Program Protocol Reference

ast

The AST of the program.

Declaration

Swift

var ast: AST { get }

Show on GitHub


                    
                    
                    nodeToScope

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

Declaration

Swift

var nodeToScope: ASTProperty<AnyScopeID> { get }

Show on GitHub


                    
                    
                    scopeToDecls

A map from scope to the declarations that it contains.

Declaration

Swift

var scopeToDecls: ASTProperty<DeclIDs> { get }

Show on GitHub


                    
                    
                    varToBinding

A map from variable declaration its containing binding declaration.

Declaration

Swift

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

Show on GitHub


                    
                    
                    subscript(_:)

Extension method

Projects the node associated with id bundled with its extrinsic relationships.

Declaration

Swift

public subscript<T>(id: T) -> BundledNode<T, Self> where T : NodeIDProtocol { get }

Show on GitHub


                    
                    
                    isModuleEntry(_:)

Extension method

Returns true iff d is a module’s entry function.

Declaration

Swift

public func isModuleEntry(_ d: FunctionDecl.ID) -> Bool

Show on GitHub


                    
                    
                    builtinIsVisible(in:)

Extension method

true iff the Builtin module is visible in s.

Declaration

Swift

public func builtinIsVisible(in s: AnyScopeID) -> Bool

Show on GitHub


                    
                    
                    isContained(_:in:)

Extension method

Returns whether child is contained in ancestor.

Lexical scope containment is transitive and reflexive; this method returns true if:

child == ancestor, or
parent[child] == ancestor, or
isContained(parent[child], ancestor).

Requires

child is the identifier of a scope in this hierarchy.

Declaration

Swift

public func isContained<T, U>(_ child: T, in ancestor: U) -> Bool where T : NodeIDProtocol, U : ScopeID

Show on GitHub


                    
                    
                    areInSameModule(_:_:)

Extension method

Returns whether l and r are in the same module.

Declaration

Swift

public func areInSameModule<L, R>(_ l: L, _ r: R) -> Bool where L : NodeIDProtocol, R : NodeIDProtocol

Show on GitHub


                    
                    
                    areOverlapping(_:_:)

Extension method

Returns whether l overlaps with r.

Declaration

Swift

public func areOverlapping(_ l: AnyScopeID, _ r: AnyScopeID) -> Bool

Show on GitHub


                    
                    
                    hasMoreAncestors(_:than:)

Extension method

Returns true iff l is lexically enclosed in more scopes than r.

Declaration

Swift

public func hasMoreAncestors<T: NodeIDProtocol, U: NodeIDProtocol>(
  _ l: T, than r: U
) -> Bool

Show on GitHub


                    
                    
                    compareLexicalDepth(_:_:in:)

Extension method

Compares lhs and rhs in scopeOfUse and returns whether one lexically shadows the other.

lhs is lexically deeper than rhs w.r.t. scopeOfUse if any of these statements hold:

lhs is declared in the module containing scopeOfUse and rhs isn’t.
lhs and rhs are declared in module containing scopeOfUse and lhs has more ancestors than rhs.

Declaration

Swift

public func compareLexicalDepth<T: NodeIDProtocol, U: NodeIDProtocol>(
  _ lhs: T, _ rhs: U, in scopeOfUse: AnyScopeID
) -> StrictPartialOrdering

Show on GitHub


                    
                    
                    scopeContainingBody(of:)

Extension method

Returns the scope of d‘s body, if any.

Declaration

Swift

public func scopeContainingBody(of d: FunctionDecl.ID) -> AnyScopeID?

Show on GitHub


                    
                    
                    scopeContainingBody(of:)

Extension method

Returns the scope of d‘s body, if any.

Declaration

Swift

public func scopeContainingBody(of d: MethodImpl.ID) -> AnyScopeID?

Show on GitHub


                    
                    
                    scopeContainingBody(of:)

Extension method

Returns the scope of d‘s body, if any.

Declaration

Swift

public func scopeContainingBody(of d: SubscriptImpl.ID) -> AnyScopeID?

Show on GitHub


                    
                    
                    isCallableBody(_:)

Extension method

Returns true iff s is the body of a function, initializer, or subscript.

Declaration

Swift

public func isCallableBody(_ s: BraceStmt.ID) -> Bool

Show on GitHub


                    
                    
                    siblings(of:)

Extension method

Returns d and the parameters and explicit captures introduced in the same scope.

Declaration

Swift

public func siblings(of d: ParameterDecl.ID) -> [AnyDeclID]

Show on GitHub


                    
                    
                    parametersAndCaptures(inBodyOf:)

Extension method

Returns the parameters and explicit captures introduced in the body of d.

Declaration

Swift

private func parametersAndCaptures(inBodyOf d: AnyDeclID) -> [AnyDeclID]

Show on GitHub


                    
                    
                    isAtModuleScope(_:)

Extension method

Returns true iff d is at module scope.

Declaration

Swift

public func isAtModuleScope<T>(_ d: T) -> Bool where T : DeclID

Show on GitHub


                    
                    
                    isGlobal(_:)

Extension method

Returns whether decl is global.

A declaration is global if and only if:

it is a type declaration; or
it is declared at global or namespace scope; or
it is declared at type scope and it is static; or
it is introduced with init or memberwise init.

Declaration

Swift

public func isGlobal<T>(_ decl: T) -> Bool where T : DeclID

Show on GitHub


                    
                    
                    isMember(_:)

Extension method

Returns whether d is member of a type declaration.

Declaration

Swift

public func isMember<T>(_ d: T) -> Bool where T : DeclID

Show on GitHub


                    
                    
                    isNonStaticMember(_:)

Extension method

Returns whether decl is a non-static member of a type declaration.

Declaration

Swift

public func isNonStaticMember<T>(_ decl: T) -> Bool where T : DeclID

Show on GitHub


                    
                    
                    isNonStaticMember(_:)

Extension method

Returns whether decl is a non-static member of a type declaration.

Declaration

Swift

public func isNonStaticMember(_ decl: FunctionDecl.ID) -> Bool

Show on GitHub


                    
                    
                    isNonStaticMember(_:)

Extension method

Returns whether decl is a non-static member of a type declaration.

Declaration

Swift

public func isNonStaticMember(_ decl: MethodDecl.ID) -> Bool

Show on GitHub


                    
                    
                    isNonStaticMember(_:)

Extension method

Returns whether decl is a non-static member of a type declaration.

Declaration

Swift

public func isNonStaticMember(_ decl: SubscriptDecl.ID) -> Bool

Show on GitHub


                    
                    
                    isLocal(_:)

Extension method

Returns whether decl is local in ast.

Declaration

Swift

public func isLocal<T>(_ decl: T) -> Bool where T : DeclID

Show on GitHub


                    
                    
                    isPublic(_:)

Extension method

Returns true iff d is public.

Declaration

Swift

public func isPublic<T>(_ d: T) -> Bool where T : DeclID

Show on GitHub


                    
                    
                    isAccessibleAsRequirementImplementation(_:)

Extension method

Returns true iff d has the appropriate visibility when used as the implementation of a trait requirement.

Declaration

Swift

public func isAccessibleAsRequirementImplementation<T>(_ d: T) -> Bool where T : DeclID

Show on GitHub


                    
                    
                    isExported(_:)

Extension method

Returns true iff d is visible outside of its module.

Note

modules are considered exported.

Declaration

Swift

public func isExported<T>(_ d: T) -> Bool where T : DeclID

Show on GitHub


                    
                    
                    isExportingDecls(_:)

Extension method

Returns true iff the public declarations in s are visible outside of their module.

Declaration

Swift

public func isExportingDecls(_ s: AnyScopeID) -> Bool

Show on GitHub


                    
                    
                    isDefinedInExtension(_:)

Extension method

Returns true iff d is defined in an extension.

Declaration

Swift

public func isDefinedInExtension<T>(_ d: T) -> Bool where T : DeclID

Show on GitHub


                    
                    
                    isRequirement(_:)

Extension method

Returns true iff d is a trait requirement.

Declaration

Swift

public func isRequirement<T>(_ d: T) -> Bool where T : DeclID

Show on GitHub


                    
                    
                    isImplicitDefinition(_:)

Extension method

Returns true iff d declares a value usable as an implicit parameter.

Declaration

Swift

public func isImplicitDefinition(_ d: AnyDeclID) -> Bool

Show on GitHub


                    
                    
                    innermostReceiver(in:)

Extension method

If s is in a member context, returns the innermost receiver declaration exposed to s. Otherwise, returns nil

Declaration

Swift

public func innermostReceiver(in useScope: AnyScopeID) -> ParameterDecl.ID?

Show on GitHub


                    
                    
                    scopes(from:)

Extension method

Returns a sequence containing scope and all its ancestors, from inner to outer.

Declaration

Swift

public func scopes<S>(from scope: S) -> LexicalScopeSequence where S : ScopeID

Show on GitHub


                    
                    
                    innermostCommonScope(_:_:)

Extension method

Returns the innermost scope that is a common ancestor of a and b or nil if a and b are in different modules.

Declaration

Swift

public func innermostCommonScope(_ a: AnyScopeID, _ b: AnyScopeID) -> AnyScopeID?

Show on GitHub


                    
                    
                    module(containing:)

Extension method

Returns the module containing scope.

Declaration

Swift

public func module<S>(containing scope: S) -> ModuleDecl.ID where S : ScopeID

Show on GitHub


                    
                    
                    source(containing:)

Extension method

Returns the translation unit containing scope.

Requires

Requires:scope is not a module.

Declaration

Swift

public func source<S>(containing scope: S) -> TranslationUnit.ID where S : ScopeID

Show on GitHub


                    
                    
                    name(of:)

Extension method

Returns the name of d.

Declaration

Swift

public func name<T>(of d: T) -> Name? where T : DeclID

Show on GitHub


                    
                    
                    subfieldRelativeToRoot(of:)

Extension method

Returns (root: r, path: p) where root is the binding declaration introducing d and p is the path to the object bound to d relative to root.

Declaration

Swift

public func subfieldRelativeToRoot(
  of d: VarDecl.ID
) -> (root: BindingDecl.ID, path: RecordPath)

Show on GitHub


                    
                    
                    storedParts(of:)

Extension method

Returns the declarations of the stored part of p.

Declaration

Swift

public func storedParts(of p: ProductTypeDecl.ID) -> [VarDecl.ID]

Show on GitHub


                    
                    
                    debugDescription(_:)

Extension method

Returns a textual description of n suitable for debugging.

Declaration

Swift

public func debugDescription<T>(_ n: T) -> String where T : NodeIDProtocol

Show on GitHub


                    
                    
                    debugDescription(_:)

Extension method

Returns a textual description of d suitable for debugging.

Declaration

Swift

public func debugDescription(_ d: BindingDecl.ID) -> String

Show on GitHub


                    
                    
                    makeReference(to:specializedBy:memberOf:exposedTo:usedAsConstructor:)

Extension method

Returns a reference to d as a member of parent, specialized by specialization, exposed to scopeOfUse, and used as a constructor if isConstructor is true.

Declaration

Swift

fileprivate func makeReference(
  to d: AnyDeclID, specializedBy specialization: GenericArguments,
  memberOf parent: NameResolutionContext?,
  exposedTo scopeOfUse: AnyScopeID,
  usedAsConstructor isConstructor: Bool
) -> DeclReference

Show on GitHub