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

Class MultiPayloadEnumDescriptor

java.lang.Object

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

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

All Implemented Interfaces:

StructConverter

public final class MultiPayloadEnumDescriptor
extends SwiftTypeMetadataStructure

Represents a Swift MultiPayloadEnumDescriptor structure

See Also:

• swift/RemoteInspection/Records.h

Field Summary

Fields

Modifier and Type	Field	Description
static final int	PEEK_SIZE	How many bytes it requires to peek at size of the contents array
static final int	SIZE	The size (in bytes) of a MultiPayloadEnumDescriptor structure.

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
MultiPayloadEnumDescriptor(BinaryReader reader)	Creates a new MultiPayloadEnumDescriptor

Method Summary

Modifier and Type	Method	Description
int[]	getContents()	Returns the contents.
long	getContentsSize()	Returns the size of the contents in bytes.
String	getDescription()	Returns a short description of the SwiftTypeMetadataStructure.
String	getStructureName()	Returns the name of the SwiftTypeMetadataStructure.
String	getTypeName()	Returns the type name.
static int	peekContentsSize(BinaryReader reader)	Returns the size of the contents in bytes, without reading the contents.
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.SwiftTypeMetadataStructure

getBase, getTrailingObjects

Methods inherited from class java.lang.Object

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

Field Details

SIZE

public static final int SIZE

The size (in bytes) of a MultiPayloadEnumDescriptor structure. This size does not take into account the size of the contents array.

See Also:

• getContentsSize()
• Constant Field Values

PEEK_SIZE

public static final int PEEK_SIZE

How many bytes it requires to peek at size of the contents array

See Also:

• Constant Field Values

Constructor Details

MultiPayloadEnumDescriptor

public MultiPayloadEnumDescriptor(BinaryReader reader)
                           throws IOException

Creates a new MultiPayloadEnumDescriptor

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

getTypeName

public String getTypeName()

Returns the type name.

Returns:

the type name

getContents

public int[] getContents()

Returns the contents.

Returns:

the contents

getContentsSize

public long getContentsSize()

Returns the size of the contents in bytes.

Returns:

the size of the contents in bytes

peekContentsSize

public static int peekContentsSize(BinaryReader reader)
                            throws IOException

Returns the size of the contents in bytes, without reading the contents.

This method will leave the BinaryReader's position unaffected.

Parameters:

reader - A BinaryReader positioned at the start of the structure

Returns:

the size of the contents in bytes, without reading the contents

Throws:

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

getStructureName

public String getStructureName()

Description copied from class: SwiftTypeMetadataStructure

Returns the name of the SwiftTypeMetadataStructure.

Specified by:

getStructureName in class SwiftTypeMetadataStructure

Returns:

the name of the SwiftTypeMetadataStructure

getDescription

public String getDescription()

Description copied from class: SwiftTypeMetadataStructure

Returns a short description of the SwiftTypeMetadataStructure.

Specified by:

getDescription in class SwiftTypeMetadataStructure

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.

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