com.vladsch.flexmark.internal

Class DocumentParser

java.lang.Object

com.vladsch.flexmark.internal.DocumentParser

All Implemented Interfaces:

BlockParserTracker, ParserState, com.vladsch.flexmark.util.BlockTracker

public class DocumentParser
extends Object
implements ParserState

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DocumentParser.BlockPreProcessorDependencies
static class	DocumentParser.BlockPreProcessorDependencyStage
static class	DocumentParser.CustomBlockParserDependencies
static class	DocumentParser.CustomBlockParserDependencyStage
static class	DocumentParser.ParagraphPreProcessorDependencies
static class	DocumentParser.ParagraphPreProcessorDependencyStage

Field Summary

Fields

Modifier and Type	Field and Description
static InlineParserFactory	INLINE_PARSER_FACTORY

Constructor Summary

Constructors

Constructor and Description
DocumentParser(com.vladsch.flexmark.util.options.DataHolder options, List<CustomBlockParserFactory> customBlockParserFactories, DocumentParser.ParagraphPreProcessorDependencies paragraphPreProcessorDependencies, DocumentParser.BlockPreProcessorDependencies blockPreProcessorDependencies, InlineParser inlineParser)

Method Summary

Modifier and Type	Method and Description
void	blockAdded(com.vladsch.flexmark.ast.Block node)
void	blockAddedWithChildren(com.vladsch.flexmark.ast.Block node)
void	blockAddedWithDescendants(com.vladsch.flexmark.ast.Block node)
void	blockParserAdded(BlockParser blockParser)
void	blockParserRemoved(BlockParser blockParser)
void	blockRemoved(com.vladsch.flexmark.ast.Block node)
void	blockRemovedWithChildren(com.vladsch.flexmark.ast.Block node)
void	blockRemovedWithDescendants(com.vladsch.flexmark.ast.Block node)
static List<CustomBlockParserFactory>	calculateBlockParserFactories(com.vladsch.flexmark.util.options.DataHolder options, List<CustomBlockParserFactory> customBlockParserFactories)
static DocumentParser.BlockPreProcessorDependencies	calculateBlockPreProcessors(com.vladsch.flexmark.util.options.DataHolder options, List<BlockPreProcessorFactory> blockPreProcessors, InlineParserFactory inlineParserFactory)
static DocumentParser.ParagraphPreProcessorDependencies	calculateParagraphPreProcessors(com.vladsch.flexmark.util.options.DataHolder options, List<ParagraphPreProcessorFactory> blockPreProcessors, InlineParserFactory inlineParserFactory)
boolean	endsWithBlankLine(com.vladsch.flexmark.ast.Node block) Test the block to see if it ends in a blank line.
BlockParser	getActiveBlockParser()
BlockParser	getActiveBlockParser(com.vladsch.flexmark.ast.Block node)
List<BlockParser>	getActiveBlockParsers()
int	getColumn() The column is the position within the line after tab characters have been processed as 4-space tab stops.
int	getIndent()
int	getIndex()
InlineParser	getInlineParser()
com.vladsch.flexmark.util.sequence.BasedSequence	getLine()
int	getLineEndIndex()
int	getLineEolLength()
int	getLineNumber()
List<com.vladsch.flexmark.util.sequence.BasedSequence>	getLineSegments() Returns a list of document lines encountered this far in the parsing process
int	getLineStart()
com.vladsch.flexmark.util.sequence.BasedSequence	getLineWithEOL()
int	getNextNonSpaceIndex()
ParserPhase	getParserPhase() Get the current parser phase
Parsing	getParsing()
com.vladsch.flexmark.util.options.MutableDataHolder	getProperties()
boolean	isBlank()
boolean	isLastLineBlank(com.vladsch.flexmark.ast.Node node) Test a block to see if the last line of the block is blank.
com.vladsch.flexmark.ast.Document	parse(CharSequence source) The main parsing function.
com.vladsch.flexmark.ast.Document	parse(Reader input)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

INLINE_PARSER_FACTORY

public static final InlineParserFactory INLINE_PARSER_FACTORY

Constructor Detail

DocumentParser

public DocumentParser(com.vladsch.flexmark.util.options.DataHolder options,
                      List<CustomBlockParserFactory> customBlockParserFactories,
                      DocumentParser.ParagraphPreProcessorDependencies paragraphPreProcessorDependencies,
                      DocumentParser.BlockPreProcessorDependencies blockPreProcessorDependencies,
                      InlineParser inlineParser)

Method Detail

getLineSegments

public List<com.vladsch.flexmark.util.sequence.BasedSequence> getLineSegments()

Description copied from interface: ParserState

Returns a list of document lines encountered this far in the parsing process

Specified by:

getLineSegments in interface ParserState

Returns:

list of line sequences (including EOLs)

blockParserAdded

public void blockParserAdded(BlockParser blockParser)

Specified by:

blockParserAdded in interface BlockParserTracker

blockParserRemoved

public void blockParserRemoved(BlockParser blockParser)

Specified by:

blockParserRemoved in interface BlockParserTracker

blockAdded

public void blockAdded(com.vladsch.flexmark.ast.Block node)

Specified by:

blockAdded in interface com.vladsch.flexmark.util.BlockTracker

blockAddedWithChildren

public void blockAddedWithChildren(com.vladsch.flexmark.ast.Block node)

Specified by:

blockAddedWithChildren in interface com.vladsch.flexmark.util.BlockTracker

blockAddedWithDescendants

public void blockAddedWithDescendants(com.vladsch.flexmark.ast.Block node)

Specified by:

blockAddedWithDescendants in interface com.vladsch.flexmark.util.BlockTracker

blockRemoved

public void blockRemoved(com.vladsch.flexmark.ast.Block node)

Specified by:

blockRemoved in interface com.vladsch.flexmark.util.BlockTracker

blockRemovedWithChildren

public void blockRemovedWithChildren(com.vladsch.flexmark.ast.Block node)

Specified by:

blockRemovedWithChildren in interface com.vladsch.flexmark.util.BlockTracker

blockRemovedWithDescendants

public void blockRemovedWithDescendants(com.vladsch.flexmark.ast.Block node)

Specified by:

blockRemovedWithDescendants in interface com.vladsch.flexmark.util.BlockTracker

getParserPhase

public ParserPhase getParserPhase()

Description copied from interface: ParserState

Get the current parser phase

Specified by:

getParserPhase in interface ParserState

Returns:

the current parser phase ParserPhase

getParsing

public Parsing getParsing()

Specified by:

getParsing in interface ParserState

Returns:

strings and patterns class adjusted for options Parsing

getProperties

public com.vladsch.flexmark.util.options.MutableDataHolder getProperties()

Specified by:

getProperties in interface ParserState

Returns:

document properties of the document being parsed

calculateBlockParserFactories

public static List<CustomBlockParserFactory> calculateBlockParserFactories(com.vladsch.flexmark.util.options.DataHolder options,
                                                                           List<CustomBlockParserFactory> customBlockParserFactories)

calculateParagraphPreProcessors

public static DocumentParser.ParagraphPreProcessorDependencies calculateParagraphPreProcessors(com.vladsch.flexmark.util.options.DataHolder options,
                                                                                               List<ParagraphPreProcessorFactory> blockPreProcessors,
                                                                                               InlineParserFactory inlineParserFactory)

calculateBlockPreProcessors

public static DocumentParser.BlockPreProcessorDependencies calculateBlockPreProcessors(com.vladsch.flexmark.util.options.DataHolder options,
                                                                                       List<BlockPreProcessorFactory> blockPreProcessors,
                                                                                       InlineParserFactory inlineParserFactory)

getInlineParser

public InlineParser getInlineParser()

Specified by:

getInlineParser in interface ParserState

Returns:

inline parser instance for the parser state

parse

public com.vladsch.flexmark.ast.Document parse(CharSequence source)

The main parsing function. Returns a parsed document AST.

Parameters:

source - source sequence to parse

Returns:

Document node of the resulting AST

parse

public com.vladsch.flexmark.ast.Document parse(Reader input)
                                        throws IOException

Throws:

IOException

getLineNumber

public int getLineNumber()

Specified by:

getLineNumber in interface ParserState

Returns:

The 0 based current line number within the input

getLineStart

public int getLineStart()

Specified by:

getLineStart in interface ParserState

Returns:

the start of line offset into the input stream corresponding to current index into the line

getLineEndIndex

public int getLineEndIndex()

Specified by:

getLineEndIndex in interface ParserState

Returns:

the end of line offset into the input stream corresponding to current index into the line, including the EOL

getLine

public com.vladsch.flexmark.util.sequence.BasedSequence getLine()

Specified by:

getLine in interface ParserState

Returns:

the current line

getLineWithEOL

public com.vladsch.flexmark.util.sequence.BasedSequence getLineWithEOL()

Specified by:

getLineWithEOL in interface ParserState

Returns:

the current line with EOL

getLineEolLength

public int getLineEolLength()

Specified by:

getLineEolLength in interface ParserState

Returns:

the EOL offset into the input stream corresponding to current index into the line

getIndex

public int getIndex()

Specified by:

getIndex in interface ParserState

Returns:

the current index within the line (0-based)

getNextNonSpaceIndex

public int getNextNonSpaceIndex()

Specified by:

getNextNonSpaceIndex in interface ParserState

Returns:

the index of the next non-space character starting from ParserState.getIndex() (may be the same) (0-based)

getColumn

public int getColumn()

Description copied from interface: ParserState

The column is the position within the line after tab characters have been processed as 4-space tab stops. If the line doesn't contain any tabs, it's the same as the ParserState.getIndex(). If the line starts with a tab, followed by text, then the column for the first character of the text is 4 (the index is 1).

Specified by:

getColumn in interface ParserState

Returns:

the current column within the line (0-based)

getIndent

public int getIndent()

Specified by:

getIndent in interface ParserState

Returns:

the indentation in columns (either by spaces or tab stop of 4), starting from ParserState.getColumn()

isBlank

public boolean isBlank()

Specified by:

isBlank in interface ParserState

Returns:

true if the current line is blank starting from the index

getActiveBlockParser

public BlockParser getActiveBlockParser()

Specified by:

getActiveBlockParser in interface ParserState

Returns:

the deepest open block parser

getActiveBlockParser

public BlockParser getActiveBlockParser(com.vladsch.flexmark.ast.Block node)

Specified by:

getActiveBlockParser in interface ParserState

Parameters:

node - block node for which to get the active block parser

Returns:

an active block parser for the node or null if not found or the block is already closed.

getActiveBlockParsers

public List<BlockParser> getActiveBlockParsers()

Specified by:

getActiveBlockParsers in interface ParserState

Returns:

the current list of active block parsers, deepest is last

endsWithBlankLine

public boolean endsWithBlankLine(com.vladsch.flexmark.ast.Node block)

Description copied from interface: ParserState

Test the block to see if it ends in a blank line. The blank line can be in the block or its last child.

Specified by:

endsWithBlankLine in interface ParserState

Parameters:

block - block to be tested

Returns:

true if the block ends in a blank line

isLastLineBlank

public boolean isLastLineBlank(com.vladsch.flexmark.ast.Node node)

Description copied from interface: ParserState

Test a block to see if the last line of the block is blank. Children not tested.

Specified by:

isLastLineBlank in interface ParserState

Parameters:

node - block instance to test

Returns:

true if the block's last line is blank