quarkdown-core/com.quarkdown.core.ast.base.block/Code

Code

class Code(val content: String, val language: String?, val showLineNumbers: Boolean = true, val highlight: Boolean = true, val focusedLines: Range? = null, val caption: InlineContent? = null, val referenceId: String? = null) : LocationTrackableNode, CrossReferenceableNode, CaptionableNode, LocalizedKind, PrimitiveFunctionBackedNode

A code block.

Parameters

content

code content

language

optional syntax language

showLineNumbers

whether to show line numbers

highlight

whether to apply syntax highlighting

focusedLines

range of lines to focus on. No lines are focused if null

caption

optional caption

referenceId

optional ID for cross-referencing via a com.quarkdown.core.ast.quarkdown.reference.CrossReference

Constructors

Code

constructor(content: String, language: String?, showLineNumbers: Boolean = true, highlight: Boolean = true, focusedLines: Range? = null, caption: InlineContent? = null, referenceId: String? = null)

Properties

backingFunctionName

open override val backingFunctionName: String

The name of the function that backs this node, from a loaded library.

canTrackLocation

open val canTrackLocation: Boolean

Whether this node should be tracked in the document's hierarchy.

caption

open override val caption: InlineContent?

children

open override val children: List<Node>

Caption nodes grouped into a single container, making them visible to tree traversals. Subclasses that define their own children must include this in their override.

content

val content: String

focusedLines

val focusedLines: Range?

highlight

val highlight: Boolean

isBackingCallBlock

open val isBackingCallBlock: Boolean

Whether the synthesized backing call should be treated as a block call. Defaults to true; inline primitive nodes should override to false so the inline output mapper is used during expansion.

kindLocalizationKey

open override val kindLocalizationKey: String

Key for localization of the kind of this node, used to look up localized strings in the default com.quarkdown.core.localization.LocalizationTable.

language

val language: String?

linkableReferenceId

val CrossReferenceableNode.linkableReferenceId: String?

The CrossReferenceableNode.referenceId of this node, if it is a real linkable ID (i.e. not the placeholder).

referenceId

open override val referenceId: String?

showLineNumbers

val showLineNumbers: Boolean

Functions

open override fun <T> accept(visitor: NodeVisitor<T>): T

Accepts a visitor.

flattenedChildren

fun NestableNode.flattenedChildren(): Sequence<Node>

Returns a sequence of all nodes in the tree, where this is the root node. The sequence is generated by traversing the tree in depth-first order. The root node is excluded from the sequence.

formatLocation

fun LocationTrackableNode.formatLocation(context: Context, format: (DocumentNumbering) -> NumberingFormat?): String?

getLocation

fun LocationTrackableNode.getLocation(context: Context): SectionLocation?

getLocationLabel

fun LocationTrackableNode.getLocationLabel(context: Context): String?

getStoredMedia

fun Node.getStoredMedia(context: Context): StoredMedia?

Retrieves the stored media associated with this node, if any.

setLocation

fun LocationTrackableNode.setLocation(context: MutableContext, location: SectionLocation)

Registers the location of this node within the document handled by context.

setLocationLabel

fun LocationTrackableNode.setLocationLabel(context: MutableContext, label: String)

Registers the formatted location of this node within the document handled by context, according to this node's NumberingFormat.

toFunctionCallArguments

open override fun toFunctionCallArguments(): List<FunctionCallArgument>

Materializes this node's properties into the arguments of the backing function call. Argument names must match the parameter names of the function identified by backingFunctionName.

withChildren

fun Node.withChildren(newChildren: List<Node>): Node

Returns a copy of this node with its children replaced by newChildren.

wrappedAsValue

fun Node.wrappedAsValue(): NodeValue