Package ghidra.program.util
Class FunctionReturnTypeFieldLocation
java.lang.Object
ghidra.program.util.ProgramLocation
ghidra.program.util.FunctionLocation
ghidra.program.util.FunctionSignatureFieldLocation
ghidra.program.util.FunctionReturnTypeFieldLocation
- All Implemented Interfaces:
Cloneable
,Comparable<ProgramLocation>
The
FunctionReturnTypeFieldLocation
class provides specific information
about the Function Return Type field within a program location.-
Field Summary
Fields inherited from class ghidra.program.util.FunctionLocation
functionAddr
Fields inherited from class ghidra.program.util.ProgramLocation
addr, program, refAddr
-
Constructor Summary
ConstructorDescriptionDefault constructor needed for restoring a program location from XMLFunctionReturnTypeFieldLocation
(Program program, Address functionAddr, int col, String signature, String returnType) Construct a new FunctionReturnTypeFieldLocation object.FunctionReturnTypeFieldLocation
(Program program, Address locationAddr, Address functionAddr, int charOffset, String signature, String returnType) Construct a new FunctionReturnTypeFieldLocation object.FunctionReturnTypeFieldLocation
(Program program, Address functionAddr, String returnType) Construct a new FunctionReturnTypeFieldLocation object that is field based. -
Method Summary
Modifier and TypeMethodDescriptionboolean
Return the function return type string at this location.int
hashCode()
void
restoreState
(Program restoreProgram, SaveState obj) Restore this function location using the given program and save state object.void
Save this function location to the given save state object.toString()
Returns a String representation of this location.Methods inherited from class ghidra.program.util.FunctionSignatureFieldLocation
getSignature, isFieldBasedPositioning
Methods inherited from class ghidra.program.util.FunctionLocation
getFunctionAddress, isValid
Methods inherited from class ghidra.program.util.ProgramLocation
clone, compareAddr, compareTo, getAddress, getByteAddress, getCharOffset, getColumn, getComponentPath, getLocation, getProgram, getRefAddress, getRow, getTranslatedCopy
-
Constructor Details
-
FunctionReturnTypeFieldLocation
public FunctionReturnTypeFieldLocation(Program program, Address locationAddr, Address functionAddr, int charOffset, String signature, String returnType) Construct a new FunctionReturnTypeFieldLocation object.- Parameters:
program
- the program of the locationlocationAddr
- the address of the listing location (i.e., referent code unit)functionAddr
- the function addresscharOffset
- the position within the function signature string for this location.signature
- the function signature string for this location.returnType
- the function return type String at this location.
-
FunctionReturnTypeFieldLocation
public FunctionReturnTypeFieldLocation(Program program, Address functionAddr, int col, String signature, String returnType) Construct a new FunctionReturnTypeFieldLocation object.- Parameters:
program
- the program of the locationfunctionAddr
- the function addresscol
- the position within the function signature string for this location.signature
- the function signature string for this location.returnType
- the function return type String at this location.
-
FunctionReturnTypeFieldLocation
Construct a new FunctionReturnTypeFieldLocation object that is field based.- Parameters:
program
- the program of the locationfunctionAddr
- the function addressreturnType
- the function return type String at this location.
-
FunctionReturnTypeFieldLocation
public FunctionReturnTypeFieldLocation()Default constructor needed for restoring a program location from XML
-
-
Method Details
-
getReturnType
Return the function return type string at this location. -
toString
Returns a String representation of this location.- Overrides:
toString
in classFunctionSignatureFieldLocation
-
hashCode
public int hashCode()- Overrides:
hashCode
in classFunctionSignatureFieldLocation
-
equals
- Overrides:
equals
in classFunctionSignatureFieldLocation
- See Also:
-
saveState
Description copied from class:FunctionLocation
Save this function location to the given save state object.- Overrides:
saveState
in classFunctionSignatureFieldLocation
- Parameters:
obj
- the save state object for saving the location
-
restoreState
Description copied from class:FunctionLocation
Restore this function location using the given program and save state object.- Overrides:
restoreState
in classFunctionSignatureFieldLocation
- Parameters:
restoreProgram
- the program containing the function locationobj
- the save state object for saving the location
-