quarkdown-core/com.quarkdown.core.context

Package-level declarations

Types

open class BaseContext(val attributes: AstAttributes, val flavor: MarkdownFlavor, val libraries: Set<Library> = emptySet(), 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

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

ContextOptions

interface ContextOptions : MediaStorageOptions

Read-only properties that affect several behaviors of the document generation process, and that can be altered through function calls through its MutableContextOptions implementation.

MutableContext

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

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

MutableContextOptions

data class MutableContextOptions(var autoPageBreakHeadingMaxDepth: Int = 1, var enableAutomaticIdentifiers: Boolean = true, var enableLocationAwareness: Boolean = true, var subdocumentUrlSuffixes: Set<String> = DEFAULT_SUBDOCUMENT_URL_SUFFIXES, var uuidSupplier: () -> String = { java.util.UUID .randomUUID() .toString() }, var enableRemoteMediaStorage: Boolean = false, var enableLocalMediaStorage: Boolean = false) : ContextOptions

Mutable ContextOptions implementation.

ScopeContext

open class ScopeContext(val parent: MutableContext, fileSystem: FileSystem? = null) : 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, val 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.

Functions

isSubdocumentUrl

fun Context.isSubdocumentUrl(url: String): Boolean

resolveOrFallback

fun Context.resolveOrFallback(reference: ReferenceImage): Node

fun Context.resolveOrFallback(reference: ReferenceLink): Node

shouldAutoPageBreak

fun Context.shouldAutoPageBreak(heading: Heading): Boolean