Class BooleanDataType
- All Implemented Interfaces:
ArrayStringable
,BuiltInDataType
,DataType
,ExtensionPoint
-
Field Summary
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, TYPEDEF_ATTRIBUTE_PREFIX, TYPEDEF_ATTRIBUTE_SUFFIX, VOID
-
Constructor Summary
ConstructorDescriptionConstructs a new Boolean datatype. -
Method Summary
Modifier and TypeMethodDescriptionclone
(DataTypeManager dtm) Returns an instance of this DataType using the specifiedDataTypeManager
to allow its use of the correspondingDataOrganization
while retaining its unique identity (seeDataType.getUniversalID()
and archive association (seeDataType.getSourceArchive()
) if applicable.protected SettingsDefinition[]
Gets a list of all the settingsDefinitions used by this datatype.getDecompilerDisplayName
(DecompilerLanguage language) Return token used to represent this type in decompiler/source-code outputReturns the appropriate string to use as the default label prefix in the absence of any data.Get a String briefly describing this DataType.int
Get the length of this DataType as a number of 8-bit bytes.getMnemonic
(Settings settings) Get the mnemonic for this DataType.getRepresentation
(MemBuffer buf, Settings settings, int length) Get bytes from memory in a printable format for this type.getRepresentation
(BigInteger bigInt, Settings settings, int bitLength) Returns the interpreted data value as an instance of theadvertised value class
.Class
<?> getValueClass
(Settings settings) Get the Class of the value Object to be returned by this datatype (seeDataType.getValue(MemBuffer, Settings, int)
).Methods inherited from class ghidra.program.model.data.AbstractUnsignedIntegerDataType
isSigned
Methods inherited from class ghidra.program.model.data.AbstractIntegerDataType
castValueToEncode, encodeRepresentation, encodeValue, getArrayDefaultLabelPrefix, getArrayDefaultOffcutLabelPrefix, getAssemblyMnemonic, getBitCount, getCMnemonic, getFormatSettingsDefinition, getSignedDataType, getSignedDataTypes, getUnsignedDataType, getUnsignedDataTypes, hasStringValue, isEncodable, isEquivalent
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, setDefaultSettings, setName, setNameAndCategory
Methods inherited from class ghidra.program.model.data.DataTypeImpl
equals, getAlignedLength, getAlignment, getDefaultSettings, getLastChangeTimeInSourceArchive, getParents, getPathName, getSourceArchive, hashCode, notifyAlignmentChanged, notifyDeleted, notifyNameChanged, notifyParents, notifyReplaced, notifySizeChanged, replaceWith, setDescription, setLastChangeTime, setLastChangeTimeInSourceArchive, setSourceArchive
Methods inherited from class ghidra.program.model.data.AbstractDataType
dataTypeAlignmentChanged, getCategoryPath, getDataOrganization, getDataOrganization, getDataTypeManager, getDataTypePath, getDefaultAbbreviatedLabelPrefix, getDefaultLabelPrefix, getDefaultOffcutLabelPrefix, getDisplayName, getDocs, getName, getTypeDefSettingsDefinitions, 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, getAlignedLength, getAlignment, getCategoryPath, getDataOrganization, getDataTypeManager, getDataTypePath, getDefaultAbbreviatedLabelPrefix, getDefaultLabelPrefix, getDefaultOffcutLabelPrefix, getDefaultSettings, getDisplayName, getDocs, getLastChangeTime, getLastChangeTimeInSourceArchive, getName, getParents, getPathName, getSettingsDefinitions, getSourceArchive, getTypeDefSettingsDefinitions, getUniversalID, hasLanguageDependantLength, isDeleted, isNotYetDefined, isZeroLength, removeParent, replaceWith, setCategoryPath, setDescription, setLastChangeTime, setLastChangeTimeInSourceArchive, setName, setNameAndCategory, setSourceArchive
-
Field Details
-
dataType
-
-
Constructor Details
-
BooleanDataType
public BooleanDataType()Constructs a new Boolean datatype. -
BooleanDataType
-
-
Method Details
-
getMnemonic
Description copied from interface:DataType
Get the mnemonic for this DataType.- Specified by:
getMnemonic
in interfaceDataType
- Overrides:
getMnemonic
in classAbstractIntegerDataType
- Parameters:
settings
- settings which may influence the result or null- Returns:
- the mnemonic for this DataType.
-
getDecompilerDisplayName
Description copied from class:BuiltIn
Return token used to represent this type in decompiler/source-code output- Overrides:
getDecompilerDisplayName
in classBuiltIn
- Parameters:
language
- is the language being displayed- Returns:
- the name string
-
getCDeclaration
- Overrides:
getCDeclaration
in classAbstractIntegerDataType
- 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 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 itsaligned-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 ifDataType.isZeroLength()
, and onlyDynamic
/FactoryDataType
datatypes should return -1. IfDataType.isZeroLength()
is true a length of 1 should be returned. Where a zero-length datatype can be handled (e.g.,Composite
) theDataType.isZeroLength()
method should be used.- Returns:
- the length of this DataType
-
getDescription
Description copied from interface:DataType
Get a String briefly describing this DataType.- Returns:
- a one-liner describing this DataType.
-
getValue
Description copied from interface:DataType
Returns the interpreted data value as an instance of theadvertised value class
.For instance,
Pointer
data types should return an Address object (or null), or integer data types should return aScalar
object.- Specified by:
getValue
in interfaceDataType
- Overrides:
getValue
in classAbstractIntegerDataType
- Parameters:
buf
- the data buffersettings
- the settings to use.length
- indicates the maximum number of bytes that may be consumed by aDynamic
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
-
getValueClass
Description copied from interface:DataType
Get the Class of the value Object to be returned by this datatype (seeDataType.getValue(MemBuffer, Settings, int)
).- Specified by:
getValueClass
in interfaceDataType
- Overrides:
getValueClass
in classAbstractIntegerDataType
- Parameters:
settings
- the relevant settings to use or null for default.- Returns:
- Class of the value to be returned by this datatype or null if it can vary or is unspecified. Types which correspond to a string or char array will return the String class.
-
getRepresentation
Description copied from interface:DataType
Get bytes from memory in a printable format for this type.- Specified by:
getRepresentation
in interfaceDataType
- Overrides:
getRepresentation
in classAbstractIntegerDataType
- 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
-
getBuiltInSettingsDefinitions
Description copied from class:BuiltIn
Gets a list of all the settingsDefinitions used by this datatype.- Overrides:
getBuiltInSettingsDefinitions
in classAbstractIntegerDataType
- Returns:
- a list of the settingsDefinitions used by this datatype.
-
clone
Description copied from interface:DataType
Returns an instance of this DataType using the specifiedDataTypeManager
to allow its use of the correspondingDataOrganization
while retaining its unique identity (seeDataType.getUniversalID()
and archive association (seeDataType.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.- Parameters:
dtm
- the data-type manager instance whose data-organization should apply.- Returns:
- cloned instance which may be the same as this instance
-
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 interfaceDataType
- Overrides:
getDefaultLabelPrefix
in classAbstractIntegerDataType
- Returns:
- the default label prefix or null if none specified.
-
getOppositeSignednessDataType
- Specified by:
getOppositeSignednessDataType
in classAbstractIntegerDataType
- Returns:
- the data-type with the opposite signedness from this data-type. For example, this method on IntegerDataType will return an instance of UnsignedIntegerDataType.
-