Cabal-2.4.0.1: A framework for packaging Haskell software

Description

This is a library of parser combinators, originally written by Koen Claessen. It parses all alternatives in parallel, so it never keeps hold of the beginning of the input string, a common source of space leaks with other parsers. The '(+++)' choice combinator is genuinely commutative; it makes no difference which branch is "shorter".

This version of ReadP has been locally hacked to make it H98, by Martin Sjögren mailto:msjogren@gmail.com

The unit tests have been moved to UnitTest.Distribution.Compat.ReadP, by Mark Lentczner mailto:mark@glyphic.com

Synopsis

# The ReadP type

type ReadP r a = Parser r Char a #

# Primitive operations

Consumes and returns the next character. Fails if there is no input left.

Look-ahead: returns the part of the input that is left, without consuming it.

Symmetric choice.

Local, exclusive, left-biased choice: If left parser locally produces any result at all, then right parser is not used.

gather :: ReadP (String -> P Char r) a -> ReadP r (String, a) #

Transforms a parser into one that does the same, but in addition returns the exact characters read. IMPORTANT NOTE: gather gives a runtime error if its first argument is built using any occurrences of readS_to_P.

# Other operations

pfail :: ReadP r a #

Always fails.

eof :: ReadP r () #

Succeeds iff we are at the end of input

satisfy :: (Char -> Bool) -> ReadP r Char #

Consumes and returns the next character, if it satisfies the specified predicate.

char :: Char -> ReadP r Char #

Parses and returns the specified character.

Parses and returns the specified string.

munch :: (Char -> Bool) -> ReadP r String #

Parses the first zero or more characters satisfying the predicate.

munch1 :: (Char -> Bool) -> ReadP r String #

Parses the first one or more characters satisfying the predicate.

skipSpaces :: ReadP r () #

Skips all whitespace.

skipSpaces1 :: ReadP r () #

Like skipSpaces but succeeds only if there is at least one whitespace character to skip.

Combines all parsers in the specified list.

count :: Int -> ReadP r a -> ReadP r [a] #

 count n p  parses n occurrences of p in sequence. A list of results is returned.

 between open close p  parses open, followed by p and finally close. Only the value of p is returned.

option :: a -> ReadP r a -> ReadP r a #

option x p will either parse p or return x without consuming any input.

optional p optionally parses p and always returns ().

Parses zero or more occurrences of the given parser.

Parses one or more occurrences of the given parser.

Like many, but discards the result.

Like many1, but discards the result.

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

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

endBy p sep parses zero or more occurrences of p, separated and ended by sep.

endBy p sep parses one or more occurrences of p, separated and ended by sep.

chainr :: ReadP r a -> ReadP r (a -> a -> a) -> a -> ReadP r a #

chainr p op x parses zero or more occurrences of p, separated by op. Returns a value produced by a right associative application of all functions returned by op. If there are no occurrences of p, x is returned.

chainl :: ReadP r a -> ReadP r (a -> a -> a) -> a -> ReadP r a #

chainl p op x parses zero or more occurrences of p, separated by op. Returns a value produced by a left associative application of all functions returned by op. If there are no occurrences of p, x is returned.

chainl1 :: ReadP r a -> ReadP r (a -> a -> a) -> ReadP r a #

Like chainl, but parses one or more occurrences of p.

chainr1 :: ReadP r a -> ReadP r (a -> a -> a) -> ReadP r a #

Like chainr, but parses one or more occurrences of p.

manyTill p end parses zero or more occurrences of p, until end succeeds. Returns a list of values returned by p.

# Running a parser

type ReadS a = String -> [(a, String)] #

A parser for a type a, represented as a function that takes a String and returns a list of possible parses as (a,String) pairs.

Note that this kind of backtracking parser is very inefficient; reading a large structure may be quite slow (cf ReadP).

Converts a parser into a Haskell ReadS-style function. This is the main way in which you can "run" a ReadP parser: the expanded type is  readP_to_S :: ReadP a -> String -> [(a,String)]

Converts a Haskell ReadS-style function into a parser. Warning: This introduces local backtracking in the resulting parser, and therefore a possible inefficiency.

## Internal

data Parser r s a #

Instances
 Monad (Parser r s) # Instance detailsDefined in Distribution.Compat.ReadP Methods(>>=) :: Parser r s a -> (a -> Parser r s b) -> Parser r s b #(>>) :: Parser r s a -> Parser r s b -> Parser r s b #return :: a -> Parser r s a #fail :: String -> Parser r s a # Functor (Parser r s) # Instance detailsDefined in Distribution.Compat.ReadP Methodsfmap :: (a -> b) -> Parser r s a -> Parser r s b #(<\$) :: a -> Parser r s b -> Parser r s a # MonadFail (Parser r s) # Instance detailsDefined in Distribution.Compat.ReadP Methodsfail :: String -> Parser r s a # Applicative (Parser r s) # Instance detailsDefined in Distribution.Compat.ReadP Methodspure :: a -> Parser r s a #(<*>) :: Parser r s (a -> b) -> Parser r s a -> Parser r s b #liftA2 :: (a -> b -> c) -> Parser r s a -> Parser r s b -> Parser r s c #(*>) :: Parser r s a -> Parser r s b -> Parser r s b #(<*) :: Parser r s a -> Parser r s b -> Parser r s a # s ~ Char => Alternative (Parser r s) # Instance detailsDefined in Distribution.Compat.ReadP Methodsempty :: Parser r s a #(<|>) :: Parser r s a -> Parser r s a -> Parser r s a #some :: Parser r s a -> Parser r s [a] #many :: Parser r s a -> Parser r s [a] # s ~ Char => MonadPlus (Parser r s) # Instance detailsDefined in Distribution.Compat.ReadP Methodsmzero :: Parser r s a #mplus :: Parser r s a -> Parser r s a -> Parser r s a # t ~ Char => Parsing (Parser r t) # Instance detailsDefined in Distribution.Compat.Parsing Methodstry :: Parser r t a -> Parser r t a #() :: Parser r t a -> String -> Parser r t a #skipMany :: Parser r t a -> Parser r t () #skipSome :: Parser r t a -> Parser r t () #unexpected :: String -> Parser r t a #eof :: Parser r t () #notFollowedBy :: Show a => Parser r t a -> Parser r t () # t ~ Char => CharParsing (Parser r t) # Instance detailsDefined in Distribution.Compat.CharParsing Methodssatisfy :: (Char -> Bool) -> Parser r t Char #char :: Char -> Parser r t Char #notChar :: Char -> Parser r t Char #anyChar :: Parser r t Char #string :: String -> Parser r t String #text :: Text -> Parser r t Text # t ~ Char => CabalParsing (Parser r t) # Instance detailsDefined in Distribution.Parsec.Class MethodsparsecWarning :: PWarnType -> String -> Parser r t () #