Commonmark.TokParsers

Documentation

satisfyTok :: Monad m => (Tok -> Bool) -> ParsecT [Tok] s m Tok

Parses a single Tok satisfying a predicate.

satisfyWord :: Monad m => (Text -> Bool) -> ParsecT [Tok] s m Tok

Parses a WordChars token matching a predicate.

anyTok :: Monad m => ParsecT [Tok] s m Tok

Parses any Tok.

anySymbol :: Monad m => ParsecT [Tok] s m Tok

Parses any Symbol Tok.

symbol :: Monad m => Char -> ParsecT [Tok] s m Tok

Parses a Symbol with character c.

whitespace :: Monad m => ParsecT [Tok] s m [Tok]

Parses one or more whitespace Toks.

lineEnd :: Monad m => ParsecT [Tok] s m Tok

Parses a LineEnd token.

spaceTok :: Monad m => ParsecT [Tok] s m Tok

Parses a Spaces token.

oneOfToks :: Monad m => [TokType] -> ParsecT [Tok] s m Tok

Parses a Tok with one of the listed types.

noneOfToks :: Monad m => [TokType] -> ParsecT [Tok] s m Tok

Parses a Tok with none of the listed types.

gobbleSpaces :: Monad m => Int -> ParsecT [Tok] u m Int

Parses exactly n spaces. If tabs are encountered, they are split into spaces before being consumed; so a tab may be partially consumed by this parser.

gobbleUpToSpaces :: Monad m => Int -> ParsecT [Tok] u m Int

Parses up to n spaces.

withRaw :: Monad m => ParsecT [Tok] s m a -> ParsecT [Tok] s m (a, [Tok])

Applies a parser and returns its value (if successful) plus a list of the raw tokens parsed.

hasType :: TokType -> Tok -> Bool

Filters tokens of a certain type.

textIs :: (Text -> Bool) -> Tok -> Bool

Filters tokens with certain contents.

blankLine :: Monad m => ParsecT [Tok] s m ()

Parse optional spaces and an endline.

restOfLine :: Monad m => ParsecT [Tok] s m [Tok]

Efficiently parse the remaining tokens on a line, including the LineEnd (if any).

isOneOfCI :: [Text] -> Text -> Bool

Case-insensitive membership in a list of Texts.

nonindentSpaces :: Monad m => ParsecT [Tok] u m ()

Gobble up to 3 spaces (may be part of a tab).

skipManyTill :: ParsecT s u m a -> ParsecT s u m b -> ParsecT s u m ()

Apply p many times until stop succeeds, discarding results.

skipWhile :: Monad m => (Tok -> Bool) -> ParsecT [Tok] u m ()

Efficiently skip Toks satisfying a certain condition.