TypedProgram Structure Reference


                    
                    
                    ConformanceSet

A set of conformances represented to answer “does A conform to T in S” efficiently.

Declaration

Swift

public typealias ConformanceSet = [AnyType : ConformanceTable]

Show on GitHub


                    
                    
                    ConformanceTable

A table from trait to its conformances for a given type.

Declaration

Swift

public typealias ConformanceTable = [TraitType : Set<Conformance>]

Show on GitHub


                    
                    
                    base

The program annotated by the properties of self.

Declaration

Swift

public private(set) var base: ScopedProgram { get }

Show on GitHub


                    
                    
                    imports

A map from translation unit to its imports.

Declaration

Swift

public internal(set) var imports: [TranslationUnit.ID : Set<ModuleDecl.ID>] { get }

Show on GitHub


                    
                    
                    declType

The overarching type of each declaration.

Declaration

Swift

public internal(set) var declType: [AnyDeclID : AnyType] { get }

Show on GitHub


                    
                    
                    exprType

The type of each expression.

Declaration

Swift

public internal(set) var exprType: [AnyExprID : AnyType] { get }

Show on GitHub


                    
                    
                    patternType

The type of each pattern.

Declaration

Swift

public internal(set) var patternType: [AnyPatternID : AnyType] { get }

Show on GitHub


                    
                    
                    implicitCaptures

A map from function and subscript declarations to their implicit captures.

Declaration

Swift

public internal(set) var implicitCaptures: [AnyDeclID : [ImplicitCapture]] { get }

Show on GitHub


                    
                    
                    environment

A map from generic declarations to their environment.

Declaration

Swift

public internal(set) var environment: [AnyDeclID : GenericEnvironment] { get }

Show on GitHub


                    
                    
                    synthesizedDecls

A map from module to its synthesized declarations.

Declaration

Swift

public internal(set) var synthesizedDecls: [ModuleDecl.ID : Set<SynthesizedFunctionDecl>] { get }

Show on GitHub


                    
                    
                    referredDecl

A map from name expression to its referred declaration.

Declaration

Swift

public internal(set) var referredDecl: BindingMap { get }

Show on GitHub


                    
                    
                    callOperands

A map from call expression to its operands after desugaring and implicit resolution.

Declaration

Swift

public internal(set) var callOperands: [CallID : [ArgumentResolutionResult]] { get }

Show on GitHub


                    
                    
                    foldedForm

A map from sequence expressions to their evaluation order.

Declaration

Swift

public internal(set) var foldedForm: [SequenceExpr.ID : FoldedSequenceExpr] { get }

Show on GitHub


                    
                    
                    functionAttributes

A map from functions to their attributes.

Declaration

Swift

public internal(set) var functionAttributes: [FunctionDecl.ID : FunctionAttributes] { get }

Show on GitHub


                    
                    
                    conformances

The conformances in the program.

Declaration

Swift

public internal(set) var conformances: ConformanceSet { get }

Show on GitHub


                    
                    
                    init(annotating:inParallel:reportingDiagnosticsTo:tracingInferenceIf:loggingRequirementSystemIf:)

Creates an instance annotating base with semantic information, reporting diagnostics to log and throwing iff an error was found.

Declaration

Swift

public init(
  annotating base: ScopedProgram,
  inParallel typeCheckingIsParallel: Bool = false,
  reportingDiagnosticsTo log: inout DiagnosticSet,
  tracingInferenceIf shouldTraceInference: (@Sendable (AnyNodeID, TypedProgram) -> Bool)? = nil,
  loggingRequirementSystemIf shouldLogRequirements: (@Sendable (AnyDeclID, TypedProgram) -> Bool)? = nil
) throws

Parameters

`typeCheckingIsParallel`	if `true`, the program is partitioned into chucks that are type checked separately. Otherwise, type checking is performed sequentially. Either way, the order in which declarations are being checked is nondeterministic.
`shouldTraceInference`	A closure accepting a node and its containing program, returning `true` if a trace of type inference should be logged on the console for that node. The closure is not called if `typeCheckingIsParallel` is `true`.

Show on GitHub


                    
                    
                    Module

A module within a TypedProgram.

Declaration

Swift

public typealias Module = Module_<`Self`>

Show on GitHub


                    
                    
                    loadModule(reportingDiagnosticsTo:tracingInferenceIf:loggingRequirementSystemIf:creatingContentsWith:)

Returns a copy of self in which a new module has been loaded, calling make to form its contents and reporting diagnostics to log.

Declaration

Swift

public func loadModule(
  reportingDiagnosticsTo log: inout DiagnosticSet,
  tracingInferenceIf shouldTraceInference: (@Sendable (AnyNodeID, TypedProgram) -> Bool)? = nil,
  loggingRequirementSystemIf shouldLogRequirements: (@Sendable (AnyDeclID, TypedProgram) -> Bool)? = nil,
  creatingContentsWith make: AST.ModuleLoader
) throws -> Module

Parameters


                                shouldTraceInference

A closure accepting a node and its containing program, returning true if a trace of type inference should be logged on the console for that node.

Show on GitHub


                    
                    
                    TypeCheckTask

The type checking of a collection of source files.

Declaration

Swift

private final class TypeCheckTask : Operation, @unchecked Sendable

Show on GitHub


                    
                    
                    init(partiallyFormedFrom:)

Creates a partially formed instance with empty property in preparation for type checking.

Declaration

Swift

private init(partiallyFormedFrom base: ScopedProgram)

Show on GitHub


                    
                    
                    canonical(typeOf:)

Returns the canonical form of d‘s type.

Declaration

Swift

public func canonical<T>(typeOf d: T) -> AnyType where T : DeclID

Show on GitHub


                    
                    
                    canonical(typeOf:)

Returns the canonical form of e‘s type.

Declaration

Swift

public func canonical<T>(typeOf e: T) -> AnyType where T : ExprID

Show on GitHub


                    
                    
                    canonical(_:in:)

Returns the canonical form of t in scopeOfUse.

Declaration

Swift

public func canonical(_ t: AnyType, in scopeOfUse: AnyScopeID) -> AnyType

Show on GitHub


                    
                    
                    canonical(_:in:)

Returns the canonical form of v in scopeOfUse.

Declaration

Swift

public func canonical(_ v: CompileTimeValue, in scopeOfUse: AnyScopeID) -> CompileTimeValue

Show on GitHub


                    
                    
                    canonical(_:in:)

Returns arguments with all types replaced by their canonical form in scopeOfUse.

Declaration

Swift

public func canonical(
  _ arguments: GenericArguments, in scopeOfUse: AnyScopeID
) -> GenericArguments

Show on GitHub


                    
                    
                    areEquivalent(_:_:in:)

Returns true iff t and u are semantically equivalent in scopeOfUse.

Declaration

Swift

public func areEquivalent(_ t: AnyType, _ u: AnyType, in scopeOfUse: AnyScopeID) -> Bool

Show on GitHub


                    
                    
                    specialize(_:for:in:)

Returns generic with occurrences of parameters keying specialization replaced by their corresponding value, performing necessary name lookups from scopeOfUse.

This method has no effect if substitutions is empty.

Declaration

Swift

public func specialize(
  _ generic: AnyType, for specialization: GenericArguments, in scopeOfUse: AnyScopeID
) -> AnyType

Show on GitHub


                    
                    
                    specialize(_:for:in:)

Returns arguments applying specialization on each value in scopeOfUse.

Declaration

Swift

public func specialize(
  _ arguments: GenericArguments, for specialization: GenericArguments,
  in scopeOfUse: AnyScopeID
) -> GenericArguments

Show on GitHub


                    
                    
                    isTriviallyDeinitializable(_:in:)

Returns true iff deinitializing an instance of t in scopeOfUse is a no-op.

A type is “trivially deinitializable” if deinitializing its instances doesn’t have runtime effects. Built-in types are trivially deinitializable. Types composed only of trivially deinitializable parts are trivially deinitializable unless there exists a non-synthetic conformance to Deinitializable in scope.

Declaration

Swift

public func isTriviallyDeinitializable(_ t: AnyType, in scopeOfUse: AnyScopeID) -> Bool

Show on GitHub


                    
                    
                    isTrivialModel(_:of:in:)

Returns true iff t models coreConcept without any user-defined semantics.

Declaration

Swift

private func isTrivialModel(
  _ t: AnyType, of coreConcept: TraitType, in scopeOfUse: AnyScopeID
) -> Bool

Show on GitHub


                    
                    
                    isTrivial(_:)

Returns true iff c has no user-defined semantics.

Declaration

Swift

public func isTrivial(_ c: Conformance) -> Bool

Show on GitHub


                    
                    
                    storage(of:)

If t has a record layout, returns the names and types of its stored properties.

Declaration

Swift

public func storage(of t: AnyType) -> [TupleType.Element]

Show on GitHub


                    
                    
                    storage(of:)

Returns the names and types of t‘s stored properties.

Declaration

Swift

public func storage(of t: ArrowType) -> [TupleType.Element]

Show on GitHub


                    
                    
                    storage(of:)

Returns the names and types of t‘s stored properties.

Declaration

Swift

public func storage(of t: BoundGenericType) -> [TupleType.Element]

Show on GitHub


                    
                    
                    storage(of:)

Returns the names and types of t‘s stored properties.

Declaration

Swift

public func storage(of t: BufferType) -> [TupleType.Element]

Show on GitHub


                    
                    
                    storage(of:)

Returns the names and types of t‘s stored properties.

Declaration

Swift

public func storage(of t: ProductType) -> [TupleType.Element]

Show on GitHub


                    
                    
                    accumulatedGenericParameters(in:)

Returns generic parameters captured by s and the scopes semantically containing s.

Declaration

Swift

public func accumulatedGenericParameters<T: ScopeID>(
  in s: T
) -> [GenericParameterDecl.ID]

Show on GitHub


                    
                    
                    traitDeclaring(_:)

Returns the trait of which d is a member, or nil if d isn’t member of a trait.

Declaration

Swift

public func traitDeclaring<T>(_ d: T) -> TraitType? where T : DeclID

Show on GitHub


                    
                    
                    requirementDeclaring(_:)

If d is member of a trait c, returns (d, c) if d is a requirement, or (r, c) if d is a default implementation of a requirement r; returns nil otherwise.

Declaration

Swift

public func requirementDeclaring(_ d: AnyDeclID) -> (decl: AnyDeclID, trait: TraitType)?

Show on GitHub


                    
                    
                    conforms(_:to:in:)

Returns true iff model conforms to concept in scopeOfUse.

Declaration

Swift

public func conforms(
  _ model: AnyType, to concept: TraitType, in scopeOfUse: AnyScopeID
) -> Bool

Show on GitHub


                    
                    
                    allConform(_:to:in:)

Returns true iff all elements in models conform to concept in scopeOfUse.

Declaration

Swift

public func allConform<S: Sequence<AnyType>>(
  _ models: S, to concept: TraitType, in scopeOfUse: AnyScopeID
) -> Bool

Show on GitHub


                    
                    
                    conformance(of:to:exposedTo:)

Returns the conformance of model to concept that is exposed to scopeOfUse, or nil if such a conformance doesn’t exist.

Declaration

Swift

public func conformance(
  of model: AnyType, to concept: TraitType, exposedTo scopeOfUse: AnyScopeID
) -> Conformance?

Show on GitHub


                    
                    
                    concreteConformance(of:to:exposedTo:)

Returns the explicitly declared conformance of model to concept that is exposed to scopeOfUse, or nil if such a conformance doesn’t exist.

This method returns nil if the conformance of model to concept is structural (e.g., a tuple’s synthesized conformance to Movable) or if the conformance is implied by a trait bound (e.g., T: P in fun f<T: P>() {}).

Do not call concreteConformance during type checking.

Requires

model is canonical.

Declaration

Swift

private func concreteConformance(
  of model: AnyType, to concept: TraitType, exposedTo scopeOfUse: AnyScopeID
) -> Conformance?

Show on GitHub


                    
                    
                    abstractConformance(of:to:exposedTo:)

Returns the conformance of model to concept that is implied by the generic environment introducing model in scopeOfUse, or nil if such a conformance doesn’t exist.

The result of this method is valid iff a call to concreteConformance(of:to:exposedTo:) with the same arguments has returned nil.

Requires

model is canonical.

Declaration

Swift

private func abstractConformance(
  of model: AnyType, to concept: TraitType, exposedTo scopeOfUse: AnyScopeID
) -> Conformance?

Show on GitHub


                    
                    
                    structuralConformance(of:to:exposedTo:)

Returns the implicit structural conformance of model to concept that is exposed to scopeOfUse, or nil if such a conformance doesn’t exist.

Declaration

Swift

private func structuralConformance(
  of model: AnyType, to concept: TraitType, exposedTo scopeOfUse: AnyScopeID
) -> Conformance?

Show on GitHub


                    
                    
                    associatedType(_:for:)

Returns the type satisfying the associated type requirement n in conformance c.

Requires

n is declared by the trait for which c has been established.

Declaration

Swift

public func associatedType(_ n: AssociatedTypeDecl.ID, for c: Conformance) -> AnyType

Show on GitHub


                    
                    
                    foreignRepresentation(of:exposedTo:)

Returns the foreign representation of t using its conformance to ForeignConvertible in scopeOfUse.

Requires

t conforms to ForeignConvertible in scopeOfUse.

Declaration

Swift

public func foreignRepresentation(
  of t: AnyType, exposedTo scopeOfUse: AnyScopeID
) -> AnyType

Show on GitHub


                    
                    
                    modules(exposedTo:)

Returns the modules visible to s.

Declaration

Swift

public func modules(exposedTo s: AnyScopeID) -> Set<ModuleDecl.ID>

Show on GitHub


                    
                    
                    canonicalType(of:specializedBy:in:)

Returns the type of d specialized by specialization in scopeOfUse.

Declaration

Swift

public func canonicalType<T: Decl>(
  of d: T.ID, specializedBy specialization: GenericArguments, in scopeOfUse: AnyScopeID
) -> AnyType

Show on GitHub


                    
                    
                    captures(of:)

Returns the declarations of d‘s captures.

If d is a member, its receiver is its only capture. Otherwise, this method returns nonMemberCaptures(d).

Declaration

Swift

public func captures(of d: FunctionDecl.ID) -> [AnyDeclID]

Show on GitHub


                    
                    
                    captures(of:)

Returns the declarations of d‘s captures.

If d is a member, its receiver is its only capture. Otherwise, this method returns nonMemberCaptures(d).

Declaration

Swift

public func captures(of d: SubscriptImpl.ID) -> [AnyDeclID]

Show on GitHub


                    
                    
                    nonMemberCaptures(of:)

Returns the declarations of d‘s captures.

Explicit captures come first, in the order they appear in its capture list, from left to right. Implicit captures come next, in the order they were found during type checking.

Requires

d is not a member declaration.

Declaration

Swift

public func nonMemberCaptures<T>(of d: T.ID) -> [AnyDeclID] where T : CapturingDecl

Show on GitHub


                    
                    
                    runtimeParameters(of:)

Returns the run-time parameters of e, which is the callee of a function or subscript call, if e is a reference to a callable declaration.

Declaration

Swift

public func runtimeParameters(of callee: AnyExprID) -> [ParameterDecl.ID]?

Show on GitHub


                    
                    
                    write(_:at:mergingWith:)

Applies merge(self[keyPath: path], value).

Declaration

Swift

mutating func write<V>(
  _ value: V, at path: WritableKeyPath<Self, V>,
  mergingWith merge: (inout V, V) -> Void
)

Parameters


                                merge

A closure that merges value into the value currently stored at path, guaranteeing that the result of the merge is a refinement.

Show on GitHub


                    
                    
                    write(_:at:)

Writes value at path.

Requires

value contains at least as much information as self[keyPath: path].

Declaration

Swift

mutating func write<V>(
  _ value: V, at path: WritableKeyPath<Self, V>
) where V: Monotonic

Show on GitHub


                    
                    
                    describe(_:)

Returns a debug description of m.

Declaration

Swift

func describe(_ m: RequirementSystem) -> String

Show on GitHub


                    
                    
                    describe(_:)

Returns a debug description of r.

Declaration

Swift

func describe(_ r: RequirementRule) -> String

Show on GitHub


                    
                    
                    describe(_:)

Returns a debug description of t.

Declaration

Swift

func describe(_ t: RequirementTerm) -> String

Show on GitHub

ast

The AST of the program.

Declaration

Swift

public var ast: AST { get }

Show on GitHub


                    
                    
                    nodeToScope

A map from node to the innermost scope that contains it.

Declaration

Swift

public var nodeToScope: ASTProperty<AnyScopeID> { get }

Show on GitHub


                    
                    
                    scopeToDecls

A map from scope to the declarations directly contained in it.

Declaration

Swift

public var scopeToDecls: ASTProperty<DeclIDs> { get }

Show on GitHub


                    
                    
                    varToBinding

A map from variable declaration its containing binding declaration.

Declaration

Swift

public var varToBinding: [VarDecl.ID : BindingDecl.ID] { get }

Show on GitHub