1 ------------------------------------------------------------------------------
3 -- GNAT COMPILER COMPONENTS --
9 -- Copyright (C) 1998-2012, 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 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 Pragma_Name (P) = Name_Warnings
521 Pragma_Name (P) = Name_Unmodified
523 Pragma_Name (P) = Name_Unreferenced
529 -- A reference to a formal in a named parameter association does
530 -- not make the formal referenced. Formals that are unused in the
531 -- subprogram body are properly flagged as such, even if calls
532 -- elsewhere use named notation.
534 elsif Nkind (P) = N_Parameter_Association
535 and then N = Selector_Name (P)
542 end OK_To_Set_Referenced;
544 -- Start of processing for Generate_Reference
547 pragma Assert (Nkind (E) in N_Entity);
548 Find_Actual (N, Formal, Call);
550 if Present (Formal) then
551 Kind := Ekind (Formal);
556 -- Check for obsolescent reference to package ASCII. GNAT treats this
557 -- element of annex J specially since in practice, programs make a lot
558 -- of use of this feature, so we don't include it in the set of features
559 -- diagnosed when Warn_On_Obsolescent_Features mode is set. However we
560 -- are required to note it as a violation of the RM defined restriction.
562 if E = Standard_ASCII then
563 Check_Restriction (No_Obsolescent_Features, N);
566 -- Check for reference to entity marked with Is_Obsolescent
568 -- Note that we always allow obsolescent references in the compiler
569 -- itself and the run time, since we assume that we know what we are
570 -- doing in such cases. For example the calls in Ada.Characters.Handling
571 -- to its own obsolescent subprograms are just fine.
573 -- In any case we only generate warnings if we are in the extended main
574 -- source unit, and the entity itself is not in the extended main source
575 -- unit, since we assume the source unit itself knows what is going on
576 -- (and for sure we do not want silly warnings, e.g. on the end line of
577 -- an obsolescent procedure body).
579 if Is_Obsolescent (E)
580 and then not GNAT_Mode
581 and then not In_Extended_Main_Source_Unit (E)
582 and then In_Extended_Main_Source_Unit (N)
584 Check_Restriction (No_Obsolescent_Features, N);
586 if Warn_On_Obsolescent_Feature then
587 Output_Obsolescent_Entity_Warnings (N, E);
591 -- Warn if reference to Ada 2005 entity not in Ada 2005 mode. We only
592 -- detect real explicit references (modifications and references).
594 if Comes_From_Source (N)
595 and then Is_Ada_2005_Only (E)
596 and then Ada_Version < Ada_2005
597 and then Warn_On_Ada_2005_Compatibility
598 and then (Typ = 'm' or else Typ = 'r' or else Typ = 's')
600 Error_Msg_NE ("& is only defined in Ada 2005?", N, E);
603 -- Warn if reference to Ada 2012 entity not in Ada 2012 mode. We only
604 -- detect real explicit references (modifications and references).
606 if Comes_From_Source (N)
607 and then Is_Ada_2012_Only (E)
608 and then Ada_Version < Ada_2012
609 and then Warn_On_Ada_2012_Compatibility
610 and then (Typ = 'm' or else Typ = 'r')
612 Error_Msg_NE ("& is only defined in Ada 2012?", N, E);
615 -- Never collect references if not in main source unit. However, we omit
616 -- this test if Typ is 'e' or 'k', since these entries are structural,
617 -- and it is useful to have them in units that reference packages as
618 -- well as units that define packages. We also omit the test for the
619 -- case of 'p' since we want to include inherited primitive operations
620 -- from other packages.
622 -- We also omit this test is this is a body reference for a subprogram
623 -- instantiation. In this case the reference is to the generic body,
624 -- which clearly need not be in the main unit containing the instance.
625 -- For the same reason we accept an implicit reference generated for
626 -- a default in an instance.
628 if not In_Extended_Main_Source_Unit (N) then
634 or else (Typ = 'b' and then Is_Generic_Instance (E))
636 -- Allow the generation of references to reads, writes and calls
637 -- in Alfa mode when the related context comes from an instance.
641 and then In_Extended_Main_Code_Unit (N)
642 and then (Typ = 'm' or else Typ = 'r' or else Typ = 's'))
650 -- For reference type p, the entity must be in main source unit
652 if Typ = 'p' and then not In_Extended_Main_Source_Unit (E) then
656 -- Unless the reference is forced, we ignore references where the
657 -- reference itself does not come from source.
659 if not Force and then not Comes_From_Source (N) then
663 -- Deal with setting entity as referenced, unless suppressed. Note that
664 -- we still do Set_Referenced on entities that do not come from source.
665 -- This situation arises when we have a source reference to a derived
666 -- operation, where the derived operation itself does not come from
667 -- source, but we still want to mark it as referenced, since we really
668 -- are referencing an entity in the corresponding package (this avoids
669 -- wrong complaints that the package contains no referenced entities).
673 -- Assignable object appearing on left side of assignment or as
677 and then Is_On_LHS (N)
678 and then Ekind (E) /= E_In_Out_Parameter
680 -- For objects that are renamings, just set as simply referenced
681 -- we do not try to do assignment type tracking in this case.
683 if Present (Renamed_Object (E)) then
686 -- Out parameter case
688 elsif Kind = E_Out_Parameter then
690 -- If warning mode for all out parameters is set, or this is
691 -- the only warning parameter, then we want to mark this for
692 -- later warning logic by setting Referenced_As_Out_Parameter
694 if Warn_On_Modified_As_Out_Parameter (Formal) then
695 Set_Referenced_As_Out_Parameter (E, True);
696 Set_Referenced_As_LHS (E, False);
698 -- For OUT parameter not covered by the above cases, we simply
699 -- regard it as a normal reference (in this case we do not
700 -- want any of the warning machinery for out parameters).
706 -- For the left hand of an assignment case, we do nothing here.
707 -- The processing for Analyze_Assignment_Statement will set the
708 -- Referenced_As_LHS flag.
714 -- Check for a reference in a pragma that should not count as a
715 -- making the variable referenced for warning purposes.
717 elsif Is_Non_Significant_Pragma_Reference (N) then
720 -- A reference in an attribute definition clause does not count as a
721 -- reference except for the case of Address. The reason that 'Address
722 -- is an exception is that it creates an alias through which the
723 -- variable may be referenced.
725 elsif Nkind (Parent (N)) = N_Attribute_Definition_Clause
726 and then Chars (Parent (N)) /= Name_Address
727 and then N = Name (Parent (N))
731 -- Constant completion does not count as a reference
734 and then Ekind (E) = E_Constant
738 -- Record representation clause does not count as a reference
740 elsif Nkind (N) = N_Identifier
741 and then Nkind (Parent (N)) = N_Record_Representation_Clause
745 -- Discriminants do not need to produce a reference to record type
748 and then Nkind (Parent (N)) = N_Discriminant_Specification
755 -- Special processing for IN OUT parameters, where we have an
756 -- implicit assignment to a simple variable.
758 if Kind = E_In_Out_Parameter
759 and then Is_Assignable (E)
761 -- For sure this counts as a normal read reference
764 Set_Last_Assignment (E, Empty);
766 -- We count it as being referenced as an out parameter if the
767 -- option is set to warn on all out parameters, except that we
768 -- have a special exclusion for an intrinsic subprogram, which
769 -- is most likely an instantiation of Unchecked_Deallocation
770 -- which we do not want to consider as an assignment since it
771 -- generates false positives. We also exclude the case of an
772 -- IN OUT parameter if the name of the procedure is Free,
773 -- since we suspect similar semantics.
775 if Warn_On_All_Unread_Out_Parameters
776 and then Is_Entity_Name (Name (Call))
777 and then not Is_Intrinsic_Subprogram (Entity (Name (Call)))
778 and then Chars (Name (Call)) /= Name_Free
780 Set_Referenced_As_Out_Parameter (E, True);
781 Set_Referenced_As_LHS (E, False);
784 -- Don't count a recursive reference within a subprogram as a
785 -- reference (that allows detection of a recursive subprogram
786 -- whose only references are recursive calls as unreferenced).
788 elsif Is_Subprogram (E)
789 and then E = Nearest_Dynamic_Scope (Current_Scope)
793 -- Any other occurrence counts as referencing the entity
795 elsif OK_To_Set_Referenced then
798 -- If variable, this is an OK reference after an assignment
799 -- so we can clear the Last_Assignment indication.
801 if Is_Assignable (E) then
802 Set_Last_Assignment (E, Empty);
807 -- Check for pragma Unreferenced given and reference is within
808 -- this source unit (occasion for possible warning to be issued).
810 if Has_Unreferenced (E)
811 and then In_Same_Extended_Unit (E, N)
813 -- A reference as a named parameter in a call does not count
814 -- as a violation of pragma Unreferenced for this purpose...
816 if Nkind (N) = N_Identifier
817 and then Nkind (Parent (N)) = N_Parameter_Association
818 and then Selector_Name (Parent (N)) = N
822 -- ... Neither does a reference to a variable on the left side
825 elsif Is_On_LHS (N) then
828 -- For entry formals, we want to place the warning message on the
829 -- corresponding entity in the accept statement. The current scope
830 -- is the body of the accept, so we find the formal whose name
831 -- matches that of the entry formal (there is no link between the
832 -- two entities, and the one in the accept statement is only used
833 -- for conformance checking).
835 elsif Ekind (Scope (E)) = E_Entry then
840 BE := First_Entity (Current_Scope);
841 while Present (BE) loop
842 if Chars (BE) = Chars (E) then
843 Error_Msg_NE -- CODEFIX
844 ("?pragma Unreferenced given for&!", N, BE);
852 -- Here we issue the warning, since this is a real reference
855 Error_Msg_NE -- CODEFIX
856 ("?pragma Unreferenced given for&!", N, E);
860 -- If this is a subprogram instance, mark as well the internal
861 -- subprogram in the wrapper package, which may be a visible
864 if Is_Overloadable (E)
865 and then Is_Generic_Instance (E)
866 and then Present (Alias (E))
868 Set_Referenced (Alias (E));
872 -- Generate reference if all conditions are met:
875 -- Cross referencing must be active
879 -- The entity must be one for which we collect references
881 and then Xref_Entity_Letters (Ekind (E)) /= ' '
883 -- Both Sloc values must be set to something sensible
885 and then Sloc (E) > No_Location
886 and then Sloc (N) > No_Location
888 -- Ignore references from within an instance. The only exceptions to
889 -- this are default subprograms, for which we generate an implicit
890 -- reference and compilations in Alfa_Mode.
893 (Instantiation_Location (Sloc (N)) = No_Location
897 -- Ignore dummy references
901 if Nkind_In (N, N_Identifier,
902 N_Defining_Identifier,
903 N_Defining_Operator_Symbol,
905 N_Defining_Character_Literal)
906 or else Nkind (N) in N_Op
907 or else (Nkind (N) = N_Character_Literal
908 and then Sloc (Entity (N)) /= Standard_Location)
912 elsif Nkind_In (N, N_Expanded_Name, N_Selected_Component) then
913 Nod := Selector_Name (N);
919 -- Normal case of source entity comes from source
921 if Comes_From_Source (E) then
924 -- Entity does not come from source, but is a derived subprogram and
925 -- the derived subprogram comes from source (after one or more
926 -- derivations) in which case the reference is to parent subprogram.
928 elsif Is_Overloadable (E)
929 and then Present (Alias (E))
932 while not Comes_From_Source (Ent) loop
933 if No (Alias (Ent)) then
940 -- The internally created defining entity for a child subprogram
941 -- that has no previous spec has valid references.
943 elsif Is_Overloadable (E)
944 and then Is_Child_Unit (E)
948 -- Ditto for the formals of such a subprogram
950 elsif Is_Overloadable (Scope (E))
951 and then Is_Child_Unit (Scope (E))
955 -- Record components of discriminated subtypes or derived types must
956 -- be treated as references to the original component.
958 elsif Ekind (E) = E_Component
959 and then Comes_From_Source (Original_Record_Component (E))
961 Ent := Original_Record_Component (E);
963 -- If this is an expanded reference to a discriminant, recover the
964 -- original discriminant, which gets the reference.
966 elsif Ekind (E) = E_In_Parameter
967 and then Present (Discriminal_Link (E))
969 Ent := Discriminal_Link (E);
970 Set_Referenced (Ent);
972 -- Ignore reference to any other entity that is not from source
978 -- In Alfa mode, consider the underlying entity renamed instead of
979 -- the renaming, which is needed to compute a valid set of effects
980 -- (reads, writes) for the enclosing subprogram.
983 Ent := Get_Through_Renamings (Ent);
985 -- If no enclosing object, then it could be a reference to any
986 -- location not tracked individually, like heap-allocated data.
987 -- Conservatively approximate this possibility by generating a
988 -- dereference, and return.
991 if Actual_Typ = 'w' then
992 Alfa.Generate_Dereference (Nod, 'r');
993 Alfa.Generate_Dereference (Nod, 'w');
995 Alfa.Generate_Dereference (Nod, 'r');
1002 -- Record reference to entity
1005 and then Is_Subprogram (Nod)
1006 and then Present (Overridden_Operation (Nod))
1015 Ref_Scope := Alfa.Enclosing_Subprogram_Or_Package (Nod);
1016 Ent_Scope := Alfa.Enclosing_Subprogram_Or_Package (Ent);
1018 -- Since we are reaching through renamings in Alfa mode, we may
1019 -- end up with standard constants. Ignore those.
1021 if Sloc (Ent_Scope) <= Standard_Location
1022 or else Def <= Standard_Location
1031 Eun => Get_Code_Unit (Def),
1032 Lun => Get_Code_Unit (Ref),
1033 Ref_Scope => Ref_Scope,
1034 Ent_Scope => Ent_Scope),
1035 Ent_Scope_File => Get_Code_Unit (Ent));
1038 Ref := Original_Location (Sloc (Nod));
1039 Def := Original_Location (Sloc (Ent));
1041 -- If this is an operator symbol, skip the initial quote for
1042 -- navigation purposes. This is not done for the end label,
1043 -- where we want the actual position after the closing quote.
1048 elsif Nkind (N) = N_Defining_Operator_Symbol
1049 or else Nkind (Nod) = N_Operator_Symbol
1058 Eun => Get_Source_Unit (Def),
1059 Lun => Get_Source_Unit (Ref),
1061 Ent_Scope => Empty),
1062 Ent_Scope_File => No_Unit);
1065 end Generate_Reference;
1067 -----------------------------------
1068 -- Generate_Reference_To_Formals --
1069 -----------------------------------
1071 procedure Generate_Reference_To_Formals (E : Entity_Id) is
1075 if Is_Generic_Subprogram (E) then
1076 Formal := First_Entity (E);
1078 while Present (Formal)
1079 and then not Is_Formal (Formal)
1081 Next_Entity (Formal);
1085 Formal := First_Formal (E);
1088 while Present (Formal) loop
1089 if Ekind (Formal) = E_In_Parameter then
1091 if Nkind (Parameter_Type (Parent (Formal)))
1092 = N_Access_Definition
1094 Generate_Reference (E, Formal, '^', False);
1096 Generate_Reference (E, Formal, '>', False);
1099 elsif Ekind (Formal) = E_In_Out_Parameter then
1100 Generate_Reference (E, Formal, '=', False);
1103 Generate_Reference (E, Formal, '<', False);
1106 Next_Formal (Formal);
1108 end Generate_Reference_To_Formals;
1110 -------------------------------------------
1111 -- Generate_Reference_To_Generic_Formals --
1112 -------------------------------------------
1114 procedure Generate_Reference_To_Generic_Formals (E : Entity_Id) is
1118 Formal := First_Entity (E);
1119 while Present (Formal) loop
1120 if Comes_From_Source (Formal) then
1121 Generate_Reference (E, Formal, 'z', False);
1124 Next_Entity (Formal);
1126 end Generate_Reference_To_Generic_Formals;
1132 function Get_Key (E : Xref_Entry_Number) return Xref_Entry_Number is
1141 function Hash (F : Xref_Entry_Number) return Header_Num is
1142 -- It is unlikely to have two references to the same entity at the same
1143 -- source location, so the hash function depends only on the Ent and Loc
1146 XE : Xref_Entry renames Xrefs.Table (F);
1147 type M is mod 2**32;
1149 H : constant M := M (XE.Key.Ent) + 2 ** 7 * M (abs XE.Key.Loc);
1150 -- It would be more natural to write:
1152 -- H : constant M := M'Mod (XE.Key.Ent) + 2**7 * M'Mod (XE.Key.Loc);
1154 -- But we can't use M'Mod, because it prevents bootstrapping with older
1155 -- compilers. Loc can be negative, so we do "abs" before converting.
1156 -- One day this can be cleaned up ???
1159 return Header_Num (H mod Num_Buckets);
1166 procedure HT_Set_Next (E : Xref_Entry_Number; Next : Xref_Entry_Number) is
1168 Xrefs.Table (E).HTable_Next := Next;
1175 function HT_Next (E : Xref_Entry_Number) return Xref_Entry_Number is
1177 return Xrefs.Table (E).HTable_Next;
1184 procedure Initialize is
1193 function Lt (T1, T2 : Xref_Entry) return Boolean is
1195 -- First test: if entity is in different unit, sort by unit
1197 if T1.Key.Eun /= T2.Key.Eun then
1198 return Dependency_Num (T1.Key.Eun) < Dependency_Num (T2.Key.Eun);
1200 -- Second test: within same unit, sort by entity Sloc
1202 elsif T1.Def /= T2.Def then
1203 return T1.Def < T2.Def;
1205 -- Third test: sort definitions ahead of references
1207 elsif T1.Key.Loc = No_Location then
1210 elsif T2.Key.Loc = No_Location then
1213 -- Fourth test: for same entity, sort by reference location unit
1215 elsif T1.Key.Lun /= T2.Key.Lun then
1216 return Dependency_Num (T1.Key.Lun) < Dependency_Num (T2.Key.Lun);
1218 -- Fifth test: order of location within referencing unit
1220 elsif T1.Key.Loc /= T2.Key.Loc then
1221 return T1.Key.Loc < T2.Key.Loc;
1223 -- Finally, for two locations at the same address, we prefer
1224 -- the one that does NOT have the type 'r' so that a modification
1225 -- or extension takes preference, when there are more than one
1226 -- reference at the same location. As a result, in the case of
1227 -- entities that are in-out actuals, the read reference follows
1228 -- the modify reference.
1231 return T2.Key.Typ = 'r';
1235 -----------------------
1236 -- Output_References --
1237 -----------------------
1239 procedure Output_References is
1241 procedure Get_Type_Reference
1243 Tref : out Entity_Id;
1244 Left : out Character;
1245 Right : out Character);
1246 -- Given an Entity_Id Ent, determines whether a type reference is
1247 -- required. If so, Tref is set to the entity for the type reference
1248 -- and Left and Right are set to the left/right brackets to be output
1249 -- for the reference. If no type reference is required, then Tref is
1250 -- set to Empty, and Left/Right are set to space.
1252 procedure Output_Import_Export_Info (Ent : Entity_Id);
1253 -- Output language and external name information for an interfaced
1254 -- entity, using the format <language, external_name>.
1256 ------------------------
1257 -- Get_Type_Reference --
1258 ------------------------
1260 procedure Get_Type_Reference
1262 Tref : out Entity_Id;
1263 Left : out Character;
1264 Right : out Character)
1269 -- See if we have a type reference
1278 -- Processing for types
1280 if Is_Type (Tref) then
1282 -- Case of base type
1284 if Base_Type (Tref) = Tref then
1286 -- If derived, then get first subtype
1288 if Tref /= Etype (Tref) then
1289 Tref := First_Subtype (Etype (Tref));
1291 -- Set brackets for derived type, but don't override
1292 -- pointer case since the fact that something is a
1293 -- pointer is more important.
1300 -- If non-derived ptr, get directly designated type.
1301 -- If the type has a full view, all references are on the
1302 -- partial view, that is seen first.
1304 elsif Is_Access_Type (Tref) then
1305 Tref := Directly_Designated_Type (Tref);
1309 elsif Is_Private_Type (Tref)
1310 and then Present (Full_View (Tref))
1312 if Is_Access_Type (Full_View (Tref)) then
1313 Tref := Directly_Designated_Type (Full_View (Tref));
1317 -- If the full view is an array type, we also retrieve
1318 -- the corresponding component type, because the ali
1319 -- entry already indicates that this is an array.
1321 elsif Is_Array_Type (Full_View (Tref)) then
1322 Tref := Component_Type (Full_View (Tref));
1327 -- If non-derived array, get component type. Skip component
1328 -- type for case of String or Wide_String, saves worthwhile
1331 elsif Is_Array_Type (Tref)
1332 and then Tref /= Standard_String
1333 and then Tref /= Standard_Wide_String
1335 Tref := Component_Type (Tref);
1339 -- For other non-derived base types, nothing
1345 -- For a subtype, go to ancestor subtype
1348 Tref := Ancestor_Subtype (Tref);
1350 -- If no ancestor subtype, go to base type
1353 Tref := Base_Type (Sav);
1357 -- For objects, functions, enum literals, just get type from
1360 elsif Is_Object (Tref)
1361 or else Ekind (Tref) = E_Enumeration_Literal
1362 or else Ekind (Tref) = E_Function
1363 or else Ekind (Tref) = E_Operator
1365 Tref := Etype (Tref);
1367 -- For anything else, exit
1373 -- Exit if no type reference, or we are stuck in some loop trying
1374 -- to find the type reference, or if the type is standard void
1375 -- type (the latter is an implementation artifact that should not
1376 -- show up in the generated cross-references).
1380 or else Tref = Standard_Void_Type;
1382 -- If we have a usable type reference, return, otherwise keep
1383 -- looking for something useful (we are looking for something
1384 -- that either comes from source or standard)
1386 if Sloc (Tref) = Standard_Location
1387 or else Comes_From_Source (Tref)
1389 -- If the reference is a subtype created for a generic actual,
1390 -- go actual directly, the inner subtype is not user visible.
1392 if Nkind (Parent (Tref)) = N_Subtype_Declaration
1393 and then not Comes_From_Source (Parent (Tref))
1395 (Is_Wrapper_Package (Scope (Tref))
1396 or else Is_Generic_Instance (Scope (Tref)))
1398 Tref := First_Subtype (Base_Type (Tref));
1405 -- If we fall through the loop, no type reference
1410 end Get_Type_Reference;
1412 -------------------------------
1413 -- Output_Import_Export_Info --
1414 -------------------------------
1416 procedure Output_Import_Export_Info (Ent : Entity_Id) is
1417 Language_Name : Name_Id;
1418 Conv : constant Convention_Id := Convention (Ent);
1421 -- Generate language name from convention
1423 if Conv = Convention_C then
1424 Language_Name := Name_C;
1426 elsif Conv = Convention_CPP then
1427 Language_Name := Name_CPP;
1429 elsif Conv = Convention_Ada then
1430 Language_Name := Name_Ada;
1433 -- For the moment we ignore all other cases ???
1438 Write_Info_Char ('<');
1439 Get_Unqualified_Name_String (Language_Name);
1441 for J in 1 .. Name_Len loop
1442 Write_Info_Char (Name_Buffer (J));
1445 if Present (Interface_Name (Ent)) then
1446 Write_Info_Char (',');
1447 String_To_Name_Buffer (Strval (Interface_Name (Ent)));
1449 for J in 1 .. Name_Len loop
1450 Write_Info_Char (Name_Buffer (J));
1454 Write_Info_Char ('>');
1455 end Output_Import_Export_Info;
1457 -- Start of processing for Output_References
1460 -- First we add references to the primitive operations of tagged types
1461 -- declared in the main unit.
1463 Handle_Prim_Ops : declare
1467 for J in 1 .. Xrefs.Last loop
1468 Ent := Xrefs.Table (J).Key.Ent;
1471 and then Is_Tagged_Type (Ent)
1472 and then Is_Base_Type (Ent)
1473 and then In_Extended_Main_Source_Unit (Ent)
1475 Generate_Prim_Op_References (Ent);
1478 end Handle_Prim_Ops;
1480 -- Before we go ahead and output the references we have a problem
1481 -- that needs dealing with. So far we have captured things that are
1482 -- definitely referenced by the main unit, or defined in the main
1483 -- unit. That's because we don't want to clutter up the ali file
1484 -- for this unit with definition lines for entities in other units
1485 -- that are not referenced.
1487 -- But there is a glitch. We may reference an entity in another unit,
1488 -- and it may have a type reference to an entity that is not directly
1489 -- referenced in the main unit, which may mean that there is no xref
1490 -- entry for this entity yet in the list of references.
1492 -- If we don't do something about this, we will end with an orphan type
1493 -- reference, i.e. it will point to an entity that does not appear
1494 -- within the generated references in the ali file. That is not good for
1495 -- tools using the xref information.
1497 -- To fix this, we go through the references adding definition entries
1498 -- for any unreferenced entities that can be referenced in a type
1499 -- reference. There is a recursion problem here, and that is dealt with
1500 -- by making sure that this traversal also traverses any entries that
1501 -- get added by the traversal.
1503 Handle_Orphan_Type_References : declare
1509 pragma Warnings (Off, L);
1510 pragma Warnings (Off, R);
1512 procedure New_Entry (E : Entity_Id);
1513 -- Make an additional entry into the Xref table for a type entity
1514 -- that is related to the current entity (parent, type ancestor,
1515 -- progenitor, etc.).
1521 procedure New_Entry (E : Entity_Id) is
1523 pragma Assert (Present (E));
1525 if not Has_Xref_Entry (Implementation_Base_Type (E))
1526 and then Sloc (E) > No_Location
1531 Typ => Character'First,
1532 Eun => Get_Source_Unit (Original_Location (Sloc (E))),
1535 Ent_Scope => Empty),
1536 Ent_Scope_File => No_Unit);
1540 -- Start of processing for Handle_Orphan_Type_References
1543 -- Note that this is not a for loop for a very good reason. The
1544 -- processing of items in the table can add new items to the table,
1545 -- and they must be processed as well.
1548 while J <= Xrefs.Last loop
1549 Ent := Xrefs.Table (J).Key.Ent;
1550 Get_Type_Reference (Ent, Tref, L, R);
1553 and then not Has_Xref_Entry (Tref)
1554 and then Sloc (Tref) > No_Location
1558 if Is_Record_Type (Ent)
1559 and then Present (Interfaces (Ent))
1561 -- Add an entry for each one of the given interfaces
1562 -- implemented by type Ent.
1565 Elmt : Elmt_Id := First_Elmt (Interfaces (Ent));
1567 while Present (Elmt) loop
1568 New_Entry (Node (Elmt));
1575 -- Collect inherited primitive operations that may be declared in
1576 -- another unit and have no visible reference in the current one.
1579 and then Is_Tagged_Type (Ent)
1580 and then Is_Derived_Type (Ent)
1581 and then Is_Base_Type (Ent)
1582 and then In_Extended_Main_Source_Unit (Ent)
1585 Op_List : constant Elist_Id := Primitive_Operations (Ent);
1589 function Parent_Op (E : Entity_Id) return Entity_Id;
1590 -- Find original operation, which may be inherited through
1591 -- several derivations.
1593 function Parent_Op (E : Entity_Id) return Entity_Id is
1594 Orig_Op : constant Entity_Id := Alias (E);
1597 if No (Orig_Op) then
1600 elsif not Comes_From_Source (E)
1601 and then not Has_Xref_Entry (Orig_Op)
1602 and then Comes_From_Source (Orig_Op)
1606 return Parent_Op (Orig_Op);
1611 Op := First_Elmt (Op_List);
1612 while Present (Op) loop
1613 Prim := Parent_Op (Node (Op));
1615 if Present (Prim) then
1619 Typ => Character'First,
1620 Eun => Get_Source_Unit (Sloc (Prim)),
1623 Ent_Scope => Empty),
1624 Ent_Scope_File => No_Unit);
1634 end Handle_Orphan_Type_References;
1636 -- Now we have all the references, including those for any embedded
1637 -- type references, so we can sort them, and output them.
1639 Output_Refs : declare
1641 Nrefs : constant Nat := Xrefs.Last;
1642 -- Number of references in table
1644 Rnums : array (0 .. Nrefs) of Nat;
1645 -- This array contains numbers of references in the Xrefs table.
1646 -- This list is sorted in output order. The extra 0'th entry is
1647 -- convenient for the call to sort. When we sort the table, we
1648 -- move the entries in Rnums around, but we do not move the
1649 -- original table entries.
1651 Curxu : Unit_Number_Type;
1652 -- Current xref unit
1654 Curru : Unit_Number_Type;
1655 -- Current reference unit for one entity
1660 Curnam : String (1 .. Name_Buffer'Length);
1662 -- Simple name and length of current entity
1664 Curdef : Source_Ptr;
1665 -- Original source location for current entity
1668 -- Current reference location
1671 -- Entity type character
1674 -- reference kind of previous reference
1680 -- Renaming reference
1682 Trunit : Unit_Number_Type;
1683 -- Unit number for type reference
1685 function Lt (Op1, Op2 : Natural) return Boolean;
1686 -- Comparison function for Sort call
1688 function Name_Change (X : Entity_Id) return Boolean;
1689 -- Determines if entity X has a different simple name from Curent
1691 procedure Move (From : Natural; To : Natural);
1692 -- Move procedure for Sort call
1694 package Sorting is new GNAT.Heap_Sort_G (Move, Lt);
1700 function Lt (Op1, Op2 : Natural) return Boolean is
1701 T1 : Xref_Entry renames Xrefs.Table (Rnums (Nat (Op1)));
1702 T2 : Xref_Entry renames Xrefs.Table (Rnums (Nat (Op2)));
1712 procedure Move (From : Natural; To : Natural) is
1714 Rnums (Nat (To)) := Rnums (Nat (From));
1721 -- Why a string comparison here??? Why not compare Name_Id values???
1723 function Name_Change (X : Entity_Id) return Boolean is
1725 Get_Unqualified_Name_String (Chars (X));
1727 if Name_Len /= Curlen then
1730 return Name_Buffer (1 .. Curlen) /= Curnam (1 .. Curlen);
1734 -- Start of processing for Output_Refs
1737 -- Capture the definition Sloc values. We delay doing this till now,
1738 -- since at the time the reference or definition is made, private
1739 -- types may be swapped, and the Sloc value may be incorrect. We
1740 -- also set up the pointer vector for the sort.
1742 -- For user-defined operators we need to skip the initial quote and
1743 -- point to the first character of the name, for navigation purposes.
1745 for J in 1 .. Nrefs loop
1747 E : constant Entity_Id := Xrefs.Table (J).Key.Ent;
1748 Loc : constant Source_Ptr := Original_Location (Sloc (E));
1753 if Nkind (E) = N_Defining_Operator_Symbol then
1754 Xrefs.Table (J).Def := Loc + 1;
1756 Xrefs.Table (J).Def := Loc;
1761 -- Sort the references
1763 Sorting.Sort (Integer (Nrefs));
1765 -- Initialize loop through references
1769 Curdef := No_Location;
1771 Crloc := No_Location;
1774 -- Loop to output references
1776 for Refno in 1 .. Nrefs loop
1777 Output_One_Ref : declare
1780 XE : Xref_Entry renames Xrefs.Table (Rnums (Refno));
1781 -- The current entry to be accessed
1785 -- Used for {} or <> or () for type reference
1787 procedure Check_Type_Reference
1789 List_Interface : Boolean);
1790 -- Find whether there is a meaningful type reference for
1791 -- Ent, and display it accordingly. If List_Interface is
1792 -- true, then Ent is a progenitor interface of the current
1793 -- type entity being listed. In that case list it as is,
1794 -- without looking for a type reference for it.
1796 procedure Output_Instantiation_Refs (Loc : Source_Ptr);
1797 -- Recursive procedure to output instantiation references for
1798 -- the given source ptr in [file|line[...]] form. No output
1799 -- if the given location is not a generic template reference.
1801 procedure Output_Overridden_Op (Old_E : Entity_Id);
1802 -- For a subprogram that is overriding, display information
1803 -- about the inherited operation that it overrides.
1805 --------------------------
1806 -- Check_Type_Reference --
1807 --------------------------
1809 procedure Check_Type_Reference
1811 List_Interface : Boolean)
1814 if List_Interface then
1816 -- This is a progenitor interface of the type for which
1817 -- xref information is being generated.
1824 Get_Type_Reference (Ent, Tref, Left, Right);
1827 if Present (Tref) then
1829 -- Case of standard entity, output name
1831 if Sloc (Tref) = Standard_Location then
1832 Write_Info_Char (Left);
1833 Write_Info_Name (Chars (Tref));
1834 Write_Info_Char (Right);
1836 -- Case of source entity, output location
1839 Write_Info_Char (Left);
1840 Trunit := Get_Source_Unit (Sloc (Tref));
1842 if Trunit /= Curxu then
1843 Write_Info_Nat (Dependency_Num (Trunit));
1844 Write_Info_Char ('|');
1848 (Int (Get_Logical_Line_Number (Sloc (Tref))));
1856 Ctyp := Xref_Entity_Letters (Ekind (Ent));
1859 and then Present (Full_View (Ent))
1861 Ent := Underlying_Type (Ent);
1863 if Present (Ent) then
1864 Ctyp := Xref_Entity_Letters (Ekind (Ent));
1868 Write_Info_Char (Ctyp);
1872 (Int (Get_Column_Number (Sloc (Tref))));
1874 -- If the type comes from an instantiation, add the
1875 -- corresponding info.
1877 Output_Instantiation_Refs (Sloc (Tref));
1878 Write_Info_Char (Right);
1881 end Check_Type_Reference;
1883 -------------------------------
1884 -- Output_Instantiation_Refs --
1885 -------------------------------
1887 procedure Output_Instantiation_Refs (Loc : Source_Ptr) is
1888 Iloc : constant Source_Ptr := Instantiation_Location (Loc);
1889 Lun : Unit_Number_Type;
1890 Cu : constant Unit_Number_Type := Curru;
1893 -- Nothing to do if this is not an instantiation
1895 if Iloc = No_Location then
1899 -- Output instantiation reference
1901 Write_Info_Char ('[');
1902 Lun := Get_Source_Unit (Iloc);
1904 if Lun /= Curru then
1906 Write_Info_Nat (Dependency_Num (Curru));
1907 Write_Info_Char ('|');
1910 Write_Info_Nat (Int (Get_Logical_Line_Number (Iloc)));
1912 -- Recursive call to get nested instantiations
1914 Output_Instantiation_Refs (Iloc);
1916 -- Output final ] after call to get proper nesting
1918 Write_Info_Char (']');
1921 end Output_Instantiation_Refs;
1923 --------------------------
1924 -- Output_Overridden_Op --
1925 --------------------------
1927 procedure Output_Overridden_Op (Old_E : Entity_Id) is
1931 -- The overridden operation has an implicit declaration
1932 -- at the point of derivation. What we want to display
1933 -- is the original operation, which has the actual body
1934 -- (or abstract declaration) that is being overridden.
1935 -- The overridden operation is not always set, e.g. when
1936 -- it is a predefined operator.
1941 -- Follow alias chain if one is present
1943 elsif Present (Alias (Old_E)) then
1945 -- The subprogram may have been implicitly inherited
1946 -- through several levels of derivation, so find the
1947 -- ultimate (source) ancestor.
1949 Op := Ultimate_Alias (Old_E);
1951 -- Normal case of no alias present. We omit generated
1952 -- primitives like tagged equality, that have no source
1960 and then Sloc (Op) /= Standard_Location
1961 and then Comes_From_Source (Op)
1964 Loc : constant Source_Ptr := Sloc (Op);
1965 Par_Unit : constant Unit_Number_Type :=
1966 Get_Source_Unit (Loc);
1969 Write_Info_Char ('<');
1971 if Par_Unit /= Curxu then
1972 Write_Info_Nat (Dependency_Num (Par_Unit));
1973 Write_Info_Char ('|');
1976 Write_Info_Nat (Int (Get_Logical_Line_Number (Loc)));
1977 Write_Info_Char ('p');
1978 Write_Info_Nat (Int (Get_Column_Number (Loc)));
1979 Write_Info_Char ('>');
1982 end Output_Overridden_Op;
1984 -- Start of processing for Output_One_Ref
1988 Ctyp := Xref_Entity_Letters (Ekind (Ent));
1990 -- Skip reference if it is the only reference to an entity,
1991 -- and it is an END line reference, and the entity is not in
1992 -- the current extended source. This prevents junk entries
1993 -- consisting only of packages with END lines, where no
1994 -- entity from the package is actually referenced.
1997 and then Ent /= Curent
1998 and then (Refno = Nrefs
2000 Ent /= Xrefs.Table (Rnums (Refno + 1)).Key.Ent)
2001 and then not In_Extended_Main_Source_Unit (Ent)
2006 -- For private type, get full view type
2009 and then Present (Full_View (XE.Key.Ent))
2011 Ent := Underlying_Type (Ent);
2013 if Present (Ent) then
2014 Ctyp := Xref_Entity_Letters (Ekind (Ent));
2018 -- Special exception for Boolean
2020 if Ctyp = 'E' and then Is_Boolean_Type (Ent) then
2024 -- For variable reference, get corresponding type
2027 Ent := Etype (XE.Key.Ent);
2028 Ctyp := Fold_Lower (Xref_Entity_Letters (Ekind (Ent)));
2030 -- If variable is private type, get full view type
2033 and then Present (Full_View (Etype (XE.Key.Ent)))
2035 Ent := Underlying_Type (Etype (XE.Key.Ent));
2037 if Present (Ent) then
2038 Ctyp := Fold_Lower (Xref_Entity_Letters (Ekind (Ent)));
2041 elsif Is_Generic_Type (Ent) then
2043 -- If the type of the entity is a generic private type,
2044 -- there is no usable full view, so retain the indication
2045 -- that this is an object.
2050 -- Special handling for access parameters and objects of
2051 -- an anonymous access type.
2053 if Ekind_In (Etype (XE.Key.Ent),
2054 E_Anonymous_Access_Type,
2055 E_Anonymous_Access_Subprogram_Type,
2056 E_Anonymous_Access_Protected_Subprogram_Type)
2058 if Is_Formal (XE.Key.Ent)
2059 or else Ekind_In (XE.Key.Ent, E_Variable, E_Constant)
2064 -- Special handling for Boolean
2066 elsif Ctyp = 'e' and then Is_Boolean_Type (Ent) then
2071 -- Special handling for abstract types and operations
2073 if Is_Overloadable (XE.Key.Ent)
2074 and then Is_Abstract_Subprogram (XE.Key.Ent)
2077 Ctyp := 'x'; -- Abstract procedure
2079 elsif Ctyp = 'V' then
2080 Ctyp := 'y'; -- Abstract function
2083 elsif Is_Type (XE.Key.Ent)
2084 and then Is_Abstract_Type (XE.Key.Ent)
2086 if Is_Interface (XE.Key.Ent) then
2089 elsif Ctyp = 'R' then
2090 Ctyp := 'H'; -- Abstract type
2094 -- Only output reference if interesting type of entity
2098 -- Suppress references to object definitions, used for local
2101 or else XE.Key.Typ = 'D'
2102 or else XE.Key.Typ = 'I'
2104 -- Suppress self references, except for bodies that act as
2107 or else (XE.Key.Loc = XE.Def
2110 or else not Is_Subprogram (XE.Key.Ent)))
2112 -- Also suppress definitions of body formals (we only
2113 -- treat these as references, and the references were
2114 -- separately recorded).
2116 or else (Is_Formal (XE.Key.Ent)
2117 and then Present (Spec_Entity (XE.Key.Ent)))
2122 -- Start new Xref section if new xref unit
2124 if XE.Key.Eun /= Curxu then
2125 if Write_Info_Col > 1 then
2129 Curxu := XE.Key.Eun;
2131 Write_Info_Initiate ('X');
2132 Write_Info_Char (' ');
2133 Write_Info_Nat (Dependency_Num (XE.Key.Eun));
2134 Write_Info_Char (' ');
2136 (Reference_Name (Source_Index (XE.Key.Eun)));
2139 -- Start new Entity line if new entity. Note that we
2140 -- consider two entities the same if they have the same
2141 -- name and source location. This causes entities in
2142 -- instantiations to be treated as though they referred
2147 (XE.Key.Ent /= Curent
2149 (Name_Change (XE.Key.Ent) or else XE.Def /= Curdef))
2151 Curent := XE.Key.Ent;
2154 Get_Unqualified_Name_String (Chars (XE.Key.Ent));
2156 Curnam (1 .. Curlen) := Name_Buffer (1 .. Curlen);
2158 if Write_Info_Col > 1 then
2162 -- Write column number information
2164 Write_Info_Nat (Int (Get_Logical_Line_Number (XE.Def)));
2165 Write_Info_Char (Ctyp);
2166 Write_Info_Nat (Int (Get_Column_Number (XE.Def)));
2168 -- Write level information
2170 Write_Level_Info : declare
2171 function Is_Visible_Generic_Entity
2172 (E : Entity_Id) return Boolean;
2173 -- Check whether E is declared in the visible part
2174 -- of a generic package. For source navigation
2175 -- purposes, treat this as a visible entity.
2177 function Is_Private_Record_Component
2178 (E : Entity_Id) return Boolean;
2179 -- Check whether E is a non-inherited component of a
2180 -- private extension. Even if the enclosing record is
2181 -- public, we want to treat the component as private
2182 -- for navigation purposes.
2184 ---------------------------------
2185 -- Is_Private_Record_Component --
2186 ---------------------------------
2188 function Is_Private_Record_Component
2189 (E : Entity_Id) return Boolean
2191 S : constant Entity_Id := Scope (E);
2194 Ekind (E) = E_Component
2195 and then Nkind (Declaration_Node (S)) =
2196 N_Private_Extension_Declaration
2197 and then Original_Record_Component (E) = E;
2198 end Is_Private_Record_Component;
2200 -------------------------------
2201 -- Is_Visible_Generic_Entity --
2202 -------------------------------
2204 function Is_Visible_Generic_Entity
2205 (E : Entity_Id) return Boolean
2210 -- The Present check here is an error defense
2212 if Present (Scope (E))
2213 and then Ekind (Scope (E)) /= E_Generic_Package
2219 while Present (Par) loop
2221 Nkind (Par) = N_Generic_Package_Declaration
2223 -- Entity is a generic formal
2228 Nkind (Parent (Par)) = N_Package_Specification
2231 Is_List_Member (Par)
2232 and then List_Containing (Par) =
2233 Visible_Declarations (Parent (Par));
2235 Par := Parent (Par);
2240 end Is_Visible_Generic_Entity;
2242 -- Start of processing for Write_Level_Info
2245 if Is_Hidden (Curent)
2246 or else Is_Private_Record_Component (Curent)
2248 Write_Info_Char (' ');
2252 or else Is_Visible_Generic_Entity (Curent)
2254 Write_Info_Char ('*');
2257 Write_Info_Char (' ');
2259 end Write_Level_Info;
2261 -- Output entity name. We use the occurrence from the
2262 -- actual source program at the definition point.
2265 Ent_Name : constant String :=
2266 Exact_Source_Name (Sloc (XE.Key.Ent));
2268 for C in Ent_Name'Range loop
2269 Write_Info_Char (Ent_Name (C));
2273 -- See if we have a renaming reference
2275 if Is_Object (XE.Key.Ent)
2276 and then Present (Renamed_Object (XE.Key.Ent))
2278 Rref := Renamed_Object (XE.Key.Ent);
2280 elsif Is_Overloadable (XE.Key.Ent)
2281 and then Nkind (Parent (Declaration_Node (XE.Key.Ent)))
2282 = N_Subprogram_Renaming_Declaration
2284 Rref := Name (Parent (Declaration_Node (XE.Key.Ent)));
2286 elsif Ekind (XE.Key.Ent) = E_Package
2287 and then Nkind (Declaration_Node (XE.Key.Ent)) =
2288 N_Package_Renaming_Declaration
2290 Rref := Name (Declaration_Node (XE.Key.Ent));
2296 if Present (Rref) then
2297 if Nkind (Rref) = N_Expanded_Name then
2298 Rref := Selector_Name (Rref);
2301 if Nkind (Rref) = N_Identifier
2302 or else Nkind (Rref) = N_Operator_Symbol
2306 -- For renamed array components, use the array name
2307 -- for the renamed entity, which reflect the fact that
2308 -- in general the whole array is aliased.
2310 elsif Nkind (Rref) = N_Indexed_Component then
2311 if Nkind (Prefix (Rref)) = N_Identifier then
2312 Rref := Prefix (Rref);
2313 elsif Nkind (Prefix (Rref)) = N_Expanded_Name then
2314 Rref := Selector_Name (Prefix (Rref));
2324 -- Write out renaming reference if we have one
2326 if Present (Rref) then
2327 Write_Info_Char ('=');
2329 (Int (Get_Logical_Line_Number (Sloc (Rref))));
2330 Write_Info_Char (':');
2332 (Int (Get_Column_Number (Sloc (Rref))));
2335 -- Indicate that the entity is in the unit of the current
2340 -- Write out information about generic parent, if entity
2343 if Is_Generic_Instance (XE.Key.Ent) then
2345 Gen_Par : constant Entity_Id :=
2348 (Unit_Declaration_Node
2350 Loc : constant Source_Ptr := Sloc (Gen_Par);
2351 Gen_U : constant Unit_Number_Type :=
2352 Get_Source_Unit (Loc);
2355 Write_Info_Char ('[');
2357 if Curru /= Gen_U then
2358 Write_Info_Nat (Dependency_Num (Gen_U));
2359 Write_Info_Char ('|');
2363 (Int (Get_Logical_Line_Number (Loc)));
2364 Write_Info_Char (']');
2368 -- See if we have a type reference and if so output
2370 Check_Type_Reference (XE.Key.Ent, False);
2372 -- Additional information for types with progenitors
2374 if Is_Record_Type (XE.Key.Ent)
2375 and then Present (Interfaces (XE.Key.Ent))
2379 First_Elmt (Interfaces (XE.Key.Ent));
2381 while Present (Elmt) loop
2382 Check_Type_Reference (Node (Elmt), True);
2387 -- For array types, list index types as well. (This is
2388 -- not C, indexes have distinct types).
2390 elsif Is_Array_Type (XE.Key.Ent) then
2394 Indx := First_Index (XE.Key.Ent);
2395 while Present (Indx) loop
2396 Check_Type_Reference
2397 (First_Subtype (Etype (Indx)), True);
2403 -- If the entity is an overriding operation, write info
2404 -- on operation that was overridden.
2406 if Is_Subprogram (XE.Key.Ent)
2407 and then Present (Overridden_Operation (XE.Key.Ent))
2409 Output_Overridden_Op
2410 (Overridden_Operation (XE.Key.Ent));
2413 -- End of processing for entity output
2415 Crloc := No_Location;
2418 -- Output the reference if it is not as the same location
2419 -- as the previous one, or it is a read-reference that
2420 -- indicates that the entity is an in-out actual in a call.
2422 if XE.Key.Loc /= No_Location
2424 (XE.Key.Loc /= Crloc
2425 or else (Prevt = 'm' and then XE.Key.Typ = 'r'))
2427 Crloc := XE.Key.Loc;
2428 Prevt := XE.Key.Typ;
2430 -- Start continuation if line full, else blank
2432 if Write_Info_Col > 72 then
2434 Write_Info_Initiate ('.');
2437 Write_Info_Char (' ');
2439 -- Output file number if changed
2441 if XE.Key.Lun /= Curru then
2442 Curru := XE.Key.Lun;
2443 Write_Info_Nat (Dependency_Num (Curru));
2444 Write_Info_Char ('|');
2448 (Int (Get_Logical_Line_Number (XE.Key.Loc)));
2449 Write_Info_Char (XE.Key.Typ);
2451 if Is_Overloadable (XE.Key.Ent) then
2452 if (Is_Imported (XE.Key.Ent) and then XE.Key.Typ = 'b')
2454 (Is_Exported (XE.Key.Ent) and then XE.Key.Typ = 'i')
2456 Output_Import_Export_Info (XE.Key.Ent);
2460 Write_Info_Nat (Int (Get_Column_Number (XE.Key.Loc)));
2462 Output_Instantiation_Refs (Sloc (XE.Key.Ent));
2473 end Output_References;
2475 -- Start of elaboration for Lib.Xref
2478 -- Reset is necessary because Elmt_Ptr does not default to Null_Ptr,
2479 -- because it's not an access type.