quarkdown-core/com.quarkdown.core.ast.quarkdown/FunctionCallNode

FunctionCallNode

class FunctionCallNode(val context: Context, val name: String, val arguments: List<FunctionCallArgument>, val isBlock: Boolean, val delegator: Node? = null, val sourceText: CharSequence? = null, val sourceRange: IntRange? = null) : NestableNode, ErrorCapableNode

A call to a function. The call is executed after parsing, and its output is stored in its mutable children.

Parameters

context

context this node lies in, which is where symbols will be loaded from upon execution

name

name of the function to call

arguments

arguments to call the function with

isBlock

whether this function call is an isolated block (opposite: inline)

delegator

if this call was synthesized at parse time from a primitive Markdown node (see com.quarkdown.core.ast.attributes.primitive.PrimitiveFunctionBackedNode), the original node. When set, the expander falls back to rendering this node directly if no .extend has been registered for name, skipping function dispatch overhead

sourceText

if available, the source code of the whole function call

sourceRange

if available, the range of the function call in the source code

Constructors

FunctionCallNode

constructor(context: Context, name: String, arguments: List<FunctionCallArgument>, isBlock: Boolean, delegator: Node? = null, sourceText: CharSequence? = null, sourceRange: IntRange? = null)

Properties

arguments

val arguments: List<FunctionCallArgument>

children

open override val children: MutableList<Node>

context

val context: Context

delegator

val delegator: Node?

error

open override var error: Pair<Throwable, PipelineErrorHandler>?

The error that occurred during processing, paired with the PipelineErrorHandler strategy to handle it. If null, no error occurred and the node is rendered normally via acceptOnSuccess.

isBlock

val isBlock: Boolean

name

val name: String

sourceRange

val sourceRange: IntRange?

sourceText

val sourceText: CharSequence?

Functions

open fun <T> accept(visitor: NodeVisitor<T>): T

Accepts a visitor.

acceptOnSuccess

open override fun <T> acceptOnSuccess(visitor: NodeVisitor<T>): T

Visits this node with the given visitor when no error is present.

flattenedChildren

fun NestableNode.flattenedChildren(): Sequence<Node>

Returns a sequence of all nodes in the tree, where this is the root node. The sequence is generated by traversing the tree in depth-first order. The root node is excluded from the sequence.

getStoredMedia

fun Node.getStoredMedia(context: Context): StoredMedia?

Retrieves the stored media associated with this node, if any.

setError

fun ErrorCapableNode.setError(throwable: Throwable, context: Context)

Sets the given throwable as the error of this node, paired with the error handler from context.

withChildren

fun Node.withChildren(newChildren: List<Node>): Node

Returns a copy of this node with its children replaced by newChildren.

wrappedAsValue

fun Node.wrappedAsValue(): NodeValue