Class TypedefDataType
-
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.DataType
CONFLICT_SUFFIX, DEFAULT, NO_LAST_CHANGE_TIME, NO_SOURCE_SYNC_TIME, TYPEDEF_ATTRIBUTE_PREFIX, TYPEDEF_ATTRIBUTE_SUFFIX, VOID
-
Constructor Summary
ConstructorDescriptionTypedefDataType
(CategoryPath path, String name, DataType dt) Construct a new typedef.TypedefDataType
(CategoryPath path, String name, DataType dt, DataTypeManager dtm) Construct a new typedef.TypedefDataType
(CategoryPath path, String name, DataType dt, UniversalID universalID, SourceArchive sourceArchive, long lastChangeTime, long lastChangeTimeInSourceArchive, DataTypeManager dtm) Construct a new typedef.TypedefDataType
(String name, DataType dt) Construct a new typedef within the root category -
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.static TypeDef
clone
(TypeDef typedef, DataTypeManager dtm) copy
(DataTypeManager dtm) Returns a new instance (shallow copy) of this DataType with a new identity and no source archive association.static TypedefDataType
copy
(TypeDef typedef, DataTypeManager dtm) static void
copyTypeDefSettings
(TypeDef src, TypeDef dest, boolean clearBeforeCopy) Copy all default settings , which correspond to a TypeDefSettingsDefinition, from the specified src TypeDef to the specified dest TypeDef.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.void
Enable auto-naming for this typedef.static String
generateTypedefName
(TypeDef modelType) Generate a name for the typedef based upon its currentTypeDefSettingsDefinition
settings.int
Get the aligned-length of this datatype as a number of 8-bit bytes.Returns the non-typedef dataType that this typedef is based on, following chains of typedefs as necessary.Gets the categoryPath associated with this datatypeReturns the dataType that this typedef is based on.Returns the prefix to use for this datatype when an abbreviated prefix is desired.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.Gets the settings for this data type.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.getName()
Get the name of this datatype.getRepresentation
(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
Determine if this datatype use auto-naming (e.g., seePointerTypedef
).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 datatypetoString()
Methods inherited from class ghidra.program.model.data.GenericDataType
setNameAndCategory
Methods inherited from class ghidra.program.model.data.DataTypeImpl
addParent, equals, getAlignment, getLastChangeTime, 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, getDisplayName, getDocs, isEncodable, isNotYetDefined
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface ghidra.program.model.data.DataType
addParent, encodeRepresentation, encodeValue, getAlignment, getDataOrganization, getDataTypeManager, getDataTypePath, getDisplayName, getDocs, getLastChangeTime, getLastChangeTimeInSourceArchive, getParents, getPathName, getSourceArchive, getUniversalID, isEncodable, isNotYetDefined, removeParent, replaceWith, setDescription, setLastChangeTime, setLastChangeTimeInSourceArchive, setNameAndCategory, setSourceArchive
Methods inherited from interface ghidra.program.model.data.TypeDef
hasSameTypeDefSettings, isPointer
-
Constructor Details
-
TypedefDataType
Construct a new typedef within the root category- Parameters:
name
- name of this typedefdt
- data type that is being typedef'ed (may not be null)
-
TypedefDataType
Construct a new typedef.- Parameters:
path
- category path for this datatypename
- name of this typedefdt
- data type that is being typedef'ed (may not be null)
-
TypedefDataType
Construct a new typedef.- Parameters:
path
- category path for this datatypename
- name of this typedefdt
- data type that is being typedef'ed (may not be null)dtm
- the data type manager associated with this data type. This can be null.
-
TypedefDataType
public TypedefDataType(CategoryPath path, String name, DataType dt, UniversalID universalID, SourceArchive sourceArchive, long lastChangeTime, long lastChangeTimeInSourceArchive, DataTypeManager dtm) Construct a new typedef.- Parameters:
path
- category path for this datatypename
- name of this typedefdt
- data type that is being typedef'ed (may not be null)universalID
- the id for the data typesourceArchive
- the source archive for this data typelastChangeTime
- the last time this data type was changedlastChangeTimeInSourceArchive
- the last time this data type was changed in its source archive.dtm
- the data type manager associated with this data type. This can be null.
-
-
Method Details
-
enableAutoNaming
public void enableAutoNaming()Description copied from interface:TypeDef
Enable auto-naming for this typedef. This will force naming to reflect the name of associated datatype plus an attribute list which corresponds to anyTypeDefSettingsDefinition
settings which may be set.- Specified by:
enableAutoNaming
in interfaceTypeDef
-
isAutoNamed
public boolean isAutoNamed()Description copied from interface:TypeDef
Determine if this datatype use auto-naming (e.g., seePointerTypedef
). If true, any change to associatedTypeDefSettingsDefinition
settings or naming of the pointer-referenced datatype will cause a automatic renaming of this datatype.- Specified by:
isAutoNamed
in interfaceTypeDef
- Returns:
- true if auto-named, else false.
-
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.
-
getDefaultAbbreviatedLabelPrefix
Description copied from interface:DataType
Returns the prefix to use for this datatype when an abbreviated prefix is desired.For example, some datatypes will built a large default label, at which is is more desirable to have a shortened prefix.
- Specified by:
getDefaultAbbreviatedLabelPrefix
in interfaceDataType
- Overrides:
getDefaultAbbreviatedLabelPrefix
in classAbstractDataType
- Returns:
- the prefix to use for this datatype when an abbreviated prefix is desired. May return null.
-
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.
-
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
-
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.
-
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.
-
getDataType
Description copied from interface:TypeDef
Returns the dataType that this typedef is based on. This could be another typedef- Specified by:
getDataType
in interfaceTypeDef
- Returns:
- the datatype which this typedef is based on (may be another
TypeDef
).
-
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.
-
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.
-
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.
-
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
-
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.
-
clone
-
copy
-
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)
. -
getName
Description copied from interface:DataType
Get the name of this datatype.- Specified by:
getName
in interfaceDataType
- Overrides:
getName
in classAbstractDataType
- Returns:
- the name
-
setName
Description copied from interface:DataType
Sets the name of the datatype- Specified by:
setName
in interfaceDataType
- Overrides:
setName
in classGenericDataType
- Parameters:
name
- the new name for this datatype.- Throws:
InvalidNameException
- if the given name does not form a valid name.
-
setCategoryPath
Description copied from interface:DataType
Set the categoryPath associated with this datatype- Specified by:
setCategoryPath
in interfaceDataType
- Overrides:
setCategoryPath
in classGenericDataType
- Parameters:
path
- the new path
-
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
-
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.
-
getBaseDataType
Description copied from interface:TypeDef
Returns the non-typedef dataType that this typedef is based on, following chains of typedefs as necessary.- Specified by:
getBaseDataType
in interfaceTypeDef
- Returns:
- the datatype which this typedef is based on (will not be another
TypeDef
).
-
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.
-
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.
-
getDefaultSettings
Description copied from interface:DataType
Gets the settings for this data type. The settings may have underlying default settings and may in turn become defaults for instance-specific settings (e.g., Data or DataTypeComponent). It is important to note that these settings are tied to a specific DataType instantiation so it is important to understand the scope of its use. Example: TheBuiltInDataTypeManager
has its own set of DataType instances which are separate from those which have been instantiated or resolved to a specific Program/ArchiveDataTypeManager
. Settings manipulation may be disabled by default in some instances.- Specified by:
getDefaultSettings
in interfaceDataType
- Overrides:
getDefaultSettings
in classDataTypeImpl
- Returns:
- the settings for this dataType.
-
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
-
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.
-
toString
- Overrides:
toString
in classAbstractDataType
-
copyTypeDefSettings
Copy all default settings , which correspond to a TypeDefSettingsDefinition, from the specified src TypeDef to the specified dest TypeDef.- Parameters:
src
- settings source TypeDefdest
- settings destination TypeDefclearBeforeCopy
- if true dest default settings will be cleared before copy performed
-
generateTypedefName
Generate a name for the typedef based upon its currentTypeDefSettingsDefinition
settings.- Parameters:
modelType
- model typedef from which name should be derived- Returns:
- generated typedef auto-name with attribute specification
-