Safe Haskell	None
Language	Haskell2010

Documentation.Haddock.Parser.Monad

Synopsis

Documentation

newtype ParserState Source #

Constructors

ParserState
Fields parserStateSince :: Maybe Version

Instances

Eq ParserState Source #
Methods (==) :: ParserState -> ParserState -> Bool # (/=) :: ParserState -> ParserState -> Bool #
Show ParserState Source #
Methods showsPrec :: Int -> ParserState -> ShowS # show :: ParserState -> String # showList :: [ParserState] -> ShowS #

initialParserState :: ParserState Source #

newtype Parser a Source #

Constructors

Parser (StateT ParserState Parser a)

Instances

Monad Parser Source #
Methods (>>=) :: Parser a -> (a -> Parser b) -> Parser b # (>>) :: Parser a -> Parser b -> Parser b # return :: a -> Parser a # fail :: String -> Parser a #
Functor Parser Source #
Methods fmap :: (a -> b) -> Parser a -> Parser b # (<$) :: a -> Parser b -> Parser a #
Applicative Parser Source #
Methods pure :: a -> Parser a # (<>) :: Parser (a -> b) -> Parser a -> Parser b # (>) :: Parser a -> Parser b -> Parser b # (<*) :: Parser a -> Parser b -> Parser a #
Alternative Parser Source #
Methods empty :: Parser a # (<\|>) :: Parser a -> Parser a -> Parser a # some :: Parser a -> Parser [a] # many :: Parser a -> Parser [a] #
MonadPlus Parser Source #
Methods mzero :: Parser a # mplus :: Parser a -> Parser a -> Parser a #
(~) * a ByteString => IsString (Parser a) Source #
Methods fromString :: String -> Parser a #

parseOnly :: Parser a -> ByteString -> Either String (ParserState, a) Source #

lift :: Parser a -> Parser a Source #

setParserState :: ParserState -> Parser () Source #

setSince :: Version -> Parser () Source #

char :: Char -> Parser Char Source #

char8 :: Char -> Parser Word8 Source #

anyChar :: Parser Char Source #

notChar :: Char -> Parser Char Source #

satisfy :: (Char -> Bool) -> Parser Char Source #

peekChar :: Parser (Maybe Char) Source #

peekChar' :: Parser Char Source #

digit :: Parser Char Source #

letter_iso8859_15 :: Parser Char Source #

letter_ascii :: Parser Char Source #

space :: Parser Char Source #

string :: ByteString -> Parser ByteString Source #

stringCI :: ByteString -> Parser ByteString Source #

skipSpace :: Parser () Source #

skipWhile :: (Char -> Bool) -> Parser () Source #

take :: Int -> Parser ByteString Source #

scan :: s -> (s -> Char -> Maybe s) -> Parser ByteString Source #

takeWhile :: (Char -> Bool) -> Parser ByteString Source #

takeWhile1 :: (Char -> Bool) -> Parser ByteString Source #

takeTill :: (Char -> Bool) -> Parser ByteString Source #

takeByteString :: Parser ByteString Source #

takeLazyByteString :: Parser ByteString Source #

endOfLine :: Parser () Source #

decimal :: Integral a => Parser a Source #

hexadecimal :: (Integral a, Bits a) => Parser a Source #

endOfInput :: Parser () Source #

atEnd :: Parser Bool Source #

isDigit :: Char -> Bool Source #

A fast digit predicate.

isDigit_w8 :: Word8 -> Bool Source #

A fast digit predicate.

isAlpha_iso8859_15 :: Char -> Bool Source #

A fast alphabetic predicate for the ISO-8859-15 encoding

Note: For all character encodings other than ISO-8859-15, and almost all Unicode code points above U+00A3, this predicate gives wrong answers.

isAlpha_ascii :: Char -> Bool Source #

A fast alphabetic predicate for the ASCII encoding

Note: For all character encodings other than ASCII, and almost all Unicode code points above U+007F, this predicate gives wrong answers.

isSpace :: Char -> Bool Source #

Fast predicate for matching ASCII space characters.

Note: This predicate only gives correct answers for the ASCII encoding. For instance, it does not recognise U+00A0 (non-breaking space) as a space character, even though it is a valid ISO-8859-15 byte. For a Unicode-aware and only slightly slower predicate, use isSpace

isSpace_w8 :: Word8 -> Bool Source #

Fast Word8 predicate for matching ASCII space characters.

inClass :: String -> Char -> Bool Source #

Match any character in a set.

vowel = inClass "aeiou"

Range notation is supported.

halfAlphabet = inClass "a-nA-N"

To add a literal '-' to a set, place it at the beginning or end of the string.

notInClass :: String -> Char -> Bool Source #

Match any character not in a set.

isEndOfLine :: Word8 -> Bool Source #

A predicate that matches either a carriage return '\r' or newline '\n' character.

isHorizontalSpace :: Word8 -> Bool Source #

A predicate that matches either a space ' ' or horizontal tab '\t' character.

choice :: Alternative f => [f a] -> f a Source #

choice ps tries to apply the actions in the list ps in order, until one of them succeeds. Returns the value of the succeeding action.

count :: Monad m => Int -> m a -> m [a] Source #

Apply the given action repeatedly, returning every result.

option :: Alternative f => a -> f a -> f a Source #

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

priority  = option 0 (digitToInt <$> digit)

many' :: MonadPlus m => m a -> m [a] Source #

many' p applies the action p zero or more times. Returns a list of the returned values of p. The value returned by p is forced to WHNF.

 word  = many' letter

many1 :: Alternative f => f a -> f [a] Source #

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

 word  = many1 letter

many1' :: MonadPlus m => m a -> m [a] Source #

many1' p applies the action p one or more times. Returns a list of the returned values of p. The value returned by p is forced to WHNF.

 word  = many1' letter

manyTill :: Alternative f => f a -> f b -> f [a] Source #

manyTill p end applies action p zero or more times until action end succeeds, and returns the list of values returned by p. This can be used to scan comments:

 simpleComment   = string "<!--" *> manyTill anyChar (string "-->")

(Note the overlapping parsers anyChar and string "-->". While this will work, it is not very efficient, as it will cause a lot of backtracking.)

manyTill' :: MonadPlus m => m a -> m b -> m [a] Source #

manyTill' p end applies action p zero or more times until action end succeeds, and returns the list of values returned by p. This can be used to scan comments:

 simpleComment   = string "<!--" *> manyTill' anyChar (string "-->")

(Note the overlapping parsers anyChar and string "-->". While this will work, it is not very efficient, as it will cause a lot of backtracking.)

The value returned by p is forced to WHNF.

sepBy :: Alternative f => f a -> f s -> f [a] Source #

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

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

sepBy' :: MonadPlus m => m a -> m s -> m [a] Source #

sepBy' p sep applies zero or more occurrences of p, separated by sep. Returns a list of the values returned by p. The value returned by p is forced to WHNF.

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

sepBy1 :: Alternative f => f a -> f s -> f [a] Source #

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

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

sepBy1' :: MonadPlus m => m a -> m s -> m [a] Source #

sepBy1' p sep applies one or more occurrences of p, separated by sep. Returns a list of the values returned by p. The value returned by p is forced to WHNF.

commaSep p  = p `sepBy1'` (symbol ",")

skipMany :: Alternative f => f a -> f () Source #

Skip zero or more instances of an action.

skipMany1 :: Alternative f => f a -> f () Source #

Skip one or more instances of an action.

eitherP :: Alternative f => f a -> f b -> f (Either a b) Source #

Combine two alternatives.