pandoc-3.7.0.2: Conversion between markup formats

Copyright | Copyright (C) 2006-2024 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

- Re-exports from Text.Parsec

Description

A utility library with parsers used in pandoc readers.

Synopsis

- module Text.Pandoc.Sources
- countChar :: forall s (m :: Type -> Type) st. (Stream s m Char, UpdateSourcePos s Char, Monad m) => Int -> ParsecT s st m Char -> ParsecT s st m Text
- textStr :: forall s (m :: Type -> Type) u. (Stream s m Char, UpdateSourcePos s Char) => Text -> ParsecT s u m Text
- anyLine :: forall (m :: Type -> Type) st. Monad m => ParsecT Sources st m Text
- anyLineNewline :: forall (m :: Type -> Type) st. Monad m => ParsecT Sources st m Text
- indentWith :: forall s (m :: Type -> Type) st. (Stream s m Char, UpdateSourcePos s Char, HasReaderOptions st) => Int -> ParsecT s st m Text
- manyChar :: forall s (m :: Type -> Type) t st. Stream s m t => ParsecT s st m Char -> ParsecT s st m Text
- many1Char :: forall s (m :: Type -> Type) t st. Stream s m t => ParsecT s st m Char -> ParsecT s st m Text
- manyTillChar :: forall s (m :: Type -> Type) t st a. Stream s m t => ParsecT s st m Char -> ParsecT s st m a -> ParsecT s st m Text
- many1TillChar :: forall end s (m :: Type -> Type) t st. (Show end, Stream s m t) => ParsecT s st m Char -> ParsecT s st m end -> ParsecT s st m Text
- many1Till :: forall end s (m :: Type -> Type) t st a. (Show end, Stream s m t) => ParsecT s st m a -> ParsecT s st m end -> ParsecT s st m [a]
- manyUntil :: forall s u (m :: Type -> Type) a b. ParsecT s u m a -> ParsecT s u m b -> ParsecT s u m ([a], b)
- manyUntilChar :: forall s u (m :: Type -> Type) b. ParsecT s u m Char -> ParsecT s u m b -> ParsecT s u m (Text, b)
- sepBy1' :: forall s u (m :: Type -> Type) a sep. ParsecT s u m a -> ParsecT s u m sep -> ParsecT s u m [a]
- notFollowedBy' :: forall b s (m :: Type -> Type) a st. (Show b, Stream s m a) => ParsecT s st m b -> ParsecT s st m ()
- oneOfStrings :: forall s (m :: Type -> Type) st. (Stream s m Char, UpdateSourcePos s Char) => [Text] -> ParsecT s st m Text
- oneOfStringsCI :: forall s (m :: Type -> Type) st. (Stream s m Char, UpdateSourcePos s Char) => [Text] -> ParsecT s st m Text
- spaceChar :: forall s (m :: Type -> Type) st. (Stream s m Char, UpdateSourcePos s Char) => ParsecT s st m Char
- nonspaceChar :: forall s (m :: Type -> Type) st. (Stream s m Char, UpdateSourcePos s Char) => ParsecT s st m Char
- skipSpaces :: forall s (m :: Type -> Type) st. (Stream s m Char, UpdateSourcePos s Char) => ParsecT s st m ()
- blankline :: forall s (m :: Type -> Type) st. (Stream s m Char, UpdateSourcePos s Char) => ParsecT s st m Char
- blanklines :: forall s (m :: Type -> Type) st. (Stream s m Char, UpdateSourcePos s Char) => ParsecT s st m Text
- gobbleSpaces :: forall st (m :: Type -> Type). (HasReaderOptions st, Monad m) => Int -> ParsecT Sources st m ()
- gobbleAtMostSpaces :: forall st (m :: Type -> Type). (HasReaderOptions st, Monad m) => Int -> ParsecT Sources st m Int
- enclosed :: forall end s (m :: Type -> Type) st t a. (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 :: forall s (m :: Type -> Type) st. (Stream s m Char, UpdateSourcePos s Char) => Text -> ParsecT s st m Text
- parseFromString :: forall (m :: Type -> Type) st r. Monad m => ParsecT Sources st m r -> Text -> ParsecT Sources st m r
- parseFromString' :: forall (m :: Type -> Type) u a. (Monad m, HasLastStrPosition u) => ParsecT Sources u m a -> Text -> ParsecT Sources u m a
- lineClump :: forall (m :: Type -> Type) st. Monad m => ParsecT Sources st m Text
- charsInBalanced :: forall s (m :: Type -> Type) st. (Stream s m Char, UpdateSourcePos s Char) => Char -> Char -> ParsecT s st m Text -> ParsecT s st m Text
- romanNumeral :: forall s (m :: Type -> Type) st. (Stream s m Char, UpdateSourcePos s Char) => Bool -> ParsecT s st m Int
- emailAddress :: forall s (m :: Type -> Type) st. (Stream s m Char, UpdateSourcePos s Char) => ParsecT s st m (Text, Text)
- uri :: forall s (m :: Type -> Type) st. (Stream s m Char, UpdateSourcePos s Char) => ParsecT s st m (Text, Text)
- mathInline :: forall st s (m :: Type -> Type). (HasReaderOptions st, Stream s m Char, UpdateSourcePos s Char) => ParsecT s st m Text
- mathDisplay :: forall st s (m :: Type -> Type). (HasReaderOptions st, Stream s m Char, UpdateSourcePos s Char) => ParsecT s st m Text
- withHorizDisplacement :: forall s (m :: Type -> Type) st a. (Stream s m Char, UpdateSourcePos s Char) => ParsecT s st m a -> ParsecT s st m (a, Int)
- withRaw :: forall (m :: Type -> Type) st a. Monad m => ParsecT Sources st m a -> ParsecT Sources st m (a, Text)
- fromParsecError :: Sources -> ParseError -> PandocError
- escaped :: forall s (m :: Type -> Type) st. (Stream s m Char, UpdateSourcePos s Char) => ParsecT s st m Char -> ParsecT s st m Char
- characterReference :: forall s (m :: Type -> Type) st. (Stream s m Char, UpdateSourcePos s Char) => ParsecT s st m Text
- upperRoman :: forall s (m :: Type -> Type) st. (Stream s m Char, UpdateSourcePos s Char) => ParsecT s st m (ListNumberStyle, Int)
- lowerRoman :: forall s (m :: Type -> Type) st. (Stream s m Char, UpdateSourcePos s Char) => ParsecT s st m (ListNumberStyle, Int)
- decimal :: forall s (m :: Type -> Type) st. (Stream s m Char, UpdateSourcePos s Char) => ParsecT s st m (ListNumberStyle, Int)
- lowerAlpha :: forall s (m :: Type -> Type) st. (Stream s m Char, UpdateSourcePos s Char) => ParsecT s st m (ListNumberStyle, Int)
- upperAlpha :: forall s (m :: Type -> Type) st. (Stream s m Char, UpdateSourcePos s Char) => ParsecT s st m (ListNumberStyle, Int)
- anyOrderedListMarker :: forall s (m :: Type -> Type). (Stream s m Char, UpdateSourcePos s Char) => ParsecT s ParserState m ListAttributes
- orderedListMarker :: forall s (m :: Type -> Type). (Stream s m Char, UpdateSourcePos s Char) => ListNumberStyle -> ListNumberDelim -> ParsecT s ParserState m Int
- charRef :: forall s (m :: Type -> Type) st. (Stream s m Char, UpdateSourcePos s Char) => ParsecT s st m Inline
- lineBlockLines :: forall (m :: Type -> Type) st. Monad m => ParsecT Sources st m [Text]
- tableWith :: forall s (m :: Type -> Type) st mf sep end. (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' :: forall s (m :: Type -> Type) st mf sep end. (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 :: forall (m :: Type -> Type) mf st. (Monad m, Monad mf, HasLastStrPosition st, HasReaderOptions st) => ParsecT Sources st m (mf Blocks) -> ParsecT Sources st m (mf Blocks)
- gridTableWith' :: forall (m :: Type -> Type) mf st. (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
  - = NoNormalization
  - | NormalizeHeader
- 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 :: forall s (m :: Type -> Type) a st. (Stream s m a, HasReaderOptions st) => Extension -> ParsecT s st m ()
- guardDisabled :: forall s (m :: Type -> Type) a st. (Stream s m a, HasReaderOptions st) => Extension -> ParsecT s st m ()
- updateLastStrPos :: forall s (m :: Type -> Type) a st. (Stream s m a, HasLastStrPosition st) => ParsecT s st m ()
- notAfterString :: forall s (m :: Type -> Type) a st. (Stream s m a, HasLastStrPosition st) => ParsecT s st m Bool
- logMessage :: forall s (m :: Type -> Type) a st. (Stream s m a, HasLogMessages st) => LogMessage -> ParsecT s st m ()
- reportLogMessages :: forall (m :: Type -> Type) st s. (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 :: forall s (m :: Type -> Type) t b. 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
  - = SingleHeader Char
  - | DoubleHeader Char
- data ParserContext
  - = ListItemState
  - | NullState
- data QuoteContext
  - = InSingleQuote
  - | InDoubleQuote
  - | NoQuote
- class HasQuoteContext st (m :: Type -> Type) 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 Blocks
- newtype Key = Key Text
- toKey :: Text -> Key
- registerHeader :: forall s (m :: Type -> Type) a st. (Stream s m a, HasReaderOptions st, HasLogMessages st, HasIdentifierList st) => Attr -> Inlines -> ParsecT s st m Attr
- smartPunctuation :: forall st (m :: Type -> Type) s. (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 :: forall st (m :: Type -> Type) s. (HasLastStrPosition st, HasQuoteContext st m, Stream s m Char, UpdateSourcePos s Char) => ParsecT s st m ()
- singleQuoteEnd :: forall s (m :: Type -> Type) st. (Stream s m Char, UpdateSourcePos s Char) => ParsecT s st m ()
- doubleQuoteStart :: forall st (m :: Type -> Type) s. (HasLastStrPosition st, HasQuoteContext st m, Stream s m Char, UpdateSourcePos s Char) => ParsecT s st m ()
- doubleQuoteEnd :: forall s (m :: Type -> Type) st. (Stream s m Char, UpdateSourcePos s Char) => ParsecT s st m ()
- apostrophe :: forall s (m :: Type -> Type) st. (Stream s m Char, UpdateSourcePos s Char) => ParsecT s st m Inlines
- doubleCloseQuote :: forall s (m :: Type -> Type) st. (Stream s m Char, UpdateSourcePos s Char) => ParsecT s st m Inlines
- ellipses :: forall s (m :: Type -> Type) st. (Stream s m Char, UpdateSourcePos s Char) => ParsecT s st m Inlines
- dash :: forall st s (m :: Type -> Type). (HasReaderOptions st, Stream s m Char, UpdateSourcePos s Char) => ParsecT s st m Inlines
- citeKey :: forall s (m :: Type -> Type) st. (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 :: forall s (m :: Type -> Type) t a st. Stream s m t => (t -> Text) -> (t -> SourcePos) -> (t -> Maybe a) -> ParsecT s st m a
- (<+?>) :: forall a s st (m :: Type -> Type). Monoid a => ParsecT s st m a -> ParsecT s st m a -> ParsecT s st m a
- extractIdClass :: Attr -> Attr
- insertIncludedFile :: forall (m :: Type -> Type) st a b. (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
  - uncons :: s -> m (Maybe (t, s))
- 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 u (m :: Type -> Type) a. 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 :: forall s (m :: Type -> Type) st. (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 :: forall s (m :: Type -> Type) u. (Stream s m Char, UpdateSourcePos s Char) => Text -> ParsecT s u m Text Source #

Like `string`, but uses `Text`.

anyLine :: forall (m :: Type -> Type) st. Monad m => ParsecT Sources st m Text Source #

Parse any line of text, returning the contents without the final newline.

anyLineNewline :: forall (m :: Type -> Type) st. Monad m => ParsecT Sources st m Text Source #

Parse any line, include the final newline in the output

indentWith :: forall s (m :: Type -> Type) st. (Stream s m Char, UpdateSourcePos s Char, HasReaderOptions st) => Int -> ParsecT s st m Text Source #

Parse indent by specified number of spaces (or equiv. tabs)

manyChar :: forall s (m :: Type -> Type) t st. Stream s m t => ParsecT s st m Char -> ParsecT s st m Text Source #

Like `many`, but packs its result.

many1Char :: forall s (m :: Type -> Type) t st. Stream s m t => ParsecT s st m Char -> ParsecT s st m Text Source #

Like `many1`, but packs its result.

manyTillChar :: forall s (m :: Type -> Type) t st a. Stream s m t => ParsecT s st m Char -> ParsecT s st m a -> ParsecT s st m Text Source #

Like `manyTill`, but packs its result.

many1TillChar :: forall end s (m :: Type -> Type) t st. (Show end, Stream s m t) => ParsecT s st m Char -> ParsecT s st m end -> ParsecT s st m Text Source #

Like `many1Till`, but packs its result

many1Till :: forall end s (m :: Type -> Type) t st a. (Show end, Stream s m t) => ParsecT s st m a -> ParsecT s st m end -> ParsecT s st m [a] Source #

Like `manyTill`, but reads at least one item.

manyUntil :: forall s u (m :: Type -> Type) a b. ParsecT s u m a -> ParsecT s u m b -> ParsecT s u m ([a], b) Source #

Like `manyTill`, but also returns the result of end parser.

manyUntilChar :: forall s u (m :: Type -> Type) b. ParsecT s u m Char -> ParsecT s u m b -> ParsecT s u m (Text, b) Source #

Like `manyUntil`, but also packs its result.

sepBy1' :: forall s u (m :: Type -> Type) a sep. 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' :: forall b s (m :: Type -> Type) a st. (Show b, Stream s m a) => ParsecT s st m b -> ParsecT 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 :: forall s (m :: Type -> Type) st. (Stream s m Char, UpdateSourcePos s Char) => [Text] -> ParsecT 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 :: forall s (m :: Type -> Type) st. (Stream s m Char, UpdateSourcePos s Char) => [Text] -> ParsecT s st m Text Source #

Parses one of a list of strings (tried in order), case insensitive.

spaceChar :: forall s (m :: Type -> Type) st. (Stream s m Char, UpdateSourcePos s Char) => ParsecT s st m Char Source #

Parses a space or tab.

nonspaceChar :: forall s (m :: Type -> Type) st. (Stream s m Char, UpdateSourcePos s Char) => ParsecT s st m Char Source #

Parses a nonspace, nonnewline character.

skipSpaces :: forall s (m :: Type -> Type) st. (Stream s m Char, UpdateSourcePos s Char) => ParsecT s st m () Source #

Skips zero or more spaces or tabs.

blankline :: forall s (m :: Type -> Type) st. (Stream s m Char, UpdateSourcePos s Char) => ParsecT s st m Char Source #

Skips zero or more spaces or tabs, then reads a newline.

blanklines :: forall s (m :: Type -> Type) st. (Stream s m Char, UpdateSourcePos s Char) => ParsecT s st m Text Source #

Parses one or more blank lines and returns a string of newlines.

gobbleSpaces :: forall st (m :: Type -> Type). (HasReaderOptions st, Monad m) => Int -> ParsecT 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 :: forall st (m :: Type -> Type). (HasReaderOptions st, Monad m) => Int -> ParsecT 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.

enclosed Source #

Arguments

:: forall end s (m :: Type -> Type) st t a. (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 :: forall s (m :: Type -> Type) st. (Stream s m Char, UpdateSourcePos s Char) => Text -> ParsecT s st m Text Source #

Parse string, case insensitive.

parseFromString :: forall (m :: Type -> Type) st r. Monad m => ParsecT Sources st m r -> Text -> ParsecT Sources st m r Source #

Parse contents of `str` using `parser` and return result.

parseFromString' :: forall (m :: Type -> Type) u a. (Monad m, HasLastStrPosition u) => ParsecT Sources u m a -> Text -> ParsecT Sources u m a Source #

Like `parseFromString` but specialized for `ParserState`. This resets `stateLastStrPos`, which is almost always what we want.

lineClump :: forall (m :: Type -> Type) st. Monad m => ParsecT Sources st m Text Source #

Parse raw line block up to and including blank lines.

charsInBalanced :: forall s (m :: Type -> Type) st. (Stream s m Char, UpdateSourcePos s Char) => Char -> Char -> ParsecT s st m Text -> ParsecT 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 '(' ')' (Data.Text.singleton $ anyChar)` will parse "(hello (there))" and return "hello (there)".

romanNumeral Source #

Arguments

:: forall s (m :: Type -> Type) st. (Stream s m Char, UpdateSourcePos s Char) |
=> Bool | Uppercase if true
-> ParsecT s st m Int |

Parses a roman numeral (uppercase or lowercase), returns number.

emailAddress :: forall s (m :: Type -> Type) st. (Stream s m Char, UpdateSourcePos s Char) => ParsecT s st m (Text, Text) Source #

Parses an email address; returns original and corresponding escaped mailto: URI.

uri :: forall s (m :: Type -> Type) st. (Stream s m Char, UpdateSourcePos s Char) => ParsecT s st m (Text, Text) Source #

Parses a URI. Returns pair of original and URI-escaped version.

mathInline :: forall st s (m :: Type -> Type). (HasReaderOptions st, Stream s m Char, UpdateSourcePos s Char) => ParsecT s st m Text Source #

mathDisplay :: forall st s (m :: Type -> Type). (HasReaderOptions st, Stream s m Char, UpdateSourcePos s Char) => ParsecT s st m Text Source #

withHorizDisplacement Source #

Arguments

:: forall s (m :: Type -> Type) st a. (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 :: forall (m :: Type -> Type) st a. 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.

fromParsecError :: Sources -> ParseError -> PandocError Source #

escaped Source #

Arguments

:: forall s (m :: Type -> Type) st. (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 :: forall s (m :: Type -> Type) st. (Stream s m Char, UpdateSourcePos s Char) => ParsecT s st m Text Source #

Parse character entity.

upperRoman :: forall s (m :: Type -> Type) st. (Stream s m Char, UpdateSourcePos s Char) => ParsecT s st m (ListNumberStyle, Int) Source #

Parses an uppercase roman numeral and returns (UpperRoman, number).

lowerRoman :: forall s (m :: Type -> Type) st. (Stream s m Char, UpdateSourcePos s Char) => ParsecT s st m (ListNumberStyle, Int) Source #

Parses a lowercase roman numeral and returns (LowerRoman, number).

decimal :: forall s (m :: Type -> Type) st. (Stream s m Char, UpdateSourcePos s Char) => ParsecT s st m (ListNumberStyle, Int) Source #

Parses a decimal numeral and returns (Decimal, number).

lowerAlpha :: forall s (m :: Type -> Type) st. (Stream s m Char, UpdateSourcePos s Char) => ParsecT s st m (ListNumberStyle, Int) Source #

Parses a lowercase letter and returns (LowerAlpha, number).

upperAlpha :: forall s (m :: Type -> Type) st. (Stream s m Char, UpdateSourcePos s Char) => ParsecT s st m (ListNumberStyle, Int) Source #

Parses an uppercase letter and returns (UpperAlpha, number).

anyOrderedListMarker :: forall s (m :: Type -> Type). (Stream s m Char, UpdateSourcePos s Char) => ParsecT s ParserState m ListAttributes Source #

Parses an ordered list marker and returns list attributes.

orderedListMarker :: forall s (m :: Type -> Type). (Stream s m Char, UpdateSourcePos s Char) => ListNumberStyle -> ListNumberDelim -> ParsecT s ParserState m Int Source #

Parses an ordered list marker with a given style and delimiter, returns number.

charRef :: forall s (m :: Type -> Type) st. (Stream s m Char, UpdateSourcePos s Char) => ParsecT s st m Inline Source #

Parses a character reference and returns a Str element.

lineBlockLines :: forall (m :: Type -> Type) st. Monad m => ParsecT Sources st m [Text] Source #

Parses an RST-style line block and returns a list of strings.

tableWith Source #

Arguments

:: forall s (m :: Type -> Type) st mf sep end. (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`.

tableWith' Source #

Arguments

:: forall s (m :: Type -> Type) st mf sep end. (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] Source #

Calculate relative widths of table columns, based on indices

gridTableWith Source #

Arguments

:: forall (m :: Type -> Type) mf st. (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).

gridTableWith' Source #

Arguments

:: forall (m :: Type -> Type) mf st. (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 ``gridTableWith``, but returns `TableComponents` instead of a Table.

data TableComponents Source #

Collection of components making up a Table block.

Constructors

TableComponents |

Fields

- tableAttr :: Attr
- tableCaption :: Caption
- tableColSpecs :: [ColSpec]
- tableHead :: TableHead
- tableBodies :: [TableBody]
- tableFoot :: TableFoot

data TableNormalization Source #

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 Source #

Bundles basic table components into a single value.

toTableComponents' :: TableNormalization -> [Alignment] -> [Double] -> [Blocks] -> [[Blocks]] -> TableComponents Source #

Bundles basic table components into a single value, performing normalizations as necessary.

readWith :: ToSources t => Parsec Sources st a -> st -> t -> Either PandocError a Source #

Parse a string with a given parser and state

readWithM Source #

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 () Source #

Parse a string with `parser` (for testing).

guardEnabled :: forall s (m :: Type -> Type) a st. (Stream s m a, HasReaderOptions st) => Extension -> ParsecT s st m () Source #

Succeed only if the extension is enabled.

guardDisabled :: forall s (m :: Type -> Type) a st. (Stream s m a, HasReaderOptions st) => Extension -> ParsecT s st m () Source #

Succeed only if the extension is disabled.

updateLastStrPos :: forall s (m :: Type -> Type) a st. (Stream s m a, HasLastStrPosition st) => ParsecT s st m () Source #

Update the position on which the last string ended.

notAfterString :: forall s (m :: Type -> Type) a st. (Stream s m a, HasLastStrPosition st) => ParsecT s st m Bool Source #

Whether we are right after the end of a string.

logMessage :: forall s (m :: Type -> Type) a st. (Stream s m a, HasLogMessages st) => LogMessage -> ParsecT s st m () Source #

Add a log message.

reportLogMessages :: forall (m :: Type -> Type) st s. (PandocMonad m, HasLogMessages st) => ParsecT s st m () Source #

Report all the accumulated log messages, according to verbosity level.

data ParserState Source #

Parsing options.

Constructors

ParserState |

Fields

- stateOptions :: ReaderOptions

  User options

- stateParserContext :: ParserContext

  Inside list?

- stateQuoteContext :: QuoteContext

  Inside quoted environment?

- stateAllowLinks :: Bool

  Allow parsing of links

- stateAllowLineBreaks :: Bool

  Allow parsing of line breaks

- stateLastStrPos :: Maybe SourcePos

  Position after last str parsed

- stateKeys :: KeyTable

  List of reference keys

- stateHeaderKeys :: KeyTable

  List of implicit header ref keys

- stateSubstitutions :: SubstTable

  List of substitution references

- stateNotes :: NoteTable

  List of notes (raw bodies)

- stateNotes' :: NoteTable'

  List of notes (parsed bodies)

- stateNoteRefs :: Set Text

  List of note references used

- stateInNote :: Bool

  True if parsing note contents

- stateNoteNumber :: Int

  Last note number for citations

- stateMeta :: Meta

  Document metadata

- stateMeta' :: Future ParserState Meta

  Document metadata

- stateCitations :: Map Text Text

  RST-style citations

- stateHeaderTable :: [HeaderType]

  Ordered list of header types used

- stateIdentifiers :: Set Text

  Header identifiers used

- stateNextExample :: Int

  Number of next example

- stateExamples :: Map Text Int

  Map from example labels to numbers

- stateMacros :: Map Text Macro

  Table of macros defined so far

- stateRstDefaultRole :: Text

  Current rST default interpreted text role

- stateRstHighlight :: Maybe Text

  Current rST literal block language

- stateRstCustomRoles :: Map Text (Text, Maybe Text, Attr)

  Current rST cust text roles; Triple represents:) Base role 2) Optional format (only for :raw: roles) 3) Addition classes (rest of Attr is unused)).

- stateCaption :: Maybe Inlines

  Caption in current environment

- stateInHtmlBlock :: Maybe Text

  Tag type of HTML block being parsed

- stateFencedDivLevel :: Int

  Depth of fenced div

- stateContainers :: [Text]

  parent include files

- stateLogMessages :: [LogMessage]

  log messages

- stateMarkdownAttribute :: Bool

  True if in markdown=1 context

#### Instances

Instances details

Default ParserState Source # |
Instance details Defined in Text.Pandoc.Parsing.State Methods def :: ParserState Source #
HasIdentifierList ParserState Source # |
Instance details Defined in Text.Pandoc.Parsing.State Methods extractIdentifierList :: ParserState -> Set Text Source # updateIdentifierList :: (Set Text -> Set Text) -> ParserState -> ParserState Source #
HasIncludeFiles ParserState Source # |
Instance details Defined in Text.Pandoc.Parsing.State Methods getIncludeFiles :: ParserState -> [Text] Source # addIncludeFile :: Text -> ParserState -> ParserState Source # dropLatestIncludeFile :: ParserState -> ParserState Source #
HasLastStrPosition ParserState Source # |
Instance details Defined in Text.Pandoc.Parsing.State Methods setLastStrPos :: Maybe SourcePos -> ParserState -> ParserState Source # getLastStrPos :: ParserState -> Maybe SourcePos Source #
HasLogMessages ParserState Source # |
Instance details Defined in Text.Pandoc.Parsing.State Methods addLogMessage :: LogMessage -> ParserState -> ParserState Source # getLogMessages :: ParserState -> [LogMessage] Source #
HasMacros ParserState Source # |
Instance details Defined in Text.Pandoc.Parsing.State Methods extractMacros :: ParserState -> Map Text Macro Source # updateMacros :: (Map Text Macro -> Map Text Macro) -> ParserState -> ParserState Source #
HasReaderOptions ParserState Source # |
Instance details Defined in Text.Pandoc.Parsing.State Methods extractReaderOptions :: ParserState -> ReaderOptions Source # getOption :: forall s (m :: Type -> Type) t b. Stream s m t => (ReaderOptions -> b) -> ParsecT s ParserState m b Source #
HasMeta ParserState Source # |
Instance details Defined in Text.Pandoc.Parsing.State Methods setMeta :: ToMetaValue b => Text -> b -> ParserState -> ParserState Source # deleteMeta :: Text -> ParserState -> ParserState Source #
Monad m => HasQuoteContext ParserState m Source # |
Instance details Defined in Text.Pandoc.Parsing.State 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 #

class HasReaderOptions st where Source #

Minimal complete definition

extractReaderOptions

Methods

extractReaderOptions :: st -> ReaderOptions Source #

getOption :: forall s (m :: Type -> Type) t b. Stream s m t => (ReaderOptions -> b) -> ParsecT s st m b Source #

#### Instances

Instances details

HasReaderOptions ParserState Source # |
Instance details Defined in Text.Pandoc.Parsing.State Methods extractReaderOptions :: ParserState -> ReaderOptions Source # getOption :: forall s (m :: Type -> Type) t b. Stream s m t => (ReaderOptions -> b) -> ParsecT 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

Instances details

HasIdentifierList ParserState Source # |
Instance details Defined in Text.Pandoc.Parsing.State 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

Instances details

HasMacros ParserState Source # |
Instance details Defined in Text.Pandoc.Parsing.State 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

Instances details

HasLogMessages ParserState Source # |
Instance details Defined in Text.Pandoc.Parsing.State 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

Instances details

HasLastStrPosition ParserState Source # |
Instance details Defined in Text.Pandoc.Parsing.State 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

Instances details

HasIncludeFiles ParserState Source # |
Instance details Defined in Text.Pandoc.Parsing.State Methods getIncludeFiles :: ParserState -> [Text] Source # addIncludeFile :: Text -> ParserState -> ParserState Source # dropLatestIncludeFile :: ParserState -> ParserState Source #

defaultParserState :: ParserState Source #

data HeaderType Source #

Constructors

SingleHeader Char | Single line of characters underneath
DoubleHeader Char | Lines of characters above and below

#### Instances

Instances details

Show HeaderType Source # |
Instance details Defined in Text.Pandoc.Parsing.State Methods showsPrec :: Int -> HeaderType -> ShowS Source # show :: HeaderType -> String Source # showList :: [HeaderType] -> ShowS Source #
Eq HeaderType Source # |
Instance details Defined in Text.Pandoc.Parsing.State Methods (==) :: HeaderType -> HeaderType -> Bool Source # (/=) :: HeaderType -> HeaderType -> Bool Source #

data ParserContext Source #

Constructors

ListItemState | Used when running parser on list item contents
NullState | Default state

#### Instances

Instances details

Show ParserContext Source # |
Instance details Defined in Text.Pandoc.Parsing.State Methods showsPrec :: Int -> ParserContext -> ShowS Source # show :: ParserContext -> String Source # showList :: [ParserContext] -> ShowS Source #
Eq ParserContext Source # |
Instance details Defined in Text.Pandoc.Parsing.State Methods (==) :: ParserContext -> ParserContext -> Bool Source # (/=) :: ParserContext -> ParserContext -> Bool Source #

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

Instances details

Show QuoteContext Source # |
Instance details Defined in Text.Pandoc.Parsing.Capabilities Methods showsPrec :: Int -> QuoteContext -> ShowS Source # show :: QuoteContext -> String Source # showList :: [QuoteContext] -> ShowS Source #
Eq QuoteContext Source # |
Instance details Defined in Text.Pandoc.Parsing.Capabilities Methods (==) :: QuoteContext -> QuoteContext -> Bool Source # (/=) :: QuoteContext -> QuoteContext -> Bool Source #

class HasQuoteContext st (m :: Type -> Type) 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

Instances details

Monad m => HasQuoteContext ParserState m Source # |
Instance details Defined in Text.Pandoc.Parsing.State 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 = [(Text, Text)] Source #

type NoteTable' = Map Text (SourcePos, Future ParserState Blocks) Source #

type KeyTable = Map Key (Target, Attr) Source #

type SubstTable = Map Key Blocks Source #

newtype Key Source #

Constructors

Key Text |

#### Instances

Instances details

Read Key Source # |
Instance details Defined in Text.Pandoc.Parsing.State Methods readsPrec :: Int -> ReadS Key Source # readList :: ReadS [Key] Source # readPrec :: ReadPrec Key Source # readListPrec :: ReadPrec [Key] Source #
Show Key Source # |
Instance details Defined in Text.Pandoc.Parsing.State Methods showsPrec :: Int -> Key -> ShowS Source # show :: Key -> String Source # showList :: [Key] -> ShowS Source #
Eq Key Source # |
Instance details Defined in Text.Pandoc.Parsing.State Methods (==) :: Key -> Key -> Bool Source # (/=) :: Key -> Key -> Bool Source #
Ord Key Source # |
Instance details Defined in Text.Pandoc.Parsing.State Methods compare :: Key -> Key -> Ordering Source # (<) :: Key -> Key -> Bool Source # (<=) :: Key -> Key -> Bool Source # (>) :: Key -> Key -> Bool Source # (>=) :: Key -> Key -> Bool Source # max :: Key -> Key -> Key Source # min :: Key -> Key -> Key Source #

toKey :: Text -> Key Source #

registerHeader :: forall s (m :: Type -> Type) a st. (Stream s m a, HasReaderOptions st, HasLogMessages st, HasIdentifierList st) => Attr -> Inlines -> ParsecT s st m Attr Source #

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 :: forall st (m :: Type -> Type) s. (HasReaderOptions st, HasLastStrPosition st, HasQuoteContext st m, Stream s m Char, UpdateSourcePos s Char) => ParsecT s st m Inlines -> ParsecT s st m Inlines Source #

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 :: forall st (m :: Type -> Type) s. (HasLastStrPosition st, HasQuoteContext st m, Stream s m Char, UpdateSourcePos s Char) => ParsecT s st m () Source #

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 :: forall s (m :: Type -> Type) st. (Stream s m Char, UpdateSourcePos s Char) => ParsecT s st m () Source #

doubleQuoteStart :: forall st (m :: Type -> Type) s. (HasLastStrPosition st, HasQuoteContext st m, Stream s m Char, UpdateSourcePos s Char) => ParsecT s st m () Source #

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 :: forall s (m :: Type -> Type) st. (Stream s m Char, UpdateSourcePos s Char) => ParsecT s st m () Source #

Parses a closing quote character.

apostrophe :: forall s (m :: Type -> Type) st. (Stream s m Char, UpdateSourcePos s Char) => ParsecT s st m Inlines Source #

Parses an ASCII apostrophe (`'`) or right single quotation mark and returns a RIGHT SINGLE QUOtatiON MARK character.

doubleCloseQuote :: forall s (m :: Type -> Type) st. (Stream s m Char, UpdateSourcePos s Char) => ParsecT s st m Inlines Source #

Parses an ASCII quotation mark character and returns a RIGHT DOUBLE QUOTATION MARK.

ellipses :: forall s (m :: Type -> Type) st. (Stream s m Char, UpdateSourcePos s Char) => ParsecT s st m Inlines Source #

Parses three dots as HORIZONTAL ELLIPSIS.

dash :: forall st s (m :: Type -> Type). (HasReaderOptions st, Stream s m Char, UpdateSourcePos s Char) => ParsecT s st m Inlines Source #

Parses two hyphens as EN DASH and three as EM DASH.

If the extension ``Ext_old_dashes`` 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.

citeKey Source #

Arguments

:: forall s (m :: Type -> Type) st. (Stream s m Char, UpdateSourcePos s Char, HasLastStrPosition st) |
=> Bool | If True, allow expanded @{..} syntax.
-> ParsecT s st m (Bool, Text) |

type Parsec s u = ParsecT s u Identity Source #

data ParsecT s u (m :: Type -> Type) a Source #

ParserT monad transformer and Parser type

`ParsecT s u m a` is a parser with stream type `s`, user state type `u`, underlying monad `m` and return type `a`. Parsec is strict in the user state. If this is undesirable, simply use a data type like `data Box a = Box a` and the state type `Box YourStateType` to add a level of indirection.

#### Instances

Instances details

MonadError e m => MonadError e (ParsecT s u m) |
Instance details Defined in Text.Parsec.Prim Methods throwError :: e -> ParsecT s u m a Source # catchError :: ParsecT s u m a -> (e -> ParsecT s u m a) -> ParsecT s u m a Source #
MonadReader r m => MonadReader r (ParsecT s u m) |
Instance details Defined in Text.Parsec.Prim Methods ask :: ParsecT s u m r Source # local :: (r -> r) -> ParsecT s u m a -> ParsecT s u m a Source # reader :: (r -> a) -> ParsecT s u m a Source #
MonadState s m => MonadState s (ParsecT s' u m) |
Instance details Defined in Text.Parsec.Prim Methods get :: ParsecT s' u m s Source # put :: s -> ParsecT s' u m () Source # state :: (s -> (a, s)) -> ParsecT s' u m a Source #
MonadTrans (ParsecT s u) |
Instance details Defined in Text.Parsec.Prim Methods lift :: Monad m => m a -> ParsecT s u m a Source #
MonadIO m => MonadIO (ParsecT s u m) |
Instance details Defined in Text.Parsec.Prim Methods liftIO :: IO a -> ParsecT s u m a Source #
Alternative (ParsecT s u m) |
Instance details Defined in Text.Parsec.Prim Methods empty :: ParsecT s u m a Source # (<|>) :: ParsecT s u m a -> ParsecT s u m a -> ParsecT s u m a Source # some :: ParsecT s u m a -> ParsecT s u m [a] Source # many :: ParsecT s u m a -> ParsecT s u m [a] Source #
Applicative (ParsecT s u m) |

Instance details

Defined in Text.Parsec.Prim

Methods

pure :: a -> ParsecT s u m a Source #

(<*>) :: ParsecT s u m (a -> b) -> ParsecT s u m a -> ParsecT s u m b Source #

liftA2 :: (a -> b -> c) -> ParsecT s u m a -> ParsecT s u m b -> ParsecT s u m c Source #

(*>) :: ParsecT s u m a -> ParsecT s u m b -> ParsecT s u m b Source #

(<*) :: ParsecT s u m a -> ParsecT s u m b -> ParsecT s u m a Source #

Functor (ParsecT s u m) |
Instance details Defined in Text.Parsec.Prim Methods fmap :: (a -> b) -> ParsecT s u m a -> ParsecT s u m b Source # (<$) :: a -> ParsecT s u m b -> ParsecT s u m a Source #
Monad (ParsecT s u m) |
Instance details Defined in Text.Parsec.Prim Methods (>>=) :: ParsecT s u m a -> (a -> ParsecT s u m b) -> ParsecT s u m b Source # (>>) :: ParsecT s u m a -> ParsecT s u m b -> ParsecT s u m b Source # return :: a -> ParsecT s u m a Source #
MonadPlus (ParsecT s u m) |
Instance details Defined in Text.Parsec.Prim Methods mzero :: ParsecT s u m a Source # mplus :: ParsecT s u m a -> ParsecT s u m a -> ParsecT s u m a Source #
MonadFail (ParsecT s u m) | Since: parsec-3.1.12.0
Instance details Defined in Text.Parsec.Prim Methods fail :: String -> ParsecT s u m a Source #
MonadCont m => MonadCont (ParsecT s u m) |
Instance details Defined in Text.Parsec.Prim Methods callCC :: ((a -> ParsecT s u m b) -> ParsecT s u m a) -> ParsecT s u m a Source #
PandocMonad m => PandocMonad (ParsecT s st m) Source # |

Instance details

Defined in Text.Pandoc.Class.PandocMonad

Methods

lookupEnv :: Text -> ParsecT s st m (Maybe Text) Source #

getCurrentTime :: ParsecT s st m UTCTime Source #

getCurrentTimeZone :: ParsecT s st m TimeZone Source #

newStdGen :: ParsecT s st m StdGen Source #

newUniqueHash :: ParsecT s st m Int Source #

openURL :: Text -> ParsecT s st m (ByteString, Maybe MimeType) Source #

readFileLazy :: FilePath -> ParsecT s st m ByteString Source #

readFileStrict :: FilePath -> ParsecT s st m ByteString Source #

readStdinStrict :: ParsecT s st m ByteString Source #

glob :: String -> ParsecT s st m [FilePath] Source #

fileExists :: FilePath -> ParsecT s st m Bool Source #

getDataFileName :: FilePath -> ParsecT s st m FilePath Source #

getModificationTime :: FilePath -> ParsecT s st m UTCTime Source #

getCommonState :: ParsecT s st m CommonState Source #

putCommonState :: CommonState -> ParsecT s st m () Source #

getsCommonState :: (CommonState -> a) -> ParsecT s st m a Source #

modifyCommonState :: (CommonState -> CommonState) -> ParsecT s st m () Source #

logOutput :: LogMessage -> ParsecT s st m () Source #

trace :: Text -> ParsecT s st m () Source #

(Monoid a, Semigroup (ParsecT s u m a)) => Monoid (ParsecT s u m a) | The `Monoid` instance for `ParsecT` is used for the same purposes as the `Semigroup` instance. Since: parsec-3.1.12
Instance details Defined in Text.Parsec.Prim Methods mempty :: ParsecT s u m a Source # mappend :: ParsecT s u m a -> ParsecT s u m a -> ParsecT s u m a Source # mconcat :: [ParsecT s u m a] -> ParsecT s u m a Source #

Semigroup a => Semigroup (ParsecT s u m a)

The `Semigroup` instance for `ParsecT` is used to append the result of several parsers, for example:

    (many $ char a) <> (many $ char b)

The above will parse a string like `"aabbb"` and return a successful parse result `"aabbb"`. Compare against the below which will produce a result of `"bbb"` for the same input:

    (many $ char a) >> (many $ char b)
    (many $ char a) *> (many $ char b)

Since: parsec-3.1.12

Instance details Defined in Text.Parsec.Prim Methods (<>) :: ParsecT s u m a -> ParsecT s u m a -> ParsecT s u m a Source # sconcat :: NonEmpty (ParsecT s u m a) -> ParsecT s u m a Source # stimes :: Integral b => b -> ParsecT s u m a -> ParsecT s u m a Source #

newtype Future s a Source #

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

- runDelayed :: Reader s a

#### Instances

Instances details

Applicative (Future s) Source # |
Instance details Defined in Text.Pandoc.Parsing.Future Methods pure :: a -> Future s a Source # (<*>) :: Future s (a -> b) -> Future s a -> Future s b Source # liftA2 :: (a -> b -> c) -> Future s a -> Future s b -> Future s c Source # (*>) :: Future s a -> Future s b -> Future s b Source # (<*) :: Future s a -> Future s b -> Future s a Source #
Functor (Future s) Source # |
Instance details Defined in Text.Pandoc.Parsing.Future Methods fmap :: (a -> b) -> Future s a -> Future s b Source # (<$) :: a -> Future s b -> Future s a Source #
Monad (Future s) Source # |
Instance details Defined in Text.Pandoc.Parsing.Future Methods (>>=) :: Future s a -> (a -> Future s b) -> Future s b Source # (>>) :: Future s a -> Future s b -> Future s b Source # return :: a -> Future s a Source #
(Semigroup a, Monoid a) => Monoid (Future s a) Source # |
Instance details Defined in Text.Pandoc.Parsing.Future Methods mempty :: Future s a Source # mappend :: Future s a -> Future s a -> Future s a Source # mconcat :: [Future s a] -> Future s a Source #
Semigroup a => Semigroup (Future s a) Source # |
Instance details Defined in Text.Pandoc.Parsing.Future Methods (<>) :: Future s a -> Future s a -> Future s a Source # sconcat :: NonEmpty (Future s a) -> Future s a Source # stimes :: Integral b => b -> Future s a -> Future s a Source #

runF :: Future s a -> s -> a Source #

Run a delayed action with the given state.

askF :: Future s s Source #

asksF :: (s -> a) -> Future s a Source #

returnF :: Monad m => a -> m (Future s a) Source #

trimInlinesF :: Future s Inlines -> Future s Inlines Source #

Remove whitespace from start and end; just like ``trimInlines``, but lifted into the `Future` type.

token :: forall s (m :: Type -> Type) t a st. Stream s m t => (t -> Text) -> (t -> SourcePos) -> (t -> Maybe a) -> ParsecT s st m a Source #

(<+?>) :: forall a s st (m :: Type -> Type). Monoid a => ParsecT s st m a -> ParsecT s st m a -> ParsecT s st m a infixr 5 Source #

extractIdClass :: Attr -> Attr Source #

insertIncludedFile Source #

Arguments

:: forall (m :: Type -> Type) st a b. (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 Source #

An instance of `Stream` has stream type `s`, underlying monad `m` and token type `t` determined by the stream

Some rough guidelines for a "correct" instance of Stream:

- unfoldM uncons gives the [t] corresponding to the stream
- A `Stream` instance is responsible for maintaining the "position within the stream" in the stream state `s`. This is trivial unless you are using the monad in a non-trivial way.

Methods

uncons :: s -> m (Maybe (t, s)) Source #

#### Instances

Instances details

Monad m => Stream ByteString m Char |
Instance details Defined in Text.Parsec.Prim Methods uncons :: ByteString -> m (Maybe (Char, ByteString)) Source #
Monad m => Stream ByteString m Char |
Instance details Defined in Text.Parsec.Prim Methods uncons :: ByteString -> m (Maybe (Char, ByteString)) Source #
Monad m => Stream Sources m Char Source # |
Instance details Defined in Text.Pandoc.Sources Methods uncons :: Sources -> m (Maybe (Char, Sources)) Source #
Monad m => Stream Text m Char |
Instance details Defined in Text.Parsec.Prim Methods uncons :: Text -> m (Maybe (Char, Text)) Source #
Monad m => Stream Text m Char |
Instance details Defined in Text.Parsec.Prim Methods uncons :: Text -> m (Maybe (Char, Text)) Source #
Monad m => Stream [tok] m tok |
Instance details Defined in Text.Parsec.Prim Methods uncons :: [tok] -> m (Maybe (tok, [tok])) Source #

runParser :: Stream s Identity t => Parsec s u a -> u -> SourceName -> s -> Either ParseError a Source #

The most general way to run a parser over the Identity monad. `runParser p state filePath input` runs parser `p` on the input list of tokens `input`, obtained from source `filePath` with the initial user state `st`. The `filePath` is only used in error messages and may be the empty string. Returns either a `ParseError` (`Left`) or a value of type `a` (`Right`).

     parseFromFile p fname
       = do{ input <- readFile fname
           ; return (runParser p () fname input)
           }

runParserT :: Stream s m t => ParsecT s u m a -> u -> SourceName -> s -> m (Either ParseError a) Source #

The most general way to run a parser. `runParserT p state filePath input` runs parser `p` on the input list of tokens `input`, obtained from source `filePath` with the initial user state `st`. The `filePath` is only used in error messages and may be the empty string. Returns a computation in the underlying monad `m` that return either a `ParseError` (`Left`) or a value of type `a` (`Right`).

parse :: Stream s Identity t => Parsec s () a -> SourceName -> s -> Either ParseError a Source #

`parse p filePath input` runs a parser `p` over Identity without user state. The `filePath` is only used in error messages and may be the empty string. Returns either a `ParseError` (`Left`) or a value of type `a` (`Right`).

     main    = case (parse numbers "" "11, 2, 43") of
                Left err  -> print err
                Right xs  -> print (sum xs)

     numbers = commaSep integer

tokenPrim Source #

Arguments

:: forall s (m :: Type -> Type) t a u. Stream s m t |
=> (t -> String) | Token pretty-printing function.
-> (SourcePos -> t -> s -> SourcePos) | Next position calculating function.
-> (t -> Maybe a) | Matching function for the token to parse.
-> ParsecT s u m a |

The parser `tokenPrim showTok nextPos testTok` accepts a token `t` with result `x` when the function `testTok t` returns ``Just` x`. The token can be shown using `showTok t`. The position of the next token should be returned when `nextPos` is called with the current source position `pos`, the current token `t` and the rest of the tokens `toks`, `nextPos pos t toks`.

This is the most primitive combinator for accepting tokens. For example, the `char` parser could be implemented as:

     char c
       = tokenPrim showChar nextPos testChar
       where
         showChar x        = "'" ++ x ++ "'"
         testChar x        = if x == c then Just x else Nothing
         nextPos pos x xs  = updatePosChar pos x

anyToken :: forall s (m :: Type -> Type) t u. (Stream s m t, Show t) => ParsecT s u m t Source #

The parser `anyToken` accepts any kind of token. It is for example used to implement `eof`. Returns the accepted token.

getInput :: forall (m :: Type -> Type) s u. Monad m => ParsecT s u m s Source #

Returns the current input

setInput :: forall (m :: Type -> Type) s u. Monad m => s -> ParsecT s u m () Source #

`setInput input` continues parsing with `input`. The `getInput` and `setInput` functions can for example be used to deal with #include files.

unexpected :: forall s (m :: Type -> Type) t u a. Stream s m t => String -> ParsecT s u m a Source #

The parser `unexpected msg` always fails with an unexpected error message `msg` without consuming any input.

The parsers `fail`, (`<?>`) and `unexpected` are the three parsers used to generate error messages. Of these, only (`<?>`) is commonly used. For an example of the use of `unexpected`, see the definition of `notFollowedBy`.

skipMany :: forall s u (m :: Type -> Type) a. ParsecT s u m a -> ParsecT s u m () Source #

`skipMany p` applies the parser `p` zero or more times, skipping its result.

     spaces  = skipMany space

skipMany1 :: forall s (m :: Type -> Type) t u a. Stream s m t => ParsecT s u m a -> ParsecT s u m () Source #

`skipMany1 p` applies the parser `p` one or more times, skipping its result.

count :: forall s (m :: Type -> Type) t u a. Stream s m t => Int -> ParsecT s u m a -> ParsecT s u m [a] Source #

`count n p` parses `n` occurrences of `p`. If `n` is smaller or equal to zero, the parser equals to `return []`. Returns a list of `n` values returned by `p`.

eof :: forall s (m :: Type -> Type) t u. (Stream s m t, Show t) => ParsecT s u m () Source #

This parser only succeeds at the end of the input. This is not a primitive parser but it is defined using `notFollowedBy`.

     eof  = notFollowedBy anyToken <?> "end of input"

lookAhead :: forall s (m :: Type -> Type) t u a. Stream s m t => ParsecT s u m a -> ParsecT s u m a Source #

`lookAhead p` parses `p` without consuming any input.

If `p` fails and consumes some input, so does `lookAhead`. Combine with `try` if this is undesirable.

notFollowedBy :: forall s (m :: Type -> Type) t a u. (Stream s m t, Show a) => ParsecT s u m a -> ParsecT s u m () Source #

`notFollowedBy p` only succeeds when parser `p` fails. This parser does not consume any input. This parser can be used to implement the 'longest match' rule. For example, when recognizing keywords (for example `let`), we want to make sure that a keyword is not followed by a legal identifier character, in which case the keyword is actually an identifier (for example `lets`). We can program this behaviour as follows:

     keywordLet  = try (do{ string "let"
                          ; notFollowedBy alphaNum
                          })

NOTE: Currently, `notFollowedBy` exhibits surprising behaviour when applied to a parser `p` that doesn't consume any input; specifically

- ``notFollowedBy` . `notFollowedBy`` is not equivalent to `lookAhead`, and
- ``notFollowedBy` `eof`` never fails.

See haskell/parsec#8 for more details.

many :: forall s u (m :: Type -> Type) a. ParsecT s u m a -> ParsecT s u m [a] Source #

`many p` applies the parser `p` zero or more times. Returns a list of the returned values of `p`.

     identifier  = do{ c  <- letter
                     ; cs <- many (alphaNum <|> char '_')
                     ; return (c:cs)
                     }

many1 :: forall s u (m :: Type -> Type) a. ParsecT s u m a -> ParsecT s u m [a] Source #

`many1 p` applies the parser `p` one or more times. Returns a list of the returned values of `p`.

     word  = many1 letter

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] Source #

`manyTill p end` applies parser `p` zero or more times until parser `end` succeeds. Returns the list of values returned by `p`. This parser can be used to scan comments:

     simpleComment   = do{ string "<!--"
                         ; manyTill anyChar (try (string "-->"))
                         }

Note the overlapping parsers `anyChar` and `string "-->"`, and therefore the use of the `try` combinator.

(<|>) :: forall s u (m :: Type -> Type) a. ParsecT s u m a -> ParsecT s u m a -> ParsecT s u m a infixr 1 Source #

This combinator implements choice. The parser `p <|> q` first applies `p`. If it succeeds, the value of `p` is returned. If `p` fails without consuming any input, parser `q` is tried. This combinator is defined equal to the `mplus` member of the `MonadPlus` class and the (`<|>`) member of `Alternative`.

The parser is called predictive since `q` is only tried when parser `p` didn't consume any input (i.e.. the look ahead is 1). This non-backtracking behaviour allows for both an efficient implementation of the parser combinators and the generation of good error messages.

(<?>) :: forall s u (m :: Type -> Type) a. ParsecT s u m a -> String -> ParsecT s u m a infix 0 Source #

The parser `p <?> msg` behaves as parser `p`, but whenever the parser `p` fails without consuming any input, it replaces expect error messages with the expect error message `msg`.

This is normally used at the end of a set alternatives where we want to return an error message in terms of a higher level construct rather than returning all possible characters. For example, if the `expr` parser from the `try` example would fail, the error message is: '...: expecting expression'. Without the `(<?>)` combinator, the message would be like '...: expecting "let" or letter', which is less friendly.

choice :: forall s (m :: Type -> Type) t u a. Stream s m t => [ParsecT s u m a] -> ParsecT s u m a Source #

`choice ps` tries to apply the parsers in the list `ps` in order, until one of them succeeds. Returns the value of the succeeding parser.

try :: forall s u (m :: Type -> Type) a. ParsecT s u m a -> ParsecT s u m a Source #

The parser `try p` behaves like parser `p`, except that it pretends that it hasn't consumed any input when an error occurs.

This combinator is used whenever arbitrary look ahead is needed. Since it pretends that it hasn't consumed any input when `p` fails, the (`<|>`) combinator will try its second alternative even when the first parser failed while consuming input.

The `try` combinator can for example be used to distinguish identifiers and reserved words. Both reserved words and identifiers are a sequence of letters. Whenever we expect a certain reserved word where we can also expect an identifier we have to use the `try` combinator. Suppose we write:

     expr        = letExpr <|> identifier <?> "expression"

     letExpr     = do{ string "let"; ... }
     identifier  = many1 letter

If the user writes "lexical", the parser fails with: `unexpected 'x', expecting 't' in "let"`. Indeed, since the (`<|>`) combinator only tries alternatives when the first alternative hasn't consumed input, the `identifier` parser is never tried (because the prefix "le" of the `string "let"` parser is already consumed). The right behaviour can be obtained by adding the `try` combinator:

     expr        = letExpr <|> identifier <?> "expression"

     letExpr     = do{ try (string "let"); ... }
     identifier  = many1 letter

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] Source #

`sepBy p sep` parses zero or more occurrences of `p`, separated by `sep`. Returns a list of values returned by `p`.

     commaSep p  = p `sepBy` (symbol ",")

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] Source #

`sepBy1 p sep` parses one or more occurrences of `p`, separated by `sep`. Returns a list of values returned by `p`.

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] Source #

`sepEndBy p sep` parses zero or more occurrences of `p`, separated and optionally ended by `sep`, ie. haskell style statements. Returns a list of values returned by `p`.

     haskellStatements  = haskellStatement `sepEndBy` semi

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] Source #

`sepEndBy1 p sep` parses one or more occurrences of `p`, separated and optionally ended by `sep`. Returns a list of values returned by `p`.

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] Source #

`endBy p sep` parses zero or more occurrences of `p`, separated and ended by `sep`. Returns a list of values returned by `p`.

      cStatements  = cStatement `endBy` semi

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] Source #

`endBy1 p sep` parses one or more occurrences of `p`, separated and ended by `sep`. Returns a list of values returned by `p`.

option :: forall s (m :: Type -> Type) t a u. Stream s m t => a -> ParsecT s u m a -> ParsecT s u m a Source #

`option x p` tries to apply parser `p`. If `p` fails without consuming input, it returns the value `x`, otherwise the value returned by `p`.

     priority  = option 0 (do{ d <- digit
                             ; return (digitToInt d)
                             })

optional :: forall s (m :: Type -> Type) t u a. Stream s m t => ParsecT s u m a -> ParsecT s u m () Source #

`optional p` tries to apply parser `p`. It will parse `p` or nothing. It only fails if `p` fails after consuming input. It discards the result of `p`.

optionMaybe :: forall s (m :: Type -> Type) t u a. Stream s m t => ParsecT s u m a -> ParsecT s u m (Maybe a) Source #

`optionMaybe p` tries to apply parser `p`. If `p` fails without consuming input, it return `Nothing`, otherwise it returns `Just` the value returned by `p`.

getState :: forall (m :: Type -> Type) s u. Monad m => ParsecT s u m u Source #

Returns the current user state.

setState :: forall (m :: Type -> Type) u s. Monad m => u -> ParsecT s u m () Source #

An alias for putState for backwards compatibility.

updateState :: forall (m :: Type -> Type) u s. Monad m => (u -> u) -> ParsecT s u m () Source #

An alias for modifyState for backwards compatibility.

data SourcePos Source #

The abstract data type `SourcePos` represents source positions. It contains the name of the source (i.e. file name), a line number and a column number. `SourcePos` is an instance of the `Show`, `Eq` and `Ord` class.

#### Instances

Instances details

Data SourcePos |

Instance details

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 Source #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SourcePos Source #

toConstr :: SourcePos -> Constr Source #

dataTypeOf :: SourcePos -> DataType Source #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c SourcePos) Source #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SourcePos) Source #

gmapT :: (forall b. Data b => b -> b) -> SourcePos -> SourcePos Source #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SourcePos -> r Source #

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SourcePos -> r Source #

gmapQ :: (forall d. Data d => d -> u) -> SourcePos -> [u] Source #

gmapQi :: Int -> (forall d. Data d => d -> u) -> SourcePos -> u Source #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> SourcePos -> m SourcePos Source #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SourcePos -> m SourcePos Source #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SourcePos -> m SourcePos Source #

Show SourcePos |
Instance details Defined in Text.Parsec.Pos Methods showsPrec :: Int -> SourcePos -> ShowS Source # show :: SourcePos -> String Source # showList :: [SourcePos] -> ShowS Source #
Eq SourcePos |
Instance details Defined in Text.Parsec.Pos Methods (==) :: SourcePos -> SourcePos -> Bool Source # (/=) :: SourcePos -> SourcePos -> Bool Source #
Ord SourcePos |
Instance details Defined in Text.Parsec.Pos Methods compare :: SourcePos -> SourcePos -> Ordering Source # (<) :: SourcePos -> SourcePos -> Bool Source # (<=) :: SourcePos -> SourcePos -> Bool Source # (>) :: SourcePos -> SourcePos -> Bool Source # (>=) :: SourcePos -> SourcePos -> Bool Source # max :: SourcePos -> SourcePos -> SourcePos Source # min :: SourcePos -> SourcePos -> SourcePos Source #

type SourceName = String Source #

updatePosString :: SourcePos -> String -> SourcePos Source #

The expression `updatePosString pos s` updates the source position `pos` by calling `updatePosChar` on every character in `s`, ie. `foldl updatePosChar pos string`.

getPosition :: forall (m :: Type -> Type) s u. Monad m => ParsecT s u m SourcePos Source #

Returns the current source position. See also `SourcePos`.

setPosition :: forall (m :: Type -> Type) s u. Monad m => SourcePos -> ParsecT s u m () Source #

`setPosition pos` sets the current source position to `pos`.

sourceName :: SourcePos -> SourceName Source #

Extracts the name of the source from a source position.

setSourceName :: SourcePos -> SourceName -> SourcePos Source #

Set the name of the source.

sourceColumn :: SourcePos -> Column Source #

Extracts the column number from a source position.

sourceLine :: SourcePos -> Line Source #

Extracts the line number from a source position.

setSourceColumn :: SourcePos -> Column -> SourcePos Source #

Set the column number of a source position.

setSourceLine :: SourcePos -> Line -> SourcePos Source #

Set the line number of a source position.

incSourceColumn :: SourcePos -> Column -> SourcePos Source #

Increments the column number of a source position.

incSourceLine :: SourcePos -> Line -> SourcePos Source #

Increments the line number of a source position.

newPos :: SourceName -> Line -> Column -> SourcePos Source #

Create a new `SourcePos` with the given source name, line number and column number.

initialPos :: SourceName -> SourcePos Source #

Create a new `SourcePos` with the given source name, and line number and column number set to 1, the upper left.

type Line = Int Source #

type Column = Int Source #

data ParseError Source #

The abstract data type `ParseError` represents parse errors. It provides the source position (`SourcePos`) of the error and a list of error messages (`Message`). A `ParseError` can be returned by the function `parse`. `ParseError` is an instance of the `Show` and `Eq` classes.

#### Instances

Instances details

Exception ParseError | Since: parsec-3.1.17.0
Instance details Defined in Text.Parsec.Error Methods toException :: ParseError -> SomeException Source # fromException :: SomeException -> Maybe ParseError Source # displayException :: ParseError -> String Source # backtraceDesired :: ParseError -> Bool Source #
Show ParseError |
Instance details Defined in Text.Parsec.Error Methods showsPrec :: Int -> ParseError -> ShowS Source # show :: ParseError -> String Source # showList :: [ParseError] -> ShowS Source #
Eq ParseError |
Instance details Defined in Text.Parsec.Error Methods (==) :: ParseError -> ParseError -> Bool Source # (/=) :: ParseError -> ParseError -> Bool Source #

errorMessages :: ParseError -> [Message] Source #

Extracts the list of error messages from the parse error

messageString :: Message -> String Source #

Extract the message string from an error message