Package-level declarations
Types
Link copied to clipboard
class Pipeline(context: MutableContext, val options: PipelineOptions, val libraries: Set<Library>, renderer: (RendererFactory, Context) -> RenderingComponents, val 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
object PipelineChainFactory
Factory for creating standard pipeline stage chains.
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 afterTreeTraversal: Pipeline.(AstRoot) -> Unit = {}, val afterRendering: Pipeline.(CharSequence) -> Unit = {}, val afterPostRendering: Pipeline.(CharSequence) -> Unit = {}, val afterAllRendering: Pipeline.(CharSequence) -> Unit = {}, val afterGeneratingResources: Pipeline.(Set<OutputResource>) -> Unit = {})
Actions to run after each stage of a Pipeline has been completed.
Link copied to clipboard
data class PipelineOptions(val resourceName: String? = null, val prettyOutput: Boolean = false, val wrapOutput: Boolean = true, val workingDirectory: File? = null, val enableMediaStorage: Boolean = true, val minimizeSubdocumentCollisions: Boolean = false, val serverPort: Int? = null, val mediaStorageOptionsOverrides: MediaStorageOptions = ReadOnlyMediaStorageOptions(), val errorHandler: PipelineErrorHandler = BasePipelineErrorHandler())
Read-only settings that affect different behaviors of a Pipeline.