Class FunctionLocation

    • Field Detail

      • functionAddr

        protected Address functionAddr
    • Constructor Detail

      • FunctionLocation

        protected FunctionLocation​(Program program,
                                   Address locationAddr,
                                   Address functionAddr,
                                   int row,
                                   int col,
                                   int charOffset)
        Create a new FunctionLocation.
        Parameters:
        the - program of the location
        locationAddr - the address of the listing location (i.e., referent code unit)
        functionAddr - the function address
        row - the row in the field
        col - the display piece on the row
        charOffset - the character position within the display piece specifed by row,col
      • FunctionLocation

        protected FunctionLocation()
        Default constructor needed for restoring a program function location from XML
    • Method Detail

      • equals

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

        public Address getFunctionAddress()
        Return the Function symbol address which may differ from the "location address" when a function is indirectly inferred via a reference. WARNING: The ProgramLocation.getAddress() should not be used to obtain the function address!
        Returns:
        the function address corresponding to this program location
      • saveState

        public void saveState​(SaveState obj)
        Save this function location to the given save state object.
        Overrides:
        saveState in class ProgramLocation
        Parameters:
        obj - the save state object for saving the location
        prefix - prefix appended to the names of the save state items to make the entry unique
      • restoreState

        public void restoreState​(Program program1,
                                 SaveState obj)
        Restore this function location using the given program and save state object.
        Overrides:
        restoreState in class ProgramLocation
        Parameters:
        prefix - prefix appended to the names of the save state items to make the entry unique
      • isValid

        public boolean isValid​(Program p)
        Description copied from class: ProgramLocation
        Returns true if this location represents a valid location in the given program
        Overrides:
        isValid in class ProgramLocation
        Parameters:
        p - the program to test if this location is valid.
        Returns:
        true if this location represents a valid location in the given program