Class VariableLocFieldLocation

  • All Implemented Interfaces:
    java.lang.Comparable<ProgramLocation>

    public class VariableLocFieldLocation
    extends VariableLocation
    The VariableLocFieldLocation class provides specific information about the stack variable offset field within a program location.
    • Constructor Detail

      • VariableLocFieldLocation

        public VariableLocFieldLocation​(Program program,
                                        Address locationAddr,
                                        Variable var,
                                        int charOffset)
        Construct a new VariableLocFieldLocation object.
        Parameters:
        program - the program of the location
        locationAddr - the address of the listing location (i.e., referent code unit)
        var - the variable which has its location (stack offset) in the field.
        charOffset - the position within the variable location (stack offset) string for this location.
      • VariableLocFieldLocation

        public VariableLocFieldLocation​(Program program,
                                        Variable var,
                                        int charOffset)
        Construct a new VariableLocFieldLocation object. Variable function entry point is the assumed listing location (i.e., referent code unit). Care should be taken if variable corresponds to an EXTERNAL function.
        Parameters:
        program - the program of the location
        var - the variable which has its location (stack offset) in the field.
        charOffset - the position within the variable location (stack offset) string for this location.
      • VariableLocFieldLocation

        public VariableLocFieldLocation()
        Should only be used by XML restoration.
    • Method Detail

      • getLoc

        public java.lang.String getLoc()
        Gets the location string. (For stack variables this is the offset as a string.)
      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class VariableLocation
        See Also:
        Object.equals(java.lang.Object)
      • restoreState

        public void restoreState​(Program program1,
                                 SaveState obj)
        Description copied from class: FunctionLocation
        Restore this function location using the given program and save state object.
        Overrides:
        restoreState in class VariableLocation
        Parameters:
        program1 - the program containing the function location
        obj - the save state object for saving the location
      • saveState

        public void saveState​(SaveState obj)
        Description copied from class: FunctionLocation
        Save this function location to the given save state object.
        Overrides:
        saveState in class VariableLocation
        Parameters:
        obj - the save state object for saving the location