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

LibrariesRegistrationStage

object LibrariesRegistrationStage : PipelineStage<Boolean, Set<Library>>

Pipeline stage responsible for registering libraries with the document context.

This stage takes a boolean as input (indicating whether to register libraries) and produces a Set of Library objects as output. If the input is true, it registers all libraries from the pipeline with the context.

If the input is false (see AttachmentStage), it means the context is a scope context and libraries should not be registered again, since they are inherited from the parent context.

Libraries provide functions, extensions, and other capabilities to the document processing system. They need to be registered with the context so that their functions can be called from within the document.

Properties

hook

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

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

Functions

execute

open fun execute(input: Boolean, data: SharedPipelineData): Set<Library>

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

execute

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

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

invokeHook

open override fun invokeHook(data: SharedPipelineData, input: Boolean, output: Set<Library>)

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

process

open override fun process(input: Boolean, data: SharedPipelineData): Set<Library>

Processes the input I and produces an output O.

then

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.

thenOptionally

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.