Protocols

The description of a core trait that has been loaded in an AST.

See more

public protocol CoreTraitDescription : Decodable, Encodable, Sendable

A type that is notified when nodes are entered and left during an AST traversal.

Use this protocol to implement algorithms that must traverse all or most AST nodes and perform similar operations on each of them. Instances of types implementing this protocol are meant to be passed as argument to AST.walk(_:notifying:).

For example:

struct V: ASTWalkObserver {
  var outermostFunctions: [FunctionDecl.ID] = []
  mutating func willEnter(_ n: AnyNodeID, in ast: AST) -> Bool {
    if let d = FunctionDecl.ID(n) {
      outermostFunctions.append(d)
      return false
    } else {
      return true
    }
  }
}
var v = V()
for m in ast.modules { ast.walk(m, notifying: &v) }
print(v.outermostFunctions)

This program prints the IDs of the outermost function declarations in ast.

See more

public protocol ASTWalkObserver : Sendable

A declaration bundle.

See more

public protocol BundleDecl : ExposableDecl

A variant in a declaration bundle.

See more

public protocol BundleImpl : Decl

The declaration of an entity that may capture bindings.

See more

public protocol CapturingDecl : Decl, LexicalScope

The declaration of a type’s conformance to one or multiple traits.

See more

public protocol ConformanceSource : ExposableDecl

A generic type declaration that may be annotated with constraints.

See more

public protocol ConstrainedGenericTypeDecl : Decl

A declaration.

See more

public protocol Decl : Node

A declaration that may be exposed to other scopes.

See more

public protocol ExposableDecl : Decl

A generic declaration.

See more

public protocol GenericDecl : GenericScope

A declaration that introduces a single entity.

See more

public protocol SingleEntityDecl : Decl

A declaration that extends a type.

See more

public protocol TypeExtendingDecl : ExposableDecl, GenericScope

A value expression.

public protocol Expr : Node

A numeric literal expression.

See more

public protocol NumericLiteralExpr : Expr

An AST node that outlines a generic lexical scope.

See more

public protocol GenericScope : Decl, LexicalScope

An AST node that outlines a lexical scope.

public protocol LexicalScope

A protocol describing the API of an AST node.

See more

public protocol Node : Decodable, Encodable, Sendable

The ID of a declaration.

See more

public protocol DeclID : NodeIDProtocol

The ID of a value expression.

See more

public protocol ExprID : NodeIDProtocol

A type denoting the ID of a node.

See more

public protocol NodeIDProtocol : CustomStringConvertible, Decodable, Encodable, Hashable, Sendable

Undocumented

See more

public protocol ConcreteNodeID : NodeIDProtocol

The ID of a pattern.

public protocol PatternID : NodeIDProtocol

The ID of a node outlining a lexical scope.

public protocol ScopeID : NodeIDProtocol

The ID of a statement.

public protocol StmtID : NodeIDProtocol

A pattern.

public protocol Pattern : Node

A statement.

public protocol Stmt : Node

A type whose instances can be updated without loss of information.

See more

protocol Monotonic : Equatable, Sendable

Types representing Hylo programs at some stage after syntactic and scope analysis.

See more

public protocol Program : Sendable

A box wrapping a term.

See more

private protocol TermBox : Sendable

A protocol describing the API of a Hylo term.

See more

public protocol TermProtocol : Hashable, Sendable

A constraint used to perform type checking or inference.

A constraint is a predicate over one or multiple types, including type variables, that must be satisfied in order for a program to be well-typed. Constraints also server to infer implicit type information from the structure of the program.

See more

protocol Constraint : Sendable

A set of predicates that is satisfied if at least one of them is satisfied.

See more

protocol DisjunctiveConstraintProtocol : Constraint

A predicate in a disjunctive constraint.

See more

protocol DisjunctiveConstraintTerm

A term in a rewriting system.

See more

protocol RewritingTerm : Collection, Equatable, Sendable where Self.Element : Hashable, Self.Element : Sendable, Self.Index == Int, Self.SubSequence : Sendable

A box wrapping a type.

See more

private protocol TypeBox : Sendable

A type whose instances are callable entities.

See more

public protocol CallableType

A protocol describing the API of a Hylo type.

See more

public protocol TypeProtocol : Hashable, Sendable