Class TypedefDataType
- java.lang.Object
-
- ghidra.program.model.data.AbstractDataType
-
- ghidra.program.model.data.DataTypeImpl
-
- ghidra.program.model.data.GenericDataType
-
- ghidra.program.model.data.TypedefDataType
-
public class TypedefDataType extends GenericDataType implements TypeDef
Basic implementation for the typedef dataType
-
-
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, VOID
-
-
Constructor Summary
Constructors Constructor Description TypedefDataType(CategoryPath path, java.lang.String name, DataType dt)
Construct a new typedef.TypedefDataType(CategoryPath path, java.lang.String name, DataType dt, DataTypeManager dtm)
Construct a new typedef.TypedefDataType(CategoryPath path, java.lang.String name, DataType dt, UniversalID universalID, SourceArchive sourceArchive, long lastChangeTime, long lastChangeTimeInSourceArchive, DataTypeManager dtm)
Construct a new typedef.TypedefDataType(java.lang.String name, DataType dt)
Construct a new typedef within the root category
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description DataType
clone(DataTypeManager dtm)
Returns an instance of this DataType with its universalID and SourceArchive identity retained.DataType
copy(DataTypeManager dtm)
Returns a new instance (shallow copy) of this DataType with a new identity.void
dataTypeAlignmentChanged(DataType dt)
Notification that the given datatype's alignment has changed.void
dataTypeDeleted(DataType dt)
Informs this datatype that the given datatype has been deleted.void
dataTypeNameChanged(DataType dt, java.lang.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
dataTypeSizeChanged(DataType dt)
Notification that the given datatype's size has changed.boolean
dependsOn(DataType dt)
Check if this datatype depends on the existence of the given datatype.DataType
getBaseDataType()
Returns the non-typedef dataType that this typedef is based on, following chains of typedefs as necessary.DataType
getDataType()
Returns the dataType that this typedef is based on.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.java.lang.String
getRepresentation(MemBuffer buf, Settings settings, int length)
Get bytes from memory in a printable format for this type.SettingsDefinition[]
getSettingsDefinitions()
Gets a list of all the settingsDefinitions used by this datatype.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 datatype.boolean
hasLanguageDependantLength()
Indicates if the length of this data-type is determined based upon theDataOrganization
obtained from the associatedDataTypeManager
.boolean
isDeleted()
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
isZeroLength()
Indicates this datatype is defined with a zero length.java.lang.String
toString()
-
Methods inherited from class ghidra.program.model.data.GenericDataType
setCategoryPath, setName, setNameAndCategory
-
Methods inherited from class ghidra.program.model.data.DataTypeImpl
addParent, equals, getAlignment, getDefaultSettings, getLastChangeTime, getLastChangeTimeInSourceArchive, getParents, getPathName, getSourceArchive, getUniversalID, hashCode, notifyAlignmentChanged, notifyDeleted, notifyNameChanged, notifyParents, notifyReplaced, notifySizeChanged, removeParent, replaceWith, setDefaultSettings, setDescription, setLastChangeTime, setLastChangeTimeInSourceArchive, setSourceArchive
-
Methods inherited from class ghidra.program.model.data.AbstractDataType
encodeRepresentation, encodeValue, getCategoryPath, getDataOrganization, getDataTypeManager, getDataTypePath, getDefaultAbbreviatedLabelPrefix, getDefaultLabelPrefix, getDefaultOffcutLabelPrefix, getDisplayName, getDocs, getName, 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, getCategoryPath, getDataOrganization, getDataTypeManager, getDataTypePath, getDefaultAbbreviatedLabelPrefix, getDefaultLabelPrefix, getDefaultOffcutLabelPrefix, getDefaultSettings, getDisplayName, getDocs, getLastChangeTime, getLastChangeTimeInSourceArchive, getName, getParents, getPathName, getSourceArchive, getUniversalID, isEncodable, isNotYetDefined, removeParent, replaceWith, setCategoryPath, setDefaultSettings, setDescription, setLastChangeTime, setLastChangeTimeInSourceArchive, setName, setNameAndCategory, setSourceArchive
-
-
-
-
Constructor Detail
-
TypedefDataType
public TypedefDataType(java.lang.String name, DataType dt)
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
public TypedefDataType(CategoryPath path, java.lang.String name, DataType dt)
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
public TypedefDataType(CategoryPath path, java.lang.String name, DataType dt, 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)dtm
- the data type manager associated with this data type. This can be null.
-
TypedefDataType
public TypedefDataType(CategoryPath path, java.lang.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 Detail
-
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 interfaceDataType
- Overrides:
getDefaultLabelPrefix
in classAbstractDataType
- Returns:
- the default label prefix or null if none specified.
-
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
public boolean isEquivalent(DataType obj)
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
public java.lang.String getMnemonic(Settings settings)
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
public 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
-
getDescription
public java.lang.String 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 (number of 8-bit bytes) of this DataType.NOTE: No datatype should ever return 0, even if
DataType.isZeroLength()
, and onlyDynamic
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.
-
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 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
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 datatype is an AddressDT, return an Address object. a Byte, return a Scalar* (maybe this should be a Byte) a Float, return a Float
-
getValueClass
public java.lang.Class<?> getValueClass(Settings settings)
Description copied from interface:DataType
Get the Class of the value to be returned by this datatype.- 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
public DataType clone(DataTypeManager dtm)
Description copied from interface:DataType
Returns an instance of this DataType with its universalID and SourceArchive identity retained.The current instanceof 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.
-
copy
public DataType copy(DataTypeManager dtm)
Description copied from interface:DataType
Returns a new instance (shallow copy) of this DataType with a new identity.Any reference to other datatypes will use
DataType.clone(DataTypeManager)
.
-
dataTypeSizeChanged
public void dataTypeSizeChanged(DataType dt)
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
public void dataTypeAlignmentChanged(DataType dt)
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
public DataType 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
-
dataTypeDeleted
public void dataTypeDeleted(DataType dt)
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
public SettingsDefinition[] getSettingsDefinitions()
Description copied from interface:DataType
Gets a list of all the settingsDefinitions used by this datatype.- Specified by:
getSettingsDefinitions
in interfaceDataType
- Overrides:
getSettingsDefinitions
in classDataTypeImpl
- Returns:
- a list of the settingsDefinitions used by this datatype.
-
dataTypeReplaced
public void dataTypeReplaced(DataType oldDt, DataType newDt)
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
public void dataTypeNameChanged(DataType dt, java.lang.String oldName)
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
public boolean dependsOn(DataType dt)
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
public java.lang.String toString()
- Overrides:
toString
in classAbstractDataType
-
-