AST

public struct AST : Sendable

extension AST: Codable

An abstract syntax tree.

Show on GitHub

ModuleLoader
A function inserting the contents of a module in ast, registering the identities of newly formed ASTs in nodeSpace and reporting diagnostics to log.
Declaration
Swift

public typealias ModuleLoader = ( _ ast: inout AST, _ log: inout DiagnosticSet, _ nodeSpace: Int ) throws -> ModuleDecl.ID
Show on GitHub
Storage
The stored representation of an AST; distinguished for encoding/decoding purposes.
See more
Declaration
Swift

private struct Storage : Codable
Show on GitHub
storage
The notional stored properties of self; distinguished for encoding/decoding purposes.
Declaration
Swift

private var storage: Storage
Show on GitHub
coreTraits
The traits in Hylo’s standard library that are known by the compiler.
Declaration
Swift

public var coreTraits: CoreTraits? { get set }
Show on GitHub
modules
The indices of the modules.

Invariant
All referred modules have a different name.
Declaration
Swift

public private(set) var modules: [ModuleDecl.ID] { get set }
Show on GitHub
coreLibrary
The module containing Hylo’s core library, if any.
Declaration
Swift

public var coreLibrary: ModuleDecl.ID? { get set }
Show on GitHub
compilationConditions
The expansion filter used while processing conditional compilation statements in self.
Declaration
Swift

public var compilationConditions: ConditionalCompilationFactors { get }
Show on GitHub
init(_:)
Creates an empty AST, using using compilationConditions as conditions for selecting conditional compilation branches.
Declaration
Swift

public init( _ compilationConditions: ConditionalCompilationFactors = ConditionalCompilationFactors() )
Show on GitHub
createNodeSpace()
Creates a new node space and returns its identifier.
Declaration
Swift

public mutating func createNodeSpace() -> Int
Show on GitHub


                    
                    
                    loadModule(inNodeSpace:reportingDiagnosticsTo:creatingContentsWith:)

Loads a new module in self, calling make to parse its contents and reporting diagnostics to log.

Declaration

Swift

public mutating func loadModule(
  inNodeSpace space: Int? = nil,
  reportingDiagnosticsTo log: inout DiagnosticSet,
  creatingContentsWith parseSources: ModuleLoader
) rethrows -> ModuleDecl.ID

Show on GitHub


                    
                    
                    loadModule(_:parsing:inNodeSpace:withBuiltinModuleAccess:reportingDiagnosticsTo:)

Loads a new module in self, parsing its contents from sourceCode, registering the identities of newly formed ASTs in space space, and reporting diagnostics to log.

Declaration

Swift

public mutating func loadModule<S: Sequence>(
  _ name: String, parsing sourceCode: S, inNodeSpace space: Int? = nil,
  withBuiltinModuleAccess builtinModuleAccess: Bool = false,
  reportingDiagnosticsTo log: inout DiagnosticSet
) throws -> ModuleDecl.ID where S.Element == SourceFile

Parameters

`name`	The name of the loaded module.
`sourceCode`	The URL of a single source file or the root directory of the module.
`space`	The space in which the module’s ASTs are registered. This argument should be `nil` unless this method is called in a module loader.
`builtinModuleAccess`	Whether the module is allowed to access the builtin module.
`log`	A set extended with the diagnostics reported by this method.

Show on GitHub

insert(_:inNodeSpace:reportingDiagnosticsTo:)
Inserts n into self, registering its identity in space k and reporting well-formedness issues to log.
Declaration
Swift

public mutating func insert<T: Node>( _ n: T, inNodeSpace k: Int, reportingDiagnosticsTo log: inout DiagnosticSet ) -> T.ID
Show on GitHub
insert(synthesized:inNodeSpace:)
Inserts n into self, registering its identity in space k.

Precondition
n is well formed.
Declaration
Swift

public mutating func insert<T>(synthesized n: T, inNodeSpace k: Int) -> T.ID where T : Node
Show on GitHub

Node access


                    
                    
                    subscript(_:)

Accesses the node identified by i.

Declaration

Swift

public subscript<T>(i: T) -> T.Subject where T : ConcreteNodeID { get }

Show on GitHub


                    
                    
                    subscript(_:)

Accesses the node identified by i.

Declaration

Swift

public subscript<T>(i: T?) -> T.Subject? where T : ConcreteNodeID { get }

Show on GitHub


                    
                    
                    subscript(_:)

Accesses the node identified by i.

Declaration

Swift

public subscript<T>(i: T) -> Node where T : NodeIDProtocol { get }

Show on GitHub


                    
                    
                    subscript(_:)

Accesses the node identified by i.

Declaration

Swift

public subscript<T>(i: T?) -> Node? where T : NodeIDProtocol { get }

Show on GitHub


                    
                    
                    ConcreteProjectedSequence

A sequence of concrete nodes projected from an AST.

Declaration

Swift

public typealias ConcreteProjectedSequence<T> = LazyMapSequence<
  LazySequence<T>.Elements,
  T.Element.Subject
> where T: Sequence, T.Element: ConcreteNodeID

Show on GitHub


                    
                    
                    subscript(_:)

Projects a sequence containing the nodes at positions.

Declaration

Swift

public subscript<T>(positions: T) -> ConcreteProjectedSequence<T> where T : Sequence, T.Element : ConcreteNodeID { get }

Show on GitHub

Core library

coreModuleIsLoaded
Indicates whether the Core library has been loaded.
Declaration
Swift

public var coreModuleIsLoaded: Bool { get }
Show on GitHub
optional(_:)
Returns the Hylo type of an optional t.

Requires
The Core library must have been loaded.
Declaration
Swift

public func optional(_ t: AnyType) -> UnionType
Show on GitHub
array(_:)
Returns the Hylo type of an array of t.

Requires
The Core library must have been loaded.
Declaration
Swift

public func array(_ t: AnyType) -> BoundGenericType
Show on GitHub
coreType(_:)
Returns the type named name defined in the core library or nil it does not exist.

Requires
The Core library must have been loaded.
Declaration
Swift

public func coreType(_ name: String) -> ProductType?
Show on GitHub
coreTrait(_:)
Returns the trait named name defined in the core library or nil if it does not exist.

Requires
The Core library must have been loaded.
Declaration
Swift

public func coreTrait(_ name: String) -> TraitType?
Show on GitHub
coreTrait(forTypesExpressibleBy:)
Returns the trait describing types whose instances are expressible by this literal or nil if it does not exist.

Requires
The Core library must have been loaded.
Declaration
Swift

public func coreTrait<T>(forTypesExpressibleBy literal: T.Type) -> TraitType? where T : Expr
Show on GitHub

Helpers

module(named:)
Returns the ID of the module named n if such a module has been loaded, or nil otherwise.
Declaration
Swift

public func module(named n: String) -> ModuleDecl.ID?
Show on GitHub
topLevelDecls(_:)
Returns the top-level declarations in the lexical scope of module.
Declaration
Swift

private func topLevelDecls(_ module: ModuleDecl.ID) -> some Collection<AnyDeclID>
Show on GitHub
requirements(of:)
Returns the requirements declared in t.
Declaration
Swift

public func requirements(of t: TraitDecl.ID) -> RequirementSequence
Show on GitHub
requirements(_:in:)
Returns the requirements named n in t.

If n is overloaded, the requirements are returned in the order in which they are declared in the source code.
Declaration
Swift

public func requirements(_ n: Name, in t: TraitDecl.ID) -> [AnyDeclID]
Show on GitHub
synthesizedKind(of:)
Returns the kind identifying synthesized declarations of requirement, or nil if requirement is not synthesizable.
Declaration
Swift

public func synthesizedKind<T>(of requirement: T) -> SynthesizedFunctionDecl.Kind? where T : DeclID
Show on GitHub
defaultArguments(of:)
Returns a table mapping each parameter of d to its default argument if d is a function, initializer, method or subscript declaration; otherwise, returns nil.
Declaration
Swift

public func defaultArguments(of d: AnyDeclID) -> [AnyExprID?]?
Show on GitHub
externalName(of:)
Returns the name of entity defining the implementation of d if it is external.
Declaration
Swift

public func externalName(of d: FunctionDecl.ID) -> String?
Show on GitHub
foreignName(of:)
Returns the name of the entity interfaced by the declared function if it is an FFI.
Declaration
Swift

public func foreignName(of d: FunctionDecl.ID) -> String?
Show on GitHub
runtimeParameters(of:)
Returns the run-time parameters of d iff d is callable.
Declaration
Swift

public func runtimeParameters(of d: AnyDeclID) -> [ParameterDecl.ID]?
Show on GitHub
genericParameters(introducedBy:)
Returns the generic parameters introduced by d.
Declaration
Swift

public func genericParameters(introducedBy d: AnyDeclID) -> [GenericParameterDecl.ID]
Show on GitHub
name(of:)
Returns the name of d unless d is anonymous.
Declaration
Swift

public func name(of d: FunctionDecl.ID) -> Name?
Show on GitHub
name(of:)
Returns the name of d.
Declaration
Swift

public func name(of d: InitializerDecl.ID) -> Name
Show on GitHub
name(of:)
Returns the name of d.
Declaration
Swift

public func name(of d: MethodDecl.ID) -> Name
Show on GitHub
name(of:)
Returns the name of d.
Declaration
Swift

public func name(of d: SubscriptDecl.ID) -> Name
Show on GitHub
names(in:)
Returns the subfields and pattern IDs of the named patterns contained in p.
See more
Declaration
Swift

public func names<T>(in p: T) -> [(subfield: RecordPath, pattern: NamePattern.ID)] where T : PatternID
Show on GitHub
splitNominalComponents(of:)
Returns (head, tail) where head contains the nominal components of name from right to left and tail is the non-nominal component of name, if any.

Name expressions are rperesented as linked-list, whose elements are the components of a name in reverse order. This method splits such lists at the first non-nominal component.
Declaration
Swift

public func splitNominalComponents(of name: NameExpr.ID) -> ([NameExpr.ID], NameExpr.Domain)
Show on GitHub
walking(pattern:expression:at:_:)
Calls action on each sub-pattern in pattern and its corresponding sub-expression in expression, along with the path to this sub-pattern, relative to root.

Use this method to walk a pattern and a corresponding expression side by side and perform an action for each pair. Children of tuple patterns are visited in pre-order if and only if the corresponding expression is also a tuple. Otherwise, action is called on the tuple and the sub-patterns are not visited.

Requires
expression structurally matches pattern: If pattern and expression are tuples, then they have equal lengths and labels.
Declaration
Swift

public func walking( pattern: AnyPatternID, expression: AnyExprID, at root: RecordPath = [], _ action: (_ subfield: RecordPath, _ subpattern: AnyPatternID, _ subexpression: AnyExprID) -> Void )
Show on GitHub
implementation(_:of:)
Retutns the declaration of the implementation of d with effect a, if any.
Declaration
Swift

public func implementation<T>(_ a: AccessEffect, of d: T.ID) -> T.Variant.ID? where T : BundleDecl
Show on GitHub
isConsuming(_:)
Returns true iff s is a consuming for-loop.
Declaration
Swift

public func isConsuming(_ s: ForStmt.ID) -> Bool
Show on GitHub
isImplicitlyQualified(_:)
Returns true if e is an expression starting with an implicit name qualification.
Declaration
Swift

public func isImplicitlyQualified(_ e: AnyExprID) -> Bool
Show on GitHub
isImplicitlyQualified(_:)
Returns true if e is an expression starting with an implicit name qualification.
Declaration
Swift

public func isImplicitlyQualified(_ e: NameExpr.ID) -> Bool
Show on GitHub
isMarkedForMutation(_:)
Returns true iff e is an expression that’s marked for mutation.
Declaration
Swift

public func isMarkedForMutation(_ e: AnyExprID) -> Bool
Show on GitHub
isMarkedForMutation(_:)
Returns true iff e is an expression that’s marked for mutation.
Declaration
Swift

public func isMarkedForMutation(_ e: NameExpr.ID) -> Bool
Show on GitHub
isMarkedForMutation(_:)
Returns true iff e is an expression that’s marked for mutation.
Declaration
Swift

public func isMarkedForMutation(_ e: FoldedSequenceExpr) -> Bool
Show on GitHub
site(of:)
Returns the source site of expr.
Declaration
Swift

public func site(of expr: FoldedSequenceExpr) -> SourceRange
Show on GitHub
siteForDiagnostics(about:)
Returns a site suitable to emit diagnostics related to d as a whole.
Declaration
Swift

public func siteForDiagnostics<T>(about d: T) -> SourceRange where T : DeclID
Show on GitHub
introducerSite(of:)
Returns the site from which the introducer of d was parsed, if any.
Declaration
Swift

public func introducerSite<T>(of d: T) -> SourceRange? where T : DeclID
Show on GitHub
core
The loaded entities from Hylo’s standard library that are known to the compiler.
Declaration
Swift

public var core: CoreEntities { get }
Show on GitHub
uses(in:)
Returns a map from used name to its mutability.

This method collects all name expressions that occurs in d, visiting its children in pre-order. Nested type and extension declarations are not visited.
Declaration
Swift

func uses<T>(in d: T.ID) -> [(NameExpr.ID, AccessEffect)] where T : CapturingDecl
Show on GitHub
walk(_:notifying:)
Visits n and its children in pre-order, notifying o when a node is entered or left.
Declaration
Swift

public func walk<O>(_ n: AnyNodeID, notifying o: inout O) where O : ASTWalkObserver
Show on GitHub
walk(_:notifying:)
Visits n and its children in pre-order, notifying o when a node is entered or left.
Declaration
Swift

public func walk<T, O>(_ n: T, notifying o: inout O) where T : NodeIDProtocol, O : ASTWalkObserver
Show on GitHub
walk(_:notifying:)
Visits n and its children in pre-order, notifying o when a node is entered or left.
Declaration
Swift

public func walk<T, O>(_ n: T?, notifying o: inout O) where T : NodeIDProtocol, O : ASTWalkObserver
Show on GitHub
walk(roots:notifying:)
Visits all nodes in roots and their children in pre-order, notifying o when a node is entered or left.
Declaration
Swift

public func walk<T, O>(roots: [T], notifying o: inout O) where T : NodeIDProtocol, O : ASTWalkObserver
Show on GitHub
walk(conditionItems:notifying:)
Visits all condition items in i and their children in pre-order, notifying o when a node is entered or left.
Declaration
Swift

public func walk<O>(conditionItems i: [ConditionItem], notifying o: inout O) where O : ASTWalkObserver
Show on GitHub

Declarations

traverse(_:notifying:)
Visits the children of n in pre-order, notifying o when a node is entered or left.
Declaration
Swift

public func traverse<O: ASTWalkObserver>( _ n: AssociatedTypeDecl, notifying o: inout O )
Show on GitHub
traverse(_:notifying:)
Visits the children of n in pre-order, notifying o when a node is entered or left.
Declaration
Swift

public func traverse<O: ASTWalkObserver>( _ n: AssociatedValueDecl, notifying o: inout O )
Show on GitHub
traverse(_:notifying:)
Visits the children of n in pre-order, notifying o when a node is entered or left.
Declaration
Swift

public func traverse<O: ASTWalkObserver>( _ n: BindingDecl, notifying o: inout O )
Show on GitHub
traverse(_:notifying:)
Visits the children of n in pre-order, notifying o when a node is entered or left.
Declaration
Swift

public func traverse<O: ASTWalkObserver>( _ n: ConformanceDecl, notifying o: inout O )
Show on GitHub
traverse(_:notifying:)
Visits the children of n in pre-order, notifying o when a node is entered or left.
Declaration
Swift

public func traverse<O: ASTWalkObserver>( _ n: ExtensionDecl, notifying o: inout O )
Show on GitHub
traverse(_:notifying:)
Visits the children of n in pre-order, notifying o when a node is entered or left.
Declaration
Swift

public func traverse<O: ASTWalkObserver>( _ n: FunctionDecl, notifying o: inout O )
Show on GitHub
traverse(_:notifying:)
Visits the children of n in pre-order, notifying o when a node is entered or left.
Declaration
Swift

public func traverse<O: ASTWalkObserver>( _ n: GenericParameterDecl, notifying o: inout O )
Show on GitHub
traverse(_:notifying:)
Visits the children of n in pre-order, notifying o when a node is entered or left.
Declaration
Swift

public func traverse<O: ASTWalkObserver>( _ n: ImportDecl, notifying o: inout O )
Show on GitHub
traverse(_:notifying:)
Visits the children of n in pre-order, notifying o when a node is entered or left.
Declaration
Swift

public func traverse<O: ASTWalkObserver>( _ n: InitializerDecl, notifying o: inout O )
Show on GitHub
traverse(_:notifying:)
Visits the children of n in pre-order, notifying o when a node is entered or left.
Declaration
Swift

public func traverse<O: ASTWalkObserver>( _ n: MethodDecl, notifying o: inout O )
Show on GitHub
traverse(_:notifying:)
Visits the children of n in pre-order, notifying o when a node is entered or left.
Declaration
Swift

public func traverse<O: ASTWalkObserver>( _ n: MethodImpl, notifying o: inout O )
Show on GitHub
traverse(_:notifying:)
Visits the children of n in pre-order, notifying o when a node is entered or left.
Declaration
Swift

public func traverse<O: ASTWalkObserver>( _ n: ModuleDecl, notifying o: inout O )
Show on GitHub
traverse(_:notifying:)
Visits the children of n in pre-order, notifying o when a node is entered or left.
Declaration
Swift

public func traverse<O: ASTWalkObserver>( _ n: NamespaceDecl, notifying o: inout O )
Show on GitHub
traverse(_:notifying:)
Visits the children of n in pre-order, notifying o when a node is entered or left.
Declaration
Swift

public func traverse<O: ASTWalkObserver>( _ n: OperatorDecl, notifying o: inout O )
Show on GitHub
traverse(_:notifying:)
Visits the children of n in pre-order, notifying o when a node is entered or left.
Declaration
Swift

public func traverse<O: ASTWalkObserver>( _ n: ParameterDecl, notifying o: inout O )
Show on GitHub
traverse(_:notifying:)
Visits the children of n in pre-order, notifying o when a node is entered or left.
Declaration
Swift

public func traverse<O: ASTWalkObserver>( _ n: ProductTypeDecl, notifying o: inout O )
Show on GitHub
traverse(_:notifying:)
Visits the children of n in pre-order, notifying o when a node is entered or left.
Declaration
Swift

public func traverse<O: ASTWalkObserver>( _ n: SubscriptDecl, notifying o: inout O )
Show on GitHub
traverse(_:notifying:)
Visits the children of n in pre-order, notifying o when a node is entered or left.
Declaration
Swift

public func traverse<O: ASTWalkObserver>( _ n: SubscriptImpl, notifying o: inout O )
Show on GitHub
traverse(_:notifying:)
Visits the children of n in pre-order, notifying o when a node is entered or left.
Declaration
Swift

public func traverse<O: ASTWalkObserver>( _ n: TraitDecl, notifying o: inout O )
Show on GitHub
traverse(_:notifying:)
Visits the children of n in pre-order, notifying o when a node is entered or left.
Declaration
Swift

public func traverse<O: ASTWalkObserver>( _ n: TypeAliasDecl, notifying o: inout O )
Show on GitHub
traverse(_:notifying:)
Visits the children of n in pre-order, notifying o when a node is entered or left.
Declaration
Swift

public func traverse<O: ASTWalkObserver>( _ n: VarDecl, notifying o: inout O )
Show on GitHub

Expressions

traverse(_:notifying:)
Visits the children of n in pre-order, notifying o when a node is entered or left.
Declaration
Swift

public func traverse<O: ASTWalkObserver>( _ n: BooleanLiteralExpr, notifying o: inout O )
Show on GitHub
traverse(_:notifying:)
Visits the children of n in pre-order, notifying o when a node is entered or left.
Declaration
Swift

public func traverse<O: ASTWalkObserver>( _ n: BufferLiteralExpr, notifying o: inout O )
Show on GitHub
traverse(_:notifying:)
Visits the children of n in pre-order, notifying o when a node is entered or left.
Declaration
Swift

public func traverse<O: ASTWalkObserver>( _ n: CaptureExpr, notifying o: inout O )
Show on GitHub
traverse(_:notifying:)
Visits the children of n in pre-order, notifying o when a node is entered or left.
Declaration
Swift

public func traverse<O: ASTWalkObserver>( _ n: CastExpr, notifying o: inout O )
Show on GitHub
traverse(_:notifying:)
Visits the children of n in pre-order, notifying o when a node is entered or left.
Declaration
Swift

public func traverse<O: ASTWalkObserver>( _ n: ConditionalExpr, notifying o: inout O )
Show on GitHub
traverse(_:notifying:)
Visits the children of n in pre-order, notifying o when a node is entered or left.
Declaration
Swift

public func traverse<O: ASTWalkObserver>( _ n: ConformanceLensExpr, notifying o: inout O )
Show on GitHub
traverse(_:notifying:)
Visits the children of n in pre-order, notifying o when a node is entered or left.
Declaration
Swift

public func traverse<O: ASTWalkObserver>( _ n: ExistentialTypeExpr, notifying o: inout O )
Show on GitHub
traverse(_:notifying:)
Visits the children of n in pre-order, notifying o when a node is entered or left.
Declaration
Swift

public func traverse<O: ASTWalkObserver>( _ n: FloatLiteralExpr, notifying o: inout O )
Show on GitHub
traverse(_:notifying:)
Visits the children of n in pre-order, notifying o when a node is entered or left.
Declaration
Swift

public func traverse<O: ASTWalkObserver>( _ n: FunctionCallExpr, notifying o: inout O )
Show on GitHub
traverse(_:notifying:)
Visits the children of n in pre-order, notifying o when a node is entered or left.
Declaration
Swift

public func traverse<O: ASTWalkObserver>( _ n: InoutExpr, notifying o: inout O )
Show on GitHub
traverse(_:notifying:)
Visits the children of n in pre-order, notifying o when a node is entered or left.
Declaration
Swift

public func traverse<O: ASTWalkObserver>( _ n: IntegerLiteralExpr, notifying o: inout O )
Show on GitHub
traverse(_:notifying:)
Visits the children of n in pre-order, notifying o when a node is entered or left.
Declaration
Swift

public func traverse<O: ASTWalkObserver>( _ n: LambdaExpr, notifying o: inout O )
Show on GitHub
traverse(_:notifying:)
Visits the children of n in pre-order, notifying o when a node is entered or left.
Declaration
Swift

public func traverse<O: ASTWalkObserver>( _ n: ArrowTypeExpr, notifying o: inout O )
Show on GitHub
traverse(_:notifying:)
Visits the children of n in pre-order, notifying o when a node is entered or left.
Declaration
Swift

public func traverse<O: ASTWalkObserver>( _ n: MapLiteralExpr, notifying o: inout O )
Show on GitHub
traverse(_:notifying:)
Visits the children of n in pre-order, notifying o when a node is entered or left.
Declaration
Swift

public func traverse<O: ASTWalkObserver>( _ n: MatchExpr, notifying o: inout O )
Show on GitHub
traverse(_:notifying:)
Visits the children of n in pre-order, notifying o when a node is entered or left.
Declaration
Swift

public func traverse<O: ASTWalkObserver>( _ n: NameExpr, notifying o: inout O )
Show on GitHub
traverse(_:notifying:)
Visits the children of n in pre-order, notifying o when a node is entered or left.
Declaration
Swift

public func traverse<O: ASTWalkObserver>( _ n: ParameterTypeExpr, notifying o: inout O )
Show on GitHub
traverse(_:notifying:)
Visits the children of n in pre-order, notifying o when a node is entered or left.
Declaration
Swift

public func traverse<O: ASTWalkObserver>( _ n: PragmaLiteralExpr, notifying o: inout O )
Show on GitHub
traverse(_:notifying:)
Visits the children of n in pre-order, notifying o when a node is entered or left.
Declaration
Swift

public func traverse<O: ASTWalkObserver>( _ n: RemoteTypeExpr, notifying o: inout O )
Show on GitHub
traverse(_:notifying:)
Visits the children of n in pre-order, notifying o when a node is entered or left.
Declaration
Swift

public func traverse<O: ASTWalkObserver>( _ n: SequenceExpr, notifying o: inout O )
Show on GitHub
traverse(_:notifying:)
Visits the children of n in pre-order, notifying o when a node is entered or left.
Declaration
Swift

public func traverse<O: ASTWalkObserver>( _ n: SpawnExpr, notifying o: inout O )
Show on GitHub
traverse(_:notifying:)
Visits the children of n in pre-order, notifying o when a node is entered or left.
Declaration
Swift

public func traverse<O: ASTWalkObserver>( _ n: StringLiteralExpr, notifying o: inout O )
Show on GitHub
traverse(_:notifying:)
Visits the children of n in pre-order, notifying o when a node is entered or left.
Declaration
Swift

public func traverse<O: ASTWalkObserver>( _ n: SubscriptCallExpr, notifying o: inout O )
Show on GitHub
traverse(_:notifying:)
Visits the children of n in pre-order, notifying o when a node is entered or left.
Declaration
Swift

public func traverse<O: ASTWalkObserver>( _ n: TupleExpr, notifying o: inout O )
Show on GitHub
traverse(_:notifying:)
Visits the children of n in pre-order, notifying o when a node is entered or left.
Declaration
Swift

public func traverse<O: ASTWalkObserver>( _ n: TupleMemberExpr, notifying o: inout O )
Show on GitHub
traverse(_:notifying:)
Visits the children of n in pre-order, notifying o when a node is entered or left.
Declaration
Swift

public func traverse<O: ASTWalkObserver>( _ n: TupleTypeExpr, notifying o: inout O )
Show on GitHub
traverse(_:notifying:)
Visits the children of n in pre-order, notifying o when a node is entered or left.
Declaration
Swift

public func traverse<O: ASTWalkObserver>( _ n: UnicodeScalarLiteralExpr, notifying o: inout O )
Show on GitHub
traverse(_:notifying:)
Visits the children of n in pre-order, notifying o when a node is entered or left.
Declaration
Swift

public func traverse<O: ASTWalkObserver>( _ n: WildcardExpr, notifying o: inout O )
Show on GitHub

Patterns

traverse(_:notifying:)
Visits the children of n in pre-order, notifying o when a node is entered or left.
Declaration
Swift

public func traverse<O: ASTWalkObserver>( _ n: BindingPattern, notifying o: inout O )
Show on GitHub
traverse(_:notifying:)
Visits the children of n in pre-order, notifying o when a node is entered or left.
Declaration
Swift

public func traverse<O: ASTWalkObserver>( _ n: ExprPattern, notifying o: inout O )
Show on GitHub
traverse(_:notifying:)
Visits the children of n in pre-order, notifying o when a node is entered or left.
Declaration
Swift

public func traverse<O: ASTWalkObserver>( _ n: NamePattern, notifying o: inout O )
Show on GitHub
traverse(_:notifying:)
Visits the children of n in pre-order, notifying o when a node is entered or left.
Declaration
Swift

public func traverse<O: ASTWalkObserver>( _ n: OptionPattern, notifying o: inout O )
Show on GitHub
traverse(_:notifying:)
Visits the children of n in pre-order, notifying o when a node is entered or left.
Declaration
Swift

public func traverse<O: ASTWalkObserver>( _ n: TuplePattern, notifying o: inout O )
Show on GitHub
traverse(_:notifying:)
Visits the children of n in pre-order, notifying o when a node is entered or left.
Declaration
Swift

public func traverse<O: ASTWalkObserver>( _ n: WildcardPattern, notifying o: inout O )
Show on GitHub

Statements

traverse(_:notifying:)
Visits the children of n in pre-order, notifying o when a node is entered or left.
Declaration
Swift

public func traverse<O: ASTWalkObserver>( _ n: AssignStmt, notifying o: inout O )
Show on GitHub
traverse(_:notifying:)
Visits the children of n in pre-order, notifying o when a node is entered or left.
Declaration
Swift

public func traverse<O: ASTWalkObserver>( _ n: BraceStmt, notifying o: inout O )
Show on GitHub
traverse(_:notifying:)
Visits the children of n in pre-order, notifying o when a node is entered or left.
Declaration
Swift

public func traverse<O: ASTWalkObserver>( _ n: BreakStmt, notifying o: inout O )
Show on GitHub
traverse(_:notifying:)
Visits the children of n in pre-order, notifying o when a node is entered or left.
Declaration
Swift

public func traverse<O: ASTWalkObserver>( _ n: ConditionalBindingStmt, notifying o: inout O )
Show on GitHub
traverse(_:notifying:)
Visits the children of n in pre-order, notifying o when a node is entered or left.
Declaration
Swift

public func traverse<O: ASTWalkObserver>( _ n: ConditionalCompilationStmt, notifying o: inout O )
Show on GitHub
traverse(_:notifying:)
Visits the children of n in pre-order, notifying o when a node is entered or left.
Declaration
Swift

public func traverse<O: ASTWalkObserver>( _ n: ConditionalStmt, notifying o: inout O )
Show on GitHub
traverse(_:notifying:)
Visits the children of n in pre-order, notifying o when a node is entered or left.
Declaration
Swift

public func traverse<O: ASTWalkObserver>( _ n: ContinueStmt, notifying o: inout O )
Show on GitHub
traverse(_:notifying:)
Visits the children of n in pre-order, notifying o when a node is entered or left.
Declaration
Swift

public func traverse<O: ASTWalkObserver>( _ n: DeclStmt, notifying o: inout O )
Show on GitHub
traverse(_:notifying:)
Visits the children of n in pre-order, notifying o when a node is entered or left.
Declaration
Swift

public func traverse<O: ASTWalkObserver>( _ n: DiscardStmt, notifying o: inout O )
Show on GitHub
traverse(_:notifying:)
Visits the children of n in pre-order, notifying o when a node is entered or left.
Declaration
Swift

public func traverse<O: ASTWalkObserver>( _ n: DoWhileStmt, notifying o: inout O )
Show on GitHub
traverse(_:notifying:)
Visits the children of n in pre-order, notifying o when a node is entered or left.
Declaration
Swift

public func traverse<O: ASTWalkObserver>( _ n: ExprStmt, notifying o: inout O )
Show on GitHub
traverse(_:notifying:)
Visits the children of n in pre-order, notifying o when a node is entered or left.
Declaration
Swift

public func traverse<O: ASTWalkObserver>( _ n: ForStmt, notifying o: inout O )
Show on GitHub
traverse(_:notifying:)
Visits the children of n in pre-order, notifying o when a node is entered or left.
Declaration
Swift

public func traverse<O: ASTWalkObserver>( _ n: ReturnStmt, notifying o: inout O )
Show on GitHub
traverse(_:notifying:)
Visits the children of n in pre-order, notifying o when a node is entered or left.
Declaration
Swift

public func traverse<O: ASTWalkObserver>( _ n: WhileStmt, notifying o: inout O )
Show on GitHub
traverse(_:notifying:)
Visits the children of n in pre-order, notifying o when a node is entered or left.
Declaration
Swift

public func traverse<O: ASTWalkObserver>( _ n: YieldStmt, notifying o: inout O )
Show on GitHub

Others

traverse(_:notifying:)
Visits the children of n in pre-order, notifying o when a node is entered or left.
Declaration
Swift

public func traverse<O: ASTWalkObserver>( _ n: MatchCase, notifying o: inout O )
Show on GitHub
traverse(_:notifying:)
Visits the children of n in pre-order, notifying o when a node is entered or left.
Declaration
Swift

public func traverse<O: ASTWalkObserver>( _ n: TranslationUnit, notifying o: inout O )
Show on GitHub
traverse(genericClause:notifying:)
Visits the children of c in pre-order, notifying o when a node is entered or left.
Declaration
Swift

public func traverse<O>(genericClause c: GenericClause, notifying o: inout O) where O : ASTWalkObserver
Show on GitHub
traverse(whereClause:notifying:)
Visits the children of c in pre-order, notifying o when a node is entered or left.
Declaration
Swift

public func traverse<O>(whereClause c: WhereClause, notifying o: inout O) where O : ASTWalkObserver
Show on GitHub
traverse(constraintExpr:notifying:)
Visits the children of c in pre-order, notifying o when a node is entered or left.
Declaration
Swift

public func traverse<O: ASTWalkObserver>( constraintExpr c: WhereClause.ConstraintExpr, notifying o: inout O )
Show on GitHub
validateGlobalScopeMember(_:atTopLevel:reportingDiagnosticsTo:)
Reports any well-formedness problems with d occurring at global scope into log.

atTopLevel is true iff d isn’t nested in any declaration.
Declaration
Swift

func validateGlobalScopeMember( _ d: AnyDeclID, atTopLevel: Bool, reportingDiagnosticsTo log: inout DiagnosticSet )
Show on GitHub
validateGlobalScopeMember(_:reportingDiagnosticsTo:)
Reports any well-formedness problems with d occurring at global scope into log.
Declaration
Swift

func validateGlobalScopeMember( _ d: BindingDecl.ID, reportingDiagnosticsTo log: inout DiagnosticSet )
Show on GitHub
validateGlobalScopeMember(_:reportingDiagnosticsTo:)
Reports any well-formedness problems with d occurring at global scope into log.
Declaration
Swift

func validateGlobalScopeMember( _ d: FunctionDecl.ID, reportingDiagnosticsTo log: inout DiagnosticSet )
Show on GitHub
validateGlobalScopeMember(_:reportingDiagnosticsTo:)
Reports any well-formedness problems with d occurring at global scope into log.
Declaration
Swift

func validateGlobalScopeMember( _ d: SubscriptDecl.ID, reportingDiagnosticsTo log: inout DiagnosticSet )
Show on GitHub
validateTypeMember(_:into:)
Reports any well-formedness problems with d occurring at type scope into log.
Declaration
Swift

func validateTypeMember(_ d: AnyDeclID, into log: inout DiagnosticSet)
Show on GitHub
validateTypeMember(_:reportingDiagnosticsTo:)
Reports any well-formedness problems with d occurring at type scope into log.
Declaration
Swift

func validateTypeMember(_ d: BindingDecl.ID, reportingDiagnosticsTo log: inout DiagnosticSet)
Show on GitHub
validateTypeMember(_:reportingDiagnosticsTo:)
Reports any well-formedness problems with d occurring at type scope into log.
Declaration
Swift

func validateTypeMember(_ d: FunctionDecl.ID, reportingDiagnosticsTo log: inout DiagnosticSet)
Show on GitHub
EncodingState
The format of data that must be injected into a StatefulEncoder for serializing an AST instance.
Declaration
Swift

typealias EncodingState = SourceFile.EncodingState
Show on GitHub
DecodingState
The format of data that must be injected into a StatefulDecoder for deserializing an AST instance.
Declaration
Swift

typealias DecodingState = SourceFile.DecodingState
Show on GitHub
CodingKeys
The parts of an encoded AST.
See more
Declaration
Swift

private enum CodingKeys : String, CodingKey
Show on GitHub


                    
                    
                    init(from:)

Declaration

Swift

public init(from decoder: Decoder) throws

Show on GitHub


                    
                    
                    encode(to:)

Declaration

Swift

public func encode(to encoder: Encoder) throws

Show on GitHub