protocols

Documentation

Index

• Constants
• type CDType
• type ConformanceDescriptor
• type Descriptor
  • func (d Descriptor) GetProtocolContextDescriptorFlags() ProtocolContextDescriptorFlags
  • func (d Descriptor) String() string
• type GRKind
  • func (i GRKind) String() string
• type GenericRequirementFlags
  • func (f GenericRequirementFlags) HasExtraArgument() bool
  • func (f GenericRequirementFlags) HasKeyArgument() bool
  • func (f GenericRequirementFlags) Kind() GRKind
  • func (f GenericRequirementFlags) String() string
• type PRKind
  • func (i PRKind) String() string
• type Protocol
  • func (p Protocol) String() string
• type ProtocolContextDescriptorFlags
  • func (i ProtocolContextDescriptorFlags) String() string
• type ProtocolRequirementFlags
  • func (f ProtocolRequirementFlags) ExtraDiscriminator() uint16
  • func (f ProtocolRequirementFlags) IsAsync() bool
  • func (f ProtocolRequirementFlags) IsFunctionImpl() bool
  • func (f ProtocolRequirementFlags) IsInstance() bool
  • func (f ProtocolRequirementFlags) IsSignedWithAddress() bool
  • func (f ProtocolRequirementFlags) Kind() PRKind
  • func (f ProtocolRequirementFlags) String() string
• type TargetGenericRequirementDescriptor
• type TargetProtocolRequirement

Constants

const (
	UnusedLowBits conformanceFlag = 0x07 // historical conformance kind

	TypeMetadataKindMask  conformanceFlag = 0x7 << 3 // 8 type reference kinds
	TypeMetadataKindShift conformanceFlag = 3

	IsRetroactiveMask          conformanceFlag = 0x01 << 6
	IsSynthesizedNonUniqueMask conformanceFlag = 0x01 << 7

	NumConditionalRequirementsMask  conformanceFlag = 0xFF << 8
	NumConditionalRequirementsShift conformanceFlag = 8

	HasResilientWitnessesMask  conformanceFlag = 0x01 << 16
	HasGenericWitnessTableMask conformanceFlag = 0x01 << 17
)

const (
	// The conformance is for a nominal type referenced directly;
	// getTypeDescriptor() points to the type context descriptor.
	DirectTypeDescriptor referenceKind = 0x00

	// The conformance is for a nominal type referenced indirectly;
	// getTypeDescriptor() points to the type context descriptor.
	IndirectTypeDescriptor referenceKind = 0x01

	// The conformance is for an Objective-C class that should be looked up
	// by class name.
	DirectObjCClassName referenceKind = 0x02

	// The conformance is for an Objective-C class that has no nominal type
	// descriptor.
	// getIndirectObjCClass() points to a variable that contains the pointer to
	// the class object, which then requires a runtime call to get metadata.
	//
	// On platforms without Objective-C interoperability, this case is
	// unused.
	IndirectObjCClass referenceKind = 0x03
)

Types

type CDType

type CDType struct {
	ProtocolDescriptorOffset int32
	TypeRefOffset            int32
	WitnessTableOffset       int32
	Flags                    conformanceFlag
}

ConformanceDescriptor in __TEXT.__swift5_proto This section contains an array of 32-bit signed integers. Each integer is a relative offset that points to a protocol conformance descriptor in the __TEXT.__const section.

type ConformanceDescriptor

type ConformanceDescriptor struct {
	Protocol     string
	TypeRef      int32
	WitnessTable int32
	CDType
}

type Descriptor

type Descriptor struct {
	Flags                      types.ContextDescriptorFlags // overide kind specific flags w/ ProtocolContextDescriptorFlags TODO: handle kind specific flags
	ParentOffset               int32
	NameOffset                 int32  // The name of the protocol.
	NumRequirementsInSignature uint32 // The number of generic requirements in the requirement signature of the protocol.
	NumRequirements            uint32 /* The number of requirements in the protocol. If any requirements beyond MinimumWitnessTableSizeInWords are present
	 * in the witness table template, they will be not be overwritten with defaults. */
	AssociatedTypeNamesOffset int32 // Associated type names, as a space-separated list in the same order as the requirements.
}

Descriptor in __TEXT.__swift5_protos This section contains an array of 32-bit signed integers. Each integer is a relative offset that points to a protocol descriptor in the __TEXT.__const section.

func (Descriptor) GetProtocolContextDescriptorFlags

func (d Descriptor) GetProtocolContextDescriptorFlags() ProtocolContextDescriptorFlags

func (Descriptor) String

func (d Descriptor) String() string

type GRKind

type GRKind uint8

const (
	GRKindProtocol  GRKind = 0 // A protocol requirement.
	GRKindSameType  GRKind = 1 // A same-type requirement.
	GRKindBaseClass GRKind = 2 // A base class requirement.
	// A "same-conformance" requirement, implied by a same-type or base-class constraint that binds a parameter with protocol requirements.
	GRKindSameConformance GRKind = 3
	GRKindLayout          GRKind = 0x1F // A layout constraint.
)

func (GRKind) String

func (i GRKind) String() string

type GenericRequirementFlags

type GenericRequirementFlags uint32

func (GenericRequirementFlags) HasExtraArgument

func (f GenericRequirementFlags) HasExtraArgument() bool

func (GenericRequirementFlags) HasKeyArgument

func (f GenericRequirementFlags) HasKeyArgument() bool

func (GenericRequirementFlags) Kind

func (f GenericRequirementFlags) Kind() GRKind

func (GenericRequirementFlags) String

func (f GenericRequirementFlags) String() string

type PRKind

type PRKind uint8

const (
	BaseProtocol PRKind = iota
	Method
	Init
	Getter
	Setter
	ReadCoroutine
	ModifyCoroutine
	AssociatedTypeAccessFunction
	AssociatedConformanceAccessFunction
)

func (PRKind) String

func (i PRKind) String() string

type Protocol

type Protocol struct {
	Name           string
	AssociatedType string
	Parent         *Protocol
	Descriptor
	SignatureRequirements []TargetGenericRequirementDescriptor
	Requirements          []TargetProtocolRequirement
}

Protocol swift protocol object

func (Protocol) String

func (p Protocol) String() string

type ProtocolContextDescriptorFlags

type ProtocolContextDescriptorFlags uint16

ProtocolContextDescriptorFlags flags for protocol context descriptors. These values are used as the kindSpecificFlags of the ContextDescriptorFlags for the protocol.

const (
	/// Whether this protocol is class-constrained.
	HasClassConstraint       ProtocolContextDescriptorFlags = 0
	HasClassConstraint_width ProtocolContextDescriptorFlags = 1
	/// Whether this protocol is resilient.
	IsResilient ProtocolContextDescriptorFlags = 1
	/// Special protocol value.
	SpecialProtocolKind       ProtocolContextDescriptorFlags = 2
	SpecialProtocolKind_width ProtocolContextDescriptorFlags = 6
)

func (ProtocolContextDescriptorFlags) String

func (i ProtocolContextDescriptorFlags) String() string

type ProtocolRequirementFlags

type ProtocolRequirementFlags uint32

func (ProtocolRequirementFlags) ExtraDiscriminator

func (f ProtocolRequirementFlags) ExtraDiscriminator() uint16

func (ProtocolRequirementFlags) IsAsync

func (f ProtocolRequirementFlags) IsAsync() bool

func (ProtocolRequirementFlags) IsFunctionImpl

func (f ProtocolRequirementFlags) IsFunctionImpl() bool

func (ProtocolRequirementFlags) IsInstance

func (f ProtocolRequirementFlags) IsInstance() bool

func (ProtocolRequirementFlags) IsSignedWithAddress

func (f ProtocolRequirementFlags) IsSignedWithAddress() bool

func (ProtocolRequirementFlags) Kind

func (f ProtocolRequirementFlags) Kind() PRKind

func (ProtocolRequirementFlags) String

func (f ProtocolRequirementFlags) String() string

type TargetGenericRequirementDescriptor

type TargetGenericRequirementDescriptor struct {
	Flags                               GenericRequirementFlags
	Param                               int32 // The type that's constrained, described as a mangled name.
	TypeOrProtocolOrConformanceOrLayout int32 // UNION: flags determine type
}

type TargetProtocolRequirement

type TargetProtocolRequirement struct {
	Flags                 ProtocolRequirementFlags
	DefaultImplementation int32
}