Cabal-1.18.1.3: A framework for packaging Haskell software

Copyright(c) The University of Glasgow 2002
LicenseBSD-style (see the file libraries/base/LICENSE)
Maintainer[email protected]
Portabilityportable
Safe HaskellSafe-Inferred
LanguageHaskell98

Distribution.Compat.ReadP

Contents

Description

Synopsis

The ReadP type

type ReadP r a = Parser r Char a Source

Primitive operations

get :: ReadP r Char Source

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

look :: ReadP r String Source

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

(+++) :: ReadP r a -> ReadP r a -> ReadP r a infixr 5 Source

Symmetric choice.

(<++) :: ReadP a a -> ReadP r a -> ReadP r a infixr 5 Source

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

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 Source

Always fails.

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

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

char :: Char -> ReadP r Char Source

Parses and returns the specified character.

string :: String -> ReadP r String Source

Parses and returns the specified string.

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

Parses the first zero or more characters satisfying the predicate.

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

Parses the first one or more characters satisfying the predicate.

skipSpaces :: ReadP r () Source

Skips all whitespace.

choice :: [ReadP r a] -> ReadP r a Source

Combines all parsers in the specified list.

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

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

between :: ReadP r open -> ReadP r close -> ReadP r a -> ReadP r a Source

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 Source

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

optional :: ReadP r a -> ReadP r () Source

optional p optionally parses p and always returns ().

many :: ReadP r a -> ReadP r [a] Source

Parses zero or more occurrences of the given parser.

many1 :: ReadP r a -> ReadP r [a] Source

Parses one or more occurrences of the given parser.

skipMany :: ReadP r a -> ReadP r () Source

Like many, but discards the result.

skipMany1 :: ReadP r a -> ReadP r () Source

Like many1, but discards the result.

sepBy :: ReadP r a -> ReadP r sep -> ReadP r [a] Source

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

sepBy1 :: ReadP r a -> ReadP r sep -> ReadP r [a] Source

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

endBy :: ReadP r a -> ReadP r sep -> ReadP r [a] Source

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

endBy1 :: ReadP r a -> ReadP r sep -> ReadP r [a] Source

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 Source

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 Source

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 Source

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

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

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

manyTill :: ReadP r a -> ReadP [a] end -> ReadP r [a] Source

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)] Source

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

readP_to_S :: ReadP a a -> ReadS a Source

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

readS_to_P :: ReadS a -> ReadP r a Source

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