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

BlockNode

class BlockNode : StatementNode, List<StatementNode>

A sequence of statements.

Constructors

BlockNode

fun BlockNode(statements: List<StatementNode>, sourceLocation: SourceLocation)

BlockNode

fun BlockNode(vararg statements: StatementNode, sourceLocation: SourceLocation)

Functions

contains

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

containsAll

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

copy

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

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

forEach

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

get

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

indexOf

open override fun indexOf(element: StatementNode): Int

isEmpty

open override fun isEmpty(): Boolean

iterator

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

lastIndexOf

open override fun lastIndexOf(element: StatementNode): Int

listIterator

open override fun listIterator(): ListIterator<StatementNode>

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

parallelStream

open fun parallelStream(): Stream<StatementNode>

spliterator

open override fun spliterator(): Spliterator<StatementNode>

stream

open fun stream(): Stream<StatementNode>

subList

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

toArray

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

toDocument

override fun toDocument(): Document

toDocumentWithMetadata

fun toDocumentWithMetadata(metadata: Metadata): Document

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

toSurfaceNode

open override fun toSurfaceNode(metadata: Metadata): BlockNode

Returns a representation of this node in the surface syntax.

Properties

children

open override val children: Iterable<StatementNode>

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

size

open override val size: Int

sourceLocation

open override val sourceLocation: SourceLocation

statements

val statements: PersistentList<StatementNode>

Extensions

canMux

fun StatementNode.canMux(): Boolean

createdVariables

fun StatementNode.createdVariables(): List<Variable>

deepCopy

fun Node.deepCopy(): Node

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

descendants

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.

immediateRHS

fun StatementNode.immediateRHS(): List<ExpressionNode>

unions

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.