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

Class TargetEnumDescriptor

java.lang.Object

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:

SwiftStructure, StructConverter

public final class TargetEnumDescriptor
extends TargetTypeContextDescriptor

Represents a Swift TargetEnumDescriptor structure

See Also:

• swift/ABI/Metadata.h

Field Summary

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

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

Fields inherited from interface ghidra.app.util.bin.format.swift.SwiftStructure

DATA_TYPE_CATEGORY

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 SwiftStructure
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 SwiftStructure
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, getFields, getName, toString

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

getFlags, getParent

Methods inherited from class java.lang.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 interface: SwiftStructure

Gets the name of the SwiftStructure

Specified by:

getStructureName in interface SwiftStructure

Overrides:

getStructureName in class TargetTypeContextDescriptor

Returns:

The name of the SwiftStructure

getDescription

public String getDescription()

Description copied from interface: SwiftStructure

Gets a short description of the SwiftStructure

Specified by:

getDescription in interface SwiftStructure

Overrides:

getDescription in class TargetTypeContextDescriptor

Returns:

A short description of the SwiftStructure

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

See Also:

• StructureDataType