Class TypedefDataType

All Implemented Interfaces:
DataType, TypeDef

public class TypedefDataType extends GenericDataType implements TypeDef
Basic implementation for the typedef dataType. NOTE: Settings are immutable when a DataTypeManager has not been specified (i.e., null).
  • Constructor Details

    • TypedefDataType

      public TypedefDataType(String name, DataType dt)
      Construct a new typedef within the root category
      Parameters:
      name - name of this typedef
      dt - data type that is being typedef'ed (may not be null)
    • TypedefDataType

      public TypedefDataType(CategoryPath path, String name, DataType dt)
      Construct a new typedef.
      Parameters:
      path - category path for this datatype
      name - name of this typedef
      dt - data type that is being typedef'ed (may not be null)
    • TypedefDataType

      public TypedefDataType(CategoryPath path, String name, DataType dt, DataTypeManager dtm)
      Construct a new typedef.
      Parameters:
      path - category path for this datatype
      name - name of this typedef
      dt - data type that is being typedef'ed (may not be null)
      dtm - the data type manager associated with this data type. This can be null.
    • TypedefDataType

      public TypedefDataType(CategoryPath path, String name, DataType dt, UniversalID universalID, SourceArchive sourceArchive, long lastChangeTime, long lastChangeTimeInSourceArchive, DataTypeManager dtm)
      Construct a new typedef.
      Parameters:
      path - category path for this datatype
      name - name of this typedef
      dt - data type that is being typedef'ed (may not be null)
      universalID - the id for the data type
      sourceArchive - the source archive for this data type
      lastChangeTime - the last time this data type was changed
      lastChangeTimeInSourceArchive - the last time this data type was changed in its source archive.
      dtm - the data type manager associated with this data type. This can be null.
  • Method Details

    • enableAutoNaming

      public void enableAutoNaming()
      Description copied from interface: TypeDef
      Enable auto-naming for this typedef. This will force naming to reflect the name of associated datatype plus an attribute list which corresponds to any TypeDefSettingsDefinition settings which may be set.
      Specified by:
      enableAutoNaming in interface TypeDef
    • isAutoNamed

      public boolean isAutoNamed()
      Description copied from interface: TypeDef
      Determine if this datatype use auto-naming (e.g., see PointerTypedef). If true, any change to associated TypeDefSettingsDefinition settings or naming of the pointer-referenced datatype will cause a automatic renaming of this datatype.
      Specified by:
      isAutoNamed in interface TypeDef
      Returns:
      true if auto-named, else false.
    • 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.
    • 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.
    • getDefaultAbbreviatedLabelPrefix

      public String getDefaultAbbreviatedLabelPrefix()
      Description copied from interface: DataType
      Returns the prefix to use for this datatype when an abbreviated prefix is desired.

      For example, some datatypes will built a large default label, at which is is more desirable to have a shortened prefix.

      Specified by:
      getDefaultAbbreviatedLabelPrefix in interface DataType
      Overrides:
      getDefaultAbbreviatedLabelPrefix in class AbstractDataType
      Returns:
      the prefix to use for this datatype when an abbreviated prefix is desired. May return null.
    • getDefaultOffcutLabelPrefix

      public String getDefaultOffcutLabelPrefix(MemBuffer buf, Settings settings, int len, DataTypeDisplayOptions options, int offcutLength)
      Description copied from interface: DataType
      Returns the appropriate string to use as the default label prefix.

      This takes into account the fact that there exists a reference to the data that references offcutLength bytes into this type

      Specified by:
      getDefaultOffcutLabelPrefix in interface DataType
      Overrides:
      getDefaultOffcutLabelPrefix 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.
      offcutLength - offset into datatype
      Returns:
      the default label prefix.
    • hasLanguageDependantLength

      public boolean hasLanguageDependantLength()
      Description copied from interface: DataType
      Indicates if the length of this data-type is determined based upon the DataOrganization obtained from the associated DataTypeManager.
      Specified by:
      hasLanguageDependantLength in interface DataType
      Overrides:
      hasLanguageDependantLength in class AbstractDataType
      Returns:
      true length is language/compiler-specification dependent, else false
    • isEquivalent

      public boolean isEquivalent(DataType obj)
      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
      Parameters:
      obj - the datatype being tested for equivalence.
      Returns:
      true if the if the given datatype is equivalent to 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.
    • getDataType

      public DataType getDataType()
      Description copied from interface: TypeDef
      Returns the dataType that this typedef is based on. This could be another typedef
      Specified by:
      getDataType in interface TypeDef
      Returns:
      the datatype which this typedef is based on (may be another TypeDef).
    • 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.
    • isZeroLength

      public boolean isZeroLength()
      Description copied from interface: DataType
      Indicates this datatype is defined with a zero length.

      This method should not be confused with DataType.isNotYetDefined() which indicates that nothing but the name and basic type is known.

      NOTE: a zero-length datatype must return a length of 1 via DataType.getLength(). Zero-length datatypes used as a component within a Composite may, or may not, be assigned a component length of 0. The method DataTypeComponent.usesZeroLengthComponent(DataType) is used to make this determination.

      Specified by:
      isZeroLength in interface DataType
      Overrides:
      isZeroLength in class AbstractDataType
      Returns:
      true if type definition has a length of 0, else false
    • 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
    • getAlignedLength

      public int getAlignedLength()
      Description copied from interface: DataType
      Get the aligned-length of this datatype as a number of 8-bit bytes.

      For primitive datatypes this is equivalent to the C/C++ "sizeof" operation within source code and should be used when determining Array element length or component sizing for a Composite. For Pointer, Composite and Array types this will return the same value as DataType.getLength().

      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 / FunctionDefinition datatypes should return -1. If DataType.isZeroLength() is true a length of 1 should be returned.

      Specified by:
      getAlignedLength in interface DataType
      Overrides:
      getAlignedLength in class DataTypeImpl
      Returns:
      byte length of binary encoding.
    • 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
      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
    • 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.
    • clone

      public static TypeDef clone(TypeDef typedef, DataTypeManager dtm)
    • copy

      public static TypedefDataType copy(TypeDef typedef, DataTypeManager dtm)
    • clone

      public TypedefDataType 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
    • copy

      public TypedefDataType copy(DataTypeManager dtm)
      Description copied from interface: DataType
      Returns a new instance (shallow copy) of this DataType with a new identity and no source archive association.

      Any reference to other datatypes will use DataType.clone(DataTypeManager).

      Specified by:
      copy in interface DataType
      Parameters:
      dtm - the data-type manager instance whose data-organization should apply.
      Returns:
      new instanceof of this datatype
    • getName

      public String getName()
      Description copied from interface: DataType
      Get the name of this datatype.
      Specified by:
      getName in interface DataType
      Overrides:
      getName in class AbstractDataType
      Returns:
      the name
    • setName

      public void setName(String name) throws InvalidNameException
      Description copied from interface: DataType
      Sets the name of the datatype
      Specified by:
      setName in interface DataType
      Overrides:
      setName in class GenericDataType
      Parameters:
      name - the new name for this datatype.
      Throws:
      InvalidNameException - if the given name does not form a valid name.
    • setCategoryPath

      public void setCategoryPath(CategoryPath path)
      Description copied from interface: DataType
      Set the categoryPath associated with this datatype
      Specified by:
      setCategoryPath in interface DataType
      Overrides:
      setCategoryPath in class GenericDataType
      Parameters:
      path - the new path
    • getCategoryPath

      public CategoryPath getCategoryPath()
      Description copied from interface: DataType
      Gets the categoryPath associated with this datatype
      Specified by:
      getCategoryPath in interface DataType
      Overrides:
      getCategoryPath in class AbstractDataType
      Returns:
      the datatype's category path
    • dataTypeSizeChanged

      public void dataTypeSizeChanged(DataType dt)
      Description copied from interface: DataType
      Notification that the given datatype's size has changed.

      DataTypes may need to make internal changes in response.
      TODO: This method is reserved for internal DB use.

      Specified by:
      dataTypeSizeChanged in interface DataType
      Overrides:
      dataTypeSizeChanged in class AbstractDataType
      Parameters:
      dt - the datatype that has changed.
    • dataTypeAlignmentChanged

      public void dataTypeAlignmentChanged(DataType dt)
      Description copied from interface: DataType
      Notification that the given datatype's alignment has changed.

      DataTypes may need to make internal changes in response.
      TODO: This method is reserved for internal DB use.

      Specified by:
      dataTypeAlignmentChanged in interface DataType
      Overrides:
      dataTypeAlignmentChanged in class AbstractDataType
      Parameters:
      dt - the datatype that has changed.
    • getBaseDataType

      public DataType getBaseDataType()
      Description copied from interface: TypeDef
      Returns the non-typedef dataType that this typedef is based on, following chains of typedefs as necessary.
      Specified by:
      getBaseDataType in interface TypeDef
      Returns:
      the datatype which this typedef is based on (will not be another TypeDef).
    • dataTypeDeleted

      public void dataTypeDeleted(DataType dt)
      Description copied from interface: DataType
      Informs this datatype that the given datatype has been deleted.

      TODO: This method is reserved for internal DB use.

      Specified by:
      dataTypeDeleted in interface DataType
      Overrides:
      dataTypeDeleted in class AbstractDataType
      Parameters:
      dt - the datatype that has been deleted.
    • isDeleted

      public boolean isDeleted()
      Description copied from interface: DataType
      Returns true if this datatype has been deleted and is no longer valid
      Specified by:
      isDeleted in interface DataType
      Overrides:
      isDeleted in class AbstractDataType
      Returns:
      true if this datatype has been deleted and is no longer valid.
    • getSettingsDefinitions

      public SettingsDefinition[] getSettingsDefinitions()
      Description copied from interface: DataType
      Get the list of settings definitions available for use with this datatype.

      In the case of a TypeDef, the return list will include the TypeDefSettingsDefinition list from the associated base data type.

      Unlike TypeDefSettingsDefinition standard settings definitions generally support default, component-default and data-instance use. In addition, standard settings definitions are never considered during DataType.isEquivalent(DataType) checking or during the resolve process.

      Specified by:
      getSettingsDefinitions in interface DataType
      Overrides:
      getSettingsDefinitions in class DataTypeImpl
      Returns:
      list of the settings definitions for this datatype.
    • getTypeDefSettingsDefinitions

      public TypeDefSettingsDefinition[] getTypeDefSettingsDefinitions()
      Description copied from interface: DataType
      Get the list of all settings definitions for this datatype that may be used for an associated TypeDef. When used for an associated TypeDef, these settings will be considered during a DataType.isEquivalent(DataType) check and will be preserved during the resolve process.
      Specified by:
      getTypeDefSettingsDefinitions in interface DataType
      Overrides:
      getTypeDefSettingsDefinitions in class AbstractDataType
      Returns:
      a list of the settings definitions for a TypeDef associated with this datatype.
    • getDefaultSettings

      public Settings getDefaultSettings()
      Description copied from interface: DataType
      Gets the settings for this data type. The settings may have underlying default settings and may in turn become defaults for instance-specific settings (e.g., Data or DataTypeComponent). It is important to note that these settings are tied to a specific DataType instantiation so it is important to understand the scope of its use. Example: The BuiltInDataTypeManager has its own set of DataType instances which are separate from those which have been instantiated or resolved to a specific Program/Archive DataTypeManager. Settings manipulation may be disabled by default in some instances.
      Specified by:
      getDefaultSettings in interface DataType
      Overrides:
      getDefaultSettings in class DataTypeImpl
      Returns:
      the settings for this dataType.
    • dataTypeReplaced

      public void dataTypeReplaced(DataType oldDt, DataType newDt)
      Description copied from interface: DataType
      Informs this datatype that the given oldDT has been replaced with newDT

      TODO: This method is reserved for internal DB use.

      Specified by:
      dataTypeReplaced in interface DataType
      Overrides:
      dataTypeReplaced in class AbstractDataType
      Parameters:
      oldDt - old datatype
      newDt - new datatype
    • dataTypeNameChanged

      public void dataTypeNameChanged(DataType dt, String oldName)
      Description copied from interface: DataType
      Informs this datatype that its name has changed from the indicated old name.

      TODO: This method is reserved for internal DB use.

      Specified by:
      dataTypeNameChanged in interface DataType
      Overrides:
      dataTypeNameChanged in class AbstractDataType
      Parameters:
      dt - the datatype whose name changed
      oldName - the datatype's old name
    • dependsOn

      public boolean dependsOn(DataType dt)
      Description copied from interface: DataType
      Check if this datatype depends on the existence of the given datatype.

      For example byte[] depends on byte. If byte were deleted, then byte[] would also be deleted.

      Specified by:
      dependsOn in interface DataType
      Overrides:
      dependsOn in class AbstractDataType
      Parameters:
      dt - the datatype to test that this datatype depends on.
      Returns:
      true if the existence of this datatype relies on the existence of the specified datatype dt.
    • toString

      public String toString()
      Overrides:
      toString in class AbstractDataType
    • copyTypeDefSettings

      public static void copyTypeDefSettings(TypeDef src, TypeDef dest, boolean clearBeforeCopy)
      Copy all default settings , which correspond to a TypeDefSettingsDefinition, from the specified src TypeDef to the specified dest TypeDef.
      Parameters:
      src - settings source TypeDef
      dest - settings destination TypeDef
      clearBeforeCopy - if true dest default settings will be cleared before copy performed
    • generateTypedefName

      public static String generateTypedefName(TypeDef modelType)
      Generate a name for the typedef based upon its current TypeDefSettingsDefinition settings.
      Parameters:
      modelType - model typedef from which name should be derived
      Returns:
      generated typedef auto-name with attribute specification