Class BadDataType

All Implemented Interfaces:
BuiltInDataType, DataType, Dynamic, ExtensionPoint

public class BadDataType extends BuiltIn implements Dynamic
Provides an implementation of a data type that is not valid (bad) as it is used in the program. For example, the class for the underlying data type may no longer be available or the data type may not fit where it has been placed in the program.

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

  • Field Details

  • Constructor Details

    • BadDataType

      public BadDataType()
    • BadDataType

      public BadDataType(DataTypeManager dtm)
  • 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:
    • 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
      See Also:
    • 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.
      See Also:
    • 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
      See Also:
    • 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
      Overrides:
      isEquivalent in class BuiltIn
      Parameters:
      dt - the datatype being tested for equivalence.
      Returns:
      true if the if the given datatype is equivalent to 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.
      See Also:
    • 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
    • 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.
    • 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