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

Class TargetGenericContextDescriptorHeader

java.lang.Object

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

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

All Implemented Interfaces:

StructConverter

public class TargetGenericContextDescriptorHeader
extends SwiftTypeMetadataStructure

Represents a Swift TargetGenericContextDescriptorHeader structure

See Also:

• swift/ABI/GenericContext.h

Field Summary

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

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Returns a short description of the SwiftTypeMetadataStructure.
GenericContextDescriptorFlags	getFlags()	Returns the flags.
int	getNumKeyArguments()	Returns the size of the "key" area of the argument layout, in words.
int	getNumParams()	Returns the number of (source-written) generic parameters, and thus the number of GenericParamDescriptors associated with this context.
int	getNumRequirements()	Returns the number of GenericRequirementDescriptors in this generic signature.
List<GenericParamDescriptor>	getParams()	Returns the List of generic parameter descriptors.
List<TargetGenericRequirementsDescriptor>	getRequirements()	Returns the List of generic requirements descriptors.
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.

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, toString, wait, wait, wait

Constructor Details

TargetGenericContextDescriptorHeader

public TargetGenericContextDescriptorHeader(BinaryReader reader)
                                     throws IOException

Creates a new TargetGenericContextDescriptorHeader

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

getNumParams

public int getNumParams()

Returns the number of (source-written) generic parameters, and thus the number of GenericParamDescriptors associated with this context.

Returns:

the number of (source-written) generic parameters, and thus the number of GenericParamDescriptors associated with this context

getNumRequirements

public int getNumRequirements()

Returns the number of GenericRequirementDescriptors in this generic signature.

Returns:

the number of GenericRequirementDescriptors in this generic signature

getNumKeyArguments

public int getNumKeyArguments()

Returns the size of the "key" area of the argument layout, in words.

Key arguments include shape classes, generic parameters, and conformance requirements which are part of the identity of the context.

Returns:

the size of the "key" area of the argument layout, in words

getFlags

public GenericContextDescriptorFlags getFlags()

Returns the flags.

Returns:

the flags

getParams

public List<GenericParamDescriptor> getParams()

Returns the List of generic parameter descriptors.

Returns:

the List of generic parameter descriptors

getRequirements

public List<TargetGenericRequirementsDescriptor> getRequirements()

Returns the List of generic requirements descriptors.

Returns:

the List of generic requirements descriptors

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.

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