InlineParsers
Related Doc:
package rst
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.
Represent a reference name.
Represent a reference name. When resolving references whitespace needs to be normalized and the name converted to lower case.
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.
Parses a single email address as defined in RFC 6068.
Parses a single email address as defined in RFC 6068.
addr-spec = local-part "@" domain
Parses letters according to RFC 2234.
Parses letters according to RFC 2234.
ALPHA = %x41-5A / %x61-7A ; A-Z / a-z
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.
Parses the authority part of a URI as defined in RFC 3986.
Parses the authority part of a URI as defined in RFC 3986.
authority = [ userinfo "@" ] host [ ":" port ]
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 citation reference.
Parses a citation reference.
See http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#citation-references.
The default text role to use when no role is specified in an interpreted text element.
Parses digits according to RFC 2234.
Parses digits according to RFC 2234.
DIGIT = %x30-39; 0-9
Parses the domain portion of an email address as defined in RFC 6068.
Parses the domain portion of an email address as defined in RFC 6068.
domain = dot-atom-text / "[" *dtext-no-obs "]" dtext-no-obs = %d33-90 / ; Printable US-ASCII %d94-126 ; characters not including ; "[", "]", or "\"
Parses a dot-atom-text sequence as defined in RFC 5322.
Parses a dot-atom-text sequence as defined in RFC 5322.
dot-atom-text = 1*atext *("." 1*atext) atext = ALPHA / DIGIT / ; Printable US-ASCII "!" / "#" / ; characters not including "$" / "%" / ; specials. Used for atoms. "&" / "'" / "*" / "+" / "-" / "/" / "=" / "?" / "^" / "_" / "`" / "{" / "|" / "}" / "~"
Parses a span of emphasized text.
Parses a span of emphasized text.
See http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#emphasis
Parses a standalone email address (with no surrounding markup).
Parses a standalone email address (with no surrounding markup).
See http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#standalone-hyperlinks
Parses a mailto URI without the scheme part as defined in RFC 6068.
Parses a mailto URI without the scheme part as defined in RFC 6068.
Parses a full mailto URI as defined in RFC 6068.
Parses a full mailto URI as defined in RFC 6068.
mailtoURI = "mailto:" [ to ] [ hfields ]
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 an escaped character.
Parses an escaped character. For most characters it produces the character itself as the result with the only exception being an escaped space character which is removed from the output in reStructuredText.
See http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#escaping-mechanism.
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
Flattens the result from various combinators,
including the repX variants and ~ into
a single string.
Flattens the result from various combinators,
including the repX variants and ~ into
a single string.
Parses any of the four supported types of footnote labels.
Parses any of the four supported types of footnote labels.
See http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#footnote-references.
Parses a footnote reference.
Parses a footnote reference.
See http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#footnote-references.
Parses the fragment part of a URI as defined in RFC 3986.
Parses the fragment part of a URI as defined in RFC 3986.
fragment = *( pchar / "/" / "?" )
Parses a hexadecimal value according to RFC 2234.
Parses a hexadecimal value according to RFC 2234.
HEXDIG = DIGIT / "A" / "B" / "C" / "D" / "E" / "F"
Parses header fields of an email address as defined in RFC 6068.
Parses header fields of an email address as defined in RFC 6068.
hfields = "?" hfield *( "&" hfield ) hfield = hfname "=" hfvalue hfname = *qchar hfvalue = *qchar qchar = unreserved / pct-encoded / some-delims some-delims = "!" / "$" / "'" / "(" / ")" / "*" / "+" / "," / ";" / ":" / "@"
Parses the hierarchical part of a URI with an authority component as defined in RFC 3986, but only the variant including an authority component.
Parses the hierarchical part of a URI with an authority component as defined in RFC 3986, but only the variant including an authority component.
hier-part = "//" authority path-abempty
/ path-absolute ; excluded
/ path-rootless ; excluded
/ path-empty ; excluded
Parses a host as defined in RFC 3986.
Parses a host as defined in RFC 3986.
host = IP-literal / IPv4address / reg-name
Parses a full HTTP URI including the scheme part and an authority component as defined in RFC 3986.
Parses a full HTTP URI including the scheme part and an authority component as defined in RFC 3986.
Parses an HTTP or HTTPS URI with an authority component, but without the scheme part (therefore starting with "//") as defined in RFC 3986.
Parses an HTTP or HTTPS URI with an authority component, but without the scheme part (therefore starting with "//") as defined in RFC 3986.
URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ]
Parses a full HTTPS URI including the scheme part and an authority component as defined in RFC 3986.
Parses a full HTTPS URI including the scheme part and an authority component as defined in RFC 3986.
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 inline literal element.
Parses an inline literal element.
See http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#inline-literals.
Parses an inline internal link target.
Parses an inline internal link target.
See http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#inline-internal-targets
Parses an interpreted text element with the role name as a prefix.
Parses an interpreted text element with the role name as a prefix.
See http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#interpreted-text
Parses an interpreted text element with the role name as a suffix.
Parses an interpreted text element with the role name as a suffix.
See http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#interpreted-text
Parses an ip literal as defined in RFC 3986.
Parses an ip literal as defined in RFC 3986.
IP-literal = "[" ( IPv6address / IPvFuture ) "]"
Parses an IPv4 address as defined in RFC 3986.
Parses an IPv4 address as defined in RFC 3986.
IPv4address = dec-octet "." dec-octet "." dec-octet "." dec-octet dec-octet = DIGIT ; 0-9 / %x31-39 DIGIT ; 10-99 / "1" 2DIGIT ; 100-199 / "2" %x30-34 DIGIT ; 200-249 / "25" %x30-35 ; 250-255
The implementation has been simplified to parse a 3-digit number and check its value.
Parses an IPv6 address as defined in RFC 3986.
Parses an IPv6 address as defined in RFC 3986.
IPv6address = 6( h16 ":" ) ls32 / "::" 5( h16 ":" ) ls32 / [ h16 ] "::" 4( h16 ":" ) ls32 / [ *1( h16 ":" ) h16 ] "::" 3( h16 ":" ) ls32 / [ *2( h16 ":" ) h16 ] "::" 2( h16 ":" ) ls32 / [ *3( h16 ":" ) h16 ] "::" h16 ":" ls32 / [ *4( h16 ":" ) h16 ] "::" ls32 / [ *5( h16 ":" ) h16 ] "::" h16 / [ *6( h16 ":" ) h16 ] "::" h16 = 1*4HEXDIG ls32 = ( h16 ":" h16 ) / IPv4address
Parses a future IP address as defined in RFC 3986.
Parses a future IP address as defined in RFC 3986.
IPvFuture = "v" 1*HEXDIG "." 1*( unreserved / sub-delims / ":" )
Parses the local part of an email address (before the @), with one deviation from RFC 6068: a quoted string is not allowed.
Parses the local part of an email address (before the @), with one deviation from RFC 6068: a quoted string is not allowed. It is rarely used, not supported by the reStructuredText reference parser and would be hard to combine within text markup as it allows for whitespace and line break characters.
local-part = dot-atom-text / quoted-string ; quoted-string omitted
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.
Parses the end of an inline element according to reStructuredText markup recognition rules.
Parses the end of an inline element according to reStructuredText markup recognition rules.
See http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#inline-markup-recognition-rules.
the parser that recognizes the markup at the end of an inline element
a parser that produces the same result as the parser passed as an argument
Parses the start of an inline element without specific start markup according to reStructuredText markup recognition rules.
Parses the start of an inline element without specific start markup according to reStructuredText markup recognition rules.
See http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#inline-markup-recognition-rules.
the parser that recognizes the markup at the end of an inline element, needed to verify the start sequence is not immediately followed by an end sequence as empty elements are not allowed.
a parser without a useful result, as it is only needed to verify it succeeds
Parses the markup at the start of an inline element according to reStructuredText markup recognition rules.
Parses the markup at the start of an inline element according to reStructuredText markup recognition rules.
See http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#inline-markup-recognition-rules.
the parser that recognizes the markup at the start of an inline element
the parser that recognizes the markup at the end of an inline element, needed to verify the start sequence is not immediately followed by an end sequence as empty elements are not allowed.
a parser without a useful result, as it is only needed to verify it succeeds
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.
Parses one path character as defined in RFC 3986.
Parses one path character as defined in RFC 3986.
pchar = unreserved / pct-encoded / sub-delims / ":" / "@"
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 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 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.
Parses the path of a URI as defined in RFC 3986, but only the path variant following an authority component.
Parses the path of a URI as defined in RFC 3986, but only the path variant following an authority component.
path-abempty = *( "/" segment )
segment = *pchar
Parses a percent-encoded character as defined in RFC 3986.
Parses a percent-encoded character as defined in RFC 3986.
pct-encoded = "%" HEXDIG HEXDIG
Parses a phrase link reference (enclosed in back ticks).
Parses a phrase link reference (enclosed in back ticks).
See http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#hyperlink-references
Parses a phrase reference name enclosed in back ticks.
Parses a phrase reference name enclosed in back ticks.
See http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#reference-names.
Parses a port as defined in RFC 3986, except for requiring at least one digit; instead the port is defined as optional in a higher level combinator.
Parses a port as defined in RFC 3986, except for requiring at least one digit; instead the port is defined as optional in a higher level combinator.
port = *DIGIT
A mapping of the start character of an inline element to the corresponding parser.
A mapping of the start character of an inline element to the corresponding parser. The mapping is used to provide a fast implementation of an inline parser that only stops at known special characters.
Parses the query part of a URI as defined in RFC 3986.
Parses the query part of a URI as defined in RFC 3986.
query = *( pchar / "/" / "?" )
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 -, _, ., :, +.
Parses a server name as defined in RFC 3986.
Parses a server name as defined in RFC 3986.
reg-name = *( unreserved / pct-encoded / sub-delims )
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.
Parses a simple link reference.
Parses a simple link reference.
See http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#hyperlink-references
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 -, _, ., :, +.
See http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#reference-names.
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 text with strong emphasis.
Parses a span of text with strong emphasis.
See http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#strong-emphasis
Parses a single sub-delimiter as defined in RFC 3986.
Parses a single sub-delimiter as defined in RFC 3986.
sub-delims = "!" / "$" / "&" / "'" / "(" / ")" / "*" / "+" / "," / ";" / "="
Parses a substitution reference.
Parses a substitution reference.
See http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#substitution-references.
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 a sequence of email addresses as defined in RFC 6068.
Parses a sequence of email addresses as defined in RFC 6068.
to = addr-spec *("," addr-spec )
Parses a single unreserved character as defined in RFC 3986.
Parses a single unreserved character as defined in RFC 3986.
sub-delims = "!" / "$" / "&" / "'" / "(" / ")" / "*" / "+" / "," / ";" / "="
Parses a standalone HTTP or HTTPS hyperlink (with no surrounding markup).
Parses a standalone HTTP or HTTPS hyperlink (with no surrounding markup).
See http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#standalone-hyperlinks
Parses the user info portion of a URI as defined in RFC 3986.
Parses the user info portion of a URI as defined in RFC 3986.
userinfo = *( unreserved / pct-encoded / sub-delims / ":" )
Parses horizontal whitespace (space and tab).
Parses horizontal whitespace (space and tab). Always succeeds, consuming all whitespace found.
Provides all inline parsers for reStructuredText.
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.