Class AbstractIntegerDataType
- All Implemented Interfaces:
ArrayStringable
,BuiltInDataType
,DataType
,ExtensionPoint
- Direct Known Subclasses:
AbstractSignedIntegerDataType
,AbstractUnsignedIntegerDataType
,CharDataType
chars
, ints
, and longs
.
If FormatSettingsDefinition.getFormat(Settings)
indicates that this is a
CHAR
type, the ArrayStringable
methods will treat
an array of this data type as a string.
-
Field Summary
Modifier and TypeFieldDescriptionprotected static final EndianSettingsDefinition
protected static final DataTypeMnemonicSettingsDefinition
protected static final PaddingSettingsDefinition
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
-
Method Summary
Modifier and TypeMethodDescriptionprotected BigInteger
castValueToEncode
(Object value) byte[]
encodeRepresentation
(String repr, MemBuffer buf, Settings settings, int length) Encode bytes according to the display format for this type.byte[]
encodeValue
(Object value, MemBuffer buf, Settings settings, int length) Encode bytes from an Object appropriate for this DataType.getArrayDefaultLabelPrefix
(MemBuffer buf, Settings settings, int len, DataTypeDisplayOptions options) For cases where an array of this type exists, get the appropriate string to use as the default label prefix for the array.getArrayDefaultOffcutLabelPrefix
(MemBuffer buf, Settings settings, int len, DataTypeDisplayOptions options, int offcutOffset) For cases where an array of this type exists, get the appropriate string to use as the default label prefix, taking into account the fact that there exists a reference to the data that referencesoffcutLength
bytes into this typeprotected static int
getBitCount
(Class<? extends Number> type) Get the number of bits in the integral typeprotected SettingsDefinition[]
Gets a list of all the settingsDefinitions used by this datatype.Returns the appropriate string to use as the default label prefix in the absence of any data.protected FormatSettingsDefinition
Return the Format settings definition included in the settings definition arraygetMnemonic
(Settings settings) Get the mnemonic for this DataType.abstract AbstractIntegerDataType
getRepresentation
(MemBuffer buf, Settings settings, int length) Get bytes from memory in a printable format for this type.static DataType
getSignedDataType
(int size, DataTypeManager dtm) Get a Signed Integer data-type instance of the requested sizestatic AbstractIntegerDataType[]
Returns all built-in signed integer data-types.static DataType
getUnsignedDataType
(int size, DataTypeManager dtm) Get a Unsigned Integer data-type instance of the requested sizestatic AbstractIntegerDataType[]
Returns all built-in unsigned integer data-typesReturns 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)
).boolean
hasStringValue
(Settings settings) For cases where an array of this type exists, determines if a String value will be returned.boolean
Check if this type supports encoding (patching)boolean
isEquivalent
(DataType dt) Check if the given datatype is equivalent to this datatype.abstract boolean
isSigned()
Determine if this type is signed.Methods inherited from class ghidra.program.model.data.BuiltIn
addParent, copy, dataTypeDeleted, dataTypeNameChanged, dataTypeReplaced, dataTypeSizeChanged, dependsOn, getCTypeDeclaration, getCTypeDeclaration, getCTypeDeclaration, getCTypeDeclaration, getDecompilerDisplayName, 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, clone, copy, dataTypeAlignmentChanged, dataTypeDeleted, dataTypeNameChanged, dataTypeReplaced, dataTypeSizeChanged, dependsOn, getAlignedLength, getAlignment, getCategoryPath, getDataOrganization, getDataTypeManager, getDataTypePath, getDefaultAbbreviatedLabelPrefix, getDefaultLabelPrefix, getDefaultOffcutLabelPrefix, getDefaultSettings, getDescription, getDisplayName, getDocs, getLastChangeTime, getLastChangeTimeInSourceArchive, getLength, getName, getParents, getPathName, getSettingsDefinitions, getSourceArchive, getTypeDefSettingsDefinitions, getUniversalID, hasLanguageDependantLength, isDeleted, isNotYetDefined, isZeroLength, removeParent, replaceWith, setCategoryPath, setDescription, setLastChangeTime, setLastChangeTimeInSourceArchive, setName, setNameAndCategory, setSourceArchive
-
Field Details
-
PADDING
-
ENDIAN
-
MNEMONIC
-
-
Constructor Details
-
AbstractIntegerDataType
Constructor- Parameters:
name
- a unique signed/unsigned data-type name (also used as the mnemonic)dtm
- data-type manager whose data organization should be used
-
-
Method Details
-
getFormatSettingsDefinition
Return the Format settings definition included in the settings definition array- Returns:
- Format settings definition included in the settings definition array
- See Also:
-
getBuiltInSettingsDefinitions
Description copied from class:BuiltIn
Gets a list of all the settingsDefinitions used by this datatype.- Overrides:
getBuiltInSettingsDefinitions
in classBuiltIn
- Returns:
- a list of the settingsDefinitions used by this datatype.
-
isSigned
public abstract boolean isSigned()Determine if this type is signed.- Returns:
- true if this is a signed integer data-type
-
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 classAbstractDataType
- Returns:
- the default label prefix or null if none specified.
-
getMnemonic
Description copied from interface:DataType
Get the mnemonic for this DataType.- Specified by:
getMnemonic
in interfaceDataType
- Overrides:
getMnemonic
in classAbstractDataType
- Parameters:
settings
- settings which may influence the result or null- Returns:
- the mnemonic for this DataType.
-
getAssemblyMnemonic
- Returns:
- the Assembly style data-type declaration for this data-type.
-
getCMnemonic
- Returns:
- the C style data-type mnemonic for this data-type. NOTE: currently the same as getCDeclaration().
-
getCDeclaration
- Returns:
- the C style data-type declaration for this data-type. Null is returned if no appropriate declaration exists.
-
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
- 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
-
getBitCount
Get the number of bits in the integral type- Parameters:
type
- the type- Returns:
- the number of bits
-
castValueToEncode
- Throws:
DataTypeEncodeException
-
isEncodable
public boolean isEncodable()Description copied from interface:DataType
Check if this type supports encoding (patching)If unsupported,
DataType.encodeValue(Object, MemBuffer, Settings, int)
andDataType.encodeRepresentation(String, MemBuffer, Settings, int)
will always throw an exception. Actions which rely on eitherencode
method should not be displayed if the applicable datatype is not encodable.- Specified by:
isEncodable
in interfaceDataType
- Overrides:
isEncodable
in classAbstractDataType
- Returns:
- true if encoding is supported
-
encodeValue
public byte[] encodeValue(Object value, MemBuffer buf, Settings settings, int length) throws DataTypeEncodeException Description copied from interface:DataType
Encode bytes from an Object appropriate for this DataType.Converts the given object to the byte encoding and returns it. When appropriate, this should seek the nearest encoding to the specified value, since the object may come from a user script. For example, a floating-point value may be rounded. Invalid values should be rejected with a
DataTypeEncodeException
.- Specified by:
encodeValue
in interfaceDataType
- Overrides:
encodeValue
in classAbstractDataType
- Parameters:
value
- the desired value.buf
- a buffer representing the eventual destination of the bytes.settings
- the settings to use.length
- the expected length of the result, usually the length of the data unit, or -1 to let the type choose the length. It may be ignored, e.g., for fixed-length types.- Returns:
- the encoded value.
- Throws:
DataTypeEncodeException
- if the value cannot be encoded for any reason, e.g., incorrect type, not enough space, buffer overflow, unsupported (seeDataType.isEncodable()
).
-
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 classDataTypeImpl
- 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
- 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.
-
encodeRepresentation
public byte[] encodeRepresentation(String repr, MemBuffer buf, Settings settings, int length) throws DataTypeEncodeException Description copied from interface:DataType
Encode bytes according to the display format for this type.Converts the given representation to the byte encoding and returns it. When appropriate, this should seek the nearest encoding to the specified value, since the representation is likely coming from user input. For example, a floating-point value may be rounded. Invalid representations should be rejected with a
DataTypeEncodeException
.- Specified by:
encodeRepresentation
in interfaceDataType
- Overrides:
encodeRepresentation
in classAbstractDataType
- Parameters:
repr
- the representation of the desired value, as inDataType.getRepresentation(MemBuffer, Settings, int)
. The supported formats depend on the specific datatype and its settings.buf
- a buffer representing the eventual destination of the bytes.settings
- the settings to use for the representation.length
- the expected length of the result, usually the length of the data unit, or -1 to let the type choose the length. It may be ignored, e.g., for fixed-length types.- Returns:
- the encoded value.
- Throws:
DataTypeEncodeException
- if the value cannot be encoded for any reason, e.g., incorrect format, not enough space, buffer overflow, unsupported (seeDataType.isEncodable()
).
-
hasStringValue
Description copied from interface:ArrayStringable
For cases where an array of this type exists, determines if a String value will be returned.- Specified by:
hasStringValue
in interfaceArrayStringable
- Parameters:
settings
-- Returns:
- true if array of this type with the specified settings will return a String value.
-
getArrayDefaultLabelPrefix
public String getArrayDefaultLabelPrefix(MemBuffer buf, Settings settings, int len, DataTypeDisplayOptions options) Description copied from interface:ArrayStringable
For cases where an array of this type exists, get the appropriate string to use as the default label prefix for the array.- Specified by:
getArrayDefaultLabelPrefix
in interfaceArrayStringable
- Parameters:
buf
- memory buffer containing the bytes.settings
- the Settings objectlen
- the length of the data.options
- options for how to format the default label prefix.- Returns:
- the default label prefix or null if none specified.
-
getArrayDefaultOffcutLabelPrefix
public String getArrayDefaultOffcutLabelPrefix(MemBuffer buf, Settings settings, int len, DataTypeDisplayOptions options, int offcutOffset) Description copied from interface:ArrayStringable
For cases where an array of this type exists, get the appropriate string to use as the default label prefix, taking into account the fact that there exists a reference to the data that referencesoffcutLength
bytes into this type- Specified by:
getArrayDefaultOffcutLabelPrefix
in interfaceArrayStringable
- Parameters:
buf
- memory buffer containing the bytes.settings
- the Settings object.len
- the length of the data.options
- options for how to format the default label prefix.offcutOffset
- the length of the offcut label prefix.- Returns:
- the default label prefix or null if none specified.
-
getOppositeSignednessDataType
- Returns:
- the data-type with the opposite signedness from this data-type. For example, this method on IntegerDataType will return an instance of UnsignedIntegerDataType.
-
isEquivalent
Description copied from interface:DataType
Check if the given datatype is equivalent to this datatype.The precise meaning of "equivalent" is datatype dependent.
NOTE: if invoked by a DB object or manager it should be invoked on the DataTypeDB object passing the other datatype as the argument.- Specified by:
isEquivalent
in interfaceDataType
- Overrides:
isEquivalent
in classBuiltIn
- Parameters:
dt
- the datatype being tested for equivalence.- Returns:
- true if the if the given datatype is equivalent to this datatype.
-
getSignedDataType
Get a Signed Integer data-type instance of the requested size- Parameters:
size
- data type size, sizes greater than 8 (and other than 16) will cause an SignedByteDataType[size] (i.e., Array) to be returned.dtm
- optional program data-type manager, if specified a generic data-type will be returned if possible.- Returns:
- signed integer data type
-
getSignedDataTypes
Returns all built-in signed integer data-types.- Parameters:
dtm
- optional program data-type manager, if specified generic data-types will be returned in place of fixed-sized data-types.- Returns:
- array of all signed integer types (char and bool types excluded)
-
getUnsignedDataType
Get a Unsigned Integer data-type instance of the requested size- Parameters:
size
- data type size, sizes greater than 8 (and other than 16) will cause an undefined type to be returned.dtm
- optional program data-type manager, if specified a generic data-type will be returned if possible.- Returns:
- unsigned integer data type
-
getUnsignedDataTypes
Returns all built-in unsigned integer data-types- Parameters:
dtm
- optional program data-type manager, if specified generic data-types will be returned in place of fixed-sized data-types.- Returns:
- array of all unsigned integer types (char and bool types excluded)
-