Package ghidra.program.util
Class FunctionParameterFieldLocation
- java.lang.Object
-
- ghidra.program.util.ProgramLocation
-
- ghidra.program.util.FunctionLocation
-
- ghidra.program.util.FunctionSignatureFieldLocation
-
- ghidra.program.util.FunctionParameterFieldLocation
-
- All Implemented Interfaces:
java.lang.Comparable<ProgramLocation>
- Direct Known Subclasses:
FunctionParameterNameFieldLocation
public class FunctionParameterFieldLocation extends FunctionSignatureFieldLocation
-
-
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 FunctionParameterFieldLocation()
Default constructor needed for restoring a program location from XMLFunctionParameterFieldLocation(Program program, Address locationAddr, Address functionAddr, int charOffset, java.lang.String signature, Parameter parameter)
Construct a new FunctionParameterFieldLocation object.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(java.lang.Object obj)
int
getOrdinal()
Parameter
getParameter()
Returns the parameter associated with this location.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, hashCode, 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
-
FunctionParameterFieldLocation
public FunctionParameterFieldLocation(Program program, Address locationAddr, Address functionAddr, int charOffset, java.lang.String signature, Parameter parameter)
Construct a new FunctionParameterFieldLocation 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 at this location.parameter
- the function parameter at this location.
-
FunctionParameterFieldLocation
public FunctionParameterFieldLocation()
Default constructor needed for restoring a program location from XML
-
-
Method Detail
-
getParameter
public Parameter getParameter()
Returns the parameter associated with this location. This value can be null if the parameters are deleted from the function associated with the address of the parameter.- Returns:
- the parameter
-
getOrdinal
public int getOrdinal()
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classFunctionSignatureFieldLocation
- See Also:
Object.equals(java.lang.Object)
-
toString
public java.lang.String toString()
Returns a String representation of this location.- Overrides:
toString
in classFunctionSignatureFieldLocation
-
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
-
-