Class PointerDataType
- java.lang.Object
-
- ghidra.program.model.data.AbstractDataType
-
- ghidra.program.model.data.DataTypeImpl
-
- ghidra.program.model.data.BuiltIn
-
- ghidra.program.model.data.PointerDataType
-
- All Implemented Interfaces:
BuiltInDataType
,DataType
,Pointer
,ExtensionPoint
- Direct Known Subclasses:
Pointer16DataType
,Pointer24DataType
,Pointer32DataType
,Pointer40DataType
,Pointer48DataType
,Pointer56DataType
,Pointer64DataType
,Pointer8DataType
public class PointerDataType extends BuiltIn implements Pointer
Basic implementation for a pointer dataType
-
-
Field Summary
Fields Modifier and Type Field Description static PointerDataType
dataType
protected int
length
static int
MAX_POINTER_SIZE_BYTES
static java.lang.String
POINTER_LABEL_PREFIX
static java.lang.String
POINTER_LOOP_LABEL_PREFIX
static java.lang.String
POINTER_NAME
protected DataType
referencedDataType
-
Fields inherited from class ghidra.program.model.data.DataTypeImpl
defaultSettings
-
Fields inherited from class ghidra.program.model.data.AbstractDataType
categoryPath, dataMgr, name
-
Fields inherited from interface ghidra.program.model.data.DataType
CONFLICT_SUFFIX, DEFAULT, NO_LAST_CHANGE_TIME, NO_SOURCE_SYNC_TIME, VOID
-
-
Constructor Summary
Constructors Constructor Description PointerDataType()
Creates a dynamically-sized default pointer data type.PointerDataType(DataType referencedDataType)
Construct a dynamically-sized pointer to a referencedDataType A dynamic pointer size of 4-bytes will be in used, but will adapt to a data type manager's data organization when resolved.PointerDataType(DataTypeManager dtm)
Creates a dynamically-sized default pointer data type.PointerDataType(DataType referencedDataType, int length)
Construct a pointer of a specified length to a referencedDataType.PointerDataType(DataType referencedDataType, int length, DataTypeManager dtm)
Construct a pointer of a specified length to a referencedDataType.PointerDataType(DataType referencedDataType, DataTypeManager dtm)
Construct a dynamically-sized pointer to the given data type.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Pointer
clone(DataTypeManager dtm)
Returns an instance of this DataType with its universalID and SourceArchive identity retained.void
dataTypeDeleted(DataType dt)
Informs this datatype that the given datatype has been deleted.void
dataTypeNameChanged(DataType dt, java.lang.String oldName)
Informs this datatype that its name has changed from the indicated old name.void
dataTypeReplaced(DataType oldDt, DataType newDt)
Informs this datatype that the given oldDT has been replaced with newDTboolean
dependsOn(DataType dt)
Check if this datatype depends on the existence of the given datatype.static Address
getAddressValue(MemBuffer buf, int size, AddressSpace targetSpace)
Generate an address value based upon bytes stored at the specified buf locationCategoryPath
getCategoryPath()
Gets the categoryPath associated with this datatypeDataType
getDataType()
Returns the "pointed to" dataTypejava.lang.String
getDefaultLabelPrefix()
Returns the appropriate string to use as the default label prefix in the absence of any data.java.lang.String
getDefaultLabelPrefix(MemBuffer buf, Settings settings, int len, DataTypeDisplayOptions options)
Returns the appropriate string to use as the default label prefix.java.lang.String
getDescription()
Get a String briefly describing this DataType.java.lang.String
getDisplayName()
Gets the name for referring to this datatype.static java.lang.String
getLabelString(MemBuffer buf, Settings settings, int len, DataTypeDisplayOptions options)
int
getLength()
Get the length (number of 8-bit bytes) of this DataType.java.lang.String
getMnemonic(Settings settings)
Get the mnemonic for this DataType.java.lang.String
getName()
Get the name of this datatype.static Pointer
getPointer(DataType dt, int pointerSize)
Get a pointer data-type instance of the requested size.static Pointer
getPointer(DataType dt, DataTypeManager dtm)
Get a pointer data-type instance with a default sizejava.lang.String
getRepresentation(MemBuffer buf, Settings settings, int len)
Get bytes from memory in a printable format for this type.java.lang.Object
getValue(MemBuffer buf, Settings settings, int len)
Get the data in the form of the appropriate Object for this DataType.java.lang.Class<?>
getValueClass(Settings settings)
Get the Class of the value to be returned by this datatype.boolean
hasLanguageDependantLength()
Indicates if the length of this data-type is determined based upon theDataOrganization
obtained from the associatedDataTypeManager
.boolean
isDeleted()
Returns true if this datatype has been deleted and is no longer validboolean
isEquivalent(DataType dt)
Check if the given datatype is equivalent to this datatype.Pointer
newPointer(DataType dt)
Creates a pointer to the indicated data type.java.lang.String
toString()
-
Methods inherited from class ghidra.program.model.data.BuiltIn
addParent, copy, dataTypeSizeChanged, getBuiltInSettingsDefinitions, getCTypeDeclaration, getCTypeDeclaration, getCTypeDeclaration, getCTypeDeclaration, getDecompilerDisplayName, getLastChangeTime, getSettingsDefinitions, getUniversalID, removeParent, setCategoryPath, setName, setNameAndCategory
-
Methods inherited from class ghidra.program.model.data.DataTypeImpl
equals, getAlignment, getDefaultSettings, getLastChangeTimeInSourceArchive, getParents, getPathName, getSourceArchive, hashCode, notifyAlignmentChanged, notifyDeleted, notifyNameChanged, notifyParents, notifyReplaced, notifySizeChanged, replaceWith, setDefaultSettings, setDescription, setLastChangeTime, setLastChangeTimeInSourceArchive, setSourceArchive
-
Methods inherited from class ghidra.program.model.data.AbstractDataType
dataTypeAlignmentChanged, encodeRepresentation, encodeValue, getDataOrganization, getDataTypeManager, getDataTypePath, getDefaultAbbreviatedLabelPrefix, getDefaultOffcutLabelPrefix, getDocs, isEncodable, isNotYetDefined, isZeroLength
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface ghidra.program.model.data.DataType
addParent, copy, dataTypeAlignmentChanged, dataTypeSizeChanged, encodeRepresentation, encodeValue, getAlignment, getDataOrganization, getDataTypeManager, getDataTypePath, getDefaultAbbreviatedLabelPrefix, getDefaultOffcutLabelPrefix, getDefaultSettings, getDocs, getLastChangeTime, getLastChangeTimeInSourceArchive, getParents, getPathName, getSettingsDefinitions, getSourceArchive, getUniversalID, isEncodable, isNotYetDefined, isZeroLength, removeParent, replaceWith, setCategoryPath, setDefaultSettings, setDescription, setLastChangeTime, setLastChangeTimeInSourceArchive, setName, setNameAndCategory, setSourceArchive
-
-
-
-
Field Detail
-
dataType
public static final PointerDataType dataType
-
MAX_POINTER_SIZE_BYTES
public static final int MAX_POINTER_SIZE_BYTES
- See Also:
- Constant Field Values
-
POINTER_NAME
public static final java.lang.String POINTER_NAME
- See Also:
- Constant Field Values
-
POINTER_LABEL_PREFIX
public static final java.lang.String POINTER_LABEL_PREFIX
- See Also:
- Constant Field Values
-
POINTER_LOOP_LABEL_PREFIX
public static final java.lang.String POINTER_LOOP_LABEL_PREFIX
- See Also:
- Constant Field Values
-
referencedDataType
protected DataType referencedDataType
-
length
protected int length
-
-
Constructor Detail
-
PointerDataType
public PointerDataType()
Creates a dynamically-sized default pointer data type. A dynamic pointer size of 4-bytes will be in used, but will adapt to a data type manager's data organization when resolved.
-
PointerDataType
public PointerDataType(DataTypeManager dtm)
Creates a dynamically-sized default pointer data type. The pointer size is established dynamically based upon the data organization associated with the specified dtm but can adapt to another data type manager's data organization when resolved.- Parameters:
dtm
- data-type manager whose data organization should be used
-
PointerDataType
public PointerDataType(DataType referencedDataType)
Construct a dynamically-sized pointer to a referencedDataType A dynamic pointer size of 4-bytes will be in used, but will adapt to a data type manager's data organization when resolved.- Parameters:
referencedDataType
- data type this pointer points to
-
PointerDataType
public PointerDataType(DataType referencedDataType, int length)
Construct a pointer of a specified length to a referencedDataType. Note: It is preferred to use default sized pointers when possible (i.e., length=-1, seePointerDataType(DataType)
) instead of explicitly specifying the pointer length value.- Parameters:
referencedDataType
- data type this pointer points tolength
- pointer length (values <= 0 will result in dynamically-sized pointer)
-
PointerDataType
public PointerDataType(DataType referencedDataType, DataTypeManager dtm)
Construct a dynamically-sized pointer to the given data type. The pointer size is established dynamically based upon the data organization associated with the specified dtm but can adapt to another data type manager's data organization when resolved.- Parameters:
referencedDataType
- data type this pointer points todtm
- data-type manager whose data organization should be used
-
PointerDataType
public PointerDataType(DataType referencedDataType, int length, DataTypeManager dtm)
Construct a pointer of a specified length to a referencedDataType. Note: It is preferred to use default sized pointers when possible (i.e., length=-1, seePointerDataType(DataType, DataTypeManager)
) instead of explicitly specifying the pointer length value.- Parameters:
referencedDataType
- data type this pointer points tolength
- pointer length (-1 will result in dynamically-sized pointer)dtm
- associated data type manager whose data organization will be used
-
-
Method Detail
-
clone
public final Pointer clone(DataTypeManager dtm)
Description copied from interface:DataType
Returns an instance of this DataType with its universalID and SourceArchive identity retained.The current instanceof will be returned if this datatype's DataTypeManager matches the specified dtm. The recursion depth of a clone will stop on any datatype whose DataTypeManager matches the specified dtm and simply use the existing datatype instance.
-
getDataType
public DataType getDataType()
Description copied from interface:Pointer
Returns the "pointed to" dataType- Specified by:
getDataType
in interfacePointer
-
hasLanguageDependantLength
public boolean hasLanguageDependantLength()
Description copied from interface:DataType
Indicates if the length of this data-type is determined based upon theDataOrganization
obtained from the associatedDataTypeManager
.- Specified by:
hasLanguageDependantLength
in interfaceDataType
- Overrides:
hasLanguageDependantLength
in classAbstractDataType
- Returns:
- true length is language/compiler-specification dependent, else false
-
getLength
public int getLength()
Description copied from interface:DataType
Get the length (number of 8-bit bytes) of this DataType.NOTE: No datatype should ever return 0, even if
DataType.isZeroLength()
, and onlyDynamic
datatypes should return -1. IfDataType.isZeroLength()
is true a length of 1 should be returned. Where a zero-length datatype can be handled (e.g.,Composite
) theDataType.isZeroLength()
method should be used.
-
getDefaultLabelPrefix
public java.lang.String getDefaultLabelPrefix()
Description copied from interface:DataType
Returns the appropriate string to use as the default label prefix in the absence of any data.- Specified by:
getDefaultLabelPrefix
in interfaceDataType
- Overrides:
getDefaultLabelPrefix
in classAbstractDataType
- Returns:
- the default label prefix or null if none specified.
-
getDefaultLabelPrefix
public java.lang.String getDefaultLabelPrefix(MemBuffer buf, Settings settings, int len, DataTypeDisplayOptions options)
Description copied from interface:DataType
Returns the appropriate string to use as the default label prefix.- Specified by:
getDefaultLabelPrefix
in interfaceDataType
- Overrides:
getDefaultLabelPrefix
in classAbstractDataType
- Parameters:
buf
- memory buffer containing the bytes.settings
- the Settings objectlen
- the length of the data.options
- options for how to format the default label prefix.- Returns:
- the default label prefix or null if none specified.
-
getLabelString
public static java.lang.String getLabelString(MemBuffer buf, Settings settings, int len, DataTypeDisplayOptions options)
-
getDisplayName
public java.lang.String getDisplayName()
Description copied from interface:DataType
Gets the name for referring to this datatype.- Specified by:
getDisplayName
in interfaceDataType
- Overrides:
getDisplayName
in classAbstractDataType
- Returns:
- generic name for this Data Type (i.e.: Word)
-
getDescription
public java.lang.String getDescription()
Description copied from interface:DataType
Get a String briefly describing this DataType.- Specified by:
getDescription
in interfaceDataType
- Returns:
- a one-liner describing this DataType.
-
getMnemonic
public java.lang.String getMnemonic(Settings settings)
Description copied from interface:DataType
Get the mnemonic for this DataType.- Specified by:
getMnemonic
in interfaceDataType
- Overrides:
getMnemonic
in classAbstractDataType
- Parameters:
settings
- settings which may influence the result or null- Returns:
- the mnemonic for this DataType.
-
getValue
public java.lang.Object getValue(MemBuffer buf, Settings settings, int len)
Description copied from interface:DataType
Get the data in the form of the appropriate Object for this DataType.For instance if the datatype is an AddressDT, return an Address object. a Byte, return a Scalar* (maybe this should be a Byte) a Float, return a Float
-
getValueClass
public java.lang.Class<?> getValueClass(Settings settings)
Description copied from interface:DataType
Get the Class of the value to be returned by this datatype.- Specified by:
getValueClass
in interfaceDataType
- Overrides:
getValueClass
in classDataTypeImpl
- Parameters:
settings
- the relevant settings to use or null for default.- Returns:
- Class of the value to be returned by this datatype or null if it can vary or is unspecified. Types which correspond to a string or char array will return the String class.
-
getAddressValue
public static Address getAddressValue(MemBuffer buf, int size, AddressSpace targetSpace)
Generate an address value based upon bytes stored at the specified buf location- Parameters:
buf
- memory buffer and stored pointer locationsize
- pointer size in bytestargetSpace
- address space for returned pointer- Returns:
- pointer value or null if unusable buf or data
-
getRepresentation
public java.lang.String getRepresentation(MemBuffer buf, Settings settings, int len)
Description copied from interface:DataType
Get bytes from memory in a printable format for this type.- Specified by:
getRepresentation
in interfaceDataType
- Parameters:
buf
- the data.settings
- the settings to use for the representation.len
- the number of bytes to represent.- Returns:
- the representation of the data in this format, never null.
-
isEquivalent
public boolean isEquivalent(DataType dt)
Description copied from interface:DataType
Check if the given datatype is equivalent to this datatype.The precise meaning of "equivalent" is datatype dependent.
NOTE: if invoked by a DB object or manager it should be invoked on the DataTypeDB object passing the other datatype as the argument.- Specified by:
isEquivalent
in interfaceDataType
- Overrides:
isEquivalent
in classBuiltIn
- Parameters:
dt
- the datatype being tested for equivalence.- Returns:
- true if the if the given datatype is equivalent to this datatype.
-
dataTypeDeleted
public void dataTypeDeleted(DataType dt)
Description copied from interface:DataType
Informs this datatype that the given datatype has been deleted.TODO: This method is reserved for internal DB use.
- Specified by:
dataTypeDeleted
in interfaceDataType
- Overrides:
dataTypeDeleted
in classBuiltIn
- Parameters:
dt
- the datatype that has been deleted.
-
isDeleted
public boolean isDeleted()
Description copied from interface:DataType
Returns true if this datatype has been deleted and is no longer valid- Specified by:
isDeleted
in interfaceDataType
- Overrides:
isDeleted
in classAbstractDataType
- Returns:
- true if this datatype has been deleted and is no longer valid.
-
dataTypeReplaced
public void dataTypeReplaced(DataType oldDt, DataType newDt)
Description copied from interface:DataType
Informs this datatype that the given oldDT has been replaced with newDTTODO: This method is reserved for internal DB use.
- Specified by:
dataTypeReplaced
in interfaceDataType
- Overrides:
dataTypeReplaced
in classBuiltIn
- Parameters:
oldDt
- old datatypenewDt
- new datatype
-
dataTypeNameChanged
public void dataTypeNameChanged(DataType dt, java.lang.String oldName)
Description copied from interface:DataType
Informs this datatype that its name has changed from the indicated old name.TODO: This method is reserved for internal DB use.
- Specified by:
dataTypeNameChanged
in interfaceDataType
- Overrides:
dataTypeNameChanged
in classBuiltIn
- Parameters:
dt
- the datatype whose name changedoldName
- the datatype's old name
-
getCategoryPath
public CategoryPath getCategoryPath()
Description copied from interface:DataType
Gets the categoryPath associated with this datatype- Specified by:
getCategoryPath
in interfaceDataType
- Overrides:
getCategoryPath
in classAbstractDataType
- Returns:
- the datatype's category path
-
dependsOn
public boolean dependsOn(DataType dt)
Description copied from interface:DataType
Check if this datatype depends on the existence of the given datatype.For example byte[] depends on byte. If byte were deleted, then byte[] would also be deleted.
-
getPointer
public static Pointer getPointer(DataType dt, DataTypeManager dtm)
Get a pointer data-type instance with a default size- Parameters:
dt
- data-type referenced by pointerdtm
- program data-type manager (required) a generic data-type will be returned if possible.- Returns:
- signed integer data type
-
getPointer
public static Pointer getPointer(DataType dt, int pointerSize)
Get a pointer data-type instance of the requested size. NOTE: The returned data-type will not be associated with any particular data-type-manager and may therefore not utilize dynamically-sized-pointers when a valid pointerSize is specified. If an invalid pointerSize is specified, a dynamically-size pointer will be returned whose length is based upon the default-data-organization.- Parameters:
dt
- data-type referenced by pointerpointerSize
- pointer size- Returns:
- signed integer data type
-
newPointer
public Pointer newPointer(DataType dt)
Description copied from interface:Pointer
Creates a pointer to the indicated data type.- Specified by:
newPointer
in interfacePointer
- Parameters:
dt
- the data type to point to.- Returns:
- the newly created pointer.
-
getName
public java.lang.String getName()
Description copied from interface:DataType
Get the name of this datatype.- Specified by:
getName
in interfaceDataType
- Overrides:
getName
in classAbstractDataType
- Returns:
- the name
-
toString
public java.lang.String toString()
- Overrides:
toString
in classAbstractDataType
-
-