docs/org.intellij.markdown.parser

Package-level declarations

Types

class InlineBuilder(nodeBuilder: ASTNodeBuilder, tokensCache: TokensCache, cancellationToken: CancellationToken) : TreeBuilder

LinkMap

class LinkMap(map: Map<CharSequence, LinkMap.LinkInfo>)

LookaheadText

class LookaheadText

MarkdownParser

class MarkdownParser(flavour: MarkdownFlavourDescriptor, assertionsEnabled: Boolean = true, cancellationToken: CancellationToken = CancellationToken.NonCancellable)

MarkerProcessor

abstract class MarkerProcessor<T : MarkerProcessor.StateInfo>(productionHolder: ProductionHolder, startConstraints: MarkdownConstraints)

MarkerProcessorFactory

interface MarkerProcessorFactory

ProductionHolder

class ProductionHolder

StreamingMarkdownFile

interface StreamingMarkdownFile : ASTNode

Mutable AST node that accept appending chunks.

TopLevelBuilder

class TopLevelBuilder(nodeBuilder: ASTNodeBuilder, cancellationToken: CancellationToken) : TreeBuilder

TreeBuilder

abstract class TreeBuilder(nodeBuilder: ASTNodeBuilder, cancellationToken: CancellationToken)

Functions

collectBlockProduction

fun collectBlockProduction(flavour: MarkdownFlavourDescriptor, root: IElementType, text: CharSequence, productionHolder: ProductionHolder, cancellationToken: CancellationToken): List<MarkerBlock>

Fills productionHolder with the blocks of text, and returns the blocks that are still open at the end of text. The step finds the block boundaries only. It builds no ASTNode, and it parses no inline content.

EmptyStreamingMarkdownFile

fun EmptyStreamingMarkdownFile(flavour: MarkdownFlavourDescriptor = GFMFlavourDescriptor()): StreamingMarkdownFile

fun EmptyStreamingMarkdownFile(flavour: MarkdownFlavourDescriptor, cancellationToken: CancellationToken): StreamingMarkdownFile

Creates a StreamingMarkdownFile whose StreamingMarkdownFile.append checks cancellationToken while parsing, so an append can be aborted. This matters most when the StreamingMarkdownFile.unstableTail is large, since the whole of it is reparsed on every append.