1 ------------------------------------------------------------------------------
3 -- GNAT COMPILER COMPONENTS --
9 -- Copyright (C) 1998-2014, Free Software Foundation, Inc. --
11 -- GNAT is free software; you can redistribute it and/or modify it under --
12 -- terms of the GNU General Public License as published by the Free Soft- --
13 -- ware Foundation; either version 3, or (at your option) any later ver- --
14 -- sion. GNAT is distributed in the hope that it will be useful, but WITH- --
15 -- OUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY --
16 -- or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License --
17 -- for more details. You should have received a copy of the GNU General --
18 -- Public License distributed with GNAT; see file COPYING3. If not, go to --
19 -- http://www.gnu.org/licenses for a complete copy of the license. --
21 -- GNAT was originally developed by the GNAT team at New York University. --
22 -- Extensive contributions were provided by Ada Core Technologies Inc. --
24 ------------------------------------------------------------------------------
26 with Atree; use Atree;
27 with Csets; use Csets;
28 with Elists; use Elists;
29 with Errout; use Errout;
30 with Nlists; use Nlists;
32 with Restrict; use Restrict;
33 with Rident; use Rident;
35 with Sem_Aux; use Sem_Aux;
36 with Sem_Prag; use Sem_Prag;
37 with Sem_Util; use Sem_Util;
38 with Sem_Warn; use Sem_Warn;
39 with Sinfo; use Sinfo;
40 with Sinput; use Sinput;
41 with Snames; use Snames;
42 with Stringt; use Stringt;
43 with Stand; use Stand;
44 with Table; use Table;
46 with GNAT.Heap_Sort_G;
49 package body Lib.Xref is
55 -- The Xref table is used to record references. The Loc field is set
56 -- to No_Location for a definition entry.
58 subtype Xref_Entry_Number is Int;
60 type Xref_Key is record
61 -- These are the components of Xref_Entry that participate in hash
65 -- Entity referenced (E parameter to Generate_Reference)
68 -- Location of reference (Original_Location (Sloc field of N parameter
69 -- to Generate_Reference). Set to No_Location for the case of a
70 -- defining occurrence.
73 -- Reference type (Typ param to Generate_Reference)
75 Eun : Unit_Number_Type;
76 -- Unit number corresponding to Ent
78 Lun : Unit_Number_Type;
79 -- Unit number corresponding to Loc. Value is undefined and not
80 -- referenced if Loc is set to No_Location.
82 -- The following components are only used for SPARK cross-references
84 Ref_Scope : Entity_Id;
85 -- Entity of the closest subprogram or package enclosing the reference
87 Ent_Scope : Entity_Id;
88 -- Entity of the closest subprogram or package enclosing the definition,
89 -- which should be located in the same file as the definition itself.
92 type Xref_Entry is record
95 Ent_Scope_File : Unit_Number_Type;
96 -- File for entity Ent_Scope
99 -- Original source location for entity being referenced. Note that these
100 -- values are used only during the output process, they are not set when
101 -- the entries are originally built. This is because private entities
102 -- can be swapped when the initial call is made.
104 HTable_Next : Xref_Entry_Number;
105 -- For use only by Static_HTable
108 package Xrefs is new Table.Table (
109 Table_Component_Type => Xref_Entry,
110 Table_Index_Type => Xref_Entry_Number,
111 Table_Low_Bound => 1,
112 Table_Initial => Alloc.Xrefs_Initial,
113 Table_Increment => Alloc.Xrefs_Increment,
114 Table_Name => "Xrefs");
120 -- We keep a set of xref entries, in order to avoid inserting duplicate
121 -- entries into the above Xrefs table. An entry is in Xref_Set if and only
122 -- if it is in Xrefs.
124 Num_Buckets : constant := 2**16;
126 subtype Header_Num is Integer range 0 .. Num_Buckets - 1;
127 type Null_Type is null record;
128 pragma Unreferenced (Null_Type);
130 function Hash (F : Xref_Entry_Number) return Header_Num;
132 function Equal (F1, F2 : Xref_Entry_Number) return Boolean;
134 procedure HT_Set_Next (E : Xref_Entry_Number; Next : Xref_Entry_Number);
136 function HT_Next (E : Xref_Entry_Number) return Xref_Entry_Number;
138 function Get_Key (E : Xref_Entry_Number) return Xref_Entry_Number;
140 pragma Inline (Hash, Equal, HT_Set_Next, HT_Next, Get_Key);
142 package Xref_Set is new GNAT.HTable.Static_HTable (
144 Element => Xref_Entry,
145 Elmt_Ptr => Xref_Entry_Number,
147 Set_Next => HT_Set_Next,
149 Key => Xref_Entry_Number,
154 -----------------------------
155 -- SPARK Xrefs Information --
156 -----------------------------
158 package body SPARK_Specific is separate;
160 ------------------------
161 -- Local Subprograms --
162 ------------------------
164 procedure Add_Entry (Key : Xref_Key; Ent_Scope_File : Unit_Number_Type);
165 -- Add an entry to the tables of Xref_Entries, avoiding duplicates
167 procedure Generate_Prim_Op_References (Typ : Entity_Id);
168 -- For a tagged type, generate implicit references to its primitive
169 -- operations, for source navigation. This is done right before emitting
170 -- cross-reference information rather than at the freeze point of the type
171 -- in order to handle late bodies that are primitive operations.
173 function Lt (T1, T2 : Xref_Entry) return Boolean;
174 -- Order cross-references
180 procedure Add_Entry (Key : Xref_Key; Ent_Scope_File : Unit_Number_Type) is
182 Xrefs.Increment_Last; -- tentative
183 Xrefs.Table (Xrefs.Last).Key := Key;
185 -- Set the entry in Xref_Set, and if newly set, keep the above
186 -- tentative increment.
188 if Xref_Set.Set_If_Not_Present (Xrefs.Last) then
189 Xrefs.Table (Xrefs.Last).Ent_Scope_File := Ent_Scope_File;
190 -- Leave Def and HTable_Next uninitialized
192 Set_Has_Xref_Entry (Key.Ent);
194 -- It was already in Xref_Set, so throw away the tentatively-added
198 Xrefs.Decrement_Last;
206 function Equal (F1, F2 : Xref_Entry_Number) return Boolean is
207 Result : constant Boolean :=
208 Xrefs.Table (F1).Key = Xrefs.Table (F2).Key;
213 -------------------------
214 -- Generate_Definition --
215 -------------------------
217 procedure Generate_Definition (E : Entity_Id) is
219 pragma Assert (Nkind (E) in N_Entity);
221 -- Note that we do not test Xref_Entity_Letters here. It is too early
222 -- to do so, since we are often called before the entity is fully
223 -- constructed, so that the Ekind is still E_Void.
227 -- Definition must come from source
229 -- We make an exception for subprogram child units that have no spec.
230 -- For these we generate a subprogram declaration for library use,
231 -- and the corresponding entity does not come from source.
232 -- Nevertheless, all references will be attached to it and we have
233 -- to treat is as coming from user code.
235 and then (Comes_From_Source (E) or else Is_Child_Unit (E))
237 -- And must have a reasonable source location that is not
238 -- within an instance (all entities in instances are ignored)
240 and then Sloc (E) > No_Location
241 and then Instantiation_Location (Sloc (E)) = No_Location
243 -- And must be a non-internal name from the main source unit
245 and then In_Extended_Main_Source_Unit (E)
246 and then not Is_Internal_Name (Chars (E))
252 Eun => Get_Source_Unit (Original_Location (Sloc (E))),
256 Ent_Scope_File => No_Unit);
258 if In_Inlined_Body then
262 end Generate_Definition;
264 ---------------------------------
265 -- Generate_Operator_Reference --
266 ---------------------------------
268 procedure Generate_Operator_Reference
273 if not In_Extended_Main_Source_Unit (N) then
277 -- If the operator is not a Standard operator, then we generate a real
278 -- reference to the user defined operator.
280 if Sloc (Entity (N)) /= Standard_Location then
281 Generate_Reference (Entity (N), N);
283 -- A reference to an implicit inequality operator is also a reference
284 -- to the user-defined equality.
286 if Nkind (N) = N_Op_Ne
287 and then not Comes_From_Source (Entity (N))
288 and then Present (Corresponding_Equality (Entity (N)))
290 Generate_Reference (Corresponding_Equality (Entity (N)), N);
293 -- For the case of Standard operators, we mark the result type as
294 -- referenced. This ensures that in the case where we are using a
295 -- derived operator, we mark an entity of the unit that implicitly
296 -- defines this operator as used. Otherwise we may think that no entity
297 -- of the unit is used. The actual entity marked as referenced is the
298 -- first subtype, which is the relevant user defined entity.
300 -- Note: we only do this for operators that come from source. The
301 -- generated code sometimes reaches for entities that do not need to be
302 -- explicitly visible (for example, when we expand the code for
303 -- comparing two record objects, the fields of the record may not be
306 elsif Comes_From_Source (N) then
307 Set_Referenced (First_Subtype (T));
309 end Generate_Operator_Reference;
311 ---------------------------------
312 -- Generate_Prim_Op_References --
313 ---------------------------------
315 procedure Generate_Prim_Op_References (Typ : Entity_Id) is
318 Prim_List : Elist_Id;
321 -- Handle subtypes of synchronized types
323 if Ekind (Typ) = E_Protected_Subtype
324 or else Ekind (Typ) = E_Task_Subtype
326 Base_T := Etype (Typ);
331 -- References to primitive operations are only relevant for tagged types
333 if not Is_Tagged_Type (Base_T)
334 or else Is_Class_Wide_Type (Base_T)
339 -- Ada 2005 (AI-345): For synchronized types generate reference to the
340 -- wrapper that allow us to dispatch calls through their implemented
341 -- abstract interface types.
343 -- The check for Present here is to protect against previously reported
346 Prim_List := Primitive_Operations (Base_T);
348 if No (Prim_List) then
352 Prim := First_Elmt (Prim_List);
353 while Present (Prim) loop
355 -- If the operation is derived, get the original for cross-reference
356 -- reference purposes (it is the original for which we want the xref
357 -- and for which the comes_from_source test must be performed).
360 (Typ, Ultimate_Alias (Node (Prim)), 'p', Set_Ref => False);
363 end Generate_Prim_Op_References;
365 ------------------------
366 -- Generate_Reference --
367 ------------------------
369 procedure Generate_Reference
372 Typ : Character := 'r';
373 Set_Ref : Boolean := True;
374 Force : Boolean := False)
376 Actual_Typ : Character := Typ;
380 Ent_Scope : Entity_Id;
385 Ref_Scope : Entity_Id;
387 function Get_Through_Renamings (E : Entity_Id) return Entity_Id;
388 -- Get the enclosing entity through renamings, which may come from
389 -- source or from the translation of generic instantiations.
391 function Is_On_LHS (Node : Node_Id) return Boolean;
392 -- Used to check if a node is on the left hand side of an assignment.
393 -- The following cases are handled:
395 -- Variable Node is a direct descendant of left hand side of an
396 -- assignment statement.
398 -- Prefix Of an indexed or selected component that is present in
399 -- a subtree rooted by an assignment statement. There is
400 -- no restriction of nesting of components, thus cases
401 -- such as A.B (C).D are handled properly. However a prefix
402 -- of a dereference (either implicit or explicit) is never
403 -- considered as on a LHS.
405 -- Out param Same as above cases, but OUT parameter
407 function OK_To_Set_Referenced return Boolean;
408 -- Returns True if the Referenced flag can be set. There are a few
409 -- exceptions where we do not want to set this flag, see body for
410 -- details of these exceptional cases.
412 ---------------------------
413 -- Get_Through_Renamings --
414 ---------------------------
416 function Get_Through_Renamings (E : Entity_Id) return Entity_Id is
417 Result : Entity_Id := E;
419 while Present (Result)
420 and then Is_Object (Result)
421 and then Present (Renamed_Object (Result))
423 Result := Get_Enclosing_Object (Renamed_Object (Result));
426 end Get_Through_Renamings;
432 -- ??? There are several routines here and there that perform a similar
433 -- (but subtly different) computation, which should be factored:
436 -- Sem_Util.May_Be_Lvalue
437 -- Sem_Util.Known_To_Be_Assigned
438 -- Exp_Ch2.Expand_Entry_Parameter.In_Assignment_Context
439 -- Exp_Smem.Is_Out_Actual
441 function Is_On_LHS (Node : Node_Id) return Boolean is
447 -- Only identifiers are considered, is this necessary???
449 if Nkind (Node) /= N_Identifier then
453 -- Immediate return if appeared as OUT parameter
455 if Kind = E_Out_Parameter then
459 -- Search for assignment statement subtree root
466 if K = N_Assignment_Statement then
469 -- Check whether the parent is a component and the current node is
470 -- its prefix, but return False if the current node has an access
471 -- type, as in that case the selected or indexed component is an
472 -- implicit dereference, and the LHS is the designated object, not
473 -- the access object.
475 -- ??? case of a slice assignment?
477 elsif (K = N_Selected_Component or else K = N_Indexed_Component)
478 and then Prefix (P) = N
480 -- Check for access type. First a kludge, In some cases this is
481 -- called too early (see comments in Sem_Ch8.Find_Direct_Name),
482 -- at a point where the tree is not fully typed yet. In that
483 -- case we may lack an Etype for N, and we can't check the
484 -- Etype. For now, we always return False in such a case,
485 -- but this is clearly not right in all cases ???
487 if No (Etype (N)) then
490 elsif Is_Access_Type (Etype (N)) then
493 -- Access type case dealt with, keep going
499 -- All other cases, definitely not on left side
507 ---------------------------
508 -- OK_To_Set_Referenced --
509 ---------------------------
511 function OK_To_Set_Referenced return Boolean is
515 -- A reference from a pragma Unreferenced or pragma Unmodified or
516 -- pragma Warnings does not cause the Referenced flag to be set.
517 -- This avoids silly warnings about things being referenced and
518 -- not assigned when the only reference is from the pragma.
520 if Nkind (N) = N_Identifier then
523 if Nkind (P) = N_Pragma_Argument_Association then
526 if Nkind (P) = N_Pragma then
527 if Nam_In (Pragma_Name (P), Name_Warnings,
535 -- A reference to a formal in a named parameter association does
536 -- not make the formal referenced. Formals that are unused in the
537 -- subprogram body are properly flagged as such, even if calls
538 -- elsewhere use named notation.
540 elsif Nkind (P) = N_Parameter_Association
541 and then N = Selector_Name (P)
548 end OK_To_Set_Referenced;
550 -- Start of processing for Generate_Reference
553 pragma Assert (Nkind (E) in N_Entity);
554 Find_Actual (N, Formal, Call);
556 if Present (Formal) then
557 Kind := Ekind (Formal);
562 -- Check for obsolescent reference to package ASCII. GNAT treats this
563 -- element of annex J specially since in practice, programs make a lot
564 -- of use of this feature, so we don't include it in the set of features
565 -- diagnosed when Warn_On_Obsolescent_Features mode is set. However we
566 -- are required to note it as a violation of the RM defined restriction.
568 if E = Standard_ASCII then
569 Check_Restriction (No_Obsolescent_Features, N);
572 -- Check for reference to entity marked with Is_Obsolescent
574 -- Note that we always allow obsolescent references in the compiler
575 -- itself and the run time, since we assume that we know what we are
576 -- doing in such cases. For example the calls in Ada.Characters.Handling
577 -- to its own obsolescent subprograms are just fine.
579 -- In any case we only generate warnings if we are in the extended main
580 -- source unit, and the entity itself is not in the extended main source
581 -- unit, since we assume the source unit itself knows what is going on
582 -- (and for sure we do not want silly warnings, e.g. on the end line of
583 -- an obsolescent procedure body).
585 if Is_Obsolescent (E)
586 and then not GNAT_Mode
587 and then not In_Extended_Main_Source_Unit (E)
588 and then In_Extended_Main_Source_Unit (N)
590 Check_Restriction (No_Obsolescent_Features, N);
592 if Warn_On_Obsolescent_Feature then
593 Output_Obsolescent_Entity_Warnings (N, E);
597 -- Warn if reference to Ada 2005 entity not in Ada 2005 mode. We only
598 -- detect real explicit references (modifications and references).
600 if Comes_From_Source (N)
601 and then Is_Ada_2005_Only (E)
602 and then Ada_Version < Ada_2005
603 and then Warn_On_Ada_2005_Compatibility
604 and then (Typ = 'm' or else Typ = 'r' or else Typ = 's')
606 Error_Msg_NE ("& is only defined in Ada 2005?y?", N, E);
609 -- Warn if reference to Ada 2012 entity not in Ada 2012 mode. We only
610 -- detect real explicit references (modifications and references).
612 if Comes_From_Source (N)
613 and then Is_Ada_2012_Only (E)
614 and then Ada_Version < Ada_2012
615 and then Warn_On_Ada_2012_Compatibility
616 and then (Typ = 'm' or else Typ = 'r')
618 Error_Msg_NE ("& is only defined in Ada 2012?y?", N, E);
621 -- Do not generate references if we are within a postcondition sub-
622 -- program, because the reference does not comes from source, and the
623 -- pre-analysis of the aspect has already created an entry for the ali
624 -- file at the proper source location.
626 if Chars (Current_Scope) = Name_uPostconditions then
630 -- Never collect references if not in main source unit. However, we omit
631 -- this test if Typ is 'e' or 'k', since these entries are structural,
632 -- and it is useful to have them in units that reference packages as
633 -- well as units that define packages. We also omit the test for the
634 -- case of 'p' since we want to include inherited primitive operations
635 -- from other packages.
637 -- We also omit this test is this is a body reference for a subprogram
638 -- instantiation. In this case the reference is to the generic body,
639 -- which clearly need not be in the main unit containing the instance.
640 -- For the same reason we accept an implicit reference generated for
641 -- a default in an instance.
643 if not In_Extended_Main_Source_Unit (N) then
649 or else (Typ = 'b' and then Is_Generic_Instance (E))
651 -- Allow the generation of references to reads, writes and calls
652 -- in SPARK mode when the related context comes from an instance.
656 and then In_Extended_Main_Code_Unit (N)
657 and then (Typ = 'm' or else Typ = 'r' or else Typ = 's'))
665 -- For reference type p, the entity must be in main source unit
667 if Typ = 'p' and then not In_Extended_Main_Source_Unit (E) then
671 -- Unless the reference is forced, we ignore references where the
672 -- reference itself does not come from source.
674 if not Force and then not Comes_From_Source (N) then
678 -- Deal with setting entity as referenced, unless suppressed. Note that
679 -- we still do Set_Referenced on entities that do not come from source.
680 -- This situation arises when we have a source reference to a derived
681 -- operation, where the derived operation itself does not come from
682 -- source, but we still want to mark it as referenced, since we really
683 -- are referencing an entity in the corresponding package (this avoids
684 -- wrong complaints that the package contains no referenced entities).
688 -- Assignable object appearing on left side of assignment or as
692 and then Is_On_LHS (N)
693 and then Ekind (E) /= E_In_Out_Parameter
695 -- For objects that are renamings, just set as simply referenced
696 -- we do not try to do assignment type tracking in this case.
698 if Present (Renamed_Object (E)) then
701 -- Out parameter case
703 elsif Kind = E_Out_Parameter then
705 -- If warning mode for all out parameters is set, or this is
706 -- the only warning parameter, then we want to mark this for
707 -- later warning logic by setting Referenced_As_Out_Parameter
709 if Warn_On_Modified_As_Out_Parameter (Formal) then
710 Set_Referenced_As_Out_Parameter (E, True);
711 Set_Referenced_As_LHS (E, False);
713 -- For OUT parameter not covered by the above cases, we simply
714 -- regard it as a normal reference (in this case we do not
715 -- want any of the warning machinery for out parameters).
721 -- For the left hand of an assignment case, we do nothing here.
722 -- The processing for Analyze_Assignment_Statement will set the
723 -- Referenced_As_LHS flag.
729 -- Check for a reference in a pragma that should not count as a
730 -- making the variable referenced for warning purposes.
732 elsif Is_Non_Significant_Pragma_Reference (N) then
735 -- A reference in an attribute definition clause does not count as a
736 -- reference except for the case of Address. The reason that 'Address
737 -- is an exception is that it creates an alias through which the
738 -- variable may be referenced.
740 elsif Nkind (Parent (N)) = N_Attribute_Definition_Clause
741 and then Chars (Parent (N)) /= Name_Address
742 and then N = Name (Parent (N))
746 -- Constant completion does not count as a reference
749 and then Ekind (E) = E_Constant
753 -- Record representation clause does not count as a reference
755 elsif Nkind (N) = N_Identifier
756 and then Nkind (Parent (N)) = N_Record_Representation_Clause
760 -- Discriminants do not need to produce a reference to record type
763 and then Nkind (Parent (N)) = N_Discriminant_Specification
770 -- Special processing for IN OUT parameters, where we have an
771 -- implicit assignment to a simple variable.
773 if Kind = E_In_Out_Parameter
774 and then Is_Assignable (E)
776 -- For sure this counts as a normal read reference
779 Set_Last_Assignment (E, Empty);
781 -- We count it as being referenced as an out parameter if the
782 -- option is set to warn on all out parameters, except that we
783 -- have a special exclusion for an intrinsic subprogram, which
784 -- is most likely an instantiation of Unchecked_Deallocation
785 -- which we do not want to consider as an assignment since it
786 -- generates false positives. We also exclude the case of an
787 -- IN OUT parameter if the name of the procedure is Free,
788 -- since we suspect similar semantics.
790 if Warn_On_All_Unread_Out_Parameters
791 and then Is_Entity_Name (Name (Call))
792 and then not Is_Intrinsic_Subprogram (Entity (Name (Call)))
793 and then Chars (Name (Call)) /= Name_Free
795 Set_Referenced_As_Out_Parameter (E, True);
796 Set_Referenced_As_LHS (E, False);
799 -- Don't count a recursive reference within a subprogram as a
800 -- reference (that allows detection of a recursive subprogram
801 -- whose only references are recursive calls as unreferenced).
803 elsif Is_Subprogram (E)
804 and then E = Nearest_Dynamic_Scope (Current_Scope)
808 -- Any other occurrence counts as referencing the entity
810 elsif OK_To_Set_Referenced then
813 -- If variable, this is an OK reference after an assignment
814 -- so we can clear the Last_Assignment indication.
816 if Is_Assignable (E) then
817 Set_Last_Assignment (E, Empty);
822 -- Check for pragma Unreferenced given and reference is within
823 -- this source unit (occasion for possible warning to be issued).
825 if Has_Unreferenced (E)
826 and then In_Same_Extended_Unit (E, N)
828 -- A reference as a named parameter in a call does not count
829 -- as a violation of pragma Unreferenced for this purpose...
831 if Nkind (N) = N_Identifier
832 and then Nkind (Parent (N)) = N_Parameter_Association
833 and then Selector_Name (Parent (N)) = N
837 -- ... Neither does a reference to a variable on the left side
840 elsif Is_On_LHS (N) then
843 -- For entry formals, we want to place the warning message on the
844 -- corresponding entity in the accept statement. The current scope
845 -- is the body of the accept, so we find the formal whose name
846 -- matches that of the entry formal (there is no link between the
847 -- two entities, and the one in the accept statement is only used
848 -- for conformance checking).
850 elsif Ekind (Scope (E)) = E_Entry then
855 BE := First_Entity (Current_Scope);
856 while Present (BE) loop
857 if Chars (BE) = Chars (E) then
858 Error_Msg_NE -- CODEFIX
859 ("??pragma Unreferenced given for&!", N, BE);
867 -- Here we issue the warning, since this is a real reference
870 Error_Msg_NE -- CODEFIX
871 ("?pragma Unreferenced given for&!", N, E);
875 -- If this is a subprogram instance, mark as well the internal
876 -- subprogram in the wrapper package, which may be a visible
879 if Is_Overloadable (E)
880 and then Is_Generic_Instance (E)
881 and then Present (Alias (E))
883 Set_Referenced (Alias (E));
887 -- Generate reference if all conditions are met:
890 -- Cross referencing must be active
894 -- The entity must be one for which we collect references
896 and then Xref_Entity_Letters (Ekind (E)) /= ' '
898 -- Both Sloc values must be set to something sensible
900 and then Sloc (E) > No_Location
901 and then Sloc (N) > No_Location
903 -- Ignore references from within an instance. The only exceptions to
904 -- this are default subprograms, for which we generate an implicit
905 -- reference and compilations in SPARK mode.
908 (Instantiation_Location (Sloc (N)) = No_Location
910 or else GNATprove_Mode)
912 -- Ignore dummy references
916 if Nkind_In (N, N_Identifier,
917 N_Defining_Identifier,
918 N_Defining_Operator_Symbol,
920 N_Defining_Character_Literal)
921 or else Nkind (N) in N_Op
922 or else (Nkind (N) = N_Character_Literal
923 and then Sloc (Entity (N)) /= Standard_Location)
927 elsif Nkind_In (N, N_Expanded_Name, N_Selected_Component) then
928 Nod := Selector_Name (N);
934 -- Normal case of source entity comes from source
936 if Comes_From_Source (E) then
939 -- Entity does not come from source, but is a derived subprogram and
940 -- the derived subprogram comes from source (after one or more
941 -- derivations) in which case the reference is to parent subprogram.
943 elsif Is_Overloadable (E)
944 and then Present (Alias (E))
947 while not Comes_From_Source (Ent) loop
948 if No (Alias (Ent)) then
955 -- The internally created defining entity for a child subprogram
956 -- that has no previous spec has valid references.
958 elsif Is_Overloadable (E)
959 and then Is_Child_Unit (E)
963 -- Ditto for the formals of such a subprogram
965 elsif Is_Overloadable (Scope (E))
966 and then Is_Child_Unit (Scope (E))
970 -- Record components of discriminated subtypes or derived types must
971 -- be treated as references to the original component.
973 elsif Ekind (E) = E_Component
974 and then Comes_From_Source (Original_Record_Component (E))
976 Ent := Original_Record_Component (E);
978 -- If this is an expanded reference to a discriminant, recover the
979 -- original discriminant, which gets the reference.
981 elsif Ekind (E) = E_In_Parameter
982 and then Present (Discriminal_Link (E))
984 Ent := Discriminal_Link (E);
985 Set_Referenced (Ent);
987 -- Ignore reference to any other entity that is not from source
993 -- In SPARK mode, consider the underlying entity renamed instead of
994 -- the renaming, which is needed to compute a valid set of effects
995 -- (reads, writes) for the enclosing subprogram.
997 if GNATprove_Mode then
998 Ent := Get_Through_Renamings (Ent);
1000 -- If no enclosing object, then it could be a reference to any
1001 -- location not tracked individually, like heap-allocated data.
1002 -- Conservatively approximate this possibility by generating a
1003 -- dereference, and return.
1006 if Actual_Typ = 'w' then
1007 SPARK_Specific.Generate_Dereference (Nod, 'r');
1008 SPARK_Specific.Generate_Dereference (Nod, 'w');
1010 SPARK_Specific.Generate_Dereference (Nod, 'r');
1017 -- Record reference to entity
1020 and then Is_Subprogram (Nod)
1021 and then Present (Overridden_Operation (Nod))
1026 -- Comment needed here for special SPARK code ???
1028 if GNATprove_Mode then
1033 SPARK_Specific.Enclosing_Subprogram_Or_Library_Package (Nod);
1035 SPARK_Specific.Enclosing_Subprogram_Or_Library_Package (Ent);
1037 -- Since we are reaching through renamings in SPARK mode, we may
1038 -- end up with standard constants. Ignore those.
1040 if Sloc (Ent_Scope) <= Standard_Location
1041 or else Def <= Standard_Location
1050 Eun => Get_Code_Unit (Def),
1051 Lun => Get_Code_Unit (Ref),
1052 Ref_Scope => Ref_Scope,
1053 Ent_Scope => Ent_Scope),
1054 Ent_Scope_File => Get_Code_Unit (Ent));
1057 Ref := Original_Location (Sloc (Nod));
1058 Def := Original_Location (Sloc (Ent));
1060 -- If this is an operator symbol, skip the initial quote for
1061 -- navigation purposes. This is not done for the end label,
1062 -- where we want the actual position after the closing quote.
1067 elsif Nkind (N) = N_Defining_Operator_Symbol
1068 or else Nkind (Nod) = N_Operator_Symbol
1077 Eun => Get_Source_Unit (Def),
1078 Lun => Get_Source_Unit (Ref),
1080 Ent_Scope => Empty),
1081 Ent_Scope_File => No_Unit);
1083 -- Generate reference to the first private entity
1086 and then Comes_From_Source (E)
1087 and then Nkind (Ent) = N_Defining_Identifier
1088 and then (Is_Package_Or_Generic_Package (Ent)
1089 or else Is_Concurrent_Type (Ent))
1090 and then Present (First_Private_Entity (E))
1091 and then In_Extended_Main_Source_Unit (N)
1093 -- Handle case in which the full-view and partial-view of the
1094 -- first private entity are swapped
1097 First_Private : Entity_Id := First_Private_Entity (E);
1100 if Is_Private_Type (First_Private)
1101 and then Present (Full_View (First_Private))
1103 First_Private := Full_View (First_Private);
1108 Loc => Sloc (First_Private),
1110 Eun => Get_Source_Unit (Def),
1111 Lun => Get_Source_Unit (Ref),
1113 Ent_Scope => Empty),
1114 Ent_Scope_File => No_Unit);
1119 end Generate_Reference;
1121 -----------------------------------
1122 -- Generate_Reference_To_Formals --
1123 -----------------------------------
1125 procedure Generate_Reference_To_Formals (E : Entity_Id) is
1129 if Is_Generic_Subprogram (E) then
1130 Formal := First_Entity (E);
1132 while Present (Formal)
1133 and then not Is_Formal (Formal)
1135 Next_Entity (Formal);
1138 elsif Ekind (E) in Access_Subprogram_Kind then
1139 Formal := First_Formal (Designated_Type (E));
1142 Formal := First_Formal (E);
1145 while Present (Formal) loop
1146 if Ekind (Formal) = E_In_Parameter then
1148 if Nkind (Parameter_Type (Parent (Formal)))
1149 = N_Access_Definition
1151 Generate_Reference (E, Formal, '^', False);
1153 Generate_Reference (E, Formal, '>', False);
1156 elsif Ekind (Formal) = E_In_Out_Parameter then
1157 Generate_Reference (E, Formal, '=', False);
1160 Generate_Reference (E, Formal, '<', False);
1163 Next_Formal (Formal);
1165 end Generate_Reference_To_Formals;
1167 -------------------------------------------
1168 -- Generate_Reference_To_Generic_Formals --
1169 -------------------------------------------
1171 procedure Generate_Reference_To_Generic_Formals (E : Entity_Id) is
1175 Formal := First_Entity (E);
1176 while Present (Formal) loop
1177 if Comes_From_Source (Formal) then
1178 Generate_Reference (E, Formal, 'z', False);
1181 Next_Entity (Formal);
1183 end Generate_Reference_To_Generic_Formals;
1189 function Get_Key (E : Xref_Entry_Number) return Xref_Entry_Number is
1198 function Hash (F : Xref_Entry_Number) return Header_Num is
1199 -- It is unlikely to have two references to the same entity at the same
1200 -- source location, so the hash function depends only on the Ent and Loc
1203 XE : Xref_Entry renames Xrefs.Table (F);
1204 type M is mod 2**32;
1206 H : constant M := M (XE.Key.Ent) + 2 ** 7 * M (abs XE.Key.Loc);
1207 -- It would be more natural to write:
1209 -- H : constant M := M'Mod (XE.Key.Ent) + 2**7 * M'Mod (XE.Key.Loc);
1211 -- But we can't use M'Mod, because it prevents bootstrapping with older
1212 -- compilers. Loc can be negative, so we do "abs" before converting.
1213 -- One day this can be cleaned up ???
1216 return Header_Num (H mod Num_Buckets);
1223 procedure HT_Set_Next (E : Xref_Entry_Number; Next : Xref_Entry_Number) is
1225 Xrefs.Table (E).HTable_Next := Next;
1232 function HT_Next (E : Xref_Entry_Number) return Xref_Entry_Number is
1234 return Xrefs.Table (E).HTable_Next;
1241 procedure Initialize is
1250 function Lt (T1, T2 : Xref_Entry) return Boolean is
1252 -- First test: if entity is in different unit, sort by unit
1254 if T1.Key.Eun /= T2.Key.Eun then
1255 return Dependency_Num (T1.Key.Eun) < Dependency_Num (T2.Key.Eun);
1257 -- Second test: within same unit, sort by entity Sloc
1259 elsif T1.Def /= T2.Def then
1260 return T1.Def < T2.Def;
1262 -- Third test: sort definitions ahead of references
1264 elsif T1.Key.Loc = No_Location then
1267 elsif T2.Key.Loc = No_Location then
1270 -- Fourth test: for same entity, sort by reference location unit
1272 elsif T1.Key.Lun /= T2.Key.Lun then
1273 return Dependency_Num (T1.Key.Lun) < Dependency_Num (T2.Key.Lun);
1275 -- Fifth test: order of location within referencing unit
1277 elsif T1.Key.Loc /= T2.Key.Loc then
1278 return T1.Key.Loc < T2.Key.Loc;
1280 -- Finally, for two locations at the same address, we prefer
1281 -- the one that does NOT have the type 'r' so that a modification
1282 -- or extension takes preference, when there are more than one
1283 -- reference at the same location. As a result, in the case of
1284 -- entities that are in-out actuals, the read reference follows
1285 -- the modify reference.
1288 return T2.Key.Typ = 'r';
1292 -----------------------
1293 -- Output_References --
1294 -----------------------
1296 procedure Output_References is
1298 procedure Get_Type_Reference
1300 Tref : out Entity_Id;
1301 Left : out Character;
1302 Right : out Character);
1303 -- Given an Entity_Id Ent, determines whether a type reference is
1304 -- required. If so, Tref is set to the entity for the type reference
1305 -- and Left and Right are set to the left/right brackets to be output
1306 -- for the reference. If no type reference is required, then Tref is
1307 -- set to Empty, and Left/Right are set to space.
1309 procedure Output_Import_Export_Info (Ent : Entity_Id);
1310 -- Output language and external name information for an interfaced
1311 -- entity, using the format <language, external_name>.
1313 ------------------------
1314 -- Get_Type_Reference --
1315 ------------------------
1317 procedure Get_Type_Reference
1319 Tref : out Entity_Id;
1320 Left : out Character;
1321 Right : out Character)
1326 -- See if we have a type reference
1335 -- Processing for types
1337 if Is_Type (Tref) then
1339 -- Case of base type
1341 if Base_Type (Tref) = Tref then
1343 -- If derived, then get first subtype
1345 if Tref /= Etype (Tref) then
1346 Tref := First_Subtype (Etype (Tref));
1348 -- Set brackets for derived type, but don't override
1349 -- pointer case since the fact that something is a
1350 -- pointer is more important.
1357 -- If the completion of a private type is itself a derived
1358 -- type, we need the parent of the full view.
1360 elsif Is_Private_Type (Tref)
1361 and then Present (Full_View (Tref))
1362 and then Etype (Full_View (Tref)) /= Full_View (Tref)
1364 Tref := Etype (Full_View (Tref));
1371 -- If non-derived pointer, get directly designated type.
1372 -- If the type has a full view, all references are on the
1373 -- partial view that is seen first.
1375 elsif Is_Access_Type (Tref) then
1376 Tref := Directly_Designated_Type (Tref);
1380 elsif Is_Private_Type (Tref)
1381 and then Present (Full_View (Tref))
1383 if Is_Access_Type (Full_View (Tref)) then
1384 Tref := Directly_Designated_Type (Full_View (Tref));
1388 -- If the full view is an array type, we also retrieve
1389 -- the corresponding component type, because the ali
1390 -- entry already indicates that this is an array.
1392 elsif Is_Array_Type (Full_View (Tref)) then
1393 Tref := Component_Type (Full_View (Tref));
1398 -- If non-derived array, get component type. Skip component
1399 -- type for case of String or Wide_String, saves worthwhile
1402 elsif Is_Array_Type (Tref)
1403 and then Tref /= Standard_String
1404 and then Tref /= Standard_Wide_String
1406 Tref := Component_Type (Tref);
1410 -- For other non-derived base types, nothing
1416 -- For a subtype, go to ancestor subtype
1419 Tref := Ancestor_Subtype (Tref);
1421 -- If no ancestor subtype, go to base type
1424 Tref := Base_Type (Sav);
1428 -- For objects, functions, enum literals, just get type from
1431 elsif Is_Object (Tref)
1432 or else Ekind (Tref) = E_Enumeration_Literal
1433 or else Ekind (Tref) = E_Function
1434 or else Ekind (Tref) = E_Operator
1436 Tref := Etype (Tref);
1438 -- Another special case: an object of a classwide type
1439 -- initialized with a tag-indeterminate call gets a subtype
1440 -- of the classwide type during expansion. See if the original
1441 -- type in the declaration is named, and return it instead
1442 -- of going to the root type.
1444 if Ekind (Tref) = E_Class_Wide_Subtype
1445 and then Nkind (Parent (Ent)) = N_Object_Declaration
1447 Nkind (Original_Node (Object_Definition (Parent (Ent))))
1452 (Original_Node ((Object_Definition (Parent (Ent)))));
1455 -- For anything else, exit
1461 -- Exit if no type reference, or we are stuck in some loop trying
1462 -- to find the type reference, or if the type is standard void
1463 -- type (the latter is an implementation artifact that should not
1464 -- show up in the generated cross-references).
1468 or else Tref = Standard_Void_Type;
1470 -- If we have a usable type reference, return, otherwise keep
1471 -- looking for something useful (we are looking for something
1472 -- that either comes from source or standard)
1474 if Sloc (Tref) = Standard_Location
1475 or else Comes_From_Source (Tref)
1477 -- If the reference is a subtype created for a generic actual,
1478 -- go actual directly, the inner subtype is not user visible.
1480 if Nkind (Parent (Tref)) = N_Subtype_Declaration
1481 and then not Comes_From_Source (Parent (Tref))
1483 (Is_Wrapper_Package (Scope (Tref))
1484 or else Is_Generic_Instance (Scope (Tref)))
1486 Tref := First_Subtype (Base_Type (Tref));
1493 -- If we fall through the loop, no type reference
1498 end Get_Type_Reference;
1500 -------------------------------
1501 -- Output_Import_Export_Info --
1502 -------------------------------
1504 procedure Output_Import_Export_Info (Ent : Entity_Id) is
1505 Language_Name : Name_Id;
1506 Conv : constant Convention_Id := Convention (Ent);
1509 -- Generate language name from convention
1511 if Conv = Convention_C then
1512 Language_Name := Name_C;
1514 elsif Conv = Convention_CPP then
1515 Language_Name := Name_CPP;
1517 elsif Conv = Convention_Ada then
1518 Language_Name := Name_Ada;
1521 -- For the moment we ignore all other cases ???
1526 Write_Info_Char ('<');
1527 Get_Unqualified_Name_String (Language_Name);
1529 for J in 1 .. Name_Len loop
1530 Write_Info_Char (Name_Buffer (J));
1533 if Present (Interface_Name (Ent)) then
1534 Write_Info_Char (',');
1535 String_To_Name_Buffer (Strval (Interface_Name (Ent)));
1537 for J in 1 .. Name_Len loop
1538 Write_Info_Char (Name_Buffer (J));
1542 Write_Info_Char ('>');
1543 end Output_Import_Export_Info;
1545 -- Start of processing for Output_References
1548 -- First we add references to the primitive operations of tagged types
1549 -- declared in the main unit.
1551 Handle_Prim_Ops : declare
1555 for J in 1 .. Xrefs.Last loop
1556 Ent := Xrefs.Table (J).Key.Ent;
1559 and then Is_Tagged_Type (Ent)
1560 and then Is_Base_Type (Ent)
1561 and then In_Extended_Main_Source_Unit (Ent)
1563 Generate_Prim_Op_References (Ent);
1566 end Handle_Prim_Ops;
1568 -- Before we go ahead and output the references we have a problem
1569 -- that needs dealing with. So far we have captured things that are
1570 -- definitely referenced by the main unit, or defined in the main
1571 -- unit. That's because we don't want to clutter up the ali file
1572 -- for this unit with definition lines for entities in other units
1573 -- that are not referenced.
1575 -- But there is a glitch. We may reference an entity in another unit,
1576 -- and it may have a type reference to an entity that is not directly
1577 -- referenced in the main unit, which may mean that there is no xref
1578 -- entry for this entity yet in the list of references.
1580 -- If we don't do something about this, we will end with an orphan type
1581 -- reference, i.e. it will point to an entity that does not appear
1582 -- within the generated references in the ali file. That is not good for
1583 -- tools using the xref information.
1585 -- To fix this, we go through the references adding definition entries
1586 -- for any unreferenced entities that can be referenced in a type
1587 -- reference. There is a recursion problem here, and that is dealt with
1588 -- by making sure that this traversal also traverses any entries that
1589 -- get added by the traversal.
1591 Handle_Orphan_Type_References : declare
1597 pragma Warnings (Off, L);
1598 pragma Warnings (Off, R);
1600 procedure New_Entry (E : Entity_Id);
1601 -- Make an additional entry into the Xref table for a type entity
1602 -- that is related to the current entity (parent, type ancestor,
1603 -- progenitor, etc.).
1609 procedure New_Entry (E : Entity_Id) is
1611 pragma Assert (Present (E));
1613 if not Has_Xref_Entry (Implementation_Base_Type (E))
1614 and then Sloc (E) > No_Location
1619 Typ => Character'First,
1620 Eun => Get_Source_Unit (Original_Location (Sloc (E))),
1623 Ent_Scope => Empty),
1624 Ent_Scope_File => No_Unit);
1628 -- Start of processing for Handle_Orphan_Type_References
1631 -- Note that this is not a for loop for a very good reason. The
1632 -- processing of items in the table can add new items to the table,
1633 -- and they must be processed as well.
1636 while J <= Xrefs.Last loop
1637 Ent := Xrefs.Table (J).Key.Ent;
1638 Get_Type_Reference (Ent, Tref, L, R);
1641 and then not Has_Xref_Entry (Tref)
1642 and then Sloc (Tref) > No_Location
1646 if Is_Record_Type (Ent)
1647 and then Present (Interfaces (Ent))
1649 -- Add an entry for each one of the given interfaces
1650 -- implemented by type Ent.
1653 Elmt : Elmt_Id := First_Elmt (Interfaces (Ent));
1655 while Present (Elmt) loop
1656 New_Entry (Node (Elmt));
1663 -- Collect inherited primitive operations that may be declared in
1664 -- another unit and have no visible reference in the current one.
1667 and then Is_Tagged_Type (Ent)
1668 and then Is_Derived_Type (Ent)
1669 and then Is_Base_Type (Ent)
1670 and then In_Extended_Main_Source_Unit (Ent)
1673 Op_List : constant Elist_Id := Primitive_Operations (Ent);
1677 function Parent_Op (E : Entity_Id) return Entity_Id;
1678 -- Find original operation, which may be inherited through
1679 -- several derivations.
1681 function Parent_Op (E : Entity_Id) return Entity_Id is
1682 Orig_Op : constant Entity_Id := Alias (E);
1685 if No (Orig_Op) then
1688 elsif not Comes_From_Source (E)
1689 and then not Has_Xref_Entry (Orig_Op)
1690 and then Comes_From_Source (Orig_Op)
1694 return Parent_Op (Orig_Op);
1699 Op := First_Elmt (Op_List);
1700 while Present (Op) loop
1701 Prim := Parent_Op (Node (Op));
1703 if Present (Prim) then
1707 Typ => Character'First,
1708 Eun => Get_Source_Unit (Sloc (Prim)),
1711 Ent_Scope => Empty),
1712 Ent_Scope_File => No_Unit);
1722 end Handle_Orphan_Type_References;
1724 -- Now we have all the references, including those for any embedded type
1725 -- references, so we can sort them, and output them.
1727 Output_Refs : declare
1729 Nrefs : constant Nat := Xrefs.Last;
1730 -- Number of references in table
1732 Rnums : array (0 .. Nrefs) of Nat;
1733 -- This array contains numbers of references in the Xrefs table.
1734 -- This list is sorted in output order. The extra 0'th entry is
1735 -- convenient for the call to sort. When we sort the table, we
1736 -- move the entries in Rnums around, but we do not move the
1737 -- original table entries.
1739 Curxu : Unit_Number_Type;
1740 -- Current xref unit
1742 Curru : Unit_Number_Type;
1743 -- Current reference unit for one entity
1748 Curnam : String (1 .. Name_Buffer'Length);
1750 -- Simple name and length of current entity
1752 Curdef : Source_Ptr;
1753 -- Original source location for current entity
1756 -- Current reference location
1759 -- Entity type character
1762 -- reference kind of previous reference
1768 -- Renaming reference
1770 Trunit : Unit_Number_Type;
1771 -- Unit number for type reference
1773 function Lt (Op1, Op2 : Natural) return Boolean;
1774 -- Comparison function for Sort call
1776 function Name_Change (X : Entity_Id) return Boolean;
1777 -- Determines if entity X has a different simple name from Curent
1779 procedure Move (From : Natural; To : Natural);
1780 -- Move procedure for Sort call
1782 package Sorting is new GNAT.Heap_Sort_G (Move, Lt);
1788 function Lt (Op1, Op2 : Natural) return Boolean is
1789 T1 : Xref_Entry renames Xrefs.Table (Rnums (Nat (Op1)));
1790 T2 : Xref_Entry renames Xrefs.Table (Rnums (Nat (Op2)));
1800 procedure Move (From : Natural; To : Natural) is
1802 Rnums (Nat (To)) := Rnums (Nat (From));
1809 -- Why a string comparison here??? Why not compare Name_Id values???
1811 function Name_Change (X : Entity_Id) return Boolean is
1813 Get_Unqualified_Name_String (Chars (X));
1815 if Name_Len /= Curlen then
1818 return Name_Buffer (1 .. Curlen) /= Curnam (1 .. Curlen);
1822 -- Start of processing for Output_Refs
1825 -- Capture the definition Sloc values. We delay doing this till now,
1826 -- since at the time the reference or definition is made, private
1827 -- types may be swapped, and the Sloc value may be incorrect. We
1828 -- also set up the pointer vector for the sort.
1830 -- For user-defined operators we need to skip the initial quote and
1831 -- point to the first character of the name, for navigation purposes.
1833 for J in 1 .. Nrefs loop
1835 E : constant Entity_Id := Xrefs.Table (J).Key.Ent;
1836 Loc : constant Source_Ptr := Original_Location (Sloc (E));
1841 if Nkind (E) = N_Defining_Operator_Symbol then
1842 Xrefs.Table (J).Def := Loc + 1;
1844 Xrefs.Table (J).Def := Loc;
1849 -- Sort the references
1851 Sorting.Sort (Integer (Nrefs));
1853 -- Initialize loop through references
1857 Curdef := No_Location;
1859 Crloc := No_Location;
1862 -- Loop to output references
1864 for Refno in 1 .. Nrefs loop
1865 Output_One_Ref : declare
1868 XE : Xref_Entry renames Xrefs.Table (Rnums (Refno));
1869 -- The current entry to be accessed
1873 -- Used for {} or <> or () for type reference
1875 procedure Check_Type_Reference
1877 List_Interface : Boolean);
1878 -- Find whether there is a meaningful type reference for
1879 -- Ent, and display it accordingly. If List_Interface is
1880 -- true, then Ent is a progenitor interface of the current
1881 -- type entity being listed. In that case list it as is,
1882 -- without looking for a type reference for it.
1884 procedure Output_Instantiation_Refs (Loc : Source_Ptr);
1885 -- Recursive procedure to output instantiation references for
1886 -- the given source ptr in [file|line[...]] form. No output
1887 -- if the given location is not a generic template reference.
1889 procedure Output_Overridden_Op (Old_E : Entity_Id);
1890 -- For a subprogram that is overriding, display information
1891 -- about the inherited operation that it overrides.
1893 --------------------------
1894 -- Check_Type_Reference --
1895 --------------------------
1897 procedure Check_Type_Reference
1899 List_Interface : Boolean)
1902 if List_Interface then
1904 -- This is a progenitor interface of the type for which
1905 -- xref information is being generated.
1912 Get_Type_Reference (Ent, Tref, Left, Right);
1915 if Present (Tref) then
1917 -- Case of standard entity, output name
1919 if Sloc (Tref) = Standard_Location then
1920 Write_Info_Char (Left);
1921 Write_Info_Name (Chars (Tref));
1922 Write_Info_Char (Right);
1924 -- Case of source entity, output location
1927 Write_Info_Char (Left);
1928 Trunit := Get_Source_Unit (Sloc (Tref));
1930 if Trunit /= Curxu then
1931 Write_Info_Nat (Dependency_Num (Trunit));
1932 Write_Info_Char ('|');
1936 (Int (Get_Logical_Line_Number (Sloc (Tref))));
1944 Ctyp := Xref_Entity_Letters (Ekind (Ent));
1947 and then Present (Full_View (Ent))
1949 Ent := Underlying_Type (Ent);
1951 if Present (Ent) then
1952 Ctyp := Xref_Entity_Letters (Ekind (Ent));
1956 Write_Info_Char (Ctyp);
1960 (Int (Get_Column_Number (Sloc (Tref))));
1962 -- If the type comes from an instantiation, add the
1963 -- corresponding info.
1965 Output_Instantiation_Refs (Sloc (Tref));
1966 Write_Info_Char (Right);
1969 end Check_Type_Reference;
1971 -------------------------------
1972 -- Output_Instantiation_Refs --
1973 -------------------------------
1975 procedure Output_Instantiation_Refs (Loc : Source_Ptr) is
1976 Iloc : constant Source_Ptr := Instantiation_Location (Loc);
1977 Lun : Unit_Number_Type;
1978 Cu : constant Unit_Number_Type := Curru;
1981 -- Nothing to do if this is not an instantiation
1983 if Iloc = No_Location then
1987 -- Output instantiation reference
1989 Write_Info_Char ('[');
1990 Lun := Get_Source_Unit (Iloc);
1992 if Lun /= Curru then
1994 Write_Info_Nat (Dependency_Num (Curru));
1995 Write_Info_Char ('|');
1998 Write_Info_Nat (Int (Get_Logical_Line_Number (Iloc)));
2000 -- Recursive call to get nested instantiations
2002 Output_Instantiation_Refs (Iloc);
2004 -- Output final ] after call to get proper nesting
2006 Write_Info_Char (']');
2009 end Output_Instantiation_Refs;
2011 --------------------------
2012 -- Output_Overridden_Op --
2013 --------------------------
2015 procedure Output_Overridden_Op (Old_E : Entity_Id) is
2019 -- The overridden operation has an implicit declaration
2020 -- at the point of derivation. What we want to display
2021 -- is the original operation, which has the actual body
2022 -- (or abstract declaration) that is being overridden.
2023 -- The overridden operation is not always set, e.g. when
2024 -- it is a predefined operator.
2029 -- Follow alias chain if one is present
2031 elsif Present (Alias (Old_E)) then
2033 -- The subprogram may have been implicitly inherited
2034 -- through several levels of derivation, so find the
2035 -- ultimate (source) ancestor.
2037 Op := Ultimate_Alias (Old_E);
2039 -- Normal case of no alias present. We omit generated
2040 -- primitives like tagged equality, that have no source
2048 and then Sloc (Op) /= Standard_Location
2049 and then Comes_From_Source (Op)
2052 Loc : constant Source_Ptr := Sloc (Op);
2053 Par_Unit : constant Unit_Number_Type :=
2054 Get_Source_Unit (Loc);
2057 Write_Info_Char ('<');
2059 if Par_Unit /= Curxu then
2060 Write_Info_Nat (Dependency_Num (Par_Unit));
2061 Write_Info_Char ('|');
2064 Write_Info_Nat (Int (Get_Logical_Line_Number (Loc)));
2065 Write_Info_Char ('p');
2066 Write_Info_Nat (Int (Get_Column_Number (Loc)));
2067 Write_Info_Char ('>');
2070 end Output_Overridden_Op;
2072 -- Start of processing for Output_One_Ref
2076 Ctyp := Xref_Entity_Letters (Ekind (Ent));
2078 -- Skip reference if it is the only reference to an entity,
2079 -- and it is an END line reference, and the entity is not in
2080 -- the current extended source. This prevents junk entries
2081 -- consisting only of packages with END lines, where no
2082 -- entity from the package is actually referenced.
2085 and then Ent /= Curent
2086 and then (Refno = Nrefs
2088 Ent /= Xrefs.Table (Rnums (Refno + 1)).Key.Ent)
2089 and then not In_Extended_Main_Source_Unit (Ent)
2094 -- For private type, get full view type
2097 and then Present (Full_View (XE.Key.Ent))
2099 Ent := Underlying_Type (Ent);
2101 if Present (Ent) then
2102 Ctyp := Xref_Entity_Letters (Ekind (Ent));
2106 -- Special exception for Boolean
2108 if Ctyp = 'E' and then Is_Boolean_Type (Ent) then
2112 -- For variable reference, get corresponding type
2115 Ent := Etype (XE.Key.Ent);
2116 Ctyp := Fold_Lower (Xref_Entity_Letters (Ekind (Ent)));
2118 -- If variable is private type, get full view type
2121 and then Present (Full_View (Etype (XE.Key.Ent)))
2123 Ent := Underlying_Type (Etype (XE.Key.Ent));
2125 if Present (Ent) then
2126 Ctyp := Fold_Lower (Xref_Entity_Letters (Ekind (Ent)));
2129 elsif Is_Generic_Type (Ent) then
2131 -- If the type of the entity is a generic private type,
2132 -- there is no usable full view, so retain the indication
2133 -- that this is an object.
2138 -- Special handling for access parameters and objects and
2139 -- components of an anonymous access type.
2141 if Ekind_In (Etype (XE.Key.Ent),
2142 E_Anonymous_Access_Type,
2143 E_Anonymous_Access_Subprogram_Type,
2144 E_Anonymous_Access_Protected_Subprogram_Type)
2146 if Is_Formal (XE.Key.Ent)
2149 (XE.Key.Ent, E_Variable, E_Constant, E_Component)
2154 -- Special handling for Boolean
2156 elsif Ctyp = 'e' and then Is_Boolean_Type (Ent) then
2161 -- Special handling for abstract types and operations
2163 if Is_Overloadable (XE.Key.Ent)
2164 and then Is_Abstract_Subprogram (XE.Key.Ent)
2167 Ctyp := 'x'; -- Abstract procedure
2169 elsif Ctyp = 'V' then
2170 Ctyp := 'y'; -- Abstract function
2173 elsif Is_Type (XE.Key.Ent)
2174 and then Is_Abstract_Type (XE.Key.Ent)
2176 if Is_Interface (XE.Key.Ent) then
2179 elsif Ctyp = 'R' then
2180 Ctyp := 'H'; -- Abstract type
2184 -- Only output reference if interesting type of entity
2188 -- Suppress references to object definitions, used for local
2191 or else XE.Key.Typ = 'D'
2192 or else XE.Key.Typ = 'I'
2194 -- Suppress self references, except for bodies that act as
2197 or else (XE.Key.Loc = XE.Def
2200 or else not Is_Subprogram (XE.Key.Ent)))
2202 -- Also suppress definitions of body formals (we only
2203 -- treat these as references, and the references were
2204 -- separately recorded).
2206 or else (Is_Formal (XE.Key.Ent)
2207 and then Present (Spec_Entity (XE.Key.Ent)))
2212 -- Start new Xref section if new xref unit
2214 if XE.Key.Eun /= Curxu then
2215 if Write_Info_Col > 1 then
2219 Curxu := XE.Key.Eun;
2221 Write_Info_Initiate ('X');
2222 Write_Info_Char (' ');
2223 Write_Info_Nat (Dependency_Num (XE.Key.Eun));
2224 Write_Info_Char (' ');
2226 (Reference_Name (Source_Index (XE.Key.Eun)));
2229 -- Start new Entity line if new entity. Note that we
2230 -- consider two entities the same if they have the same
2231 -- name and source location. This causes entities in
2232 -- instantiations to be treated as though they referred
2237 (XE.Key.Ent /= Curent
2239 (Name_Change (XE.Key.Ent) or else XE.Def /= Curdef))
2241 Curent := XE.Key.Ent;
2244 Get_Unqualified_Name_String (Chars (XE.Key.Ent));
2246 Curnam (1 .. Curlen) := Name_Buffer (1 .. Curlen);
2248 if Write_Info_Col > 1 then
2252 -- Write column number information
2254 Write_Info_Nat (Int (Get_Logical_Line_Number (XE.Def)));
2255 Write_Info_Char (Ctyp);
2256 Write_Info_Nat (Int (Get_Column_Number (XE.Def)));
2258 -- Write level information
2260 Write_Level_Info : declare
2261 function Is_Visible_Generic_Entity
2262 (E : Entity_Id) return Boolean;
2263 -- Check whether E is declared in the visible part
2264 -- of a generic package. For source navigation
2265 -- purposes, treat this as a visible entity.
2267 function Is_Private_Record_Component
2268 (E : Entity_Id) return Boolean;
2269 -- Check whether E is a non-inherited component of a
2270 -- private extension. Even if the enclosing record is
2271 -- public, we want to treat the component as private
2272 -- for navigation purposes.
2274 ---------------------------------
2275 -- Is_Private_Record_Component --
2276 ---------------------------------
2278 function Is_Private_Record_Component
2279 (E : Entity_Id) return Boolean
2281 S : constant Entity_Id := Scope (E);
2284 Ekind (E) = E_Component
2285 and then Nkind (Declaration_Node (S)) =
2286 N_Private_Extension_Declaration
2287 and then Original_Record_Component (E) = E;
2288 end Is_Private_Record_Component;
2290 -------------------------------
2291 -- Is_Visible_Generic_Entity --
2292 -------------------------------
2294 function Is_Visible_Generic_Entity
2295 (E : Entity_Id) return Boolean
2300 -- The Present check here is an error defense
2302 if Present (Scope (E))
2303 and then Ekind (Scope (E)) /= E_Generic_Package
2309 while Present (Par) loop
2311 Nkind (Par) = N_Generic_Package_Declaration
2313 -- Entity is a generic formal
2318 Nkind (Parent (Par)) = N_Package_Specification
2321 Is_List_Member (Par)
2322 and then List_Containing (Par) =
2323 Visible_Declarations (Parent (Par));
2325 Par := Parent (Par);
2330 end Is_Visible_Generic_Entity;
2332 -- Start of processing for Write_Level_Info
2335 if Is_Hidden (Curent)
2336 or else Is_Private_Record_Component (Curent)
2338 Write_Info_Char (' ');
2342 or else Is_Visible_Generic_Entity (Curent)
2344 Write_Info_Char ('*');
2347 Write_Info_Char (' ');
2349 end Write_Level_Info;
2351 -- Output entity name. We use the occurrence from the
2352 -- actual source program at the definition point.
2355 Ent_Name : constant String :=
2356 Exact_Source_Name (Sloc (XE.Key.Ent));
2358 for C in Ent_Name'Range loop
2359 Write_Info_Char (Ent_Name (C));
2363 -- See if we have a renaming reference
2365 if Is_Object (XE.Key.Ent)
2366 and then Present (Renamed_Object (XE.Key.Ent))
2368 Rref := Renamed_Object (XE.Key.Ent);
2370 elsif Is_Overloadable (XE.Key.Ent)
2371 and then Nkind (Parent (Declaration_Node (XE.Key.Ent)))
2372 = N_Subprogram_Renaming_Declaration
2374 Rref := Name (Parent (Declaration_Node (XE.Key.Ent)));
2376 elsif Ekind (XE.Key.Ent) = E_Package
2377 and then Nkind (Declaration_Node (XE.Key.Ent)) =
2378 N_Package_Renaming_Declaration
2380 Rref := Name (Declaration_Node (XE.Key.Ent));
2386 if Present (Rref) then
2387 if Nkind (Rref) = N_Expanded_Name then
2388 Rref := Selector_Name (Rref);
2391 if Nkind (Rref) = N_Identifier
2392 or else Nkind (Rref) = N_Operator_Symbol
2396 -- For renamed array components, use the array name
2397 -- for the renamed entity, which reflect the fact that
2398 -- in general the whole array is aliased.
2400 elsif Nkind (Rref) = N_Indexed_Component then
2401 if Nkind (Prefix (Rref)) = N_Identifier then
2402 Rref := Prefix (Rref);
2403 elsif Nkind (Prefix (Rref)) = N_Expanded_Name then
2404 Rref := Selector_Name (Prefix (Rref));
2414 -- Write out renaming reference if we have one
2416 if Present (Rref) then
2417 Write_Info_Char ('=');
2419 (Int (Get_Logical_Line_Number (Sloc (Rref))));
2420 Write_Info_Char (':');
2422 (Int (Get_Column_Number (Sloc (Rref))));
2425 -- Indicate that the entity is in the unit of the current
2430 -- Write out information about generic parent, if entity
2433 if Is_Generic_Instance (XE.Key.Ent) then
2435 Gen_Par : constant Entity_Id :=
2438 (Unit_Declaration_Node
2440 Loc : constant Source_Ptr := Sloc (Gen_Par);
2441 Gen_U : constant Unit_Number_Type :=
2442 Get_Source_Unit (Loc);
2445 Write_Info_Char ('[');
2447 if Curru /= Gen_U then
2448 Write_Info_Nat (Dependency_Num (Gen_U));
2449 Write_Info_Char ('|');
2453 (Int (Get_Logical_Line_Number (Loc)));
2454 Write_Info_Char (']');
2458 -- See if we have a type reference and if so output
2460 Check_Type_Reference (XE.Key.Ent, False);
2462 -- Additional information for types with progenitors,
2463 -- including synchronized tagged types.
2466 Typ : constant Entity_Id := XE.Key.Ent;
2470 if Is_Record_Type (Typ)
2471 and then Present (Interfaces (Typ))
2473 Elmt := First_Elmt (Interfaces (Typ));
2475 elsif Is_Concurrent_Type (Typ)
2476 and then Present (Corresponding_Record_Type (Typ))
2478 Interfaces (Corresponding_Record_Type (Typ)))
2482 Interfaces (Corresponding_Record_Type (Typ)));
2488 while Present (Elmt) loop
2489 Check_Type_Reference (Node (Elmt), True);
2494 -- For array types, list index types as well. (This is
2495 -- not C, indexes have distinct types).
2497 if Is_Array_Type (XE.Key.Ent) then
2501 Indx := First_Index (XE.Key.Ent);
2502 while Present (Indx) loop
2503 Check_Type_Reference
2504 (First_Subtype (Etype (Indx)), True);
2510 -- If the entity is an overriding operation, write info
2511 -- on operation that was overridden.
2513 if Is_Subprogram (XE.Key.Ent)
2514 and then Present (Overridden_Operation (XE.Key.Ent))
2516 Output_Overridden_Op
2517 (Overridden_Operation (XE.Key.Ent));
2520 -- End of processing for entity output
2522 Crloc := No_Location;
2525 -- Output the reference if it is not as the same location
2526 -- as the previous one, or it is a read-reference that
2527 -- indicates that the entity is an in-out actual in a call.
2529 if XE.Key.Loc /= No_Location
2531 (XE.Key.Loc /= Crloc
2532 or else (Prevt = 'm' and then XE.Key.Typ = 'r'))
2534 Crloc := XE.Key.Loc;
2535 Prevt := XE.Key.Typ;
2537 -- Start continuation if line full, else blank
2539 if Write_Info_Col > 72 then
2541 Write_Info_Initiate ('.');
2544 Write_Info_Char (' ');
2546 -- Output file number if changed
2548 if XE.Key.Lun /= Curru then
2549 Curru := XE.Key.Lun;
2550 Write_Info_Nat (Dependency_Num (Curru));
2551 Write_Info_Char ('|');
2555 (Int (Get_Logical_Line_Number (XE.Key.Loc)));
2556 Write_Info_Char (XE.Key.Typ);
2558 if Is_Overloadable (XE.Key.Ent) then
2559 if (Is_Imported (XE.Key.Ent) and then XE.Key.Typ = 'b')
2561 (Is_Exported (XE.Key.Ent) and then XE.Key.Typ = 'i')
2563 Output_Import_Export_Info (XE.Key.Ent);
2567 Write_Info_Nat (Int (Get_Column_Number (XE.Key.Loc)));
2569 Output_Instantiation_Refs (Sloc (XE.Key.Ent));
2580 end Output_References;
2582 ---------------------------------
2583 -- Process_Deferred_References --
2584 ---------------------------------
2586 procedure Process_Deferred_References is
2588 for J in Deferred_References.First .. Deferred_References.Last loop
2590 D : Deferred_Reference_Entry renames Deferred_References.Table (J);
2593 case Is_LHS (D.N) is
2595 Generate_Reference (D.E, D.N, 'm');
2598 Generate_Reference (D.E, D.N, 'r');
2600 -- Not clear if Unknown can occur at this stage, but if it
2601 -- does we will treat it as a normal reference.
2604 Generate_Reference (D.E, D.N, 'r');
2609 -- Clear processed entries from table
2611 Deferred_References.Init;
2612 end Process_Deferred_References;
2614 -- Start of elaboration for Lib.Xref
2617 -- Reset is necessary because Elmt_Ptr does not default to Null_Ptr,
2618 -- because it's not an access type.