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:
java.lang.Comparable<ProgramLocation>
public class FunctionNameFieldLocation extends FunctionSignatureFieldLocation
TheFunctionNameFieldLocation
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
Constructors Constructor Description FunctionNameFieldLocation()
Default constructor needed for restoring a program location from XMLFunctionNameFieldLocation(Program program, Address functionAddr, int col, java.lang.String signature, java.lang.String functionName)
Construct a new FunctionNameFieldLocation object.FunctionNameFieldLocation(Program program, Address locationAddr, Address functionAddr, int charOffset, java.lang.String signature, java.lang.String functionName)
Construct a new FunctionNameFieldLocation object.FunctionNameFieldLocation(Program program, Address addr, java.lang.String functionName)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(java.lang.Object obj)
java.lang.String
getFunctionName()
int
hashCode()
void
restoreState(Program restoreProgram, SaveState obj)
Restore this function location using the given program and save state object.void
saveState(SaveState obj)
Save this function location to the given save state object.java.lang.String
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
compareAddr, compareTo, getAddress, getByteAddress, getCharOffset, getColumn, getComponentPath, getLocation, getProgram, getRefAddress, getRow
-
-
-
-
Constructor Detail
-
FunctionNameFieldLocation
public FunctionNameFieldLocation(Program program, Address locationAddr, Address functionAddr, int charOffset, java.lang.String signature, java.lang.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, java.lang.String signature, java.lang.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
public FunctionNameFieldLocation(Program program, Address addr, java.lang.String functionName)
-
FunctionNameFieldLocation
public FunctionNameFieldLocation()
Default constructor needed for restoring a program location from XML
-
-
Method Detail
-
getFunctionName
public java.lang.String getFunctionName()
-
toString
public java.lang.String toString()
Returns a String representation of this location.- Overrides:
toString
in classFunctionSignatureFieldLocation
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classFunctionSignatureFieldLocation
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classFunctionSignatureFieldLocation
- See Also:
Object.equals(java.lang.Object)
-
saveState
public void saveState(SaveState obj)
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
public void restoreState(Program restoreProgram, SaveState obj)
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
-
-