Copyright | Copyright (C) 2006-2021 John MacFarlane |
---|---|
License | GNU GPL, version 2 or above |
Maintainer | John MacFarlane <jgm@berkeley.edu> |
Stability | alpha |
Portability | portable |
Safe Haskell | None |
Language | Haskell2010 |
Text.Pandoc.Parsing
Contents
Description
A utility library with parsers used in pandoc readers.
Synopsis
- module Text.Pandoc.Sources
- countChar :: (Stream s m Char, UpdateSourcePos s Char, Monad m) => Int -> ParsecT s st m Char -> ParsecT s st m Text
- textStr :: (Stream s m Char, UpdateSourcePos s Char) => Text -> ParsecT s u m Text
- anyLine :: Monad m => ParserT Sources st m Text
- anyLineNewline :: Monad m => ParserT Sources st m Text
- indentWith :: (Stream s m Char, UpdateSourcePos s Char) => HasReaderOptions st => Int -> ParserT s st m Text
- manyChar :: Stream s m t => ParserT s st m Char -> ParserT s st m Text
- many1Char :: Stream s m t => ParserT s st m Char -> ParserT s st m Text
- manyTillChar :: Stream s m t => ParserT s st m Char -> ParserT s st m a -> ParserT s st m Text
- many1TillChar :: (Show end, Stream s m t) => ParserT s st m Char -> ParserT s st m end -> ParserT s st m Text
- many1Till :: (Show end, Stream s m t) => ParserT s st m a -> ParserT s st m end -> ParserT s st m [a]
- manyUntil :: ParserT s u m a -> ParserT s u m b -> ParserT s u m ([a], b)
- manyUntilChar :: ParserT s u m Char -> ParserT s u m b -> ParserT s u m (Text, b)
- sepBy1' :: ParsecT s u m a -> ParsecT s u m sep -> ParsecT s u m [a]
- notFollowedBy' :: (Show b, Stream s m a) => ParserT s st m b -> ParserT s st m ()
- oneOfStrings :: (Stream s m Char, UpdateSourcePos s Char) => [Text] -> ParserT s st m Text
- oneOfStringsCI :: (Stream s m Char, UpdateSourcePos s Char) => [Text] -> ParserT s st m Text
- spaceChar :: (Stream s m Char, UpdateSourcePos s Char) => ParserT s st m Char
- nonspaceChar :: (Stream s m Char, UpdateSourcePos s Char) => ParserT s st m Char
- skipSpaces :: (Stream s m Char, UpdateSourcePos s Char) => ParserT s st m ()
- blankline :: (Stream s m Char, UpdateSourcePos s Char) => ParserT s st m Char
- blanklines :: (Stream s m Char, UpdateSourcePos s Char) => ParserT s st m Text
- gobbleSpaces :: (HasReaderOptions st, Monad m) => Int -> ParserT Sources st m ()
- gobbleAtMostSpaces :: (HasReaderOptions st, Monad m) => Int -> ParserT Sources st m Int
- enclosed :: (Show end, Stream s m Char, UpdateSourcePos s Char) => ParserT s st m t -> ParserT s st m end -> ParserT s st m a -> ParserT s st m [a]
- stringAnyCase :: (Stream s m Char, UpdateSourcePos s Char) => Text -> ParserT s st m Text
- parseFromString :: Monad m => ParserT Sources st m r -> Text -> ParserT Sources st m r
- parseFromString' :: (Monad m, HasLastStrPosition u) => ParserT Sources u m a -> Text -> ParserT Sources u m a
- lineClump :: Monad m => ParserT Sources st m Text
- charsInBalanced :: (Stream s m Char, UpdateSourcePos s Char) => Char -> Char -> ParserT s st m Char -> ParserT s st m Text
- romanNumeral :: (Stream s m Char, UpdateSourcePos s Char) => Bool -> ParserT s st m Int
- emailAddress :: (Stream s m Char, UpdateSourcePos s Char) => ParserT s st m (Text, Text)
- uri :: (Stream s m Char, UpdateSourcePos s Char) => ParserT s st m (Text, Text)
- mathInline :: (HasReaderOptions st, Stream s m Char, UpdateSourcePos s Char) => ParserT s st m Text
- mathDisplay :: (HasReaderOptions st, Stream s m Char, UpdateSourcePos s Char) => ParserT s st m Text
- withHorizDisplacement :: (Stream s m Char, UpdateSourcePos s Char) => ParserT s st m a -> ParserT s st m (a, Int)
- withRaw :: Monad m => ParsecT Sources st m a -> ParsecT Sources st m (a, Text)
- escaped :: (Stream s m Char, UpdateSourcePos s Char) => ParserT s st m Char -> ParserT s st m Char
- characterReference :: (Stream s m Char, UpdateSourcePos s Char) => ParserT s st m Char
- upperRoman :: (Stream s m Char, UpdateSourcePos s Char) => ParserT s st m (ListNumberStyle, Int)
- lowerRoman :: (Stream s m Char, UpdateSourcePos s Char) => ParserT s st m (ListNumberStyle, Int)
- decimal :: (Stream s m Char, UpdateSourcePos s Char) => ParserT s st m (ListNumberStyle, Int)
- lowerAlpha :: (Stream s m Char, UpdateSourcePos s Char) => ParserT s st m (ListNumberStyle, Int)
- upperAlpha :: (Stream s m Char, UpdateSourcePos s Char) => ParserT s st m (ListNumberStyle, Int)
- anyOrderedListMarker :: (Stream s m Char, UpdateSourcePos s Char) => ParserT s ParserState m ListAttributes
- orderedListMarker :: (Stream s m Char, UpdateSourcePos s Char) => ListNumberStyle -> ListNumberDelim -> ParserT s ParserState m Int
- charRef :: (Stream s m Char, UpdateSourcePos s Char) => ParserT s st m Inline
- lineBlockLines :: Monad m => ParserT Sources st m [Text]
- tableWith :: (Stream s m Char, UpdateSourcePos s Char, HasReaderOptions st, Monad mf) => ParserT s st m (mf [Blocks], [Alignment], [Int]) -> ([Int] -> ParserT s st m (mf [Blocks])) -> ParserT s st m sep -> ParserT s st m end -> ParserT s st m (mf Blocks)
- widthsFromIndices :: Int -> [Int] -> [Double]
- gridTableWith :: (Monad m, HasReaderOptions st, HasLastStrPosition st, Monad mf) => ParserT Sources st m (mf Blocks) -> Bool -> ParserT Sources st m (mf Blocks)
- gridTableWith' :: (Monad m, HasReaderOptions st, HasLastStrPosition st, Monad mf) => ParserT Sources st m (mf Blocks) -> Bool -> ParserT Sources st m (TableComponents mf)
- readWith :: ToSources t => Parser Sources st a -> st -> t -> Either PandocError a
- readWithM :: (Monad m, ToSources t) => ParserT Sources st m a -> st -> t -> m (Either PandocError a)
- testStringWith :: Show a => ParserT Sources ParserState Identity a -> Text -> IO ()
- guardEnabled :: (Stream s m a, HasReaderOptions st) => Extension -> ParserT s st m ()
- guardDisabled :: (Stream s m a, HasReaderOptions st) => Extension -> ParserT s st m ()
- updateLastStrPos :: (Stream s m a, HasLastStrPosition st) => ParserT s st m ()
- notAfterString :: (Stream s m a, HasLastStrPosition st) => ParserT s st m Bool
- logMessage :: (Stream s m a, HasLogMessages st) => LogMessage -> ParserT s st m ()
- reportLogMessages :: (PandocMonad m, HasLogMessages st) => ParserT s st m ()
- data ParserState = ParserState {
- stateOptions :: ReaderOptions
- stateParserContext :: ParserContext
- stateQuoteContext :: QuoteContext
- stateAllowLinks :: Bool
- stateAllowLineBreaks :: Bool
- stateMaxNestingLevel :: Int
- stateLastStrPos :: Maybe SourcePos
- stateKeys :: KeyTable
- stateHeaderKeys :: KeyTable
- stateSubstitutions :: SubstTable
- stateNotes :: NoteTable
- stateNotes' :: NoteTable'
- stateNoteRefs :: Set Text
- stateInNote :: Bool
- stateNoteNumber :: Int
- stateMeta :: Meta
- stateMeta' :: Future ParserState Meta
- stateCitations :: Map Text Text
- stateHeaderTable :: [HeaderType]
- stateIdentifiers :: Set Text
- stateNextExample :: Int
- stateExamples :: Map Text Int
- stateMacros :: Map Text Macro
- stateRstDefaultRole :: Text
- stateRstHighlight :: Maybe Text
- stateRstCustomRoles :: Map Text (Text, Maybe Text, Attr)
- stateCaption :: Maybe Inlines
- stateInHtmlBlock :: Maybe Text
- stateFencedDivLevel :: Int
- stateContainers :: [Text]
- stateLogMessages :: [LogMessage]
- stateMarkdownAttribute :: Bool
- class HasReaderOptions st where
- extractReaderOptions :: st -> ReaderOptions
- getOption :: Stream s m t => (ReaderOptions -> b) -> ParserT s st m b
- class HasIdentifierList st where
- extractIdentifierList :: st -> Set Text
- updateIdentifierList :: (Set Text -> Set Text) -> st -> st
- class HasMacros st where
- extractMacros :: st -> Map Text Macro
- updateMacros :: (Map Text Macro -> Map Text Macro) -> st -> st
- class HasLogMessages st where
- addLogMessage :: LogMessage -> st -> st
- getLogMessages :: st -> [LogMessage]
- class HasLastStrPosition st where
- setLastStrPos :: Maybe SourcePos -> st -> st
- getLastStrPos :: st -> Maybe SourcePos
- class HasIncludeFiles st where
- getIncludeFiles :: st -> [Text]
- addIncludeFile :: Text -> st -> st
- dropLatestIncludeFile :: st -> st
- defaultParserState :: ParserState
- data HeaderType
- = SingleHeader Char
- | DoubleHeader Char
- data ParserContext
- data QuoteContext
- class HasQuoteContext st m where
- getQuoteContext :: Stream s m t => ParsecT s st m QuoteContext
- withQuoteContext :: QuoteContext -> ParsecT s st m a -> ParsecT s st m a
- type NoteTable = [(Text, Text)]
- type NoteTable' = Map Text (SourcePos, Future ParserState Blocks)
- type KeyTable = Map Key (Target, Attr)
- type SubstTable = Map Key Inlines
- newtype Key = Key Text
- toKey :: Text -> Key
- registerHeader :: (Stream s m a, HasReaderOptions st, HasLogMessages st, HasIdentifierList st) => Attr -> Inlines -> ParserT s st m Attr
- smartPunctuation :: (HasReaderOptions st, HasLastStrPosition st, HasQuoteContext st m, Stream s m Char, UpdateSourcePos s Char) => ParserT s st m Inlines -> ParserT s st m Inlines
- singleQuoteStart :: (HasLastStrPosition st, HasQuoteContext st m, Stream s m Char, UpdateSourcePos s Char) => ParserT s st m ()
- singleQuoteEnd :: (Stream s m Char, UpdateSourcePos s Char) => ParserT s st m ()
- doubleQuoteStart :: (HasLastStrPosition st, HasQuoteContext st m, Stream s m Char, UpdateSourcePos s Char) => ParserT s st m ()
- doubleQuoteEnd :: (Stream s m Char, UpdateSourcePos s Char) => ParserT s st m ()
- apostrophe :: (Stream s m Char, UpdateSourcePos s Char) => ParserT s st m Inlines
- doubleCloseQuote :: (Stream s m Char, UpdateSourcePos s Char) => ParserT s st m Inlines
- ellipses :: (Stream s m Char, UpdateSourcePos s Char) => ParserT s st m Inlines
- dash :: (HasReaderOptions st, Stream s m Char, UpdateSourcePos s Char) => ParserT s st m Inlines
- nested :: Stream s m a => ParserT s ParserState m a -> ParserT s ParserState m a
- citeKey :: (Stream s m Char, UpdateSourcePos s Char, HasLastStrPosition st) => Bool -> ParserT s st m (Bool, Text)
- type Parser t s = Parsec t s
- type ParserT = ParsecT
- newtype Future s a = Future {
- runDelayed :: Reader s a
- runF :: Future s a -> s -> a
- askF :: Future s s
- asksF :: (s -> a) -> Future s a
- returnF :: Monad m => a -> m (Future s a)
- trimInlinesF :: Future s Inlines -> Future s Inlines
- token :: Stream s m t => (t -> Text) -> (t -> SourcePos) -> (t -> Maybe a) -> ParsecT s st m a
- (<+?>) :: Monoid a => ParserT s st m a -> ParserT s st m a -> ParserT s st m a
- extractIdClass :: Attr -> Attr
- insertIncludedFile :: (PandocMonad m, HasIncludeFiles st) => ParserT a st m b -> (Text -> a) -> [FilePath] -> FilePath -> Maybe Int -> Maybe Int -> ParserT a st m b
- class Monad m => Stream s (m :: Type -> Type) t | s -> t
- runParser :: Stream s Identity t => Parsec s u a -> u -> SourceName -> s -> Either ParseError a
- runParserT :: Stream s m t => ParsecT s u m a -> u -> SourceName -> s -> m (Either ParseError a)
- parse :: Stream s Identity t => Parsec s () a -> SourceName -> s -> Either ParseError a
- tokenPrim :: forall s (m :: Type -> Type) t a u. Stream s m t => (t -> String) -> (SourcePos -> t -> s -> SourcePos) -> (t -> Maybe a) -> ParsecT s u m a
- anyToken :: forall s (m :: Type -> Type) t u. (Stream s m t, Show t) => ParsecT s u m t
- getInput :: forall (m :: Type -> Type) s u. Monad m => ParsecT s u m s
- setInput :: forall (m :: Type -> Type) s u. Monad m => s -> ParsecT s u m ()
- unexpected :: forall s (m :: Type -> Type) t u a. Stream s m t => String -> ParsecT s u m a
- skipMany :: forall s u (m :: Type -> Type) a. ParsecT s u m a -> ParsecT s u m ()
- skipMany1 :: forall s (m :: Type -> Type) t u a. Stream s m t => ParsecT s u m a -> ParsecT s u m ()
- count :: forall s (m :: Type -> Type) t u a. Stream s m t => Int -> ParsecT s u m a -> ParsecT s u m [a]
- eof :: forall s (m :: Type -> Type) t u. (Stream s m t, Show t) => ParsecT s u m ()
- lookAhead :: forall s (m :: Type -> Type) t u a. Stream s m t => ParsecT s u m a -> ParsecT s u m a
- notFollowedBy :: forall s (m :: Type -> Type) t a u. (Stream s m t, Show a) => ParsecT s u m a -> ParsecT s u m ()
- many :: forall s u (m :: Type -> Type) a. ParsecT s u m a -> ParsecT s u m [a]
- many1 :: forall s (m :: Type -> Type) t u a. Stream s m t => ParsecT s u m a -> ParsecT s u m [a]
- manyTill :: forall s (m :: Type -> Type) t u a end. Stream s m t => ParsecT s u m a -> ParsecT s u m end -> ParsecT s u m [a]
- (<|>) :: forall s u (m :: Type -> Type) a. ParsecT s u m a -> ParsecT s u m a -> ParsecT s u m a
- (<?>) :: forall s u (m :: Type -> Type) a. ParsecT s u m a -> String -> ParsecT s u m a
- choice :: forall s (m :: Type -> Type) t u a. Stream s m t => [ParsecT s u m a] -> ParsecT s u m a
- try :: forall s u (m :: Type -> Type) a. ParsecT s u m a -> ParsecT s u m a
- sepBy :: forall s (m :: Type -> Type) t u a sep. Stream s m t => ParsecT s u m a -> ParsecT s u m sep -> ParsecT s u m [a]
- sepBy1 :: forall s (m :: Type -> Type) t u a sep. Stream s m t => ParsecT s u m a -> ParsecT s u m sep -> ParsecT s u m [a]
- sepEndBy :: forall s (m :: Type -> Type) t u a sep. Stream s m t => ParsecT s u m a -> ParsecT s u m sep -> ParsecT s u m [a]
- sepEndBy1 :: forall s (m :: Type -> Type) t u a sep. Stream s m t => ParsecT s u m a -> ParsecT s u m sep -> ParsecT s u m [a]
- endBy :: forall s (m :: Type -> Type) t u a sep. Stream s m t => ParsecT s u m a -> ParsecT s u m sep -> ParsecT s u m [a]
- endBy1 :: forall s (m :: Type -> Type) t u a sep. Stream s m t => ParsecT s u m a -> ParsecT s u m sep -> ParsecT s u m [a]
- option :: forall s (m :: Type -> Type) t a u. Stream s m t => a -> ParsecT s u m a -> ParsecT s u m a
- optional :: forall s (m :: Type -> Type) t u a. Stream s m t => ParsecT s u m a -> ParsecT s u m ()
- optionMaybe :: forall s (m :: Type -> Type) t u a. Stream s m t => ParsecT s u m a -> ParsecT s u m (Maybe a)
- getState :: forall (m :: Type -> Type) s u. Monad m => ParsecT s u m u
- setState :: forall (m :: Type -> Type) u s. Monad m => u -> ParsecT s u m ()
- updateState :: forall (m :: Type -> Type) u s. Monad m => (u -> u) -> ParsecT s u m ()
- data SourcePos
- getPosition :: forall (m :: Type -> Type) s u. Monad m => ParsecT s u m SourcePos
- setPosition :: forall (m :: Type -> Type) s u. Monad m => SourcePos -> ParsecT s u m ()
- sourceName :: SourcePos -> SourceName
- setSourceName :: SourcePos -> SourceName -> SourcePos
- sourceColumn :: SourcePos -> Column
- sourceLine :: SourcePos -> Line
- setSourceColumn :: SourcePos -> Column -> SourcePos
- setSourceLine :: SourcePos -> Line -> SourcePos
- incSourceColumn :: SourcePos -> Column -> SourcePos
- incSourceLine :: SourcePos -> Line -> SourcePos
- newPos :: SourceName -> Line -> Column -> SourcePos
- initialPos :: SourceName -> SourcePos
- type Line = Int
- type Column = Int
- data ParseError
Documentation
module Text.Pandoc.Sources
countChar :: (Stream s m Char, UpdateSourcePos s Char, Monad m) => Int -> ParsecT s st m Char -> ParsecT s st m Text Source #
Like count
, but packs its result
textStr :: (Stream s m Char, UpdateSourcePos s Char) => Text -> ParsecT s u m Text Source #
Like string
, but uses Text
.
anyLine :: Monad m => ParserT Sources st m Text Source #
Parse any line of text, returning the contents without the final newline.
anyLineNewline :: Monad m => ParserT Sources st m Text Source #
Parse any line, include the final newline in the output
indentWith :: (Stream s m Char, UpdateSourcePos s Char) => HasReaderOptions st => Int -> ParserT s st m Text Source #
Parse indent by specified number of spaces (or equiv. tabs)
manyChar :: Stream s m t => ParserT s st m Char -> ParserT s st m Text Source #
Like many
, but packs its result.
many1Char :: Stream s m t => ParserT s st m Char -> ParserT s st m Text Source #
Like many1
, but packs its result.
manyTillChar :: Stream s m t => ParserT s st m Char -> ParserT s st m a -> ParserT s st m Text Source #
Like manyTill
, but packs its result.
many1TillChar :: (Show end, Stream s m t) => ParserT s st m Char -> ParserT s st m end -> ParserT s st m Text Source #
Like many1Till
, but packs its result
many1Till :: (Show end, Stream s m t) => ParserT s st m a -> ParserT s st m end -> ParserT s st m [a] Source #
Like manyTill
, but reads at least one item.
manyUntil :: ParserT s u m a -> ParserT s u m b -> ParserT s u m ([a], b) Source #
Like manyTill
, but also returns the result of end parser.
manyUntilChar :: ParserT s u m Char -> ParserT s u m b -> ParserT s u m (Text, b) Source #
Like manyUntil
, but also packs its result.
sepBy1' :: ParsecT s u m a -> ParsecT s u m sep -> ParsecT s u m [a] Source #
Like sepBy1
from Parsec,
but does not fail if it sep
succeeds and p
fails.
notFollowedBy' :: (Show b, Stream s m a) => ParserT s st m b -> ParserT s st m () Source #
A more general form of notFollowedBy
. This one allows any
type of parser to be specified, and succeeds only if that parser fails.
It does not consume any input.
oneOfStrings :: (Stream s m Char, UpdateSourcePos s Char) => [Text] -> ParserT s st m Text Source #
Parses one of a list of strings. If the list contains two strings one of which is a prefix of the other, the longer string will be matched if possible.
oneOfStringsCI :: (Stream s m Char, UpdateSourcePos s Char) => [Text] -> ParserT s st m Text Source #
Parses one of a list of strings (tried in order), case insensitive.
spaceChar :: (Stream s m Char, UpdateSourcePos s Char) => ParserT s st m Char Source #
Parses a space or tab.
nonspaceChar :: (Stream s m Char, UpdateSourcePos s Char) => ParserT s st m Char Source #
Parses a nonspace, nonnewline character.
skipSpaces :: (Stream s m Char, UpdateSourcePos s Char) => ParserT s st m () Source #
Skips zero or more spaces or tabs.
blankline :: (Stream s m Char, UpdateSourcePos s Char) => ParserT s st m Char Source #
Skips zero or more spaces or tabs, then reads a newline.
blanklines :: (Stream s m Char, UpdateSourcePos s Char) => ParserT s st m Text Source #
Parses one or more blank lines and returns a string of newlines.
gobbleSpaces :: (HasReaderOptions st, Monad m) => Int -> ParserT Sources st m () Source #
Gobble n spaces; if tabs are encountered, expand them and gobble some or all of their spaces, leaving the rest.
gobbleAtMostSpaces :: (HasReaderOptions st, Monad m) => Int -> ParserT Sources st m Int Source #
Gobble up to n spaces; if tabs are encountered, expand them and gobble some or all of their spaces, leaving the rest.
Arguments
:: (Show end, Stream s m Char, UpdateSourcePos s Char) | |
=> ParserT s st m t | start parser |
-> ParserT s st m end | end parser |
-> ParserT s st m a | content parser (to be used repeatedly) |
-> ParserT s st m [a] |
Parses material enclosed between start and end parsers.
stringAnyCase :: (Stream s m Char, UpdateSourcePos s Char) => Text -> ParserT s st m Text Source #
Parse string, case insensitive.
parseFromString :: Monad m => ParserT Sources st m r -> Text -> ParserT Sources st m r Source #
Parse contents of str
using parser
and return result.
parseFromString' :: (Monad m, HasLastStrPosition u) => ParserT Sources u m a -> Text -> ParserT Sources u m a Source #
Like parseFromString
but specialized for ParserState
.
This resets stateLastStrPos
, which is almost always what we want.
lineClump :: Monad m => ParserT Sources st m Text Source #
Parse raw line block up to and including blank lines.
charsInBalanced :: (Stream s m Char, UpdateSourcePos s Char) => Char -> Char -> ParserT s st m Char -> ParserT s st m Text Source #
Parse a string of characters between an open character
and a close character, including text between balanced
pairs of open and close, which must be different. For example,
charsInBalanced '(' ')' anyChar
will parse "(hello (there))"
and return "hello (there)".
Arguments
:: (Stream s m Char, UpdateSourcePos s Char) | |
=> Bool | Uppercase if true |
-> ParserT s st m Int |
Parses a roman numeral (uppercase or lowercase), returns number.
emailAddress :: (Stream s m Char, UpdateSourcePos s Char) => ParserT s st m (Text, Text) Source #
Parses an email address; returns original and corresponding escaped mailto: URI.
uri :: (Stream s m Char, UpdateSourcePos s Char) => ParserT s st m (Text, Text) Source #
Parses a URI. Returns pair of original and URI-escaped version.
mathInline :: (HasReaderOptions st, Stream s m Char, UpdateSourcePos s Char) => ParserT s st m Text Source #
mathDisplay :: (HasReaderOptions st, Stream s m Char, UpdateSourcePos s Char) => ParserT s st m Text Source #
withHorizDisplacement Source #
Arguments
:: (Stream s m Char, UpdateSourcePos s Char) | |
=> ParserT s st m a | Parser to apply |
-> ParserT s st m (a, Int) | (result, displacement) |
Applies a parser, returns tuple of its results and its horizontal displacement (the difference between the source column at the end and the source column at the beginning). Vertical displacement (source row) is ignored.
withRaw :: Monad m => ParsecT Sources st m a -> ParsecT Sources st m (a, Text) Source #
Applies a parser and returns the raw string that was parsed, along with the value produced by the parser.
Arguments
:: (Stream s m Char, UpdateSourcePos s Char) | |
=> ParserT s st m Char | Parser for character to escape |
-> ParserT s st m Char |
Parses backslash, then applies character parser.
characterReference :: (Stream s m Char, UpdateSourcePos s Char) => ParserT s st m Char Source #
Parse character entity.
upperRoman :: (Stream s m Char, UpdateSourcePos s Char) => ParserT s st m (ListNumberStyle, Int) Source #
Parses an uppercase roman numeral and returns (UpperRoman, number).
lowerRoman :: (Stream s m Char, UpdateSourcePos s Char) => ParserT s st m (ListNumberStyle, Int) Source #
Parses a lowercase roman numeral and returns (LowerRoman, number).
decimal :: (Stream s m Char, UpdateSourcePos s Char) => ParserT s st m (ListNumberStyle, Int) Source #
Parses a decimal numeral and returns (Decimal, number).
lowerAlpha :: (Stream s m Char, UpdateSourcePos s Char) => ParserT s st m (ListNumberStyle, Int) Source #
Parses a lowercase letter and returns (LowerAlpha, number).
upperAlpha :: (Stream s m Char, UpdateSourcePos s Char) => ParserT s st m (ListNumberStyle, Int) Source #
Parses an uppercase letter and returns (UpperAlpha, number).
anyOrderedListMarker :: (Stream s m Char, UpdateSourcePos s Char) => ParserT s ParserState m ListAttributes Source #
Parses an ordered list marker and returns list attributes.
orderedListMarker :: (Stream s m Char, UpdateSourcePos s Char) => ListNumberStyle -> ListNumberDelim -> ParserT s ParserState m Int Source #
Parses an ordered list marker with a given style and delimiter, returns number.
charRef :: (Stream s m Char, UpdateSourcePos s Char) => ParserT s st m Inline Source #
Parses a character reference and returns a Str element.
lineBlockLines :: Monad m => ParserT Sources st m [Text] Source #
Parses an RST-style line block and returns a list of strings.
tableWith :: (Stream s m Char, UpdateSourcePos s Char, HasReaderOptions st, Monad mf) => ParserT s st m (mf [Blocks], [Alignment], [Int]) -> ([Int] -> ParserT s st m (mf [Blocks])) -> ParserT s st m sep -> ParserT s st m end -> ParserT s st m (mf Blocks) Source #
Parse a table using headerParser
, rowParser
,
lineParser
, and footerParser
.
widthsFromIndices :: Int -> [Int] -> [Double] Source #
Arguments
:: (Monad m, HasReaderOptions st, HasLastStrPosition st, Monad mf) | |
=> ParserT Sources st m (mf Blocks) | Block list parser |
-> Bool | Headerless table |
-> ParserT Sources st m (mf Blocks) |
Arguments
:: (Monad m, HasReaderOptions st, HasLastStrPosition st, Monad mf) | |
=> ParserT Sources st m (mf Blocks) | Block list parser |
-> Bool | Headerless table |
-> ParserT Sources st m (TableComponents mf) |
readWith :: ToSources t => Parser Sources st a -> st -> t -> Either PandocError a Source #
Parse a string with a given parser and state
Arguments
:: (Monad m, ToSources t) | |
=> ParserT Sources st m a | parser |
-> st | initial state |
-> t | input |
-> m (Either PandocError a) |
Removes the ParsecT layer from the monad transformer stack
testStringWith :: Show a => ParserT Sources ParserState Identity a -> Text -> IO () Source #
Parse a string with parser
(for testing).
guardEnabled :: (Stream s m a, HasReaderOptions st) => Extension -> ParserT s st m () Source #
Succeed only if the extension is enabled.
guardDisabled :: (Stream s m a, HasReaderOptions st) => Extension -> ParserT s st m () Source #
Succeed only if the extension is disabled.
updateLastStrPos :: (Stream s m a, HasLastStrPosition st) => ParserT s st m () Source #
Update the position on which the last string ended.
notAfterString :: (Stream s m a, HasLastStrPosition st) => ParserT s st m Bool Source #
Whether we are right after the end of a string.
logMessage :: (Stream s m a, HasLogMessages st) => LogMessage -> ParserT s st m () Source #
Add a log message.
reportLogMessages :: (PandocMonad m, HasLogMessages st) => ParserT s st m () Source #
Report all the accumulated log messages, according to verbosity level.
data ParserState Source #
Parsing options.
Constructors
ParserState | |
Fields
|
Instances
class HasReaderOptions st where Source #
Minimal complete definition
Methods
extractReaderOptions :: st -> ReaderOptions Source #
getOption :: Stream s m t => (ReaderOptions -> b) -> ParserT s st m b Source #
Instances
HasReaderOptions ParserState Source # | |
Defined in Text.Pandoc.Parsing Methods extractReaderOptions :: ParserState -> ReaderOptions Source # getOption :: forall s (m :: Type -> Type) t b. Stream s m t => (ReaderOptions -> b) -> ParserT s ParserState m b Source # |
class HasIdentifierList st where Source #
Methods
extractIdentifierList :: st -> Set Text Source #
updateIdentifierList :: (Set Text -> Set Text) -> st -> st Source #
Instances
HasIdentifierList ParserState Source # | |
Defined in Text.Pandoc.Parsing Methods extractIdentifierList :: ParserState -> Set Text Source # updateIdentifierList :: (Set Text -> Set Text) -> ParserState -> ParserState Source # |
class HasMacros st where Source #
Methods
extractMacros :: st -> Map Text Macro Source #
updateMacros :: (Map Text Macro -> Map Text Macro) -> st -> st Source #
Instances
HasMacros ParserState Source # | |
Defined in Text.Pandoc.Parsing Methods extractMacros :: ParserState -> Map Text Macro Source # updateMacros :: (Map Text Macro -> Map Text Macro) -> ParserState -> ParserState Source # |
class HasLogMessages st where Source #
Methods
addLogMessage :: LogMessage -> st -> st Source #
getLogMessages :: st -> [LogMessage] Source #
Instances
HasLogMessages ParserState Source # | |
Defined in Text.Pandoc.Parsing Methods addLogMessage :: LogMessage -> ParserState -> ParserState Source # getLogMessages :: ParserState -> [LogMessage] Source # |
class HasLastStrPosition st where Source #
Methods
setLastStrPos :: Maybe SourcePos -> st -> st Source #
getLastStrPos :: st -> Maybe SourcePos Source #
Instances
HasLastStrPosition ParserState Source # | |
Defined in Text.Pandoc.Parsing Methods setLastStrPos :: Maybe SourcePos -> ParserState -> ParserState Source # getLastStrPos :: ParserState -> Maybe SourcePos Source # |
class HasIncludeFiles st where Source #
Methods
getIncludeFiles :: st -> [Text] Source #
addIncludeFile :: Text -> st -> st Source #
dropLatestIncludeFile :: st -> st Source #
Instances
HasIncludeFiles ParserState Source # | |
Defined in Text.Pandoc.Parsing Methods getIncludeFiles :: ParserState -> [Text] Source # addIncludeFile :: Text -> ParserState -> ParserState Source # dropLatestIncludeFile :: ParserState -> ParserState Source # |
data HeaderType Source #
Constructors
SingleHeader Char | Single line of characters underneath |
DoubleHeader Char | Lines of characters above and below |
Instances
Eq HeaderType Source # | |
Defined in Text.Pandoc.Parsing | |
Show HeaderType Source # | |
Defined in Text.Pandoc.Parsing Methods showsPrec :: Int -> HeaderType -> ShowS show :: HeaderType -> String showList :: [HeaderType] -> ShowS |
data ParserContext Source #
Constructors
ListItemState | Used when running parser on list item contents |
NullState | Default state |
Instances
Eq ParserContext Source # | |
Defined in Text.Pandoc.Parsing | |
Show ParserContext Source # | |
Defined in Text.Pandoc.Parsing Methods showsPrec :: Int -> ParserContext -> ShowS show :: ParserContext -> String showList :: [ParserContext] -> ShowS |
data QuoteContext Source #
Constructors
InSingleQuote | Used when parsing inside single quotes |
InDoubleQuote | Used when parsing inside double quotes |
NoQuote | Used when not parsing inside quotes |
Instances
Eq QuoteContext Source # | |
Defined in Text.Pandoc.Parsing | |
Show QuoteContext Source # | |
Defined in Text.Pandoc.Parsing Methods showsPrec :: Int -> QuoteContext -> ShowS show :: QuoteContext -> String showList :: [QuoteContext] -> ShowS |
class HasQuoteContext st m where Source #
Methods
getQuoteContext :: Stream s m t => ParsecT s st m QuoteContext Source #
withQuoteContext :: QuoteContext -> ParsecT s st m a -> ParsecT s st m a Source #
Instances
Monad m => HasQuoteContext ParserState m Source # | |
Defined in Text.Pandoc.Parsing Methods getQuoteContext :: Stream s m t => ParsecT s ParserState m QuoteContext Source # withQuoteContext :: QuoteContext -> ParsecT s ParserState m a -> ParsecT s ParserState m a Source # |
type NoteTable' = Map Text (SourcePos, Future ParserState Blocks) Source #
type SubstTable = Map Key Inlines Source #
Constructors
Key Text |
registerHeader :: (Stream s m a, HasReaderOptions st, HasLogMessages st, HasIdentifierList st) => Attr -> Inlines -> ParserT s st m Attr Source #
smartPunctuation :: (HasReaderOptions st, HasLastStrPosition st, HasQuoteContext st m, Stream s m Char, UpdateSourcePos s Char) => ParserT s st m Inlines -> ParserT s st m Inlines Source #
singleQuoteStart :: (HasLastStrPosition st, HasQuoteContext st m, Stream s m Char, UpdateSourcePos s Char) => ParserT s st m () Source #
singleQuoteEnd :: (Stream s m Char, UpdateSourcePos s Char) => ParserT s st m () Source #
doubleQuoteStart :: (HasLastStrPosition st, HasQuoteContext st m, Stream s m Char, UpdateSourcePos s Char) => ParserT s st m () Source #
doubleQuoteEnd :: (Stream s m Char, UpdateSourcePos s Char) => ParserT s st m () Source #
apostrophe :: (Stream s m Char, UpdateSourcePos s Char) => ParserT s st m Inlines Source #
doubleCloseQuote :: (Stream s m Char, UpdateSourcePos s Char) => ParserT s st m Inlines Source #
dash :: (HasReaderOptions st, Stream s m Char, UpdateSourcePos s Char) => ParserT s st m Inlines Source #
nested :: Stream s m a => ParserT s ParserState m a -> ParserT s ParserState m a Source #
Arguments
:: (Stream s m Char, UpdateSourcePos s Char, HasLastStrPosition st) | |
=> Bool | If True, allow expanded @{..} syntax. |
-> ParserT s st m (Bool, Text) |
Reader monad wrapping the parser state. This is used to possibly delay evaluation until all relevant information has been parsed and made available in the parser state.
Constructors
Future | |
Fields
|
trimInlinesF :: Future s Inlines -> Future s Inlines Source #
token :: Stream s m t => (t -> Text) -> (t -> SourcePos) -> (t -> Maybe a) -> ParsecT s st m a Source #
extractIdClass :: Attr -> Attr Source #
Arguments
:: (PandocMonad m, HasIncludeFiles st) | |
=> ParserT a st m b | parser to apply |
-> (Text -> a) | convert Text to stream type |
-> [FilePath] | search path (directories) |
-> FilePath | path of file to include |
-> Maybe Int | start line (negative counts from end) |
-> Maybe Int | end line (negative counts from end) |
-> ParserT a st m b |
Re-exports from Text.Parsec
class Monad m => Stream s (m :: Type -> Type) t | s -> t #
Minimal complete definition
uncons
Instances
Monad m => Stream Text m Char | |
Defined in Text.Parsec.Prim Methods uncons :: Text -> m (Maybe (Char, Text)) | |
Monad m => Stream ByteString m Char | |
Defined in Text.Parsec.Prim Methods uncons :: ByteString -> m (Maybe (Char, ByteString)) | |
Monad m => Stream ByteString m Char | |
Defined in Text.Parsec.Prim Methods uncons :: ByteString -> m (Maybe (Char, ByteString)) | |
Monad m => Stream Text m Char | |
Defined in Text.Parsec.Prim Methods uncons :: Text -> m (Maybe (Char, Text)) | |
Monad m => Stream Sources m Char Source # | |
Defined in Text.Pandoc.Sources | |
Monad m => Stream [tok] m tok | |
Defined in Text.Parsec.Prim Methods uncons :: [tok] -> m (Maybe (tok, [tok])) |
runParser :: Stream s Identity t => Parsec s u a -> u -> SourceName -> s -> Either ParseError a #
runParserT :: Stream s m t => ParsecT s u m a -> u -> SourceName -> s -> m (Either ParseError a) #
parse :: Stream s Identity t => Parsec s () a -> SourceName -> s -> Either ParseError a #
tokenPrim :: forall s (m :: Type -> Type) t a u. Stream s m t => (t -> String) -> (SourcePos -> t -> s -> SourcePos) -> (t -> Maybe a) -> ParsecT s u m a #
unexpected :: forall s (m :: Type -> Type) t u a. Stream s m t => String -> ParsecT s u m a #
skipMany1 :: forall s (m :: Type -> Type) t u a. Stream s m t => ParsecT s u m a -> ParsecT s u m () #
count :: forall s (m :: Type -> Type) t u a. Stream s m t => Int -> ParsecT s u m a -> ParsecT s u m [a] #
lookAhead :: forall s (m :: Type -> Type) t u a. Stream s m t => ParsecT s u m a -> ParsecT s u m a #
notFollowedBy :: forall s (m :: Type -> Type) t a u. (Stream s m t, Show a) => ParsecT s u m a -> ParsecT s u m () #
manyTill :: forall s (m :: Type -> Type) t u a end. Stream s m t => ParsecT s u m a -> ParsecT s u m end -> ParsecT s u m [a] #
choice :: forall s (m :: Type -> Type) t u a. Stream s m t => [ParsecT s u m a] -> ParsecT s u m a #
sepBy :: forall s (m :: Type -> Type) t u a sep. Stream s m t => ParsecT s u m a -> ParsecT s u m sep -> ParsecT s u m [a] #
sepBy1 :: forall s (m :: Type -> Type) t u a sep. Stream s m t => ParsecT s u m a -> ParsecT s u m sep -> ParsecT s u m [a] #
sepEndBy :: forall s (m :: Type -> Type) t u a sep. Stream s m t => ParsecT s u m a -> ParsecT s u m sep -> ParsecT s u m [a] #
sepEndBy1 :: forall s (m :: Type -> Type) t u a sep. Stream s m t => ParsecT s u m a -> ParsecT s u m sep -> ParsecT s u m [a] #
endBy :: forall s (m :: Type -> Type) t u a sep. Stream s m t => ParsecT s u m a -> ParsecT s u m sep -> ParsecT s u m [a] #
endBy1 :: forall s (m :: Type -> Type) t u a sep. Stream s m t => ParsecT s u m a -> ParsecT s u m sep -> ParsecT s u m [a] #
option :: forall s (m :: Type -> Type) t a u. Stream s m t => a -> ParsecT s u m a -> ParsecT s u m a #
optional :: forall s (m :: Type -> Type) t u a. Stream s m t => ParsecT s u m a -> ParsecT s u m () #
optionMaybe :: forall s (m :: Type -> Type) t u a. Stream s m t => ParsecT s u m a -> ParsecT s u m (Maybe a) #
updateState :: forall (m :: Type -> Type) u s. Monad m => (u -> u) -> ParsecT s u m () #
Instances
Eq SourcePos | |
Data SourcePos | |
Defined in Text.Parsec.Pos Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SourcePos -> c SourcePos gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SourcePos toConstr :: SourcePos -> Constr dataTypeOf :: SourcePos -> DataType dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c SourcePos) dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SourcePos) gmapT :: (forall b. Data b => b -> b) -> SourcePos -> SourcePos gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SourcePos -> r gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SourcePos -> r gmapQ :: (forall d. Data d => d -> u) -> SourcePos -> [u] gmapQi :: Int -> (forall d. Data d => d -> u) -> SourcePos -> u gmapM :: Monad m => (forall d. Data d => d -> m d) -> SourcePos -> m SourcePos gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SourcePos -> m SourcePos gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SourcePos -> m SourcePos | |
Ord SourcePos | |
Defined in Text.Parsec.Pos | |
Show SourcePos | |
getPosition :: forall (m :: Type -> Type) s u. Monad m => ParsecT s u m SourcePos #
setPosition :: forall (m :: Type -> Type) s u. Monad m => SourcePos -> ParsecT s u m () #
sourceName :: SourcePos -> SourceName #
setSourceName :: SourcePos -> SourceName -> SourcePos #
sourceColumn :: SourcePos -> Column #
sourceLine :: SourcePos -> Line #
setSourceColumn :: SourcePos -> Column -> SourcePos #
setSourceLine :: SourcePos -> Line -> SourcePos #
incSourceColumn :: SourcePos -> Column -> SourcePos #
incSourceLine :: SourcePos -> Line -> SourcePos #
initialPos :: SourceName -> SourcePos #
data ParseError #
Instances
Eq ParseError | |
Defined in Text.Parsec.Error | |
Show ParseError | |
Defined in Text.Parsec.Error Methods showsPrec :: Int -> ParseError -> ShowS show :: ParseError -> String showList :: [ParseError] -> ShowS |