Distribution.Deprecated.ReadP

cabal-install-3.12.1.0: The command-line interface for Cabal and Hackage.

Copyright | (c) The University of Glasgow 2002
License | BSD-style (see the file libraries/base/LICENSE)
Maintainer | libraries@haskell.org
Portability | portable
Safe Haskell | None
Language | Haskell2010

Distribution.Deprecated.ReadP

Contents

- The `ReadP` type
- Primitive operations
- Other operations
- Running a parser
  - Internal

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

See also Koen's paper Parallel Parsing Processes (http://citeseerx.ist.psu.edu/viewdoc/summary?doi=10.1.1.19.9217).

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.Deprecated.ReadP, by Mark Lentczner mailto:mark@glyphic.com

Synopsis

- type ReadP r a = Parser r Char a
- get :: ReadP r Char
- look :: ReadP r String
- (+++) :: ReadP r a -> ReadP r a -> ReadP r a
- (<++) :: ReadP a a -> ReadP r a -> ReadP r a
- gather :: ReadP (String -> P Char r) a -> ReadP r (String, a)
- pfail :: ReadP r a
- eof :: ReadP r ()
- satisfy :: (Char -> Bool) -> ReadP r Char
- char :: Char -> ReadP r Char
- string :: String -> ReadP r String
- munch :: (Char -> Bool) -> ReadP r String
- munch1 :: (Char -> Bool) -> ReadP r String
- skipSpaces :: ReadP r ()
- skipSpaces1 :: ReadP r ()
- choice :: [ReadP r a] -> ReadP r a
- count :: Int -> ReadP r a -> ReadP r [a]
- between :: ReadP r open -> ReadP r close -> ReadP r a -> ReadP r a
- option :: a -> ReadP r a -> ReadP r a
- optional :: ReadP r a -> ReadP r ()
- many :: ReadP r a -> ReadP r [a]
- many1 :: ReadP r a -> ReadP r [a]
- skipMany :: ReadP r a -> ReadP r ()
- skipMany1 :: ReadP r a -> ReadP r ()
- sepBy :: ReadP r a -> ReadP r sep -> ReadP r [a]
- sepBy1 :: ReadP r a -> ReadP r sep -> ReadP r [a]
- endBy :: ReadP r a -> ReadP r sep -> ReadP r [a]
- endBy1 :: ReadP r a -> ReadP r sep -> ReadP r [a]
- chainr :: ReadP r a -> ReadP r (a -> a -> a) -> a -> ReadP r a
- chainl :: ReadP r a -> ReadP r (a -> a -> a) -> a -> ReadP r a
- chainl1 :: ReadP r a -> ReadP r (a -> a -> a) -> ReadP r a
- chainr1 :: ReadP r a -> ReadP r (a -> a -> a) -> ReadP r a
- manyTill :: ReadP r a -> ReadP [a] end -> ReadP r [a]
- type ReadS a = String -> [(a, String)]
- readP_to_S :: ReadP a a -> ReadS a
- readS_to_P :: ReadS a -> ReadP r a
- readP_to_E :: (String -> String) -> ReadP a a -> ReadE a
- data Parser r s a

# The `ReadP` type

type ReadP r a = Parser r Char a #

# Primitive operations

get :: ReadP r Char #

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

look :: ReadP r String #

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 #

Symmetric choice.

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

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.

string :: String -> ReadP r String #

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.

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

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 :: ReadP r open -> ReadP r close -> ReadP r a -> ReadP r a #

`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 :: ReadP r a -> ReadP r () #

`optional p` optionally parses `p` and always returns `()`.

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

Parses zero or more occurrences of the given parser.

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

Parses one or more occurrences of the given parser.

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

Like `many`, but discards the result.

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

Like `many1`, but discards the result.

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

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

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

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

`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 :: ReadP r a -> ReadP [a] end -> ReadP r [a] #

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

readP_to_S :: ReadP a a -> ReadS a #

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 #

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

readP_to_E :: (String -> String) -> ReadP a a -> ReadE a #

## Internal

data Parser r s a #

#### Instances

Instances details

s ~ Char => Alternative (Parser r s) # |
Instance details Defined in Distribution.Deprecated.ReadP Methods empty :: 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] #
Applicative (Parser r s) # |
Instance details Defined in Distribution.Deprecated.ReadP Methods pure :: 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 #
Functor (Parser r s) # |
Instance details Defined in Distribution.Deprecated.ReadP Methods fmap :: (a -> b) -> Parser r s a -> Parser r s b # (<$) :: a -> Parser r s b -> Parser r s a #
Monad (Parser r s) # |
Instance details Defined in Distribution.Deprecated.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 #
s ~ Char => MonadPlus (Parser r s) # |
Instance details Defined in Distribution.Deprecated.ReadP Methods mzero :: Parser r s a # mplus :: Parser r s a -> Parser r s a -> Parser r s a #
MonadFail (Parser r s) # |
Instance details Defined in Distribution.Deprecated.ReadP Methods fail :: String -> Parser r s a #