quarkdown-core/com.quarkdown.core.context/BaseContext

BaseContext

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.

Parameters

attributes

attributes of the node tree, produced by the parsing stage

flavor

Markdown flavor used for this pipeline. It specifies how to produce the needed components

libraries

loaded libraries to look up functions from

subdocument

the subdocument this context is processing

Inheritors

MutableContext

Constructors

BaseContext

constructor(attributes: AstAttributes, flavor: MarkdownFlavor, libraries: Set<Library> = emptySet(), subdocument: Subdocument = Subdocument.Root)

Properties

attachedPipeline

open override val attachedPipeline: Pipeline?

The pipeline this context is attached to, if it exists. A context can have up to 1 attached pipeline.

attributes

open override val attributes: AstAttributes

documentInfo

open override val documentInfo: DocumentInfo

Mutable information about the final document that is being created.

fileSystem

open override val fileSystem: FileSystem

The file system relative to this context which can be used to access files starting from a certain working directory.

flavor

open override val flavor: MarkdownFlavor

libraries

open override val libraries: Set<Library>

loadableLibraries

open override val loadableLibraries: Set<Library>

External libraries that can be loaded by the user into libraries. These libraries are, for instance, fetched from the library directory (--libs option) and can be loaded via the .include {name} function.

localizationTables

open override val localizationTables: Map<String, LocalizationTable>

Tables that store key-value localization pairs for each supported locale. Each table is identified by a unique name.

mediaStorage

open override val mediaStorage: ReadOnlyMediaStorage

Media storage that contains all the media files that are referenced within the document. For example, if an image node references a local image file "image.png", the local file needs to be exported to the output directory in order for a browser to look it up. This storage is used to keep track of all the media files that may need to be exported.

options

open override val options: ContextOptions

Global properties that affect several behaviors and that can be altered through function calls.

subdocument

open override val subdocument: Subdocument

subdocumentGraph

open override val subdocumentGraph: VisitableOnceGraph<Subdocument>

Directed graph of the subdocuments that are part of the document complex. Each subdocument is a separate document file that can be rendered independently, and is referenced by a link from the main document or another subdocument.

Functions

fork

open override fun fork(subdocument: Subdocument): ScopeContext

getFunctionByName

open override fun getFunctionByName(name: String): Function<*>?

Looks up a function by name.

isSubdocumentUrl

fun Context.isSubdocumentUrl(url: String): Boolean

localize

open override fun localize(tableName: String, key: String, locale: Locale): String

Localizes a string to this context's language (the locale set in documentInfo) by looking up a key in a localization table.

localizeOrDefault

fun Context.localizeOrDefault(tableName: String = STDLIB_LOCALIZATION_TABLE_NAME, key: String): String?

Localizes a key from the stdlib table. If the key is not found in the context's locale, it falls back to the default locale (English).

localizeOrNull

fun Context.localizeOrNull(tableName: String = STDLIB_LOCALIZATION_TABLE_NAME, key: String, locale: Locale? = null): String?

Localizes a key from a table.

newUuid

open fun newUuid(): String

Generates a new UUID via ContextOptions.uuidSupplier.

resolve

open override fun resolve(reference: ReferenceLink): LinkNode?

Tries to resolve a reference link to an actual link. If the resolution succeeds, ReferenceLink.onResolve callbacks are executed.

open override fun resolve(call: FunctionCallNode): FunctionCall<*>?

resolveOrFallback

fun Context.resolveOrFallback(reference: ReferenceImage): Node

fun Context.resolveOrFallback(reference: ReferenceLink): Node

resolveUnchecked

open override fun resolveUnchecked(call: FunctionCallNode): UncheckedFunctionCall<*>

shouldAutoPageBreak

fun Context.shouldAutoPageBreak(heading: Heading): Boolean