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

DeclarationNode

class DeclarationNode(val name: ObjectVariableNode, val objectType: ObjectTypeNode, val arguments: Arguments<AtomicExpressionNode>, val protocol: ProtocolNode?, val sourceLocation: SourceLocation) : SimpleStatementNode, ObjectVariableDeclarationNode

Constructing a new object and binding it to a variable.

Constructors

DeclarationNode

fun DeclarationNode(name: ObjectVariableNode, objectType: ObjectTypeNode, arguments: Arguments<AtomicExpressionNode>, protocol: ProtocolNode?, sourceLocation: SourceLocation)

Functions

copy

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

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

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): DeclarationNode

Returns a representation of this node in the surface syntax.

Properties

arguments

val arguments: Arguments<AtomicExpressionNode>

children

open override val children: Iterable<AtomicExpressionNode>

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

name

open override val name: ObjectVariableNode

The variable declared by this node.

objectType

val objectType: ObjectTypeNode

protocol

open override val protocol: ProtocolNode?

The protocol that should store the declared variable.

sourceLocation

open override val sourceLocation: SourceLocation

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>

readsFrom

fun DeclarationNode.readsFrom(nameAnalysis: NameAnalysis, to: Set<Protocol>, from: Set<Protocol>): SelectionConstraint

sendsTo

fun DeclarationNode.sendsTo(nameAnalysis: NameAnalysis, from: Set<Protocol>, to: Set<Protocol>): SelectionConstraint