compiler/edu.cornell.cs.apl.viaduct.syntax.intermediate/FunctionDeclarationNode

FunctionDeclarationNode

class FunctionDeclarationNode(name: FunctionNameNode, pcLabel: LabelNode?, parameters: Arguments<ParameterNode>, body: BlockNode, sourceLocation: SourceLocation) : TopLevelDeclarationNode
Content copied to clipboard

A function declaration associating a name with code.

Parameters

name

A name identifying the function.

pcLabel

Value of the program control label at the beginning of body.

parameters

A list of formal parameters.

body

Code to run when the function is called.

Constructors

FunctionDeclarationNode
Link copied to clipboard
fun FunctionDeclarationNode(name: FunctionNameNode, pcLabel: LabelNode?, parameters: Arguments<ParameterNode>, body: BlockNode, sourceLocation: SourceLocation)
Content copied to clipboard

Functions

copy
Link copied to clipboard
open override fun copy(children: List<Node>): Node
Content copied to clipboard

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

getParameter
Link copied to clipboard
fun getParameter(name: ObjectVariable): ParameterNode?
Content copied to clipboard
getParameterAtIndex
Link copied to clipboard
fun getParameterAtIndex(i: Int): ParameterNode?
Content copied to clipboard
toDocument
Link copied to clipboard
override fun toDocument(): Document
Content copied to clipboard
toDocumentWithMetadata
Link copied to clipboard
fun toDocumentWithMetadata(metadata: Metadata): Document
Content copied to clipboard

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

toSurfaceNode
Link copied to clipboard
open override fun toSurfaceNode(metadata: Metadata): FunctionDeclarationNode
Content copied to clipboard

Returns a representation of this node in the surface syntax.

Properties

body
Link copied to clipboard
val body: BlockNode
Content copied to clipboard
children
Link copied to clipboard
open override val children: Iterable<Node>
Content copied to clipboard
name
Link copied to clipboard
val name: FunctionNameNode
Content copied to clipboard
parameters
Link copied to clipboard
val parameters: Arguments<ParameterNode>
Content copied to clipboard
pcLabel
Link copied to clipboard
val pcLabel: LabelNode?
Content copied to clipboard
sourceLocation
Link copied to clipboard
open override val sourceLocation: SourceLocation
Content copied to clipboard