Package ghidra.program.model.data

Class AbstractFloatDataType

java.lang.Object

ghidra.program.model.data.AbstractDataType

ghidra.program.model.data.DataTypeImpl

ghidra.program.model.data.BuiltIn

ghidra.program.model.data.AbstractFloatDataType

All Implemented Interfaces:

BuiltInDataType, DataType, ExtensionPoint

Direct Known Subclasses:

DoubleDataType, Float10DataType, Float16DataType, Float2DataType, Float4DataType, Float8DataType, FloatDataType, LongDoubleDataType

public abstract class AbstractFloatDataType
extends BuiltIn

Provides a definition of a Float within a program.

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
AbstractFloatDataType(java.lang.String name, DataTypeManager dtm)

Method Summary

Modifier and Type	Method	Description
byte[]	encodeRepresentation(java.lang.String repr, MemBuffer buf, Settings settings, int length)	Encode bytes according to the display format for this type.
byte[]	encodeValue(java.lang.Object value, MemBuffer buf, Settings settings, int length)	Encode bytes from an Object appropriate for this DataType.
protected SettingsDefinition[]	getBuiltInSettingsDefinitions()	Gets a list of all the settingsDefinitions used by this datatype.
java.lang.String	getCTypeDeclaration(DataOrganization dataOrganization)	Returns null for FactoryDataType (which should never be used) and Dynamic types which should generally be replaced by a primitive array (e.g., char[5]) or, a primitive pointer (e.g., char *).
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.
static DataType	getFloatDataType(int size, DataTypeManager dtm)	Get a Float data-type instance of the requested size
static AbstractFloatDataType[]	getFloatDataTypes(DataTypeManager dtm)	Returns all built-in float data-types
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.
java.lang.Object	getValue(MemBuffer buf, Settings settings, int length)	Get the data in the form of the appropriate Object for this DataType.
boolean	isEncodable()	Check if this type supports encoding (patching)

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

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

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

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

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

dataTypeAlignmentChanged, getCategoryPath, getDataOrganization, getDataTypeManager, getDataTypePath, getDefaultAbbreviatedLabelPrefix, getDefaultLabelPrefix, getDefaultOffcutLabelPrefix, getDisplayName, getDocs, getName, hasLanguageDependantLength, isDeleted, 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

clone, dataTypeAlignmentChanged, getAlignment, getCategoryPath, getDataOrganization, getDataTypeManager, getDataTypePath, getDefaultAbbreviatedLabelPrefix, getDefaultLabelPrefix, getDefaultOffcutLabelPrefix, getDefaultSettings, getDisplayName, getDocs, getLastChangeTimeInSourceArchive, getLength, getName, getParents, getPathName, getSourceArchive, getValueClass, hasLanguageDependantLength, isDeleted, isNotYetDefined, isZeroLength, replaceWith, setDefaultSettings, setDescription, setLastChangeTime, setLastChangeTimeInSourceArchive, setSourceArchive

Constructor Detail

AbstractFloatDataType

public AbstractFloatDataType(java.lang.String name,
                             DataTypeManager dtm)

Method Detail

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

Parameters:

settings - settings which may influence the result or null

Returns:

the mnemonic for this DataType.

See Also:

DataType.getMnemonic(Settings)

getDescription

public java.lang.String getDescription()

Description copied from interface: DataType

Get a String briefly describing this DataType.

Returns:

a one-liner describing this DataType.

See Also:

DataType.getDescription()

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

Parameters:

buf - the data buffer.

settings - the settings to use.

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

Returns:

the data Object.

See Also:

DataType.getValue(ghidra.program.model.mem.MemBuffer, ghidra.docking.settings.Settings, int)

isEncodable

public boolean isEncodable()

Description copied from interface: DataType

Check if this type supports encoding (patching)

If unsupported, DataType.encodeValue(Object, MemBuffer, Settings, int) and DataType.encodeRepresentation(String, MemBuffer, Settings, int) will always throw an exception. Actions which rely on either encode method should not be displayed if the applicable datatype is not encodable.

Specified by:

isEncodable in interface DataType

Overrides:

isEncodable in class AbstractDataType

Returns:

true if encoding is supported

encodeValue

public byte[] encodeValue(java.lang.Object value,
                          MemBuffer buf,
                          Settings settings,
                          int length)
                   throws DataTypeEncodeException

Description copied from interface: DataType

Encode bytes from an Object appropriate for this DataType.

Converts the given object to the byte encoding and returns it. When appropriate, this should seek the nearest encoding to the specified value, since the object may come from a user script. For example, a floating-point value may be rounded. Invalid values should be rejected with a DataTypeEncodeException.

Specified by:

encodeValue in interface DataType

Overrides:

encodeValue in class AbstractDataType

Parameters:

value - the desired value.

buf - a buffer representing the eventual destination of the bytes.

settings - the settings to use.

length - the expected length of the result, usually the length of the data unit, or -1 to let the type choose the length. It may be ignored, e.g., for fixed-length types.

Returns:

the encoded value.

Throws:

DataTypeEncodeException - if the value cannot be encoded for any reason, e.g., incorrect type, not enough space, buffer overflow, unsupported (see DataType.isEncodable()).

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.

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.

See Also:

DataType.getRepresentation(MemBuffer, Settings, int)

encodeRepresentation

public byte[] encodeRepresentation(java.lang.String repr,
                                   MemBuffer buf,
                                   Settings settings,
                                   int length)
                            throws DataTypeEncodeException

Description copied from interface: DataType

Encode bytes according to the display format for this type.

Converts the given representation to the byte encoding and returns it. When appropriate, this should seek the nearest encoding to the specified value, since the representation is likely coming from user input. For example, a floating-point value may be rounded. Invalid representations should be rejected with a DataTypeEncodeException.

Specified by:

encodeRepresentation in interface DataType

Overrides:

encodeRepresentation in class AbstractDataType

Parameters:

repr - the representation of the desired value, as in DataType.getRepresentation(MemBuffer, Settings, int). The supported formats depend on the specific datatype and its settings.

buf - a buffer representing the eventual destination of the bytes.

settings - the settings to use for the representation.

length - the expected length of the result, usually the length of the data unit, or -1 to let the type choose the length. It may be ignored, e.g., for fixed-length types.

Returns:

the encoded value.

Throws:

DataTypeEncodeException - if the value cannot be encoded for any reason, e.g., incorrect format, not enough space, buffer overflow, unsupported (see DataType.isEncodable()).

getBuiltInSettingsDefinitions

protected SettingsDefinition[] getBuiltInSettingsDefinitions()

Description copied from class: BuiltIn

Gets a list of all the settingsDefinitions used by this datatype.

Overrides:

getBuiltInSettingsDefinitions in class BuiltIn

Returns:

a list of the settingsDefinitions used by this datatype.

See Also:

BuiltIn.getBuiltInSettingsDefinitions()

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.

getCTypeDeclaration

public java.lang.String getCTypeDeclaration(DataOrganization dataOrganization)

Description copied from class: BuiltIn

Returns null for FactoryDataType (which should never be used) and Dynamic types which should generally be replaced by a primitive array (e.g., char[5]) or, a primitive pointer (e.g., char *). For other types an appropriately sized unsigned integer typedef is returned.

Specified by:

getCTypeDeclaration in interface BuiltInDataType

Overrides:

getCTypeDeclaration in class BuiltIn

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)

getFloatDataType

public static DataType getFloatDataType(int size,
                                        DataTypeManager dtm)

Get a Float data-type instance of the requested size

Parameters:

size - data type size, unsupported sizes will cause an undefined type to be returned.

dtm - optional program data-type manager, if specified a generic data-type will be returned if possible (i.e., float, double, long double).

Returns:

float data type of specified size

getFloatDataTypes

public static AbstractFloatDataType[] getFloatDataTypes(DataTypeManager dtm)

Returns all built-in float data-types

Parameters:

dtm - optional program data-type manager, if specified generic data-types will be returned in place of fixed-sized data-types.