InlineParsers
Related Doc:
package markdown
Exception thrown when parsing a text markup document or fragment fails.
Exception thrown when parsing a text markup document or fragment fails.
This can only happen due to a bug in this library, as the behaviour of the parser
is to treat all unknown or malformed markup as regular text and always succeed.
The result property holds the NoSuccess instance that caused the failure.
Provides additional combinator methods to parsers via implicit conversion.
Provides additional combinator methods to parsers via implicit conversion.
Abstracts the internal process of building up the result of an inline parser.
Abstracts the internal process of building up the result of an inline parser. Since some inline parser produce a tree of nested spans whereas others may only produce a text result, they often require the same logic in how they deal with nested constructs.
ResultBuilder that produces a list of spans.
ResultBuilder that produces a list of spans.
ResultBuilder that produces a String.
ResultBuilder that produces a String.
API for specifying further constraints on the parsers provided by this base trait.
API for specifying further constraints on the parsers provided by this base trait.
For reading 3 or more '*' or '+'characters for example the constraint could
be specified as follows:
anyOf('*','+') min 3
Provides additional methods to Try via implicit conversion.
Provides additional methods to Try via implicit conversion.
Consumes any kind of input, always succeeds.
Consumes any kind of input, always succeeds.
This parser would consume the entire input unless a max constraint
is specified.
Consumes any number of consecutive characters that are not one of the specified characters.
Consumes any number of consecutive characters that are not one of the specified characters. Always succeeds unless a minimum number of required matches is specified.
Consumes any number of consecutive characters that are in one of the specified character ranges.
Consumes any number of consecutive characters that are in one of the specified character ranges. Always succeeds unless a minimum number of required matches is specified.
Consumes any number of consecutive occurrences of the specified characters.
Consumes any number of consecutive occurrences of the specified characters. Always succeeds unless a minimum number of required matches is specified.
Consumes any number of characters for which the specified parser fails on the corresponding offset.
Consumes any number of characters for which the specified parser fails on the corresponding offset.
This parser fails if the end of input is reached without the specified parser ever succeeding or
if the parser causes an Error result instead of a plain Failure or Success.
Further constraints like minimum or maximum number of required matching characters can be specified
through the API of the returned TextParser instance.
Consumes any number of consecutive characters that are not one of the specified characters.
Consumes any number of consecutive characters that are not one of the specified characters.
This parser is identical to the anyBut parser except for two differences: this parser fails
if it reaches the end of the input without seeing any of the specified
characters and it also consumes this final character, without adding it
to the result. This parser is usually used when a construct like a span
enclosed between two characters needs to be parsed.
Consumes any number of consecutive characters which satisfy the specified predicate.
Consumes any number of consecutive characters which satisfy the specified predicate. Always succeeds unless a minimum number of required matches is specified.
Succeeds at the start of the input.
Succeeds at the start of the input.
Implicit conversion that allows to pass a single
character to the range-based anyIn parser.
Implicit conversion that allows to pass a single
character to the range-based anyIn parser.
Parses a span of emphasized text enclosed by one occurrence of the specified character.
Parses a span enclosed by two consecutive occurrences of the specified character.
Parses a span enclosed by two consecutive occurrences of the specified character. Recursively parses nested spans, too.
Parses a span enclosed by a single occurrence of the specified character.
Parses a span enclosed by a single occurrence of the specified character. Recursively parses nested spans, too.
Succeeds at the end of the input.
Succeeds at the end of the input.
Succeeds at the end of a line, including the end of the input.
Succeeds at the end of a line, including the end of the input. Produces an empty string as a result and consumes any new line characters.
Parses a single escaped character, only recognizing the characters the Markdown syntax document specifies as escapable.
Parses a single escaped character, only recognizing the characters the Markdown syntax document specifies as escapable.
Note: escaping > is not mandated by the official syntax description, but by the official test suite.
Adds support for escape sequences to the specified text parser.
Adds support for escape sequences to the specified text parser.
the parser to add support for escape sequences to
a parser for a text span that supports escape sequences
Parses a span of text until one of the specified characters is seen (unless it is escaped), while also processing escaped characters, but no other nested spans.
Parses a span of text until one of the specified characters is seen (unless it is escaped), while also processing escaped characters, but no other nested spans. The final character is not included in the result.
the character that signals the end of the text span
a parser for a text span that supports escape sequences
Parses an inline image.
Parses an inline image.
Recognizes both, an inline image  and an image reference ![text][id].
Generic base parser that parses inline elements based on the specified helper parsers.
Generic base parser that parses inline elements based on the specified helper parsers. Usually not used directly by parser implementations, this is the base parser the other inline parsers of this trait delegate to.
the element type produced by a single parser for a nested span
the type of the result this parser produces
a mapping from the start character of a span to the corresponding parser for nested span elements
responsible for building the final result of this parser based on the results of the helper parsers
the resulting parser
Parses an explicit hard line break.
Parses a link, including nested spans in the link text.
Parses a link, including nested spans in the link text.
Recognizes both, an inline link [text](url) and a link reference [text][id].
Parses a link definition in the form [id]: <url> "title".
Parses a link definition in the form [id]: <url> "title".
The title is optional as well as the quotes around it and the angle brackets around the url.
Parses a literal span enclosed by double backticks.
Parses a literal span enclosed by double backticks. Does neither parse nested spans nor Markdown escapes.
Parses a literal span enclosed by a single backtick.
Parses a literal span enclosed by a single backtick. Does neither parse nested spans nor Markdown escapes.
Applies the specified parser at the specified offset behind the current position.
Applies the specified parser at the specified offset behind the current position. Never consumes any input.
Returns an optimized, Array-based lookup function for the specified characters.
Returns an optimized, Array-based lookup function for the specified characters.
Returns an optimized, Array-based lookup function for the specified ranges of characters.
Returns an optimized, Array-based lookup function for the specified ranges of characters.
Fully parses the input string and produces a list of spans, using the
default span parsers returned by the spanParsers method.
Fully parses the input string and produces a list of spans, using the
default span parsers returned by the spanParsers method.
This function is expected to always succeed, errors would be considered a bug of this library, as the parsers treat all unknown or malformed markup as regular text. Some parsers might additionally insert system message elements in case of markup errors.
the input to parse
the result of the parser in form of a list of spans
Fully parses the input string and produces a list of spans.
Fully parses the input string and produces a list of spans.
This function is expected to always succeed, errors would be considered a bug of this library, as the parsers treat all unknown or malformed markup as regular text. Some parsers might additionally insert system message elements in case of markup errors.
the input to parse
a mapping from the start character of a span to the corresponding parser
the result of the parser in form of a list of spans
Fully parses the input from the specified reader and returns the result.
Fully parses the input from the specified reader and returns the result. This function is expected to always succeed, errors would be considered a bug in this library, as the parsers treat all unknown or malformed markup as regular text.
Fully parses the specified input string and returns the result.
Fully parses the specified input string and returns the result. This function is expected to always succeed, errors would be considered a bug in this library, as the parsers treat all unknown or malformed markup as regular text.
Creates a new mapping from the start character of an inline span to the corresponding parser.
Creates a new mapping from the start character of an inline span to the corresponding parser. May be overridden by subtraits.
Parses a simple reference name that only allows alphanumerical characters
and the punctuation characters -, _, ., :, +.
Parses a simple reference name that only allows alphanumerical characters
and the punctuation characters -, _, ., :, +.
A parser generator for repetitions where all subsequent parsers after the first depend on the result of the previous.
A parser generator for repetitions where all subsequent parsers after the first depend on the result of the previous.
the parser to use for the first piece of input
a function that determines the next parser based on the result of the previous
(Changed in version 2.9.0) The p0 call-by-name arguments is evaluated at most once per constructed Parser object, instead of on every need that arises during parsing.
Uses the parser for at most the specified number of repetitions, always succeeds.
Uses the parser for at most the specified number of repetitions, always succeeds. The result is the list of results from applying the parser repeatedly.
Uses the parser for at least the specified number of repetitions or otherwise fails.
Uses the parser for at least the specified number of repetitions or otherwise fails. Continues to apply the parser after the minimum has been reached until if fails. The result is the list of results from applying the parser repeatedly.
Helper function that abstracts the common parser logic of links and images.
Helper function that abstracts the common parser logic of links and images.
factory function for creating a new inline link or image based on the text, url and optional title parameters
factory function for creating a new link or image reference based on the text and id parameters
Parses a simple inline link in the form of <http://someURL/>
Creates a parser for an inline span based on the specified parsers that represent the start and end condition.
Creates a parser for an inline span based on the specified parsers that represent the start and end condition.
the parser that parses the beginning of the span, result will be discarded
the parser that recognizes the end of the span, result will be discarded
The mapping of markup start characters to their corresponding span parsers.
The mapping of markup start characters to their corresponding span parsers.
A parser mapped to a start character is not required to successfully parse the subsequent input. If it fails the character that triggered the parser invocation will be treated as normal text. The mapping is merely used as a performance optimization. The parser will be invoked with the input offset pointing to the character after the one specified as the key for the mapping.
Parses a list of spans based on the specified helper parsers.
Parses a list of spans based on the specified helper parsers.
the parser for the text of the current span element
the resulting parser
Parses a span of strong text enclosed by two consecutive occurrences of the specified character.
Parses text based on the specified helper parsers.
Parses text based on the specified helper parsers.
the parser for the text of the current element
a mapping from the start character of a span to the corresponding parser for nested span elements
the resulting parser
Parses horizontal whitespace (space and tab).
Parses horizontal whitespace (space and tab). Always succeeds, consuming all whitespace found.
Provides all inline parsers for Markdown text except for those dealing with verbatim HTML markup which this library treats as an optional feature that has to be explicitly mixed in.
Inline parsers deal with markup within a block of text, such as a link or emphasized text. They are used in the second phase of parsing, after the block parsers have cut the document into a (potentially nested) block structure.