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

Class TargetStructDescriptor

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

All Implemented Interfaces:

SwiftStructure, StructConverter

public final class TargetStructDescriptor
extends TargetTypeContextDescriptor

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

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Gets a short description of the SwiftStructure
int	getFieldOffsetVectorOffset()	Gets the offset of the field offset vector for this struct's stored properties in its metadata, if any.
int	getNumFields()	Gets the number of stored properties in the struct.
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

TargetStructDescriptor

public TargetStructDescriptor(BinaryReader reader)
                       throws IOException

Creates a new TargetStructDescriptor

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

getNumFields

public int getNumFields()

Gets the number of stored properties in the struct. If there is a field offset vector, this is its length.

Returns:

The number of stored properties in the struct. If there is a field offset vector, this is its length.

getFieldOffsetVectorOffset

public int getFieldOffsetVectorOffset()

Gets the offset of the field offset vector for this struct's stored properties in its metadata, if any. 0 means there is no field offset vector.

Returns:

The offset of the field offset vector for this struct's stored properties in its metadata, if any. 0 means there is no field offset vector.

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