Class TargetEnumDescriptor

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

All Implemented Interfaces:

StructConverter

public final class TargetEnumDescriptor
extends TargetTypeContextDescriptor

Represents a Swift TargetEnumDescriptor structure

See Also:

• swift/ABI/Metadata.h

Field Summary

Fields inherited from class TargetContextDescriptor

flags, SIZE

Fields inherited from class SwiftTypeMetadataStructure

CATEGORY, CATEGORY_PATH

Fields inherited from interface StructConverter

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

Constructor Summary

Constructors

Constructor	Description
TargetEnumDescriptor(BinaryReader reader)	Creates a new TargetEnumDescriptor

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Returns a short description of the SwiftTypeMetadataStructure.
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	getNumEmptyCases()	Returns the number of empty cases in the enum.
int	getNumPayloadCasesAndPayloadSizeOffset()	Gets the number of non-empty cases in the enum are in the low 24 bits; the offset of the payload size in the metadata record in words, if any, is stored in the high 8 bits;
String	getStructureName()	Returns the name of the SwiftTypeMetadataStructure.
TargetForeignMetadataInitialization	getTargetForeignMetadataInitialization()	Returns the TargetForeignMetadataInitialization, 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.
DataType	toDataType()	Returns a structure datatype representing the contents of the implementor of this interface.

Methods inherited from class TargetTypeContextDescriptor

getAccessFunctionPtr, getFieldDescriptor, getFields, getName, toString

Methods inherited from class TargetContextDescriptor

getFlags, getParent

Methods inherited from class SwiftTypeMetadataStructure

getBase

Methods inherited from class Object

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

Constructor Details

TargetEnumDescriptor

public TargetEnumDescriptor(BinaryReader reader)
                     throws IOException

Creates a new TargetEnumDescriptor

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

getNumPayloadCasesAndPayloadSizeOffset

public int getNumPayloadCasesAndPayloadSizeOffset()

Gets the number of non-empty cases in the enum are in the low 24 bits; the offset of the payload size in the metadata record in words, if any, is stored in the high 8 bits;

Returns:

The number of non-empty cases in the enum and the offset of the payload size

getNumEmptyCases

public int getNumEmptyCases()

Returns the number of empty cases in the enum.

Returns:

the number of empty cases in the enum

getGenericHeader

public TargetTypeGenericContextDescriptorHeader getGenericHeader()

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

Returns:

the TargetTypeGenericContextDescriptorHeader, 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

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