pandoc-2.5: Conversion between markup formats

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

- takeWhileP :: Monad m => (Char -> Bool) -> ParserT [Char] st m [Char]
- takeP :: Monad m => Int -> ParserT [Char] st m [Char]
- anyLine :: Monad m => ParserT [Char] st m [Char]
- anyLineNewline :: Monad m => ParserT [Char] st m [Char]
- indentWith :: Stream s m Char => HasReaderOptions st => Int -> ParserT s st m [Char]
- many1Till :: (Show end, Stream s m t) => ParserT s st m a -> ParserT s st m end -> ParserT s st m [a]
- manyUntil :: Stream s m t => ParserT s u m a -> ParserT s u m b -> ParserT s u m ([a], b)
- sepBy1' :: Stream s m t => ParsecT s u m a -> ParsecT s u m sep -> ParsecT s u m [a]
- notFollowedBy' :: (Show b, Stream s m a) => ParserT s st m b -> ParserT s st m ()
- oneOfStrings :: Stream s m Char => [String] -> ParserT s st m String
- oneOfStringsCI :: Stream s m Char => [String] -> ParserT s st m String
- spaceChar :: Stream s m Char => ParserT s st m Char
- nonspaceChar :: Stream s m Char => ParserT s st m Char
- skipSpaces :: Stream s m Char => ParserT s st m ()
- blankline :: Stream s m Char => ParserT s st m Char
- blanklines :: Stream s m Char => ParserT s st m [Char]
- gobbleSpaces :: (HasReaderOptions st, Monad m) => Int -> ParserT [Char] st m ()
- gobbleAtMostSpaces :: (HasReaderOptions st, Monad m) => Int -> ParserT [Char] st m Int
- enclosed :: (Show end, Stream s m Char) => ParserT s st m t -> ParserT s st m end -> ParserT s st m a -> ParserT s st m [a]
- stringAnyCase :: Stream s m Char => [Char] -> ParserT s st m String
- parseFromString :: (Monad m, Stream s m Char, IsString s) => ParserT s st m r -> String -> ParserT s st m r
- parseFromString' :: (Monad m, Stream s m Char, IsString s) => ParserT s ParserState m a -> String -> ParserT s ParserState m a
- lineClump :: Monad m => ParserT [Char] st m String
- charsInBalanced :: Stream s m Char => Char -> Char -> ParserT s st m Char -> ParserT s st m String
- romanNumeral :: Stream s m Char => Bool -> ParserT s st m Int
- emailAddress :: Stream s m Char => ParserT s st m (String, String)
- uri :: Stream s m Char => ParserT s st m (String, String)
- mathInline :: (HasReaderOptions st, Stream s m Char) => ParserT s st m String
- mathDisplay :: (HasReaderOptions st, Stream s m Char) => ParserT s st m String
- withHorizDisplacement :: Stream s m Char => ParserT s st m a -> ParserT s st m (a, Int)
- withRaw :: Monad m => ParsecT [Char] st m a -> ParsecT [Char] st m (a, [Char])
- escaped :: Stream s m Char => ParserT s st m Char -> ParserT s st m Char
- characterReference :: Stream s m Char => ParserT s st m Char
- upperRoman :: Stream s m Char => ParserT s st m (ListNumberStyle, Int)
- lowerRoman :: Stream s m Char => ParserT s st m (ListNumberStyle, Int)
- decimal :: Stream s m Char => ParserT s st m (ListNumberStyle, Int)
- lowerAlpha :: Stream s m Char => ParserT s st m (ListNumberStyle, Int)
- upperAlpha :: Stream s m Char => ParserT s st m (ListNumberStyle, Int)
- anyOrderedListMarker :: Stream s m Char => ParserT s ParserState m ListAttributes
- orderedListMarker :: Stream s m Char => ListNumberStyle -> ListNumberDelim -> ParserT s ParserState m Int
- charRef :: Stream s m Char => ParserT s st m Inline
- lineBlockLines :: Monad m => ParserT [Char] st m [String]
- tableWith :: (Stream s m Char, HasReaderOptions st, Monad mf) => ParserT s st m (mf [Blocks], [Alignment], [Int]) -> ([Int] -> ParserT s st m (mf [Blocks])) -> ParserT s st m sep -> ParserT s st m end -> ParserT s st m (mf Blocks)
- widthsFromIndices :: Int -> [Int] -> [Double]
- gridTableWith :: (Stream s m Char, HasReaderOptions st, Monad mf, IsString s) => ParserT s st m (mf Blocks) -> Bool -> ParserT s st m (mf Blocks)
- gridTableWith' :: (Stream s m Char, HasReaderOptions st, Monad mf, IsString s) => ParserT s st m (mf Blocks) -> Bool -> ParserT s st m (TableComponents mf)
- readWith :: Parser [Char] st a -> st -> String -> Either PandocError a
- readWithM :: (Monad m, Stream s m Char, ToString s) => ParserT s st m a -> st -> s -> m (Either PandocError a)
- testStringWith :: Show a => ParserT [Char] ParserState Identity a -> [Char] -> IO ()
- guardEnabled :: (Stream s m a, HasReaderOptions st) => Extension -> ParserT s st m ()
- guardDisabled :: (Stream s m a, HasReaderOptions st) => Extension -> ParserT s st m ()
- updateLastStrPos :: (Stream s m a, HasLastStrPosition st) => ParserT s st m ()
- notAfterString :: (Stream s m a, HasLastStrPosition st) => ParserT s st m Bool
- logMessage :: (Stream s m a, HasLogMessages st) => LogMessage -> ParserT s st m ()
- reportLogMessages :: (PandocMonad m, HasLogMessages st) => ParserT s st m ()
- data ParserState = ParserState {
  - stateOptions :: ReaderOptions
  - stateParserContext :: ParserContext
  - stateQuoteContext :: QuoteContext
  - stateAllowLinks :: Bool
  - stateMaxNestingLevel :: Int
  - stateLastStrPos :: Maybe SourcePos
  - stateKeys :: KeyTable
  - stateHeaderKeys :: KeyTable
  - stateSubstitutions :: SubstTable
  - stateNotes :: NoteTable
  - stateNotes' :: NoteTable'
  - stateNoteRefs :: Set String
  - stateMeta :: Meta
  - stateMeta' :: F Meta
  - stateCitations :: Map String String
  - stateHeaderTable :: [HeaderType]
  - stateHeaders :: Map Inlines String
  - stateIdentifiers :: Set String
  - stateNextExample :: Int
  - stateExamples :: Map String Int
  - stateMacros :: Map Text Macro
  - stateRstDefaultRole :: String
  - stateRstCustomRoles :: Map String (String, Maybe String, Attr)
  - stateCaption :: Maybe Inlines
  - stateInHtmlBlock :: Maybe String
  - stateFencedDivLevel :: Int
  - stateContainers :: [String]
  - stateLogMessages :: [LogMessage]
  - stateMarkdownAttribute :: Bool
  }
- class HasReaderOptions st where
  - extractReaderOptions :: st -> ReaderOptions
  - getOption :: Stream s m t => (ReaderOptions -> b) -> ParserT s st m b
- class HasHeaderMap st where
  - extractHeaderMap :: st -> Map Inlines String
  - updateHeaderMap :: (Map Inlines String -> Map Inlines String) -> st -> st
- class HasIdentifierList st where
  - extractIdentifierList :: st -> Set String
  - updateIdentifierList :: (Set String -> Set String) -> 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 :: SourcePos -> st -> st
  - getLastStrPos :: st -> Maybe SourcePos
- class HasIncludeFiles st where
  - getIncludeFiles :: st -> [String]
  - addIncludeFile :: String -> 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 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 = [(String, String)]
- type NoteTable' = Map String (SourcePos, F Blocks)
- type KeyTable = Map Key (Target, Attr)
- type SubstTable = Map Key Inlines
- newtype Key = Key String
- toKey :: String -> Key
- registerHeader :: (Stream s m a, HasReaderOptions st, HasHeaderMap st, HasLogMessages st, HasIdentifierList st) => Attr -> Inlines -> ParserT s st m Attr
- smartPunctuation :: (HasReaderOptions st, HasLastStrPosition st, HasQuoteContext st m, Stream s m Char) => ParserT s st m Inlines -> ParserT s st m Inlines
- singleQuoteStart :: (HasLastStrPosition st, HasQuoteContext st m, Stream s m Char) => ParserT s st m ()
- singleQuoteEnd :: Stream s m Char => ParserT s st m ()
- doubleQuoteStart :: (HasQuoteContext st m, Stream s m Char) => ParserT s st m ()
- doubleQuoteEnd :: Stream s m Char => ParserT s st m ()
- ellipses :: Stream s m Char => ParserT s st m Inlines
- apostrophe :: Stream s m Char => ParserT s st m Inlines
- dash :: (HasReaderOptions st, Stream s m Char) => ParserT s st m Inlines
- nested :: Stream s m a => ParserT s ParserState m a -> ParserT s ParserState m a
- citeKey :: (Stream s m Char, HasLastStrPosition st) => ParserT s st m (Bool, String)
- type Parser t s = Parsec t s
- type ParserT = ParsecT
- type F = Future ParserState
- 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 -> String) -> (t -> SourcePos) -> (t -> Maybe a) -> ParsecT s st m a
- (<+?>) :: Monoid a => ParserT s st m a -> ParserT s st m a -> ParserT s st m a
- extractIdClass :: Attr -> Attr
- insertIncludedFile :: (PandocMonad m, HasIncludeFiles st) => ParserT [a] st m Blocks -> (String -> [a]) -> [FilePath] -> FilePath -> ParserT [a] st m Blocks
- insertIncludedFileF :: (PandocMonad m, HasIncludeFiles st) => ParserT String st m (Future st Blocks) -> [FilePath] -> FilePath -> ParserT String st m (Future st Blocks)
- class Monad m => Stream s (m :: Type -> Type) t | s -> t
- runParser :: Stream s Identity t => Parsec s u a -> u -> SourceName -> s -> Either ParseError a
- runParserT :: Stream s m t => ParsecT s u m a -> u -> SourceName -> s -> m (Either ParseError a)
- parse :: Stream s Identity t => Parsec s () a -> SourceName -> s -> Either ParseError a
- tokenPrim :: Stream s m t => (t -> String) -> (SourcePos -> t -> s -> SourcePos) -> (t -> Maybe a) -> ParsecT s u m a
- anyToken :: (Stream s m t, Show t) => ParsecT s u m t
- getInput :: Monad m => ParsecT s u m s
- setInput :: Monad m => s -> ParsecT s u m ()
- unexpected :: Stream s m t => String -> ParsecT s u m a
- char :: Stream s m Char => Char -> ParsecT s u m Char
- letter :: Stream s m Char => ParsecT s u m Char
- digit :: Stream s m Char => ParsecT s u m Char
- alphaNum :: Stream s m Char => ParsecT s u m Char
- skipMany :: ParsecT s u m a -> ParsecT s u m ()
- skipMany1 :: Stream s m t => ParsecT s u m a -> ParsecT s u m ()
- spaces :: Stream s m Char => ParsecT s u m ()
- space :: Stream s m Char => ParsecT s u m Char
- anyChar :: Stream s m Char => ParsecT s u m Char
- satisfy :: Stream s m Char => (Char -> Bool) -> ParsecT s u m Char
- newline :: Stream s m Char => ParsecT s u m Char
- string :: Stream s m Char => String -> ParsecT s u m String
- count :: Stream s m t => Int -> ParsecT s u m a -> ParsecT s u m [a]
- eof :: (Stream s m t, Show t) => ParsecT s u m ()
- noneOf :: Stream s m Char => [Char] -> ParsecT s u m Char
- oneOf :: Stream s m Char => [Char] -> ParsecT s u m Char
- lookAhead :: Stream s m t => ParsecT s u m a -> ParsecT s u m a
- notFollowedBy :: (Stream s m t, Show a) => ParsecT s u m a -> ParsecT s u m ()
- many :: ParsecT s u m a -> ParsecT s u m [a]
- many1 :: Stream s m t => ParsecT s u m a -> ParsecT s u m [a]
- manyTill :: Stream s m t => ParsecT s u m a -> ParsecT s u m end -> ParsecT s u m [a]
- (<|>) :: ParsecT s u m a -> ParsecT s u m a -> ParsecT s u m a
- (<?>) :: ParsecT s u m a -> String -> ParsecT s u m a
- choice :: Stream s m t => [ParsecT s u m a] -> ParsecT s u m a
- try :: ParsecT s u m a -> ParsecT s u m a
- sepBy :: Stream s m t => ParsecT s u m a -> ParsecT s u m sep -> ParsecT s u m [a]
- sepBy1 :: Stream s m t => ParsecT s u m a -> ParsecT s u m sep -> ParsecT s u m [a]
- sepEndBy :: Stream s m t => ParsecT s u m a -> ParsecT s u m sep -> ParsecT s u m [a]
- sepEndBy1 :: Stream s m t => ParsecT s u m a -> ParsecT s u m sep -> ParsecT s u m [a]
- endBy :: Stream s m t => ParsecT s u m a -> ParsecT s u m sep -> ParsecT s u m [a]
- endBy1 :: Stream s m t => ParsecT s u m a -> ParsecT s u m sep -> ParsecT s u m [a]
- option :: Stream s m t => a -> ParsecT s u m a -> ParsecT s u m a
- optional :: Stream s m t => ParsecT s u m a -> ParsecT s u m ()
- optionMaybe :: Stream s m t => ParsecT s u m a -> ParsecT s u m (Maybe a)
- getState :: Monad m => ParsecT s u m u
- setState :: Monad m => u -> ParsecT s u m ()
- updateState :: Monad m => (u -> u) -> ParsecT s u m ()
- data SourcePos
- getPosition :: Monad m => ParsecT s u m SourcePos
- setPosition :: Monad m => SourcePos -> ParsecT s u m ()
- sourceColumn :: SourcePos -> Column
- sourceLine :: SourcePos -> Line
- setSourceColumn :: SourcePos -> Column -> SourcePos
- setSourceLine :: SourcePos -> Line -> SourcePos
- incSourceColumn :: SourcePos -> Column -> SourcePos
- newPos :: SourceName -> Line -> Column -> SourcePos
- type Line = Int
- type Column = Int

# Documentation

takeWhileP :: Monad m => (Char -> Bool) -> ParserT [Char] st m [Char] Source #

Parse characters while a predicate is true.

takeP :: Monad m => Int -> ParserT [Char] st m [Char] Source #

anyLine :: Monad m => ParserT [Char] st m [Char] Source #

Parse any line of text

anyLineNewline :: Monad m => ParserT [Char] st m [Char] Source #

Parse any line, include the final newline in the output

indentWith :: Stream s m Char => HasReaderOptions st => Int -> ParserT s st m [Char] Source #

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

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

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

manyUntil :: Stream s m t => ParserT s u m a -> ParserT s u m b -> ParserT s u m ([a], b) Source #

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

sepBy1' :: Stream s m t => ParsecT s u m a -> ParsecT s u m sep -> ParsecT s u m [a] Source #

Like `sepBy1` from Parsec, but does not fail if it `sep` succeeds and `p` fails.

notFollowedBy' :: (Show b, Stream s m a) => ParserT s st m b -> ParserT s st m () Source #

A more general form of `notFollowedBy`. This one allows any type of parser to be specified, and succeeds only if that parser fails. It does not consume any input.

oneOfStrings :: Stream s m Char => [String] -> ParserT s st m String Source #

Parses one of a list of strings. If the list contains two strings one of which is a prefix of the other, the longer string will be matched if possible.

oneOfStringsCI :: Stream s m Char => [String] -> ParserT s st m String Source #

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

spaceChar :: Stream s m Char => ParserT s st m Char Source #

Parses a space or tab.

nonspaceChar :: Stream s m Char => ParserT s st m Char Source #

Parses a nonspace, nonnewline character.

skipSpaces :: Stream s m Char => ParserT s st m () Source #

Skips zero or more spaces or tabs.

blankline :: Stream s m Char => ParserT s st m Char Source #

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

blanklines :: Stream s m Char => ParserT s st m [Char] Source #

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

gobbleSpaces :: (HasReaderOptions st, Monad m) => Int -> ParserT [Char] st m () Source #

Gobble n spaces; if tabs are encountered, expand them and gobble some or all of their spaces, leaving the rest.

gobbleAtMostSpaces :: (HasReaderOptions st, Monad m) => Int -> ParserT [Char] 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

:: (Show end, Stream s m Char) |
=> ParserT s st m t | start parser
-> ParserT s st m end | end parser
-> ParserT s st m a | content parser (to be used repeatedly)
-> ParserT s st m [a] |

Parses material enclosed between start and end parsers.

stringAnyCase :: Stream s m Char => [Char] -> ParserT s st m String Source #

Parse string, case insensitive.

parseFromString :: (Monad m, Stream s m Char, IsString s) => ParserT s st m r -> String -> ParserT s st m r Source #

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

parseFromString' :: (Monad m, Stream s m Char, IsString s) => ParserT s ParserState m a -> String -> ParserT s ParserState m a Source #

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

lineClump :: Monad m => ParserT [Char] st m String Source #

Parse raw line block up to and including blank lines.

charsInBalanced :: Stream s m Char => Char -> Char -> ParserT s st m Char -> ParserT s st m String Source #

Parse a string of characters between an open character and a close character, including text between balanced pairs of open and close, which must be different. For example, `charsInBalanced '(' ')' anyChar` will parse "(hello (there))" and return "hello (there)".

romanNumeral Source #

Arguments

:: Stream s m Char |
=> Bool | Uppercase if true
-> ParserT s st m Int |

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

emailAddress :: Stream s m Char => ParserT s st m (String, String) Source #

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

uri :: Stream s m Char => ParserT s st m (String, String) Source #

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

mathInline :: (HasReaderOptions st, Stream s m Char) => ParserT s st m String Source #

mathDisplay :: (HasReaderOptions st, Stream s m Char) => ParserT s st m String Source #

withHorizDisplacement Source #

Arguments

:: Stream s m Char |
=> ParserT s st m a | Parser to apply
-> ParserT s st m (a, Int) | (result, displacement)

Applies a parser, returns tuple of its results and its horizontal displacement (the difference between the source column at the end and the source column at the beginning). Vertical displacement (source row) is ignored.

withRaw :: Monad m => ParsecT [Char] st m a -> ParsecT [Char] st m (a, [Char]) Source #

Applies a parser and returns the raw string that was parsed, along with the value produced by the parser.

escaped Source #

Arguments

:: Stream s m Char |
=> ParserT s st m Char | Parser for character to escape
-> ParserT s st m Char |

Parses backslash, then applies character parser.

characterReference :: Stream s m Char => ParserT s st m Char Source #

Parse character entity.

upperRoman :: Stream s m Char => ParserT s st m (ListNumberStyle, Int) Source #

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

lowerRoman :: Stream s m Char => ParserT s st m (ListNumberStyle, Int) Source #

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

decimal :: Stream s m Char => ParserT s st m (ListNumberStyle, Int) Source #

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

lowerAlpha :: Stream s m Char => ParserT s st m (ListNumberStyle, Int) Source #

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

upperAlpha :: Stream s m Char => ParserT s st m (ListNumberStyle, Int) Source #

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

anyOrderedListMarker :: Stream s m Char => ParserT s ParserState m ListAttributes Source #

Parses an ordered list marker and returns list attributes.

orderedListMarker :: Stream s m Char => ListNumberStyle -> ListNumberDelim -> ParserT s ParserState m Int Source #

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

charRef :: Stream s m Char => ParserT s st m Inline Source #

Parses a character reference and returns a Str element.

lineBlockLines :: Monad m => ParserT [Char] st m [String] Source #

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

tableWith :: (Stream s m Char, HasReaderOptions st, Monad mf) => ParserT s st m (mf [Blocks], [Alignment], [Int]) -> ([Int] -> ParserT s st m (mf [Blocks])) -> ParserT s st m sep -> ParserT s st m end -> ParserT s st m (mf Blocks) Source #

Parse a table using `headerParser`, `rowParser`, `lineParser`, and `footerParser`.

widthsFromIndices :: Int -> [Int] -> [Double] Source #

gridTableWith Source #

Arguments

:: (Stream s m Char, HasReaderOptions st, Monad mf, IsString s) |
=> ParserT s st m (mf Blocks) | Block list parser
-> Bool | Headerless table
-> ParserT s st m (mf Blocks) |

gridTableWith' Source #

Arguments

:: (Stream s m Char, HasReaderOptions st, Monad mf, IsString s) |
=> ParserT s st m (mf Blocks) | Block list parser
-> Bool | Headerless table
-> ParserT s st m (TableComponents mf) |

readWith :: Parser [Char] st a -> st -> String -> Either PandocError a Source #

Parse a string with a given parser and state

readWithM Source #

Arguments

:: (Monad m, Stream s m Char, ToString s) |
=> ParserT s st m a | parser
-> st | initial state
-> s | input
-> m (Either PandocError a) |

Removes the ParsecT layer from the monad transformer stack

testStringWith :: Show a => ParserT [Char] ParserState Identity a -> [Char] -> IO () Source #

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

guardEnabled :: (Stream s m a, HasReaderOptions st) => Extension -> ParserT s st m () Source #

Succeed only if the extension is enabled.

guardDisabled :: (Stream s m a, HasReaderOptions st) => Extension -> ParserT s st m () Source #

Succeed only if the extension is disabled.

updateLastStrPos :: (Stream s m a, HasLastStrPosition st) => ParserT s st m () Source #

Update the position on which the last string ended.

notAfterString :: (Stream s m a, HasLastStrPosition st) => ParserT s st m Bool Source #

Whether we are right after the end of a string.

logMessage :: (Stream s m a, HasLogMessages st) => LogMessage -> ParserT s st m () Source #

Add a log message.

reportLogMessages :: (PandocMonad m, HasLogMessages st) => ParserT s st m () Source #

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

data ParserState Source #

Parsing options.

Constructors

ParserState |

Fields

- stateOptions :: ReaderOptions

  User options

- stateParserContext :: ParserContext

  Inside list?

- stateQuoteContext :: QuoteContext

  Inside quoted environment?

- stateAllowLinks :: Bool

  Allow parsing of links

- stateMaxNestingLevel :: Int

  Max # of nested Strong/Emph

- 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 String

  List of note references used

- stateMeta :: Meta

  Document metadata

- stateMeta' :: F Meta

  Document metadata

- stateCitations :: Map String String

  RST-style citations

- stateHeaderTable :: [HeaderType]

  Ordered list of header types used

- stateHeaders :: Map Inlines String

  List of headers and ids (used for implicit ref links)

- stateIdentifiers :: Set String

  Header identifiers used

- stateNextExample :: Int

  Number of next example

- stateExamples :: Map String Int

  Map from example labels to numbers

- stateMacros :: Map Text Macro

  Table of macros defined so far

- stateRstDefaultRole :: String

  Current rST default interpreted text role

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

  Current rST custom text roles Triple represents: 1) Base role, 2) Optional format (only for :raw: roles), 3) Additional classes (rest of Attr is unused)).

- stateCaption :: Maybe Inlines

  Caption in current environment

- stateInHtmlBlock :: Maybe String

  Tag type of HTML block being parsed

- stateFencedDivLevel :: Int

  Depth of fenced div

- stateContainers :: [String]

  parent include files

- stateLogMessages :: [LogMessage]

  log messages

- stateMarkdownAttribute :: Bool

  True if in markdown=1 context

Instances

Default ParserState Source # |
Instance details Defined in Text.Pandoc.Parsing Methods def :: ParserState #
HasMeta ParserState Source # |
Instance details Defined in Text.Pandoc.Parsing Methods setMeta :: ToMetaValue b => String -> b -> ParserState -> ParserState Source # deleteMeta :: String -> ParserState -> ParserState Source #
HasIncludeFiles ParserState Source # |
Instance details Defined in Text.Pandoc.Parsing Methods getIncludeFiles :: ParserState -> [String] Source # addIncludeFile :: String -> ParserState -> ParserState Source # dropLatestIncludeFile :: ParserState -> ParserState Source #
HasLogMessages ParserState Source # |
Instance details Defined in Text.Pandoc.Parsing Methods addLogMessage :: LogMessage -> ParserState -> ParserState Source # getLogMessages :: ParserState -> [LogMessage] Source #
HasLastStrPosition ParserState Source # |
Instance details Defined in Text.Pandoc.Parsing Methods setLastStrPos :: SourcePos -> ParserState -> ParserState Source # getLastStrPos :: ParserState -> Maybe SourcePos Source #
HasMacros ParserState Source # |
Instance details Defined in Text.Pandoc.Parsing Methods extractMacros :: ParserState -> Map Text Macro Source # updateMacros :: (Map Text Macro -> Map Text Macro) -> ParserState -> ParserState Source #
HasIdentifierList ParserState Source # |
Instance details Defined in Text.Pandoc.Parsing Methods extractIdentifierList :: ParserState -> Set String Source # updateIdentifierList :: (Set String -> Set String) -> ParserState -> ParserState Source #
HasHeaderMap ParserState Source # |
Instance details Defined in Text.Pandoc.Parsing Methods extractHeaderMap :: ParserState -> Map Inlines String Source # updateHeaderMap :: (Map Inlines String -> Map Inlines String) -> ParserState -> ParserState Source #
HasReaderOptions ParserState Source # |
Instance details Defined in Text.Pandoc.Parsing Methods extractReaderOptions :: ParserState -> ReaderOptions Source # getOption :: Stream s m t => (ReaderOptions -> b) -> ParserT s ParserState m b Source #
Monad m => HasQuoteContext ParserState m Source # |
Instance details Defined in Text.Pandoc.Parsing Methods getQuoteContext :: Stream s m t => ParsecT s ParserState m QuoteContext Source # withQuoteContext :: QuoteContext -> ParsecT s ParserState m a -> ParsecT s ParserState m a Source #

class HasReaderOptions st where Source #

Minimal complete definition

extractReaderOptions

Methods

extractReaderOptions :: st -> ReaderOptions Source #

getOption :: Stream s m t => (ReaderOptions -> b) -> ParserT s st m b Source #

Instances

HasReaderOptions ParserState Source # |
Instance details Defined in Text.Pandoc.Parsing Methods extractReaderOptions :: ParserState -> ReaderOptions Source # getOption :: Stream s m t => (ReaderOptions -> b) -> ParserT s ParserState m b Source #

class HasHeaderMap st where Source #

Methods

extractHeaderMap :: st -> Map Inlines String Source #

updateHeaderMap :: (Map Inlines String -> Map Inlines String) -> st -> st Source #

Instances

HasHeaderMap ParserState Source # |
Instance details Defined in Text.Pandoc.Parsing Methods extractHeaderMap :: ParserState -> Map Inlines String Source # updateHeaderMap :: (Map Inlines String -> Map Inlines String) -> ParserState -> ParserState Source #

class HasIdentifierList st where Source #

Methods

extractIdentifierList :: st -> Set String Source #

updateIdentifierList :: (Set String -> Set String) -> st -> st Source #

Instances

HasIdentifierList ParserState Source # |
Instance details Defined in Text.Pandoc.Parsing Methods extractIdentifierList :: ParserState -> Set String Source # updateIdentifierList :: (Set String -> Set String) -> ParserState -> ParserState Source #

class HasMacros st where Source #

Methods

extractMacros :: st -> Map Text Macro Source #

updateMacros :: (Map Text Macro -> Map Text Macro) -> st -> st Source #

Instances

HasMacros ParserState Source # |
Instance details Defined in Text.Pandoc.Parsing Methods extractMacros :: ParserState -> Map Text Macro Source # updateMacros :: (Map Text Macro -> Map Text Macro) -> ParserState -> ParserState Source #

class HasLogMessages st where Source #

Methods

addLogMessage :: LogMessage -> st -> st Source #

getLogMessages :: st -> [LogMessage] Source #

Instances

HasLogMessages ParserState Source # |
Instance details Defined in Text.Pandoc.Parsing Methods addLogMessage :: LogMessage -> ParserState -> ParserState Source # getLogMessages :: ParserState -> [LogMessage] Source #

class HasLastStrPosition st where Source #

Methods

setLastStrPos :: SourcePos -> st -> st Source #

getLastStrPos :: st -> Maybe SourcePos Source #

Instances

HasLastStrPosition ParserState Source # |
Instance details Defined in Text.Pandoc.Parsing Methods setLastStrPos :: SourcePos -> ParserState -> ParserState Source # getLastStrPos :: ParserState -> Maybe SourcePos Source #

class HasIncludeFiles st where Source #

Methods

getIncludeFiles :: st -> [String] Source #

addIncludeFile :: String -> st -> st Source #

dropLatestIncludeFile :: st -> st Source #

Instances

HasIncludeFiles ParserState Source # |
Instance details Defined in Text.Pandoc.Parsing Methods getIncludeFiles :: ParserState -> [String] Source # addIncludeFile :: String -> 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

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

data ParserContext Source #

Constructors

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

Instances

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

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

class HasQuoteContext st m where Source #

Methods

getQuoteContext :: Stream s m t => ParsecT s st m QuoteContext Source #

withQuoteContext :: QuoteContext -> ParsecT s st m a -> ParsecT s st m a Source #

Instances

Monad m => HasQuoteContext ParserState m Source # |
Instance details Defined in Text.Pandoc.Parsing Methods getQuoteContext :: Stream s m t => ParsecT s ParserState m QuoteContext Source # withQuoteContext :: QuoteContext -> ParsecT s ParserState m a -> ParsecT s ParserState m a Source #

type NoteTable = [(String, String)] Source #

type NoteTable' = Map String (SourcePos, F Blocks) Source #

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

type SubstTable = Map Key Inlines Source #

newtype Key Source #

Constructors

Key String |

Instances

Eq Key Source # |
Instance details Defined in Text.Pandoc.Parsing Methods (==) :: Key -> Key -> Bool Source # (/=) :: Key -> Key -> Bool Source #
Ord Key Source # |
Instance details Defined in Text.Pandoc.Parsing 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 #
Read Key Source # |
Instance details Defined in Text.Pandoc.Parsing 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 Methods showsPrec :: Int -> Key -> ShowS Source # show :: Key -> String Source # showList :: [Key] -> ShowS Source #

toKey :: String -> Key Source #

registerHeader :: (Stream s m a, HasReaderOptions st, HasHeaderMap st, HasLogMessages st, HasIdentifierList st) => Attr -> Inlines -> ParserT s st m Attr Source #

smartPunctuation :: (HasReaderOptions st, HasLastStrPosition st, HasQuoteContext st m, Stream s m Char) => ParserT s st m Inlines -> ParserT s st m Inlines Source #

singleQuoteStart :: (HasLastStrPosition st, HasQuoteContext st m, Stream s m Char) => ParserT s st m () Source #

singleQuoteEnd :: Stream s m Char => ParserT s st m () Source #

doubleQuoteStart :: (HasQuoteContext st m, Stream s m Char) => ParserT s st m () Source #

doubleQuoteEnd :: Stream s m Char => ParserT s st m () Source #

ellipses :: Stream s m Char => ParserT s st m Inlines Source #

apostrophe :: Stream s m Char => ParserT s st m Inlines Source #

dash :: (HasReaderOptions st, Stream s m Char) => ParserT s st m Inlines Source #

nested :: Stream s m a => ParserT s ParserState m a -> ParserT s ParserState m a Source #

citeKey :: (Stream s m Char, HasLastStrPosition st) => ParserT s st m (Bool, String) Source #

type Parser t s = Parsec t s Source #

type ParserT = ParsecT Source #

type F = Future ParserState 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

Monad (Future s) Source # |
Instance details Defined in Text.Pandoc.Parsing 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 # fail :: String -> Future s a Source #
Functor (Future s) Source # |
Instance details Defined in Text.Pandoc.Parsing Methods fmap :: (a -> b) -> Future s a -> Future s b Source # (<$) :: a -> Future s b -> Future s a Source #
Applicative (Future s) Source # |
Instance details Defined in Text.Pandoc.Parsing 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 #
Semigroup a => Semigroup (Future s a) Source # |
Instance details Defined in Text.Pandoc.Parsing 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 #
(Semigroup a, Monoid a) => Monoid (Future s a) Source # |
Instance details Defined in Text.Pandoc.Parsing 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 #

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

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 #

token :: Stream s m t => (t -> String) -> (t -> SourcePos) -> (t -> Maybe a) -> ParsecT s st m a Source #

(<+?>) :: Monoid a => ParserT s st m a -> ParserT s st m a -> ParserT s st m a infixr 5 Source #

extractIdClass :: Attr -> Attr Source #

insertIncludedFile :: (PandocMonad m, HasIncludeFiles st) => ParserT [a] st m Blocks -> (String -> [a]) -> [FilePath] -> FilePath -> ParserT [a] st m Blocks Source #

Parse content of include file as blocks. Circular includes result in an `PandocParseError`.

insertIncludedFileF :: (PandocMonad m, HasIncludeFiles st) => ParserT String st m (Future st Blocks) -> [FilePath] -> FilePath -> ParserT String st m (Future st Blocks) Source #

Parse content of include file as future blocks. Circular includes result in an `PandocParseError`.

# Re-exports from Text.Parsec

class Monad m => Stream s (m :: Type -> Type) t | s -> t 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.

Minimal complete definition

uncons

Instances

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

:: 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 :: (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 :: Monad m => ParsecT s u m s Source #

Returns the current input

setInput :: 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 :: 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`.

char :: Stream s m Char => Char -> ParsecT s u m Char Source #

`char c` parses a single character `c`. Returns the parsed character (i.e. `c`).

     semiColon  = char ';'

letter :: Stream s m Char => ParsecT s u m Char Source #

Parses a letter (an upper case or lower case character according to `isAlpha`). Returns the parsed character.

digit :: Stream s m Char => ParsecT s u m Char Source #

Parses a digit. Returns the parsed character.

alphaNum :: Stream s m Char => ParsecT s u m Char Source #

Parses a letter or digit (a character between '0' and '9') according to `isAlphaNum`. Returns the parsed character.

skipMany :: 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 :: 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.

spaces :: Stream s m Char => ParsecT s u m () Source #

Skips zero or more white space characters. See also `skipMany`.

space :: Stream s m Char => ParsecT s u m Char Source #

Parses a white space character (any character which satisfies `isSpace`) Returns the parsed character.

anyChar :: Stream s m Char => ParsecT s u m Char Source #

This parser succeeds for any character. Returns the parsed character.

satisfy :: Stream s m Char => (Char -> Bool) -> ParsecT s u m Char Source #

The parser `satisfy f` succeeds for any character for which the supplied function `f` returns `True`. Returns the character that is actually parsed.

newline :: Stream s m Char => ParsecT s u m Char Source #

Parses a newline character ('\n'). Returns a newline character.

string :: Stream s m Char => String -> ParsecT s u m String Source #

`string s` parses a sequence of characters given by `s`. Returns the parsed string (i.e. `s`).

     divOrMod    =   string "div"
                 <|> string "mod"

count :: 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 :: (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"

noneOf :: Stream s m Char => [Char] -> ParsecT s u m Char Source #

As the dual of `oneOf`, `noneOf cs` succeeds if the current character not in the supplied list of characters `cs`. Returns the parsed character.

     consonant = noneOf "aeiou"

oneOf :: Stream s m Char => [Char] -> ParsecT s u m Char Source #

`oneOf cs` succeeds if the current character is in the supplied list of characters `cs`. Returns the parsed character. See also `satisfy`.

      vowel  = oneOf "aeiou"

lookAhead :: 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 :: (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 :: 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 :: Stream s m t => 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 :: 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.

(<|>) :: 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.

(<?>) :: 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 :: 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 :: 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 :: 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 :: 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 :: 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 :: 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 :: 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 :: 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 :: 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 :: 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 :: 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 :: Monad m => ParsecT s u m u Source #

Returns the current user state.

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

An alias for putState for backwards compatibility.

updateState :: 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

Eq SourcePos |
Instance details Defined in Text.Parsec.Pos Methods (==) :: SourcePos -> SourcePos -> Bool Source # (/=) :: SourcePos -> SourcePos -> Bool Source #
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 :: (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 #

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 #
Show SourcePos |
Instance details Defined in Text.Parsec.Pos Methods showsPrec :: Int -> SourcePos -> ShowS Source # show :: SourcePos -> String Source # showList :: [SourcePos] -> ShowS Source #

getPosition :: Monad m => ParsecT s u m SourcePos Source #

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

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

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

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.

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

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

type Line = Int Source #

type Column = Int Source #