Class ArrayDataType
FactoryDataType
and Dynamic
, where
Dynamic.canSpecifyLength()
is false, are not supported for array use.-
Field Summary
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.Array
ARRAY_LABEL_PREFIX
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
ConstructorDescriptionArrayDataType
(DataType dataType, int numElements) Constructs a new Array dataType for fixed-length datatypes.ArrayDataType
(DataType dataType, int numElements, int elementLength) Constructs a new Array dataType.ArrayDataType
(DataType dataType, int numElements, int elementLength, DataTypeManager dataMgr) Constructs a new Array dataType. -
Method Summary
Modifier and TypeMethodDescriptionfinal DataType
clone
(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.final DataType
copy
(DataTypeManager dtm) Returns a new instance (shallow copy) of this DataType with a new identity and no source archive association.void
Notification that the given datatype's alignment has changed.void
Informs this datatype that the given datatype has been deleted.void
dataTypeNameChanged
(DataType dt, String oldName) Informs this datatype that its name has changed from the indicated old name.void
dataTypeReplaced
(DataType oldDt, DataType newDt) Informs this datatype that the given oldDT has been replaced with newDTvoid
Notification that the given datatype's size has changed.boolean
Check if this datatype depends on the existence of the given datatype.int
Get the aligned-length of this datatype as a number of 8-bit bytes.Gets the categoryPath associated with this datatypeReturns the dataType of the elements in the array.Returns the appropriate string to use as the default label prefix in the absence of any data.getDefaultLabelPrefix
(MemBuffer buf, Settings settings, int len, DataTypeDisplayOptions options) Returns the appropriate string to use as the default label prefix.getDefaultOffcutLabelPrefix
(MemBuffer buf, Settings settings, int len, DataTypeDisplayOptions options, int offcutLength) Returns the appropriate string to use as the default label prefix.Get a String briefly describing this DataType.int
Returns the length of an element in the array.long
Get the timestamp corresponding to the last time this type was changed within its datatype managerint
Get the length of this DataType as a number of 8-bit bytes.getMnemonic
(Settings settings) Get the mnemonic for this DataType.int
Returns the number of elements in the arraygetRepresentation
(MemBuffer buf, Settings settings, int length) Get bytes from memory in a printable format for this type.Get the list of settings definitions available for use with this datatype.Get the list of all settings definitions for this datatype that may be used for an associatedTypeDef
.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)
).boolean
Indicates if the length of this data-type is determined based upon theDataOrganization
obtained from the associatedDataTypeManager
.boolean
Returns true if this datatype has been deleted and is no longer validboolean
isEquivalent
(DataType obj) Check if the given datatype is equivalent to this datatype.boolean
Indicates this datatype is defined with a zero length.void
setCategoryPath
(CategoryPath path) Set the categoryPath associated with this datatypevoid
Sets the name of the datatypevoid
setNameAndCategory
(CategoryPath path, String name) Sets the name and category of a datatype at the same time.Methods inherited from class ghidra.program.model.data.DataTypeImpl
addParent, equals, getAlignment, getDefaultSettings, getLastChangeTimeInSourceArchive, getParents, getPathName, getSourceArchive, getUniversalID, hashCode, notifyAlignmentChanged, notifyDeleted, notifyNameChanged, notifyParents, notifyReplaced, notifySizeChanged, removeParent, replaceWith, setDescription, setLastChangeTime, setLastChangeTimeInSourceArchive, setSourceArchive
Methods inherited from class ghidra.program.model.data.AbstractDataType
encodeRepresentation, encodeValue, getDataOrganization, getDataOrganization, getDataTypeManager, getDataTypePath, getDefaultAbbreviatedLabelPrefix, getDisplayName, getDocs, getName, isEncodable, 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.Array
getArrayDefaultLabelPrefix, getArrayDefaultOffcutLabelPrefix, getArrayRepresentation, getArrayValue, getArrayValueClass
Methods inherited from interface ghidra.program.model.data.DataType
addParent, encodeRepresentation, encodeValue, getAlignment, getDataOrganization, getDataTypeManager, getDataTypePath, getDefaultAbbreviatedLabelPrefix, getDefaultSettings, getDisplayName, getDocs, getLastChangeTimeInSourceArchive, getName, getParents, getPathName, getSourceArchive, getUniversalID, isEncodable, isNotYetDefined, removeParent, replaceWith, setDescription, setLastChangeTime, setLastChangeTimeInSourceArchive, setSourceArchive
-
Constructor Details
-
ArrayDataType
Constructs a new Array dataType for fixed-length datatypes. The specified datatype'sDataTypeManager
will be used for its data organization.- Parameters:
dataType
- the dataType of the elements in the array (FactoryDataType
andDynamic
data types are not permitted).numElements
- the number of elements in the array (0 is permitted).- Throws:
IllegalArgumentException
- if invalid datatype is specified or required validelementLength
required.
-
ArrayDataType
Constructs a new Array dataType. The specified datatype'sDataTypeManager
will be used for its data organization.- Parameters:
dataType
- the dataType of the elements in the array.FactoryDataType
andDynamic
, whereDynamic.canSpecifyLength()
is false, are not not permitted.numElements
- the number of elements in the array (0 is permitted).elementLength
- the length of an individual element in the array. This value is only used forDynamic
dataType whereDynamic.canSpecifyLength()
returns true. A -1 value can be specified for fixed-length datatypes.- Throws:
IllegalArgumentException
- if invalid datatype is specified or required validelementLength
required.
-
ArrayDataType
public ArrayDataType(DataType dataType, int numElements, int elementLength, DataTypeManager dataMgr) Constructs a new Array dataType.- Parameters:
dataType
- the dataType of the elements in the array.FactoryDataType
andDynamic
, whereDynamic.canSpecifyLength()
is false, are not not permitted.numElements
- the number of elements in the array (0 is permitted).elementLength
- the length of an individual element in the array. This value is only used forDynamic
dataType whereDynamic.canSpecifyLength()
returns true. A -1 value can be specified for fixed-length datatypes.dataMgr
- datatype manager or null. If null, the datatype manager associated with the specified datatype will be used.- Throws:
IllegalArgumentException
- if invalid datatype is specified or required validelementLength
required.
-
-
Method Details
-
hasLanguageDependantLength
public boolean hasLanguageDependantLength()Description copied from interface:DataType
Indicates if the length of this data-type is determined based upon theDataOrganization
obtained from the associatedDataTypeManager
.- Specified by:
hasLanguageDependantLength
in interfaceDataType
- Overrides:
hasLanguageDependantLength
in classAbstractDataType
- Returns:
- true length is language/compiler-specification dependent, else false
-
getSettingsDefinitions
Description copied from interface:DataType
Get the list of settings definitions available for use with this datatype.In the case of a
TypeDef
, the return list will include theTypeDefSettingsDefinition
list from the associated base data type.Unlike
TypeDefSettingsDefinition
standard settings definitions generally support default, component-default and data-instance use. In addition, standard settings definitions are never considered duringDataType.isEquivalent(DataType)
checking or during the resolve process.- Specified by:
getSettingsDefinitions
in interfaceDataType
- Overrides:
getSettingsDefinitions
in classDataTypeImpl
- Returns:
- list of the settings definitions for this datatype.
-
getTypeDefSettingsDefinitions
Description copied from interface:DataType
Get the list of all settings definitions for this datatype that may be used for an associatedTypeDef
. When used for an associatedTypeDef
, these settings will be considered during aDataType.isEquivalent(DataType)
check and will be preserved during the resolve process.- Specified by:
getTypeDefSettingsDefinitions
in interfaceDataType
- Overrides:
getTypeDefSettingsDefinitions
in classAbstractDataType
- Returns:
- a list of the settings definitions for a
TypeDef
associated with this datatype.
-
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
- Parameters:
obj
- the datatype being tested for equivalence.- Returns:
- true if the if the given datatype is equivalent to this datatype.
-
getNumElements
public int getNumElements()Description copied from interface:Array
Returns the number of elements in the array- Specified by:
getNumElements
in interfaceArray
- Returns:
- the number of elements in the array
-
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.
-
isZeroLength
public boolean isZeroLength()Description copied from interface:DataType
Indicates this datatype is defined with a zero length.This method should not be confused with
DataType.isNotYetDefined()
which indicates that nothing but the name and basic type is known.NOTE: a zero-length datatype must return a length of 1 via
DataType.getLength()
. Zero-length datatypes used as a component within aComposite
may, or may not, be assigned a component length of 0. The methodDataTypeComponent.usesZeroLengthComponent(DataType)
is used to make this determination.- Specified by:
isZeroLength
in interfaceDataType
- Overrides:
isZeroLength
in classAbstractDataType
- Returns:
- true if type definition has a length of 0, else false
-
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. -
getAlignedLength
public int getAlignedLength()Description copied from interface:DataType
Get the aligned-length of this datatype as a number of 8-bit bytes.For primitive datatypes this is equivalent to the C/C++ "sizeof" operation within source code and should be used when determining
Array
element length or component sizing for aComposite
. ForPointer
,Composite
andArray
types this will return the same value asDataType.getLength()
.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
/FunctionDefinition
datatypes should return -1. IfDataType.isZeroLength()
is true a length of 1 should be returned.- Specified by:
getAlignedLength
in interfaceDataType
- Overrides:
getAlignedLength
in classDataTypeImpl
- Returns:
- byte length of binary encoding.
-
getDescription
Description copied from interface:DataType
Get a String briefly describing this DataType.- Specified by:
getDescription
in interfaceDataType
- Returns:
- a one-liner describing this DataType.
-
getDataType
Description copied from interface:Array
Returns the dataType of the elements in the array.- Specified by:
getDataType
in interfaceArray
- Returns:
- the dataType of the elements in the array
-
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. -
copy
Description copied from interface:DataType
Returns a new instance (shallow copy) of this DataType with a new identity and no source archive association.Any reference to other datatypes will use
DataType.clone(DataTypeManager)
. -
dataTypeSizeChanged
Description copied from interface:DataType
Notification that the given datatype's size has changed.DataTypes may need to make internal changes in response.
TODO: This method is reserved for internal DB use.- Specified by:
dataTypeSizeChanged
in interfaceDataType
- Overrides:
dataTypeSizeChanged
in classAbstractDataType
- Parameters:
dt
- the datatype that has changed.
-
dataTypeAlignmentChanged
Description copied from interface:DataType
Notification that the given datatype's alignment has changed.DataTypes may need to make internal changes in response.
TODO: This method is reserved for internal DB use.- Specified by:
dataTypeAlignmentChanged
in interfaceDataType
- Overrides:
dataTypeAlignmentChanged
in classAbstractDataType
- Parameters:
dt
- the datatype that has changed.
-
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.
-
setName
Description copied from interface:DataType
Sets the name of the datatype- Specified by:
setName
in interfaceDataType
- Overrides:
setName
in classAbstractDataType
- Parameters:
name
- the new name for this datatype.- Throws:
InvalidNameException
- if the given name does not form a valid name.
-
getElementLength
public int getElementLength()Description copied from interface:Array
Returns the length of an element in the array. In the case of a Dynamic base datatype, this element length will have been explicitly specified at the time of construction. For a zero-length base type an element length of 1 will be reported withDataType.getLength()
returning the number of elements.- Specified by:
getElementLength
in interfaceArray
- Returns:
- the length of one element in the array.
-
dataTypeDeleted
Description copied from interface:DataType
Informs this datatype that the given datatype has been deleted.TODO: This method is reserved for internal DB use.
- Specified by:
dataTypeDeleted
in interfaceDataType
- Overrides:
dataTypeDeleted
in classAbstractDataType
- Parameters:
dt
- the datatype that has been deleted.
-
isDeleted
public boolean isDeleted()Description copied from interface:DataType
Returns true if this datatype has been deleted and is no longer valid- Specified by:
isDeleted
in interfaceDataType
- Overrides:
isDeleted
in classAbstractDataType
- Returns:
- true if this datatype has been deleted and is no longer valid.
-
dataTypeReplaced
Description copied from interface:DataType
Informs this datatype that the given oldDT has been replaced with newDTTODO: This method is reserved for internal DB use.
- Specified by:
dataTypeReplaced
in interfaceDataType
- Overrides:
dataTypeReplaced
in classAbstractDataType
- Parameters:
oldDt
- old datatypenewDt
- new datatype
-
setCategoryPath
Description copied from interface:DataType
Set the categoryPath associated with this datatype- Specified by:
setCategoryPath
in interfaceDataType
- Overrides:
setCategoryPath
in classAbstractDataType
- Parameters:
path
- the new path- Throws:
DuplicateNameException
- if an attempt to place this datatype into the specified category resulted in a name collision. This should not occur for non-DB DataType instances.
-
setNameAndCategory
public void setNameAndCategory(CategoryPath path, String name) throws InvalidNameException, DuplicateNameException Description copied from interface:DataType
Sets the name and category of a datatype at the same time.- Specified by:
setNameAndCategory
in interfaceDataType
- Overrides:
setNameAndCategory
in classAbstractDataType
- Parameters:
path
- the new category path.name
- the new name- Throws:
InvalidNameException
- if the name is invalidDuplicateNameException
- if name change on storedDataType
is a duplicate of another datatype within the same category (only applies to DB storedDataType
).
-
getCategoryPath
Description copied from interface:DataType
Gets the categoryPath associated with this datatype- Specified by:
getCategoryPath
in interfaceDataType
- Overrides:
getCategoryPath
in classAbstractDataType
- Returns:
- the datatype's category path
-
dataTypeNameChanged
Description copied from interface:DataType
Informs this datatype that its name has changed from the indicated old name.TODO: This method is reserved for internal DB use.
- Specified by:
dataTypeNameChanged
in interfaceDataType
- Overrides:
dataTypeNameChanged
in classAbstractDataType
- Parameters:
dt
- the datatype whose name changedoldName
- the datatype's old name
-
dependsOn
Description copied from interface:DataType
Check if this datatype depends on the existence of the given datatype.For example byte[] depends on byte. If byte were deleted, then byte[] would also be deleted.
- Specified by:
dependsOn
in interfaceDataType
- Overrides:
dependsOn
in classAbstractDataType
- Parameters:
dt
- the datatype to test that this datatype depends on.- Returns:
- true if the existence of this datatype relies on the existence of the specified datatype dt.
-
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.
-
getDefaultLabelPrefix
public String getDefaultLabelPrefix(MemBuffer buf, Settings settings, int len, DataTypeDisplayOptions options) Description copied from interface:DataType
Returns the appropriate string to use as the default label prefix.- Specified by:
getDefaultLabelPrefix
in interfaceDataType
- Overrides:
getDefaultLabelPrefix
in classAbstractDataType
- 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.
-
getDefaultOffcutLabelPrefix
public String getDefaultOffcutLabelPrefix(MemBuffer buf, Settings settings, int len, DataTypeDisplayOptions options, int offcutLength) Description copied from interface:DataType
Returns the appropriate string to use as the default label prefix.This takes into account the fact that there exists a reference to the data that references
offcutLength
bytes into this type- Specified by:
getDefaultOffcutLabelPrefix
in interfaceDataType
- Overrides:
getDefaultOffcutLabelPrefix
in classAbstractDataType
- 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.offcutLength
- offset into datatype- Returns:
- the default label prefix.
-
getLastChangeTime
public long getLastChangeTime()Description copied from interface:DataType
Get the timestamp corresponding to the last time this type was changed within its datatype manager- Specified by:
getLastChangeTime
in interfaceDataType
- Overrides:
getLastChangeTime
in classDataTypeImpl
- Returns:
- timestamp of last change within datatype manager
-
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
-
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.
-