compiler/io.github.aplcornell.viaduct.syntax.intermediate/ProgramNode

ProgramNode

class ProgramNode : Node, List<TopLevelDeclarationNode>

The intermediate level representation of a program.

Instances are created by elaborated.

Constructors

fun ProgramNode(declarations: List<TopLevelDeclarationNode>, sourceLocation: SourceLocation)

Functions

fun <T> cached(function: (ProgramNode) -> T): T

Applies function to this program and returns the results. The result is cached, so future calls with the same function do not evaluate function.

open operator override fun contains(element: TopLevelDeclarationNode): Boolean

open override fun containsAll(elements: Collection<TopLevelDeclarationNode>): Boolean

open override fun copy(children: List<Node>): ProgramNode

Returns a shallow copy of this node where the child nodes are replaced by children.

open fun forEach(p0: Consumer<in TopLevelDeclarationNode>)

open operator override fun get(index: Int): TopLevelDeclarationNode

open override fun indexOf(element: TopLevelDeclarationNode): Int

open override fun isEmpty(): Boolean

open operator override fun iterator(): Iterator<TopLevelDeclarationNode>

open override fun lastIndexOf(element: TopLevelDeclarationNode): Int

open override fun listIterator(): ListIterator<TopLevelDeclarationNode>

open override fun listIterator(index: Int): ListIterator<TopLevelDeclarationNode>

open fun parallelStream(): Stream<TopLevelDeclarationNode>

open override fun spliterator(): Spliterator<TopLevelDeclarationNode>

open fun stream(): Stream<TopLevelDeclarationNode>

open override fun subList(fromIndex: Int, toIndex: Int): List<TopLevelDeclarationNode>

open fun <T : Any> ~~toArray~~(p0: IntFunction<Array<T>>): Array<T>

override fun toDocument(): Document

toDocumentWithMetadata

fun toDocumentWithMetadata(metadata: Metadata): Document

Returns a pretty representation of this Node where each descendant is decorated using metadata.

open override fun toString(): String

open override fun toSurfaceNode(metadata: Metadata): ProgramNode

Returns a representation of this node in the surface syntax.

Properties

open override val children: Iterable<TopLevelDeclarationNode>

The list of all children nodes. This is empty for leaf nodes.

val declarations: PersistentList<TopLevelDeclarationNode>

val functionMap: Map<FunctionName, FunctionDeclarationNode>

val functions: Iterable<FunctionDeclarationNode>

hostDeclarations

val hostDeclarations: Iterable<HostDeclarationNode>

val hosts: Set<Host>

open override val size: Int

open override val sourceLocation: SourceLocation

val tree: Tree<Node, ProgramNode>

A lazily constructed Tree instance for the program.

Extensions

annotateWithProtocols

fun ProgramNode.annotateWithProtocols(assignment: ProtocolAssignment): ProgramNode

Annotate parameters, declarations, and let nodes with protocols.

fun ProgramNode.check()

Performs all static checks on this program.

compileToKotlin

fun ProgramNode.compileToKotlin(fileName: String, packageName: String, codeGenerator: (context: CodeGeneratorContext) -> CodeGenerator, protocolComposer: ProtocolComposer): FileSpec

fun Node.deepCopy(): Node

Like Node.copy, but recursively copies all descendant nodes also.

fun Node.descendants(): Sequence<Node>

Returns this node and all its descendants in post order.

descendantsIsInstance

inline fun <T : Node> Node.descendantsIsInstance(): Sequence<T>

Returns all instances of T contained in this node (which may include this node).

freshVariableNameGenerator

fun Node.freshVariableNameGenerator(): FreshNameGenerator

A FreshNameGenerator that will avoid all Variable names in this node.

val ProgramNode.main: FunctionDeclarationNode

Returns the declaration of mainFunction function in this program.

fun ProgramNode.specialize(): ProgramNode

Returns an AST where every call site is specialized into new functions as much as possible. This allows for the most liberal protocol selection possible, at the cost of redundancy. The specializer will not specialize (mutually) recursive functions to prevent unbounded specialization.

fun Iterable<Backend>.unions(): Backend

Combines back ends for different protocols into one that supports all.

fun Iterable<Pair<Set<ProtocolName>, ProtocolComposer>>.unions(): ProtocolComposer

Combines multiple protocol composers into one.

fun <K, V> Iterable<Map<K, V>>.unions(): Map<K, V>

Returns the union of all given maps.

fun <T> Iterable<Set<T>>.unions(): Set<T>

Returns the union of all given sets.

fun Iterable<Pair<Set<ProtocolName>, CodeGenerator>>.unions(): CodeGenerator

Combines code generators for different protocols into one generator that can handle all protocols.

fun Iterable<ProtocolFactory>.unions(): ProtocolFactory

Combines given factories into a single factory that returns protocols from all of them.