1 ------------------------------------------------------------------------------
3 -- GNAT COMPILER COMPONENTS --
9 -- Copyright (C) 1998-2013, Free Software Foundation, Inc. --
11 -- GNAT is free software; you can redistribute it and/or modify it under --
12 -- terms of the GNU General Public License as published by the Free Soft- --
13 -- ware Foundation; either version 3, or (at your option) any later ver- --
14 -- sion. GNAT is distributed in the hope that it will be useful, but WITH- --
15 -- OUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY --
16 -- or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License --
17 -- for more details. You should have received a copy of the GNU General --
18 -- Public License distributed with GNAT; see file COPYING3. If not, go to --
19 -- http://www.gnu.org/licenses for a complete copy of the license. --
21 -- GNAT was originally developed by the GNAT team at New York University. --
22 -- Extensive contributions were provided by Ada Core Technologies Inc. --
24 ------------------------------------------------------------------------------
26 with Atree; use Atree;
27 with Csets; use Csets;
28 with Elists; use Elists;
29 with Errout; use Errout;
30 with Nlists; use Nlists;
32 with Restrict; use Restrict;
33 with Rident; use Rident;
35 with Sem_Aux; use Sem_Aux;
36 with Sem_Prag; use Sem_Prag;
37 with Sem_Util; use Sem_Util;
38 with Sem_Warn; use Sem_Warn;
39 with Sinfo; use Sinfo;
40 with Sinput; use Sinput;
41 with Snames; use Snames;
42 with Stringt; use Stringt;
43 with Stand; use Stand;
44 with Table; use Table;
46 with GNAT.Heap_Sort_G;
49 package body Lib.Xref is
55 -- The Xref table is used to record references. The Loc field is set
56 -- to No_Location for a definition entry.
58 subtype Xref_Entry_Number is Int;
60 type Xref_Key is record
61 -- These are the components of Xref_Entry that participate in hash
65 -- Entity referenced (E parameter to Generate_Reference)
68 -- Location of reference (Original_Location (Sloc field of N parameter
69 -- to Generate_Reference). Set to No_Location for the case of a
70 -- defining occurrence.
73 -- Reference type (Typ param to Generate_Reference)
75 Eun : Unit_Number_Type;
76 -- Unit number corresponding to Ent
78 Lun : Unit_Number_Type;
79 -- Unit number corresponding to Loc. Value is undefined and not
80 -- referenced if Loc is set to No_Location.
82 -- The following components are only used for SPARK cross-references
84 Ref_Scope : Entity_Id;
85 -- Entity of the closest subprogram or package enclosing the reference
87 Ent_Scope : Entity_Id;
88 -- Entity of the closest subprogram or package enclosing the definition,
89 -- which should be located in the same file as the definition itself.
92 type Xref_Entry is record
95 Ent_Scope_File : Unit_Number_Type;
96 -- File for entity Ent_Scope
99 -- Original source location for entity being referenced. Note that these
100 -- values are used only during the output process, they are not set when
101 -- the entries are originally built. This is because private entities
102 -- can be swapped when the initial call is made.
104 HTable_Next : Xref_Entry_Number;
105 -- For use only by Static_HTable
108 package Xrefs is new Table.Table (
109 Table_Component_Type => Xref_Entry,
110 Table_Index_Type => Xref_Entry_Number,
111 Table_Low_Bound => 1,
112 Table_Initial => Alloc.Xrefs_Initial,
113 Table_Increment => Alloc.Xrefs_Increment,
114 Table_Name => "Xrefs");
120 -- We keep a set of xref entries, in order to avoid inserting duplicate
121 -- entries into the above Xrefs table. An entry is in Xref_Set if and only
122 -- if it is in Xrefs.
124 Num_Buckets : constant := 2**16;
126 subtype Header_Num is Integer range 0 .. Num_Buckets - 1;
127 type Null_Type is null record;
128 pragma Unreferenced (Null_Type);
130 function Hash (F : Xref_Entry_Number) return Header_Num;
132 function Equal (F1, F2 : Xref_Entry_Number) return Boolean;
134 procedure HT_Set_Next (E : Xref_Entry_Number; Next : Xref_Entry_Number);
136 function HT_Next (E : Xref_Entry_Number) return Xref_Entry_Number;
138 function Get_Key (E : Xref_Entry_Number) return Xref_Entry_Number;
140 pragma Inline (Hash, Equal, HT_Set_Next, HT_Next, Get_Key);
142 package Xref_Set is new GNAT.HTable.Static_HTable (
144 Element => Xref_Entry,
145 Elmt_Ptr => Xref_Entry_Number,
147 Set_Next => HT_Set_Next,
149 Key => Xref_Entry_Number,
154 -----------------------------
155 -- SPARK Xrefs Information --
156 -----------------------------
158 package body SPARK_Specific is separate;
160 ------------------------
161 -- Local Subprograms --
162 ------------------------
164 procedure Add_Entry (Key : Xref_Key; Ent_Scope_File : Unit_Number_Type);
165 -- Add an entry to the tables of Xref_Entries, avoiding duplicates
167 procedure Generate_Prim_Op_References (Typ : Entity_Id);
168 -- For a tagged type, generate implicit references to its primitive
169 -- operations, for source navigation. This is done right before emitting
170 -- cross-reference information rather than at the freeze point of the type
171 -- in order to handle late bodies that are primitive operations.
173 function Lt (T1, T2 : Xref_Entry) return Boolean;
174 -- Order cross-references
180 procedure Add_Entry (Key : Xref_Key; Ent_Scope_File : Unit_Number_Type) is
182 Xrefs.Increment_Last; -- tentative
183 Xrefs.Table (Xrefs.Last).Key := Key;
185 -- Set the entry in Xref_Set, and if newly set, keep the above
186 -- tentative increment.
188 if Xref_Set.Set_If_Not_Present (Xrefs.Last) then
189 Xrefs.Table (Xrefs.Last).Ent_Scope_File := Ent_Scope_File;
190 -- Leave Def and HTable_Next uninitialized
192 Set_Has_Xref_Entry (Key.Ent);
194 -- It was already in Xref_Set, so throw away the tentatively-added
198 Xrefs.Decrement_Last;
206 function Equal (F1, F2 : Xref_Entry_Number) return Boolean is
207 Result : constant Boolean :=
208 Xrefs.Table (F1).Key = Xrefs.Table (F2).Key;
213 -------------------------
214 -- Generate_Definition --
215 -------------------------
217 procedure Generate_Definition (E : Entity_Id) is
219 pragma Assert (Nkind (E) in N_Entity);
221 -- Note that we do not test Xref_Entity_Letters here. It is too early
222 -- to do so, since we are often called before the entity is fully
223 -- constructed, so that the Ekind is still E_Void.
227 -- Definition must come from source
229 -- We make an exception for subprogram child units that have no spec.
230 -- For these we generate a subprogram declaration for library use,
231 -- and the corresponding entity does not come from source.
232 -- Nevertheless, all references will be attached to it and we have
233 -- to treat is as coming from user code.
235 and then (Comes_From_Source (E) or else Is_Child_Unit (E))
237 -- And must have a reasonable source location that is not
238 -- within an instance (all entities in instances are ignored)
240 and then Sloc (E) > No_Location
241 and then Instantiation_Location (Sloc (E)) = No_Location
243 -- And must be a non-internal name from the main source unit
245 and then In_Extended_Main_Source_Unit (E)
246 and then not Is_Internal_Name (Chars (E))
252 Eun => Get_Source_Unit (Original_Location (Sloc (E))),
256 Ent_Scope_File => No_Unit);
258 if In_Inlined_Body then
262 end Generate_Definition;
264 ---------------------------------
265 -- Generate_Operator_Reference --
266 ---------------------------------
268 procedure Generate_Operator_Reference
273 if not In_Extended_Main_Source_Unit (N) then
277 -- If the operator is not a Standard operator, then we generate a real
278 -- reference to the user defined operator.
280 if Sloc (Entity (N)) /= Standard_Location then
281 Generate_Reference (Entity (N), N);
283 -- A reference to an implicit inequality operator is also a reference
284 -- to the user-defined equality.
286 if Nkind (N) = N_Op_Ne
287 and then not Comes_From_Source (Entity (N))
288 and then Present (Corresponding_Equality (Entity (N)))
290 Generate_Reference (Corresponding_Equality (Entity (N)), N);
293 -- For the case of Standard operators, we mark the result type as
294 -- referenced. This ensures that in the case where we are using a
295 -- derived operator, we mark an entity of the unit that implicitly
296 -- defines this operator as used. Otherwise we may think that no entity
297 -- of the unit is used. The actual entity marked as referenced is the
298 -- first subtype, which is the relevant user defined entity.
300 -- Note: we only do this for operators that come from source. The
301 -- generated code sometimes reaches for entities that do not need to be
302 -- explicitly visible (for example, when we expand the code for
303 -- comparing two record objects, the fields of the record may not be
306 elsif Comes_From_Source (N) then
307 Set_Referenced (First_Subtype (T));
309 end Generate_Operator_Reference;
311 ---------------------------------
312 -- Generate_Prim_Op_References --
313 ---------------------------------
315 procedure Generate_Prim_Op_References (Typ : Entity_Id) is
318 Prim_List : Elist_Id;
321 -- Handle subtypes of synchronized types
323 if Ekind (Typ) = E_Protected_Subtype
324 or else Ekind (Typ) = E_Task_Subtype
326 Base_T := Etype (Typ);
331 -- References to primitive operations are only relevant for tagged types
333 if not Is_Tagged_Type (Base_T)
334 or else Is_Class_Wide_Type (Base_T)
339 -- Ada 2005 (AI-345): For synchronized types generate reference to the
340 -- wrapper that allow us to dispatch calls through their implemented
341 -- abstract interface types.
343 -- The check for Present here is to protect against previously reported
346 Prim_List := Primitive_Operations (Base_T);
348 if No (Prim_List) then
352 Prim := First_Elmt (Prim_List);
353 while Present (Prim) loop
355 -- If the operation is derived, get the original for cross-reference
356 -- reference purposes (it is the original for which we want the xref
357 -- and for which the comes_from_source test must be performed).
360 (Typ, Ultimate_Alias (Node (Prim)), 'p', Set_Ref => False);
363 end Generate_Prim_Op_References;
365 ------------------------
366 -- Generate_Reference --
367 ------------------------
369 procedure Generate_Reference
372 Typ : Character := 'r';
373 Set_Ref : Boolean := True;
374 Force : Boolean := False)
376 Actual_Typ : Character := Typ;
380 Ent_Scope : Entity_Id;
385 Ref_Scope : Entity_Id;
387 function Get_Through_Renamings (E : Entity_Id) return Entity_Id;
388 -- Get the enclosing entity through renamings, which may come from
389 -- source or from the translation of generic instantiations.
391 function Is_On_LHS (Node : Node_Id) return Boolean;
392 -- Used to check if a node is on the left hand side of an assignment.
393 -- The following cases are handled:
395 -- Variable Node is a direct descendant of left hand side of an
396 -- assignment statement.
398 -- Prefix Of an indexed or selected component that is present in
399 -- a subtree rooted by an assignment statement. There is
400 -- no restriction of nesting of components, thus cases
401 -- such as A.B (C).D are handled properly. However a prefix
402 -- of a dereference (either implicit or explicit) is never
403 -- considered as on a LHS.
405 -- Out param Same as above cases, but OUT parameter
407 function OK_To_Set_Referenced return Boolean;
408 -- Returns True if the Referenced flag can be set. There are a few
409 -- exceptions where we do not want to set this flag, see body for
410 -- details of these exceptional cases.
412 ---------------------------
413 -- Get_Through_Renamings --
414 ---------------------------
416 function Get_Through_Renamings (E : Entity_Id) return Entity_Id is
417 Result : Entity_Id := E;
419 while Present (Result)
420 and then Is_Object (Result)
421 and then Present (Renamed_Object (Result))
423 Result := Get_Enclosing_Object (Renamed_Object (Result));
426 end Get_Through_Renamings;
432 -- ??? There are several routines here and there that perform a similar
433 -- (but subtly different) computation, which should be factored:
435 -- Sem_Util.May_Be_Lvalue
436 -- Sem_Util.Known_To_Be_Assigned
437 -- Exp_Ch2.Expand_Entry_Parameter.In_Assignment_Context
438 -- Exp_Smem.Is_Out_Actual
440 function Is_On_LHS (Node : Node_Id) return Boolean is
446 -- Only identifiers are considered, is this necessary???
448 if Nkind (Node) /= N_Identifier then
452 -- Immediate return if appeared as OUT parameter
454 if Kind = E_Out_Parameter then
458 -- Search for assignment statement subtree root
465 if K = N_Assignment_Statement then
468 -- Check whether the parent is a component and the current node is
469 -- its prefix, but return False if the current node has an access
470 -- type, as in that case the selected or indexed component is an
471 -- implicit dereference, and the LHS is the designated object, not
472 -- the access object.
474 -- ??? case of a slice assignment?
476 -- ??? Note that in some cases this is called too early
477 -- (see comments in Sem_Ch8.Find_Direct_Name), at a point where
478 -- the tree is not fully typed yet. In that case we may lack
479 -- an Etype for N, and we must disable the check for an implicit
480 -- dereference. If the dereference is on an LHS, this causes a
483 elsif (K = N_Selected_Component or else K = N_Indexed_Component)
484 and then Prefix (P) = N
485 and then not (Present (Etype (N))
487 Is_Access_Type (Etype (N)))
491 -- All other cases, definitely not on left side
499 ---------------------------
500 -- OK_To_Set_Referenced --
501 ---------------------------
503 function OK_To_Set_Referenced return Boolean is
507 -- A reference from a pragma Unreferenced or pragma Unmodified or
508 -- pragma Warnings does not cause the Referenced flag to be set.
509 -- This avoids silly warnings about things being referenced and
510 -- not assigned when the only reference is from the pragma.
512 if Nkind (N) = N_Identifier then
515 if Nkind (P) = N_Pragma_Argument_Association then
518 if Nkind (P) = N_Pragma then
519 if Nam_In (Pragma_Name (P), Name_Warnings,
527 -- A reference to a formal in a named parameter association does
528 -- not make the formal referenced. Formals that are unused in the
529 -- subprogram body are properly flagged as such, even if calls
530 -- elsewhere use named notation.
532 elsif Nkind (P) = N_Parameter_Association
533 and then N = Selector_Name (P)
540 end OK_To_Set_Referenced;
542 -- Start of processing for Generate_Reference
545 pragma Assert (Nkind (E) in N_Entity);
546 Find_Actual (N, Formal, Call);
548 if Present (Formal) then
549 Kind := Ekind (Formal);
554 -- Check for obsolescent reference to package ASCII. GNAT treats this
555 -- element of annex J specially since in practice, programs make a lot
556 -- of use of this feature, so we don't include it in the set of features
557 -- diagnosed when Warn_On_Obsolescent_Features mode is set. However we
558 -- are required to note it as a violation of the RM defined restriction.
560 if E = Standard_ASCII then
561 Check_Restriction (No_Obsolescent_Features, N);
564 -- Check for reference to entity marked with Is_Obsolescent
566 -- Note that we always allow obsolescent references in the compiler
567 -- itself and the run time, since we assume that we know what we are
568 -- doing in such cases. For example the calls in Ada.Characters.Handling
569 -- to its own obsolescent subprograms are just fine.
571 -- In any case we only generate warnings if we are in the extended main
572 -- source unit, and the entity itself is not in the extended main source
573 -- unit, since we assume the source unit itself knows what is going on
574 -- (and for sure we do not want silly warnings, e.g. on the end line of
575 -- an obsolescent procedure body).
577 if Is_Obsolescent (E)
578 and then not GNAT_Mode
579 and then not In_Extended_Main_Source_Unit (E)
580 and then In_Extended_Main_Source_Unit (N)
582 Check_Restriction (No_Obsolescent_Features, N);
584 if Warn_On_Obsolescent_Feature then
585 Output_Obsolescent_Entity_Warnings (N, E);
589 -- Warn if reference to Ada 2005 entity not in Ada 2005 mode. We only
590 -- detect real explicit references (modifications and references).
592 if Comes_From_Source (N)
593 and then Is_Ada_2005_Only (E)
594 and then Ada_Version < Ada_2005
595 and then Warn_On_Ada_2005_Compatibility
596 and then (Typ = 'm' or else Typ = 'r' or else Typ = 's')
598 Error_Msg_NE ("& is only defined in Ada 2005?y?", N, E);
601 -- Warn if reference to Ada 2012 entity not in Ada 2012 mode. We only
602 -- detect real explicit references (modifications and references).
604 if Comes_From_Source (N)
605 and then Is_Ada_2012_Only (E)
606 and then Ada_Version < Ada_2012
607 and then Warn_On_Ada_2012_Compatibility
608 and then (Typ = 'm' or else Typ = 'r')
610 Error_Msg_NE ("& is only defined in Ada 2012?y?", N, E);
613 -- Do not generate references if we are within a postcondition sub-
614 -- program, because the reference does not comes from source, and the
615 -- pre-analysis of the aspect has already created an entry for the ali
616 -- file at the proper source location.
618 if Chars (Current_Scope) = Name_uPostconditions then
622 -- Never collect references if not in main source unit. However, we omit
623 -- this test if Typ is 'e' or 'k', since these entries are structural,
624 -- and it is useful to have them in units that reference packages as
625 -- well as units that define packages. We also omit the test for the
626 -- case of 'p' since we want to include inherited primitive operations
627 -- from other packages.
629 -- We also omit this test is this is a body reference for a subprogram
630 -- instantiation. In this case the reference is to the generic body,
631 -- which clearly need not be in the main unit containing the instance.
632 -- For the same reason we accept an implicit reference generated for
633 -- a default in an instance.
635 if not In_Extended_Main_Source_Unit (N) then
641 or else (Typ = 'b' and then Is_Generic_Instance (E))
643 -- Allow the generation of references to reads, writes and calls
644 -- in SPARK mode when the related context comes from an instance.
648 and then In_Extended_Main_Code_Unit (N)
649 and then (Typ = 'm' or else Typ = 'r' or else Typ = 's'))
657 -- For reference type p, the entity must be in main source unit
659 if Typ = 'p' and then not In_Extended_Main_Source_Unit (E) then
663 -- Unless the reference is forced, we ignore references where the
664 -- reference itself does not come from source.
666 if not Force and then not Comes_From_Source (N) then
670 -- Deal with setting entity as referenced, unless suppressed. Note that
671 -- we still do Set_Referenced on entities that do not come from source.
672 -- This situation arises when we have a source reference to a derived
673 -- operation, where the derived operation itself does not come from
674 -- source, but we still want to mark it as referenced, since we really
675 -- are referencing an entity in the corresponding package (this avoids
676 -- wrong complaints that the package contains no referenced entities).
680 -- Assignable object appearing on left side of assignment or as
684 and then Is_On_LHS (N)
685 and then Ekind (E) /= E_In_Out_Parameter
687 -- For objects that are renamings, just set as simply referenced
688 -- we do not try to do assignment type tracking in this case.
690 if Present (Renamed_Object (E)) then
693 -- Out parameter case
695 elsif Kind = E_Out_Parameter then
697 -- If warning mode for all out parameters is set, or this is
698 -- the only warning parameter, then we want to mark this for
699 -- later warning logic by setting Referenced_As_Out_Parameter
701 if Warn_On_Modified_As_Out_Parameter (Formal) then
702 Set_Referenced_As_Out_Parameter (E, True);
703 Set_Referenced_As_LHS (E, False);
705 -- For OUT parameter not covered by the above cases, we simply
706 -- regard it as a normal reference (in this case we do not
707 -- want any of the warning machinery for out parameters).
713 -- For the left hand of an assignment case, we do nothing here.
714 -- The processing for Analyze_Assignment_Statement will set the
715 -- Referenced_As_LHS flag.
721 -- Check for a reference in a pragma that should not count as a
722 -- making the variable referenced for warning purposes.
724 elsif Is_Non_Significant_Pragma_Reference (N) then
727 -- A reference in an attribute definition clause does not count as a
728 -- reference except for the case of Address. The reason that 'Address
729 -- is an exception is that it creates an alias through which the
730 -- variable may be referenced.
732 elsif Nkind (Parent (N)) = N_Attribute_Definition_Clause
733 and then Chars (Parent (N)) /= Name_Address
734 and then N = Name (Parent (N))
738 -- Constant completion does not count as a reference
741 and then Ekind (E) = E_Constant
745 -- Record representation clause does not count as a reference
747 elsif Nkind (N) = N_Identifier
748 and then Nkind (Parent (N)) = N_Record_Representation_Clause
752 -- Discriminants do not need to produce a reference to record type
755 and then Nkind (Parent (N)) = N_Discriminant_Specification
762 -- Special processing for IN OUT parameters, where we have an
763 -- implicit assignment to a simple variable.
765 if Kind = E_In_Out_Parameter
766 and then Is_Assignable (E)
768 -- For sure this counts as a normal read reference
771 Set_Last_Assignment (E, Empty);
773 -- We count it as being referenced as an out parameter if the
774 -- option is set to warn on all out parameters, except that we
775 -- have a special exclusion for an intrinsic subprogram, which
776 -- is most likely an instantiation of Unchecked_Deallocation
777 -- which we do not want to consider as an assignment since it
778 -- generates false positives. We also exclude the case of an
779 -- IN OUT parameter if the name of the procedure is Free,
780 -- since we suspect similar semantics.
782 if Warn_On_All_Unread_Out_Parameters
783 and then Is_Entity_Name (Name (Call))
784 and then not Is_Intrinsic_Subprogram (Entity (Name (Call)))
785 and then Chars (Name (Call)) /= Name_Free
787 Set_Referenced_As_Out_Parameter (E, True);
788 Set_Referenced_As_LHS (E, False);
791 -- Don't count a recursive reference within a subprogram as a
792 -- reference (that allows detection of a recursive subprogram
793 -- whose only references are recursive calls as unreferenced).
795 elsif Is_Subprogram (E)
796 and then E = Nearest_Dynamic_Scope (Current_Scope)
800 -- Any other occurrence counts as referencing the entity
802 elsif OK_To_Set_Referenced then
805 -- If variable, this is an OK reference after an assignment
806 -- so we can clear the Last_Assignment indication.
808 if Is_Assignable (E) then
809 Set_Last_Assignment (E, Empty);
814 -- Check for pragma Unreferenced given and reference is within
815 -- this source unit (occasion for possible warning to be issued).
817 if Has_Unreferenced (E)
818 and then In_Same_Extended_Unit (E, N)
820 -- A reference as a named parameter in a call does not count
821 -- as a violation of pragma Unreferenced for this purpose...
823 if Nkind (N) = N_Identifier
824 and then Nkind (Parent (N)) = N_Parameter_Association
825 and then Selector_Name (Parent (N)) = N
829 -- ... Neither does a reference to a variable on the left side
832 elsif Is_On_LHS (N) then
835 -- For entry formals, we want to place the warning message on the
836 -- corresponding entity in the accept statement. The current scope
837 -- is the body of the accept, so we find the formal whose name
838 -- matches that of the entry formal (there is no link between the
839 -- two entities, and the one in the accept statement is only used
840 -- for conformance checking).
842 elsif Ekind (Scope (E)) = E_Entry then
847 BE := First_Entity (Current_Scope);
848 while Present (BE) loop
849 if Chars (BE) = Chars (E) then
850 Error_Msg_NE -- CODEFIX
851 ("??pragma Unreferenced given for&!", N, BE);
859 -- Here we issue the warning, since this is a real reference
862 Error_Msg_NE -- CODEFIX
863 ("?pragma Unreferenced given for&!", N, E);
867 -- If this is a subprogram instance, mark as well the internal
868 -- subprogram in the wrapper package, which may be a visible
871 if Is_Overloadable (E)
872 and then Is_Generic_Instance (E)
873 and then Present (Alias (E))
875 Set_Referenced (Alias (E));
879 -- Generate reference if all conditions are met:
882 -- Cross referencing must be active
886 -- The entity must be one for which we collect references
888 and then Xref_Entity_Letters (Ekind (E)) /= ' '
890 -- Both Sloc values must be set to something sensible
892 and then Sloc (E) > No_Location
893 and then Sloc (N) > No_Location
895 -- Ignore references from within an instance. The only exceptions to
896 -- this are default subprograms, for which we generate an implicit
897 -- reference and compilations in SPARK mode.
900 (Instantiation_Location (Sloc (N)) = No_Location
902 or else GNATprove_Mode)
904 -- Ignore dummy references
908 if Nkind_In (N, N_Identifier,
909 N_Defining_Identifier,
910 N_Defining_Operator_Symbol,
912 N_Defining_Character_Literal)
913 or else Nkind (N) in N_Op
914 or else (Nkind (N) = N_Character_Literal
915 and then Sloc (Entity (N)) /= Standard_Location)
919 elsif Nkind_In (N, N_Expanded_Name, N_Selected_Component) then
920 Nod := Selector_Name (N);
926 -- Normal case of source entity comes from source
928 if Comes_From_Source (E) then
931 -- Entity does not come from source, but is a derived subprogram and
932 -- the derived subprogram comes from source (after one or more
933 -- derivations) in which case the reference is to parent subprogram.
935 elsif Is_Overloadable (E)
936 and then Present (Alias (E))
939 while not Comes_From_Source (Ent) loop
940 if No (Alias (Ent)) then
947 -- The internally created defining entity for a child subprogram
948 -- that has no previous spec has valid references.
950 elsif Is_Overloadable (E)
951 and then Is_Child_Unit (E)
955 -- Ditto for the formals of such a subprogram
957 elsif Is_Overloadable (Scope (E))
958 and then Is_Child_Unit (Scope (E))
962 -- Record components of discriminated subtypes or derived types must
963 -- be treated as references to the original component.
965 elsif Ekind (E) = E_Component
966 and then Comes_From_Source (Original_Record_Component (E))
968 Ent := Original_Record_Component (E);
970 -- If this is an expanded reference to a discriminant, recover the
971 -- original discriminant, which gets the reference.
973 elsif Ekind (E) = E_In_Parameter
974 and then Present (Discriminal_Link (E))
976 Ent := Discriminal_Link (E);
977 Set_Referenced (Ent);
979 -- Ignore reference to any other entity that is not from source
985 -- In SPARK mode, consider the underlying entity renamed instead of
986 -- the renaming, which is needed to compute a valid set of effects
987 -- (reads, writes) for the enclosing subprogram.
989 if GNATprove_Mode then
990 Ent := Get_Through_Renamings (Ent);
992 -- If no enclosing object, then it could be a reference to any
993 -- location not tracked individually, like heap-allocated data.
994 -- Conservatively approximate this possibility by generating a
995 -- dereference, and return.
998 if Actual_Typ = 'w' then
999 SPARK_Specific.Generate_Dereference (Nod, 'r');
1000 SPARK_Specific.Generate_Dereference (Nod, 'w');
1002 SPARK_Specific.Generate_Dereference (Nod, 'r');
1009 -- Record reference to entity
1012 and then Is_Subprogram (Nod)
1013 and then Present (Overridden_Operation (Nod))
1018 -- Comment needed here for special SPARK code ???
1020 if GNATprove_Mode then
1024 Ref_Scope := SPARK_Specific.Enclosing_Subprogram_Or_Package (Nod);
1025 Ent_Scope := SPARK_Specific.Enclosing_Subprogram_Or_Package (Ent);
1027 -- Since we are reaching through renamings in SPARK mode, we may
1028 -- end up with standard constants. Ignore those.
1030 if Sloc (Ent_Scope) <= Standard_Location
1031 or else Def <= Standard_Location
1040 Eun => Get_Code_Unit (Def),
1041 Lun => Get_Code_Unit (Ref),
1042 Ref_Scope => Ref_Scope,
1043 Ent_Scope => Ent_Scope),
1044 Ent_Scope_File => Get_Code_Unit (Ent));
1047 Ref := Original_Location (Sloc (Nod));
1048 Def := Original_Location (Sloc (Ent));
1050 -- If this is an operator symbol, skip the initial quote for
1051 -- navigation purposes. This is not done for the end label,
1052 -- where we want the actual position after the closing quote.
1057 elsif Nkind (N) = N_Defining_Operator_Symbol
1058 or else Nkind (Nod) = N_Operator_Symbol
1067 Eun => Get_Source_Unit (Def),
1068 Lun => Get_Source_Unit (Ref),
1070 Ent_Scope => Empty),
1071 Ent_Scope_File => No_Unit);
1073 -- Generate reference to the first private entity
1076 and then Comes_From_Source (E)
1077 and then Nkind (Ent) = N_Defining_Identifier
1078 and then (Is_Package_Or_Generic_Package (Ent)
1079 or else Is_Concurrent_Type (Ent))
1080 and then Present (First_Private_Entity (E))
1081 and then In_Extended_Main_Source_Unit (N)
1085 Loc => Sloc (First_Private_Entity (E)),
1087 Eun => Get_Source_Unit (Def),
1088 Lun => Get_Source_Unit (Ref),
1090 Ent_Scope => Empty),
1091 Ent_Scope_File => No_Unit);
1095 end Generate_Reference;
1097 -----------------------------------
1098 -- Generate_Reference_To_Formals --
1099 -----------------------------------
1101 procedure Generate_Reference_To_Formals (E : Entity_Id) is
1105 if Is_Generic_Subprogram (E) then
1106 Formal := First_Entity (E);
1108 while Present (Formal)
1109 and then not Is_Formal (Formal)
1111 Next_Entity (Formal);
1114 elsif Ekind (E) in Access_Subprogram_Kind then
1115 Formal := First_Formal (Designated_Type (E));
1118 Formal := First_Formal (E);
1121 while Present (Formal) loop
1122 if Ekind (Formal) = E_In_Parameter then
1124 if Nkind (Parameter_Type (Parent (Formal)))
1125 = N_Access_Definition
1127 Generate_Reference (E, Formal, '^', False);
1129 Generate_Reference (E, Formal, '>', False);
1132 elsif Ekind (Formal) = E_In_Out_Parameter then
1133 Generate_Reference (E, Formal, '=', False);
1136 Generate_Reference (E, Formal, '<', False);
1139 Next_Formal (Formal);
1141 end Generate_Reference_To_Formals;
1143 -------------------------------------------
1144 -- Generate_Reference_To_Generic_Formals --
1145 -------------------------------------------
1147 procedure Generate_Reference_To_Generic_Formals (E : Entity_Id) is
1151 Formal := First_Entity (E);
1152 while Present (Formal) loop
1153 if Comes_From_Source (Formal) then
1154 Generate_Reference (E, Formal, 'z', False);
1157 Next_Entity (Formal);
1159 end Generate_Reference_To_Generic_Formals;
1165 function Get_Key (E : Xref_Entry_Number) return Xref_Entry_Number is
1174 function Hash (F : Xref_Entry_Number) return Header_Num is
1175 -- It is unlikely to have two references to the same entity at the same
1176 -- source location, so the hash function depends only on the Ent and Loc
1179 XE : Xref_Entry renames Xrefs.Table (F);
1180 type M is mod 2**32;
1182 H : constant M := M (XE.Key.Ent) + 2 ** 7 * M (abs XE.Key.Loc);
1183 -- It would be more natural to write:
1185 -- H : constant M := M'Mod (XE.Key.Ent) + 2**7 * M'Mod (XE.Key.Loc);
1187 -- But we can't use M'Mod, because it prevents bootstrapping with older
1188 -- compilers. Loc can be negative, so we do "abs" before converting.
1189 -- One day this can be cleaned up ???
1192 return Header_Num (H mod Num_Buckets);
1199 procedure HT_Set_Next (E : Xref_Entry_Number; Next : Xref_Entry_Number) is
1201 Xrefs.Table (E).HTable_Next := Next;
1208 function HT_Next (E : Xref_Entry_Number) return Xref_Entry_Number is
1210 return Xrefs.Table (E).HTable_Next;
1217 procedure Initialize is
1226 function Lt (T1, T2 : Xref_Entry) return Boolean is
1228 -- First test: if entity is in different unit, sort by unit
1230 if T1.Key.Eun /= T2.Key.Eun then
1231 return Dependency_Num (T1.Key.Eun) < Dependency_Num (T2.Key.Eun);
1233 -- Second test: within same unit, sort by entity Sloc
1235 elsif T1.Def /= T2.Def then
1236 return T1.Def < T2.Def;
1238 -- Third test: sort definitions ahead of references
1240 elsif T1.Key.Loc = No_Location then
1243 elsif T2.Key.Loc = No_Location then
1246 -- Fourth test: for same entity, sort by reference location unit
1248 elsif T1.Key.Lun /= T2.Key.Lun then
1249 return Dependency_Num (T1.Key.Lun) < Dependency_Num (T2.Key.Lun);
1251 -- Fifth test: order of location within referencing unit
1253 elsif T1.Key.Loc /= T2.Key.Loc then
1254 return T1.Key.Loc < T2.Key.Loc;
1256 -- Finally, for two locations at the same address, we prefer
1257 -- the one that does NOT have the type 'r' so that a modification
1258 -- or extension takes preference, when there are more than one
1259 -- reference at the same location. As a result, in the case of
1260 -- entities that are in-out actuals, the read reference follows
1261 -- the modify reference.
1264 return T2.Key.Typ = 'r';
1268 -----------------------
1269 -- Output_References --
1270 -----------------------
1272 procedure Output_References is
1274 procedure Get_Type_Reference
1276 Tref : out Entity_Id;
1277 Left : out Character;
1278 Right : out Character);
1279 -- Given an Entity_Id Ent, determines whether a type reference is
1280 -- required. If so, Tref is set to the entity for the type reference
1281 -- and Left and Right are set to the left/right brackets to be output
1282 -- for the reference. If no type reference is required, then Tref is
1283 -- set to Empty, and Left/Right are set to space.
1285 procedure Output_Import_Export_Info (Ent : Entity_Id);
1286 -- Output language and external name information for an interfaced
1287 -- entity, using the format <language, external_name>.
1289 ------------------------
1290 -- Get_Type_Reference --
1291 ------------------------
1293 procedure Get_Type_Reference
1295 Tref : out Entity_Id;
1296 Left : out Character;
1297 Right : out Character)
1302 -- See if we have a type reference
1311 -- Processing for types
1313 if Is_Type (Tref) then
1315 -- Case of base type
1317 if Base_Type (Tref) = Tref then
1319 -- If derived, then get first subtype
1321 if Tref /= Etype (Tref) then
1322 Tref := First_Subtype (Etype (Tref));
1324 -- Set brackets for derived type, but don't override
1325 -- pointer case since the fact that something is a
1326 -- pointer is more important.
1333 -- If the completion of a private type is itself a derived
1334 -- type, we need the parent of the full view.
1336 elsif Is_Private_Type (Tref)
1337 and then Present (Full_View (Tref))
1338 and then Etype (Full_View (Tref)) /= Full_View (Tref)
1340 Tref := Etype (Full_View (Tref));
1347 -- If non-derived pointer, get directly designated type.
1348 -- If the type has a full view, all references are on the
1349 -- partial view that is seen first.
1351 elsif Is_Access_Type (Tref) then
1352 Tref := Directly_Designated_Type (Tref);
1356 elsif Is_Private_Type (Tref)
1357 and then Present (Full_View (Tref))
1359 if Is_Access_Type (Full_View (Tref)) then
1360 Tref := Directly_Designated_Type (Full_View (Tref));
1364 -- If the full view is an array type, we also retrieve
1365 -- the corresponding component type, because the ali
1366 -- entry already indicates that this is an array.
1368 elsif Is_Array_Type (Full_View (Tref)) then
1369 Tref := Component_Type (Full_View (Tref));
1374 -- If non-derived array, get component type. Skip component
1375 -- type for case of String or Wide_String, saves worthwhile
1378 elsif Is_Array_Type (Tref)
1379 and then Tref /= Standard_String
1380 and then Tref /= Standard_Wide_String
1382 Tref := Component_Type (Tref);
1386 -- For other non-derived base types, nothing
1392 -- For a subtype, go to ancestor subtype
1395 Tref := Ancestor_Subtype (Tref);
1397 -- If no ancestor subtype, go to base type
1400 Tref := Base_Type (Sav);
1404 -- For objects, functions, enum literals, just get type from
1407 elsif Is_Object (Tref)
1408 or else Ekind (Tref) = E_Enumeration_Literal
1409 or else Ekind (Tref) = E_Function
1410 or else Ekind (Tref) = E_Operator
1412 Tref := Etype (Tref);
1414 -- Another special case: an object of a classwide type
1415 -- initialized with a tag-indeterminate call gets a subtype
1416 -- of the classwide type during expansion. See if the original
1417 -- type in the declaration is named, and return it instead
1418 -- of going to the root type.
1420 if Ekind (Tref) = E_Class_Wide_Subtype
1421 and then Nkind (Parent (Ent)) = N_Object_Declaration
1423 Nkind (Original_Node (Object_Definition (Parent (Ent))))
1428 (Original_Node ((Object_Definition (Parent (Ent)))));
1431 -- For anything else, exit
1437 -- Exit if no type reference, or we are stuck in some loop trying
1438 -- to find the type reference, or if the type is standard void
1439 -- type (the latter is an implementation artifact that should not
1440 -- show up in the generated cross-references).
1444 or else Tref = Standard_Void_Type;
1446 -- If we have a usable type reference, return, otherwise keep
1447 -- looking for something useful (we are looking for something
1448 -- that either comes from source or standard)
1450 if Sloc (Tref) = Standard_Location
1451 or else Comes_From_Source (Tref)
1453 -- If the reference is a subtype created for a generic actual,
1454 -- go actual directly, the inner subtype is not user visible.
1456 if Nkind (Parent (Tref)) = N_Subtype_Declaration
1457 and then not Comes_From_Source (Parent (Tref))
1459 (Is_Wrapper_Package (Scope (Tref))
1460 or else Is_Generic_Instance (Scope (Tref)))
1462 Tref := First_Subtype (Base_Type (Tref));
1469 -- If we fall through the loop, no type reference
1474 end Get_Type_Reference;
1476 -------------------------------
1477 -- Output_Import_Export_Info --
1478 -------------------------------
1480 procedure Output_Import_Export_Info (Ent : Entity_Id) is
1481 Language_Name : Name_Id;
1482 Conv : constant Convention_Id := Convention (Ent);
1485 -- Generate language name from convention
1487 if Conv = Convention_C then
1488 Language_Name := Name_C;
1490 elsif Conv = Convention_CPP then
1491 Language_Name := Name_CPP;
1493 elsif Conv = Convention_Ada then
1494 Language_Name := Name_Ada;
1497 -- For the moment we ignore all other cases ???
1502 Write_Info_Char ('<');
1503 Get_Unqualified_Name_String (Language_Name);
1505 for J in 1 .. Name_Len loop
1506 Write_Info_Char (Name_Buffer (J));
1509 if Present (Interface_Name (Ent)) then
1510 Write_Info_Char (',');
1511 String_To_Name_Buffer (Strval (Interface_Name (Ent)));
1513 for J in 1 .. Name_Len loop
1514 Write_Info_Char (Name_Buffer (J));
1518 Write_Info_Char ('>');
1519 end Output_Import_Export_Info;
1521 -- Start of processing for Output_References
1524 -- First we add references to the primitive operations of tagged types
1525 -- declared in the main unit.
1527 Handle_Prim_Ops : declare
1531 for J in 1 .. Xrefs.Last loop
1532 Ent := Xrefs.Table (J).Key.Ent;
1535 and then Is_Tagged_Type (Ent)
1536 and then Is_Base_Type (Ent)
1537 and then In_Extended_Main_Source_Unit (Ent)
1539 Generate_Prim_Op_References (Ent);
1542 end Handle_Prim_Ops;
1544 -- Before we go ahead and output the references we have a problem
1545 -- that needs dealing with. So far we have captured things that are
1546 -- definitely referenced by the main unit, or defined in the main
1547 -- unit. That's because we don't want to clutter up the ali file
1548 -- for this unit with definition lines for entities in other units
1549 -- that are not referenced.
1551 -- But there is a glitch. We may reference an entity in another unit,
1552 -- and it may have a type reference to an entity that is not directly
1553 -- referenced in the main unit, which may mean that there is no xref
1554 -- entry for this entity yet in the list of references.
1556 -- If we don't do something about this, we will end with an orphan type
1557 -- reference, i.e. it will point to an entity that does not appear
1558 -- within the generated references in the ali file. That is not good for
1559 -- tools using the xref information.
1561 -- To fix this, we go through the references adding definition entries
1562 -- for any unreferenced entities that can be referenced in a type
1563 -- reference. There is a recursion problem here, and that is dealt with
1564 -- by making sure that this traversal also traverses any entries that
1565 -- get added by the traversal.
1567 Handle_Orphan_Type_References : declare
1573 pragma Warnings (Off, L);
1574 pragma Warnings (Off, R);
1576 procedure New_Entry (E : Entity_Id);
1577 -- Make an additional entry into the Xref table for a type entity
1578 -- that is related to the current entity (parent, type ancestor,
1579 -- progenitor, etc.).
1585 procedure New_Entry (E : Entity_Id) is
1587 pragma Assert (Present (E));
1589 if not Has_Xref_Entry (Implementation_Base_Type (E))
1590 and then Sloc (E) > No_Location
1595 Typ => Character'First,
1596 Eun => Get_Source_Unit (Original_Location (Sloc (E))),
1599 Ent_Scope => Empty),
1600 Ent_Scope_File => No_Unit);
1604 -- Start of processing for Handle_Orphan_Type_References
1607 -- Note that this is not a for loop for a very good reason. The
1608 -- processing of items in the table can add new items to the table,
1609 -- and they must be processed as well.
1612 while J <= Xrefs.Last loop
1613 Ent := Xrefs.Table (J).Key.Ent;
1614 Get_Type_Reference (Ent, Tref, L, R);
1617 and then not Has_Xref_Entry (Tref)
1618 and then Sloc (Tref) > No_Location
1622 if Is_Record_Type (Ent)
1623 and then Present (Interfaces (Ent))
1625 -- Add an entry for each one of the given interfaces
1626 -- implemented by type Ent.
1629 Elmt : Elmt_Id := First_Elmt (Interfaces (Ent));
1631 while Present (Elmt) loop
1632 New_Entry (Node (Elmt));
1639 -- Collect inherited primitive operations that may be declared in
1640 -- another unit and have no visible reference in the current one.
1643 and then Is_Tagged_Type (Ent)
1644 and then Is_Derived_Type (Ent)
1645 and then Is_Base_Type (Ent)
1646 and then In_Extended_Main_Source_Unit (Ent)
1649 Op_List : constant Elist_Id := Primitive_Operations (Ent);
1653 function Parent_Op (E : Entity_Id) return Entity_Id;
1654 -- Find original operation, which may be inherited through
1655 -- several derivations.
1657 function Parent_Op (E : Entity_Id) return Entity_Id is
1658 Orig_Op : constant Entity_Id := Alias (E);
1661 if No (Orig_Op) then
1664 elsif not Comes_From_Source (E)
1665 and then not Has_Xref_Entry (Orig_Op)
1666 and then Comes_From_Source (Orig_Op)
1670 return Parent_Op (Orig_Op);
1675 Op := First_Elmt (Op_List);
1676 while Present (Op) loop
1677 Prim := Parent_Op (Node (Op));
1679 if Present (Prim) then
1683 Typ => Character'First,
1684 Eun => Get_Source_Unit (Sloc (Prim)),
1687 Ent_Scope => Empty),
1688 Ent_Scope_File => No_Unit);
1698 end Handle_Orphan_Type_References;
1700 -- Now we have all the references, including those for any embedded
1701 -- type references, so we can sort them, and output them.
1703 Output_Refs : declare
1705 Nrefs : constant Nat := Xrefs.Last;
1706 -- Number of references in table
1708 Rnums : array (0 .. Nrefs) of Nat;
1709 -- This array contains numbers of references in the Xrefs table.
1710 -- This list is sorted in output order. The extra 0'th entry is
1711 -- convenient for the call to sort. When we sort the table, we
1712 -- move the entries in Rnums around, but we do not move the
1713 -- original table entries.
1715 Curxu : Unit_Number_Type;
1716 -- Current xref unit
1718 Curru : Unit_Number_Type;
1719 -- Current reference unit for one entity
1724 Curnam : String (1 .. Name_Buffer'Length);
1726 -- Simple name and length of current entity
1728 Curdef : Source_Ptr;
1729 -- Original source location for current entity
1732 -- Current reference location
1735 -- Entity type character
1738 -- reference kind of previous reference
1744 -- Renaming reference
1746 Trunit : Unit_Number_Type;
1747 -- Unit number for type reference
1749 function Lt (Op1, Op2 : Natural) return Boolean;
1750 -- Comparison function for Sort call
1752 function Name_Change (X : Entity_Id) return Boolean;
1753 -- Determines if entity X has a different simple name from Curent
1755 procedure Move (From : Natural; To : Natural);
1756 -- Move procedure for Sort call
1758 package Sorting is new GNAT.Heap_Sort_G (Move, Lt);
1764 function Lt (Op1, Op2 : Natural) return Boolean is
1765 T1 : Xref_Entry renames Xrefs.Table (Rnums (Nat (Op1)));
1766 T2 : Xref_Entry renames Xrefs.Table (Rnums (Nat (Op2)));
1776 procedure Move (From : Natural; To : Natural) is
1778 Rnums (Nat (To)) := Rnums (Nat (From));
1785 -- Why a string comparison here??? Why not compare Name_Id values???
1787 function Name_Change (X : Entity_Id) return Boolean is
1789 Get_Unqualified_Name_String (Chars (X));
1791 if Name_Len /= Curlen then
1794 return Name_Buffer (1 .. Curlen) /= Curnam (1 .. Curlen);
1798 -- Start of processing for Output_Refs
1801 -- Capture the definition Sloc values. We delay doing this till now,
1802 -- since at the time the reference or definition is made, private
1803 -- types may be swapped, and the Sloc value may be incorrect. We
1804 -- also set up the pointer vector for the sort.
1806 -- For user-defined operators we need to skip the initial quote and
1807 -- point to the first character of the name, for navigation purposes.
1809 for J in 1 .. Nrefs loop
1811 E : constant Entity_Id := Xrefs.Table (J).Key.Ent;
1812 Loc : constant Source_Ptr := Original_Location (Sloc (E));
1817 if Nkind (E) = N_Defining_Operator_Symbol then
1818 Xrefs.Table (J).Def := Loc + 1;
1820 Xrefs.Table (J).Def := Loc;
1825 -- Sort the references
1827 Sorting.Sort (Integer (Nrefs));
1829 -- Initialize loop through references
1833 Curdef := No_Location;
1835 Crloc := No_Location;
1838 -- Loop to output references
1840 for Refno in 1 .. Nrefs loop
1841 Output_One_Ref : declare
1844 XE : Xref_Entry renames Xrefs.Table (Rnums (Refno));
1845 -- The current entry to be accessed
1849 -- Used for {} or <> or () for type reference
1851 procedure Check_Type_Reference
1853 List_Interface : Boolean);
1854 -- Find whether there is a meaningful type reference for
1855 -- Ent, and display it accordingly. If List_Interface is
1856 -- true, then Ent is a progenitor interface of the current
1857 -- type entity being listed. In that case list it as is,
1858 -- without looking for a type reference for it.
1860 procedure Output_Instantiation_Refs (Loc : Source_Ptr);
1861 -- Recursive procedure to output instantiation references for
1862 -- the given source ptr in [file|line[...]] form. No output
1863 -- if the given location is not a generic template reference.
1865 procedure Output_Overridden_Op (Old_E : Entity_Id);
1866 -- For a subprogram that is overriding, display information
1867 -- about the inherited operation that it overrides.
1869 --------------------------
1870 -- Check_Type_Reference --
1871 --------------------------
1873 procedure Check_Type_Reference
1875 List_Interface : Boolean)
1878 if List_Interface then
1880 -- This is a progenitor interface of the type for which
1881 -- xref information is being generated.
1888 Get_Type_Reference (Ent, Tref, Left, Right);
1891 if Present (Tref) then
1893 -- Case of standard entity, output name
1895 if Sloc (Tref) = Standard_Location then
1896 Write_Info_Char (Left);
1897 Write_Info_Name (Chars (Tref));
1898 Write_Info_Char (Right);
1900 -- Case of source entity, output location
1903 Write_Info_Char (Left);
1904 Trunit := Get_Source_Unit (Sloc (Tref));
1906 if Trunit /= Curxu then
1907 Write_Info_Nat (Dependency_Num (Trunit));
1908 Write_Info_Char ('|');
1912 (Int (Get_Logical_Line_Number (Sloc (Tref))));
1920 Ctyp := Xref_Entity_Letters (Ekind (Ent));
1923 and then Present (Full_View (Ent))
1925 Ent := Underlying_Type (Ent);
1927 if Present (Ent) then
1928 Ctyp := Xref_Entity_Letters (Ekind (Ent));
1932 Write_Info_Char (Ctyp);
1936 (Int (Get_Column_Number (Sloc (Tref))));
1938 -- If the type comes from an instantiation, add the
1939 -- corresponding info.
1941 Output_Instantiation_Refs (Sloc (Tref));
1942 Write_Info_Char (Right);
1945 end Check_Type_Reference;
1947 -------------------------------
1948 -- Output_Instantiation_Refs --
1949 -------------------------------
1951 procedure Output_Instantiation_Refs (Loc : Source_Ptr) is
1952 Iloc : constant Source_Ptr := Instantiation_Location (Loc);
1953 Lun : Unit_Number_Type;
1954 Cu : constant Unit_Number_Type := Curru;
1957 -- Nothing to do if this is not an instantiation
1959 if Iloc = No_Location then
1963 -- Output instantiation reference
1965 Write_Info_Char ('[');
1966 Lun := Get_Source_Unit (Iloc);
1968 if Lun /= Curru then
1970 Write_Info_Nat (Dependency_Num (Curru));
1971 Write_Info_Char ('|');
1974 Write_Info_Nat (Int (Get_Logical_Line_Number (Iloc)));
1976 -- Recursive call to get nested instantiations
1978 Output_Instantiation_Refs (Iloc);
1980 -- Output final ] after call to get proper nesting
1982 Write_Info_Char (']');
1985 end Output_Instantiation_Refs;
1987 --------------------------
1988 -- Output_Overridden_Op --
1989 --------------------------
1991 procedure Output_Overridden_Op (Old_E : Entity_Id) is
1995 -- The overridden operation has an implicit declaration
1996 -- at the point of derivation. What we want to display
1997 -- is the original operation, which has the actual body
1998 -- (or abstract declaration) that is being overridden.
1999 -- The overridden operation is not always set, e.g. when
2000 -- it is a predefined operator.
2005 -- Follow alias chain if one is present
2007 elsif Present (Alias (Old_E)) then
2009 -- The subprogram may have been implicitly inherited
2010 -- through several levels of derivation, so find the
2011 -- ultimate (source) ancestor.
2013 Op := Ultimate_Alias (Old_E);
2015 -- Normal case of no alias present. We omit generated
2016 -- primitives like tagged equality, that have no source
2024 and then Sloc (Op) /= Standard_Location
2025 and then Comes_From_Source (Op)
2028 Loc : constant Source_Ptr := Sloc (Op);
2029 Par_Unit : constant Unit_Number_Type :=
2030 Get_Source_Unit (Loc);
2033 Write_Info_Char ('<');
2035 if Par_Unit /= Curxu then
2036 Write_Info_Nat (Dependency_Num (Par_Unit));
2037 Write_Info_Char ('|');
2040 Write_Info_Nat (Int (Get_Logical_Line_Number (Loc)));
2041 Write_Info_Char ('p');
2042 Write_Info_Nat (Int (Get_Column_Number (Loc)));
2043 Write_Info_Char ('>');
2046 end Output_Overridden_Op;
2048 -- Start of processing for Output_One_Ref
2052 Ctyp := Xref_Entity_Letters (Ekind (Ent));
2054 -- Skip reference if it is the only reference to an entity,
2055 -- and it is an END line reference, and the entity is not in
2056 -- the current extended source. This prevents junk entries
2057 -- consisting only of packages with END lines, where no
2058 -- entity from the package is actually referenced.
2061 and then Ent /= Curent
2062 and then (Refno = Nrefs
2064 Ent /= Xrefs.Table (Rnums (Refno + 1)).Key.Ent)
2065 and then not In_Extended_Main_Source_Unit (Ent)
2070 -- For private type, get full view type
2073 and then Present (Full_View (XE.Key.Ent))
2075 Ent := Underlying_Type (Ent);
2077 if Present (Ent) then
2078 Ctyp := Xref_Entity_Letters (Ekind (Ent));
2082 -- Special exception for Boolean
2084 if Ctyp = 'E' and then Is_Boolean_Type (Ent) then
2088 -- For variable reference, get corresponding type
2091 Ent := Etype (XE.Key.Ent);
2092 Ctyp := Fold_Lower (Xref_Entity_Letters (Ekind (Ent)));
2094 -- If variable is private type, get full view type
2097 and then Present (Full_View (Etype (XE.Key.Ent)))
2099 Ent := Underlying_Type (Etype (XE.Key.Ent));
2101 if Present (Ent) then
2102 Ctyp := Fold_Lower (Xref_Entity_Letters (Ekind (Ent)));
2105 elsif Is_Generic_Type (Ent) then
2107 -- If the type of the entity is a generic private type,
2108 -- there is no usable full view, so retain the indication
2109 -- that this is an object.
2114 -- Special handling for access parameters and objects and
2115 -- components of an anonymous access type.
2117 if Ekind_In (Etype (XE.Key.Ent),
2118 E_Anonymous_Access_Type,
2119 E_Anonymous_Access_Subprogram_Type,
2120 E_Anonymous_Access_Protected_Subprogram_Type)
2122 if Is_Formal (XE.Key.Ent)
2125 (XE.Key.Ent, E_Variable, E_Constant, E_Component)
2130 -- Special handling for Boolean
2132 elsif Ctyp = 'e' and then Is_Boolean_Type (Ent) then
2137 -- Special handling for abstract types and operations
2139 if Is_Overloadable (XE.Key.Ent)
2140 and then Is_Abstract_Subprogram (XE.Key.Ent)
2143 Ctyp := 'x'; -- Abstract procedure
2145 elsif Ctyp = 'V' then
2146 Ctyp := 'y'; -- Abstract function
2149 elsif Is_Type (XE.Key.Ent)
2150 and then Is_Abstract_Type (XE.Key.Ent)
2152 if Is_Interface (XE.Key.Ent) then
2155 elsif Ctyp = 'R' then
2156 Ctyp := 'H'; -- Abstract type
2160 -- Only output reference if interesting type of entity
2164 -- Suppress references to object definitions, used for local
2167 or else XE.Key.Typ = 'D'
2168 or else XE.Key.Typ = 'I'
2170 -- Suppress self references, except for bodies that act as
2173 or else (XE.Key.Loc = XE.Def
2176 or else not Is_Subprogram (XE.Key.Ent)))
2178 -- Also suppress definitions of body formals (we only
2179 -- treat these as references, and the references were
2180 -- separately recorded).
2182 or else (Is_Formal (XE.Key.Ent)
2183 and then Present (Spec_Entity (XE.Key.Ent)))
2188 -- Start new Xref section if new xref unit
2190 if XE.Key.Eun /= Curxu then
2191 if Write_Info_Col > 1 then
2195 Curxu := XE.Key.Eun;
2197 Write_Info_Initiate ('X');
2198 Write_Info_Char (' ');
2199 Write_Info_Nat (Dependency_Num (XE.Key.Eun));
2200 Write_Info_Char (' ');
2202 (Reference_Name (Source_Index (XE.Key.Eun)));
2205 -- Start new Entity line if new entity. Note that we
2206 -- consider two entities the same if they have the same
2207 -- name and source location. This causes entities in
2208 -- instantiations to be treated as though they referred
2213 (XE.Key.Ent /= Curent
2215 (Name_Change (XE.Key.Ent) or else XE.Def /= Curdef))
2217 Curent := XE.Key.Ent;
2220 Get_Unqualified_Name_String (Chars (XE.Key.Ent));
2222 Curnam (1 .. Curlen) := Name_Buffer (1 .. Curlen);
2224 if Write_Info_Col > 1 then
2228 -- Write column number information
2230 Write_Info_Nat (Int (Get_Logical_Line_Number (XE.Def)));
2231 Write_Info_Char (Ctyp);
2232 Write_Info_Nat (Int (Get_Column_Number (XE.Def)));
2234 -- Write level information
2236 Write_Level_Info : declare
2237 function Is_Visible_Generic_Entity
2238 (E : Entity_Id) return Boolean;
2239 -- Check whether E is declared in the visible part
2240 -- of a generic package. For source navigation
2241 -- purposes, treat this as a visible entity.
2243 function Is_Private_Record_Component
2244 (E : Entity_Id) return Boolean;
2245 -- Check whether E is a non-inherited component of a
2246 -- private extension. Even if the enclosing record is
2247 -- public, we want to treat the component as private
2248 -- for navigation purposes.
2250 ---------------------------------
2251 -- Is_Private_Record_Component --
2252 ---------------------------------
2254 function Is_Private_Record_Component
2255 (E : Entity_Id) return Boolean
2257 S : constant Entity_Id := Scope (E);
2260 Ekind (E) = E_Component
2261 and then Nkind (Declaration_Node (S)) =
2262 N_Private_Extension_Declaration
2263 and then Original_Record_Component (E) = E;
2264 end Is_Private_Record_Component;
2266 -------------------------------
2267 -- Is_Visible_Generic_Entity --
2268 -------------------------------
2270 function Is_Visible_Generic_Entity
2271 (E : Entity_Id) return Boolean
2276 -- The Present check here is an error defense
2278 if Present (Scope (E))
2279 and then Ekind (Scope (E)) /= E_Generic_Package
2285 while Present (Par) loop
2287 Nkind (Par) = N_Generic_Package_Declaration
2289 -- Entity is a generic formal
2294 Nkind (Parent (Par)) = N_Package_Specification
2297 Is_List_Member (Par)
2298 and then List_Containing (Par) =
2299 Visible_Declarations (Parent (Par));
2301 Par := Parent (Par);
2306 end Is_Visible_Generic_Entity;
2308 -- Start of processing for Write_Level_Info
2311 if Is_Hidden (Curent)
2312 or else Is_Private_Record_Component (Curent)
2314 Write_Info_Char (' ');
2318 or else Is_Visible_Generic_Entity (Curent)
2320 Write_Info_Char ('*');
2323 Write_Info_Char (' ');
2325 end Write_Level_Info;
2327 -- Output entity name. We use the occurrence from the
2328 -- actual source program at the definition point.
2331 Ent_Name : constant String :=
2332 Exact_Source_Name (Sloc (XE.Key.Ent));
2334 for C in Ent_Name'Range loop
2335 Write_Info_Char (Ent_Name (C));
2339 -- See if we have a renaming reference
2341 if Is_Object (XE.Key.Ent)
2342 and then Present (Renamed_Object (XE.Key.Ent))
2344 Rref := Renamed_Object (XE.Key.Ent);
2346 elsif Is_Overloadable (XE.Key.Ent)
2347 and then Nkind (Parent (Declaration_Node (XE.Key.Ent)))
2348 = N_Subprogram_Renaming_Declaration
2350 Rref := Name (Parent (Declaration_Node (XE.Key.Ent)));
2352 elsif Ekind (XE.Key.Ent) = E_Package
2353 and then Nkind (Declaration_Node (XE.Key.Ent)) =
2354 N_Package_Renaming_Declaration
2356 Rref := Name (Declaration_Node (XE.Key.Ent));
2362 if Present (Rref) then
2363 if Nkind (Rref) = N_Expanded_Name then
2364 Rref := Selector_Name (Rref);
2367 if Nkind (Rref) = N_Identifier
2368 or else Nkind (Rref) = N_Operator_Symbol
2372 -- For renamed array components, use the array name
2373 -- for the renamed entity, which reflect the fact that
2374 -- in general the whole array is aliased.
2376 elsif Nkind (Rref) = N_Indexed_Component then
2377 if Nkind (Prefix (Rref)) = N_Identifier then
2378 Rref := Prefix (Rref);
2379 elsif Nkind (Prefix (Rref)) = N_Expanded_Name then
2380 Rref := Selector_Name (Prefix (Rref));
2390 -- Write out renaming reference if we have one
2392 if Present (Rref) then
2393 Write_Info_Char ('=');
2395 (Int (Get_Logical_Line_Number (Sloc (Rref))));
2396 Write_Info_Char (':');
2398 (Int (Get_Column_Number (Sloc (Rref))));
2401 -- Indicate that the entity is in the unit of the current
2406 -- Write out information about generic parent, if entity
2409 if Is_Generic_Instance (XE.Key.Ent) then
2411 Gen_Par : constant Entity_Id :=
2414 (Unit_Declaration_Node
2416 Loc : constant Source_Ptr := Sloc (Gen_Par);
2417 Gen_U : constant Unit_Number_Type :=
2418 Get_Source_Unit (Loc);
2421 Write_Info_Char ('[');
2423 if Curru /= Gen_U then
2424 Write_Info_Nat (Dependency_Num (Gen_U));
2425 Write_Info_Char ('|');
2429 (Int (Get_Logical_Line_Number (Loc)));
2430 Write_Info_Char (']');
2434 -- See if we have a type reference and if so output
2436 Check_Type_Reference (XE.Key.Ent, False);
2438 -- Additional information for types with progenitors,
2439 -- including synchronized tagged types.
2442 Typ : constant Entity_Id := XE.Key.Ent;
2446 if Is_Record_Type (Typ)
2447 and then Present (Interfaces (Typ))
2449 Elmt := First_Elmt (Interfaces (Typ));
2451 elsif Is_Concurrent_Type (Typ)
2452 and then Present (Corresponding_Record_Type (Typ))
2454 Interfaces (Corresponding_Record_Type (Typ)))
2458 Interfaces (Corresponding_Record_Type (Typ)));
2464 while Present (Elmt) loop
2465 Check_Type_Reference (Node (Elmt), True);
2470 -- For array types, list index types as well. (This is
2471 -- not C, indexes have distinct types).
2473 if Is_Array_Type (XE.Key.Ent) then
2477 Indx := First_Index (XE.Key.Ent);
2478 while Present (Indx) loop
2479 Check_Type_Reference
2480 (First_Subtype (Etype (Indx)), True);
2486 -- If the entity is an overriding operation, write info
2487 -- on operation that was overridden.
2489 if Is_Subprogram (XE.Key.Ent)
2490 and then Present (Overridden_Operation (XE.Key.Ent))
2492 Output_Overridden_Op
2493 (Overridden_Operation (XE.Key.Ent));
2496 -- End of processing for entity output
2498 Crloc := No_Location;
2501 -- Output the reference if it is not as the same location
2502 -- as the previous one, or it is a read-reference that
2503 -- indicates that the entity is an in-out actual in a call.
2505 if XE.Key.Loc /= No_Location
2507 (XE.Key.Loc /= Crloc
2508 or else (Prevt = 'm' and then XE.Key.Typ = 'r'))
2510 Crloc := XE.Key.Loc;
2511 Prevt := XE.Key.Typ;
2513 -- Start continuation if line full, else blank
2515 if Write_Info_Col > 72 then
2517 Write_Info_Initiate ('.');
2520 Write_Info_Char (' ');
2522 -- Output file number if changed
2524 if XE.Key.Lun /= Curru then
2525 Curru := XE.Key.Lun;
2526 Write_Info_Nat (Dependency_Num (Curru));
2527 Write_Info_Char ('|');
2531 (Int (Get_Logical_Line_Number (XE.Key.Loc)));
2532 Write_Info_Char (XE.Key.Typ);
2534 if Is_Overloadable (XE.Key.Ent) then
2535 if (Is_Imported (XE.Key.Ent) and then XE.Key.Typ = 'b')
2537 (Is_Exported (XE.Key.Ent) and then XE.Key.Typ = 'i')
2539 Output_Import_Export_Info (XE.Key.Ent);
2543 Write_Info_Nat (Int (Get_Column_Number (XE.Key.Loc)));
2545 Output_Instantiation_Refs (Sloc (XE.Key.Ent));
2556 end Output_References;
2558 -- Start of elaboration for Lib.Xref
2561 -- Reset is necessary because Elmt_Ptr does not default to Null_Ptr,
2562 -- because it's not an access type.