Package-level declarations

Types

Link copied to clipboard
class Pipeline(context: MutableContext, val options: PipelineOptions, libraries: Set<Library>, renderer: (RendererFactory, Context) -> RenderingComponents, hooks: PipelineHooks? = null)

A representation of the sequential set of actions to perform in order to produce an output artifact from a raw source. Each component of the pipeline takes an input from the output of the previous one.

Link copied to clipboard
data class PipelineHooks(val afterRegisteringLibraries: Pipeline.(Set<Library>) -> Unit = {}, val afterLexing: Pipeline.(List<Token>) -> Unit = {}, val afterParsing: Pipeline.(AstRoot) -> Unit = {}, val afterExpanding: Pipeline.(AstRoot) -> Unit = {}, val afterTreeVisiting: Pipeline.() -> Unit = {}, val afterRendering: Pipeline.(CharSequence) -> Unit = {}, val afterPostRendering: Pipeline.(CharSequence) -> Unit = {})

Actions to run after each stage of a Pipeline has been completed.

Link copied to clipboard
data class PipelineOptions(val prettyOutput: Boolean = false, val wrapOutput: Boolean = true, val workingDirectory: File? = null, val enableMediaStorage: Boolean = true, val serverPort: Int? = null, val mediaStorageOptionsOverrides: MediaStorageOptions = ReadOnlyMediaStorageOptions(), val errorHandler: PipelineErrorHandler = BasePipelineErrorHandler())

Read-only settings that affect different behaviors of a Pipeline.

Link copied to clipboard
object Pipelines

Storage for keeping track of active pipelines.