Class 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.
  • Constructor Details

  • Method Details

    • 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.
      See Also:
    • getDescription

      public String getDescription()
      Description copied from interface: DataType
      Get a String briefly describing this DataType.
      Returns:
      a one-liner describing this DataType.
      See Also:
    • 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.

      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:
    • 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(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 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:
    • encodeRepresentation

      public byte[] encodeRepresentation(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:
    • getDefaultLabelPrefix

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