Package ghidra.app.util.datatype.microsoft

Class RTTI2DataType

java.lang.Object
ghidra.program.model.data.AbstractDataType
ghidra.program.model.data.DataTypeImpl
ghidra.program.model.data.BuiltIn
ghidra.program.model.data.DynamicDataType
ghidra.app.util.datatype.microsoft.RTTIDataType
ghidra.app.util.datatype.microsoft.RTTI2DataType
All Implemented Interfaces:
BuiltInDataType, DataType, Dynamic, ExtensionPoint
@Deprecated public class RTTI2DataType extends RTTIDataType
Deprecated.
Use of this dynamic data type class is no longer recommended. Instead an array of either pointers or displacements to BaseClassDescriptor structures can be obtained using the Rtti2Model.
The RTTI2 data type represents an array of either pointers or displacements to the BaseClassDescriptors (RTTI 1s) for a class.

Fields for this RunTimeTypeInformation structure can be found on http://www.openrce.org

RTTI_Base_Class_Array is the label for the RTTI2 data structure.

  • Constructor Details

    • RTTI2DataType

      public RTTI2DataType()
      Deprecated.
      Creates a dynamic Base Class Array data type.

    • RTTI2DataType

      public RTTI2DataType(long rtti1Count)
      Deprecated.
      Creates a dynamic Base Class Array data type.
      Parameters:
      rtti1Count - the number of rtti1 refs

    • RTTI2DataType

      public RTTI2DataType(DataTypeManager dtm)
      Deprecated.
      Creates a dynamic Base Class Array data type.
      Parameters:
      dtm - the data type manager for this data type.

    • RTTI2DataType

      public RTTI2DataType(long rtti1Count, DataTypeManager dtm)
      Deprecated.
      Creates a dynamic Base Class Array data type.
      Parameters:
      rtti1Count - the number of rtti1 refs
      dtm - the data type manager for this data type.

  • Method Details

    • clone

      public DataType clone(DataTypeManager dtm)
      Deprecated.
      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.

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

    • getDescription

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

    • getMnemonic

      public String getMnemonic(Settings settings)
      Deprecated.
      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.

    • getRepresentation

      public String getRepresentation(MemBuffer buf, Settings settings, int length)
      Deprecated.
      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.

    • getValue

      public Object getValue(MemBuffer buf, Settings settings, int length)
      Deprecated.
      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.

      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

    • getAllComponents

      protected DataTypeComponent[] getAllComponents(MemBuffer buf)
      Deprecated.
      Description copied from class: DynamicDataType
      Get all dynamic components associated with the specified MemBuffer
      Specified by:
      getAllComponents in class DynamicDataType
      Parameters:
      buf - memory buffer positioned at start of data type instance
      Returns:
      all components or null if memory data is not valid for this data type.

    • getLength

      public int getLength(Memory memory, Address address, byte[] bytes)
      Deprecated.
      Gets the total length of the data created when this data type is placed at the indicated address in memory.
      Parameters:
      memory - the program memory for this data.
      address - the start address of the data.
      bytes - the bytes for this data.
      Returns:
      the length of the data. zero is returned if valid data can't be created at the indicated address using this data type.

    • getRtti1Address

      public Address getRtti1Address(Memory memory, Address rtti2Address, int rtti1Index)
      Deprecated.
      Gets address referred to by the RTTI 1 pointer at the specified index in the RTTI2's array that is at the rtti2Address.
      Parameters:
      memory - the program memory containing the RTTI 2
      rtti2Address - the address of the RTTI 2
      rtti1Index - the index of RTTI 1 entry in the RTTI 2 array
      Returns:
      the address of the RTTI 1 referred to by the indexed array element.

    • getRtti1Address

      public Address getRtti1Address(Program program, Address rtti2Address, int rtti1Index)
      Deprecated.
      Gets address referred to by the RTTI 1 pointer at the specified index in the RTTI2's array that is at the rtti2Address.
      Parameters:
      program - the program containing the RTTI 2
      rtti2Address - the address of the RTTI 2
      rtti1Index - the index of RTTI 1 entry in the RTTI 2 array
      Returns:
      the address of the RTTI 1 referred to by the indexed array element.

    • isValidRtti1Pointer

      public boolean isValidRtti1Pointer(Program program, Address startAddress, int pointerIndex, boolean overwriteInstructions, boolean overwriteDefinedData)
      Deprecated.
      Determines if the RTTI 1 pointer in the RTTI2 structure is valid.
      Parameters:
      program - the program
      startAddress - the address of the RTTI 2 structure
      pointerIndex - index of the element in the array that makes up the RTTI 2.
      overwriteInstructions - true indicates that existing instructions can be overwritten by this data type.
      overwriteDefinedData - true indicates that existing defined data can be overwritten by this data type.
      Returns:
      true if the indicated RTTI1 pointer is valid.

    • isValidRtti1Pointer

      public boolean isValidRtti1Pointer(Program program, Address startAddress, int pointerIndex, DataValidationOptions validationOptions)
      Deprecated.
      Determines if the RTTI 1 pointer in the RTTI2 structure is valid.
      Parameters:
      program - the program
      startAddress - the address of the RTTI 2 structure
      pointerIndex - index of the element in the array that makes up the RTTI 2.
      validationOptions - options indicating how to perform the validation
      Returns:
      true if the indicated RTTI1 pointer is valid.

    • isValid

      public boolean isValid(Program program, Address startAddress, DataValidationOptions validationOptions)
      Deprecated.
      Description copied from class: RTTIDataType
      Determines if the data type is valid for placing at the indicated address in the program.
      Specified by:
      isValid in class RTTIDataType
      Parameters:
      program - the program
      startAddress - the address where the validated data type will be used to create data
      validationOptions - options indicating how to perform the validation
      Returns:
      true if this data type can be laid down at the specified address

    • getDefaultLabelPrefix

      public String getDefaultLabelPrefix()
      Deprecated.
      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.