Package ghidra.program.model.data

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, GnuBuildIdSection, GnuDebugLinkSection, 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 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	FactoryStructureDataType(java.lang.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, java.lang.String componentName)
abstract DataType	clone(DataTypeManager dtm)	Returns an instance of this DataType with its universalID and SourceArchive identity retained.
DataType	getDataType(MemBuffer buf)	Returns the appropriate DataType which corresponds to the specified memory location.
java.lang.String	getDescription()	Get a String briefly describing this DataType.
int	getLength()	All implementations must return a length of -1.
java.lang.String	getRepresentation(MemBuffer buf, Settings settings, int length)	Get bytes from memory in a printable format for this type.
java.lang.Object	getValue(MemBuffer buf, Settings settings, int length)	Get the data in the form of the appropriate Object for this DataType.
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 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, copy, dataTypeAlignmentChanged, dataTypeDeleted, dataTypeNameChanged, dataTypeReplaced, dataTypeSizeChanged, dependsOn, encodeRepresentation, encodeValue, getAlignment, getCategoryPath, getDataOrganization, getDataTypeManager, getDataTypePath, getDefaultAbbreviatedLabelPrefix, getDefaultLabelPrefix, getDefaultLabelPrefix, getDefaultOffcutLabelPrefix, getDefaultSettings, getDisplayName, getDocs, getLastChangeTime, getLastChangeTimeInSourceArchive, getMnemonic, getName, getParents, getPathName, getSettingsDefinitions, getSourceArchive, getUniversalID, getValueClass, hasLanguageDependantLength, isDeleted, isEncodable, isEquivalent, isNotYetDefined, isZeroLength, removeParent, replaceWith, setCategoryPath, setDefaultSettings, setDescription, setLastChangeTime, setLastChangeTimeInSourceArchive, setName, setNameAndCategory, setSourceArchive

Constructor Detail

FactoryStructureDataType

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

Constructs a new DynamicStructureDataType with the given name

Parameters:

name - the name of this dataType

Method Detail

clone

public abstract DataType 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.

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: FactoryDataType

All implementations must return a length of -1.

Specified by:

getLength in interface DataType

Specified by:

getLength in interface FactoryDataType

Returns:

length of -1

See Also:

DataType.getLength()

getValue

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

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

Specified by:

getValue in interface DataType

Parameters:

buf - the data buffer.

settings - the settings to use.

length - the number of bytes to get the value from.

Returns:

the data Object.

See Also:

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

getRepresentation

public java.lang.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 java.lang.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,
                                         java.lang.String componentName)

populateDynamicStructure

protected abstract void populateDynamicStructure(MemBuffer buf,
                                                 Structure es)