pandoc-3.1.4: Conversion between markup formats
CopyrightCopyright (C) 2006-2023 John MacFarlane
LicenseGNU GPL, version 2 or above
MaintainerJohn MacFarlane <jgm@berkeley.edu>
Stabilityalpha
Portabilityportable
Safe HaskellSafe-Inferred
LanguageHaskell2010

Text.Pandoc.Parsing

Description

A utility library with parsers used in pandoc readers.

Synopsis

Documentation

countChar :: (Stream s m Char, UpdateSourcePos s Char, Monad m) => Int -> ParsecT s st m Char -> ParsecT s st m Text Source #

Like count, but packs its result

textStr :: (Stream s m Char, UpdateSourcePos s Char) => Text -> ParsecT s u m Text Source #

Like string, but uses Text.

anyLine :: Monad m => ParsecT Sources st m Text Source #

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

anyLineNewline :: Monad m => ParsecT Sources st m Text Source #

Parse any line, include the final newline in the output

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

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

manyChar :: Stream s m t => ParsecT s st m Char -> ParsecT s st m Text Source #

Like many, but packs its result.

many1Char :: Stream s m t => ParsecT s st m Char -> ParsecT s st m Text Source #

Like many1, but packs its result.

manyTillChar :: Stream s m t => ParsecT s st m Char -> ParsecT s st m a -> ParsecT s st m Text Source #

Like manyTill, but packs its result.

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

Like many1Till, but packs its result

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

Like manyTill, but reads at least one item.

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

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

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

Like manyUntil, but also packs its result.

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

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

notFollowedBy' :: (Show b, Stream s m a) => 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 :: (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 :: (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 :: (Stream s m Char, UpdateSourcePos s Char) => ParsecT s st m Char Source #

Parses a space or tab.

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

Parses a nonspace, nonnewline character.

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

Skips zero or more spaces or tabs.

blankline :: (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 :: (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 :: (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 :: (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

:: (Show end, Stream s m Char, UpdateSourcePos s Char) 
=> ParsecT s st m t

start parser

-> ParsecT s st m end

end parser

-> ParsecT s st m a

content parser (to be used repeatedly)

-> ParsecT s st m [a] 

Parses material enclosed between start and end parsers.

stringAnyCase :: (Stream s m Char, UpdateSourcePos s Char) => Text -> ParsecT s st m Text Source #

Parse string, case insensitive.

parseFromString :: Monad m => ParsecT Sources st m r -> Text -> ParsecT Sources st m r Source #

Parse contents of str using parser and return result.

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

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

lineClump :: Monad m => ParsecT Sources st m Text Source #

Parse raw line block up to and including blank lines.

charsInBalanced :: (Stream s m Char, UpdateSourcePos s Char) => Char -> Char -> 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 '(' ')' anyChar will parse "(hello (there))" and return "hello (there)".

romanNumeral Source #

Arguments

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

withHorizDisplacement Source #

Arguments

:: (Stream s m Char, UpdateSourcePos s Char) 
=> ParsecT s st m a

Parsec to apply

-> ParsecT s st m (a, Int)

(result, displacement)

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

withRaw :: Monad m => ParsecT Sources st m a -> ParsecT Sources st m (a, Text) 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, UpdateSourcePos s Char) 
=> ParsecT s st m Char

Parsec for character to escape

-> ParsecT s st m Char 

Parses backslash, then applies character parser.

characterReference :: (Stream s m Char, UpdateSourcePos s Char) => ParsecT s st m Text Source #

Parse character entity.

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

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

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

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

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

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

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

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

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

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

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

Parses an ordered list marker and returns list attributes.

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

Parses a character reference and returns a Str element.

lineBlockLines :: Monad m => ParsecT Sources st m [Text] Source #

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

tableWith Source #

Arguments

:: (Stream s m Char, UpdateSourcePos s Char, HasReaderOptions st, Monad mf) 
=> ParsecT s st m (mf [Blocks], [Alignment], [Int])

header parser

-> ([Int] -> ParsecT s st m (mf [Blocks]))

row parser

-> ParsecT s st m sep

line parser

-> ParsecT s st m end

footer parser

-> ParsecT s st m (mf Blocks) 

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

tableWith' Source #

Arguments

:: (Stream s m Char, UpdateSourcePos s Char, HasReaderOptions st, Monad mf) 
=> TableNormalization 
-> ParsecT s st m (mf [Blocks], [Alignment], [Int])

header parser

-> ([Int] -> ParsecT s st m (mf [Blocks]))

row parser

-> ParsecT s st m sep

line parser

-> ParsecT s st m end

footer parser

-> ParsecT s st m (mf TableComponents) 

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

Calculate relative widths of table columns, based on indices

gridTableWith Source #

Arguments

:: (Monad m, Monad mf, HasLastStrPosition st, HasReaderOptions st) 
=> ParsecT Sources st m (mf Blocks)

Block list parser

-> ParsecT Sources st m (mf Blocks) 

Parse a grid table: starts with row of - on top, then header (which may be grid), then the rows, which may be grid, separated by blank lines, and ending with a footer (dashed line followed by blank line).

gridTableWith' Source #

Arguments

:: (Monad m, Monad mf, HasReaderOptions st, HasLastStrPosition st) 
=> TableNormalization 
-> ParsecT Sources st m (mf Blocks)

Block list parser

-> ParsecT Sources st m (mf TableComponents) 

Like gridTableWith, but returns TableComponents instead of a Table.

data TableComponents Source #

Collection of components making up a Table block.

data TableNormalization Source #

Whether the table header should be normalized, i.e., whether an header row with only empty cells should be omitted.

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 :: (Stream s m a, HasReaderOptions st) => Extension -> ParsecT s st m () Source #

Succeed only if the extension is enabled.

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

Succeed only if the extension is disabled.

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

Update the position on which the last string ended.

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

Whether we are right after the end of a string.

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

Add a log message.

reportLogMessages :: (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

Instances

Instances details
Default ParserState Source # 
Instance details

Defined in Text.Pandoc.Parsing.State

Methods

def :: ParserState #

HasIdentifierList ParserState Source # 
Instance details

Defined in Text.Pandoc.Parsing.State

HasIncludeFiles ParserState Source # 
Instance details

Defined in Text.Pandoc.Parsing.State

HasLastStrPosition ParserState Source # 
Instance details

Defined in Text.Pandoc.Parsing.State

HasLogMessages ParserState Source # 
Instance details

Defined in Text.Pandoc.Parsing.State

HasMacros ParserState Source # 
Instance details

Defined in Text.Pandoc.Parsing.State

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

Monad m => HasQuoteContext ParserState m Source # 
Instance details

Defined in Text.Pandoc.Parsing.State

class HasReaderOptions st where Source #

Minimal complete definition

extractReaderOptions

Methods

extractReaderOptions :: st -> ReaderOptions Source #

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

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

Eq HeaderType Source # 
Instance details

Defined in Text.Pandoc.Parsing.State

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

Eq ParserContext Source # 
Instance details

Defined in Text.Pandoc.Parsing.State

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

class HasQuoteContext st m where Source #

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

newtype Key Source #

Constructors

Key Text 

Instances

Instances details
Read Key Source # 
Instance details

Defined in Text.Pandoc.Parsing.State

Show Key Source # 
Instance details

Defined in Text.Pandoc.Parsing.State

Methods

showsPrec :: Int -> Key -> ShowS #

show :: Key -> String #

showList :: [Key] -> ShowS #

Eq Key Source # 
Instance details

Defined in Text.Pandoc.Parsing.State

Methods

(==) :: Key -> Key -> Bool #

(/=) :: Key -> Key -> Bool #

Ord Key Source # 
Instance details

Defined in Text.Pandoc.Parsing.State

Methods

compare :: Key -> Key -> Ordering #

(<) :: Key -> Key -> Bool #

(<=) :: Key -> Key -> Bool #

(>) :: Key -> Key -> Bool #

(>=) :: Key -> Key -> Bool #

max :: Key -> Key -> Key #

min :: Key -> Key -> Key #

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

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

Parses a closing quote character.

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

Parses three dots as HORIZONTAL ELLIPSIS.

dash :: (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

:: (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 #

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

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 #

catchError :: ParsecT s u m a -> (e -> ParsecT s u m a) -> ParsecT s u m a #

MonadReader r m => MonadReader r (ParsecT s u m) 
Instance details

Defined in Text.Parsec.Prim

Methods

ask :: ParsecT s u m r #

local :: (r -> r) -> ParsecT s u m a -> ParsecT s u m a #

reader :: (r -> a) -> ParsecT s u m a #

MonadState s m => MonadState s (ParsecT s' u m) 
Instance details

Defined in Text.Parsec.Prim

Methods

get :: ParsecT s' u m s #

put :: s -> ParsecT s' u m () #

state :: (s -> (a, s)) -> ParsecT s' u m a #

MonadTrans (ParsecT s u) 
Instance details

Defined in Text.Parsec.Prim

Methods

lift :: Monad m => m a -> ParsecT s u m a #

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 #

MonadIO m => MonadIO (ParsecT s u m) 
Instance details

Defined in Text.Parsec.Prim

Methods

liftIO :: IO a -> ParsecT s u m a #

Alternative (ParsecT s u m) 
Instance details

Defined in Text.Parsec.Prim

Methods

empty :: ParsecT s u m a #

(<|>) :: ParsecT s u m a -> ParsecT s u m a -> ParsecT s u m a #

some :: ParsecT s u m a -> ParsecT s u m [a] #

many :: ParsecT s u m a -> ParsecT s u m [a] #

Applicative (ParsecT s u m) 
Instance details

Defined in Text.Parsec.Prim

Methods

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

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

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

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

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

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 #

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

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 #

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

return :: a -> ParsecT s u m a #

MonadPlus (ParsecT s u m) 
Instance details

Defined in Text.Parsec.Prim

Methods

mzero :: ParsecT s u m a #

mplus :: ParsecT s u m a -> ParsecT s u m a -> ParsecT s u m a #

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 #

PandocMonad m => PandocMonad (ParsecT s st m) Source # 
Instance details

Defined in Text.Pandoc.Class.PandocMonad

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

mappend :: ParsecT s u m a -> ParsecT s u m a -> ParsecT s u m a #

mconcat :: [ParsecT s u m a] -> ParsecT s u m a #

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 #

sconcat :: NonEmpty (ParsecT s u m a) -> ParsecT s u m a #

stimes :: Integral b => b -> ParsecT s u m a -> ParsecT s u m a #

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

Instances

Instances details
Applicative (Future s) Source # 
Instance details

Defined in Text.Pandoc.Parsing.Future

Methods

pure :: a -> Future s a #

(<*>) :: Future s (a -> b) -> Future s a -> Future s b #

liftA2 :: (a -> b -> c) -> Future s a -> Future s b -> Future s c #

(*>) :: Future s a -> Future s b -> Future s b #

(<*) :: Future s a -> Future s b -> Future s a #

Functor (Future s) Source # 
Instance details

Defined in Text.Pandoc.Parsing.Future

Methods

fmap :: (a -> b) -> Future s a -> Future s b #

(<$) :: a -> Future s b -> Future s a #

Monad (Future s) Source # 
Instance details

Defined in Text.Pandoc.Parsing.Future

Methods

(>>=) :: Future s a -> (a -> Future s b) -> Future s b #

(>>) :: Future s a -> Future s b -> Future s b #

return :: a -> Future s a #

(Semigroup a, Monoid a) => Monoid (Future s a) Source # 
Instance details

Defined in Text.Pandoc.Parsing.Future

Methods

mempty :: Future s a #

mappend :: Future s a -> Future s a -> Future s a #

mconcat :: [Future s a] -> Future s a #

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 #

sconcat :: NonEmpty (Future s a) -> Future s a #

stimes :: Integral b => b -> Future s a -> Future s a #

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

Run a delayed action with the given state.

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 :: Stream s m t => (t -> Text) -> (t -> SourcePos) -> (t -> Maybe a) -> ParsecT s st m a Source #

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

insertIncludedFile Source #

Arguments

:: (PandocMonad m, HasIncludeFiles st) 
=> ParsecT a st m b

parser to apply

-> (Text -> a)

convert Text to stream type

-> [FilePath]

search path (directories)

-> FilePath

path of file to include

-> Maybe Int

start line (negative counts from end)

-> Maybe Int

end line (negative counts from end)

-> ParsecT a st m b 

Re-exports from Text.Parsec

class Monad m => Stream s (m :: Type -> Type) t | s -> t where #

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

Instances

Instances details
Monad m => Stream ByteString m Char 
Instance details

Defined in Text.Parsec.Prim

Methods

uncons :: ByteString -> m (Maybe (Char, ByteString)) #

Monad m => Stream ByteString m Char 
Instance details

Defined in Text.Parsec.Prim

Methods

uncons :: ByteString -> m (Maybe (Char, ByteString)) #

Monad m => Stream Sources m Char Source # 
Instance details

Defined in Text.Pandoc.Sources

Methods

uncons :: Sources -> m (Maybe (Char, Sources)) #

Monad m => Stream Text m Char 
Instance details

Defined in Text.Parsec.Prim

Methods

uncons :: Text -> m (Maybe (Char, Text)) #

Monad m => Stream Text m Char 
Instance details

Defined in Text.Parsec.Prim

Methods

uncons :: Text -> m (Maybe (Char, Text)) #

Monad m => Stream [tok] m tok 
Instance details

Defined in Text.Parsec.Prim

Methods

uncons :: [tok] -> m (Maybe (tok, [tok])) #

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

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

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 #

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 #

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 #

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 #

Returns the current input

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

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 #

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

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

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

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

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 #

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

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

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

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 (m :: Type -> Type) t u a. Stream s m t => ParsecT s u m a -> ParsecT s u m [a] #

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

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 #

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 #

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 #

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 #

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

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

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

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

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

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

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 #

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

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

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 #

Returns the current user state.

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

An alias for putState for backwards compatibility.

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

An alias for modifyState for backwards compatibility.

data SourcePos #

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 #

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

toConstr :: SourcePos -> Constr #

dataTypeOf :: SourcePos -> DataType #

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

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

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

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

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

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

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

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

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

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

Show SourcePos 
Instance details

Defined in Text.Parsec.Pos

Eq SourcePos 
Instance details

Defined in Text.Parsec.Pos

Ord SourcePos 
Instance details

Defined in Text.Parsec.Pos

updatePosString :: SourcePos -> String -> SourcePos #

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 #

Returns the current source position. See also SourcePos.

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

setPosition pos sets the current source position to pos.

sourceName :: SourcePos -> SourceName #

Extracts the name of the source from a source position.

setSourceName :: SourcePos -> SourceName -> SourcePos #

Set the name of the source.

sourceColumn :: SourcePos -> Column #

Extracts the column number from a source position.

sourceLine :: SourcePos -> Line #

Extracts the line number from a source position.

setSourceColumn :: SourcePos -> Column -> SourcePos #

Set the column number of a source position.

setSourceLine :: SourcePos -> Line -> SourcePos #

Set the line number of a source position.

incSourceColumn :: SourcePos -> Column -> SourcePos #

Increments the column number of a source position.

incSourceLine :: SourcePos -> Line -> SourcePos #

Increments the line number of a source position.

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

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

initialPos :: SourceName -> SourcePos #

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

type Line = Int #

type Column = Int #

data ParseError #

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
Show ParseError 
Instance details

Defined in Text.Parsec.Error

Eq ParseError 
Instance details

Defined in Text.Parsec.Error

errorMessages :: ParseError -> [Message] #

Extracts the list of error messages from the parse error

messageString :: Message -> String #

Extract the message string from an error message