Package ghidra.app.util.bin.format.swift.types

Class TargetClassDescriptor

java.lang.Object

ghidra.app.util.bin.format.swift.SwiftTypeMetadataStructure

ghidra.app.util.bin.format.swift.types.TargetContextDescriptor

ghidra.app.util.bin.format.swift.types.TargetTypeContextDescriptor

ghidra.app.util.bin.format.swift.types.TargetClassDescriptor

All Implemented Interfaces:

StructConverter

public final class TargetClassDescriptor
extends TargetTypeContextDescriptor

Represents a Swift TargetClassDescriptor structure

See Also:

• swift/ABI/Metadata.h

Field Summary

Fields inherited from class ghidra.app.util.bin.format.swift.types.TargetContextDescriptor

flags, SIZE

Fields inherited from class ghidra.app.util.bin.format.swift.SwiftTypeMetadataStructure

CATEGORY, CATEGORY_PATH

Fields inherited from interface ghidra.app.util.bin.StructConverter

ASCII, BOOL, BYTE, DWORD, IBO32, IBO64, POINTER, QWORD, SLEB128, STRING, ULEB128, UTF16, UTF8, VOID, WORD

Constructor Summary

Constructors

Constructor	Description
TargetClassDescriptor(BinaryReader reader)	Creates a new TargetClassDescriptor

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Returns a short description of the SwiftTypeMetadataStructure.
ExtraClassDescriptorFlags	getExtraClassDescriptorFlags()	Returns flags used to do things like indicate the presence of an Objective-C resilient class stub if this descriptor has a resilient superclass; otherwise, null.
int	getFieldOffsetVectorOffset()	Returns the offset of the field offset vector for this class's stored properties in its metadata, in words (0 means there is no field offset vector).
TargetTypeGenericContextDescriptorHeader	getGenericHeader()	Returns the TargetTypeGenericContextDescriptorHeader, or null if it doesn't exist.
InvertibleProtocolSet	getInvertibleProtocolSet()	Returns the InvertibleProtocolSet, or null if it doens't exist.
int	getMetadataNegativeSizeInWords()	Returns the negative size of metadata objects of this class (in words) if this descriptor does not have a resilient superclass.
int	getMetadataPositiveSizeInWords()	Returns the positive size of metadata objects of this class (in words) if this descriptor does not have a resilient superclass.
List<TargetMethodDescriptor>	getMethodDescriptors()	Returns the List of method descriptors.
List<TargetMethodOverrideDescriptor>	getMethodOverrideDescriptors()	Returns the List of method override descriptors.
int	getNumFields()	Returns the number of stored properties in the class, not including its superclasses.
int	getNumImmediateMembers()	Returns the number of additional members added by this class to the class metadata.
TargetObjCResilientClassStubInfo	getObjcResilientClassStub()	Returns the TargetObjCResilientClassStubInfo, or null if it doesn't exist.
int	getResilientMetadataBounds()	Returns a reference to a cache holding the metadata's extents if this descriptor has a resilient superclass; otherwise, 0.
TargetResilientSuperclass	getResilientSuperclass()	Returns the TargetResilientSuperclass, or null if it doesn't exist.
String	getStructureName()	Returns the name of the SwiftTypeMetadataStructure.
int	getSuperclassType()	Returns the type of the superclass, expressed as a mangled type name that can refer to the generic arguments of the subclass type.
TargetForeignMetadataInitialization	getTargetForeignMetadataInitialization()	Returns the TargetForeignMetadataInitialization, or null if it doesn't exist.
TargetOverrideTableHeader	getTargetOverrideTableHeader()	Returns the TargetOverrideTableHeader, or null if it doesn't exist.
TargetSingletonMetadataInitialization	getTargetSingletonMetadataInitialization()	Returns the TargetSingletonMetadataInitialization, or null if it doesn't exist.
List<SwiftTypeMetadataStructure>	getTrailingObjects()	Returns a List of structures that trail this structure.
TargetVTableDescriptorHeader	getVTableDescriptorHeader()	Returns the TargetVTableDescriptorHeader, or null if it doesn't exist.
DataType	toDataType()	Returns a structure datatype representing the contents of the implementor of this interface.

Methods inherited from class ghidra.app.util.bin.format.swift.types.TargetTypeContextDescriptor

getAccessFunctionPtr, getFieldDescriptor, getFields, getName, toString

Methods inherited from class ghidra.app.util.bin.format.swift.types.TargetContextDescriptor

getFlags, getParent

Methods inherited from class ghidra.app.util.bin.format.swift.SwiftTypeMetadataStructure

getBase

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

TargetClassDescriptor

public TargetClassDescriptor(BinaryReader reader)
                      throws IOException

Creates a new TargetClassDescriptor

Parameters:

reader - A BinaryReader positioned at the start of the structure

Throws:

IOException - if there was an IO-related problem creating the structure

Method Details

getSuperclassType

public int getSuperclassType()

Returns the type of the superclass, expressed as a mangled type name that can refer to the generic arguments of the subclass type.

Returns:

the type of the superclass, expressed as a mangled type name that can refer to the generic arguments of the subclass type

getResilientMetadataBounds

public int getResilientMetadataBounds()

Returns a reference to a cache holding the metadata's extents if this descriptor has a resilient superclass; otherwise, 0.

Returns:

a reference to a cache holding the metadata's extents if this descriptor has a resilient superclass; otherwise, 0

getMetadataNegativeSizeInWords

public int getMetadataNegativeSizeInWords()

Returns the negative size of metadata objects of this class (in words) if this descriptor does not have a resilient superclass.

Returns:

the negative size of metadata objects of this class (in words) if this descriptor does not have a resilient superclass

getExtraClassDescriptorFlags

public ExtraClassDescriptorFlags getExtraClassDescriptorFlags()

Returns flags used to do things like indicate the presence of an Objective-C resilient class stub if this descriptor has a resilient superclass; otherwise, null.

Returns:

flags used to do things like indicate the presence of an Objective-C resilient class stub if this descriptor has a resilient superclass; otherwise, null

getMetadataPositiveSizeInWords

public int getMetadataPositiveSizeInWords()

Returns the positive size of metadata objects of this class (in words) if this descriptor does not have a resilient superclass.

Returns:

the positive size of metadata objects of this class (in words) if this descriptor does not have a resilient superclass

getNumImmediateMembers

public int getNumImmediateMembers()

Returns the number of additional members added by this class to the class metadata.

Returns:

the number of additional members added by this class to the class metadata

getNumFields

public int getNumFields()

Returns the number of stored properties in the class, not including its superclasses.

If there is a field offset vector, this is its length.

Returns:

the number of stored properties in the class, not including its superclasses

getFieldOffsetVectorOffset

public int getFieldOffsetVectorOffset()

Returns the offset of the field offset vector for this class's stored properties in its metadata, in words (0 means there is no field offset vector).

Returns:

the offset of the field offset vector for this class's stored properties in its metadata, in words (0 means there is no field offset vector)

getGenericHeader

public TargetTypeGenericContextDescriptorHeader getGenericHeader()

Returns the TargetTypeGenericContextDescriptorHeader, or null if it doesn't exist.

Returns:

the TargetTypeGenericContextDescriptorHeader, or null if it doesn't exist

getResilientSuperclass

public TargetResilientSuperclass getResilientSuperclass()

Returns the TargetResilientSuperclass, or null if it doesn't exist.

Returns:

the TargetResilientSuperclass, or null if it doesn't exist

getTargetSingletonMetadataInitialization

public TargetSingletonMetadataInitialization getTargetSingletonMetadataInitialization()

Returns the TargetSingletonMetadataInitialization, or null if it doesn't exist.

Returns:

the TargetSingletonMetadataInitialization, or null if it doesn't exist

getTargetForeignMetadataInitialization

public TargetForeignMetadataInitialization getTargetForeignMetadataInitialization()

Returns the TargetForeignMetadataInitialization, or null if it doesn't exist.

Returns:

the TargetForeignMetadataInitialization, or null if it doesn't exist

getVTableDescriptorHeader

public TargetVTableDescriptorHeader getVTableDescriptorHeader()

Returns the TargetVTableDescriptorHeader, or null if it doesn't exist.

Returns:

the TargetVTableDescriptorHeader, or null if it doesn't exist

getMethodDescriptors

public List<TargetMethodDescriptor> getMethodDescriptors()

Returns the List of method descriptors.

Returns:

the List of method descriptors

getTargetOverrideTableHeader

public TargetOverrideTableHeader getTargetOverrideTableHeader()

Returns the TargetOverrideTableHeader, or null if it doesn't exist.

Returns:

the TargetOverrideTableHeader, or null if it doesn't exist

getMethodOverrideDescriptors

public List<TargetMethodOverrideDescriptor> getMethodOverrideDescriptors()

Returns the List of method override descriptors.

Returns:

the List of method override descriptors

getObjcResilientClassStub

public TargetObjCResilientClassStubInfo getObjcResilientClassStub()

Returns the TargetObjCResilientClassStubInfo, or null if it doesn't exist.

Returns:

the TargetObjCResilientClassStubInfo, or null if it doesn't exist

getInvertibleProtocolSet

public InvertibleProtocolSet getInvertibleProtocolSet()

Returns the InvertibleProtocolSet, or null if it doens't exist.

Returns:

the InvertibleProtocolSet, or null if it doens't exist

getTrailingObjects

public List<SwiftTypeMetadataStructure> getTrailingObjects()

Description copied from class: SwiftTypeMetadataStructure

Returns a List of structures that trail this structure.

Overrides:

getTrailingObjects in class SwiftTypeMetadataStructure

Returns:

a List of structures that trail this structure

getStructureName

public String getStructureName()

Description copied from class: SwiftTypeMetadataStructure

Returns the name of the SwiftTypeMetadataStructure.

Overrides:

getStructureName in class TargetTypeContextDescriptor

Returns:

the name of the SwiftTypeMetadataStructure

getDescription

public String getDescription()

Description copied from class: SwiftTypeMetadataStructure

Returns a short description of the SwiftTypeMetadataStructure.

Overrides:

getDescription in class TargetTypeContextDescriptor

Returns:

a short description of the SwiftTypeMetadataStructure

toDataType

public DataType toDataType()
                    throws DuplicateNameException,
IOException

Description copied from interface: StructConverter

Returns a structure datatype representing the contents of the implementor of this interface.

For example, given:

 class A {
     int foo;
     double bar;
 }
 

The return value should be a structure data type with two data type components; an INT and a DOUBLE. The structure should contain field names and, if possible, field comments.

Specified by:

toDataType in interface StructConverter

Overrides:

toDataType in class TargetTypeContextDescriptor

Returns:

returns a structure datatype representing the implementor of this interface

Throws:

DuplicateNameException - when a datatype of the same name already exists

IOException - if an IO-related error occurs

See Also:

• StructureDataType