compiler/io.github.aplcornell.viaduct.syntax.circuit

Package-level declarations

Types

ArrayType

class ArrayType(val elementType: ValueTypeNode, val shape: Arguments<IndexExpressionNode>) : Type

BoundParameterNode

class BoundParameterNode(val name: VariableNode, val sourceLocation: SourceLocation) : Node, VariableDeclarationNode

CircuitBlockNode

class CircuitBlockNode : Node, List<CircuitStatementNode>

A sequence of circuit statements.

CircuitDeclarationNode

class CircuitDeclarationNode(val name: FunctionNameNode, val protocol: ProtocolNode, val bounds: Arguments<BoundParameterNode>, val inputs: Arguments<ParameterNode>, val outputs: Arguments<ParameterNode>, val body: CircuitBlockNode, val sourceLocation: SourceLocation) : TopLevelDeclarationNode

A simple block of statements with no control flow, all on one protocol

CircuitStatementNode

sealed class CircuitStatementNode : StatementNode

ExpressionNode

sealed class ExpressionNode : Node

A computation that produces a result.

HostDeclarationNode

class HostDeclarationNode(val name: HostNode, val sourceLocation: SourceLocation) : TopLevelDeclarationNode

Declaration of a participant and their authority.

IndexExpressionNode

sealed class IndexExpressionNode : PureExpressionNode

IndexParameterNode

class IndexParameterNode(val name: VariableNode, val bound: IndexExpressionNode, val sourceLocation: SourceLocation) : Node, VariableDeclarationNode

LetNode

class LetNode(val name: VariableNode, val indices: Arguments<IndexParameterNode>, val value: ExpressionNode, val sourceLocation: SourceLocation) : CircuitStatementNode, VariableDeclarationNode

Binding the result of an expression to a variable. Note that scalars are represented as arrays of dimension zero: val x = 5 ===> val x[] = 5

LiteralNode

class LiteralNode(val value: Value, val sourceLocation: SourceLocation) : IndexExpressionNode

A literal constant.

LookupNode

class LookupNode(variable: VariableNode, indices: Arguments<IndexExpressionNode>, val sourceLocation: SourceLocation) : PureExpressionNode

Node

sealed class Node : HasSourceLocation, PrettyPrintable

OperatorApplicationNode

class OperatorApplicationNode(val operator: Operator, val arguments: Arguments<PureExpressionNode>, val sourceLocation: SourceLocation) : PureExpressionNode

An n-ary operator applied to n arguments.

OperatorNode

class OperatorNode(val operator: Operator, val sourceLocation: SourceLocation) : Node

ParameterNode

class ParameterNode(val name: VariableNode, val type: ArrayTypeNode, val protocol: ProtocolNode, val sourceLocation: SourceLocation) : Node, VariableDeclarationNode

A parameter to a function declaration.

ProgramNode

class ProgramNode(val declarations: PersistentList<TopLevelDeclarationNode>, val sourceLocation: SourceLocation) : Node, List<TopLevelDeclarationNode>

The circuit representation of a program.

PureExpressionNode

sealed class PureExpressionNode : ExpressionNode

ReduceNode

class ReduceNode(val operator: OperatorNode, val defaultValue: PureExpressionNode, val indices: Arguments<IndexParameterNode>, val body: PureExpressionNode, val sourceLocation: SourceLocation) : PureExpressionNode

ReferenceNode

class ReferenceNode(val name: VariableNode, val sourceLocation: SourceLocation) : IndexExpressionNode

ReturnNode

class ReturnNode(val values: Arguments<PureExpressionNode>, val sourceLocation: SourceLocation) : StatementNode

StatementNode

sealed class StatementNode : Node

A computation with side effects.

TopLevelDeclarationNode

sealed class TopLevelDeclarationNode : Node

A declaration at the top level of a file.

Variable

data class Variable(val name: String) : Name

A variable is a name that stands for a value or an object instance.

VariableDeclarationNode

interface VariableDeclarationNode

A node that declares a Variable.

VariableNode

typealias VariableNode = Located<Variable>

Functions

parse

fun SourceFile.parse(protocolParsers: Map<ProtocolName, ProtocolParser<Protocol>> = defaultProtocolParsers): ProgramNode

Parses this source file to IR and returns the IR.

fun String.parse(path: String = "<string>", protocolParsers: Map<ProtocolName, ProtocolParser<Protocol>> = defaultProtocolParsers): ProgramNode

Parses this string and returns the AST.