1 ------------------------------------------------------------------------------
3 -- GNAT COMPILER COMPONENTS --
9 -- Copyright (C) 1998-2011, Free Software Foundation, Inc. --
11 -- GNAT is free software; you can redistribute it and/or modify it under --
12 -- terms of the GNU General Public License as published by the Free Soft- --
13 -- ware Foundation; either version 3, or (at your option) any later ver- --
14 -- sion. GNAT is distributed in the hope that it will be useful, but WITH- --
15 -- OUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY --
16 -- or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License --
17 -- for more details. You should have received a copy of the GNU General --
18 -- Public License distributed with GNAT; see file COPYING3. If not, go to --
19 -- http://www.gnu.org/licenses for a complete copy of the license. --
21 -- GNAT was originally developed by the GNAT team at New York University. --
22 -- Extensive contributions were provided by Ada Core Technologies Inc. --
24 ------------------------------------------------------------------------------
26 with Atree; use Atree;
27 with Csets; use Csets;
28 with Elists; use Elists;
29 with Errout; use Errout;
30 with Nlists; use Nlists;
32 with Restrict; use Restrict;
33 with Rident; use Rident;
35 with Sem_Aux; use Sem_Aux;
36 with Sem_Prag; use Sem_Prag;
37 with Sem_Util; use Sem_Util;
38 with Sem_Warn; use Sem_Warn;
39 with Sinfo; use Sinfo;
40 with Sinput; use Sinput;
41 with Snames; use Snames;
42 with Stringt; use Stringt;
43 with Stand; use Stand;
44 with Table; use Table;
46 with GNAT.Heap_Sort_G;
49 package body Lib.Xref is
55 -- The Xref table is used to record references. The Loc field is set
56 -- to No_Location for a definition entry.
58 subtype Xref_Entry_Number is Int;
60 type Xref_Key is record
61 -- These are the components of Xref_Entry that participate in hash
65 -- Entity referenced (E parameter to Generate_Reference)
68 -- Location of reference (Original_Location (Sloc field of N parameter
69 -- to Generate_Reference). Set to No_Location for the case of a
70 -- defining occurrence.
73 -- Reference type (Typ param to Generate_Reference)
75 Eun : Unit_Number_Type;
76 -- Unit number corresponding to Ent
78 Lun : Unit_Number_Type;
79 -- Unit number corresponding to Loc. Value is undefined and not
80 -- referenced if Loc is set to No_Location.
82 -- The following components are only used for Alfa cross-references
84 Ref_Scope : Entity_Id;
85 -- Entity of the closest subprogram or package enclosing the reference
87 Ent_Scope : Entity_Id;
88 -- Entity of the closest subprogram or package enclosing the definition,
89 -- which should be located in the same file as the definition itself.
92 type Xref_Entry is record
95 Ent_Scope_File : Unit_Number_Type;
96 -- File for entity Ent_Scope
99 -- Original source location for entity being referenced. Note that these
100 -- values are used only during the output process, they are not set when
101 -- the entries are originally built. This is because private entities
102 -- can be swapped when the initial call is made.
104 HTable_Next : Xref_Entry_Number;
105 -- For use only by Static_HTable
108 package Xrefs is new Table.Table (
109 Table_Component_Type => Xref_Entry,
110 Table_Index_Type => Xref_Entry_Number,
111 Table_Low_Bound => 1,
112 Table_Initial => Alloc.Xrefs_Initial,
113 Table_Increment => Alloc.Xrefs_Increment,
114 Table_Name => "Xrefs");
120 -- We keep a set of xref entries, in order to avoid inserting duplicate
121 -- entries into the above Xrefs table. An entry is in Xref_Set if and only
122 -- if it is in Xrefs.
124 Num_Buckets : constant := 2**16;
126 subtype Header_Num is Integer range 0 .. Num_Buckets - 1;
127 type Null_Type is null record;
128 pragma Unreferenced (Null_Type);
130 function Hash (F : Xref_Entry_Number) return Header_Num;
132 function Equal (F1, F2 : Xref_Entry_Number) return Boolean;
134 procedure HT_Set_Next (E : Xref_Entry_Number; Next : Xref_Entry_Number);
136 function HT_Next (E : Xref_Entry_Number) return Xref_Entry_Number;
138 function Get_Key (E : Xref_Entry_Number) return Xref_Entry_Number;
140 pragma Inline (Hash, Equal, HT_Set_Next, HT_Next, Get_Key);
142 package Xref_Set is new GNAT.HTable.Static_HTable (
144 Element => Xref_Entry,
145 Elmt_Ptr => Xref_Entry_Number,
147 Set_Next => HT_Set_Next,
149 Key => Xref_Entry_Number,
154 ----------------------
155 -- Alfa Information --
156 ----------------------
158 package body Alfa is separate;
160 ------------------------
161 -- Local Subprograms --
162 ------------------------
164 procedure Generate_Prim_Op_References (Typ : Entity_Id);
165 -- For a tagged type, generate implicit references to its primitive
166 -- operations, for source navigation. This is done right before emitting
167 -- cross-reference information rather than at the freeze point of the type
168 -- in order to handle late bodies that are primitive operations.
170 function Lt (T1, T2 : Xref_Entry) return Boolean;
171 -- Order cross-references
173 procedure Add_Entry (Key : Xref_Key; Ent_Scope_File : Unit_Number_Type);
174 -- Add an entry to the tables of Xref_Entries, avoiding duplicates
180 procedure Add_Entry (Key : Xref_Key; Ent_Scope_File : Unit_Number_Type) is
182 Xrefs.Increment_Last; -- tentative
183 Xrefs.Table (Xrefs.Last).Key := Key;
185 -- Set the entry in Xref_Set, and if newly set, keep the above
186 -- tentative increment.
188 if Xref_Set.Set_If_Not_Present (Xrefs.Last) then
189 Xrefs.Table (Xrefs.Last).Ent_Scope_File := Ent_Scope_File;
190 -- Leave Def and HTable_Next uninitialized
192 Set_Has_Xref_Entry (Key.Ent);
194 -- It was already in Xref_Set, so throw away the tentatively-added
198 Xrefs.Decrement_Last;
206 function Equal (F1, F2 : Xref_Entry_Number) return Boolean is
207 Result : constant Boolean :=
208 Xrefs.Table (F1).Key = Xrefs.Table (F2).Key;
213 -------------------------
214 -- Generate_Definition --
215 -------------------------
217 procedure Generate_Definition (E : Entity_Id) is
219 pragma Assert (Nkind (E) in N_Entity);
221 -- Note that we do not test Xref_Entity_Letters here. It is too early
222 -- to do so, since we are often called before the entity is fully
223 -- constructed, so that the Ekind is still E_Void.
227 -- Definition must come from source
229 -- We make an exception for subprogram child units that have no spec.
230 -- For these we generate a subprogram declaration for library use,
231 -- and the corresponding entity does not come from source.
232 -- Nevertheless, all references will be attached to it and we have
233 -- to treat is as coming from user code.
235 and then (Comes_From_Source (E) or else Is_Child_Unit (E))
237 -- And must have a reasonable source location that is not
238 -- within an instance (all entities in instances are ignored)
240 and then Sloc (E) > No_Location
241 and then Instantiation_Location (Sloc (E)) = No_Location
243 -- And must be a non-internal name from the main source unit
245 and then In_Extended_Main_Source_Unit (E)
246 and then not Is_Internal_Name (Chars (E))
252 Eun => Get_Source_Unit (Original_Location (Sloc (E))),
256 Ent_Scope_File => No_Unit);
258 if In_Inlined_Body then
262 end Generate_Definition;
264 ---------------------------------
265 -- Generate_Operator_Reference --
266 ---------------------------------
268 procedure Generate_Operator_Reference
273 if not In_Extended_Main_Source_Unit (N) then
277 -- If the operator is not a Standard operator, then we generate a real
278 -- reference to the user defined operator.
280 if Sloc (Entity (N)) /= Standard_Location then
281 Generate_Reference (Entity (N), N);
283 -- A reference to an implicit inequality operator is also a reference
284 -- to the user-defined equality.
286 if Nkind (N) = N_Op_Ne
287 and then not Comes_From_Source (Entity (N))
288 and then Present (Corresponding_Equality (Entity (N)))
290 Generate_Reference (Corresponding_Equality (Entity (N)), N);
293 -- For the case of Standard operators, we mark the result type as
294 -- referenced. This ensures that in the case where we are using a
295 -- derived operator, we mark an entity of the unit that implicitly
296 -- defines this operator as used. Otherwise we may think that no entity
297 -- of the unit is used. The actual entity marked as referenced is the
298 -- first subtype, which is the relevant user defined entity.
300 -- Note: we only do this for operators that come from source. The
301 -- generated code sometimes reaches for entities that do not need to be
302 -- explicitly visible (for example, when we expand the code for
303 -- comparing two record objects, the fields of the record may not be
306 elsif Comes_From_Source (N) then
307 Set_Referenced (First_Subtype (T));
309 end Generate_Operator_Reference;
311 ---------------------------------
312 -- Generate_Prim_Op_References --
313 ---------------------------------
315 procedure Generate_Prim_Op_References (Typ : Entity_Id) is
318 Prim_List : Elist_Id;
321 -- Handle subtypes of synchronized types
323 if Ekind (Typ) = E_Protected_Subtype
324 or else Ekind (Typ) = E_Task_Subtype
326 Base_T := Etype (Typ);
331 -- References to primitive operations are only relevant for tagged types
333 if not Is_Tagged_Type (Base_T)
334 or else Is_Class_Wide_Type (Base_T)
339 -- Ada 2005 (AI-345): For synchronized types generate reference to the
340 -- wrapper that allow us to dispatch calls through their implemented
341 -- abstract interface types.
343 -- The check for Present here is to protect against previously reported
346 Prim_List := Primitive_Operations (Base_T);
348 if No (Prim_List) then
352 Prim := First_Elmt (Prim_List);
353 while Present (Prim) loop
355 -- If the operation is derived, get the original for cross-reference
356 -- reference purposes (it is the original for which we want the xref
357 -- and for which the comes_from_source test must be performed).
360 (Typ, Ultimate_Alias (Node (Prim)), 'p', Set_Ref => False);
363 end Generate_Prim_Op_References;
365 ------------------------
366 -- Generate_Reference --
367 ------------------------
369 procedure Generate_Reference
372 Typ : Character := 'r';
373 Set_Ref : Boolean := True;
374 Force : Boolean := False)
381 Actual_Typ : Character := Typ;
383 Ref_Scope : Entity_Id;
384 Ent_Scope : Entity_Id;
385 Ent_Scope_File : Unit_Number_Type;
389 -- Used for call to Find_Actual
392 -- If Formal is non-Empty, then its Ekind, otherwise E_Void
394 function Get_Through_Renamings (E : Entity_Id) return Entity_Id;
395 -- Get the enclosing entity through renamings, which may come from
396 -- source or from the translation of generic instantiations.
398 function Is_On_LHS (Node : Node_Id) return Boolean;
399 -- Used to check if a node is on the left hand side of an assignment.
400 -- The following cases are handled:
402 -- Variable Node is a direct descendant of left hand side of an
403 -- assignment statement.
405 -- Prefix Of an indexed or selected component that is present in
406 -- a subtree rooted by an assignment statement. There is
407 -- no restriction of nesting of components, thus cases
408 -- such as A.B (C).D are handled properly. However a prefix
409 -- of a dereference (either implicit or explicit) is never
410 -- considered as on a LHS.
412 -- Out param Same as above cases, but OUT parameter
414 function OK_To_Set_Referenced return Boolean;
415 -- Returns True if the Referenced flag can be set. There are a few
416 -- exceptions where we do not want to set this flag, see body for
417 -- details of these exceptional cases.
419 ---------------------------
420 -- Get_Through_Renamings --
421 ---------------------------
423 function Get_Through_Renamings (E : Entity_Id) return Entity_Id is
424 Result : Entity_Id := E;
426 while Present (Result)
427 and then Is_Object (Result)
428 and then Present (Renamed_Object (Result))
430 Result := Get_Enclosing_Object (Renamed_Object (Result));
433 end Get_Through_Renamings;
439 -- ??? There are several routines here and there that perform a similar
440 -- (but subtly different) computation, which should be factored:
442 -- Sem_Util.May_Be_Lvalue
443 -- Sem_Util.Known_To_Be_Assigned
444 -- Exp_Ch2.Expand_Entry_Parameter.In_Assignment_Context
445 -- Exp_Smem.Is_Out_Actual
447 function Is_On_LHS (Node : Node_Id) return Boolean is
453 -- Only identifiers are considered, is this necessary???
455 if Nkind (Node) /= N_Identifier then
459 -- Immediate return if appeared as OUT parameter
461 if Kind = E_Out_Parameter then
465 -- Search for assignment statement subtree root
472 if K = N_Assignment_Statement then
475 -- Check whether the parent is a component and the current node is
476 -- its prefix, but return False if the current node has an access
477 -- type, as in that case the selected or indexed component is an
478 -- implicit dereference, and the LHS is the designated object, not
479 -- the access object.
481 -- ??? case of a slice assignment?
483 -- ??? Note that in some cases this is called too early
484 -- (see comments in Sem_Ch8.Find_Direct_Name), at a point where
485 -- the tree is not fully typed yet. In that case we may lack
486 -- an Etype for N, and we must disable the check for an implicit
487 -- dereference. If the dereference is on an LHS, this causes a
490 elsif (K = N_Selected_Component or else K = N_Indexed_Component)
491 and then Prefix (P) = N
492 and then not (Present (Etype (N))
494 Is_Access_Type (Etype (N)))
498 -- All other cases, definitely not on left side
506 ---------------------------
507 -- OK_To_Set_Referenced --
508 ---------------------------
510 function OK_To_Set_Referenced return Boolean is
514 -- A reference from a pragma Unreferenced or pragma Unmodified or
515 -- pragma Warnings does not cause the Referenced flag to be set.
516 -- This avoids silly warnings about things being referenced and
517 -- not assigned when the only reference is from the pragma.
519 if Nkind (N) = N_Identifier then
522 if Nkind (P) = N_Pragma_Argument_Association then
525 if Nkind (P) = N_Pragma then
526 if Pragma_Name (P) = Name_Warnings
528 Pragma_Name (P) = Name_Unmodified
530 Pragma_Name (P) = Name_Unreferenced
536 -- A reference to a formal in a named parameter association does
537 -- not make the formal referenced. Formals that are unused in the
538 -- subprogram body are properly flagged as such, even if calls
539 -- elsewhere use named notation.
541 elsif Nkind (P) = N_Parameter_Association
542 and then N = Selector_Name (P)
549 end OK_To_Set_Referenced;
551 -- Start of processing for Generate_Reference
554 pragma Assert (Nkind (E) in N_Entity);
555 Find_Actual (N, Formal, Call);
557 if Present (Formal) then
558 Kind := Ekind (Formal);
563 -- Check for obsolescent reference to package ASCII. GNAT treats this
564 -- element of annex J specially since in practice, programs make a lot
565 -- of use of this feature, so we don't include it in the set of features
566 -- diagnosed when Warn_On_Obsolescent_Features mode is set. However we
567 -- are required to note it as a violation of the RM defined restriction.
569 if E = Standard_ASCII then
570 Check_Restriction (No_Obsolescent_Features, N);
573 -- Check for reference to entity marked with Is_Obsolescent
575 -- Note that we always allow obsolescent references in the compiler
576 -- itself and the run time, since we assume that we know what we are
577 -- doing in such cases. For example the calls in Ada.Characters.Handling
578 -- to its own obsolescent subprograms are just fine.
580 -- In any case we do not generate warnings within the extended source
581 -- unit of the entity in question, since we assume the source unit
582 -- itself knows what is going on (and for sure we do not want silly
583 -- warnings, e.g. on the end line of 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)
589 Check_Restriction (No_Obsolescent_Features, N);
591 if Warn_On_Obsolescent_Feature then
592 Output_Obsolescent_Entity_Warnings (N, E);
596 -- Warn if reference to Ada 2005 entity not in Ada 2005 mode. We only
597 -- detect real explicit references (modifications and references).
599 if Comes_From_Source (N)
600 and then Is_Ada_2005_Only (E)
601 and then Ada_Version < Ada_2005
602 and then Warn_On_Ada_2005_Compatibility
603 and then (Typ = 'm' or else Typ = 'r' or else Typ = 's')
605 Error_Msg_NE ("& is only defined in Ada 2005?", N, E);
608 -- Warn if reference to Ada 2012 entity not in Ada 2012 mode. We only
609 -- detect real explicit references (modifications and references).
611 if Comes_From_Source (N)
612 and then Is_Ada_2012_Only (E)
613 and then Ada_Version < Ada_2012
614 and then Warn_On_Ada_2012_Compatibility
615 and then (Typ = 'm' or else Typ = 'r')
617 Error_Msg_NE ("& is only defined in Ada 2012?", N, E);
620 -- Never collect references if not in main source unit. However, we omit
621 -- this test if Typ is 'e' or 'k', since these entries are structural,
622 -- and it is useful to have them in units that reference packages as
623 -- well as units that define packages. We also omit the test for the
624 -- case of 'p' since we want to include inherited primitive operations
625 -- from other packages.
627 -- We also omit this test is this is a body reference for a subprogram
628 -- instantiation. In this case the reference is to the generic body,
629 -- which clearly need not be in the main unit containing the instance.
630 -- For the same reason we accept an implicit reference generated for
631 -- a default in an instance.
633 if not In_Extended_Main_Source_Unit (N) then
639 or else (Typ = 'b' and then Is_Generic_Instance (E))
647 -- For reference type p, the entity must be in main source unit
649 if Typ = 'p' and then not In_Extended_Main_Source_Unit (E) then
653 -- Unless the reference is forced, we ignore references where the
654 -- reference itself does not come from source.
656 if not Force and then not Comes_From_Source (N) then
660 -- Deal with setting entity as referenced, unless suppressed. Note that
661 -- we still do Set_Referenced on entities that do not come from source.
662 -- This situation arises when we have a source reference to a derived
663 -- operation, where the derived operation itself does not come from
664 -- source, but we still want to mark it as referenced, since we really
665 -- are referencing an entity in the corresponding package (this avoids
666 -- wrong complaints that the package contains no referenced entities).
670 -- Assignable object appearing on left side of assignment or as
674 and then Is_On_LHS (N)
675 and then Ekind (E) /= E_In_Out_Parameter
677 -- For objects that are renamings, just set as simply referenced
678 -- we do not try to do assignment type tracking in this case.
680 if Present (Renamed_Object (E)) then
683 -- Out parameter case
685 elsif Kind = E_Out_Parameter then
687 -- If warning mode for all out parameters is set, or this is
688 -- the only warning parameter, then we want to mark this for
689 -- later warning logic by setting Referenced_As_Out_Parameter
691 if Warn_On_Modified_As_Out_Parameter (Formal) then
692 Set_Referenced_As_Out_Parameter (E, True);
693 Set_Referenced_As_LHS (E, False);
695 -- For OUT parameter not covered by the above cases, we simply
696 -- regard it as a normal reference (in this case we do not
697 -- want any of the warning machinery for out parameters).
703 -- For the left hand of an assignment case, we do nothing here.
704 -- The processing for Analyze_Assignment_Statement will set the
705 -- Referenced_As_LHS flag.
711 -- Check for a reference in a pragma that should not count as a
712 -- making the variable referenced for warning purposes.
714 elsif Is_Non_Significant_Pragma_Reference (N) then
717 -- A reference in an attribute definition clause does not count as a
718 -- reference except for the case of Address. The reason that 'Address
719 -- is an exception is that it creates an alias through which the
720 -- variable may be referenced.
722 elsif Nkind (Parent (N)) = N_Attribute_Definition_Clause
723 and then Chars (Parent (N)) /= Name_Address
724 and then N = Name (Parent (N))
728 -- Constant completion does not count as a reference
731 and then Ekind (E) = E_Constant
735 -- Record representation clause does not count as a reference
737 elsif Nkind (N) = N_Identifier
738 and then Nkind (Parent (N)) = N_Record_Representation_Clause
742 -- Discriminants do not need to produce a reference to record type
745 and then Nkind (Parent (N)) = N_Discriminant_Specification
752 -- Special processing for IN OUT parameters, where we have an
753 -- implicit assignment to a simple variable.
755 if Kind = E_In_Out_Parameter
756 and then Is_Assignable (E)
758 -- For sure this counts as a normal read reference
761 Set_Last_Assignment (E, Empty);
763 -- We count it as being referenced as an out parameter if the
764 -- option is set to warn on all out parameters, except that we
765 -- have a special exclusion for an intrinsic subprogram, which
766 -- is most likely an instantiation of Unchecked_Deallocation
767 -- which we do not want to consider as an assignment since it
768 -- generates false positives. We also exclude the case of an
769 -- IN OUT parameter if the name of the procedure is Free,
770 -- since we suspect similar semantics.
772 if Warn_On_All_Unread_Out_Parameters
773 and then Is_Entity_Name (Name (Call))
774 and then not Is_Intrinsic_Subprogram (Entity (Name (Call)))
775 and then Chars (Name (Call)) /= Name_Free
777 Set_Referenced_As_Out_Parameter (E, True);
778 Set_Referenced_As_LHS (E, False);
781 -- Don't count a recursive reference within a subprogram as a
782 -- reference (that allows detection of a recursive subprogram
783 -- whose only references are recursive calls as unreferenced).
785 elsif Is_Subprogram (E)
786 and then E = Nearest_Dynamic_Scope (Current_Scope)
790 -- Any other occurrence counts as referencing the entity
792 elsif OK_To_Set_Referenced then
795 -- If variable, this is an OK reference after an assignment
796 -- so we can clear the Last_Assignment indication.
798 if Is_Assignable (E) then
799 Set_Last_Assignment (E, Empty);
804 -- Check for pragma Unreferenced given and reference is within
805 -- this source unit (occasion for possible warning to be issued).
807 if Has_Unreferenced (E)
808 and then In_Same_Extended_Unit (E, N)
810 -- A reference as a named parameter in a call does not count
811 -- as a violation of pragma Unreferenced for this purpose...
813 if Nkind (N) = N_Identifier
814 and then Nkind (Parent (N)) = N_Parameter_Association
815 and then Selector_Name (Parent (N)) = N
819 -- ... Neither does a reference to a variable on the left side
822 elsif Is_On_LHS (N) then
825 -- For entry formals, we want to place the warning message on the
826 -- corresponding entity in the accept statement. The current scope
827 -- is the body of the accept, so we find the formal whose name
828 -- matches that of the entry formal (there is no link between the
829 -- two entities, and the one in the accept statement is only used
830 -- for conformance checking).
832 elsif Ekind (Scope (E)) = E_Entry then
837 BE := First_Entity (Current_Scope);
838 while Present (BE) loop
839 if Chars (BE) = Chars (E) then
840 Error_Msg_NE -- CODEFIX
841 ("?pragma Unreferenced given for&!", N, BE);
849 -- Here we issue the warning, since this is a real reference
852 Error_Msg_NE -- CODEFIX
853 ("?pragma Unreferenced given for&!", N, E);
857 -- If this is a subprogram instance, mark as well the internal
858 -- subprogram in the wrapper package, which may be a visible
861 if Is_Overloadable (E)
862 and then Is_Generic_Instance (E)
863 and then Present (Alias (E))
865 Set_Referenced (Alias (E));
869 -- Generate reference if all conditions are met:
872 -- Cross referencing must be active
876 -- The entity must be one for which we collect references
878 and then Xref_Entity_Letters (Ekind (E)) /= ' '
880 -- Both Sloc values must be set to something sensible
882 and then Sloc (E) > No_Location
883 and then Sloc (N) > No_Location
885 -- We ignore references from within an instance, except for default
886 -- subprograms, for which we generate an implicit reference.
889 (Instantiation_Location (Sloc (N)) = No_Location or else Typ = 'i')
891 -- Ignore dummy references
895 if Nkind (N) = N_Identifier
897 Nkind (N) = N_Defining_Identifier
901 Nkind (N) = N_Defining_Operator_Symbol
903 Nkind (N) = N_Operator_Symbol
905 (Nkind (N) = N_Character_Literal
906 and then Sloc (Entity (N)) /= Standard_Location)
908 Nkind (N) = N_Defining_Character_Literal
912 elsif Nkind (N) = N_Expanded_Name
914 Nkind (N) = N_Selected_Component
916 Nod := Selector_Name (N);
922 -- Normal case of source entity comes from source
924 if Comes_From_Source (E) then
927 -- Entity does not come from source, but is a derived subprogram and
928 -- the derived subprogram comes from source (after one or more
929 -- derivations) in which case the reference is to parent subprogram.
931 elsif Is_Overloadable (E)
932 and then Present (Alias (E))
935 while not Comes_From_Source (Ent) loop
936 if No (Alias (Ent)) then
943 -- The internally created defining entity for a child subprogram
944 -- that has no previous spec has valid references.
946 elsif Is_Overloadable (E)
947 and then Is_Child_Unit (E)
951 -- Record components of discriminated subtypes or derived types must
952 -- be treated as references to the original component.
954 elsif Ekind (E) = E_Component
955 and then Comes_From_Source (Original_Record_Component (E))
957 Ent := Original_Record_Component (E);
959 -- If this is an expanded reference to a discriminant, recover the
960 -- original discriminant, which gets the reference.
962 elsif Ekind (E) = E_In_Parameter
963 and then Present (Discriminal_Link (E))
965 Ent := Discriminal_Link (E);
966 Set_Referenced (Ent);
968 -- Ignore reference to any other entity that is not from source
974 -- In Alfa mode, consider the underlying entity renamed instead of
975 -- the renaming, which is needed to compute a valid set of effects
976 -- (reads, writes) for the enclosing subprogram.
979 Ent := Get_Through_Renamings (Ent);
981 -- If no enclosing object, then it could be a reference to any
982 -- location not tracked individually, like heap-allocated data.
983 -- Conservatively approximate this possibility by generating a
984 -- dereference, and return.
987 if Actual_Typ = 'w' then
988 Alfa.Generate_Dereference (Nod, 'r');
989 Alfa.Generate_Dereference (Nod, 'w');
991 Alfa.Generate_Dereference (Nod, 'r');
998 -- Record reference to entity
1000 Ref := Original_Location (Sloc (Nod));
1001 Def := Original_Location (Sloc (Ent));
1004 and then Is_Subprogram (N)
1005 and then Present (Overridden_Operation (N))
1011 Ref_Scope := Alfa.Enclosing_Subprogram_Or_Package (N);
1012 Ent_Scope := Alfa.Enclosing_Subprogram_Or_Package (Ent);
1014 -- Since we are reaching through renamings in Alfa mode, we may
1015 -- end up with standard constants. Ignore those.
1017 if Sloc (Ent_Scope) <= Standard_Location
1018 or else Def <= Standard_Location
1023 Ent_Scope_File := Get_Source_Unit (Ent_Scope);
1027 Ent_Scope_File := No_Unit;
1034 Eun => Get_Source_Unit (Def),
1035 Lun => Get_Source_Unit (Ref),
1036 Ref_Scope => Ref_Scope,
1037 Ent_Scope => Ent_Scope),
1038 Ent_Scope_File => Ent_Scope_File);
1040 end Generate_Reference;
1042 -----------------------------------
1043 -- Generate_Reference_To_Formals --
1044 -----------------------------------
1046 procedure Generate_Reference_To_Formals (E : Entity_Id) is
1050 if Is_Generic_Subprogram (E) then
1051 Formal := First_Entity (E);
1053 while Present (Formal)
1054 and then not Is_Formal (Formal)
1056 Next_Entity (Formal);
1060 Formal := First_Formal (E);
1063 while Present (Formal) loop
1064 if Ekind (Formal) = E_In_Parameter then
1066 if Nkind (Parameter_Type (Parent (Formal)))
1067 = N_Access_Definition
1069 Generate_Reference (E, Formal, '^', False);
1071 Generate_Reference (E, Formal, '>', False);
1074 elsif Ekind (Formal) = E_In_Out_Parameter then
1075 Generate_Reference (E, Formal, '=', False);
1078 Generate_Reference (E, Formal, '<', False);
1081 Next_Formal (Formal);
1083 end Generate_Reference_To_Formals;
1085 -------------------------------------------
1086 -- Generate_Reference_To_Generic_Formals --
1087 -------------------------------------------
1089 procedure Generate_Reference_To_Generic_Formals (E : Entity_Id) is
1093 Formal := First_Entity (E);
1094 while Present (Formal) loop
1095 if Comes_From_Source (Formal) then
1096 Generate_Reference (E, Formal, 'z', False);
1099 Next_Entity (Formal);
1101 end Generate_Reference_To_Generic_Formals;
1107 function Get_Key (E : Xref_Entry_Number) return Xref_Entry_Number is
1116 function Hash (F : Xref_Entry_Number) return Header_Num is
1117 -- It is unlikely to have two references to the same entity at the same
1118 -- source location, so the hash function depends only on the Ent and Loc
1121 XE : Xref_Entry renames Xrefs.Table (F);
1122 type M is mod 2**32;
1124 H : constant M := M (XE.Key.Ent) + 2 ** 7 * M (abs XE.Key.Loc);
1125 -- It would be more natural to write:
1127 -- H : constant M := M'Mod (XE.Key.Ent) + 2**7 * M'Mod (XE.Key.Loc);
1129 -- But we can't use M'Mod, because it prevents bootstrapping with older
1130 -- compilers. Loc can be negative, so we do "abs" before converting.
1131 -- One day this can be cleaned up ???
1134 return Header_Num (H mod Num_Buckets);
1141 procedure HT_Set_Next (E : Xref_Entry_Number; Next : Xref_Entry_Number) is
1143 Xrefs.Table (E).HTable_Next := Next;
1150 function HT_Next (E : Xref_Entry_Number) return Xref_Entry_Number is
1152 return Xrefs.Table (E).HTable_Next;
1159 procedure Initialize is
1168 function Lt (T1, T2 : Xref_Entry) return Boolean is
1170 -- First test: if entity is in different unit, sort by unit
1172 if T1.Key.Eun /= T2.Key.Eun then
1173 return Dependency_Num (T1.Key.Eun) < Dependency_Num (T2.Key.Eun);
1175 -- Second test: within same unit, sort by entity Sloc
1177 elsif T1.Def /= T2.Def then
1178 return T1.Def < T2.Def;
1180 -- Third test: sort definitions ahead of references
1182 elsif T1.Key.Loc = No_Location then
1185 elsif T2.Key.Loc = No_Location then
1188 -- Fourth test: for same entity, sort by reference location unit
1190 elsif T1.Key.Lun /= T2.Key.Lun then
1191 return Dependency_Num (T1.Key.Lun) < Dependency_Num (T2.Key.Lun);
1193 -- Fifth test: order of location within referencing unit
1195 elsif T1.Key.Loc /= T2.Key.Loc then
1196 return T1.Key.Loc < T2.Key.Loc;
1198 -- Finally, for two locations at the same address, we prefer
1199 -- the one that does NOT have the type 'r' so that a modification
1200 -- or extension takes preference, when there are more than one
1201 -- reference at the same location. As a result, in the case of
1202 -- entities that are in-out actuals, the read reference follows
1203 -- the modify reference.
1206 return T2.Key.Typ = 'r';
1210 -----------------------
1211 -- Output_References --
1212 -----------------------
1214 procedure Output_References is
1216 procedure Get_Type_Reference
1218 Tref : out Entity_Id;
1219 Left : out Character;
1220 Right : out Character);
1221 -- Given an Entity_Id Ent, determines whether a type reference is
1222 -- required. If so, Tref is set to the entity for the type reference
1223 -- and Left and Right are set to the left/right brackets to be output
1224 -- for the reference. If no type reference is required, then Tref is
1225 -- set to Empty, and Left/Right are set to space.
1227 procedure Output_Import_Export_Info (Ent : Entity_Id);
1228 -- Output language and external name information for an interfaced
1229 -- entity, using the format <language, external_name>.
1231 ------------------------
1232 -- Get_Type_Reference --
1233 ------------------------
1235 procedure Get_Type_Reference
1237 Tref : out Entity_Id;
1238 Left : out Character;
1239 Right : out Character)
1244 -- See if we have a type reference
1253 -- Processing for types
1255 if Is_Type (Tref) then
1257 -- Case of base type
1259 if Base_Type (Tref) = Tref then
1261 -- If derived, then get first subtype
1263 if Tref /= Etype (Tref) then
1264 Tref := First_Subtype (Etype (Tref));
1266 -- Set brackets for derived type, but don't override
1267 -- pointer case since the fact that something is a
1268 -- pointer is more important.
1275 -- If non-derived ptr, get directly designated type.
1276 -- If the type has a full view, all references are on the
1277 -- partial view, that is seen first.
1279 elsif Is_Access_Type (Tref) then
1280 Tref := Directly_Designated_Type (Tref);
1284 elsif Is_Private_Type (Tref)
1285 and then Present (Full_View (Tref))
1287 if Is_Access_Type (Full_View (Tref)) then
1288 Tref := Directly_Designated_Type (Full_View (Tref));
1292 -- If the full view is an array type, we also retrieve
1293 -- the corresponding component type, because the ali
1294 -- entry already indicates that this is an array.
1296 elsif Is_Array_Type (Full_View (Tref)) then
1297 Tref := Component_Type (Full_View (Tref));
1302 -- If non-derived array, get component type. Skip component
1303 -- type for case of String or Wide_String, saves worthwhile
1306 elsif Is_Array_Type (Tref)
1307 and then Tref /= Standard_String
1308 and then Tref /= Standard_Wide_String
1310 Tref := Component_Type (Tref);
1314 -- For other non-derived base types, nothing
1320 -- For a subtype, go to ancestor subtype
1323 Tref := Ancestor_Subtype (Tref);
1325 -- If no ancestor subtype, go to base type
1328 Tref := Base_Type (Sav);
1332 -- For objects, functions, enum literals, just get type from
1335 elsif Is_Object (Tref)
1336 or else Ekind (Tref) = E_Enumeration_Literal
1337 or else Ekind (Tref) = E_Function
1338 or else Ekind (Tref) = E_Operator
1340 Tref := Etype (Tref);
1342 -- For anything else, exit
1348 -- Exit if no type reference, or we are stuck in some loop trying
1349 -- to find the type reference, or if the type is standard void
1350 -- type (the latter is an implementation artifact that should not
1351 -- show up in the generated cross-references).
1355 or else Tref = Standard_Void_Type;
1357 -- If we have a usable type reference, return, otherwise keep
1358 -- looking for something useful (we are looking for something
1359 -- that either comes from source or standard)
1361 if Sloc (Tref) = Standard_Location
1362 or else Comes_From_Source (Tref)
1364 -- If the reference is a subtype created for a generic actual,
1365 -- go actual directly, the inner subtype is not user visible.
1367 if Nkind (Parent (Tref)) = N_Subtype_Declaration
1368 and then not Comes_From_Source (Parent (Tref))
1370 (Is_Wrapper_Package (Scope (Tref))
1371 or else Is_Generic_Instance (Scope (Tref)))
1373 Tref := First_Subtype (Base_Type (Tref));
1380 -- If we fall through the loop, no type reference
1385 end Get_Type_Reference;
1387 -------------------------------
1388 -- Output_Import_Export_Info --
1389 -------------------------------
1391 procedure Output_Import_Export_Info (Ent : Entity_Id) is
1392 Language_Name : Name_Id;
1393 Conv : constant Convention_Id := Convention (Ent);
1396 -- Generate language name from convention
1398 if Conv = Convention_C then
1399 Language_Name := Name_C;
1401 elsif Conv = Convention_CPP then
1402 Language_Name := Name_CPP;
1404 elsif Conv = Convention_Ada then
1405 Language_Name := Name_Ada;
1408 -- For the moment we ignore all other cases ???
1413 Write_Info_Char ('<');
1414 Get_Unqualified_Name_String (Language_Name);
1416 for J in 1 .. Name_Len loop
1417 Write_Info_Char (Name_Buffer (J));
1420 if Present (Interface_Name (Ent)) then
1421 Write_Info_Char (',');
1422 String_To_Name_Buffer (Strval (Interface_Name (Ent)));
1424 for J in 1 .. Name_Len loop
1425 Write_Info_Char (Name_Buffer (J));
1429 Write_Info_Char ('>');
1430 end Output_Import_Export_Info;
1432 -- Start of processing for Output_References
1435 -- First we add references to the primitive operations of tagged types
1436 -- declared in the main unit.
1438 Handle_Prim_Ops : declare
1442 for J in 1 .. Xrefs.Last loop
1443 Ent := Xrefs.Table (J).Key.Ent;
1446 and then Is_Tagged_Type (Ent)
1447 and then Is_Base_Type (Ent)
1448 and then In_Extended_Main_Source_Unit (Ent)
1450 Generate_Prim_Op_References (Ent);
1453 end Handle_Prim_Ops;
1455 -- Before we go ahead and output the references we have a problem
1456 -- that needs dealing with. So far we have captured things that are
1457 -- definitely referenced by the main unit, or defined in the main
1458 -- unit. That's because we don't want to clutter up the ali file
1459 -- for this unit with definition lines for entities in other units
1460 -- that are not referenced.
1462 -- But there is a glitch. We may reference an entity in another unit,
1463 -- and it may have a type reference to an entity that is not directly
1464 -- referenced in the main unit, which may mean that there is no xref
1465 -- entry for this entity yet in the list of references.
1467 -- If we don't do something about this, we will end with an orphan type
1468 -- reference, i.e. it will point to an entity that does not appear
1469 -- within the generated references in the ali file. That is not good for
1470 -- tools using the xref information.
1472 -- To fix this, we go through the references adding definition entries
1473 -- for any unreferenced entities that can be referenced in a type
1474 -- reference. There is a recursion problem here, and that is dealt with
1475 -- by making sure that this traversal also traverses any entries that
1476 -- get added by the traversal.
1478 Handle_Orphan_Type_References : declare
1484 pragma Warnings (Off, L);
1485 pragma Warnings (Off, R);
1487 procedure New_Entry (E : Entity_Id);
1488 -- Make an additional entry into the Xref table for a type entity
1489 -- that is related to the current entity (parent, type ancestor,
1490 -- progenitor, etc.).
1496 procedure New_Entry (E : Entity_Id) is
1498 pragma Assert (Present (E));
1500 if not Has_Xref_Entry (Implementation_Base_Type (E))
1501 and then Sloc (E) > No_Location
1506 Typ => Character'First,
1507 Eun => Get_Source_Unit (Original_Location (Sloc (E))),
1510 Ent_Scope => Empty),
1511 Ent_Scope_File => No_Unit);
1515 -- Start of processing for Handle_Orphan_Type_References
1518 -- Note that this is not a for loop for a very good reason. The
1519 -- processing of items in the table can add new items to the table,
1520 -- and they must be processed as well.
1523 while J <= Xrefs.Last loop
1524 Ent := Xrefs.Table (J).Key.Ent;
1525 Get_Type_Reference (Ent, Tref, L, R);
1528 and then not Has_Xref_Entry (Tref)
1529 and then Sloc (Tref) > No_Location
1533 if Is_Record_Type (Ent)
1534 and then Present (Interfaces (Ent))
1536 -- Add an entry for each one of the given interfaces
1537 -- implemented by type Ent.
1540 Elmt : Elmt_Id := First_Elmt (Interfaces (Ent));
1542 while Present (Elmt) loop
1543 New_Entry (Node (Elmt));
1550 -- Collect inherited primitive operations that may be declared in
1551 -- another unit and have no visible reference in the current one.
1554 and then Is_Tagged_Type (Ent)
1555 and then Is_Derived_Type (Ent)
1556 and then Is_Base_Type (Ent)
1557 and then In_Extended_Main_Source_Unit (Ent)
1560 Op_List : constant Elist_Id := Primitive_Operations (Ent);
1564 function Parent_Op (E : Entity_Id) return Entity_Id;
1565 -- Find original operation, which may be inherited through
1566 -- several derivations.
1568 function Parent_Op (E : Entity_Id) return Entity_Id is
1569 Orig_Op : constant Entity_Id := Alias (E);
1572 if No (Orig_Op) then
1575 elsif not Comes_From_Source (E)
1576 and then not Has_Xref_Entry (Orig_Op)
1577 and then Comes_From_Source (Orig_Op)
1581 return Parent_Op (Orig_Op);
1586 Op := First_Elmt (Op_List);
1587 while Present (Op) loop
1588 Prim := Parent_Op (Node (Op));
1590 if Present (Prim) then
1594 Typ => Character'First,
1595 Eun => Get_Source_Unit (Sloc (Prim)),
1598 Ent_Scope => Empty),
1599 Ent_Scope_File => No_Unit);
1609 end Handle_Orphan_Type_References;
1611 -- Now we have all the references, including those for any embedded
1612 -- type references, so we can sort them, and output them.
1614 Output_Refs : declare
1616 Nrefs : constant Nat := Xrefs.Last;
1617 -- Number of references in table
1619 Rnums : array (0 .. Nrefs) of Nat;
1620 -- This array contains numbers of references in the Xrefs table.
1621 -- This list is sorted in output order. The extra 0'th entry is
1622 -- convenient for the call to sort. When we sort the table, we
1623 -- move the entries in Rnums around, but we do not move the
1624 -- original table entries.
1626 Curxu : Unit_Number_Type;
1627 -- Current xref unit
1629 Curru : Unit_Number_Type;
1630 -- Current reference unit for one entity
1635 Curnam : String (1 .. Name_Buffer'Length);
1637 -- Simple name and length of current entity
1639 Curdef : Source_Ptr;
1640 -- Original source location for current entity
1643 -- Current reference location
1646 -- Entity type character
1649 -- reference kind of previous reference
1655 -- Renaming reference
1657 Trunit : Unit_Number_Type;
1658 -- Unit number for type reference
1660 function Lt (Op1, Op2 : Natural) return Boolean;
1661 -- Comparison function for Sort call
1663 function Name_Change (X : Entity_Id) return Boolean;
1664 -- Determines if entity X has a different simple name from Curent
1666 procedure Move (From : Natural; To : Natural);
1667 -- Move procedure for Sort call
1669 package Sorting is new GNAT.Heap_Sort_G (Move, Lt);
1675 function Lt (Op1, Op2 : Natural) return Boolean is
1676 T1 : Xref_Entry renames Xrefs.Table (Rnums (Nat (Op1)));
1677 T2 : Xref_Entry renames Xrefs.Table (Rnums (Nat (Op2)));
1687 procedure Move (From : Natural; To : Natural) is
1689 Rnums (Nat (To)) := Rnums (Nat (From));
1696 -- Why a string comparison here??? Why not compare Name_Id values???
1698 function Name_Change (X : Entity_Id) return Boolean is
1700 Get_Unqualified_Name_String (Chars (X));
1702 if Name_Len /= Curlen then
1705 return Name_Buffer (1 .. Curlen) /= Curnam (1 .. Curlen);
1709 -- Start of processing for Output_Refs
1712 -- Capture the definition Sloc values. We delay doing this till now,
1713 -- since at the time the reference or definition is made, private
1714 -- types may be swapped, and the Sloc value may be incorrect. We
1715 -- also set up the pointer vector for the sort.
1717 for J in 1 .. Nrefs loop
1719 Xrefs.Table (J).Def :=
1720 Original_Location (Sloc (Xrefs.Table (J).Key.Ent));
1723 -- Sort the references
1725 Sorting.Sort (Integer (Nrefs));
1727 -- Initialize loop through references
1731 Curdef := No_Location;
1733 Crloc := No_Location;
1736 -- Loop to output references
1738 for Refno in 1 .. Nrefs loop
1739 Output_One_Ref : declare
1742 XE : Xref_Entry renames Xrefs.Table (Rnums (Refno));
1743 -- The current entry to be accessed
1747 -- Used for {} or <> or () for type reference
1749 procedure Check_Type_Reference
1751 List_Interface : Boolean);
1752 -- Find whether there is a meaningful type reference for
1753 -- Ent, and display it accordingly. If List_Interface is
1754 -- true, then Ent is a progenitor interface of the current
1755 -- type entity being listed. In that case list it as is,
1756 -- without looking for a type reference for it.
1758 procedure Output_Instantiation_Refs (Loc : Source_Ptr);
1759 -- Recursive procedure to output instantiation references for
1760 -- the given source ptr in [file|line[...]] form. No output
1761 -- if the given location is not a generic template reference.
1763 procedure Output_Overridden_Op (Old_E : Entity_Id);
1764 -- For a subprogram that is overriding, display information
1765 -- about the inherited operation that it overrides.
1767 --------------------------
1768 -- Check_Type_Reference --
1769 --------------------------
1771 procedure Check_Type_Reference
1773 List_Interface : Boolean)
1776 if List_Interface then
1778 -- This is a progenitor interface of the type for which
1779 -- xref information is being generated.
1786 Get_Type_Reference (Ent, Tref, Left, Right);
1789 if Present (Tref) then
1791 -- Case of standard entity, output name
1793 if Sloc (Tref) = Standard_Location then
1794 Write_Info_Char (Left);
1795 Write_Info_Name (Chars (Tref));
1796 Write_Info_Char (Right);
1798 -- Case of source entity, output location
1801 Write_Info_Char (Left);
1802 Trunit := Get_Source_Unit (Sloc (Tref));
1804 if Trunit /= Curxu then
1805 Write_Info_Nat (Dependency_Num (Trunit));
1806 Write_Info_Char ('|');
1810 (Int (Get_Logical_Line_Number (Sloc (Tref))));
1818 Ctyp := Xref_Entity_Letters (Ekind (Ent));
1821 and then Present (Full_View (Ent))
1823 Ent := Underlying_Type (Ent);
1825 if Present (Ent) then
1826 Ctyp := Xref_Entity_Letters (Ekind (Ent));
1830 Write_Info_Char (Ctyp);
1834 (Int (Get_Column_Number (Sloc (Tref))));
1836 -- If the type comes from an instantiation, add the
1837 -- corresponding info.
1839 Output_Instantiation_Refs (Sloc (Tref));
1840 Write_Info_Char (Right);
1843 end Check_Type_Reference;
1845 -------------------------------
1846 -- Output_Instantiation_Refs --
1847 -------------------------------
1849 procedure Output_Instantiation_Refs (Loc : Source_Ptr) is
1850 Iloc : constant Source_Ptr := Instantiation_Location (Loc);
1851 Lun : Unit_Number_Type;
1852 Cu : constant Unit_Number_Type := Curru;
1855 -- Nothing to do if this is not an instantiation
1857 if Iloc = No_Location then
1861 -- Output instantiation reference
1863 Write_Info_Char ('[');
1864 Lun := Get_Source_Unit (Iloc);
1866 if Lun /= Curru then
1868 Write_Info_Nat (Dependency_Num (Curru));
1869 Write_Info_Char ('|');
1872 Write_Info_Nat (Int (Get_Logical_Line_Number (Iloc)));
1874 -- Recursive call to get nested instantiations
1876 Output_Instantiation_Refs (Iloc);
1878 -- Output final ] after call to get proper nesting
1880 Write_Info_Char (']');
1883 end Output_Instantiation_Refs;
1885 --------------------------
1886 -- Output_Overridden_Op --
1887 --------------------------
1889 procedure Output_Overridden_Op (Old_E : Entity_Id) is
1893 -- The overridden operation has an implicit declaration
1894 -- at the point of derivation. What we want to display
1895 -- is the original operation, which has the actual body
1896 -- (or abstract declaration) that is being overridden.
1897 -- The overridden operation is not always set, e.g. when
1898 -- it is a predefined operator.
1903 -- Follow alias chain if one is present
1905 elsif Present (Alias (Old_E)) then
1907 -- The subprogram may have been implicitly inherited
1908 -- through several levels of derivation, so find the
1909 -- ultimate (source) ancestor.
1911 Op := Ultimate_Alias (Old_E);
1913 -- Normal case of no alias present
1920 and then Sloc (Op) /= Standard_Location
1923 Loc : constant Source_Ptr := Sloc (Op);
1924 Par_Unit : constant Unit_Number_Type :=
1925 Get_Source_Unit (Loc);
1928 Write_Info_Char ('<');
1930 if Par_Unit /= Curxu then
1931 Write_Info_Nat (Dependency_Num (Par_Unit));
1932 Write_Info_Char ('|');
1935 Write_Info_Nat (Int (Get_Logical_Line_Number (Loc)));
1936 Write_Info_Char ('p');
1937 Write_Info_Nat (Int (Get_Column_Number (Loc)));
1938 Write_Info_Char ('>');
1941 end Output_Overridden_Op;
1943 -- Start of processing for Output_One_Ref
1947 Ctyp := Xref_Entity_Letters (Ekind (Ent));
1949 -- Skip reference if it is the only reference to an entity,
1950 -- and it is an END line reference, and the entity is not in
1951 -- the current extended source. This prevents junk entries
1952 -- consisting only of packages with END lines, where no
1953 -- entity from the package is actually referenced.
1956 and then Ent /= Curent
1957 and then (Refno = Nrefs
1959 Ent /= Xrefs.Table (Rnums (Refno + 1)).Key.Ent)
1960 and then not In_Extended_Main_Source_Unit (Ent)
1965 -- For private type, get full view type
1968 and then Present (Full_View (XE.Key.Ent))
1970 Ent := Underlying_Type (Ent);
1972 if Present (Ent) then
1973 Ctyp := Xref_Entity_Letters (Ekind (Ent));
1977 -- Special exception for Boolean
1979 if Ctyp = 'E' and then Is_Boolean_Type (Ent) then
1983 -- For variable reference, get corresponding type
1986 Ent := Etype (XE.Key.Ent);
1987 Ctyp := Fold_Lower (Xref_Entity_Letters (Ekind (Ent)));
1989 -- If variable is private type, get full view type
1992 and then Present (Full_View (Etype (XE.Key.Ent)))
1994 Ent := Underlying_Type (Etype (XE.Key.Ent));
1996 if Present (Ent) then
1997 Ctyp := Fold_Lower (Xref_Entity_Letters (Ekind (Ent)));
2000 elsif Is_Generic_Type (Ent) then
2002 -- If the type of the entity is a generic private type,
2003 -- there is no usable full view, so retain the indication
2004 -- that this is an object.
2009 -- Special handling for access parameters and objects of
2010 -- an anonymous access type.
2012 if Ekind_In (Etype (XE.Key.Ent),
2013 E_Anonymous_Access_Type,
2014 E_Anonymous_Access_Subprogram_Type,
2015 E_Anonymous_Access_Protected_Subprogram_Type)
2017 if Is_Formal (XE.Key.Ent)
2018 or else Ekind_In (XE.Key.Ent, E_Variable, E_Constant)
2023 -- Special handling for Boolean
2025 elsif Ctyp = 'e' and then Is_Boolean_Type (Ent) then
2030 -- Special handling for abstract types and operations
2032 if Is_Overloadable (XE.Key.Ent)
2033 and then Is_Abstract_Subprogram (XE.Key.Ent)
2036 Ctyp := 'x'; -- Abstract procedure
2038 elsif Ctyp = 'V' then
2039 Ctyp := 'y'; -- Abstract function
2042 elsif Is_Type (XE.Key.Ent)
2043 and then Is_Abstract_Type (XE.Key.Ent)
2045 if Is_Interface (XE.Key.Ent) then
2048 elsif Ctyp = 'R' then
2049 Ctyp := 'H'; -- Abstract type
2053 -- Only output reference if interesting type of entity
2057 -- Suppress references to object definitions, used for local
2060 or else XE.Key.Typ = 'D'
2061 or else XE.Key.Typ = 'I'
2063 -- Suppress self references, except for bodies that act as
2066 or else (XE.Key.Loc = XE.Def
2069 or else not Is_Subprogram (XE.Key.Ent)))
2071 -- Also suppress definitions of body formals (we only
2072 -- treat these as references, and the references were
2073 -- separately recorded).
2075 or else (Is_Formal (XE.Key.Ent)
2076 and then Present (Spec_Entity (XE.Key.Ent)))
2081 -- Start new Xref section if new xref unit
2083 if XE.Key.Eun /= Curxu then
2084 if Write_Info_Col > 1 then
2088 Curxu := XE.Key.Eun;
2090 Write_Info_Initiate ('X');
2091 Write_Info_Char (' ');
2092 Write_Info_Nat (Dependency_Num (XE.Key.Eun));
2093 Write_Info_Char (' ');
2095 (Reference_Name (Source_Index (XE.Key.Eun)));
2098 -- Start new Entity line if new entity. Note that we
2099 -- consider two entities the same if they have the same
2100 -- name and source location. This causes entities in
2101 -- instantiations to be treated as though they referred
2106 (XE.Key.Ent /= Curent
2108 (Name_Change (XE.Key.Ent) or else XE.Def /= Curdef))
2110 Curent := XE.Key.Ent;
2113 Get_Unqualified_Name_String (Chars (XE.Key.Ent));
2115 Curnam (1 .. Curlen) := Name_Buffer (1 .. Curlen);
2117 if Write_Info_Col > 1 then
2121 -- Write column number information
2123 Write_Info_Nat (Int (Get_Logical_Line_Number (XE.Def)));
2124 Write_Info_Char (Ctyp);
2125 Write_Info_Nat (Int (Get_Column_Number (XE.Def)));
2127 -- Write level information
2129 Write_Level_Info : declare
2130 function Is_Visible_Generic_Entity
2131 (E : Entity_Id) return Boolean;
2132 -- Check whether E is declared in the visible part
2133 -- of a generic package. For source navigation
2134 -- purposes, treat this as a visible entity.
2136 function Is_Private_Record_Component
2137 (E : Entity_Id) return Boolean;
2138 -- Check whether E is a non-inherited component of a
2139 -- private extension. Even if the enclosing record is
2140 -- public, we want to treat the component as private
2141 -- for navigation purposes.
2143 ---------------------------------
2144 -- Is_Private_Record_Component --
2145 ---------------------------------
2147 function Is_Private_Record_Component
2148 (E : Entity_Id) return Boolean
2150 S : constant Entity_Id := Scope (E);
2153 Ekind (E) = E_Component
2154 and then Nkind (Declaration_Node (S)) =
2155 N_Private_Extension_Declaration
2156 and then Original_Record_Component (E) = E;
2157 end Is_Private_Record_Component;
2159 -------------------------------
2160 -- Is_Visible_Generic_Entity --
2161 -------------------------------
2163 function Is_Visible_Generic_Entity
2164 (E : Entity_Id) return Boolean
2169 -- The Present check here is an error defense
2171 if Present (Scope (E))
2172 and then Ekind (Scope (E)) /= E_Generic_Package
2178 while Present (Par) loop
2180 Nkind (Par) = N_Generic_Package_Declaration
2182 -- Entity is a generic formal
2187 Nkind (Parent (Par)) = N_Package_Specification
2190 Is_List_Member (Par)
2191 and then List_Containing (Par) =
2192 Visible_Declarations (Parent (Par));
2194 Par := Parent (Par);
2199 end Is_Visible_Generic_Entity;
2201 -- Start of processing for Write_Level_Info
2204 if Is_Hidden (Curent)
2205 or else Is_Private_Record_Component (Curent)
2207 Write_Info_Char (' ');
2211 or else Is_Visible_Generic_Entity (Curent)
2213 Write_Info_Char ('*');
2216 Write_Info_Char (' ');
2218 end Write_Level_Info;
2220 -- Output entity name. We use the occurrence from the
2221 -- actual source program at the definition point.
2224 Ent_Name : constant String :=
2225 Exact_Source_Name (Sloc (XE.Key.Ent));
2227 for C in Ent_Name'Range loop
2228 Write_Info_Char (Ent_Name (C));
2232 -- See if we have a renaming reference
2234 if Is_Object (XE.Key.Ent)
2235 and then Present (Renamed_Object (XE.Key.Ent))
2237 Rref := Renamed_Object (XE.Key.Ent);
2239 elsif Is_Overloadable (XE.Key.Ent)
2240 and then Nkind (Parent (Declaration_Node (XE.Key.Ent)))
2241 = N_Subprogram_Renaming_Declaration
2243 Rref := Name (Parent (Declaration_Node (XE.Key.Ent)));
2245 elsif Ekind (XE.Key.Ent) = E_Package
2246 and then Nkind (Declaration_Node (XE.Key.Ent)) =
2247 N_Package_Renaming_Declaration
2249 Rref := Name (Declaration_Node (XE.Key.Ent));
2255 if Present (Rref) then
2256 if Nkind (Rref) = N_Expanded_Name then
2257 Rref := Selector_Name (Rref);
2260 if Nkind (Rref) = N_Identifier
2261 or else Nkind (Rref) = N_Operator_Symbol
2265 -- For renamed array components, use the array name
2266 -- for the renamed entity, which reflect the fact that
2267 -- in general the whole array is aliased.
2269 elsif Nkind (Rref) = N_Indexed_Component then
2270 if Nkind (Prefix (Rref)) = N_Identifier then
2271 Rref := Prefix (Rref);
2272 elsif Nkind (Prefix (Rref)) = N_Expanded_Name then
2273 Rref := Selector_Name (Prefix (Rref));
2283 -- Write out renaming reference if we have one
2285 if Present (Rref) then
2286 Write_Info_Char ('=');
2288 (Int (Get_Logical_Line_Number (Sloc (Rref))));
2289 Write_Info_Char (':');
2291 (Int (Get_Column_Number (Sloc (Rref))));
2294 -- Indicate that the entity is in the unit of the current
2299 -- Write out information about generic parent, if entity
2302 if Is_Generic_Instance (XE.Key.Ent) then
2304 Gen_Par : constant Entity_Id :=
2307 (Unit_Declaration_Node
2309 Loc : constant Source_Ptr := Sloc (Gen_Par);
2310 Gen_U : constant Unit_Number_Type :=
2311 Get_Source_Unit (Loc);
2314 Write_Info_Char ('[');
2316 if Curru /= Gen_U then
2317 Write_Info_Nat (Dependency_Num (Gen_U));
2318 Write_Info_Char ('|');
2322 (Int (Get_Logical_Line_Number (Loc)));
2323 Write_Info_Char (']');
2327 -- See if we have a type reference and if so output
2329 Check_Type_Reference (XE.Key.Ent, False);
2331 -- Additional information for types with progenitors
2333 if Is_Record_Type (XE.Key.Ent)
2334 and then Present (Interfaces (XE.Key.Ent))
2338 First_Elmt (Interfaces (XE.Key.Ent));
2340 while Present (Elmt) loop
2341 Check_Type_Reference (Node (Elmt), True);
2346 -- For array types, list index types as well. (This is
2347 -- not C, indexes have distinct types).
2349 elsif Is_Array_Type (XE.Key.Ent) then
2353 Indx := First_Index (XE.Key.Ent);
2354 while Present (Indx) loop
2355 Check_Type_Reference
2356 (First_Subtype (Etype (Indx)), True);
2362 -- If the entity is an overriding operation, write info
2363 -- on operation that was overridden.
2365 if Is_Subprogram (XE.Key.Ent)
2366 and then Present (Overridden_Operation (XE.Key.Ent))
2368 Output_Overridden_Op
2369 (Overridden_Operation (XE.Key.Ent));
2372 -- End of processing for entity output
2374 Crloc := No_Location;
2377 -- Output the reference if it is not as the same location
2378 -- as the previous one, or it is a read-reference that
2379 -- indicates that the entity is an in-out actual in a call.
2381 if XE.Key.Loc /= No_Location
2383 (XE.Key.Loc /= Crloc
2384 or else (Prevt = 'm' and then XE.Key.Typ = 'r'))
2386 Crloc := XE.Key.Loc;
2387 Prevt := XE.Key.Typ;
2389 -- Start continuation if line full, else blank
2391 if Write_Info_Col > 72 then
2393 Write_Info_Initiate ('.');
2396 Write_Info_Char (' ');
2398 -- Output file number if changed
2400 if XE.Key.Lun /= Curru then
2401 Curru := XE.Key.Lun;
2402 Write_Info_Nat (Dependency_Num (Curru));
2403 Write_Info_Char ('|');
2407 (Int (Get_Logical_Line_Number (XE.Key.Loc)));
2408 Write_Info_Char (XE.Key.Typ);
2410 if Is_Overloadable (XE.Key.Ent)
2411 and then Is_Imported (XE.Key.Ent)
2412 and then XE.Key.Typ = 'b'
2414 Output_Import_Export_Info (XE.Key.Ent);
2417 Write_Info_Nat (Int (Get_Column_Number (XE.Key.Loc)));
2419 Output_Instantiation_Refs (Sloc (XE.Key.Ent));
2430 end Output_References;
2433 -- Reset is necessary because Elmt_Ptr does not default to Null_Ptr,
2434 -- because it's not an access type.