Class FactoryStructureDataType

java.lang.Object

ghidra.program.model.data.AbstractDataType

ghidra.program.model.data.DataTypeImpl

ghidra.program.model.data.BuiltIn

ghidra.program.model.data.FactoryStructureDataType

All Implemented Interfaces:

BuiltInDataType, DataType, FactoryDataType, ExtensionPoint

Direct Known Subclasses:

ElfDataType, PeDataType

public abstract class FactoryStructureDataType
extends BuiltIn
implements FactoryDataType

Abstract class used to create specialized data structures that act like a Structure and create a new Dynamic structure each time they are used.

Field Summary

Fields inherited from class DataTypeImpl

defaultSettings

Fields inherited from class AbstractDataType

categoryPath, dataMgr, EMPTY_TYPEDEF_DEFINITIONS, name

Fields inherited from interface DataType

CONFLICT_SUFFIX, DEFAULT, NO_LAST_CHANGE_TIME, NO_SOURCE_SYNC_TIME, TYPEDEF_ATTRIBUTE_PREFIX, TYPEDEF_ATTRIBUTE_SUFFIX, VOID

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	FactoryStructureDataType(String name, DataTypeManager dtm)	Constructs a new DynamicStructureDataType with the given name

Method Summary

Modifier and Type	Method	Description
protected DataTypeComponent	addComponent(Structure es, DataType dt, int length, String componentName)
protected DataTypeComponent	addComponent(Structure es, DataType dt, String componentName)
abstract DataType	clone(DataTypeManager dtm)	Returns an instance of this DataType using the specified DataTypeManager to allow its use of the corresponding DataOrganization while retaining its unique identity (see DataType.getUniversalID() and archive association (see DataType.getSourceArchive()) if applicable.
DataType	getDataType(MemBuffer buf)	Returns the appropriate DataType which corresponds to the specified memory location.
String	getDescription()	Get a String briefly describing this DataType.
final int	getLength()	Get the length of this DataType as a number of 8-bit bytes.
String	getRepresentation(MemBuffer buf, Settings settings, int length)	Get bytes from memory in a printable format for this type.
Object	getValue(MemBuffer buf, Settings settings, int length)	Returns the interpreted data value as an instance of the advertised value class.
protected abstract void	populateDynamicStructure(MemBuffer buf, Structure es)
protected Structure	setCategoryPath(Structure struct, MemBuffer buf)	Set the category of this data type.

Methods inherited from class BuiltIn

addParent, copy, getBuiltInSettingsDefinitions, getCTypeDeclaration, getCTypeDeclaration, getCTypeDeclaration, getCTypeDeclaration, getDecompilerDisplayName, getLastChangeTime, getSettingsDefinitions, getUniversalID, isEquivalent, removeParent, setDefaultSettings

Methods inherited from class DataTypeImpl

equals, getAlignedLength, getAlignment, getDefaultSettings, getLastChangeTimeInSourceArchive, getParents, getSourceArchive, getValueClass, hashCode, notifyAlignmentChanged, notifyDeleted, notifyNameChanged, notifyParents, notifyReplaced, notifySizeChanged, replaceWith, setDescription, setLastChangeTime, setLastChangeTimeInSourceArchive, setSourceArchive

Methods inherited from class AbstractDataType

dataTypeAlignmentChanged, dataTypeDeleted, dataTypeNameChanged, dataTypeReplaced, dataTypeSizeChanged, dependsOn, encodeRepresentation, encodeValue, getCategoryPath, getDataOrganization, getDataOrganization, getDataTypeManager, getDataTypePath, getDefaultAbbreviatedLabelPrefix, getDefaultLabelPrefix, getDefaultLabelPrefix, getDefaultOffcutLabelPrefix, getDisplayName, getMnemonic, getName, getPathName, getTypeDefSettingsDefinitions, hasLanguageDependantLength, isDeleted, isEncodable, isNotYetDefined, isZeroLength, setCategoryPath, setName, setNameAndCategory, toString

Methods inherited from class Object

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

Methods inherited from interface BuiltInDataType

getCTypeDeclaration, setDefaultSettings

Methods inherited from interface DataType

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

Constructor Details

FactoryStructureDataType

protected FactoryStructureDataType(String name,
 DataTypeManager dtm)

Constructs a new DynamicStructureDataType with the given name

Parameters:

name - the name of this dataType

Method Details

clone

public abstract DataType clone(DataTypeManager dtm)

Description copied from interface: DataType

Returns an instance of this DataType using the specified DataTypeManager to allow its use of the corresponding DataOrganization while retaining its unique identity (see DataType.getUniversalID() and archive association (see DataType.getSourceArchive()) if applicable.

This instance 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.

NOTE: In general, this method should not be used to obtain an instance to be modified. In most cases changes may be made directly to this instance if supported or to a DataType.copy(DataTypeManager) of this type.

Specified by:

clone in interface DataType

Parameters:

dtm - the data-type manager instance whose data-organization should apply.

Returns:

cloned instance which may be the same as this instance

getLength

public final int getLength()

Description copied from interface: DataType

Get the length of this DataType as a number of 8-bit bytes.

For primitive datatypes this reflects the smallest varnode which can be used to contain its value (i.e., raw data length).

Example: For x86 32-bit gcc an 80-bit long double raw data length of 10-bytes will fit within a floating point register while its aligned-length of 12-bytes is used by the gcc compiler for data/array/component allocations to maintain alignment (i.e., sizeof(long double) ).

NOTE: Other than the VoidDataType, no datatype should ever return 0, even if DataType.isZeroLength(), and only Dynamic/FactoryDataType 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

Specified by:

getLength in interface FactoryDataType

Returns:

the length of this DataType

See Also:

• DataType.getLength()

getValue

public Object getValue(MemBuffer buf,
 Settings settings,
 int length)

Description copied from interface: DataType

Returns the interpreted data value as an instance of the advertised value class.

For instance, Pointer data types should return an Address object (or null), or integer data types should return a Scalar object.

Specified by:

getValue in interface DataType

Parameters:

buf - the data buffer

settings - the settings to use.

length - indicates the maximum number of bytes that may be consumed by a Dynamic datatype, otherwise this value is ignored. A value of -1 may be specified to allow a Dynamic datatype to determine the length based upon the actual data bytes

Returns:

the data object, or null if data is invalid

See Also:

• DataType.getValue(ghidra.program.model.mem.MemBuffer, ghidra.docking.settings.Settings, int)

getRepresentation

public String getRepresentation(MemBuffer buf,
 Settings settings,
 int length)

Description copied from interface: DataType

Get bytes from memory in a printable format for this type.

Specified by:

getRepresentation in interface DataType

Parameters:

buf - the data.

settings - the settings to use for the representation.

length - the number of bytes to represent.

Returns:

the representation of the data in this format, never null.

See Also:

• DataType.getRepresentation(ghidra.program.model.mem.MemBuffer, ghidra.docking.settings.Settings, int)

getDescription

public String getDescription()

Description copied from interface: DataType

Get a String briefly describing this DataType.

Specified by:

getDescription in interface DataType

Returns:

a one-liner describing this DataType.

See Also:

• DataType.getDescription()

getDataType

public DataType getDataType(MemBuffer buf)

Description copied from interface: FactoryDataType

Returns the appropriate DataType which corresponds to the specified memory location.

Specified by:

getDataType in interface FactoryDataType

Parameters:

buf - memory location

Returns:

fabricated datatype based upon memory data

setCategoryPath

protected Structure setCategoryPath(Structure struct,
 MemBuffer buf)

Set the category of this data type.

Parameters:

struct -

buf -

Returns:

Returns a new structure with the correct category.

addComponent

protected DataTypeComponent addComponent(Structure es,
 DataType dt,
 String componentName)

addComponent

protected DataTypeComponent addComponent(Structure es,
 DataType dt,
 int length,
 String componentName)

populateDynamicStructure

protected abstract void populateDynamicStructure(MemBuffer buf,
 Structure es)