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 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 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 -- Never collect references if not in main source unit. However, we omit
614 -- this test if Typ is 'e' or 'k', since these entries are structural,
615 -- and it is useful to have them in units that reference packages as
616 -- well as units that define packages. We also omit the test for the
617 -- case of 'p' since we want to include inherited primitive operations
618 -- from other packages.
620 -- We also omit this test is this is a body reference for a subprogram
621 -- instantiation. In this case the reference is to the generic body,
622 -- which clearly need not be in the main unit containing the instance.
623 -- For the same reason we accept an implicit reference generated for
624 -- a default in an instance.
626 if not In_Extended_Main_Source_Unit (N) then
632 or else (Typ = 'b' and then Is_Generic_Instance (E))
634 -- Allow the generation of references to reads, writes and calls
635 -- in Alfa mode when the related context comes from an instance.
639 and then In_Extended_Main_Code_Unit (N)
640 and then (Typ = 'm' or else Typ = 'r' or else Typ = 's'))
648 -- For reference type p, the entity must be in main source unit
650 if Typ = 'p' and then not In_Extended_Main_Source_Unit (E) then
654 -- Unless the reference is forced, we ignore references where the
655 -- reference itself does not come from source.
657 if not Force and then not Comes_From_Source (N) then
661 -- Deal with setting entity as referenced, unless suppressed. Note that
662 -- we still do Set_Referenced on entities that do not come from source.
663 -- This situation arises when we have a source reference to a derived
664 -- operation, where the derived operation itself does not come from
665 -- source, but we still want to mark it as referenced, since we really
666 -- are referencing an entity in the corresponding package (this avoids
667 -- wrong complaints that the package contains no referenced entities).
671 -- Assignable object appearing on left side of assignment or as
675 and then Is_On_LHS (N)
676 and then Ekind (E) /= E_In_Out_Parameter
678 -- For objects that are renamings, just set as simply referenced
679 -- we do not try to do assignment type tracking in this case.
681 if Present (Renamed_Object (E)) then
684 -- Out parameter case
686 elsif Kind = E_Out_Parameter then
688 -- If warning mode for all out parameters is set, or this is
689 -- the only warning parameter, then we want to mark this for
690 -- later warning logic by setting Referenced_As_Out_Parameter
692 if Warn_On_Modified_As_Out_Parameter (Formal) then
693 Set_Referenced_As_Out_Parameter (E, True);
694 Set_Referenced_As_LHS (E, False);
696 -- For OUT parameter not covered by the above cases, we simply
697 -- regard it as a normal reference (in this case we do not
698 -- want any of the warning machinery for out parameters).
704 -- For the left hand of an assignment case, we do nothing here.
705 -- The processing for Analyze_Assignment_Statement will set the
706 -- Referenced_As_LHS flag.
712 -- Check for a reference in a pragma that should not count as a
713 -- making the variable referenced for warning purposes.
715 elsif Is_Non_Significant_Pragma_Reference (N) then
718 -- A reference in an attribute definition clause does not count as a
719 -- reference except for the case of Address. The reason that 'Address
720 -- is an exception is that it creates an alias through which the
721 -- variable may be referenced.
723 elsif Nkind (Parent (N)) = N_Attribute_Definition_Clause
724 and then Chars (Parent (N)) /= Name_Address
725 and then N = Name (Parent (N))
729 -- Constant completion does not count as a reference
732 and then Ekind (E) = E_Constant
736 -- Record representation clause does not count as a reference
738 elsif Nkind (N) = N_Identifier
739 and then Nkind (Parent (N)) = N_Record_Representation_Clause
743 -- Discriminants do not need to produce a reference to record type
746 and then Nkind (Parent (N)) = N_Discriminant_Specification
753 -- Special processing for IN OUT parameters, where we have an
754 -- implicit assignment to a simple variable.
756 if Kind = E_In_Out_Parameter
757 and then Is_Assignable (E)
759 -- For sure this counts as a normal read reference
762 Set_Last_Assignment (E, Empty);
764 -- We count it as being referenced as an out parameter if the
765 -- option is set to warn on all out parameters, except that we
766 -- have a special exclusion for an intrinsic subprogram, which
767 -- is most likely an instantiation of Unchecked_Deallocation
768 -- which we do not want to consider as an assignment since it
769 -- generates false positives. We also exclude the case of an
770 -- IN OUT parameter if the name of the procedure is Free,
771 -- since we suspect similar semantics.
773 if Warn_On_All_Unread_Out_Parameters
774 and then Is_Entity_Name (Name (Call))
775 and then not Is_Intrinsic_Subprogram (Entity (Name (Call)))
776 and then Chars (Name (Call)) /= Name_Free
778 Set_Referenced_As_Out_Parameter (E, True);
779 Set_Referenced_As_LHS (E, False);
782 -- Don't count a recursive reference within a subprogram as a
783 -- reference (that allows detection of a recursive subprogram
784 -- whose only references are recursive calls as unreferenced).
786 elsif Is_Subprogram (E)
787 and then E = Nearest_Dynamic_Scope (Current_Scope)
791 -- Any other occurrence counts as referencing the entity
793 elsif OK_To_Set_Referenced then
796 -- If variable, this is an OK reference after an assignment
797 -- so we can clear the Last_Assignment indication.
799 if Is_Assignable (E) then
800 Set_Last_Assignment (E, Empty);
805 -- Check for pragma Unreferenced given and reference is within
806 -- this source unit (occasion for possible warning to be issued).
808 if Has_Unreferenced (E)
809 and then In_Same_Extended_Unit (E, N)
811 -- A reference as a named parameter in a call does not count
812 -- as a violation of pragma Unreferenced for this purpose...
814 if Nkind (N) = N_Identifier
815 and then Nkind (Parent (N)) = N_Parameter_Association
816 and then Selector_Name (Parent (N)) = N
820 -- ... Neither does a reference to a variable on the left side
823 elsif Is_On_LHS (N) then
826 -- For entry formals, we want to place the warning message on the
827 -- corresponding entity in the accept statement. The current scope
828 -- is the body of the accept, so we find the formal whose name
829 -- matches that of the entry formal (there is no link between the
830 -- two entities, and the one in the accept statement is only used
831 -- for conformance checking).
833 elsif Ekind (Scope (E)) = E_Entry then
838 BE := First_Entity (Current_Scope);
839 while Present (BE) loop
840 if Chars (BE) = Chars (E) then
841 Error_Msg_NE -- CODEFIX
842 ("??pragma Unreferenced given for&!", N, BE);
850 -- Here we issue the warning, since this is a real reference
853 Error_Msg_NE -- CODEFIX
854 ("?pragma Unreferenced given for&!", N, E);
858 -- If this is a subprogram instance, mark as well the internal
859 -- subprogram in the wrapper package, which may be a visible
862 if Is_Overloadable (E)
863 and then Is_Generic_Instance (E)
864 and then Present (Alias (E))
866 Set_Referenced (Alias (E));
870 -- Generate reference if all conditions are met:
873 -- Cross referencing must be active
877 -- The entity must be one for which we collect references
879 and then Xref_Entity_Letters (Ekind (E)) /= ' '
881 -- Both Sloc values must be set to something sensible
883 and then Sloc (E) > No_Location
884 and then Sloc (N) > No_Location
886 -- Ignore references from within an instance. The only exceptions to
887 -- this are default subprograms, for which we generate an implicit
888 -- reference and compilations in Alfa_Mode.
891 (Instantiation_Location (Sloc (N)) = No_Location
895 -- Ignore dummy references
899 if Nkind_In (N, N_Identifier,
900 N_Defining_Identifier,
901 N_Defining_Operator_Symbol,
903 N_Defining_Character_Literal)
904 or else Nkind (N) in N_Op
905 or else (Nkind (N) = N_Character_Literal
906 and then Sloc (Entity (N)) /= Standard_Location)
910 elsif Nkind_In (N, N_Expanded_Name, N_Selected_Component) then
911 Nod := Selector_Name (N);
917 -- Normal case of source entity comes from source
919 if Comes_From_Source (E) then
922 -- Entity does not come from source, but is a derived subprogram and
923 -- the derived subprogram comes from source (after one or more
924 -- derivations) in which case the reference is to parent subprogram.
926 elsif Is_Overloadable (E)
927 and then Present (Alias (E))
930 while not Comes_From_Source (Ent) loop
931 if No (Alias (Ent)) then
938 -- The internally created defining entity for a child subprogram
939 -- that has no previous spec has valid references.
941 elsif Is_Overloadable (E)
942 and then Is_Child_Unit (E)
946 -- Ditto for the formals of such a subprogram
948 elsif Is_Overloadable (Scope (E))
949 and then Is_Child_Unit (Scope (E))
953 -- Record components of discriminated subtypes or derived types must
954 -- be treated as references to the original component.
956 elsif Ekind (E) = E_Component
957 and then Comes_From_Source (Original_Record_Component (E))
959 Ent := Original_Record_Component (E);
961 -- If this is an expanded reference to a discriminant, recover the
962 -- original discriminant, which gets the reference.
964 elsif Ekind (E) = E_In_Parameter
965 and then Present (Discriminal_Link (E))
967 Ent := Discriminal_Link (E);
968 Set_Referenced (Ent);
970 -- Ignore reference to any other entity that is not from source
976 -- In Alfa mode, consider the underlying entity renamed instead of
977 -- the renaming, which is needed to compute a valid set of effects
978 -- (reads, writes) for the enclosing subprogram.
981 Ent := Get_Through_Renamings (Ent);
983 -- If no enclosing object, then it could be a reference to any
984 -- location not tracked individually, like heap-allocated data.
985 -- Conservatively approximate this possibility by generating a
986 -- dereference, and return.
989 if Actual_Typ = 'w' then
990 Alfa.Generate_Dereference (Nod, 'r');
991 Alfa.Generate_Dereference (Nod, 'w');
993 Alfa.Generate_Dereference (Nod, 'r');
1000 -- Record reference to entity
1003 and then Is_Subprogram (Nod)
1004 and then Present (Overridden_Operation (Nod))
1013 Ref_Scope := Alfa.Enclosing_Subprogram_Or_Package (Nod);
1014 Ent_Scope := Alfa.Enclosing_Subprogram_Or_Package (Ent);
1016 -- Since we are reaching through renamings in Alfa mode, we may
1017 -- end up with standard constants. Ignore those.
1019 if Sloc (Ent_Scope) <= Standard_Location
1020 or else Def <= Standard_Location
1029 Eun => Get_Code_Unit (Def),
1030 Lun => Get_Code_Unit (Ref),
1031 Ref_Scope => Ref_Scope,
1032 Ent_Scope => Ent_Scope),
1033 Ent_Scope_File => Get_Code_Unit (Ent));
1036 Ref := Original_Location (Sloc (Nod));
1037 Def := Original_Location (Sloc (Ent));
1039 -- If this is an operator symbol, skip the initial quote for
1040 -- navigation purposes. This is not done for the end label,
1041 -- where we want the actual position after the closing quote.
1046 elsif Nkind (N) = N_Defining_Operator_Symbol
1047 or else Nkind (Nod) = N_Operator_Symbol
1056 Eun => Get_Source_Unit (Def),
1057 Lun => Get_Source_Unit (Ref),
1059 Ent_Scope => Empty),
1060 Ent_Scope_File => No_Unit);
1063 end Generate_Reference;
1065 -----------------------------------
1066 -- Generate_Reference_To_Formals --
1067 -----------------------------------
1069 procedure Generate_Reference_To_Formals (E : Entity_Id) is
1073 if Is_Generic_Subprogram (E) then
1074 Formal := First_Entity (E);
1076 while Present (Formal)
1077 and then not Is_Formal (Formal)
1079 Next_Entity (Formal);
1083 Formal := First_Formal (E);
1086 while Present (Formal) loop
1087 if Ekind (Formal) = E_In_Parameter then
1089 if Nkind (Parameter_Type (Parent (Formal)))
1090 = N_Access_Definition
1092 Generate_Reference (E, Formal, '^', False);
1094 Generate_Reference (E, Formal, '>', False);
1097 elsif Ekind (Formal) = E_In_Out_Parameter then
1098 Generate_Reference (E, Formal, '=', False);
1101 Generate_Reference (E, Formal, '<', False);
1104 Next_Formal (Formal);
1106 end Generate_Reference_To_Formals;
1108 -------------------------------------------
1109 -- Generate_Reference_To_Generic_Formals --
1110 -------------------------------------------
1112 procedure Generate_Reference_To_Generic_Formals (E : Entity_Id) is
1116 Formal := First_Entity (E);
1117 while Present (Formal) loop
1118 if Comes_From_Source (Formal) then
1119 Generate_Reference (E, Formal, 'z', False);
1122 Next_Entity (Formal);
1124 end Generate_Reference_To_Generic_Formals;
1130 function Get_Key (E : Xref_Entry_Number) return Xref_Entry_Number is
1139 function Hash (F : Xref_Entry_Number) return Header_Num is
1140 -- It is unlikely to have two references to the same entity at the same
1141 -- source location, so the hash function depends only on the Ent and Loc
1144 XE : Xref_Entry renames Xrefs.Table (F);
1145 type M is mod 2**32;
1147 H : constant M := M (XE.Key.Ent) + 2 ** 7 * M (abs XE.Key.Loc);
1148 -- It would be more natural to write:
1150 -- H : constant M := M'Mod (XE.Key.Ent) + 2**7 * M'Mod (XE.Key.Loc);
1152 -- But we can't use M'Mod, because it prevents bootstrapping with older
1153 -- compilers. Loc can be negative, so we do "abs" before converting.
1154 -- One day this can be cleaned up ???
1157 return Header_Num (H mod Num_Buckets);
1164 procedure HT_Set_Next (E : Xref_Entry_Number; Next : Xref_Entry_Number) is
1166 Xrefs.Table (E).HTable_Next := Next;
1173 function HT_Next (E : Xref_Entry_Number) return Xref_Entry_Number is
1175 return Xrefs.Table (E).HTable_Next;
1182 procedure Initialize is
1191 function Lt (T1, T2 : Xref_Entry) return Boolean is
1193 -- First test: if entity is in different unit, sort by unit
1195 if T1.Key.Eun /= T2.Key.Eun then
1196 return Dependency_Num (T1.Key.Eun) < Dependency_Num (T2.Key.Eun);
1198 -- Second test: within same unit, sort by entity Sloc
1200 elsif T1.Def /= T2.Def then
1201 return T1.Def < T2.Def;
1203 -- Third test: sort definitions ahead of references
1205 elsif T1.Key.Loc = No_Location then
1208 elsif T2.Key.Loc = No_Location then
1211 -- Fourth test: for same entity, sort by reference location unit
1213 elsif T1.Key.Lun /= T2.Key.Lun then
1214 return Dependency_Num (T1.Key.Lun) < Dependency_Num (T2.Key.Lun);
1216 -- Fifth test: order of location within referencing unit
1218 elsif T1.Key.Loc /= T2.Key.Loc then
1219 return T1.Key.Loc < T2.Key.Loc;
1221 -- Finally, for two locations at the same address, we prefer
1222 -- the one that does NOT have the type 'r' so that a modification
1223 -- or extension takes preference, when there are more than one
1224 -- reference at the same location. As a result, in the case of
1225 -- entities that are in-out actuals, the read reference follows
1226 -- the modify reference.
1229 return T2.Key.Typ = 'r';
1233 -----------------------
1234 -- Output_References --
1235 -----------------------
1237 procedure Output_References is
1239 procedure Get_Type_Reference
1241 Tref : out Entity_Id;
1242 Left : out Character;
1243 Right : out Character);
1244 -- Given an Entity_Id Ent, determines whether a type reference is
1245 -- required. If so, Tref is set to the entity for the type reference
1246 -- and Left and Right are set to the left/right brackets to be output
1247 -- for the reference. If no type reference is required, then Tref is
1248 -- set to Empty, and Left/Right are set to space.
1250 procedure Output_Import_Export_Info (Ent : Entity_Id);
1251 -- Output language and external name information for an interfaced
1252 -- entity, using the format <language, external_name>.
1254 ------------------------
1255 -- Get_Type_Reference --
1256 ------------------------
1258 procedure Get_Type_Reference
1260 Tref : out Entity_Id;
1261 Left : out Character;
1262 Right : out Character)
1267 -- See if we have a type reference
1276 -- Processing for types
1278 if Is_Type (Tref) then
1280 -- Case of base type
1282 if Base_Type (Tref) = Tref then
1284 -- If derived, then get first subtype
1286 if Tref /= Etype (Tref) then
1287 Tref := First_Subtype (Etype (Tref));
1289 -- Set brackets for derived type, but don't override
1290 -- pointer case since the fact that something is a
1291 -- pointer is more important.
1298 -- If non-derived ptr, get directly designated type.
1299 -- If the type has a full view, all references are on the
1300 -- partial view, that is seen first.
1302 elsif Is_Access_Type (Tref) then
1303 Tref := Directly_Designated_Type (Tref);
1307 elsif Is_Private_Type (Tref)
1308 and then Present (Full_View (Tref))
1310 if Is_Access_Type (Full_View (Tref)) then
1311 Tref := Directly_Designated_Type (Full_View (Tref));
1315 -- If the full view is an array type, we also retrieve
1316 -- the corresponding component type, because the ali
1317 -- entry already indicates that this is an array.
1319 elsif Is_Array_Type (Full_View (Tref)) then
1320 Tref := Component_Type (Full_View (Tref));
1325 -- If non-derived array, get component type. Skip component
1326 -- type for case of String or Wide_String, saves worthwhile
1329 elsif Is_Array_Type (Tref)
1330 and then Tref /= Standard_String
1331 and then Tref /= Standard_Wide_String
1333 Tref := Component_Type (Tref);
1337 -- For other non-derived base types, nothing
1343 -- For a subtype, go to ancestor subtype
1346 Tref := Ancestor_Subtype (Tref);
1348 -- If no ancestor subtype, go to base type
1351 Tref := Base_Type (Sav);
1355 -- For objects, functions, enum literals, just get type from
1358 elsif Is_Object (Tref)
1359 or else Ekind (Tref) = E_Enumeration_Literal
1360 or else Ekind (Tref) = E_Function
1361 or else Ekind (Tref) = E_Operator
1363 Tref := Etype (Tref);
1365 -- Another special case: an object of a classwide type
1366 -- initialized with a tag-indeterminate call gets a subtype
1367 -- of the classwide type during expansion. See if the original
1368 -- type in the declaration is named, and return it instead
1369 -- of going to the root type.
1371 if Ekind (Tref) = E_Class_Wide_Subtype
1372 and then Nkind (Parent (Ent)) = N_Object_Declaration
1374 Nkind (Original_Node (Object_Definition (Parent (Ent))))
1379 (Original_Node ((Object_Definition (Parent (Ent)))));
1382 -- For anything else, exit
1388 -- Exit if no type reference, or we are stuck in some loop trying
1389 -- to find the type reference, or if the type is standard void
1390 -- type (the latter is an implementation artifact that should not
1391 -- show up in the generated cross-references).
1395 or else Tref = Standard_Void_Type;
1397 -- If we have a usable type reference, return, otherwise keep
1398 -- looking for something useful (we are looking for something
1399 -- that either comes from source or standard)
1401 if Sloc (Tref) = Standard_Location
1402 or else Comes_From_Source (Tref)
1404 -- If the reference is a subtype created for a generic actual,
1405 -- go actual directly, the inner subtype is not user visible.
1407 if Nkind (Parent (Tref)) = N_Subtype_Declaration
1408 and then not Comes_From_Source (Parent (Tref))
1410 (Is_Wrapper_Package (Scope (Tref))
1411 or else Is_Generic_Instance (Scope (Tref)))
1413 Tref := First_Subtype (Base_Type (Tref));
1420 -- If we fall through the loop, no type reference
1425 end Get_Type_Reference;
1427 -------------------------------
1428 -- Output_Import_Export_Info --
1429 -------------------------------
1431 procedure Output_Import_Export_Info (Ent : Entity_Id) is
1432 Language_Name : Name_Id;
1433 Conv : constant Convention_Id := Convention (Ent);
1436 -- Generate language name from convention
1438 if Conv = Convention_C then
1439 Language_Name := Name_C;
1441 elsif Conv = Convention_CPP then
1442 Language_Name := Name_CPP;
1444 elsif Conv = Convention_Ada then
1445 Language_Name := Name_Ada;
1448 -- For the moment we ignore all other cases ???
1453 Write_Info_Char ('<');
1454 Get_Unqualified_Name_String (Language_Name);
1456 for J in 1 .. Name_Len loop
1457 Write_Info_Char (Name_Buffer (J));
1460 if Present (Interface_Name (Ent)) then
1461 Write_Info_Char (',');
1462 String_To_Name_Buffer (Strval (Interface_Name (Ent)));
1464 for J in 1 .. Name_Len loop
1465 Write_Info_Char (Name_Buffer (J));
1469 Write_Info_Char ('>');
1470 end Output_Import_Export_Info;
1472 -- Start of processing for Output_References
1475 -- First we add references to the primitive operations of tagged types
1476 -- declared in the main unit.
1478 Handle_Prim_Ops : declare
1482 for J in 1 .. Xrefs.Last loop
1483 Ent := Xrefs.Table (J).Key.Ent;
1486 and then Is_Tagged_Type (Ent)
1487 and then Is_Base_Type (Ent)
1488 and then In_Extended_Main_Source_Unit (Ent)
1490 Generate_Prim_Op_References (Ent);
1493 end Handle_Prim_Ops;
1495 -- Before we go ahead and output the references we have a problem
1496 -- that needs dealing with. So far we have captured things that are
1497 -- definitely referenced by the main unit, or defined in the main
1498 -- unit. That's because we don't want to clutter up the ali file
1499 -- for this unit with definition lines for entities in other units
1500 -- that are not referenced.
1502 -- But there is a glitch. We may reference an entity in another unit,
1503 -- and it may have a type reference to an entity that is not directly
1504 -- referenced in the main unit, which may mean that there is no xref
1505 -- entry for this entity yet in the list of references.
1507 -- If we don't do something about this, we will end with an orphan type
1508 -- reference, i.e. it will point to an entity that does not appear
1509 -- within the generated references in the ali file. That is not good for
1510 -- tools using the xref information.
1512 -- To fix this, we go through the references adding definition entries
1513 -- for any unreferenced entities that can be referenced in a type
1514 -- reference. There is a recursion problem here, and that is dealt with
1515 -- by making sure that this traversal also traverses any entries that
1516 -- get added by the traversal.
1518 Handle_Orphan_Type_References : declare
1524 pragma Warnings (Off, L);
1525 pragma Warnings (Off, R);
1527 procedure New_Entry (E : Entity_Id);
1528 -- Make an additional entry into the Xref table for a type entity
1529 -- that is related to the current entity (parent, type ancestor,
1530 -- progenitor, etc.).
1536 procedure New_Entry (E : Entity_Id) is
1538 pragma Assert (Present (E));
1540 if not Has_Xref_Entry (Implementation_Base_Type (E))
1541 and then Sloc (E) > No_Location
1546 Typ => Character'First,
1547 Eun => Get_Source_Unit (Original_Location (Sloc (E))),
1550 Ent_Scope => Empty),
1551 Ent_Scope_File => No_Unit);
1555 -- Start of processing for Handle_Orphan_Type_References
1558 -- Note that this is not a for loop for a very good reason. The
1559 -- processing of items in the table can add new items to the table,
1560 -- and they must be processed as well.
1563 while J <= Xrefs.Last loop
1564 Ent := Xrefs.Table (J).Key.Ent;
1565 Get_Type_Reference (Ent, Tref, L, R);
1568 and then not Has_Xref_Entry (Tref)
1569 and then Sloc (Tref) > No_Location
1573 if Is_Record_Type (Ent)
1574 and then Present (Interfaces (Ent))
1576 -- Add an entry for each one of the given interfaces
1577 -- implemented by type Ent.
1580 Elmt : Elmt_Id := First_Elmt (Interfaces (Ent));
1582 while Present (Elmt) loop
1583 New_Entry (Node (Elmt));
1590 -- Collect inherited primitive operations that may be declared in
1591 -- another unit and have no visible reference in the current one.
1594 and then Is_Tagged_Type (Ent)
1595 and then Is_Derived_Type (Ent)
1596 and then Is_Base_Type (Ent)
1597 and then In_Extended_Main_Source_Unit (Ent)
1600 Op_List : constant Elist_Id := Primitive_Operations (Ent);
1604 function Parent_Op (E : Entity_Id) return Entity_Id;
1605 -- Find original operation, which may be inherited through
1606 -- several derivations.
1608 function Parent_Op (E : Entity_Id) return Entity_Id is
1609 Orig_Op : constant Entity_Id := Alias (E);
1612 if No (Orig_Op) then
1615 elsif not Comes_From_Source (E)
1616 and then not Has_Xref_Entry (Orig_Op)
1617 and then Comes_From_Source (Orig_Op)
1621 return Parent_Op (Orig_Op);
1626 Op := First_Elmt (Op_List);
1627 while Present (Op) loop
1628 Prim := Parent_Op (Node (Op));
1630 if Present (Prim) then
1634 Typ => Character'First,
1635 Eun => Get_Source_Unit (Sloc (Prim)),
1638 Ent_Scope => Empty),
1639 Ent_Scope_File => No_Unit);
1649 end Handle_Orphan_Type_References;
1651 -- Now we have all the references, including those for any embedded
1652 -- type references, so we can sort them, and output them.
1654 Output_Refs : declare
1656 Nrefs : constant Nat := Xrefs.Last;
1657 -- Number of references in table
1659 Rnums : array (0 .. Nrefs) of Nat;
1660 -- This array contains numbers of references in the Xrefs table.
1661 -- This list is sorted in output order. The extra 0'th entry is
1662 -- convenient for the call to sort. When we sort the table, we
1663 -- move the entries in Rnums around, but we do not move the
1664 -- original table entries.
1666 Curxu : Unit_Number_Type;
1667 -- Current xref unit
1669 Curru : Unit_Number_Type;
1670 -- Current reference unit for one entity
1675 Curnam : String (1 .. Name_Buffer'Length);
1677 -- Simple name and length of current entity
1679 Curdef : Source_Ptr;
1680 -- Original source location for current entity
1683 -- Current reference location
1686 -- Entity type character
1689 -- reference kind of previous reference
1695 -- Renaming reference
1697 Trunit : Unit_Number_Type;
1698 -- Unit number for type reference
1700 function Lt (Op1, Op2 : Natural) return Boolean;
1701 -- Comparison function for Sort call
1703 function Name_Change (X : Entity_Id) return Boolean;
1704 -- Determines if entity X has a different simple name from Curent
1706 procedure Move (From : Natural; To : Natural);
1707 -- Move procedure for Sort call
1709 package Sorting is new GNAT.Heap_Sort_G (Move, Lt);
1715 function Lt (Op1, Op2 : Natural) return Boolean is
1716 T1 : Xref_Entry renames Xrefs.Table (Rnums (Nat (Op1)));
1717 T2 : Xref_Entry renames Xrefs.Table (Rnums (Nat (Op2)));
1727 procedure Move (From : Natural; To : Natural) is
1729 Rnums (Nat (To)) := Rnums (Nat (From));
1736 -- Why a string comparison here??? Why not compare Name_Id values???
1738 function Name_Change (X : Entity_Id) return Boolean is
1740 Get_Unqualified_Name_String (Chars (X));
1742 if Name_Len /= Curlen then
1745 return Name_Buffer (1 .. Curlen) /= Curnam (1 .. Curlen);
1749 -- Start of processing for Output_Refs
1752 -- Capture the definition Sloc values. We delay doing this till now,
1753 -- since at the time the reference or definition is made, private
1754 -- types may be swapped, and the Sloc value may be incorrect. We
1755 -- also set up the pointer vector for the sort.
1757 -- For user-defined operators we need to skip the initial quote and
1758 -- point to the first character of the name, for navigation purposes.
1760 for J in 1 .. Nrefs loop
1762 E : constant Entity_Id := Xrefs.Table (J).Key.Ent;
1763 Loc : constant Source_Ptr := Original_Location (Sloc (E));
1768 if Nkind (E) = N_Defining_Operator_Symbol then
1769 Xrefs.Table (J).Def := Loc + 1;
1771 Xrefs.Table (J).Def := Loc;
1776 -- Sort the references
1778 Sorting.Sort (Integer (Nrefs));
1780 -- Initialize loop through references
1784 Curdef := No_Location;
1786 Crloc := No_Location;
1789 -- Loop to output references
1791 for Refno in 1 .. Nrefs loop
1792 Output_One_Ref : declare
1795 XE : Xref_Entry renames Xrefs.Table (Rnums (Refno));
1796 -- The current entry to be accessed
1800 -- Used for {} or <> or () for type reference
1802 procedure Check_Type_Reference
1804 List_Interface : Boolean);
1805 -- Find whether there is a meaningful type reference for
1806 -- Ent, and display it accordingly. If List_Interface is
1807 -- true, then Ent is a progenitor interface of the current
1808 -- type entity being listed. In that case list it as is,
1809 -- without looking for a type reference for it.
1811 procedure Output_Instantiation_Refs (Loc : Source_Ptr);
1812 -- Recursive procedure to output instantiation references for
1813 -- the given source ptr in [file|line[...]] form. No output
1814 -- if the given location is not a generic template reference.
1816 procedure Output_Overridden_Op (Old_E : Entity_Id);
1817 -- For a subprogram that is overriding, display information
1818 -- about the inherited operation that it overrides.
1820 --------------------------
1821 -- Check_Type_Reference --
1822 --------------------------
1824 procedure Check_Type_Reference
1826 List_Interface : Boolean)
1829 if List_Interface then
1831 -- This is a progenitor interface of the type for which
1832 -- xref information is being generated.
1839 Get_Type_Reference (Ent, Tref, Left, Right);
1842 if Present (Tref) then
1844 -- Case of standard entity, output name
1846 if Sloc (Tref) = Standard_Location then
1847 Write_Info_Char (Left);
1848 Write_Info_Name (Chars (Tref));
1849 Write_Info_Char (Right);
1851 -- Case of source entity, output location
1854 Write_Info_Char (Left);
1855 Trunit := Get_Source_Unit (Sloc (Tref));
1857 if Trunit /= Curxu then
1858 Write_Info_Nat (Dependency_Num (Trunit));
1859 Write_Info_Char ('|');
1863 (Int (Get_Logical_Line_Number (Sloc (Tref))));
1871 Ctyp := Xref_Entity_Letters (Ekind (Ent));
1874 and then Present (Full_View (Ent))
1876 Ent := Underlying_Type (Ent);
1878 if Present (Ent) then
1879 Ctyp := Xref_Entity_Letters (Ekind (Ent));
1883 Write_Info_Char (Ctyp);
1887 (Int (Get_Column_Number (Sloc (Tref))));
1889 -- If the type comes from an instantiation, add the
1890 -- corresponding info.
1892 Output_Instantiation_Refs (Sloc (Tref));
1893 Write_Info_Char (Right);
1896 end Check_Type_Reference;
1898 -------------------------------
1899 -- Output_Instantiation_Refs --
1900 -------------------------------
1902 procedure Output_Instantiation_Refs (Loc : Source_Ptr) is
1903 Iloc : constant Source_Ptr := Instantiation_Location (Loc);
1904 Lun : Unit_Number_Type;
1905 Cu : constant Unit_Number_Type := Curru;
1908 -- Nothing to do if this is not an instantiation
1910 if Iloc = No_Location then
1914 -- Output instantiation reference
1916 Write_Info_Char ('[');
1917 Lun := Get_Source_Unit (Iloc);
1919 if Lun /= Curru then
1921 Write_Info_Nat (Dependency_Num (Curru));
1922 Write_Info_Char ('|');
1925 Write_Info_Nat (Int (Get_Logical_Line_Number (Iloc)));
1927 -- Recursive call to get nested instantiations
1929 Output_Instantiation_Refs (Iloc);
1931 -- Output final ] after call to get proper nesting
1933 Write_Info_Char (']');
1936 end Output_Instantiation_Refs;
1938 --------------------------
1939 -- Output_Overridden_Op --
1940 --------------------------
1942 procedure Output_Overridden_Op (Old_E : Entity_Id) is
1946 -- The overridden operation has an implicit declaration
1947 -- at the point of derivation. What we want to display
1948 -- is the original operation, which has the actual body
1949 -- (or abstract declaration) that is being overridden.
1950 -- The overridden operation is not always set, e.g. when
1951 -- it is a predefined operator.
1956 -- Follow alias chain if one is present
1958 elsif Present (Alias (Old_E)) then
1960 -- The subprogram may have been implicitly inherited
1961 -- through several levels of derivation, so find the
1962 -- ultimate (source) ancestor.
1964 Op := Ultimate_Alias (Old_E);
1966 -- Normal case of no alias present. We omit generated
1967 -- primitives like tagged equality, that have no source
1975 and then Sloc (Op) /= Standard_Location
1976 and then Comes_From_Source (Op)
1979 Loc : constant Source_Ptr := Sloc (Op);
1980 Par_Unit : constant Unit_Number_Type :=
1981 Get_Source_Unit (Loc);
1984 Write_Info_Char ('<');
1986 if Par_Unit /= Curxu then
1987 Write_Info_Nat (Dependency_Num (Par_Unit));
1988 Write_Info_Char ('|');
1991 Write_Info_Nat (Int (Get_Logical_Line_Number (Loc)));
1992 Write_Info_Char ('p');
1993 Write_Info_Nat (Int (Get_Column_Number (Loc)));
1994 Write_Info_Char ('>');
1997 end Output_Overridden_Op;
1999 -- Start of processing for Output_One_Ref
2003 Ctyp := Xref_Entity_Letters (Ekind (Ent));
2005 -- Skip reference if it is the only reference to an entity,
2006 -- and it is an END line reference, and the entity is not in
2007 -- the current extended source. This prevents junk entries
2008 -- consisting only of packages with END lines, where no
2009 -- entity from the package is actually referenced.
2012 and then Ent /= Curent
2013 and then (Refno = Nrefs
2015 Ent /= Xrefs.Table (Rnums (Refno + 1)).Key.Ent)
2016 and then not In_Extended_Main_Source_Unit (Ent)
2021 -- For private type, get full view type
2024 and then Present (Full_View (XE.Key.Ent))
2026 Ent := Underlying_Type (Ent);
2028 if Present (Ent) then
2029 Ctyp := Xref_Entity_Letters (Ekind (Ent));
2033 -- Special exception for Boolean
2035 if Ctyp = 'E' and then Is_Boolean_Type (Ent) then
2039 -- For variable reference, get corresponding type
2042 Ent := Etype (XE.Key.Ent);
2043 Ctyp := Fold_Lower (Xref_Entity_Letters (Ekind (Ent)));
2045 -- If variable is private type, get full view type
2048 and then Present (Full_View (Etype (XE.Key.Ent)))
2050 Ent := Underlying_Type (Etype (XE.Key.Ent));
2052 if Present (Ent) then
2053 Ctyp := Fold_Lower (Xref_Entity_Letters (Ekind (Ent)));
2056 elsif Is_Generic_Type (Ent) then
2058 -- If the type of the entity is a generic private type,
2059 -- there is no usable full view, so retain the indication
2060 -- that this is an object.
2065 -- Special handling for access parameters and objects and
2066 -- components of an anonymous access type.
2068 if Ekind_In (Etype (XE.Key.Ent),
2069 E_Anonymous_Access_Type,
2070 E_Anonymous_Access_Subprogram_Type,
2071 E_Anonymous_Access_Protected_Subprogram_Type)
2073 if Is_Formal (XE.Key.Ent)
2076 (XE.Key.Ent, E_Variable, E_Constant, E_Component)
2081 -- Special handling for Boolean
2083 elsif Ctyp = 'e' and then Is_Boolean_Type (Ent) then
2088 -- Special handling for abstract types and operations
2090 if Is_Overloadable (XE.Key.Ent)
2091 and then Is_Abstract_Subprogram (XE.Key.Ent)
2094 Ctyp := 'x'; -- Abstract procedure
2096 elsif Ctyp = 'V' then
2097 Ctyp := 'y'; -- Abstract function
2100 elsif Is_Type (XE.Key.Ent)
2101 and then Is_Abstract_Type (XE.Key.Ent)
2103 if Is_Interface (XE.Key.Ent) then
2106 elsif Ctyp = 'R' then
2107 Ctyp := 'H'; -- Abstract type
2111 -- Only output reference if interesting type of entity
2115 -- Suppress references to object definitions, used for local
2118 or else XE.Key.Typ = 'D'
2119 or else XE.Key.Typ = 'I'
2121 -- Suppress self references, except for bodies that act as
2124 or else (XE.Key.Loc = XE.Def
2127 or else not Is_Subprogram (XE.Key.Ent)))
2129 -- Also suppress definitions of body formals (we only
2130 -- treat these as references, and the references were
2131 -- separately recorded).
2133 or else (Is_Formal (XE.Key.Ent)
2134 and then Present (Spec_Entity (XE.Key.Ent)))
2139 -- Start new Xref section if new xref unit
2141 if XE.Key.Eun /= Curxu then
2142 if Write_Info_Col > 1 then
2146 Curxu := XE.Key.Eun;
2148 Write_Info_Initiate ('X');
2149 Write_Info_Char (' ');
2150 Write_Info_Nat (Dependency_Num (XE.Key.Eun));
2151 Write_Info_Char (' ');
2153 (Reference_Name (Source_Index (XE.Key.Eun)));
2156 -- Start new Entity line if new entity. Note that we
2157 -- consider two entities the same if they have the same
2158 -- name and source location. This causes entities in
2159 -- instantiations to be treated as though they referred
2164 (XE.Key.Ent /= Curent
2166 (Name_Change (XE.Key.Ent) or else XE.Def /= Curdef))
2168 Curent := XE.Key.Ent;
2171 Get_Unqualified_Name_String (Chars (XE.Key.Ent));
2173 Curnam (1 .. Curlen) := Name_Buffer (1 .. Curlen);
2175 if Write_Info_Col > 1 then
2179 -- Write column number information
2181 Write_Info_Nat (Int (Get_Logical_Line_Number (XE.Def)));
2182 Write_Info_Char (Ctyp);
2183 Write_Info_Nat (Int (Get_Column_Number (XE.Def)));
2185 -- Write level information
2187 Write_Level_Info : declare
2188 function Is_Visible_Generic_Entity
2189 (E : Entity_Id) return Boolean;
2190 -- Check whether E is declared in the visible part
2191 -- of a generic package. For source navigation
2192 -- purposes, treat this as a visible entity.
2194 function Is_Private_Record_Component
2195 (E : Entity_Id) return Boolean;
2196 -- Check whether E is a non-inherited component of a
2197 -- private extension. Even if the enclosing record is
2198 -- public, we want to treat the component as private
2199 -- for navigation purposes.
2201 ---------------------------------
2202 -- Is_Private_Record_Component --
2203 ---------------------------------
2205 function Is_Private_Record_Component
2206 (E : Entity_Id) return Boolean
2208 S : constant Entity_Id := Scope (E);
2211 Ekind (E) = E_Component
2212 and then Nkind (Declaration_Node (S)) =
2213 N_Private_Extension_Declaration
2214 and then Original_Record_Component (E) = E;
2215 end Is_Private_Record_Component;
2217 -------------------------------
2218 -- Is_Visible_Generic_Entity --
2219 -------------------------------
2221 function Is_Visible_Generic_Entity
2222 (E : Entity_Id) return Boolean
2227 -- The Present check here is an error defense
2229 if Present (Scope (E))
2230 and then Ekind (Scope (E)) /= E_Generic_Package
2236 while Present (Par) loop
2238 Nkind (Par) = N_Generic_Package_Declaration
2240 -- Entity is a generic formal
2245 Nkind (Parent (Par)) = N_Package_Specification
2248 Is_List_Member (Par)
2249 and then List_Containing (Par) =
2250 Visible_Declarations (Parent (Par));
2252 Par := Parent (Par);
2257 end Is_Visible_Generic_Entity;
2259 -- Start of processing for Write_Level_Info
2262 if Is_Hidden (Curent)
2263 or else Is_Private_Record_Component (Curent)
2265 Write_Info_Char (' ');
2269 or else Is_Visible_Generic_Entity (Curent)
2271 Write_Info_Char ('*');
2274 Write_Info_Char (' ');
2276 end Write_Level_Info;
2278 -- Output entity name. We use the occurrence from the
2279 -- actual source program at the definition point.
2282 Ent_Name : constant String :=
2283 Exact_Source_Name (Sloc (XE.Key.Ent));
2285 for C in Ent_Name'Range loop
2286 Write_Info_Char (Ent_Name (C));
2290 -- See if we have a renaming reference
2292 if Is_Object (XE.Key.Ent)
2293 and then Present (Renamed_Object (XE.Key.Ent))
2295 Rref := Renamed_Object (XE.Key.Ent);
2297 elsif Is_Overloadable (XE.Key.Ent)
2298 and then Nkind (Parent (Declaration_Node (XE.Key.Ent)))
2299 = N_Subprogram_Renaming_Declaration
2301 Rref := Name (Parent (Declaration_Node (XE.Key.Ent)));
2303 elsif Ekind (XE.Key.Ent) = E_Package
2304 and then Nkind (Declaration_Node (XE.Key.Ent)) =
2305 N_Package_Renaming_Declaration
2307 Rref := Name (Declaration_Node (XE.Key.Ent));
2313 if Present (Rref) then
2314 if Nkind (Rref) = N_Expanded_Name then
2315 Rref := Selector_Name (Rref);
2318 if Nkind (Rref) = N_Identifier
2319 or else Nkind (Rref) = N_Operator_Symbol
2323 -- For renamed array components, use the array name
2324 -- for the renamed entity, which reflect the fact that
2325 -- in general the whole array is aliased.
2327 elsif Nkind (Rref) = N_Indexed_Component then
2328 if Nkind (Prefix (Rref)) = N_Identifier then
2329 Rref := Prefix (Rref);
2330 elsif Nkind (Prefix (Rref)) = N_Expanded_Name then
2331 Rref := Selector_Name (Prefix (Rref));
2341 -- Write out renaming reference if we have one
2343 if Present (Rref) then
2344 Write_Info_Char ('=');
2346 (Int (Get_Logical_Line_Number (Sloc (Rref))));
2347 Write_Info_Char (':');
2349 (Int (Get_Column_Number (Sloc (Rref))));
2352 -- Indicate that the entity is in the unit of the current
2357 -- Write out information about generic parent, if entity
2360 if Is_Generic_Instance (XE.Key.Ent) then
2362 Gen_Par : constant Entity_Id :=
2365 (Unit_Declaration_Node
2367 Loc : constant Source_Ptr := Sloc (Gen_Par);
2368 Gen_U : constant Unit_Number_Type :=
2369 Get_Source_Unit (Loc);
2372 Write_Info_Char ('[');
2374 if Curru /= Gen_U then
2375 Write_Info_Nat (Dependency_Num (Gen_U));
2376 Write_Info_Char ('|');
2380 (Int (Get_Logical_Line_Number (Loc)));
2381 Write_Info_Char (']');
2385 -- See if we have a type reference and if so output
2387 Check_Type_Reference (XE.Key.Ent, False);
2389 -- Additional information for types with progenitors
2391 if Is_Record_Type (XE.Key.Ent)
2392 and then Present (Interfaces (XE.Key.Ent))
2396 First_Elmt (Interfaces (XE.Key.Ent));
2398 while Present (Elmt) loop
2399 Check_Type_Reference (Node (Elmt), True);
2404 -- For array types, list index types as well. (This is
2405 -- not C, indexes have distinct types).
2407 elsif Is_Array_Type (XE.Key.Ent) then
2411 Indx := First_Index (XE.Key.Ent);
2412 while Present (Indx) loop
2413 Check_Type_Reference
2414 (First_Subtype (Etype (Indx)), True);
2420 -- If the entity is an overriding operation, write info
2421 -- on operation that was overridden.
2423 if Is_Subprogram (XE.Key.Ent)
2424 and then Present (Overridden_Operation (XE.Key.Ent))
2426 Output_Overridden_Op
2427 (Overridden_Operation (XE.Key.Ent));
2430 -- End of processing for entity output
2432 Crloc := No_Location;
2435 -- Output the reference if it is not as the same location
2436 -- as the previous one, or it is a read-reference that
2437 -- indicates that the entity is an in-out actual in a call.
2439 if XE.Key.Loc /= No_Location
2441 (XE.Key.Loc /= Crloc
2442 or else (Prevt = 'm' and then XE.Key.Typ = 'r'))
2444 Crloc := XE.Key.Loc;
2445 Prevt := XE.Key.Typ;
2447 -- Start continuation if line full, else blank
2449 if Write_Info_Col > 72 then
2451 Write_Info_Initiate ('.');
2454 Write_Info_Char (' ');
2456 -- Output file number if changed
2458 if XE.Key.Lun /= Curru then
2459 Curru := XE.Key.Lun;
2460 Write_Info_Nat (Dependency_Num (Curru));
2461 Write_Info_Char ('|');
2465 (Int (Get_Logical_Line_Number (XE.Key.Loc)));
2466 Write_Info_Char (XE.Key.Typ);
2468 if Is_Overloadable (XE.Key.Ent) then
2469 if (Is_Imported (XE.Key.Ent) and then XE.Key.Typ = 'b')
2471 (Is_Exported (XE.Key.Ent) and then XE.Key.Typ = 'i')
2473 Output_Import_Export_Info (XE.Key.Ent);
2477 Write_Info_Nat (Int (Get_Column_Number (XE.Key.Loc)));
2479 Output_Instantiation_Refs (Sloc (XE.Key.Ent));
2490 end Output_References;
2492 -- Start of elaboration for Lib.Xref
2495 -- Reset is necessary because Elmt_Ptr does not default to Null_Ptr,
2496 -- because it's not an access type.