Package ghidra.program.util
Class SubDataFieldLocation
- java.lang.Object
-
- ghidra.program.util.ProgramLocation
-
- ghidra.program.util.CodeUnitLocation
-
- ghidra.program.util.SubDataFieldLocation
-
- All Implemented Interfaces:
java.lang.Comparable<ProgramLocation>
public class SubDataFieldLocation extends CodeUnitLocation
TheSubDataFieldLocation
class contains specific location information within the Sub-data field of a CodeUnitLocation object.
-
-
Field Summary
-
Fields inherited from class ghidra.program.util.ProgramLocation
addr, program, refAddr
-
-
Constructor Summary
Constructors Constructor Description SubDataFieldLocation()
Should only be used by XML restoration.SubDataFieldLocation(Program program, Address addr, GroupPath path, int[] componentPath, Address refAddr, java.lang.String rep, int charOffset, java.lang.String fieldName)
Construct a new SubDataFieldLocation object.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(java.lang.Object obj)
java.lang.String
getDataRepresentation()
Returns a string representation of the dataValue at this location.java.lang.String
getFieldName()
Returns the name of the sub-data field.int
hashCode()
void
restoreState(Program p, SaveState obj)
Restore this program location using the given program and save state object.void
saveState(SaveState obj)
Save this program 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.CodeUnitLocation
isValid
-
Methods inherited from class ghidra.program.util.ProgramLocation
compareAddr, compareTo, getAddress, getByteAddress, getCharOffset, getColumn, getComponentPath, getLocation, getProgram, getRefAddress, getRow
-
-
-
-
Constructor Detail
-
SubDataFieldLocation
public SubDataFieldLocation(Program program, Address addr, GroupPath path, int[] componentPath, Address refAddr, java.lang.String rep, int charOffset, java.lang.String fieldName)
Construct a new SubDataFieldLocation object.- Parameters:
program
- the program of the locationaddr
- address of the locationpath
- path associated with the address (an address could appear at more than one group path); may be nullcomponentPath
- array of indexes for each nested data component; the index is the data component's index within its parent; may be nullrefAddr
- the "referred to" address if the location is over a reference; may be nullrep
- the String representation of the operand.charOffset
- the character position within the operand string.fieldName
- the name of the sub-data field
-
SubDataFieldLocation
public SubDataFieldLocation()
Should only be used by XML restoration.
-
-
Method Detail
-
getDataRepresentation
public java.lang.String getDataRepresentation()
Returns a string representation of the dataValue at this location.
-
getFieldName
public java.lang.String getFieldName()
Returns the name of the sub-data field.
-
toString
public java.lang.String toString()
Returns a String representation of this location.- Overrides:
toString
in classProgramLocation
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classProgramLocation
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classProgramLocation
-
restoreState
public void restoreState(Program p, SaveState obj)
Description copied from class:ProgramLocation
Restore this program location using the given program and save state object.- Overrides:
restoreState
in classProgramLocation
- Parameters:
p
- program to restore fromobj
- the save state to restore from
-
saveState
public void saveState(SaveState obj)
Description copied from class:ProgramLocation
Save this program location to the given save state object.- Overrides:
saveState
in classProgramLocation
- Parameters:
obj
- the save state object for saving the location
-
-