Package ghidra.program.model.data

Class MissingBuiltInDataType

java.lang.Object

ghidra.program.model.data.AbstractDataType

ghidra.program.model.data.DataTypeImpl

ghidra.program.model.data.MissingBuiltInDataType

All Implemented Interfaces:

BuiltInDataType, DataType, Dynamic, ExtensionPoint

public class MissingBuiltInDataType
extends DataTypeImpl
implements Dynamic

Provides an implementation of a data type that stands-in for a missing Built-In data type.

This field is not meant to be loaded by the ClassSearcher, hence the X in the name.

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

Constructors

Constructor	Description
MissingBuiltInDataType(CategoryPath path, String missingBuiltInName, String missingBuiltInClassPath, DataTypeManager dtm)	Construct a Missing Data Type

Method Summary

Modifier and Type	Method	Description
boolean	canSpecifyLength()	Determine if the length may be specified for an instanceof this datatype (e.g., Data, Array, DataTypeComponent, etc.).
DataType	clone(DataTypeManager dtm)	Returns an instance of this DataType using the specified DataTypeManager to allow its use of the corresponding DataOrganization while retaining its unique identity (see DataType.getUniversalID() and archive association (see DataType.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	dataTypeDeleted(DataType dt)	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 newDT
void	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.
String	getCTypeDeclaration(DataOrganization dataOrganization)	Generate a suitable C-type declaration for this data-type as a #define or typedef.
String	getDescription()	Get a String briefly describing this DataType.
long	getLastChangeTime()	Get the timestamp corresponding to the last time this type was changed within its datatype manager
int	getLength()	Get the length of this DataType as a number of 8-bit bytes.
int	getLength(MemBuffer buf, int maxLength)	Compute the length for this data-type which corresponds to the specified memory location.
String	getMissingBuiltInClassPath()	Returns classpath of missing built-in datatype for which this type is standing-in for
String	getMissingBuiltInName()	Returns name of missing built-in datatype for which this type is standing-in for
String	getMnemonic(Settings settings)	Get the mnemonic for this DataType.
DataType	getReplacementBaseType()	Returns a suitable replacement base data-type for pointers and arrays when exporting to C code
String	getRepresentation(MemBuffer buf, Settings settings, int length)	Get bytes from memory in a printable format for this type.
Object	getValue(MemBuffer buf, Settings settings, int length)	Returns the interpreted data value as an instance of the advertised value class.
boolean	isEquivalent(DataType dt)	Check if the given datatype is equivalent to this datatype.
protected void	setCategory()	set the category for this data type
void	setCategoryPath(CategoryPath path)	Set the categoryPath associated with this datatype
void	setDefaultSettings(Settings settings)	Set the default settings for this data type.
void	setName(String name)	Sets the name of the datatype
void	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, getAlignedLength, getAlignment, getDefaultSettings, getLastChangeTimeInSourceArchive, getParents, getPathName, getSettingsDefinitions, getSourceArchive, getUniversalID, getValueClass, hashCode, notifyAlignmentChanged, notifyDeleted, notifyNameChanged, notifyParents, notifyReplaced, notifySizeChanged, removeParent, replaceWith, setDescription, setLastChangeTime, setLastChangeTimeInSourceArchive, setSourceArchive

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

dataTypeAlignmentChanged, encodeRepresentation, encodeValue, getCategoryPath, getDataOrganization, getDataOrganization, getDataTypeManager, getDataTypePath, getDefaultAbbreviatedLabelPrefix, getDefaultLabelPrefix, getDefaultLabelPrefix, getDefaultOffcutLabelPrefix, getDisplayName, getDocs, getName, getTypeDefSettingsDefinitions, hasLanguageDependantLength, isDeleted, isEncodable, 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.DataType

addParent, dataTypeAlignmentChanged, encodeRepresentation, encodeValue, getAlignedLength, getAlignment, getCategoryPath, getDataOrganization, getDataTypeManager, getDataTypePath, getDefaultAbbreviatedLabelPrefix, getDefaultLabelPrefix, getDefaultLabelPrefix, getDefaultOffcutLabelPrefix, getDefaultSettings, getDisplayName, getDocs, getLastChangeTimeInSourceArchive, getName, getParents, getPathName, getSettingsDefinitions, getSourceArchive, getTypeDefSettingsDefinitions, getUniversalID, getValueClass, hasLanguageDependantLength, isDeleted, isEncodable, isNotYetDefined, isZeroLength, removeParent, replaceWith, setDescription, setLastChangeTime, setLastChangeTimeInSourceArchive, setSourceArchive

Constructor Details

MissingBuiltInDataType

public MissingBuiltInDataType(CategoryPath path,
 String missingBuiltInName,
 String missingBuiltInClassPath,
 DataTypeManager dtm)

Construct a Missing Data Type

Parameters:

path - category path

missingBuiltInName - name of missing built-in datatype for which this will standin for.

missingBuiltInClassPath - classpath of missing built-in datatype for which this will standin for.

Method Details

setCategory

protected void setCategory()

set the category for this data type

getMissingBuiltInName

public String getMissingBuiltInName()

Returns name of missing built-in datatype for which this type is standing-in for

getMissingBuiltInClassPath

public String getMissingBuiltInClassPath()

Returns classpath of missing built-in datatype for which this type is standing-in for

getMnemonic

public 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

Parameters:

settings - settings which may influence the result or null

Returns:

the mnemonic for this DataType.

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 its aligned-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 if DataType.isZeroLength(), and only Dynamic/FactoryDataType datatypes should return -1. If DataType.isZeroLength() is true a length of 1 should be returned. Where a zero-length datatype can be handled (e.g., Composite) the DataType.isZeroLength() method should be used.

Specified by:

getLength in interface DataType

Returns:

the length of this DataType

canSpecifyLength

public boolean canSpecifyLength()

Description copied from interface: Dynamic

Determine if the length may be specified for an instanceof this datatype (e.g., Data, Array, DataTypeComponent, etc.).

Specified by:

canSpecifyLength in interface Dynamic

Returns:

true if a user-specified length can be used, else false

getLength

public int getLength(MemBuffer buf,
 int maxLength)

Description copied from interface: Dynamic

Compute the length for this data-type which corresponds to the specified memory location.

Specified by:

getLength in interface Dynamic

Parameters:

buf - memory location

maxLength - maximum number of bytes to consume in computing length, or -1 for unspecified.

Returns:

data length or -1 if it could not be determined. Returned length may exceed maxLength if data-type does not supported constrained lengths.

See Also:

• Dynamic.getLength(ghidra.program.model.mem.MemBuffer, int)

getDescription

public 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.

getRepresentation

public 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 Object getValue(MemBuffer buf,
 Settings settings,
 int length)

Description copied from interface: DataType

Returns the interpreted data value as an instance of the advertised value class.

For instance, Pointer data types should return an Address object (or null), or integer data types should return a Scalar object.

Specified by:

getValue in interface DataType

Parameters:

buf - the data buffer

settings - the settings to use.

length - indicates the maximum number of bytes that may be consumed by a Dynamic 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

clone

public DataType clone(DataTypeManager dtm)

Description copied from interface: DataType

Returns an instance of this DataType using the specified DataTypeManager to allow its use of the corresponding DataOrganization while retaining its unique identity (see DataType.getUniversalID() and archive association (see DataType.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.

Specified by:

clone in interface DataType

Parameters:

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

Returns:

cloned instance which may be the same as this instance

copy

public final DataType copy(DataTypeManager dtm)

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).

Specified by:

copy in interface DataType

Parameters:

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

Returns:

new instanceof of this datatype

See Also:

• DataType.copy(ghidra.program.model.data.DataTypeManager)

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

Overrides:

dataTypeDeleted in class AbstractDataType

Parameters:

dt - the datatype that has been deleted.

dataTypeNameChanged

public void dataTypeNameChanged(DataType dt,
 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 interface DataType

Overrides:

dataTypeNameChanged in class AbstractDataType

Parameters:

dt - the datatype whose name changed

oldName - the datatype's old name

dataTypeReplaced

public void dataTypeReplaced(DataType oldDt,
 DataType newDt)

Description copied from interface: DataType

Informs this datatype that the given oldDT has been replaced with newDT

TODO: This method is reserved for internal DB use.

Specified by:

dataTypeReplaced in interface DataType

Overrides:

dataTypeReplaced in class AbstractDataType

Parameters:

oldDt - old datatype

newDt - new datatype

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

Overrides:

dataTypeSizeChanged in class AbstractDataType

Parameters:

dt - the datatype that has changed.

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

Overrides:

dependsOn in class AbstractDataType

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.

isEquivalent

public boolean isEquivalent(DataType dt)

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

Parameters:

dt - the datatype being tested for equivalence.

Returns:

true if the if the given datatype is equivalent to this datatype.

setCategoryPath

public void setCategoryPath(CategoryPath path)
                     throws DuplicateNameException

Description copied from interface: DataType

Set the categoryPath associated with this datatype

Specified by:

setCategoryPath in interface DataType

Overrides:

setCategoryPath in class AbstractDataType

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.

setName

public void setName(String name)
             throws InvalidNameException

Description copied from interface: DataType

Sets the name of the datatype

Specified by:

setName in interface DataType

Overrides:

setName in class AbstractDataType

Parameters:

name - the new name for this datatype.

Throws:

InvalidNameException - if the given name does not form a valid name.

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

Overrides:

setNameAndCategory in class AbstractDataType

Parameters:

path - the new category path.

name - the new name

Throws:

InvalidNameException - if the name is invalid

DuplicateNameException - if name change on stored DataType is a duplicate of another datatype within the same category (only applies to DB stored DataType).

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

Overrides:

getLastChangeTime in class DataTypeImpl

Returns:

timestamp of last change within datatype manager

getCTypeDeclaration

public String getCTypeDeclaration(DataOrganization dataOrganization)

Description copied from interface: BuiltInDataType

Generate a suitable C-type declaration for this data-type as a #define or typedef. Since the length of a Dynamic datatype is unknown, such datatypes should only be referenced in C via a pointer. FactoryDataTypes should never be referenced and will always return null.

Specified by:

getCTypeDeclaration in interface BuiltInDataType

Parameters:

dataOrganization - or null for default

Returns:

definition C-statement (e.g., #define or typedef) or null if type name is a standard C-primitive name or if type is FactoryDataType or Dynamic.

See Also:

• BuiltInDataType.getCTypeDeclaration(ghidra.program.model.data.DataOrganization)

getReplacementBaseType

public DataType getReplacementBaseType()

Description copied from interface: Dynamic

Returns a suitable replacement base data-type for pointers and arrays when exporting to C code

Specified by:

getReplacementBaseType in interface Dynamic

Returns:

suitable base data-type for this Dynamic data-type

setDefaultSettings

public void setDefaultSettings(Settings settings)

Description copied from interface: BuiltInDataType

Set the default settings for this data type.
NOTE: This method is reserved for internal DB use.

Specified by:

setDefaultSettings in interface BuiltInDataType

Parameters:

settings - the settings to be used as this dataTypes default settings.