Package ghidra.program.model.data

Class Undefined2DataType

java.lang.Object

ghidra.program.model.data.AbstractDataType

ghidra.program.model.data.DataTypeImpl

ghidra.program.model.data.BuiltIn

ghidra.program.model.data.Undefined

ghidra.program.model.data.Undefined2DataType

All Implemented Interfaces:

BuiltInDataType, DataType, ExtensionPoint, java.util.EventListener, javax.swing.event.ChangeListener

public class Undefined2DataType
extends Undefined

Provides an implementation of a 2 byte dataType that has not been defined yet as a particular type of data in the program.

Nested Class Summary

Nested classes/interfaces inherited from interface ghidra.util.classfinder.ExtensionPoint

ExtensionPoint.Exclude, ExtensionPoint.Util

Field Summary

Fields

Modifier and Type	Field	Description
static Undefined2DataType	dataType	A statically defined DefaultDataType used when an Undefined byte is needed.

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
Undefined2DataType()	Constructs a new Undefined2 dataType
Undefined2DataType(DataTypeManager dtm)

Method Summary

Modifier and Type	Method	Description
DataType	clone(DataTypeManager dtm)	Returns a new instance of this DataType with its universalID and SourceArchive identity retained.
java.lang.String	getDescription()	Get a String briefly describing this DataType.
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	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.

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

getUndefinedDataType, getUndefinedDataTypes, isDynamicallySized, isUndefined, isUndefinedArray

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, notifyDeleted, notifyNameChanged, notifyReplaced, notifySizeChanged, replaceWith, setDefaultSettings, setDescription, setLastChangeTime, setLastChangeTimeInSourceArchive, setSourceArchive, stateChanged

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

getCategoryPath, getDataOrganization, getDataTypeManager, getDataTypePath, getDefaultAbbreviatedLabelPrefix, getDefaultLabelPrefix, getDefaultLabelPrefix, getDefaultOffcutLabelPrefix, getDisplayName, getDocs, getName, isDeleted, isNotYetDefined, toString

Methods inherited from class java.lang.Object

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

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

getAlignment, getCategoryPath, getDataOrganization, getDataTypeManager, getDataTypePath, getDefaultAbbreviatedLabelPrefix, getDefaultLabelPrefix, getDefaultLabelPrefix, getDefaultOffcutLabelPrefix, getDefaultSettings, getDisplayName, getDocs, getLastChangeTimeInSourceArchive, getName, getParents, getPathName, getSourceArchive, getValueClass, isDeleted, isNotYetDefined, replaceWith, setDefaultSettings, setDescription, setLastChangeTime, setLastChangeTimeInSourceArchive, setSourceArchive

Field Detail

dataType

public static final Undefined2DataType dataType

A statically defined DefaultDataType used when an Undefined byte is needed.

Constructor Detail

Undefined2DataType

public Undefined2DataType()

Constructs a new Undefined2 dataType

Undefined2DataType

public Undefined2DataType(DataTypeManager dtm)

Method Detail

getLength

public int getLength()

Description copied from interface: DataType

Get the length (number of 8-bit bytes) of this DataType.

Returns:

the length of this DataType

See Also:

DataType.getLength()

getDescription

public java.lang.String getDescription()

Description copied from interface: DataType

Get a String briefly describing this DataType.

Returns:

a one-liner describing this DataType.

See Also:

DataType.getDescription()

getMnemonic

public java.lang.String getMnemonic(Settings settings)

Description copied from interface: DataType

Get the mnemonic for this DataType.

Specified by:

getMnemonic in interface DataType

Overrides:

getMnemonic in class AbstractDataType

Returns:

the mnemonic for this DataType.

See Also:

DataType.getMnemonic(Settings)

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.

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(MemBuffer, Settings, int)

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 data type is an AddressDT, return an Address object. a Byte, return a Scalar* (maybe this should be a Byte) a Float, return a Float

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)

clone

public DataType clone(DataTypeManager dtm)

Description copied from interface: DataType

Returns a new instance of this DataType with its universalID and SourceArchive identity retained. Note: for built-in DataType's, clone and copy should have the same affect.

Parameters:

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