Package ghidra.program.util
Class FunctionNameFieldLocation
java.lang.Object
ghidra.program.util.ProgramLocation
ghidra.program.util.FunctionLocation
ghidra.program.util.FunctionSignatureFieldLocation
ghidra.program.util.FunctionNameFieldLocation
- All Implemented Interfaces:
Cloneable
,Comparable<ProgramLocation>
The
FunctionNameFieldLocation
class provides specific information
about the Function Name 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 XMLFunctionNameFieldLocation
(Program program, Address functionAddr, int col, String signature, String functionName) Construct a new FunctionNameFieldLocation object.FunctionNameFieldLocation
(Program program, Address locationAddr, Address functionAddr, int charOffset, String signature, String functionName) Construct a new FunctionNameFieldLocation object.FunctionNameFieldLocation
(Program program, Address addr, String functionName) -
Method Summary
Modifier and TypeMethodDescriptionboolean
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
-
FunctionNameFieldLocation
public FunctionNameFieldLocation(Program program, Address locationAddr, Address functionAddr, int charOffset, String signature, String functionName) Construct a new FunctionNameFieldLocation 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.functionName
- the function name String at this location.
-
FunctionNameFieldLocation
public FunctionNameFieldLocation(Program program, Address functionAddr, int col, String signature, String functionName) Construct a new FunctionNameFieldLocation 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.functionName
- the function name String at this location.
-
FunctionNameFieldLocation
-
FunctionNameFieldLocation
public FunctionNameFieldLocation()Default constructor needed for restoring a program location from XML
-
-
Method Details
-
getFunctionName
-
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
-