Copyright | Copyright (C) 2006-2023 John MacFarlane |
---|---|
License | GNU GPL, version 2 or above |
Maintainer | John MacFarlane <jgm@berkeley.edu> |
Stability | alpha |
Portability | portable |
Safe Haskell | Safe-Inferred |
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 => ParsecT Sources st m Text
- anyLineNewline :: Monad m => ParsecT Sources st m Text
- indentWith :: (Stream s m Char, UpdateSourcePos s Char) => HasReaderOptions st => Int -> ParsecT s st m Text
- manyChar :: Stream s m t => ParsecT s st m Char -> ParsecT s st m Text
- many1Char :: Stream s m t => ParsecT s st m Char -> ParsecT s st m Text
- manyTillChar :: Stream s m t => ParsecT s st m Char -> ParsecT s st m a -> ParsecT s st m Text
- many1TillChar :: (Show end, Stream s m t) => ParsecT s st m Char -> ParsecT s st m end -> ParsecT s st m Text
- many1Till :: (Show end, Stream s m t) => ParsecT s st m a -> ParsecT s st m end -> ParsecT s st m [a]
- manyUntil :: ParsecT s u m a -> ParsecT s u m b -> ParsecT s u m ([a], b)
- manyUntilChar :: ParsecT s u m Char -> ParsecT s u m b -> ParsecT 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) => ParsecT s st m b -> ParsecT s st m ()
- oneOfStrings :: (Stream s m Char, UpdateSourcePos s Char) => [Text] -> ParsecT s st m Text
- oneOfStringsCI :: (Stream s m Char, UpdateSourcePos s Char) => [Text] -> ParsecT s st m Text
- spaceChar :: (Stream s m Char, UpdateSourcePos s Char) => ParsecT s st m Char
- nonspaceChar :: (Stream s m Char, UpdateSourcePos s Char) => ParsecT s st m Char
- skipSpaces :: (Stream s m Char, UpdateSourcePos s Char) => ParsecT s st m ()
- blankline :: (Stream s m Char, UpdateSourcePos s Char) => ParsecT s st m Char
- blanklines :: (Stream s m Char, UpdateSourcePos s Char) => ParsecT s st m Text
- gobbleSpaces :: (HasReaderOptions st, Monad m) => Int -> ParsecT Sources st m ()
- gobbleAtMostSpaces :: (HasReaderOptions st, Monad m) => Int -> ParsecT Sources st m Int
- enclosed :: (Show end, Stream s m Char, UpdateSourcePos s Char) => ParsecT s st m t -> ParsecT s st m end -> ParsecT s st m a -> ParsecT s st m [a]
- stringAnyCase :: (Stream s m Char, UpdateSourcePos s Char) => Text -> ParsecT s st m Text
- parseFromString :: Monad m => ParsecT Sources st m r -> Text -> ParsecT Sources st m r
- parseFromString' :: (Monad m, HasLastStrPosition u) => ParsecT Sources u m a -> Text -> ParsecT Sources u m a
- lineClump :: Monad m => ParsecT Sources st m Text
- charsInBalanced :: (Stream s m Char, UpdateSourcePos s Char) => Char -> Char -> ParsecT s st m Text -> ParsecT s st m Text
- romanNumeral :: (Stream s m Char, UpdateSourcePos s Char) => Bool -> ParsecT s st m Int
- emailAddress :: (Stream s m Char, UpdateSourcePos s Char) => ParsecT s st m (Text, Text)
- uri :: (Stream s m Char, UpdateSourcePos s Char) => ParsecT s st m (Text, Text)
- mathInline :: (HasReaderOptions st, Stream s m Char, UpdateSourcePos s Char) => ParsecT s st m Text
- mathDisplay :: (HasReaderOptions st, Stream s m Char, UpdateSourcePos s Char) => ParsecT s st m Text
- withHorizDisplacement :: (Stream s m Char, UpdateSourcePos s Char) => ParsecT s st m a -> ParsecT s st m (a, Int)
- withRaw :: Monad m => ParsecT Sources st m a -> ParsecT Sources st m (a, Text)
- fromParsecError :: Sources -> ParseError -> PandocError
- escaped :: (Stream s m Char, UpdateSourcePos s Char) => ParsecT s st m Char -> ParsecT s st m Char
- characterReference :: (Stream s m Char, UpdateSourcePos s Char) => ParsecT s st m Text
- upperRoman :: (Stream s m Char, UpdateSourcePos s Char) => ParsecT s st m (ListNumberStyle, Int)
- lowerRoman :: (Stream s m Char, UpdateSourcePos s Char) => ParsecT s st m (ListNumberStyle, Int)
- decimal :: (Stream s m Char, UpdateSourcePos s Char) => ParsecT s st m (ListNumberStyle, Int)
- lowerAlpha :: (Stream s m Char, UpdateSourcePos s Char) => ParsecT s st m (ListNumberStyle, Int)
- upperAlpha :: (Stream s m Char, UpdateSourcePos s Char) => ParsecT s st m (ListNumberStyle, Int)
- anyOrderedListMarker :: (Stream s m Char, UpdateSourcePos s Char) => ParsecT s ParserState m ListAttributes
- orderedListMarker :: (Stream s m Char, UpdateSourcePos s Char) => ListNumberStyle -> ListNumberDelim -> ParsecT s ParserState m Int
- charRef :: (Stream s m Char, UpdateSourcePos s Char) => ParsecT s st m Inline
- lineBlockLines :: Monad m => ParsecT Sources st m [Text]
- tableWith :: (Stream s m Char, UpdateSourcePos s Char, HasReaderOptions st, Monad mf) => ParsecT s st m (mf [Blocks], [Alignment], [Int]) -> ([Int] -> ParsecT s st m (mf [Blocks])) -> ParsecT s st m sep -> ParsecT s st m end -> ParsecT s st m (mf Blocks)
- tableWith' :: (Stream s m Char, UpdateSourcePos s Char, HasReaderOptions st, Monad mf) => TableNormalization -> ParsecT s st m (mf [Blocks], [Alignment], [Int]) -> ([Int] -> ParsecT s st m (mf [Blocks])) -> ParsecT s st m sep -> ParsecT s st m end -> ParsecT s st m (mf TableComponents)
- widthsFromIndices :: Int -> [Int] -> [Double]
- gridTableWith :: (Monad m, Monad mf, HasLastStrPosition st, HasReaderOptions st) => ParsecT Sources st m (mf Blocks) -> ParsecT Sources st m (mf Blocks)
- gridTableWith' :: (Monad m, Monad mf, HasReaderOptions st, HasLastStrPosition st) => TableNormalization -> ParsecT Sources st m (mf Blocks) -> ParsecT Sources st m (mf TableComponents)
- data TableComponents = TableComponents {
- tableAttr :: Attr
- tableCaption :: Caption
- tableColSpecs :: [ColSpec]
- tableHead :: TableHead
- tableBodies :: [TableBody]
- tableFoot :: TableFoot
- data TableNormalization
- toTableComponents :: [Alignment] -> [Double] -> [Blocks] -> [[Blocks]] -> TableComponents
- toTableComponents' :: TableNormalization -> [Alignment] -> [Double] -> [Blocks] -> [[Blocks]] -> TableComponents
- readWith :: ToSources t => Parsec Sources st a -> st -> t -> Either PandocError a
- readWithM :: (Monad m, ToSources t) => ParsecT Sources st m a -> st -> t -> m (Either PandocError a)
- testStringWith :: Show a => ParsecT Sources ParserState Identity a -> Text -> IO ()
- guardEnabled :: (Stream s m a, HasReaderOptions st) => Extension -> ParsecT s st m ()
- guardDisabled :: (Stream s m a, HasReaderOptions st) => Extension -> ParsecT s st m ()
- updateLastStrPos :: (Stream s m a, HasLastStrPosition st) => ParsecT s st m ()
- notAfterString :: (Stream s m a, HasLastStrPosition st) => ParsecT s st m Bool
- logMessage :: (Stream s m a, HasLogMessages st) => LogMessage -> ParsecT s st m ()
- reportLogMessages :: (PandocMonad m, HasLogMessages st) => ParsecT s st m ()
- data ParserState = ParserState {
- stateOptions :: ReaderOptions
- stateParserContext :: ParserContext
- stateQuoteContext :: QuoteContext
- stateAllowLinks :: Bool
- stateAllowLineBreaks :: Bool
- 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) -> ParsecT 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
- 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 -> ParsecT s st m Attr
- smartPunctuation :: (HasReaderOptions st, HasLastStrPosition st, HasQuoteContext st m, Stream s m Char, UpdateSourcePos s Char) => ParsecT s st m Inlines -> ParsecT s st m Inlines
- singleQuoteStart :: (HasLastStrPosition st, HasQuoteContext st m, Stream s m Char, UpdateSourcePos s Char) => ParsecT s st m ()
- singleQuoteEnd :: (Stream s m Char, UpdateSourcePos s Char) => ParsecT s st m ()
- doubleQuoteStart :: (HasLastStrPosition st, HasQuoteContext st m, Stream s m Char, UpdateSourcePos s Char) => ParsecT s st m ()
- doubleQuoteEnd :: (Stream s m Char, UpdateSourcePos s Char) => ParsecT s st m ()
- apostrophe :: (Stream s m Char, UpdateSourcePos s Char) => ParsecT s st m Inlines
- doubleCloseQuote :: (Stream s m Char, UpdateSourcePos s Char) => ParsecT s st m Inlines
- ellipses :: (Stream s m Char, UpdateSourcePos s Char) => ParsecT s st m Inlines
- dash :: (HasReaderOptions st, Stream s m Char, UpdateSourcePos s Char) => ParsecT s st m Inlines
- citeKey :: (Stream s m Char, UpdateSourcePos s Char, HasLastStrPosition st) => Bool -> ParsecT s st m (Bool, Text)
- type Parsec s u = ParsecT s u Identity
- data ParsecT s u (m :: Type -> Type) a
- 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 => ParsecT s st m a -> ParsecT s st m a -> ParsecT s st m a
- extractIdClass :: Attr -> Attr
- insertIncludedFile :: (PandocMonad m, HasIncludeFiles st) => ParsecT a st m b -> (Text -> a) -> [FilePath] -> FilePath -> Maybe Int -> Maybe Int -> ParsecT a st m b
- class Monad m => Stream s (m :: Type -> Type) t | s -> t where
- 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
- type SourceName = String
- updatePosString :: SourcePos -> String -> 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
- errorMessages :: ParseError -> [Message]
- messageString :: Message -> String
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 #
Like count
, but packs its result
textStr :: (Stream s m Char, UpdateSourcePos s Char) => Text -> ParsecT s u m Text #
Like string
, but uses Text
.
anyLine :: Monad m => ParsecT Sources st m Text #
Parse any line of text, returning the contents without the final newline.
anyLineNewline :: Monad m => ParsecT Sources st m Text #
Parse any line, include the final newline in the output
indentWith :: (Stream s m Char, UpdateSourcePos s Char) => HasReaderOptions st => Int -> ParsecT s st m Text #
Parse indent by specified number of spaces (or equiv. tabs)
manyChar :: Stream s m t => ParsecT s st m Char -> ParsecT s st m Text #
Like many
, but packs its result.
many1Char :: Stream s m t => ParsecT s st m Char -> ParsecT s st m Text #
Like many1
, but packs its result.
manyTillChar :: Stream s m t => ParsecT s st m Char -> ParsecT s st m a -> ParsecT s st m Text #
Like manyTill
, but packs its result.
many1TillChar :: (Show end, Stream s m t) => ParsecT s st m Char -> ParsecT s st m end -> ParsecT s st m Text #
Like many1Till
, but packs its result
many1Till :: (Show end, Stream s m t) => ParsecT s st m a -> ParsecT s st m end -> ParsecT s st m [a] #
Like manyTill
, but reads at least one item.
manyUntil :: ParsecT s u m a -> ParsecT s u m b -> ParsecT s u m ([a], b) #
Like manyTill
, but also returns the result of end parser.
manyUntilChar :: ParsecT s u m Char -> ParsecT s u m b -> ParsecT s u m (Text, b) #
Like manyUntil
, but also packs its result.
sepBy1' :: ParsecT s u m a -> ParsecT s u m sep -> ParsecT s u m [a] #
Like sepBy1
from Parsec,
but does not fail if it sep
succeeds and p
fails.
notFollowedBy' :: (Show b, Stream s m a) => ParsecT s st m b -> ParsecT s st m () #
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] -> ParsecT s st m Text #
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] -> ParsecT s st m Text #
Parses one of a list of strings (tried in order), case insensitive.
spaceChar :: (Stream s m Char, UpdateSourcePos s Char) => ParsecT s st m Char #
Parses a space or tab.
nonspaceChar :: (Stream s m Char, UpdateSourcePos s Char) => ParsecT s st m Char #
Parses a nonspace, nonnewline character.
skipSpaces :: (Stream s m Char, UpdateSourcePos s Char) => ParsecT s st m () #
Skips zero or more spaces or tabs.
blankline :: (Stream s m Char, UpdateSourcePos s Char) => ParsecT s st m Char #
Skips zero or more spaces or tabs, then reads a newline.
blanklines :: (Stream s m Char, UpdateSourcePos s Char) => ParsecT s st m Text #
Parses one or more blank lines and returns a string of newlines.
gobbleSpaces :: (HasReaderOptions st, Monad m) => Int -> ParsecT Sources st m () #
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 -> ParsecT Sources st m Int #
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) | |
=> ParsecT s st m t | start parser |
-> ParsecT s st m end | end parser |
-> ParsecT s st m a | content parser (to be used repeatedly) |
-> ParsecT s st m [a] |
Parses material enclosed between start and end parsers.
stringAnyCase :: (Stream s m Char, UpdateSourcePos s Char) => Text -> ParsecT s st m Text #
Parse string, case insensitive.
parseFromString :: Monad m => ParsecT Sources st m r -> Text -> ParsecT Sources st m r #
Parse contents of str
using parser
and return result.
parseFromString' :: (Monad m, HasLastStrPosition u) => ParsecT Sources u m a -> Text -> ParsecT Sources u m a #
Like parseFromString
but specialized for ParserState
.
This resets stateLastStrPos
, which is almost always what we want.
lineClump :: Monad m => ParsecT Sources st m Text #
Parse raw line block up to and including blank lines.
charsInBalanced :: (Stream s m Char, UpdateSourcePos s Char) => Char -> Char -> ParsecT s st m Text -> ParsecT s st m Text #
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)".
Parses a roman numeral (uppercase or lowercase), returns number.
emailAddress :: (Stream s m Char, UpdateSourcePos s Char) => ParsecT s st m (Text, Text) #
Parses an email address; returns original and corresponding escaped mailto: URI.
uri :: (Stream s m Char, UpdateSourcePos s Char) => ParsecT s st m (Text, Text) #
Parses a URI. Returns pair of original and URI-escaped version.
mathInline :: (HasReaderOptions st, Stream s m Char, UpdateSourcePos s Char) => ParsecT s st m Text #
mathDisplay :: (HasReaderOptions st, Stream s m Char, UpdateSourcePos s Char) => ParsecT s st m Text #
Arguments
:: (Stream s m Char, UpdateSourcePos s Char) | |
=> ParsecT s st m a | Parsec to apply |
-> ParsecT 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) #
Applies a parser and returns the raw string that was parsed, along with the value produced by the parser.
fromParsecError :: Sources -> ParseError -> PandocError #
Arguments
:: (Stream s m Char, UpdateSourcePos s Char) | |
=> ParsecT s st m Char | Parsec for character to escape |
-> ParsecT s st m Char |
Parses backslash, then applies character parser.
characterReference :: (Stream s m Char, UpdateSourcePos s Char) => ParsecT s st m Text #
Parse character entity.
upperRoman :: (Stream s m Char, UpdateSourcePos s Char) => ParsecT s st m (ListNumberStyle, Int) #
Parses an uppercase roman numeral and returns (UpperRoman, number).
lowerRoman :: (Stream s m Char, UpdateSourcePos s Char) => ParsecT s st m (ListNumberStyle, Int) #
Parses a lowercase roman numeral and returns (LowerRoman, number).
decimal :: (Stream s m Char, UpdateSourcePos s Char) => ParsecT s st m (ListNumberStyle, Int) #
Parses a decimal numeral and returns (Decimal, number).
lowerAlpha :: (Stream s m Char, UpdateSourcePos s Char) => ParsecT s st m (ListNumberStyle, Int) #
Parses a lowercase letter and returns (LowerAlpha, number).
upperAlpha :: (Stream s m Char, UpdateSourcePos s Char) => ParsecT s st m (ListNumberStyle, Int) #
Parses an uppercase letter and returns (UpperAlpha, number).
anyOrderedListMarker :: (Stream s m Char, UpdateSourcePos s Char) => ParsecT s ParserState m ListAttributes #
Parses an ordered list marker and returns list attributes.
orderedListMarker :: (Stream s m Char, UpdateSourcePos s Char) => ListNumberStyle -> ListNumberDelim -> ParsecT s ParserState m Int #
Parses an ordered list marker with a given style and delimiter, returns number.
charRef :: (Stream s m Char, UpdateSourcePos s Char) => ParsecT s st m Inline #
Parses a character reference and returns a Str element.
lineBlockLines :: Monad m => ParsecT Sources st m [Text] #
Parses an RST-style line block and returns a list of strings.
Arguments
:: (Stream s m Char, UpdateSourcePos s Char, HasReaderOptions st, Monad mf) | |
=> ParsecT s st m (mf [Blocks], [Alignment], [Int]) | header parser |
-> ([Int] -> ParsecT s st m (mf [Blocks])) | row parser |
-> ParsecT s st m sep | line parser |
-> ParsecT s st m end | footer parser |
-> ParsecT s st m (mf Blocks) |
Parse a table using headerParser
, rowParser
,
lineParser
, and footerParser
.
Arguments
:: (Stream s m Char, UpdateSourcePos s Char, HasReaderOptions st, Monad mf) | |
=> TableNormalization | |
-> ParsecT s st m (mf [Blocks], [Alignment], [Int]) | header parser |
-> ([Int] -> ParsecT s st m (mf [Blocks])) | row parser |
-> ParsecT s st m sep | line parser |
-> ParsecT s st m end | footer parser |
-> ParsecT s st m (mf TableComponents) |
widthsFromIndices :: Int -> [Int] -> [Double] #
Calculate relative widths of table columns, based on indices
Arguments
:: (Monad m, Monad mf, HasLastStrPosition st, HasReaderOptions st) | |
=> ParsecT Sources st m (mf Blocks) | Block list parser |
-> ParsecT Sources st m (mf Blocks) |
Parse a grid table: starts with row of -
on top, then header
(which may be grid), then the rows, which may be grid, separated by
blank lines, and ending with a footer (dashed line followed by blank
line).
Arguments
:: (Monad m, Monad mf, HasReaderOptions st, HasLastStrPosition st) | |
=> TableNormalization | |
-> ParsecT Sources st m (mf Blocks) | Block list parser |
-> ParsecT Sources st m (mf TableComponents) |
Like
, but returns gridTableWith
TableComponents
instead of a
Table.
data TableComponents #
Collection of components making up a Table block.
Constructors
TableComponents | |
Fields
|
data TableNormalization #
Whether the table header should be normalized, i.e., whether an header row with only empty cells should be omitted.
Constructors
NoNormalization | |
NormalizeHeader |
toTableComponents :: [Alignment] -> [Double] -> [Blocks] -> [[Blocks]] -> TableComponents #
Bundles basic table components into a single value.
toTableComponents' :: TableNormalization -> [Alignment] -> [Double] -> [Blocks] -> [[Blocks]] -> TableComponents #
Bundles basic table components into a single value, performing normalizations as necessary.
readWith :: ToSources t => Parsec Sources st a -> st -> t -> Either PandocError a #
Parse a string with a given parser and state
Arguments
:: (Monad m, ToSources t) | |
=> ParsecT 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 => ParsecT Sources ParserState Identity a -> Text -> IO () #
Parse a string with parser
(for testing).
guardEnabled :: (Stream s m a, HasReaderOptions st) => Extension -> ParsecT s st m () #
Succeed only if the extension is enabled.
guardDisabled :: (Stream s m a, HasReaderOptions st) => Extension -> ParsecT s st m () #
Succeed only if the extension is disabled.
updateLastStrPos :: (Stream s m a, HasLastStrPosition st) => ParsecT s st m () #
Update the position on which the last string ended.
notAfterString :: (Stream s m a, HasLastStrPosition st) => ParsecT s st m Bool #
Whether we are right after the end of a string.
logMessage :: (Stream s m a, HasLogMessages st) => LogMessage -> ParsecT s st m () #
Add a log message.
reportLogMessages :: (PandocMonad m, HasLogMessages st) => ParsecT s st m () #
Report all the accumulated log messages, according to verbosity level.
data ParserState #
Parsing options.
Constructors
ParserState | |
Fields
|
Instances
class HasReaderOptions st where #
Minimal complete definition
Methods
extractReaderOptions :: st -> ReaderOptions #
getOption :: Stream s m t => (ReaderOptions -> b) -> ParsecT s st m b #
Instances
HasReaderOptions ParserState # | |
Defined in Text.Pandoc.Parsing.State Methods extractReaderOptions :: ParserState -> ReaderOptions # getOption :: forall s (m :: Type -> Type) t b. Stream s m t => (ReaderOptions -> b) -> ParsecT s ParserState m b # |
class HasIdentifierList st where #
Methods
extractIdentifierList :: st -> Set Text #
updateIdentifierList :: (Set Text -> Set Text) -> st -> st #
Instances
HasIdentifierList ParserState # | |
Defined in Text.Pandoc.Parsing.State Methods extractIdentifierList :: ParserState -> Set Text # updateIdentifierList :: (Set Text -> Set Text) -> ParserState -> ParserState # |
Methods
extractMacros :: st -> Map Text Macro #
updateMacros :: (Map Text Macro -> Map Text Macro) -> st -> st #
Instances
HasMacros ParserState # | |
Defined in Text.Pandoc.Parsing.State Methods extractMacros :: ParserState -> Map Text Macro # updateMacros :: (Map Text Macro -> Map Text Macro) -> ParserState -> ParserState # |
class HasLogMessages st where #
Instances
HasLogMessages ParserState # | |
Defined in Text.Pandoc.Parsing.State Methods addLogMessage :: LogMessage -> ParserState -> ParserState # getLogMessages :: ParserState -> [LogMessage] # |
class HasLastStrPosition st where #
Instances
HasLastStrPosition ParserState # | |
Defined in Text.Pandoc.Parsing.State Methods setLastStrPos :: Maybe SourcePos -> ParserState -> ParserState # getLastStrPos :: ParserState -> Maybe SourcePos # |
class HasIncludeFiles st where #
Methods
getIncludeFiles :: st -> [Text] #
addIncludeFile :: Text -> st -> st #
dropLatestIncludeFile :: st -> st #
Instances
HasIncludeFiles ParserState # | |
Defined in Text.Pandoc.Parsing.State Methods getIncludeFiles :: ParserState -> [Text] # addIncludeFile :: Text -> ParserState -> ParserState # |
data HeaderType #
Constructors
SingleHeader Char | Single line of characters underneath |
DoubleHeader Char | Lines of characters above and below |
Instances
Show HeaderType # | |
Defined in Text.Pandoc.Parsing.State Methods showsPrec :: Int -> HeaderType -> ShowS # show :: HeaderType -> String # showList :: [HeaderType] -> ShowS # | |
Eq HeaderType # | |
Defined in Text.Pandoc.Parsing.State |
data ParserContext #
Constructors
ListItemState | Used when running parser on list item contents |
NullState | Default state |
Instances
Show ParserContext # | |
Defined in Text.Pandoc.Parsing.State Methods showsPrec :: Int -> ParserContext -> ShowS # show :: ParserContext -> String # showList :: [ParserContext] -> ShowS # | |
Eq ParserContext # | |
Defined in Text.Pandoc.Parsing.State Methods (==) :: ParserContext -> ParserContext -> Bool # (/=) :: ParserContext -> ParserContext -> Bool # |
data QuoteContext #
Constructors
InSingleQuote | Used when parsing inside single quotes |
InDoubleQuote | Used when parsing inside double quotes |
NoQuote | Used when not parsing inside quotes |
Instances
Show QuoteContext # | |
Defined in Text.Pandoc.Parsing.Capabilities Methods showsPrec :: Int -> QuoteContext -> ShowS # show :: QuoteContext -> String # showList :: [QuoteContext] -> ShowS # | |
Eq QuoteContext # | |
Defined in Text.Pandoc.Parsing.Capabilities |
class HasQuoteContext st m where #
Methods
getQuoteContext :: Stream s m t => ParsecT s st m QuoteContext #
withQuoteContext :: QuoteContext -> ParsecT s st m a -> ParsecT s st m a #
Instances
Monad m => HasQuoteContext ParserState m # | |
Defined in Text.Pandoc.Parsing.State Methods getQuoteContext :: Stream s m t => ParsecT s ParserState m QuoteContext # withQuoteContext :: QuoteContext -> ParsecT s ParserState m a -> ParsecT s ParserState m a # |
type NoteTable' = Map Text (SourcePos, Future ParserState Blocks) #
type SubstTable = Map Key Inlines #
registerHeader :: (Stream s m a, HasReaderOptions st, HasLogMessages st, HasIdentifierList st) => Attr -> Inlines -> ParsecT s st m Attr #
Add header to the list of headers in state, together with its associated identifier. If the identifier is null and the auto_identifiers extension is set, generate a new unique identifier, and update the list of identifiers in state. Issue a warning if an explicit identifier is encountered that duplicates an earlier identifier (explicit or automatically generated).
smartPunctuation :: (HasReaderOptions st, HasLastStrPosition st, HasQuoteContext st m, Stream s m Char, UpdateSourcePos s Char) => ParsecT s st m Inlines -> ParsecT s st m Inlines #
Parses various ASCII punctuation, quotes, and apostrophe in a smart way, inferring their semantic meaning.
Fails unless the Ext_smart
extension has been enabled.
singleQuoteStart :: (HasLastStrPosition st, HasQuoteContext st m, Stream s m Char, UpdateSourcePos s Char) => ParsecT s st m () #
Succeeds if the parser is
- not within single quoted text;
- not directly after a word; and
- looking at an opening single quote char that's not followed by a space.
Gobbles the quote character on success.
singleQuoteEnd :: (Stream s m Char, UpdateSourcePos s Char) => ParsecT s st m () #
doubleQuoteStart :: (HasLastStrPosition st, HasQuoteContext st m, Stream s m Char, UpdateSourcePos s Char) => ParsecT s st m () #
Succeeds if the parser is
- not within a double quoted text;
- not directly after a word; and
- looking at an opening double quote char that's not followed by a space.
Gobbles the quote character on success.
doubleQuoteEnd :: (Stream s m Char, UpdateSourcePos s Char) => ParsecT s st m () #
Parses a closing quote character.
apostrophe :: (Stream s m Char, UpdateSourcePos s Char) => ParsecT s st m Inlines #
Parses an ASCII apostrophe ('
) or right single quotation mark and
returns a RIGHT SINGLE QUOtatiON MARK character.
doubleCloseQuote :: (Stream s m Char, UpdateSourcePos s Char) => ParsecT s st m Inlines #
Parses an ASCII quotation mark character and returns a RIGHT DOUBLE QUOTATION MARK.
ellipses :: (Stream s m Char, UpdateSourcePos s Char) => ParsecT s st m Inlines #
Parses three dots as HORIZONTAL ELLIPSIS.
dash :: (HasReaderOptions st, Stream s m Char, UpdateSourcePos s Char) => ParsecT s st m Inlines #
Parses two hyphens as EN DASH and three as EM DASH.
If the extension
is enabled, then two hyphens are
parsed as EM DASH, and one hyphen is parsed as EN DASH if it is
followed by a digit.Ext_old_dashes
Arguments
:: (Stream s m Char, UpdateSourcePos s Char, HasLastStrPosition st) | |
=> Bool | If True, allow expanded @{..} syntax. |
-> ParsecT s st m (Bool, Text) |
data ParsecT s u (m :: Type -> Type) a #
Instances
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 #
Remove whitespace from start and end; just like
,
but lifted into the trimInlines
Future
type.
extractIdClass :: Attr -> Attr #
Arguments
:: (PandocMonad m, HasIncludeFiles st) | |
=> ParsecT 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) |
-> ParsecT a st m b |
Re-exports from Text.Parsec
class Monad m => Stream s (m :: Type -> Type) t | s -> t where #
Instances
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 Sources m Char # | |
Monad m => Stream Text m Char | |
Defined in Text.Parsec.Prim | |
Monad m => Stream Text m Char | |
Defined in Text.Parsec.Prim | |
Monad m => Stream [tok] m tok | |
Defined in Text.Parsec.Prim |
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
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 # | |
Show SourcePos | |
Eq SourcePos | |
Ord SourcePos | |
type SourceName = String #
updatePosString :: SourcePos -> String -> 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
Show ParseError | |
Defined in Text.Parsec.Error Methods showsPrec :: Int -> ParseError -> ShowS # show :: ParseError -> String # showList :: [ParseError] -> ShowS # | |
Eq ParseError | |
Defined in Text.Parsec.Error |
errorMessages :: ParseError -> [Message] #
messageString :: Message -> String #