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

SIZE

Fields inherited from class SwiftTypeMetadataStructure

DATA_TYPE_CATEGORY

Fields inherited from interface StructConverter

ASCII, 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()	Gets a short description of the SwiftTypeMetadataStructure
int	getNumEmptyCases()	Gets 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()	Gets the name of the SwiftTypeMetadataStructure
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()

Gets the number of empty cases in the enum

Returns:

The number of empty cases in the enum

getStructureName

public String getStructureName()

Description copied from class: SwiftTypeMetadataStructure

Gets 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

Gets 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