Package ghidra.program.model.data

Class BooleanDataType

    • Constructor Detail

      • BooleanDataType

        public BooleanDataType()
        Constructs a new Boolean datatype.

    • Method Detail

      • 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 AbstractIntegerDataType
        Parameters:
        settings - settings which may influence the result or null
        Returns:
        the mnemonic for this DataType.

      • getDecompilerDisplayName

        public java.lang.String getDecompilerDisplayName​(DecompilerLanguage language)
        Description copied from class: BuiltIn
        Return token used to represent this type in decompiler/source-code output
        Overrides:
        getDecompilerDisplayName in class BuiltIn
        Parameters:
        language - is the language being displayed
        Returns:
        the name string

      • getCDeclaration

        public java.lang.String getCDeclaration()
        Overrides:
        getCDeclaration in class AbstractIntegerDataType
        Returns:
        the C style data-type declaration for this data-type. Null is returned if no appropriate declaration exists.

      • getLength

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

        NOTE: No datatype should ever return 0, even if DataType.isZeroLength(), and only Dynamic 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.

        Returns:
        the length of this DataType

      • getDescription

        public java.lang.String getDescription()
        Description copied from interface: DataType
        Get a String briefly describing this DataType.
        Returns:
        a one-liner describing this DataType.

      • 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 datatype 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
        Overrides:
        getValue in class AbstractIntegerDataType
        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 datatype.
        Specified by:
        getValueClass in interface DataType
        Overrides:
        getValueClass in class AbstractIntegerDataType
        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.

      • 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
        Overrides:
        getRepresentation in class AbstractIntegerDataType
        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.

      • getRepresentation

        public java.lang.String getRepresentation​(java.math.BigInteger bigInt,
                                          Settings settings,
                                          int bitLength)

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

        Parameters:
        dtm - the data-type manager instance whose data-organization should apply.
        Returns:
        cloned instance which may be the same as this instance