-- --
-- B o d y --
-- --
--- Copyright (C) 1998-2006, Free Software Foundation, Inc. --
+-- Copyright (C) 1998-2011, Free Software Foundation, Inc. --
-- --
-- GNAT is free software; you can redistribute it and/or modify it under --
-- terms of the GNU General Public License as published by the Free Soft- --
--- ware Foundation; either version 2, or (at your option) any later ver- --
+-- ware Foundation; either version 3, or (at your option) any later ver- --
-- sion. GNAT is distributed in the hope that it will be useful, but WITH- --
-- OUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY --
-- or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License --
-- for more details. You should have received a copy of the GNU General --
--- Public License distributed with GNAT; see file COPYING. If not, write --
--- to the Free Software Foundation, 51 Franklin Street, Fifth Floor, --
--- Boston, MA 02110-1301, USA. --
+-- Public License distributed with GNAT; see file COPYING3. If not, go to --
+-- http://www.gnu.org/licenses for a complete copy of the license. --
-- --
-- GNAT was originally developed by the GNAT team at New York University. --
-- Extensive contributions were provided by Ada Core Technologies Inc. --
with Csets; use Csets;
with Elists; use Elists;
with Errout; use Errout;
-with Lib.Util; use Lib.Util;
-with Namet; use Namet;
with Nlists; use Nlists;
with Opt; use Opt;
with Restrict; use Restrict;
with Rident; use Rident;
with Sem; use Sem;
+with Sem_Aux; use Sem_Aux;
with Sem_Prag; use Sem_Prag;
with Sem_Util; use Sem_Util;
+with Sem_Warn; use Sem_Warn;
with Sinfo; use Sinfo;
with Sinput; use Sinput;
with Snames; use Snames;
with Stringt; use Stringt;
with Stand; use Stand;
with Table; use Table;
-with Widechar; use Widechar;
-with GNAT.Heap_Sort_A;
+with GNAT.Heap_Sort_G;
+with GNAT.HTable;
package body Lib.Xref is
subtype Xref_Entry_Number is Int;
- type Xref_Entry is record
+ type Xref_Key is record
+ -- These are the components of Xref_Entry that participate in hash
+ -- lookups.
+
Ent : Entity_Id;
-- Entity referenced (E parameter to Generate_Reference)
- Def : Source_Ptr;
- -- Original source location for entity being referenced. Note that
- -- these values are used only during the output process, they are
- -- not set when the entries are originally built. This is because
- -- private entities can be swapped when the initial call is made.
-
Loc : Source_Ptr;
-- Location of reference (Original_Location (Sloc field of N parameter
-- to Generate_Reference). Set to No_Location for the case of a
-- Unit number corresponding to Loc. Value is undefined and not
-- referenced if Loc is set to No_Location.
+ -- The following components are only used for Alfa cross-references
+
+ Ref_Scope : Entity_Id;
+ -- Entity of the closest subprogram or package enclosing the reference
+
+ Ent_Scope : Entity_Id;
+ -- Entity of the closest subprogram or package enclosing the definition,
+ -- which should be located in the same file as the definition itself.
+ end record;
+
+ type Xref_Entry is record
+ Key : Xref_Key;
+
+ Ent_Scope_File : Unit_Number_Type;
+ -- File for entity Ent_Scope
+
+ Def : Source_Ptr;
+ -- Original source location for entity being referenced. Note that these
+ -- values are used only during the output process, they are not set when
+ -- the entries are originally built. This is because private entities
+ -- can be swapped when the initial call is made.
+
+ HTable_Next : Xref_Entry_Number;
+ -- For use only by Static_HTable
end record;
package Xrefs is new Table.Table (
Table_Increment => Alloc.Xrefs_Increment,
Table_Name => "Xrefs");
+ --------------
+ -- Xref_Set --
+ --------------
+
+ -- We keep a set of xref entries, in order to avoid inserting duplicate
+ -- entries into the above Xrefs table. An entry is in Xref_Set if and only
+ -- if it is in Xrefs.
+
+ Num_Buckets : constant := 2**16;
+
+ subtype Header_Num is Integer range 0 .. Num_Buckets - 1;
+ type Null_Type is null record;
+ pragma Unreferenced (Null_Type);
+
+ function Hash (F : Xref_Entry_Number) return Header_Num;
+
+ function Equal (F1, F2 : Xref_Entry_Number) return Boolean;
+
+ procedure HT_Set_Next (E : Xref_Entry_Number; Next : Xref_Entry_Number);
+
+ function HT_Next (E : Xref_Entry_Number) return Xref_Entry_Number;
+
+ function Get_Key (E : Xref_Entry_Number) return Xref_Entry_Number;
+
+ pragma Inline (Hash, Equal, HT_Set_Next, HT_Next, Get_Key);
+
+ package Xref_Set is new GNAT.HTable.Static_HTable (
+ Header_Num,
+ Element => Xref_Entry,
+ Elmt_Ptr => Xref_Entry_Number,
+ Null_Ptr => 0,
+ Set_Next => HT_Set_Next,
+ Next => HT_Next,
+ Key => Xref_Entry_Number,
+ Get_Key => Get_Key,
+ Hash => Hash,
+ Equal => Equal);
+
+ ----------------------
+ -- Alfa Information --
+ ----------------------
+
+ package body Alfa is separate;
+
+ ------------------------
+ -- Local Subprograms --
+ ------------------------
+
+ procedure Generate_Prim_Op_References (Typ : Entity_Id);
+ -- For a tagged type, generate implicit references to its primitive
+ -- operations, for source navigation. This is done right before emitting
+ -- cross-reference information rather than at the freeze point of the type
+ -- in order to handle late bodies that are primitive operations.
+
+ function Lt (T1, T2 : Xref_Entry) return Boolean;
+ -- Order cross-references
+
+ procedure Add_Entry (Key : Xref_Key; Ent_Scope_File : Unit_Number_Type);
+ -- Add an entry to the tables of Xref_Entries, avoiding duplicates
+
+ ---------------
+ -- Add_Entry --
+ ---------------
+
+ procedure Add_Entry (Key : Xref_Key; Ent_Scope_File : Unit_Number_Type) is
+ begin
+ Xrefs.Increment_Last; -- tentative
+ Xrefs.Table (Xrefs.Last).Key := Key;
+
+ -- Set the entry in Xref_Set, and if newly set, keep the above
+ -- tentative increment.
+
+ if Xref_Set.Set_If_Not_Present (Xrefs.Last) then
+ Xrefs.Table (Xrefs.Last).Ent_Scope_File := Ent_Scope_File;
+ -- Leave Def and HTable_Next uninitialized
+
+ Set_Has_Xref_Entry (Key.Ent);
+
+ -- It was already in Xref_Set, so throw away the tentatively-added
+ -- entry
+
+ else
+ Xrefs.Decrement_Last;
+ end if;
+ end Add_Entry;
+
+ -----------
+ -- Equal --
+ -----------
+
+ function Equal (F1, F2 : Xref_Entry_Number) return Boolean is
+ Result : constant Boolean :=
+ Xrefs.Table (F1).Key = Xrefs.Table (F2).Key;
+ begin
+ return Result;
+ end Equal;
+
-------------------------
-- Generate_Definition --
-------------------------
procedure Generate_Definition (E : Entity_Id) is
- Loc : Source_Ptr;
- Indx : Nat;
-
begin
pragma Assert (Nkind (E) in N_Entity);
- -- Note that we do not test Xref_Entity_Letters here. It is too
- -- early to do so, since we are often called before the entity
- -- is fully constructed, so that the Ekind is still E_Void.
+ -- Note that we do not test Xref_Entity_Letters here. It is too early
+ -- to do so, since we are often called before the entity is fully
+ -- constructed, so that the Ekind is still E_Void.
if Opt.Xref_Active
-- Definition must come from source
- -- We make an exception for subprogram child units that have no
- -- spec. For these we generate a subprogram declaration for library
- -- use, and the corresponding entity does not come from source.
+
+ -- We make an exception for subprogram child units that have no spec.
+ -- For these we generate a subprogram declaration for library use,
+ -- and the corresponding entity does not come from source.
-- Nevertheless, all references will be attached to it and we have
-- to treat is as coming from user code.
and then In_Extended_Main_Source_Unit (E)
and then not Is_Internal_Name (Chars (E))
then
- Xrefs.Increment_Last;
- Indx := Xrefs.Last;
- Loc := Original_Location (Sloc (E));
-
- Xrefs.Table (Indx).Ent := E;
- Xrefs.Table (Indx).Loc := No_Location;
- Xrefs.Table (Indx).Eun := Get_Source_Unit (Loc);
- Xrefs.Table (Indx).Lun := No_Unit;
- Set_Has_Xref_Entry (E);
+ Add_Entry
+ ((Ent => E,
+ Loc => No_Location,
+ Typ => ' ',
+ Eun => Get_Source_Unit (Original_Location (Sloc (E))),
+ Lun => No_Unit,
+ Ref_Scope => Empty,
+ Ent_Scope => Empty),
+ Ent_Scope_File => No_Unit);
if In_Inlined_Body then
Set_Referenced (E);
return;
end if;
- -- If the operator is not a Standard operator, then we generate
- -- a real reference to the user defined operator.
+ -- If the operator is not a Standard operator, then we generate a real
+ -- reference to the user defined operator.
if Sloc (Entity (N)) /= Standard_Location then
Generate_Reference (Entity (N), N);
- -- A reference to an implicit inequality operator is a also a
- -- reference to the user-defined equality.
+ -- A reference to an implicit inequality operator is also a reference
+ -- to the user-defined equality.
if Nkind (N) = N_Op_Ne
and then not Comes_From_Source (Entity (N))
Generate_Reference (Corresponding_Equality (Entity (N)), N);
end if;
- -- For the case of Standard operators, we mark the result type
- -- as referenced. This ensures that in the case where we are
- -- using a derived operator, we mark an entity of the unit that
- -- implicitly defines this operator as used. Otherwise we may
- -- think that no entity of the unit is used. The actual entity
- -- marked as referenced is the first subtype, which is the user
- -- defined entity that is relevant.
+ -- For the case of Standard operators, we mark the result type as
+ -- referenced. This ensures that in the case where we are using a
+ -- derived operator, we mark an entity of the unit that implicitly
+ -- defines this operator as used. Otherwise we may think that no entity
+ -- of the unit is used. The actual entity marked as referenced is the
+ -- first subtype, which is the relevant user defined entity.
- -- Note: we only do this for operators that come from source.
- -- The generated code sometimes reaches for entities that do
- -- not need to be explicitly visible (for example, when we
- -- expand the code for comparing two record types, the fields
- -- of the record may not be visible).
+ -- Note: we only do this for operators that come from source. The
+ -- generated code sometimes reaches for entities that do not need to be
+ -- explicitly visible (for example, when we expand the code for
+ -- comparing two record objects, the fields of the record may not be
+ -- visible).
elsif Comes_From_Source (N) then
Set_Referenced (First_Subtype (T));
end if;
end Generate_Operator_Reference;
+ ---------------------------------
+ -- Generate_Prim_Op_References --
+ ---------------------------------
+
+ procedure Generate_Prim_Op_References (Typ : Entity_Id) is
+ Base_T : Entity_Id;
+ Prim : Elmt_Id;
+ Prim_List : Elist_Id;
+
+ begin
+ -- Handle subtypes of synchronized types
+
+ if Ekind (Typ) = E_Protected_Subtype
+ or else Ekind (Typ) = E_Task_Subtype
+ then
+ Base_T := Etype (Typ);
+ else
+ Base_T := Typ;
+ end if;
+
+ -- References to primitive operations are only relevant for tagged types
+
+ if not Is_Tagged_Type (Base_T)
+ or else Is_Class_Wide_Type (Base_T)
+ then
+ return;
+ end if;
+
+ -- Ada 2005 (AI-345): For synchronized types generate reference to the
+ -- wrapper that allow us to dispatch calls through their implemented
+ -- abstract interface types.
+
+ -- The check for Present here is to protect against previously reported
+ -- critical errors.
+
+ Prim_List := Primitive_Operations (Base_T);
+
+ if No (Prim_List) then
+ return;
+ end if;
+
+ Prim := First_Elmt (Prim_List);
+ while Present (Prim) loop
+
+ -- If the operation is derived, get the original for cross-reference
+ -- reference purposes (it is the original for which we want the xref
+ -- and for which the comes_from_source test must be performed).
+
+ Generate_Reference
+ (Typ, Ultimate_Alias (Node (Prim)), 'p', Set_Ref => False);
+ Next_Elmt (Prim);
+ end loop;
+ end Generate_Prim_Op_References;
+
------------------------
-- Generate_Reference --
------------------------
Set_Ref : Boolean := True;
Force : Boolean := False)
is
- Indx : Nat;
- Nod : Node_Id;
- Ref : Source_Ptr;
- Def : Source_Ptr;
- Ent : Entity_Id;
+ Nod : Node_Id;
+ Ref : Source_Ptr;
+ Def : Source_Ptr;
+ Ent : Entity_Id;
+
+ Actual_Typ : Character := Typ;
+
+ Ref_Scope : Entity_Id;
+ Ent_Scope : Entity_Id;
+ Ent_Scope_File : Unit_Number_Type;
+
+ Call : Node_Id;
+ Formal : Entity_Id;
+ -- Used for call to Find_Actual
+
+ Kind : Entity_Kind;
+ -- If Formal is non-Empty, then its Ekind, otherwise E_Void
+
+ function Get_Through_Renamings (E : Entity_Id) return Entity_Id;
+ -- Get the enclosing entity through renamings, which may come from
+ -- source or from the translation of generic instantiations.
function Is_On_LHS (Node : Node_Id) return Boolean;
- -- Used to check if a node is on the left hand side of an
- -- assignment. The following cases are handled:
+ -- Used to check if a node is on the left hand side of an assignment.
+ -- The following cases are handled:
+ --
+ -- Variable Node is a direct descendant of left hand side of an
+ -- assignment statement.
--
- -- Variable Node is a direct descendant of an assignment
- -- statement.
+ -- Prefix Of an indexed or selected component that is present in
+ -- a subtree rooted by an assignment statement. There is
+ -- no restriction of nesting of components, thus cases
+ -- such as A.B (C).D are handled properly. However a prefix
+ -- of a dereference (either implicit or explicit) is never
+ -- considered as on a LHS.
--
- -- Prefix Of an indexed or selected component that is
- -- present in a subtree rooted by an assignment
- -- statement. There is no restriction of nesting
- -- of components, thus cases such as A.B(C).D are
- -- handled properly.
+ -- Out param Same as above cases, but OUT parameter
+
+ function OK_To_Set_Referenced return Boolean;
+ -- Returns True if the Referenced flag can be set. There are a few
+ -- exceptions where we do not want to set this flag, see body for
+ -- details of these exceptional cases.
+
+ ---------------------------
+ -- Get_Through_Renamings --
+ ---------------------------
+
+ function Get_Through_Renamings (E : Entity_Id) return Entity_Id is
+ Result : Entity_Id := E;
+ begin
+ while Present (Result)
+ and then Is_Object (Result)
+ and then Present (Renamed_Object (Result))
+ loop
+ Result := Get_Enclosing_Object (Renamed_Object (Result));
+ end loop;
+ return Result;
+ end Get_Through_Renamings;
---------------
-- Is_On_LHS --
---------------
- -- Couldn't we use Is_Lvalue or whatever it is called ???
+ -- ??? There are several routines here and there that perform a similar
+ -- (but subtly different) computation, which should be factored:
+
+ -- Sem_Util.May_Be_Lvalue
+ -- Sem_Util.Known_To_Be_Assigned
+ -- Exp_Ch2.Expand_Entry_Parameter.In_Assignment_Context
+ -- Exp_Smem.Is_Out_Actual
function Is_On_LHS (Node : Node_Id) return Boolean is
- N : Node_Id := Node;
+ N : Node_Id;
+ P : Node_Id;
+ K : Node_Kind;
begin
-- Only identifiers are considered, is this necessary???
- if Nkind (N) /= N_Identifier then
+ if Nkind (Node) /= N_Identifier then
return False;
end if;
- -- Reach the assignment statement subtree root. In the
- -- case of a variable being a direct descendant of an
- -- assignment statement, the loop is skiped.
+ -- Immediate return if appeared as OUT parameter
- while Nkind (Parent (N)) /= N_Assignment_Statement loop
+ if Kind = E_Out_Parameter then
+ return True;
+ end if;
- -- Check whether the parent is a component and the
- -- current node is its prefix.
+ -- Search for assignment statement subtree root
- if (Nkind (Parent (N)) = N_Selected_Component
- or else
- Nkind (Parent (N)) = N_Indexed_Component)
- and then Prefix (Parent (N)) = N
+ N := Node;
+ loop
+ P := Parent (N);
+ K := Nkind (P);
+
+ if K = N_Assignment_Statement then
+ return Name (P) = N;
+
+ -- Check whether the parent is a component and the current node is
+ -- its prefix, but return False if the current node has an access
+ -- type, as in that case the selected or indexed component is an
+ -- implicit dereference, and the LHS is the designated object, not
+ -- the access object.
+
+ -- ??? case of a slice assignment?
+
+ -- ??? Note that in some cases this is called too early
+ -- (see comments in Sem_Ch8.Find_Direct_Name), at a point where
+ -- the tree is not fully typed yet. In that case we may lack
+ -- an Etype for N, and we must disable the check for an implicit
+ -- dereference. If the dereference is on an LHS, this causes a
+ -- false positive.
+
+ elsif (K = N_Selected_Component or else K = N_Indexed_Component)
+ and then Prefix (P) = N
+ and then not (Present (Etype (N))
+ and then
+ Is_Access_Type (Etype (N)))
then
- N := Parent (N);
+ N := P;
+
+ -- All other cases, definitely not on left side
+
else
return False;
end if;
end loop;
+ end Is_On_LHS;
- -- Parent (N) is assignment statement, check whether N is its name
+ ---------------------------
+ -- OK_To_Set_Referenced --
+ ---------------------------
- return Name (Parent (N)) = N;
- end Is_On_LHS;
+ function OK_To_Set_Referenced return Boolean is
+ P : Node_Id;
+
+ begin
+ -- A reference from a pragma Unreferenced or pragma Unmodified or
+ -- pragma Warnings does not cause the Referenced flag to be set.
+ -- This avoids silly warnings about things being referenced and
+ -- not assigned when the only reference is from the pragma.
+
+ if Nkind (N) = N_Identifier then
+ P := Parent (N);
+
+ if Nkind (P) = N_Pragma_Argument_Association then
+ P := Parent (P);
+
+ if Nkind (P) = N_Pragma then
+ if Pragma_Name (P) = Name_Warnings
+ or else
+ Pragma_Name (P) = Name_Unmodified
+ or else
+ Pragma_Name (P) = Name_Unreferenced
+ then
+ return False;
+ end if;
+ end if;
+
+ -- A reference to a formal in a named parameter association does
+ -- not make the formal referenced. Formals that are unused in the
+ -- subprogram body are properly flagged as such, even if calls
+ -- elsewhere use named notation.
+
+ elsif Nkind (P) = N_Parameter_Association
+ and then N = Selector_Name (P)
+ then
+ return False;
+ end if;
+ end if;
+
+ return True;
+ end OK_To_Set_Referenced;
-- Start of processing for Generate_Reference
begin
pragma Assert (Nkind (E) in N_Entity);
+ Find_Actual (N, Formal, Call);
+
+ if Present (Formal) then
+ Kind := Ekind (Formal);
+ else
+ Kind := E_Void;
+ end if;
- -- Check for obsolescent reference to ASCII
+ -- Check for obsolescent reference to package ASCII. GNAT treats this
+ -- element of annex J specially since in practice, programs make a lot
+ -- of use of this feature, so we don't include it in the set of features
+ -- diagnosed when Warn_On_Obsolescent_Features mode is set. However we
+ -- are required to note it as a violation of the RM defined restriction.
if E = Standard_ASCII then
Check_Restriction (No_Obsolescent_Features, N);
end if;
+ -- Check for reference to entity marked with Is_Obsolescent
+
+ -- Note that we always allow obsolescent references in the compiler
+ -- itself and the run time, since we assume that we know what we are
+ -- doing in such cases. For example the calls in Ada.Characters.Handling
+ -- to its own obsolescent subprograms are just fine.
+
+ -- In any case we do not generate warnings within the extended source
+ -- unit of the entity in question, since we assume the source unit
+ -- itself knows what is going on (and for sure we do not want silly
+ -- warnings, e.g. on the end line of an obsolescent procedure body).
+
+ if Is_Obsolescent (E)
+ and then not GNAT_Mode
+ and then not In_Extended_Main_Source_Unit (E)
+ then
+ Check_Restriction (No_Obsolescent_Features, N);
+
+ if Warn_On_Obsolescent_Feature then
+ Output_Obsolescent_Entity_Warnings (N, E);
+ end if;
+ end if;
+
-- Warn if reference to Ada 2005 entity not in Ada 2005 mode. We only
-- detect real explicit references (modifications and references).
- if Is_Ada_2005 (E)
- and then Ada_Version < Ada_05
+ if Comes_From_Source (N)
+ and then Is_Ada_2005_Only (E)
+ and then Ada_Version < Ada_2005
and then Warn_On_Ada_2005_Compatibility
- and then (Typ = 'm' or else Typ = 'r')
+ and then (Typ = 'm' or else Typ = 'r' or else Typ = 's')
then
Error_Msg_NE ("& is only defined in Ada 2005?", N, E);
end if;
+ -- Warn if reference to Ada 2012 entity not in Ada 2012 mode. We only
+ -- detect real explicit references (modifications and references).
+
+ if Comes_From_Source (N)
+ and then Is_Ada_2012_Only (E)
+ and then Ada_Version < Ada_2012
+ and then Warn_On_Ada_2012_Compatibility
+ and then (Typ = 'm' or else Typ = 'r')
+ then
+ Error_Msg_NE ("& is only defined in Ada 2012?", N, E);
+ end if;
+
-- Never collect references if not in main source unit. However, we omit
-- this test if Typ is 'e' or 'k', since these entries are structural,
-- and it is useful to have them in units that reference packages as
-- case of 'p' since we want to include inherited primitive operations
-- from other packages.
- if not In_Extended_Main_Source_Unit (N)
- and then Typ /= 'e'
- and then Typ /= 'p'
- and then Typ /= 'k'
- then
- return;
+ -- We also omit this test is this is a body reference for a subprogram
+ -- instantiation. In this case the reference is to the generic body,
+ -- which clearly need not be in the main unit containing the instance.
+ -- For the same reason we accept an implicit reference generated for
+ -- a default in an instance.
+
+ if not In_Extended_Main_Source_Unit (N) then
+ if Typ = 'e'
+ or else Typ = 'I'
+ or else Typ = 'p'
+ or else Typ = 'i'
+ or else Typ = 'k'
+ or else (Typ = 'b' and then Is_Generic_Instance (E))
+ then
+ null;
+ else
+ return;
+ end if;
end if;
-- For reference type p, the entity must be in main source unit
return;
end if;
- -- Unless the reference is forced, we ignore references where
- -- the reference itself does not come from Source.
+ -- Unless the reference is forced, we ignore references where the
+ -- reference itself does not come from source.
if not Force and then not Comes_From_Source (N) then
return;
end if;
- -- Deal with setting entity as referenced, unless suppressed.
- -- Note that we still do Set_Referenced on entities that do not
- -- come from source. This situation arises when we have a source
- -- reference to a derived operation, where the derived operation
- -- itself does not come from source, but we still want to mark it
- -- as referenced, since we really are referencing an entity in the
- -- corresponding package (this avoids incorrect complaints that the
- -- package contains no referenced entities).
+ -- Deal with setting entity as referenced, unless suppressed. Note that
+ -- we still do Set_Referenced on entities that do not come from source.
+ -- This situation arises when we have a source reference to a derived
+ -- operation, where the derived operation itself does not come from
+ -- source, but we still want to mark it as referenced, since we really
+ -- are referencing an entity in the corresponding package (this avoids
+ -- wrong complaints that the package contains no referenced entities).
if Set_Ref then
- -- For a variable that appears on the left side of an
- -- assignment statement, we set the Referenced_As_LHS
- -- flag since this is indeed a left hand side.
- -- We also set the Referenced_As_LHS flag of a prefix
- -- of selected or indexed component.
+ -- Assignable object appearing on left side of assignment or as
+ -- an out parameter.
- if Ekind (E) = E_Variable
+ if Is_Assignable (E)
and then Is_On_LHS (N)
+ and then Ekind (E) /= E_In_Out_Parameter
then
- Set_Referenced_As_LHS (E);
+ -- For objects that are renamings, just set as simply referenced
+ -- we do not try to do assignment type tracking in this case.
+
+ if Present (Renamed_Object (E)) then
+ Set_Referenced (E);
+
+ -- Out parameter case
+
+ elsif Kind = E_Out_Parameter then
+
+ -- If warning mode for all out parameters is set, or this is
+ -- the only warning parameter, then we want to mark this for
+ -- later warning logic by setting Referenced_As_Out_Parameter
+
+ if Warn_On_Modified_As_Out_Parameter (Formal) then
+ Set_Referenced_As_Out_Parameter (E, True);
+ Set_Referenced_As_LHS (E, False);
+
+ -- For OUT parameter not covered by the above cases, we simply
+ -- regard it as a normal reference (in this case we do not
+ -- want any of the warning machinery for out parameters).
+
+ else
+ Set_Referenced (E);
+ end if;
+
+ -- For the left hand of an assignment case, we do nothing here.
+ -- The processing for Analyze_Assignment_Statement will set the
+ -- Referenced_As_LHS flag.
+
+ else
+ null;
+ end if;
-- Check for a reference in a pragma that should not count as a
-- making the variable referenced for warning purposes.
elsif Is_Non_Significant_Pragma_Reference (N) then
null;
- -- A reference in an attribute definition clause does not
- -- count as a reference except for the case of Address.
- -- The reason that 'Address is an exception is that it
- -- creates an alias through which the variable may be
- -- referenced.
+ -- A reference in an attribute definition clause does not count as a
+ -- reference except for the case of Address. The reason that 'Address
+ -- is an exception is that it creates an alias through which the
+ -- variable may be referenced.
elsif Nkind (Parent (N)) = N_Attribute_Definition_Clause
and then Chars (Parent (N)) /= Name_Address
then
null;
- -- Any other occurrence counts as referencing the entity
+ -- All other cases
else
- Set_Referenced (E);
+ -- Special processing for IN OUT parameters, where we have an
+ -- implicit assignment to a simple variable.
+
+ if Kind = E_In_Out_Parameter
+ and then Is_Assignable (E)
+ then
+ -- For sure this counts as a normal read reference
+
+ Set_Referenced (E);
+ Set_Last_Assignment (E, Empty);
+
+ -- We count it as being referenced as an out parameter if the
+ -- option is set to warn on all out parameters, except that we
+ -- have a special exclusion for an intrinsic subprogram, which
+ -- is most likely an instantiation of Unchecked_Deallocation
+ -- which we do not want to consider as an assignment since it
+ -- generates false positives. We also exclude the case of an
+ -- IN OUT parameter if the name of the procedure is Free,
+ -- since we suspect similar semantics.
+
+ if Warn_On_All_Unread_Out_Parameters
+ and then Is_Entity_Name (Name (Call))
+ and then not Is_Intrinsic_Subprogram (Entity (Name (Call)))
+ and then Chars (Name (Call)) /= Name_Free
+ then
+ Set_Referenced_As_Out_Parameter (E, True);
+ Set_Referenced_As_LHS (E, False);
+ end if;
+
+ -- Don't count a recursive reference within a subprogram as a
+ -- reference (that allows detection of a recursive subprogram
+ -- whose only references are recursive calls as unreferenced).
+
+ elsif Is_Subprogram (E)
+ and then E = Nearest_Dynamic_Scope (Current_Scope)
+ then
+ null;
+
+ -- Any other occurrence counts as referencing the entity
+
+ elsif OK_To_Set_Referenced then
+ Set_Referenced (E);
+
+ -- If variable, this is an OK reference after an assignment
+ -- so we can clear the Last_Assignment indication.
+
+ if Is_Assignable (E) then
+ Set_Last_Assignment (E, Empty);
+ end if;
+ end if;
end if;
-- Check for pragma Unreferenced given and reference is within
- -- this source unit (occasion for possible warning to be issued)
+ -- this source unit (occasion for possible warning to be issued).
- if Has_Pragma_Unreferenced (E)
+ if Has_Unreferenced (E)
and then In_Same_Extended_Unit (E, N)
then
-- A reference as a named parameter in a call does not count
- -- as a violation of pragma Unreferenced for this purpose.
+ -- as a violation of pragma Unreferenced for this purpose...
if Nkind (N) = N_Identifier
and then Nkind (Parent (N)) = N_Parameter_Association
then
null;
- -- Neither does a reference to a variable on the left side
+ -- ... Neither does a reference to a variable on the left side
-- of an assignment.
elsif Is_On_LHS (N) then
null;
- -- For entry formals, we want to place the warning on the
- -- corresponding entity in the accept statement. The current
- -- scope is the body of the accept, so we find the formal
- -- whose name matches that of the entry formal (there is no
- -- link between the two entities, and the one in the accept
- -- statement is only used for conformance checking).
+ -- For entry formals, we want to place the warning message on the
+ -- corresponding entity in the accept statement. The current scope
+ -- is the body of the accept, so we find the formal whose name
+ -- matches that of the entry formal (there is no link between the
+ -- two entities, and the one in the accept statement is only used
+ -- for conformance checking).
elsif Ekind (Scope (E)) = E_Entry then
declare
BE := First_Entity (Current_Scope);
while Present (BE) loop
if Chars (BE) = Chars (E) then
- Error_Msg_NE
- ("?pragma Unreferenced given for&", N, BE);
+ Error_Msg_NE -- CODEFIX
+ ("?pragma Unreferenced given for&!", N, BE);
exit;
end if;
-- Here we issue the warning, since this is a real reference
else
- Error_Msg_NE ("?pragma Unreferenced given for&", N, E);
+ Error_Msg_NE -- CODEFIX
+ ("?pragma Unreferenced given for&!", N, E);
end if;
end if;
and then Sloc (E) > No_Location
and then Sloc (N) > No_Location
- -- We ignore references from within an instance
+ -- We ignore references from within an instance, except for default
+ -- subprograms, for which we generate an implicit reference.
- and then Instantiation_Location (Sloc (N)) = No_Location
+ and then
+ (Instantiation_Location (Sloc (N)) = No_Location or else Typ = 'i')
-- Ignore dummy references
if Comes_From_Source (E) then
Ent := E;
- -- Entity does not come from source, but is a derived subprogram
- -- and the derived subprogram comes from source (after one or more
+ -- Entity does not come from source, but is a derived subprogram and
+ -- the derived subprogram comes from source (after one or more
-- derivations) in which case the reference is to parent subprogram.
elsif Is_Overloadable (E)
and then Present (Alias (E))
then
Ent := Alias (E);
-
- loop
- if Comes_From_Source (Ent) then
- exit;
- elsif No (Alias (Ent)) then
+ while not Comes_From_Source (Ent) loop
+ if No (Alias (Ent)) then
return;
- else
- Ent := Alias (Ent);
end if;
+
+ Ent := Alias (Ent);
end loop;
-- The internally created defining entity for a child subprogram
then
Ent := E;
- -- Record components of discriminated subtypes or derived types
- -- must be treated as references to the original component.
+ -- Record components of discriminated subtypes or derived types must
+ -- be treated as references to the original component.
elsif Ekind (E) = E_Component
and then Comes_From_Source (Original_Record_Component (E))
then
Ent := Original_Record_Component (E);
+ -- If this is an expanded reference to a discriminant, recover the
+ -- original discriminant, which gets the reference.
+
+ elsif Ekind (E) = E_In_Parameter
+ and then Present (Discriminal_Link (E))
+ then
+ Ent := Discriminal_Link (E);
+ Set_Referenced (Ent);
+
-- Ignore reference to any other entity that is not from source
else
return;
end if;
+ -- In Alfa mode, consider the underlying entity renamed instead of
+ -- the renaming, which is needed to compute a valid set of effects
+ -- (reads, writes) for the enclosing subprogram.
+
+ if Alfa_Mode then
+ Ent := Get_Through_Renamings (Ent);
+
+ -- If no enclosing object, then it could be a reference to any
+ -- location not tracked individually, like heap-allocated data.
+ -- Conservatively approximate this possibility by generating a
+ -- dereference, and return.
+
+ if No (Ent) then
+ if Actual_Typ = 'w' then
+ Alfa.Generate_Dereference (Nod, 'r');
+ Alfa.Generate_Dereference (Nod, 'w');
+ else
+ Alfa.Generate_Dereference (Nod, 'r');
+ end if;
+
+ return;
+ end if;
+ end if;
+
-- Record reference to entity
Ref := Original_Location (Sloc (Nod));
Def := Original_Location (Sloc (Ent));
- Xrefs.Increment_Last;
- Indx := Xrefs.Last;
+ if Actual_Typ = 'p'
+ and then Is_Subprogram (N)
+ and then Present (Overridden_Operation (N))
+ then
+ Actual_Typ := 'P';
+ end if;
- Xrefs.Table (Indx).Loc := Ref;
+ if Alfa_Mode then
+ Ref_Scope := Alfa.Enclosing_Subprogram_Or_Package (N);
+ Ent_Scope := Alfa.Enclosing_Subprogram_Or_Package (Ent);
- -- Overriding operations are marked with 'P'
+ -- Since we are reaching through renamings in Alfa mode, we may
+ -- end up with standard constants. Ignore those.
- if Typ = 'p'
- and then Is_Subprogram (N)
- and then Is_Overriding_Operation (N)
- then
- Xrefs.Table (Indx).Typ := 'P';
+ if Sloc (Ent_Scope) <= Standard_Location
+ or else Def <= Standard_Location
+ then
+ return;
+ end if;
+
+ Ent_Scope_File := Get_Source_Unit (Ent_Scope);
else
- Xrefs.Table (Indx).Typ := Typ;
+ Ref_Scope := Empty;
+ Ent_Scope := Empty;
+ Ent_Scope_File := No_Unit;
end if;
- Xrefs.Table (Indx).Eun := Get_Source_Unit (Def);
- Xrefs.Table (Indx).Lun := Get_Source_Unit (Ref);
- Xrefs.Table (Indx).Ent := Ent;
- Set_Has_Xref_Entry (Ent);
+ Add_Entry
+ ((Ent => Ent,
+ Loc => Ref,
+ Typ => Actual_Typ,
+ Eun => Get_Source_Unit (Def),
+ Lun => Get_Source_Unit (Ref),
+ Ref_Scope => Ref_Scope,
+ Ent_Scope => Ent_Scope),
+ Ent_Scope_File => Ent_Scope_File);
end if;
end Generate_Reference;
begin
Formal := First_Entity (E);
-
while Present (Formal) loop
if Comes_From_Source (Formal) then
Generate_Reference (E, Formal, 'z', False);
end loop;
end Generate_Reference_To_Generic_Formals;
+ -------------
+ -- Get_Key --
+ -------------
+
+ function Get_Key (E : Xref_Entry_Number) return Xref_Entry_Number is
+ begin
+ return E;
+ end Get_Key;
+
+ ----------
+ -- Hash --
+ ----------
+
+ function Hash (F : Xref_Entry_Number) return Header_Num is
+ -- It is unlikely to have two references to the same entity at the same
+ -- source location, so the hash function depends only on the Ent and Loc
+ -- fields.
+
+ XE : Xref_Entry renames Xrefs.Table (F);
+ type M is mod 2**32;
+
+ H : constant M := M (XE.Key.Ent) + 2 ** 7 * M (abs XE.Key.Loc);
+ -- It would be more natural to write:
+ --
+ -- H : constant M := M'Mod (XE.Key.Ent) + 2**7 * M'Mod (XE.Key.Loc);
+ --
+ -- But we can't use M'Mod, because it prevents bootstrapping with older
+ -- compilers. Loc can be negative, so we do "abs" before converting.
+ -- One day this can be cleaned up ???
+
+ begin
+ return Header_Num (H mod Num_Buckets);
+ end Hash;
+
+ -----------------
+ -- HT_Set_Next --
+ -----------------
+
+ procedure HT_Set_Next (E : Xref_Entry_Number; Next : Xref_Entry_Number) is
+ begin
+ Xrefs.Table (E).HTable_Next := Next;
+ end HT_Set_Next;
+
+ -------------
+ -- HT_Next --
+ -------------
+
+ function HT_Next (E : Xref_Entry_Number) return Xref_Entry_Number is
+ begin
+ return Xrefs.Table (E).HTable_Next;
+ end HT_Next;
+
----------------
-- Initialize --
----------------
Xrefs.Init;
end Initialize;
+ --------
+ -- Lt --
+ --------
+
+ function Lt (T1, T2 : Xref_Entry) return Boolean is
+ begin
+ -- First test: if entity is in different unit, sort by unit
+
+ if T1.Key.Eun /= T2.Key.Eun then
+ return Dependency_Num (T1.Key.Eun) < Dependency_Num (T2.Key.Eun);
+
+ -- Second test: within same unit, sort by entity Sloc
+
+ elsif T1.Def /= T2.Def then
+ return T1.Def < T2.Def;
+
+ -- Third test: sort definitions ahead of references
+
+ elsif T1.Key.Loc = No_Location then
+ return True;
+
+ elsif T2.Key.Loc = No_Location then
+ return False;
+
+ -- Fourth test: for same entity, sort by reference location unit
+
+ elsif T1.Key.Lun /= T2.Key.Lun then
+ return Dependency_Num (T1.Key.Lun) < Dependency_Num (T2.Key.Lun);
+
+ -- Fifth test: order of location within referencing unit
+
+ elsif T1.Key.Loc /= T2.Key.Loc then
+ return T1.Key.Loc < T2.Key.Loc;
+
+ -- Finally, for two locations at the same address, we prefer
+ -- the one that does NOT have the type 'r' so that a modification
+ -- or extension takes preference, when there are more than one
+ -- reference at the same location. As a result, in the case of
+ -- entities that are in-out actuals, the read reference follows
+ -- the modify reference.
+
+ else
+ return T2.Key.Typ = 'r';
+ end if;
+ end Lt;
+
-----------------------
-- Output_References --
-----------------------
Tref : out Entity_Id;
Left : out Character;
Right : out Character);
- -- Given an entity id Ent, determines whether a type reference is
+ -- Given an Entity_Id Ent, determines whether a type reference is
-- required. If so, Tref is set to the entity for the type reference
- -- and Left and Right are set to the left/right brackets to be
- -- output for the reference. If no type reference is required, then
- -- Tref is set to Empty, and Left/Right are set to space.
+ -- and Left and Right are set to the left/right brackets to be output
+ -- for the reference. If no type reference is required, then Tref is
+ -- set to Empty, and Left/Right are set to space.
procedure Output_Import_Export_Info (Ent : Entity_Id);
- -- Ouput language and external name information for an interfaced
- -- entity, using the format <language, external_name>,
+ -- Output language and external name information for an interfaced
+ -- entity, using the format <language, external_name>.
------------------------
-- Get_Type_Reference --
if Tref /= Etype (Tref) then
Tref := First_Subtype (Etype (Tref));
- -- Set brackets for derived type, but don't
- -- override pointer case since the fact that
- -- something is a pointer is more important
+ -- Set brackets for derived type, but don't override
+ -- pointer case since the fact that something is a
+ -- pointer is more important.
if Left /= '(' then
Left := '<';
end if;
-- If non-derived ptr, get directly designated type.
- -- If the type has a full view, all references are
- -- on the partial view, that is seen first.
+ -- If the type has a full view, all references are on the
+ -- partial view, that is seen first.
elsif Is_Access_Type (Tref) then
Tref := Directly_Designated_Type (Tref);
Right := ')';
end if;
- -- If non-derived array, get component type.
- -- Skip component type for case of String
- -- or Wide_String, saves worthwhile space.
+ -- If non-derived array, get component type. Skip component
+ -- type for case of String or Wide_String, saves worthwhile
+ -- space.
elsif Is_Array_Type (Tref)
and then Tref /= Standard_String
end if;
end if;
- -- For objects, functions, enum literals,
- -- just get type from Etype field.
+ -- For objects, functions, enum literals, just get type from
+ -- Etype field.
elsif Is_Object (Tref)
or else Ekind (Tref) = E_Enumeration_Literal
exit;
end if;
- -- Exit if no type reference, or we are stuck in
- -- some loop trying to find the type reference, or
- -- if the type is standard void type (the latter is
- -- an implementation artifact that should not show
- -- up in the generated cross-references).
+ -- Exit if no type reference, or we are stuck in some loop trying
+ -- to find the type reference, or if the type is standard void
+ -- type (the latter is an implementation artifact that should not
+ -- show up in the generated cross-references).
exit when No (Tref)
or else Tref = Sav
or else Tref = Standard_Void_Type;
- -- If we have a usable type reference, return, otherwise
- -- keep looking for something useful (we are looking for
- -- something that either comes from source or standard)
+ -- If we have a usable type reference, return, otherwise keep
+ -- looking for something useful (we are looking for something
+ -- that either comes from source or standard)
if Sloc (Tref) = Standard_Location
or else Comes_From_Source (Tref)
then
- -- If the reference is a subtype created for a generic
- -- actual, go to actual directly, the inner subtype is
- -- not user visible.
+ -- If the reference is a subtype created for a generic actual,
+ -- go actual directly, the inner subtype is not user visible.
if Nkind (Parent (Tref)) = N_Subtype_Declaration
and then not Comes_From_Source (Parent (Tref))
procedure Output_Import_Export_Info (Ent : Entity_Id) is
Language_Name : Name_Id;
Conv : constant Convention_Id := Convention (Ent);
+
begin
+ -- Generate language name from convention
+
if Conv = Convention_C then
Language_Name := Name_C;
Language_Name := Name_Ada;
else
- -- These are the only languages that GPS knows about
+ -- For the moment we ignore all other cases ???
return;
end if;
-- Start of processing for Output_References
begin
- if not Opt.Xref_Active then
- return;
- end if;
+ -- First we add references to the primitive operations of tagged types
+ -- declared in the main unit.
+
+ Handle_Prim_Ops : declare
+ Ent : Entity_Id;
+
+ begin
+ for J in 1 .. Xrefs.Last loop
+ Ent := Xrefs.Table (J).Key.Ent;
+
+ if Is_Type (Ent)
+ and then Is_Tagged_Type (Ent)
+ and then Is_Base_Type (Ent)
+ and then In_Extended_Main_Source_Unit (Ent)
+ then
+ Generate_Prim_Op_References (Ent);
+ end if;
+ end loop;
+ end Handle_Prim_Ops;
-- Before we go ahead and output the references we have a problem
-- that needs dealing with. So far we have captured things that are
-- referenced in the main unit, which may mean that there is no xref
-- entry for this entity yet in the list of references.
- -- If we don't do something about this, we will end with an orphan
- -- type reference, i.e. it will point to an entity that does not
- -- appear within the generated references in the ali file. That is
- -- not good for tools using the xref information.
+ -- If we don't do something about this, we will end with an orphan type
+ -- reference, i.e. it will point to an entity that does not appear
+ -- within the generated references in the ali file. That is not good for
+ -- tools using the xref information.
- -- To fix this, we go through the references adding definition
- -- entries for any unreferenced entities that can be referenced
- -- in a type reference. There is a recursion problem here, and
- -- that is dealt with by making sure that this traversal also
- -- traverses any entries that get added by the traversal.
+ -- To fix this, we go through the references adding definition entries
+ -- for any unreferenced entities that can be referenced in a type
+ -- reference. There is a recursion problem here, and that is dealt with
+ -- by making sure that this traversal also traverses any entries that
+ -- get added by the traversal.
- declare
+ Handle_Orphan_Type_References : declare
J : Nat;
Tref : Entity_Id;
- L, R : Character;
- Indx : Nat;
Ent : Entity_Id;
- Loc : Source_Ptr;
+
+ L, R : Character;
+ pragma Warnings (Off, L);
+ pragma Warnings (Off, R);
+
+ procedure New_Entry (E : Entity_Id);
+ -- Make an additional entry into the Xref table for a type entity
+ -- that is related to the current entity (parent, type ancestor,
+ -- progenitor, etc.).
+
+ ----------------
+ -- New_Entry --
+ ----------------
+
+ procedure New_Entry (E : Entity_Id) is
+ begin
+ pragma Assert (Present (E));
+
+ if not Has_Xref_Entry (Implementation_Base_Type (E))
+ and then Sloc (E) > No_Location
+ then
+ Add_Entry
+ ((Ent => E,
+ Loc => No_Location,
+ Typ => Character'First,
+ Eun => Get_Source_Unit (Original_Location (Sloc (E))),
+ Lun => No_Unit,
+ Ref_Scope => Empty,
+ Ent_Scope => Empty),
+ Ent_Scope_File => No_Unit);
+ end if;
+ end New_Entry;
+
+ -- Start of processing for Handle_Orphan_Type_References
begin
-- Note that this is not a for loop for a very good reason. The
- -- processing of items in the table can add new items to the
- -- table, and they must be processed as well
+ -- processing of items in the table can add new items to the table,
+ -- and they must be processed as well.
J := 1;
while J <= Xrefs.Last loop
- Ent := Xrefs.Table (J).Ent;
+ Ent := Xrefs.Table (J).Key.Ent;
Get_Type_Reference (Ent, Tref, L, R);
if Present (Tref)
and then not Has_Xref_Entry (Tref)
and then Sloc (Tref) > No_Location
then
- Xrefs.Increment_Last;
- Indx := Xrefs.Last;
- Loc := Original_Location (Sloc (Tref));
- Xrefs.Table (Indx).Ent := Tref;
- Xrefs.Table (Indx).Loc := No_Location;
- Xrefs.Table (Indx).Eun := Get_Source_Unit (Loc);
- Xrefs.Table (Indx).Lun := No_Unit;
- Set_Has_Xref_Entry (Tref);
+ New_Entry (Tref);
+
+ if Is_Record_Type (Ent)
+ and then Present (Interfaces (Ent))
+ then
+ -- Add an entry for each one of the given interfaces
+ -- implemented by type Ent.
+
+ declare
+ Elmt : Elmt_Id := First_Elmt (Interfaces (Ent));
+ begin
+ while Present (Elmt) loop
+ New_Entry (Node (Elmt));
+ Next_Elmt (Elmt);
+ end loop;
+ end;
+ end if;
end if;
- -- Collect inherited primitive operations that may be
- -- declared in another unit and have no visible reference
- -- in the current one.
+ -- Collect inherited primitive operations that may be declared in
+ -- another unit and have no visible reference in the current one.
if Is_Type (Ent)
and then Is_Tagged_Type (Ent)
and then Is_Derived_Type (Ent)
- and then Ent = Base_Type (Ent)
+ and then Is_Base_Type (Ent)
and then In_Extended_Main_Source_Unit (Ent)
then
declare
Prim : Entity_Id;
function Parent_Op (E : Entity_Id) return Entity_Id;
- -- Find original operation, which may be inherited
- -- through several derivations.
+ -- Find original operation, which may be inherited through
+ -- several derivations.
function Parent_Op (E : Entity_Id) return Entity_Id is
Orig_Op : constant Entity_Id := Alias (E);
+
begin
if No (Orig_Op) then
return Empty;
+
elsif not Comes_From_Source (E)
and then not Has_Xref_Entry (Orig_Op)
and then Comes_From_Source (Orig_Op)
Prim := Parent_Op (Node (Op));
if Present (Prim) then
- Xrefs.Increment_Last;
- Indx := Xrefs.Last;
- Loc := Original_Location (Sloc (Prim));
- Xrefs.Table (Indx).Ent := Prim;
- Xrefs.Table (Indx).Loc := No_Location;
- Xrefs.Table (Indx).Eun :=
- Get_Source_Unit (Sloc (Prim));
- Xrefs.Table (Indx).Lun := No_Unit;
- Set_Has_Xref_Entry (Prim);
+ Add_Entry
+ ((Ent => Prim,
+ Loc => No_Location,
+ Typ => Character'First,
+ Eun => Get_Source_Unit (Sloc (Prim)),
+ Lun => No_Unit,
+ Ref_Scope => Empty,
+ Ent_Scope => Empty),
+ Ent_Scope_File => No_Unit);
end if;
Next_Elmt (Op);
J := J + 1;
end loop;
- end;
+ end Handle_Orphan_Type_References;
-- Now we have all the references, including those for any embedded
-- type references, so we can sort them, and output them.
Output_Refs : declare
- Nrefs : Nat := Xrefs.Last;
- -- Number of references in table. This value may get reset
- -- (reduced) when we eliminate duplicate reference entries.
+ Nrefs : constant Nat := Xrefs.Last;
+ -- Number of references in table
Rnums : array (0 .. Nrefs) of Nat;
-- This array contains numbers of references in the Xrefs table.
Curru : Unit_Number_Type;
-- Current reference unit for one entity
- Cursrc : Source_Buffer_Ptr;
- -- Current xref unit source text
-
Curent : Entity_Id;
-- Current entity
Ctyp : Character;
-- Entity type character
+ Prevt : Character;
+ -- reference kind of previous reference
+
Tref : Entity_Id;
-- Type reference
procedure Move (From : Natural; To : Natural);
-- Move procedure for Sort call
+ package Sorting is new GNAT.Heap_Sort_G (Move, Lt);
+
--------
-- Lt --
--------
T2 : Xref_Entry renames Xrefs.Table (Rnums (Nat (Op2)));
begin
- -- First test. If entity is in different unit, sort by unit
-
- if T1.Eun /= T2.Eun then
- return Dependency_Num (T1.Eun) < Dependency_Num (T2.Eun);
-
- -- Second test, within same unit, sort by entity Sloc
-
- elsif T1.Def /= T2.Def then
- return T1.Def < T2.Def;
-
- -- Third test, sort definitions ahead of references
-
- elsif T1.Loc = No_Location then
- return True;
-
- elsif T2.Loc = No_Location then
- return False;
-
- -- Fourth test, for same entity, sort by reference location unit
-
- elsif T1.Lun /= T2.Lun then
- return Dependency_Num (T1.Lun) < Dependency_Num (T2.Lun);
-
- -- Fifth test order of location within referencing unit
-
- elsif T1.Loc /= T2.Loc then
- return T1.Loc < T2.Loc;
-
- -- Finally, for two locations at the same address, we prefer
- -- the one that does NOT have the type 'r' so that a modification
- -- or extension takes preference, when there are more than one
- -- reference at the same location.
-
- else
- return T2.Typ = 'r';
- end if;
+ return Lt (T1, T2);
end Lt;
----------
-- Name_Change --
-----------------
+ -- Why a string comparison here??? Why not compare Name_Id values???
+
function Name_Change (X : Entity_Id) return Boolean is
begin
Get_Unqualified_Name_String (Chars (X));
if Name_Len /= Curlen then
return True;
-
else
return Name_Buffer (1 .. Curlen) /= Curnam (1 .. Curlen);
end if;
for J in 1 .. Nrefs loop
Rnums (J) := J;
Xrefs.Table (J).Def :=
- Original_Location (Sloc (Xrefs.Table (J).Ent));
+ Original_Location (Sloc (Xrefs.Table (J).Key.Ent));
end loop;
-- Sort the references
- GNAT.Heap_Sort_A.Sort
- (Integer (Nrefs),
- Move'Unrestricted_Access,
- Lt'Unrestricted_Access);
-
- -- Eliminate duplicate entries
-
- declare
- NR : constant Nat := Nrefs;
-
- begin
- -- We need this test for NR because if we force ALI file
- -- generation in case of errors detected, it may be the case
- -- that Nrefs is 0, so we should not reset it here
-
- if NR >= 2 then
- Nrefs := 1;
-
- for J in 2 .. NR loop
- if Xrefs.Table (Rnums (J)) /=
- Xrefs.Table (Rnums (Nrefs))
- then
- Nrefs := Nrefs + 1;
- Rnums (Nrefs) := Rnums (J);
- end if;
- end loop;
- end if;
- end;
+ Sorting.Sort (Integer (Nrefs));
-- Initialize loop through references
Curdef := No_Location;
Curru := No_Unit;
Crloc := No_Location;
+ Prevt := 'm';
-- Loop to output references
for Refno in 1 .. Nrefs loop
Output_One_Ref : declare
- P2 : Source_Ptr;
- WC : Char_Code;
- Err : Boolean;
Ent : Entity_Id;
XE : Xref_Entry renames Xrefs.Table (Rnums (Refno));
-- The current entry to be accessed
- P : Source_Ptr;
- -- Used to index into source buffer to get entity name
-
Left : Character;
Right : Character;
-- Used for {} or <> or () for type reference
+ procedure Check_Type_Reference
+ (Ent : Entity_Id;
+ List_Interface : Boolean);
+ -- Find whether there is a meaningful type reference for
+ -- Ent, and display it accordingly. If List_Interface is
+ -- true, then Ent is a progenitor interface of the current
+ -- type entity being listed. In that case list it as is,
+ -- without looking for a type reference for it.
+
procedure Output_Instantiation_Refs (Loc : Source_Ptr);
-- Recursive procedure to output instantiation references for
-- the given source ptr in [file|line[...]] form. No output
-- For a subprogram that is overriding, display information
-- about the inherited operation that it overrides.
+ --------------------------
+ -- Check_Type_Reference --
+ --------------------------
+
+ procedure Check_Type_Reference
+ (Ent : Entity_Id;
+ List_Interface : Boolean)
+ is
+ begin
+ if List_Interface then
+
+ -- This is a progenitor interface of the type for which
+ -- xref information is being generated.
+
+ Tref := Ent;
+ Left := '<';
+ Right := '>';
+
+ else
+ Get_Type_Reference (Ent, Tref, Left, Right);
+ end if;
+
+ if Present (Tref) then
+
+ -- Case of standard entity, output name
+
+ if Sloc (Tref) = Standard_Location then
+ Write_Info_Char (Left);
+ Write_Info_Name (Chars (Tref));
+ Write_Info_Char (Right);
+
+ -- Case of source entity, output location
+
+ else
+ Write_Info_Char (Left);
+ Trunit := Get_Source_Unit (Sloc (Tref));
+
+ if Trunit /= Curxu then
+ Write_Info_Nat (Dependency_Num (Trunit));
+ Write_Info_Char ('|');
+ end if;
+
+ Write_Info_Nat
+ (Int (Get_Logical_Line_Number (Sloc (Tref))));
+
+ declare
+ Ent : Entity_Id;
+ Ctyp : Character;
+
+ begin
+ Ent := Tref;
+ Ctyp := Xref_Entity_Letters (Ekind (Ent));
+
+ if Ctyp = '+'
+ and then Present (Full_View (Ent))
+ then
+ Ent := Underlying_Type (Ent);
+
+ if Present (Ent) then
+ Ctyp := Xref_Entity_Letters (Ekind (Ent));
+ end if;
+ end if;
+
+ Write_Info_Char (Ctyp);
+ end;
+
+ Write_Info_Nat
+ (Int (Get_Column_Number (Sloc (Tref))));
+
+ -- If the type comes from an instantiation, add the
+ -- corresponding info.
+
+ Output_Instantiation_Refs (Sloc (Tref));
+ Write_Info_Char (Right);
+ end if;
+ end if;
+ end Check_Type_Reference;
+
-------------------------------
-- Output_Instantiation_Refs --
-------------------------------
--------------------------
procedure Output_Overridden_Op (Old_E : Entity_Id) is
+ Op : Entity_Id;
+
begin
- if Present (Old_E)
- and then Sloc (Old_E) /= Standard_Location
+ -- The overridden operation has an implicit declaration
+ -- at the point of derivation. What we want to display
+ -- is the original operation, which has the actual body
+ -- (or abstract declaration) that is being overridden.
+ -- The overridden operation is not always set, e.g. when
+ -- it is a predefined operator.
+
+ if No (Old_E) then
+ return;
+
+ -- Follow alias chain if one is present
+
+ elsif Present (Alias (Old_E)) then
+
+ -- The subprogram may have been implicitly inherited
+ -- through several levels of derivation, so find the
+ -- ultimate (source) ancestor.
+
+ Op := Ultimate_Alias (Old_E);
+
+ -- Normal case of no alias present. We omit generated
+ -- primitives like tagged equality, that have no source
+ -- representation.
+
+ else
+ Op := Old_E;
+ end if;
+
+ if Present (Op)
+ and then Sloc (Op) /= Standard_Location
+ and then Comes_From_Source (Op)
then
declare
- Loc : constant Source_Ptr := Sloc (Old_E);
+ Loc : constant Source_Ptr := Sloc (Op);
Par_Unit : constant Unit_Number_Type :=
Get_Source_Unit (Loc);
+
begin
Write_Info_Char ('<');
-- Start of processing for Output_One_Ref
begin
- Ent := XE.Ent;
+ Ent := XE.Key.Ent;
Ctyp := Xref_Entity_Letters (Ekind (Ent));
-- Skip reference if it is the only reference to an entity,
- -- and it is an end-line reference, and the entity is not in
+ -- and it is an END line reference, and the entity is not in
-- the current extended source. This prevents junk entries
- -- consisting only of packages with end lines, where no
+ -- consisting only of packages with END lines, where no
-- entity from the package is actually referenced.
- if XE.Typ = 'e'
+ if XE.Key.Typ = 'e'
and then Ent /= Curent
- and then (Refno = Nrefs or else
- Ent /= Xrefs.Table (Rnums (Refno + 1)).Ent)
- and then
- not In_Extended_Main_Source_Unit (Ent)
+ and then (Refno = Nrefs
+ or else
+ Ent /= Xrefs.Table (Rnums (Refno + 1)).Key.Ent)
+ and then not In_Extended_Main_Source_Unit (Ent)
then
goto Continue;
end if;
-- For private type, get full view type
if Ctyp = '+'
- and then Present (Full_View (XE.Ent))
+ and then Present (Full_View (XE.Key.Ent))
then
Ent := Underlying_Type (Ent);
-- For variable reference, get corresponding type
if Ctyp = '*' then
- Ent := Etype (XE.Ent);
+ Ent := Etype (XE.Key.Ent);
Ctyp := Fold_Lower (Xref_Entity_Letters (Ekind (Ent)));
-- If variable is private type, get full view type
if Ctyp = '+'
- and then Present (Full_View (Etype (XE.Ent)))
+ and then Present (Full_View (Etype (XE.Key.Ent)))
then
- Ent := Underlying_Type (Etype (XE.Ent));
+ Ent := Underlying_Type (Etype (XE.Key.Ent));
if Present (Ent) then
Ctyp := Fold_Lower (Xref_Entity_Letters (Ekind (Ent)));
elsif Is_Generic_Type (Ent) then
- -- If the type of the entity is a generic private type
+ -- If the type of the entity is a generic private type,
-- there is no usable full view, so retain the indication
-- that this is an object.
Ctyp := '*';
end if;
- -- Special handling for access parameter
-
- declare
- K : constant Entity_Kind := Ekind (Etype (XE.Ent));
+ -- Special handling for access parameters and objects of
+ -- an anonymous access type.
- begin
- if (K = E_Anonymous_Access_Type
- or else
- K = E_Anonymous_Access_Subprogram_Type
- or else K =
- E_Anonymous_Access_Protected_Subprogram_Type)
- and then Is_Formal (XE.Ent)
+ if Ekind_In (Etype (XE.Key.Ent),
+ E_Anonymous_Access_Type,
+ E_Anonymous_Access_Subprogram_Type,
+ E_Anonymous_Access_Protected_Subprogram_Type)
+ then
+ if Is_Formal (XE.Key.Ent)
+ or else Ekind_In (XE.Key.Ent, E_Variable, E_Constant)
then
Ctyp := 'p';
+ end if;
- -- Special handling for Boolean
+ -- Special handling for Boolean
- elsif Ctyp = 'e' and then Is_Boolean_Type (Ent) then
- Ctyp := 'b';
- end if;
- end;
+ elsif Ctyp = 'e' and then Is_Boolean_Type (Ent) then
+ Ctyp := 'b';
+ end if;
end if;
-- Special handling for abstract types and operations
- if Is_Abstract (XE.Ent) then
-
+ if Is_Overloadable (XE.Key.Ent)
+ and then Is_Abstract_Subprogram (XE.Key.Ent)
+ then
if Ctyp = 'U' then
- Ctyp := 'x'; -- abstract procedure
+ Ctyp := 'x'; -- Abstract procedure
elsif Ctyp = 'V' then
- Ctyp := 'y'; -- abstract function
+ Ctyp := 'y'; -- Abstract function
+ end if;
+
+ elsif Is_Type (XE.Key.Ent)
+ and then Is_Abstract_Type (XE.Key.Ent)
+ then
+ if Is_Interface (XE.Key.Ent) then
+ Ctyp := 'h';
elsif Ctyp = 'R' then
- Ctyp := 'H'; -- abstract type
+ Ctyp := 'H'; -- Abstract type
end if;
end if;
- -- Only output reference if interesting type of entity,
- -- and suppress self references, except for bodies that
- -- act as specs. Also suppress definitions of body formals
- -- (we only treat these as references, and the references
- -- were separately recorded).
+ -- Only output reference if interesting type of entity
if Ctyp = ' '
- or else (XE.Loc = XE.Def
- and then
- (XE.Typ /= 'b'
- or else not Is_Subprogram (XE.Ent)))
- or else (Is_Formal (XE.Ent)
- and then Present (Spec_Entity (XE.Ent)))
+
+ -- Suppress references to object definitions, used for local
+ -- references.
+
+ or else XE.Key.Typ = 'D'
+ or else XE.Key.Typ = 'I'
+
+ -- Suppress self references, except for bodies that act as
+ -- specs.
+
+ or else (XE.Key.Loc = XE.Def
+ and then
+ (XE.Key.Typ /= 'b'
+ or else not Is_Subprogram (XE.Key.Ent)))
+
+ -- Also suppress definitions of body formals (we only
+ -- treat these as references, and the references were
+ -- separately recorded).
+
+ or else (Is_Formal (XE.Key.Ent)
+ and then Present (Spec_Entity (XE.Key.Ent)))
then
null;
else
-- Start new Xref section if new xref unit
- if XE.Eun /= Curxu then
+ if XE.Key.Eun /= Curxu then
if Write_Info_Col > 1 then
Write_Info_EOL;
end if;
- Curxu := XE.Eun;
- Cursrc := Source_Text (Source_Index (Curxu));
+ Curxu := XE.Key.Eun;
Write_Info_Initiate ('X');
Write_Info_Char (' ');
- Write_Info_Nat (Dependency_Num (XE.Eun));
+ Write_Info_Nat (Dependency_Num (XE.Key.Eun));
Write_Info_Char (' ');
- Write_Info_Name (Reference_Name (Source_Index (XE.Eun)));
+ Write_Info_Name
+ (Reference_Name (Source_Index (XE.Key.Eun)));
end if;
-- Start new Entity line if new entity. Note that we
if No (Curent)
or else
- (XE.Ent /= Curent
+ (XE.Key.Ent /= Curent
and then
- (Name_Change (XE.Ent) or else XE.Def /= Curdef))
+ (Name_Change (XE.Key.Ent) or else XE.Def /= Curdef))
then
- Curent := XE.Ent;
+ Curent := XE.Key.Ent;
Curdef := XE.Def;
- Get_Unqualified_Name_String (Chars (XE.Ent));
+ Get_Unqualified_Name_String (Chars (XE.Key.Ent));
Curlen := Name_Len;
Curnam (1 .. Curlen) := Name_Buffer (1 .. Curlen);
Par : Node_Id;
begin
- if Ekind (Scope (E)) /= E_Generic_Package then
+ -- The Present check here is an error defense
+
+ if Present (Scope (E))
+ and then Ekind (Scope (E)) /= E_Generic_Package
+ then
return False;
end if;
end Write_Level_Info;
-- Output entity name. We use the occurrence from the
- -- actual source program at the definition point
-
- P := Original_Location (Sloc (XE.Ent));
-
- -- Entity is character literal
-
- if Cursrc (P) = ''' then
- Write_Info_Char (Cursrc (P));
- Write_Info_Char (Cursrc (P + 1));
- Write_Info_Char (Cursrc (P + 2));
-
- -- Entity is operator symbol
-
- elsif Cursrc (P) = '"' or else Cursrc (P) = '%' then
- Write_Info_Char (Cursrc (P));
-
- P2 := P;
- loop
- P2 := P2 + 1;
- Write_Info_Char (Cursrc (P2));
- exit when Cursrc (P2) = Cursrc (P);
- end loop;
-
- -- Entity is identifier
-
- else
- loop
- if Is_Start_Of_Wide_Char (Cursrc, P) then
- Scan_Wide (Cursrc, P, WC, Err);
- elsif not Identifier_Char (Cursrc (P)) then
- exit;
- else
- P := P + 1;
- end if;
- end loop;
+ -- actual source program at the definition point.
- for J in
- Original_Location (Sloc (XE.Ent)) .. P - 1
- loop
- Write_Info_Char (Cursrc (J));
+ declare
+ Ent_Name : constant String :=
+ Exact_Source_Name (Sloc (XE.Key.Ent));
+ begin
+ for C in Ent_Name'Range loop
+ Write_Info_Char (Ent_Name (C));
end loop;
- end if;
+ end;
-- See if we have a renaming reference
- if Is_Object (XE.Ent)
- and then Present (Renamed_Object (XE.Ent))
+ if Is_Object (XE.Key.Ent)
+ and then Present (Renamed_Object (XE.Key.Ent))
then
- Rref := Renamed_Object (XE.Ent);
+ Rref := Renamed_Object (XE.Key.Ent);
- elsif Is_Overloadable (XE.Ent)
- and then Nkind (Parent (Declaration_Node (XE.Ent))) =
- N_Subprogram_Renaming_Declaration
+ elsif Is_Overloadable (XE.Key.Ent)
+ and then Nkind (Parent (Declaration_Node (XE.Key.Ent)))
+ = N_Subprogram_Renaming_Declaration
then
- Rref := Name (Parent (Declaration_Node (XE.Ent)));
+ Rref := Name (Parent (Declaration_Node (XE.Key.Ent)));
- elsif Ekind (XE.Ent) = E_Package
- and then Nkind (Declaration_Node (XE.Ent)) =
+ elsif Ekind (XE.Key.Ent) = E_Package
+ and then Nkind (Declaration_Node (XE.Key.Ent)) =
N_Package_Renaming_Declaration
then
- Rref := Name (Declaration_Node (XE.Ent));
+ Rref := Name (Declaration_Node (XE.Key.Ent));
else
Rref := Empty;
(Int (Get_Column_Number (Sloc (Rref))));
end if;
- -- Indicate that the entity is in the unit
- -- of the current xref xection.
+ -- Indicate that the entity is in the unit of the current
+ -- xref section.
Curru := Curxu;
- -- Write out information about generic parent,
- -- if entity is an instance.
+ -- Write out information about generic parent, if entity
+ -- is an instance.
- if Is_Generic_Instance (XE.Ent) then
+ if Is_Generic_Instance (XE.Key.Ent) then
declare
Gen_Par : constant Entity_Id :=
- Generic_Parent
- (Specification
- (Unit_Declaration_Node (XE.Ent)));
- Loc : constant Source_Ptr := Sloc (Gen_Par);
- Gen_U : constant Unit_Number_Type :=
- Get_Source_Unit (Loc);
+ Generic_Parent
+ (Specification
+ (Unit_Declaration_Node
+ (XE.Key.Ent)));
+ Loc : constant Source_Ptr := Sloc (Gen_Par);
+ Gen_U : constant Unit_Number_Type :=
+ Get_Source_Unit (Loc);
+
begin
Write_Info_Char ('[');
+
if Curru /= Gen_U then
Write_Info_Nat (Dependency_Num (Gen_U));
Write_Info_Char ('|');
-- See if we have a type reference and if so output
- Get_Type_Reference (XE.Ent, Tref, Left, Right);
-
- if Present (Tref) then
-
- -- Case of standard entity, output name
-
- if Sloc (Tref) = Standard_Location then
- Write_Info_Char (Left);
- Write_Info_Name (Chars (Tref));
- Write_Info_Char (Right);
+ Check_Type_Reference (XE.Key.Ent, False);
- -- Case of source entity, output location
+ -- Additional information for types with progenitors
- else
- Write_Info_Char (Left);
- Trunit := Get_Source_Unit (Sloc (Tref));
-
- if Trunit /= Curxu then
- Write_Info_Nat (Dependency_Num (Trunit));
- Write_Info_Char ('|');
- end if;
-
- Write_Info_Nat
- (Int (Get_Logical_Line_Number (Sloc (Tref))));
-
- declare
- Ent : Entity_Id := Tref;
- Kind : constant Entity_Kind := Ekind (Ent);
- Ctyp : Character := Xref_Entity_Letters (Kind);
-
- begin
- if Ctyp = '+'
- and then Present (Full_View (Ent))
- then
- Ent := Underlying_Type (Ent);
-
- if Present (Ent) then
- Ctyp := Xref_Entity_Letters (Ekind (Ent));
- end if;
- end if;
-
- Write_Info_Char (Ctyp);
- end;
-
- Write_Info_Nat
- (Int (Get_Column_Number (Sloc (Tref))));
+ if Is_Record_Type (XE.Key.Ent)
+ and then Present (Interfaces (XE.Key.Ent))
+ then
+ declare
+ Elmt : Elmt_Id :=
+ First_Elmt (Interfaces (XE.Key.Ent));
+ begin
+ while Present (Elmt) loop
+ Check_Type_Reference (Node (Elmt), True);
+ Next_Elmt (Elmt);
+ end loop;
+ end;
- -- If the type comes from an instantiation,
- -- add the corresponding info.
+ -- For array types, list index types as well. (This is
+ -- not C, indexes have distinct types).
- Output_Instantiation_Refs (Sloc (Tref));
- Write_Info_Char (Right);
- end if;
+ elsif Is_Array_Type (XE.Key.Ent) then
+ declare
+ Indx : Node_Id;
+ begin
+ Indx := First_Index (XE.Key.Ent);
+ while Present (Indx) loop
+ Check_Type_Reference
+ (First_Subtype (Etype (Indx)), True);
+ Next_Index (Indx);
+ end loop;
+ end;
end if;
- -- If the entity is an overriding operation, write
- -- info on operation that was overridden.
+ -- If the entity is an overriding operation, write info
+ -- on operation that was overridden.
- if Is_Subprogram (XE.Ent)
- and then Is_Overriding_Operation (XE.Ent)
+ if Is_Subprogram (XE.Key.Ent)
+ and then Present (Overridden_Operation (XE.Key.Ent))
then
- Output_Overridden_Op (Overridden_Operation (XE.Ent));
+ Output_Overridden_Op
+ (Overridden_Operation (XE.Key.Ent));
end if;
-- End of processing for entity output
Crloc := No_Location;
end if;
- -- Output the reference
+ -- Output the reference if it is not as the same location
+ -- as the previous one, or it is a read-reference that
+ -- indicates that the entity is an in-out actual in a call.
- if XE.Loc /= No_Location
- and then XE.Loc /= Crloc
+ if XE.Key.Loc /= No_Location
+ and then
+ (XE.Key.Loc /= Crloc
+ or else (Prevt = 'm' and then XE.Key.Typ = 'r'))
then
- Crloc := XE.Loc;
+ Crloc := XE.Key.Loc;
+ Prevt := XE.Key.Typ;
-- Start continuation if line full, else blank
-- Output file number if changed
- if XE.Lun /= Curru then
- Curru := XE.Lun;
+ if XE.Key.Lun /= Curru then
+ Curru := XE.Key.Lun;
Write_Info_Nat (Dependency_Num (Curru));
Write_Info_Char ('|');
end if;
- Write_Info_Nat (Int (Get_Logical_Line_Number (XE.Loc)));
- Write_Info_Char (XE.Typ);
+ Write_Info_Nat
+ (Int (Get_Logical_Line_Number (XE.Key.Loc)));
+ Write_Info_Char (XE.Key.Typ);
- if Is_Overloadable (XE.Ent)
- and then Is_Imported (XE.Ent)
- and then XE.Typ = 'b'
+ if Is_Overloadable (XE.Key.Ent)
+ and then Is_Imported (XE.Key.Ent)
+ and then XE.Key.Typ = 'b'
then
- Output_Import_Export_Info (XE.Ent);
+ Output_Import_Export_Info (XE.Key.Ent);
end if;
- Write_Info_Nat (Int (Get_Column_Number (XE.Loc)));
+ Write_Info_Nat (Int (Get_Column_Number (XE.Key.Loc)));
- Output_Instantiation_Refs (Sloc (XE.Ent));
+ Output_Instantiation_Refs (Sloc (XE.Key.Ent));
end if;
end if;
end Output_One_Ref;
end Output_Refs;
end Output_References;
+begin
+ -- Reset is necessary because Elmt_Ptr does not default to Null_Ptr,
+ -- because it's not an access type.
+
+ Xref_Set.Reset;
end Lib.Xref;
OSDN Git Service
