quarkdown-core/com.quarkdown.core.pipeline.stages/FunctionCallExpansionStage

FunctionCallExpansionStage

object FunctionCallExpansionStage : PeekPipelineStage<AstRoot>

Pipeline stage responsible for expanding function calls in the abstract syntax tree (AST).

This stage traverses the AST and expands any function calls found in the document.

Function calls are special constructs in the document that invoke functions defined in libraries. These functions can generate content, modify the document structure, or perform other operations.

This stage is crucial for implementing the extensibility of the document format, allowing users to define and use custom functions in their documents.

Properties

open override val hook: KProperty1<PipelineHooks, Pipeline.(AstRoot) -> Unit>

A hook function that is invoked after the stage completes processing.

Functions

open fun execute(input: AstRoot, data: SharedPipelineData): AstRoot

Executes this pipeline stage with the given input and shared data.

fun <O> PipelineStage<Unit, O>.execute(data: SharedPipelineData): O

Utility function to execute a pipeline stage that takes Unit as input.

open fun invokeHook(data: SharedPipelineData, input: AstRoot, output: AstRoot)

Invokes the hook function for this stage, if one is defined.

open override fun peek(input: AstRoot, data: SharedPipelineData)

Peeks at the input without modifying it.

open override fun process(input: AstRoot, data: SharedPipelineData): AstRoot

Processes the input by calling peek and then returning the input unchanged.

infix fun <A, B, C> PipelineStage<A, B>.then(next: PipelineStage<B, C>): PipelineStage<A, C>

Chains two pipeline stages together to form a new pipeline stage.

infix fun <A, B> PipelineStage<A, B>.thenOptionally(next: PipelineStage<B, B>?): PipelineStage<A, B>

Conditionally chains this pipeline stage with next if it is not null.