Package ghidra.program.model.data

Class AIFFDataType

java.lang.Object

ghidra.program.model.data.AbstractDataType

ghidra.program.model.data.DataTypeImpl

ghidra.program.model.data.BuiltIn

ghidra.program.model.data.AIFFDataType

All Implemented Interfaces:

BuiltInDataType, DataType, Dynamic, ExtensionPoint

public class AIFFDataType
extends BuiltIn
implements Dynamic

Field Summary

Fields

Modifier and Type	Field	Description
static byte[]	MAGIC
static byte[]	MAGIC_MASK

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
AIFFDataType()
AIFFDataType(DataTypeManager dtm)

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.
String	getDefaultLabelPrefix(MemBuffer buf, Settings settings, int len, DataTypeDisplayOptions options)	Returns the appropriate string to use as the default label prefix.
String	getDescription()	Get a String briefly describing this DataType.
int	getLength()	Get the length (number of 8-bit bytes) of this DataType.
int	getLength(MemBuffer buf, int maxLength)	Compute the length for this data-type which corresponds to the specified memory location.
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)	Get the interpretted data value in the form of the appropriate Object for this DataType.
Class<?>	getValueClass(Settings settings)	Get the Class of the value Object to be returned by this datatype (see DataType.getValue(MemBuffer, Settings, int)).

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

addParent, copy, dataTypeDeleted, dataTypeNameChanged, dataTypeReplaced, dataTypeSizeChanged, dependsOn, getBuiltInSettingsDefinitions, getCTypeDeclaration, getCTypeDeclaration, getCTypeDeclaration, getCTypeDeclaration, getDecompilerDisplayName, getLastChangeTime, getSettingsDefinitions, getUniversalID, isEquivalent, removeParent, setCategoryPath, setDefaultSettings, setName, setNameAndCategory

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

equals, getAlignment, getDefaultSettings, getLastChangeTimeInSourceArchive, getParents, getPathName, getSourceArchive, hashCode, notifyAlignmentChanged, notifyDeleted, notifyNameChanged, notifyParents, notifyReplaced, notifySizeChanged, replaceWith, setDescription, setLastChangeTime, setLastChangeTimeInSourceArchive, setSourceArchive

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

dataTypeAlignmentChanged, encodeRepresentation, encodeValue, getCategoryPath, getDataOrganization, getDataTypeManager, getDataTypePath, getDefaultAbbreviatedLabelPrefix, 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.BuiltInDataType

getCTypeDeclaration, setDefaultSettings

Methods inherited from interface ghidra.program.model.data.DataType

addParent, copy, dataTypeAlignmentChanged, dataTypeDeleted, dataTypeNameChanged, dataTypeReplaced, dataTypeSizeChanged, dependsOn, encodeRepresentation, encodeValue, getAlignment, getCategoryPath, getDataOrganization, getDataTypeManager, getDataTypePath, getDefaultAbbreviatedLabelPrefix, getDefaultLabelPrefix, getDefaultOffcutLabelPrefix, getDefaultSettings, getDisplayName, getDocs, getLastChangeTime, getLastChangeTimeInSourceArchive, getName, getParents, getPathName, getSettingsDefinitions, getSourceArchive, getTypeDefSettingsDefinitions, getUniversalID, hasLanguageDependantLength, isDeleted, isEncodable, isEquivalent, isNotYetDefined, isZeroLength, removeParent, replaceWith, setCategoryPath, setDescription, setLastChangeTime, setLastChangeTimeInSourceArchive, setName, setNameAndCategory, setSourceArchive

Field Details

MAGIC

public static byte[] MAGIC

MAGIC_MASK

public static byte[] MAGIC_MASK

Constructor Details

AIFFDataType

public AIFFDataType()

AIFFDataType

public AIFFDataType(DataTypeManager dtm)

Method Details

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 only Dynamic 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

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.

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

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 shuold be made directly to this instance if supported or to a DataType.copy(DataTypeManager).

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

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.

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.

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

Get the interpretted data value in the form of the appropriate Object for this DataType. This method must return a value consistent with DataType.getValueClass(Settings).

For instance, if this datatype is a Pointer an Address object or null should be returned. A Byte, returns a Scalar object.

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 Class<?> getValueClass(Settings settings)

Description copied from interface: DataType

Get the Class of the value Object to be returned by this datatype (see DataType.getValue(MemBuffer, Settings, int)).

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 datatype or null if it can vary or is unspecified. Types which correspond to a string or char array will return the String class.

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

Overrides:

getDefaultLabelPrefix in class AbstractDataType

Parameters:

buf - memory buffer containing the bytes.

settings - the Settings object

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

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