Package ghidra.program.model.data

Class BooleanDataType

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.BooleanDataType

All Implemented Interfaces:

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

public class BooleanDataType
extends AbstractIntegerDataType

Provides a definition of an Ascii byte in a 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 BooleanDataType	dataType

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
BooleanDataType()	Constructs a new Boolean datatype.
BooleanDataType(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.
protected SettingsDefinition[]	getBuiltInSettingsDefinitions()	Gets a list of all the settingsDefinitions used by this datatype.
java.lang.String	getCDeclaration()
java.lang.String	getDecompilerDisplayName(DecompilerLanguage language)	Return token used to represent this type in decompiler/source-code output
java.lang.String	getDefaultLabelPrefix()	Returns the appropriate string to use as the default label prefix in the absence of any data.
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.
AbstractIntegerDataType	getOppositeSignednessDataType()
java.lang.String	getRepresentation(MemBuffer buf, Settings settings, int length)	Get bytes from memory in a printable format for this type.
java.lang.String	getRepresentation(java.math.BigInteger bigInt, Settings settings, int bitLength)	Get integer representation of the big-endian value.
java.lang.Object	getValue(MemBuffer buf, Settings settings, int length)	Get the data in the form of the appropriate Object for this DataType.
java.lang.Class<?>	getValueClass(Settings settings)	Get the Class of the value to be returned by this data type.
boolean	isDynamicallySized()	Indicates if this data-type is dynamically sized based upon DataOrganization.

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

getArrayDefaultLabelPrefix, getArrayDefaultOffcutLabelPrefix, getAssemblyMnemonic, getCMnemonic, getFormatSettingsDefinition, getSignedDataType, getSignedDataTypes, getUnsignedDataType, getUnsignedDataTypes, hasStringValue, 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, 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, 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.ArrayStringable

getArrayString

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

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

Field Detail

dataType

public static final BooleanDataType dataType

Constructor Detail

BooleanDataType

public BooleanDataType()

Constructs a new Boolean datatype.

BooleanDataType

public BooleanDataType(DataTypeManager dtm)

Method Detail

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 AbstractIntegerDataType

Returns:

the mnemonic for this DataType.

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

getCDeclaration

public java.lang.String getCDeclaration()

Overrides:

getCDeclaration in class AbstractIntegerDataType

Returns:

the C style data-type declaration for this data-type. Null is returned if no appropriate declaration exists.

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

isDynamicallySized

public boolean isDynamicallySized()

Description copied from interface: DataType

Indicates if this data-type is dynamically sized based upon DataOrganization.

Specified by:

isDynamicallySized in interface DataType

Overrides:

isDynamicallySized in class AbstractIntegerDataType

See Also:

DataType.isDynamicallySized()

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.

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

Specified by:

getValue in interface DataType

Overrides:

getValue in class AbstractIntegerDataType

Parameters:

buf - the data buffer.

settings - the settings to use.

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

Returns:

the data Object.

getValueClass

public java.lang.Class<?> getValueClass(Settings settings)

Description copied from interface: DataType

Get the Class of the value to be returned by this data type.

Specified by:

getValueClass in interface DataType

Overrides:

getValueClass in class AbstractIntegerDataType

Parameters:

settings - the relevant settings to use or null for default.

Returns:

Class of the value to be returned by this data type or null if it can vary or is unspecified. Types which correspond to a string or char array will return the String class.

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

Overrides:

getRepresentation in class AbstractIntegerDataType

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.

getRepresentation

public java.lang.String getRepresentation(java.math.BigInteger bigInt,
                                          Settings settings,
                                          int bitLength)

Description copied from class: AbstractIntegerDataType

Get integer representation of the big-endian value.

Overrides:

getRepresentation in class AbstractIntegerDataType

Parameters:

bigInt - BigInteger value with the appropriate sign

settings - integer format settings (PADDING, FORMAT, etc.)

bitLength - number of value bits to be used from bigInt

Returns:

formatted integer string

getBuiltInSettingsDefinitions

protected SettingsDefinition[] getBuiltInSettingsDefinitions()

Description copied from class: BuiltIn

Gets a list of all the settingsDefinitions used by this datatype.

Overrides:

getBuiltInSettingsDefinitions in class AbstractIntegerDataType

Returns:

a list of the settingsDefinitions used by this datatype.

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.

getDefaultLabelPrefix

public java.lang.String getDefaultLabelPrefix()

Description copied from interface: DataType

Returns the appropriate string to use as the default label prefix in the absence of any data.

Specified by:

getDefaultLabelPrefix in interface DataType

Overrides:

getDefaultLabelPrefix in class AbstractIntegerDataType

Returns:

the default label prefix or null if none specified.

getOppositeSignednessDataType

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