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,java.util.EventListener,javax.swing.event.ChangeListener
- 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.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface ghidra.util.classfinder.ExtensionPoint
ExtensionPoint.Exclude, ExtensionPoint.Util
-
-
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
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description protected SettingsDefinition[]getBuiltInSettingsDefinitions()Gets a list of all the settingsDefinitions used by this datatype.java.lang.StringgetCTypeDeclaration(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.StringgetDefaultLabelPrefix()Returns the appropriate string to use as the default label prefix in the absence of any data.java.lang.StringgetDescription()Get a String briefly describing this DataType.static DataTypegetFloatDataType(int size, DataTypeManager dtm)Get a Float data-type instance of the requested sizestatic AbstractFloatDataType[]getFloatDataTypes(DataTypeManager dtm)Returns all built-in float data-typesjava.lang.StringgetMnemonic(Settings settings)Get the mnemonic for this DataType.java.lang.StringgetRepresentation(MemBuffer buf, Settings settings, int length)Get bytes from memory in a printable format for this type.java.lang.ObjectgetValue(MemBuffer buf, Settings settings, int length)Get the data in the form of the appropriate Object for this DataType.booleanisDynamicallySized()Indicates if this data-type is dynamically sized based upon DataOrganization.-
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, notifyDeleted, notifyNameChanged, notifyReplaced, notifySizeChanged, 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, isDeleted, isNotYetDefined, 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, getAlignment, getCategoryPath, getDataOrganization, getDataTypeManager, getDataTypePath, getDefaultAbbreviatedLabelPrefix, getDefaultLabelPrefix, getDefaultOffcutLabelPrefix, getDefaultSettings, getDisplayName, getDocs, getLastChangeTimeInSourceArchive, getLength, getName, getParents, getPathName, getSourceArchive, getValueClass, isDeleted, isNotYetDefined, 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:DataTypeGet the mnemonic for this DataType.- Specified by:
getMnemonicin interfaceDataType- Overrides:
getMnemonicin classAbstractDataType- Returns:
- the mnemonic for this DataType.
- See Also:
DataType.getMnemonic(Settings)
-
isDynamicallySized
public boolean isDynamicallySized()
Description copied from interface:DataTypeIndicates if this data-type is dynamically sized based upon DataOrganization.- Specified by:
isDynamicallySizedin interfaceDataType- Overrides:
isDynamicallySizedin classAbstractDataType- See Also:
DataType.isDynamicallySized()
-
getDescription
public java.lang.String getDescription()
Description copied from interface:DataTypeGet 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:DataTypeGet 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- 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)
-
getRepresentation
public java.lang.String getRepresentation(MemBuffer buf, Settings settings, int length)
Description copied from interface:DataTypeGet 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)
-
getBuiltInSettingsDefinitions
protected SettingsDefinition[] getBuiltInSettingsDefinitions()
Description copied from class:BuiltInGets a list of all the settingsDefinitions used by this datatype.- Overrides:
getBuiltInSettingsDefinitionsin classBuiltIn- Returns:
- a list of the settingsDefinitions used by this datatype.
- See Also:
BuiltIn.getBuiltInSettingsDefinitions()
-
getDefaultLabelPrefix
public java.lang.String getDefaultLabelPrefix()
Description copied from interface:DataTypeReturns the appropriate string to use as the default label prefix in the absence of any data.- Specified by:
getDefaultLabelPrefixin interfaceDataType- Overrides:
getDefaultLabelPrefixin classAbstractDataType- Returns:
- the default label prefix or null if none specified.
-
getCTypeDeclaration
public java.lang.String getCTypeDeclaration(DataOrganization dataOrganization)
Description copied from class:BuiltInReturns 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:
getCTypeDeclarationin interfaceBuiltInDataType- Overrides:
getCTypeDeclarationin classBuiltIn- 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.
-
-