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

Class TargetProtocolDescriptor

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

All Implemented Interfaces:

StructConverter

public final class TargetProtocolDescriptor
extends TargetContextDescriptor

Represents a Swift TargetProtocolDescriptor 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
TargetProtocolDescriptor(BinaryReader reader)	Creates a new TargetProtocolDescriptor

Method Summary

Modifier and Type	Method	Description
int	getAssociatedTypeNames()
String	getDescription()	Returns a short description of the SwiftTypeMetadataStructure.
String	getName()	Returns the name of the protocol.
int	getNumRequirements()	Returns the number of requirements in the protocol.
int	getNumRequirementsInSignature()	Returns the number of generic requirements in the requirement signature of the protocol.
List<TargetProtocolRequirement>	getRequirements()	Returns a List of requirements in the protocol.
List<TargetGenericRequirementsDescriptor>	getRequirementsInSignature()	Returns a List of generic requirements in the requirement signature of the protocol.
String	getStructureName()	Returns the name of the SwiftTypeMetadataStructure.
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.
String	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

TargetProtocolDescriptor

public TargetProtocolDescriptor(BinaryReader reader)
                         throws IOException

Creates a new TargetProtocolDescriptor

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

getName

public String getName()

Returns the name of the protocol.

Returns:

the name of the protocol

getNumRequirementsInSignature

public int getNumRequirementsInSignature()

Returns the number of generic requirements in the requirement signature of the protocol.

Returns:

the number of generic requirements in the requirement signature of the protocol

getNumRequirements

public int getNumRequirements()

Returns the number of requirements in the protocol.

Returns:

the number of requirements in the protocol

getAssociatedTypeNames

public int getAssociatedTypeNames()

Returns:

the associated type names}

getRequirementsInSignature

public List<TargetGenericRequirementsDescriptor> getRequirementsInSignature()

Returns a List of generic requirements in the requirement signature of the protocol.

Returns:

a List of generic requirements in the requirement signature of the protocol

getRequirements

public List<TargetProtocolRequirement> getRequirements()

Returns a List of requirements in the protocol.

Returns:

a List of requirements in the protocol

toString

public String toString()

Overrides:

toString in class Object

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 TargetContextDescriptor

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 TargetContextDescriptor

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 TargetContextDescriptor

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