Package ghidra.program.model.data

Class ByteDataType

java.lang.Object

ghidra.program.model.data.AbstractDataType

ghidra.program.model.data.DataTypeImpl

ghidra.program.model.data.BuiltIn

ghidra.program.model.data.AbstractIntegerDataType

ghidra.program.model.data.ByteDataType

All Implemented Interfaces:

ArrayStringable, BuiltInDataType, DataType, ExtensionPoint

public class ByteDataType
extends AbstractIntegerDataType

Provides a definition of a Byte within a program.

Field Summary

Fields

Modifier and Type	Field	Description
static ByteDataType	dataType	A statically defined ByteDataType instance.

Fields inherited from class ghidra.program.model.data.AbstractIntegerDataType

ENDIAN, MNEMONIC, PADDING

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
ByteDataType()
ByteDataType(DataTypeManager dtm)

Method Summary

Modifier and Type	Method	Description
ByteDataType	clone(DataTypeManager dtm)	Returns an instance of this DataType with its universalID and SourceArchive identity retained.
java.lang.String	getAssemblyMnemonic()
java.lang.String	getDecompilerDisplayName(DecompilerLanguage language)	Return token used to represent this type in decompiler/source-code output
java.lang.String	getDescription()	Get a String briefly describing this DataType.
int	getLength()	Get the length (number of 8-bit bytes) of this DataType.
SignedByteDataType	getOppositeSignednessDataType()

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

castValueToEncode, encodeRepresentation, encodeValue, getArrayDefaultLabelPrefix, getArrayDefaultOffcutLabelPrefix, getBuiltInSettingsDefinitions, getCDeclaration, getCMnemonic, getDefaultLabelPrefix, getFormatSettingsDefinition, getMnemonic, getRepresentation, getSignedDataType, getSignedDataTypes, getUnsignedDataType, getUnsignedDataTypes, getValue, getValueClass, hasStringValue, isEncodable, isEquivalent, isSigned

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

addParent, copy, dataTypeDeleted, dataTypeNameChanged, dataTypeReplaced, dataTypeSizeChanged, dependsOn, getCTypeDeclaration, getCTypeDeclaration, getCTypeDeclaration, getCTypeDeclaration, 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, getCategoryPath, getDataOrganization, getDataTypeManager, getDataTypePath, getDefaultAbbreviatedLabelPrefix, getDefaultLabelPrefix, getDefaultOffcutLabelPrefix, getDisplayName, getDocs, getName, hasLanguageDependantLength, isDeleted, 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.ArrayStringable

getArrayString

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

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

Field Detail

dataType

public static final ByteDataType dataType

A statically defined ByteDataType instance.

Constructor Detail

ByteDataType

public ByteDataType()

ByteDataType

public ByteDataType(DataTypeManager dtm)

Method Detail

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.

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.

Returns:

the length of this DataType

getAssemblyMnemonic

public java.lang.String getAssemblyMnemonic()

Overrides:

getAssemblyMnemonic in class AbstractIntegerDataType

Returns:

the Assembly style data-type declaration for this data-type.

getDecompilerDisplayName

public java.lang.String getDecompilerDisplayName(DecompilerLanguage language)

Description copied from class: BuiltIn

Return token used to represent this type in decompiler/source-code output

Overrides:

getDecompilerDisplayName in class BuiltIn

Parameters:

language - is the language being displayed

Returns:

the name string

getOppositeSignednessDataType

public SignedByteDataType getOppositeSignednessDataType()

Specified by:

getOppositeSignednessDataType in class AbstractIntegerDataType

Returns:

the data-type with the opposite signedness from this data-type. For example, this method on IntegerDataType will return an instance of UnsignedIntegerDataType.

clone

public ByteDataType 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.

Parameters:

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

Returns:

cloned instance which may be the same as this instance