Package ghidra.program.model.data

Class TypedefDataType

  • All Implemented Interfaces:
    DataType, TypeDef, java.util.EventListener, javax.swing.event.ChangeListener
    public class TypedefDataType
extends GenericDataType
implements TypeDef
    Basic implementation for the typedef dataType

    • Constructor Detail

      • TypedefDataType

        public TypedefDataType​(java.lang.String name,
                       DataType dt)

      • TypedefDataType

        public TypedefDataType​(CategoryPath path,
                       java.lang.String name,
                       DataType dt)
        Construct a new typedef.
        Parameters:
        name - name to use as the alias
        dt - data type that is being typedef'ed

      • TypedefDataType

        public TypedefDataType​(CategoryPath path,
                       java.lang.String name,
                       DataType dt,
                       DataTypeManager dtm)
        Construct a new typedef.
        Parameters:
        name - name to use as the alias
        dt - data type that is being typedef'ed

      • TypedefDataType

        public TypedefDataType​(CategoryPath path,
                       java.lang.String name,
                       DataType dt,
                       UniversalID universalID,
                       SourceArchive sourceArchive,
                       long lastChangeTime,
                       long lastChangeTimeInSourceArchive,
                       DataTypeManager dtm)
        Construct a new typedef.
        Parameters:
        path - the category path indicating where this data type is located.
        name - the name of the new structure
        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. Also, the data type manager may not contain this actual data type.

    • Method Detail

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

      • isNotYetDefined

        public boolean isNotYetDefined()
        Description copied from interface: DataType
        Indicates if type has not yet been defined. Such types will always return a size of 1. (example: empty structure)
        Specified by:
        isNotYetDefined in interface DataType
        Overrides:
        isNotYetDefined in class AbstractDataType
        Returns:
        true if this type is not yet defined.

      • isEquivalent

        public boolean isEquivalent​(DataType obj)
        Description copied from interface: DataType
        Returns true 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 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.

      • 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

      • getDescription

        public java.lang.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 is 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: Support for zero-length datatypes is not yet fully supported, as a result they will generally return a non-zero length.
        Specified by:
        isZeroLength in interface DataType
        Overrides:
        isZeroLength in class AbstractDataType
        Returns:
        true if type definition has a length of 0 even though it may report a length of 1, else false.

      • getLength

        public int getLength()
        Description copied from interface: DataType
        Get the length (number of 8-bit bytes) of this DataType.
        Specified by:
        getLength in interface DataType
        Returns:
        the length of this DataType

      • 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.
        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 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 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
        Specified by:
        getValue in interface DataType
        Parameters:
        buf - the data buffer.
        settings - the settings to use.
        length - the number of bytes to get the value from.
        Returns:
        the data Object.

      • getValueClass

        public java.lang.Class<?> getValueClass​(Settings settings)
        Description copied from interface: DataType
        Get the Class of the value to be returned by this data type.
        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 data type 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 DataType clone​(DataTypeManager dtm)
        Description copied from interface: DataType
        Returns an instance of this DataType with its universalID and SourceArchive identity retained. The current instanceof 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.
        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 DataType copy​(DataTypeManager dtm)
        Description copied from interface: DataType
        Returns a new instance (shallow copy) of this DataType with a new identity. 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

      • 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

      • 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 data type has been deleted and is no longer valid
        Specified by:
        isDeleted in interface DataType
        Overrides:
        isDeleted in class AbstractDataType
        Returns:
        true if this data type has been deleted and is no longer valid.

      • dataTypeReplaced

        public void dataTypeReplaced​(DataType oldDt,
                             DataType newDt)
        Description copied from interface: DataType
        Informs this data type 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 data type
        newDt - new data type

      • dataTypeNameChanged

        public void dataTypeNameChanged​(DataType dt,
                                java.lang.String oldName)
        Description copied from interface: DataType
        Informs this data type 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 data type whose name changed
        oldName - the data type's old name

      • dependsOn

        public boolean dependsOn​(DataType dt)
        Description copied from interface: DataType
        Returns true 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.