quarkdown-core/com.quarkdown.core.context

Package-level declarations

Types

open class BaseContext(val attributes: AstAttributes, val flavor: MarkdownFlavor, val libraries: List<Library> = emptyList(), val subdocument: Subdocument = Subdocument.Root) : Context

An immutable Context implementation. This might be used in tests as a toy context, but in a concrete execution, its mutable subclass MutableContext is used.

ChildContext

interface ChildContext<C : Context> : Context

A Context that has a parent context, forming a scope tree. This context can access its parent's properties and inherit them.

Context

interface Context : PermissionHolder

Container of information about the current state of the pipeline, shared across the whole pipeline itself.

MutableContext

open class MutableContext(flavor: MarkdownFlavor = QuarkdownFlavor, libraries: List<Library> = emptyList(), loadableLibraries: Set<Library> = emptySet(), subdocument: Subdocument = Subdocument.Root, val attributes: MutableAstAttributes = MutableAstAttributes(), val options: MutableContextOptions = MutableContextOptions()) : BaseContext, AutoCloseable

A mutable Context implementation, which allows registering new data to be looked up later.

ScopeContext

open class ScopeContext(parent: MutableContext, fileSystem: FileSystem = parent.fileSystem) : SubdocumentContext

A context that is the result of a fork from an original parent Context. All properties are inherited from it, but not all, such as libraries, are shared mutably.

SharedContext

open class SharedContext(val parent: MutableContext, val fileSystem: FileSystem = parent.fileSystem) : MutableContext, ChildContext<MutableContext>

A context that shares all of its properties with its parent MutableContext. This is useful when a context needs to be forked, for example to update its fileSystem, but still its state mutably.

SubdocumentContext

open class SubdocumentContext(val parent: MutableContext, subdocument: Subdocument, _fileSystem: FileSystem? = null) : MutableContext, ChildContext<MutableContext>

A context that is the result of a fork from an original parent Context. All properties are inherited from it, but not all, such as libraries, are shared mutably.

Properties

errorHandler

val Context.errorHandler: PipelineErrorHandler?

The error handler of the attached pipeline, if it exists.

packageResolver

val Context.packageResolver: PackageResolver

The package resolver of the attached pipeline, or PackageResolver.Unsupported if no pipeline is attached.