laika.parse.markup

Provides base parsers that abstract aspects of block parsing common to most lightweight markup languages.

A block parser in Laika can always safely assume that it is invoked at the start of the current line and that the line is not empty.

Instance that allows to import all block parsers in isolation.

Usually it is more convenient to import laika.parse.api._ to get all parser builders with one import.

Default implementation for parsing escape sequences.

Default implementation for parsing inline markup and blocks recursively.

Default implementation for parsing inline markup recursively.

Responsible for creating the top level parsers for text markup and template documents, by combining the parser for the root element with a parser for an (optional) configuration header.

The result in case the end delimiter for the text has been parsed.

Provides parsers for escaped text, custom span parser implementations can use these without knowing the rules of the host markup language for escaping text.

Delimiter implementation for parsing inline spans that distinguishes between a delimiter that marks the end of the span and a delimiter that marks the start of a nested span.

Generic base parser that parses inline elements with potentially nested spans.

The two embed methods allow the registration of parsers for nested child spans. They can be invoked multiple times. Child parsers passed first have higher precedence than those passed later.

Only parsers of type PrefixedParser[T] can be passed to the embed methods, which are parsers with known, stable prefixes of the child span consisting of a limited set of characters so that the checks that need to be performed for each character can be optimized for performance.

Provides base parsers that abstract aspects of inline parsing common to most lightweight markup languages.

It contains helper parsers that abstract the typical logic required for parsing nested spans. In many cases a parser has to recognize the end of the span as well as potentially the start of a nested span. These two concerns are usually unrelated.

This object offers helpers that simplify creating these types of parsers and also optimize performance of inline parsing. Due to the nature of lightweight text markup inline parsing would usually require trying a long list of choices on each input character, which is slow. These base parsers work based on mappings from the first character of an inline span to the corresponding full parser.

Instance that allows to import all inline parsers in isolation.

Usually it is more convenient to import laika.parse.api._ to get all parser builders with one import.

The result of text parsed with an InlineDelimiter.

The result in case the start character of a nested span has been parsed.

Parses a sequence of blocks based on the available block types of the host markup language.

This parser always parses to the end of the input, therefore it is usually applied to the result of a previous parser invocation.

The API is restricted and not the standard Parser API to prevent invocations with just a plain string which would lose all position tracking in error messages. Instead both methods expect a full SourceFragment instance which carries the context of the root input.

Provides parsers for nested blocks, custom block parser implementations can use these without knowing the available span or block types of the host markup language.

Includes the support for nested spans and escaped text.

Parses a sequence of spans based on the available spans types of the host markup language.

This parser always parses to the end of the input, therefore it is usually applied to the result of a previous parser invocation.

The API is restricted and not the standard Parser API to prevent invocations with just a plain string which would lose all position tracking in error messages. Instead both methods expect a full SourceFragment instance which carries the context of the root input.

Provides parsers for nested spans, custom span parser implementations can use these without knowing the available span types of the host markup language.

Includes the support for escaped text.

Responsible of assembling all the block, inline, text and configuration parsers supported by a text markup language.