Package ghidra.program.model.data

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

All Implemented Interfaces:

DataType, TypeDef, java.util.EventListener, javax.swing.event.ChangeListener

public class TypedefDataType
extends GenericDataType
implements TypeDef

Basic implementation for the typedef dataType

Field Summary

Fields inherited from class ghidra.program.model.data.GenericDataType

packed

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)

Method Summary

Modifier and Type	Method	Description
DataType	clone(DataTypeManager dtm)	Returns a new instance of this DataType with its universalID and SourceArchive identity retained.
DataType	copy(DataTypeManager dtm)	Returns a new instance of this DataType with a new identity.
void	dataTypeDeleted(DataType dt)	Informs this dataType that the given dataType has been deleted.
void	dataTypeNameChanged(DataType dt, java.lang.String oldName)	Informs this data type that its name has changed from the indicated old name.
void	dataTypeReplaced(DataType oldDt, DataType newDt)	Informs this data type that the given oldDT has been replaced with newDT TODO: This method is reserved for internal DB use and should be removed from the public DataType interface!!
void	dataTypeSizeChanged(DataType dt)	Notification that the given dataType's size has changed.
boolean	dependsOn(DataType dt)	Returns true 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 data type.
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 data type.
boolean	isDeleted()	Returns true if this data type has been deleted and is no longer valid
boolean	isDynamicallySized()	Indicates if this data-type is dynamically sized based upon DataOrganization.
boolean	isEquivalent(DataType obj)	Returns true if the given dataType is equivalent to this dataType.
boolean	isNotYetDefined()	Indicates if type has not yet been defined.

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, notifyDeleted, notifyNameChanged, notifyReplaced, notifySizeChanged, removeParent, replaceWith, setDefaultSettings, setDescription, setLastChangeTime, setLastChangeTimeInSourceArchive, setSourceArchive, stateChanged

Methods inherited from class ghidra.program.model.data.AbstractDataType

getCategoryPath, getDataOrganization, getDataTypeManager, getDataTypePath, getDefaultAbbreviatedLabelPrefix, getDefaultLabelPrefix, getDefaultOffcutLabelPrefix, getDisplayName, getDocs, getName, toString

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, getAlignment, getCategoryPath, getDataOrganization, getDataTypeManager, getDataTypePath, getDefaultAbbreviatedLabelPrefix, getDefaultLabelPrefix, getDefaultOffcutLabelPrefix, getDefaultSettings, getDisplayName, getDocs, getLastChangeTime, getLastChangeTimeInSourceArchive, getName, getParents, getPathName, getSourceArchive, getUniversalID, removeParent, replaceWith, setCategoryPath, setDefaultSettings, setDescription, setLastChangeTime, setLastChangeTimeInSourceArchive, setName, setNameAndCategory, setSourceArchive

Constructor Detail

TypedefDataType

public TypedefDataType(java.lang.String name,
                       DataType dt)

TypedefDataType

public TypedefDataType(CategoryPath path,
                       java.lang.String name,
                       DataType dt)

Construct a new typedef.

Parameters:

name - name to use as the alias

dt - data type that is being typedef'ed

TypedefDataType

public TypedefDataType(CategoryPath path,
                       java.lang.String name,
                       DataType dt,
                       DataTypeManager dtm)

Construct a new typedef.

Parameters:

name - name to use as the alias

dt - data type that is being typedef'ed

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:

name - name to use as the alias

dt - data type that is being typedef'ed

dataTypeManager - the data type manager associated with this data type. This can be null. Also, the data type manager may not contain this actual data type.

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 interface DataType

Overrides:

getDefaultLabelPrefix in class AbstractDataType

Returns:

the default label prefix or null if none specified.

isNotYetDefined

public boolean isNotYetDefined()

Description copied from interface: DataType

Indicates if type has not yet been defined. Such types will always return a size of 1. (example: empty structure)

Specified by:

isNotYetDefined in interface DataType

Overrides:

isNotYetDefined in class AbstractDataType

Returns:

true if this type is not yet defined.

isDynamicallySized

public boolean isDynamicallySized()

Description copied from interface: DataType

Indicates if this data-type is dynamically sized based upon DataOrganization.

Specified by:

isDynamicallySized in interface DataType

Overrides:

isDynamicallySized in class AbstractDataType

isEquivalent

public boolean isEquivalent(DataType obj)

Description copied from interface: DataType

Returns true if the given dataType is equivalent to this dataType. The precise meaning of "equivalent" is dataType dependent.

Specified by:

isEquivalent in interface DataType

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 interface DataType

Overrides:

getMnemonic in class AbstractDataType

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 interface TypeDef

getDescription

public java.lang.String getDescription()

Description copied from interface: DataType

Get a String briefly describing this DataType.

Specified by:

getDescription in interface DataType

Returns:

a one-liner describing this DataType.

getLength

public int getLength()

Description copied from interface: DataType

Get the length (number of 8-bit bytes) of this DataType.

Specified by:

getLength in interface DataType

Returns:

the length of this DataType

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 interface DataType

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 data type is an AddressDT, return an Address object. a Byte, return a Scalar* (maybe this should be a Byte) a Float, return a Float

Specified by:

getValue in interface DataType

Parameters:

buf - the data buffer.

settings - the settings to use.

length - the number of bytes to get the value from.

Returns:

the data Object.

getValueClass

public java.lang.Class<?> getValueClass(Settings settings)

Description copied from interface: DataType

Get the Class of the value to be returned by this data type.

Specified by:

getValueClass in interface DataType

Overrides:

getValueClass in class DataTypeImpl

Parameters:

settings - the relevant settings to use or null for default.

Returns:

Class of the value to be returned by this data type 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 a new instance of this DataType with its universalID and SourceArchive identity retained. Note: for built-in DataType's, clone and copy should have the same affect.

Specified by:

clone in interface DataType

Parameters:

dtm - the data-type manager instance whose data-organization should apply.

copy

public DataType copy(DataTypeManager dtm)

Description copied from interface: DataType

Returns a new instance of this DataType with a new identity. Note: for built-in DataType's, clone and copy should have the same affect.

Specified by:

copy in interface DataType

Parameters:

dtm - the data-type manager instance whose data-organization should apply.

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 and should be removed from the public DataType interface!!

Specified by:

dataTypeSizeChanged in interface DataType

Overrides:

dataTypeSizeChanged in class AbstractDataType

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 interface TypeDef

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 and should be removed from the public DataType interface!!

Specified by:

dataTypeDeleted in interface DataType

Overrides:

dataTypeDeleted in class AbstractDataType

Parameters:

dt - the dataType that has been deleted.

isDeleted

public boolean isDeleted()

Description copied from interface: DataType

Returns true if this data type has been deleted and is no longer valid

Specified by:

isDeleted in interface DataType

Overrides:

isDeleted in class AbstractDataType

Returns:

true if this data type 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 data type.

Specified by:

getSettingsDefinitions in interface DataType

Overrides:

getSettingsDefinitions in class DataTypeImpl

Returns:

a list of the settingsDefinitions used by this data type.

dataTypeReplaced

public void dataTypeReplaced(DataType oldDt,
                             DataType newDt)

Description copied from interface: DataType

Informs this data type that the given oldDT has been replaced with newDT
TODO: This method is reserved for internal DB use and should be removed from the public DataType interface!!

Specified by:

dataTypeReplaced in interface DataType

Overrides:

dataTypeReplaced in class AbstractDataType

Parameters:

oldDt - old data type

newDt - new data type

dataTypeNameChanged

public void dataTypeNameChanged(DataType dt,
                                java.lang.String oldName)

Description copied from interface: DataType

Informs this data type that its name has changed from the indicated old name.
TODO: This method is reserved for internal DB use and should be removed from the public DataType interface!!

Specified by:

dataTypeNameChanged in interface DataType

Overrides:

dataTypeNameChanged in class AbstractDataType

Parameters:

dt - the data type whose name changed

oldName - the data type's old name

dependsOn

public boolean dependsOn(DataType dt)

Description copied from interface: DataType

Returns true 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 interface DataType

Overrides:

dependsOn in class AbstractDataType

Parameters:

dt - the dataType to test that this dataType depends on.