Text.Pandoc.Parsing

A utility library with parsers used in pandoc readers.

Documentation

(>>~) :: Monad m => m a -> m b -> m a

Like >>, but returns the operation on the left. (Suggested by Tillmann Rendel on Haskell-cafe list.)

anyLine :: Parser [Char] st [Char]

Parse any line of text

many1Till :: Parser [tok] st a -> Parser [tok] st end -> Parser [tok] st [a]

Like manyTill, but reads at least one item.

notFollowedBy' :: Show b => Parser [a] st b -> Parser [a] st ()

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 :: [String] -> Parser [Char] st String

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 :: [String] -> Parser [Char] st String

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

spaceChar :: Parser [Char] st Char

Parses a space or tab.

nonspaceChar :: Parser [Char] st Char

Parses a nonspace, nonnewline character.

skipSpaces :: Parser [Char] st ()

Skips zero or more spaces or tabs.

blankline :: Parser [Char] st Char

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

blanklines :: Parser [Char] st [Char]

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

enclosed

Arguments

:: Parser [Char] st t

start parser

-> Parser [Char] st end

end parser

-> Parser [Char] st a

content parser (to be used repeatedly)

-> Parser [Char] st [a]

Parses material enclosed between start and end parsers.

stringAnyCase :: [Char] -> Parser [Char] st String

Parse string, case insensitive.

parseFromString :: Parser [tok] st a -> [tok] -> Parser [tok] st a

Parse contents of str using parser and return result.

lineClump :: Parser [Char] st String

Parse raw line block up to and including blank lines.

charsInBalanced :: Char -> Char -> Parser [Char] st Char -> Parser [Char] st String

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

Arguments

:: Bool

Uppercase if true

-> Parser [Char] st Int

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

emailAddress :: Parser [Char] st (String, String)

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

uri :: Parser [Char] st (String, String)

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

withHorizDisplacement

Arguments

:: Parser [Char] st a

Parser to apply

-> Parser [Char] st (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 :: Parser [Char] st a -> Parser [Char] st (a, [Char])

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

escaped

Arguments

:: Parser [Char] st Char

Parser for character to escape

-> Parser [Char] st Char

Parses backslash, then applies character parser.

characterReference :: Parser [Char] st Char

Parse character entity.

updateLastStrPos :: Parser [Char] ParserState ()

anyOrderedListMarker :: Parser [Char] ParserState ListAttributes

Parses an ordered list marker and returns list attributes.

orderedListMarker :: ListNumberStyle -> ListNumberDelim -> Parser [Char] ParserState Int

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

charRef :: Parser [Char] st Inline

Parses a character reference and returns a Str element.

lineBlockLines :: Parser [Char] st [String]

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

tableWith :: Parser [Char] ParserState ([[Block]], [Alignment], [Int]) -> ([Int] -> Parser [Char] ParserState [[Block]]) -> Parser [Char] ParserState sep -> Parser [Char] ParserState end -> Parser [Char] ParserState Block

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

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

gridTableWith

Arguments

:: Parser [Char] ParserState [Block]

Block list parser

-> Bool

Headerless table

-> Parser [Char] ParserState Block

readWith

Arguments

:: Parser [t] ParserState a

parser

-> ParserState

initial state

-> [t]

input

-> a

Parse a string with a given parser and state.

testStringWith :: Show a => Parser [Char] ParserState a -> String -> IO ()

Parse a string with parser (for testing).

getOption :: (ReaderOptions -> a) -> Parser s ParserState a

guardEnabled :: Extension -> Parser s ParserState ()

Succeed only if the extension is enabled.

guardDisabled :: Extension -> Parser s ParserState ()

Succeed only if the extension is disabled.

data ParserState

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 (with fallbacks)

stateSubstitutions :: SubstTable

List of substitution references

stateNotes :: NoteTable

List of notes (raw bodies)

stateNotes' :: NoteTable'

List of notes (parsed bodies)

stateTitle :: [Inline]

Title of document

stateAuthors :: [[Inline]]

Authors of document

stateDate :: [Inline]

Date of document

stateHeaderTable :: [HeaderType]

Ordered list of header types used

stateHeaders :: [[Inline]]

List of headers (used for implicit ref links)

stateIdentifiers :: [String]

List of header identifiers used

stateNextExample :: Int

Number of next example

stateExamples :: Map String Int

Map from example labels to numbers

stateHasChapters :: Bool

True if chapter encountered

stateMacros :: [Macro]

List of macros defined so far

stateRstDefaultRole :: String

Current rST default interpreted text role

stateWarnings :: [String]

Warnings generated by the parser

Instances

Default ParserState

defaultParserState :: ParserState

data HeaderType

Constructors

SingleHeader Char

Single line of characters underneath

DoubleHeader Char

Lines of characters above and below

Instances

Eq HeaderType

Show HeaderType

data ParserContext

Constructors

ListItemState

Used when running parser on list item contents

NullState

Default state

Instances

Eq ParserContext

Show ParserContext

data QuoteContext

Constructors

InSingleQuote

Used when parsing inside single quotes

InDoubleQuote

Used when parsing inside double quotes

NoQuote

Used when not parsing inside quotes

Instances

Eq QuoteContext

Show QuoteContext

type NoteTable = [(String, String)]

type NoteTable' = [(String, F Blocks)]

type KeyTable = Map Key Target

type SubstTable = Map Key Inlines

newtype Key

Constructors

Key String

Instances

Eq Key

Ord Key

Read Key

Show Key

toKey :: String -> Key

smartPunctuation :: Parser [Char] ParserState Inline -> Parser [Char] ParserState Inline

withQuoteContext :: QuoteContext -> Parser [tok] ParserState a -> Parser [tok] ParserState a

singleQuoteStart :: Parser [Char] ParserState ()

singleQuoteEnd :: Parser [Char] st ()

doubleQuoteStart :: Parser [Char] ParserState ()

doubleQuoteEnd :: Parser [Char] st ()

ellipses :: Parser [Char] st Inline

apostrophe :: Parser [Char] ParserState Inline

dash :: Parser [Char] ParserState Inline

nested :: Parser s ParserState a -> Parser s ParserState a

macro :: Parser [Char] ParserState Blocks

Parse a newcommand or renewcommand macro definition.

applyMacros' :: String -> Parser [Char] ParserState String

Apply current macros to string.

type Parser t s = Parsec t s

newtype F a

Constructors

F

Fields

unF :: Reader ParserState a

Instances

Monad F

Functor F

Monoid a => Monoid (F a)

runF :: F a -> ParserState -> a

askF :: F ParserState

asksF :: (ParserState -> a) -> F a

Re-exports from Text.Pandoc.Parsec

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

parse :: Stream s Identity t => Parsec s () a -> SourceName -> s -> Either ParseError 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

Instances

Eq SourcePos

Data SourcePos

Ord SourcePos

Show SourcePos

Typeable SourcePos

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

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

sourceColumn :: SourcePos -> Column

sourceLine :: SourcePos -> Line

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

token :: Stream s Identity t => (t -> String) -> (t -> SourcePos) -> (t -> Maybe a) -> Parsec s u a