Package ghidra.program.model.data

Class DynamicDataType

java.lang.Object

ghidra.program.model.data.AbstractDataType

ghidra.program.model.data.DataTypeImpl

ghidra.program.model.data.BuiltIn

ghidra.program.model.data.DynamicDataType

All Implemented Interfaces:

BuiltInDataType, DataType, Dynamic, ExtensionPoint

Direct Known Subclasses:

AndroidElfRelocationTableDataType, BitmapResourceDataType, CountedDynamicDataType, DialogResourceDataType, GroupIconResourceDataType, IndexedDynamicDataType, MenuResourceDataType, MUIResourceDataType, PERichTableDataType, PEx64UnwindInfoDataType, RepeatCountDataType, RepeatedDynamicDataType, RTTIDataType, StructuredDynamicDataType, WEVTResourceDataType

public abstract class DynamicDataType
extends BuiltIn
implements Dynamic

Interface for dataTypes that don't get applied, but instead generate dataTypes on the fly based on the data.

Field Summary

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

Modifier	Constructor	Description
protected	DynamicDataType(CategoryPath path, java.lang.String name)
protected	DynamicDataType(CategoryPath path, java.lang.String name, DataTypeManager dtm)
protected	DynamicDataType(java.lang.String name)
protected	DynamicDataType(java.lang.String name, DataTypeManager dtm)

Method Summary

Modifier and Type	Method	Description
boolean	canSpecifyLength()	Determine if the length may be specified for an instanceof this datatype (e.g., Data, Array, DataTypeComponent, etc.).
protected abstract DataTypeComponent[]	getAllComponents(MemBuffer buf)	Get all dynamic components associated with the specified MemBuffer
DataTypeComponent	getComponent(int ordinal, MemBuffer buf)	Returns the immediate n'th component of this data type.
DataTypeComponent	getComponentAt(int offset, MemBuffer buf)	Returns the first component containing the byte at the given offset.
DataTypeComponent[]	getComponents(MemBuffer buf)	Returns an array of components that make up this data type.
protected DataTypeComponent[]	getComps(MemBuffer buf)
int	getLength()	Get the length (number of 8-bit bytes) of this DataType.
int	getLength(MemBuffer buf, int maxLength)	Compute the length for this data-type which corresponds to the specified memory location.
int	getNumComponents(MemBuffer buf)	Gets the number of component data types in this data type.
DataType	getReplacementBaseType()	Returns a suitable replacement base data-type for pointers and arrays when exporting to C code
void	invalidateCache()

Methods inherited from class ghidra.program.model.data.BuiltIn

addParent, copy, dataTypeDeleted, dataTypeNameChanged, dataTypeReplaced, dataTypeSizeChanged, dependsOn, getBuiltInSettingsDefinitions, getCTypeDeclaration, getCTypeDeclaration, getCTypeDeclaration, getCTypeDeclaration, getDecompilerDisplayName, getLastChangeTime, getSettingsDefinitions, getUniversalID, isEquivalent, removeParent, setCategoryPath, setName, setNameAndCategory

Methods inherited from class ghidra.program.model.data.DataTypeImpl

equals, getAlignment, getDefaultSettings, getLastChangeTimeInSourceArchive, getParents, getPathName, getSourceArchive, getValueClass, 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, getCategoryPath, getDataOrganization, getDataTypeManager, getDataTypePath, getDefaultAbbreviatedLabelPrefix, getDefaultLabelPrefix, getDefaultLabelPrefix, getDefaultOffcutLabelPrefix, getDisplayName, getDocs, getMnemonic, getName, hasLanguageDependantLength, isDeleted, isEncodable, isNotYetDefined, isZeroLength, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface ghidra.program.model.data.BuiltInDataType

getCTypeDeclaration

Methods inherited from interface ghidra.program.model.data.DataType

addParent, clone, copy, dataTypeAlignmentChanged, dataTypeDeleted, dataTypeNameChanged, dataTypeReplaced, dataTypeSizeChanged, dependsOn, encodeRepresentation, encodeValue, getAlignment, getCategoryPath, getDataOrganization, getDataTypeManager, getDataTypePath, getDefaultAbbreviatedLabelPrefix, getDefaultLabelPrefix, getDefaultLabelPrefix, getDefaultOffcutLabelPrefix, getDefaultSettings, getDescription, getDisplayName, getDocs, getLastChangeTime, getLastChangeTimeInSourceArchive, getMnemonic, getName, getParents, getPathName, getRepresentation, getSettingsDefinitions, getSourceArchive, getUniversalID, getValue, getValueClass, hasLanguageDependantLength, isDeleted, isEncodable, isEquivalent, isNotYetDefined, isZeroLength, removeParent, replaceWith, setCategoryPath, setDefaultSettings, setDescription, setLastChangeTime, setLastChangeTimeInSourceArchive, setName, setNameAndCategory, setSourceArchive

Constructor Detail

DynamicDataType

protected DynamicDataType(java.lang.String name)

DynamicDataType

protected DynamicDataType(java.lang.String name,
                          DataTypeManager dtm)

DynamicDataType

protected DynamicDataType(CategoryPath path,
                          java.lang.String name)

DynamicDataType

protected DynamicDataType(CategoryPath path,
                          java.lang.String name,
                          DataTypeManager dtm)

Method Detail

canSpecifyLength

public final boolean canSpecifyLength()

Description copied from interface: Dynamic

Determine if the length may be specified for an instanceof this datatype (e.g., Data, Array, DataTypeComponent, etc.).

Specified by:

canSpecifyLength in interface Dynamic

Returns:

true if a user-specified length can be used, else false

getNumComponents

public final int getNumComponents(MemBuffer buf)

Gets the number of component data types in this data type.

Parameters:

buf - a memory buffer to be used by dataTypes that change depending on their data context.

Returns:

the number of components that make up this data prototype - if this is an Array, return the number of elements in the array. - if this datatype is a subcomponent of another datatype and it won't fit in it's defined space, return -1.

getComps

protected DataTypeComponent[] getComps(MemBuffer buf)

getComponent

public final DataTypeComponent getComponent(int ordinal,
                                            MemBuffer buf)

Returns the immediate n'th component of this data type.

Parameters:

ordinal - the components ordinal (zero based).

buf - a memory buffer to be used by dataTypes that change depending on their data context.

Returns:

the component data type or null if there is no component at the indicated index.

Throws:

java.lang.ArrayIndexOutOfBoundsException - if index is out of bounds

getComponents

public final DataTypeComponent[] getComponents(MemBuffer buf)

Returns an array of components that make up this data type. Could return null if there are no subcomponents.

Parameters:

buf - a memory buffer to be used by dataTypes that change depending on their data context.

Returns:

datatype component array or null.

getComponentAt

public final DataTypeComponent getComponentAt(int offset,
                                              MemBuffer buf)

Returns the first component containing the byte at the given offset. It is possible with zero-length components (see DataTypeComponent#isZeroLength()) and bitfields (see @DataTypeComponent#isBitFieldComponent()} for multiple components to share the same offset.

Parameters:

offset - the offset into the dataType

buf - the memory buffer containing the bytes.

Returns:

the first component containing the byte at the given offset or null if no component defined. A zero-length component may be returned.

getAllComponents

protected abstract DataTypeComponent[] getAllComponents(MemBuffer buf)

Get all dynamic components associated with the specified MemBuffer

Parameters:

buf - memory buffer positioned at start of data type instance

Returns:

all components or null if memory data is not valid for this data type.

getLength

public final int getLength(MemBuffer buf,
                           int maxLength)

Description copied from interface: Dynamic

Compute the length for this data-type which corresponds to the specified memory location.

Specified by:

getLength in interface Dynamic

Parameters:

buf - memory location

maxLength - maximum number of bytes to consume in computing length, or -1 for unspecified.

Returns:

data length or -1 if it could not be determined. Returned length may exceed maxLength if data-type does not supported constrained lengths.

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 only Dynamic datatypes should return -1. If DataType.isZeroLength() is true a length of 1 should be returned. Where a zero-length datatype can be handled (e.g., Composite) the DataType.isZeroLength() method should be used.

Specified by:

getLength in interface DataType

Returns:

the length of this DataType

invalidateCache

public void invalidateCache()

getReplacementBaseType

public DataType getReplacementBaseType()

Description copied from interface: Dynamic

Returns a suitable replacement base data-type for pointers and arrays when exporting to C code

Specified by:

getReplacementBaseType in interface Dynamic

Returns:

suitable base data-type for this Dynamic data-type