⟦01070a8c2⟧

E3 Source Code



--| @SUMMARY Prrovides interfaces for finding references and determining
--| what kind of reference it is.  Interfaces are available for determining
--| whether a reference is set, used, or both set and used.
--|
--| @INDICES (REFERENCES, ADA_ANALYSIS)
with Ada_Program;
package Id_Referencers is

    subtype Object_References is Ada_Program.Element_List;

    --| @DESCRIPTION Locates all references to an object indentifier
    --| reference or identifier definition.
    function Initialize_References
                (For_Id : Ada_Program.Element) return Object_References;

    --| @DESCRIPTION Finds all object references in a subprogram body.
    --| Included are variables, constants, named numbers, parameters and
    --| record component declarations.
    function Internal_References
                (In_Element : Ada_Program.Element) return Object_References;

    function  Done  (Referencers : Object_References) return Boolean;
    procedure Next  (Referencers : in out Object_References);
    function  Value (Referencers : Object_References)
                   return Ada_Program.Identifier_Reference;

    type Object_Reference_Types is (Parameter,  
                                    Global_Variable,  
                                    Global_Constant,  
                                    Local_Package_Variable,  
                                    Local_Package_Constant,  
                                    Local_Procedure_Variable,  
                                    Local_Procedure_Constant,  
                                    Not_An_Object_Ref);

    --| @DESCRIPTION Returns the kind of object referenced
    function Reference_Type (Id_Ref : Ada_Program.Identifier_Reference)
                            return Object_Reference_Types;

    --| @DESCRIPTION Find the id definition of the object referenced by the
    --| Id_Ref.  If for example, the reference is to a component of a
    --| record, Ada.definiion will return the record component.  Thsi function
    --| returns the actual object that is referenced.  A nil element is
    --| returned in the reference does not actually reference any object.
    function Get_Referenced_Object_Id
                (Id_Ref : Ada_Program.Identifier_Reference)
                return Ada_Program.Identifier_Definition;

    --| @DESCRIPTION Returns the type definition of any object reference
    --| @RAISES (Not_An_Object_Reference)
    function Reference_Type (Id_Reference : Ada_Program.Identifier_Reference)
                            return Ada_Program.Type_Definition;

    --| @DESCRIPTION Raised if the reference does not actual reference and
    --| object or a component of an object
    Not_An_Object_Reference : exception;


    type Reference_Kind is (Set,  
                            Used,  
                            Set_And_Used);

    --| @DESCRIPTION A references is Set if it is on the left hand
    --| side of an assignment statement or if it is passed as
    --| an out parameter.  A reference is Set_And_Used if it is passed
    --| as an in out parameter.  All other references are Used.
    function Kind (Id_Reference : Ada_Program.Identifier_Reference)
                  return Reference_Kind;

end Id_Referencers;
DataMuseum.dk

Rational R1000/400

⟦01070a8c2⟧ Ada Source

Derivation

E3 Source Code

E3 Meta Data
