polyparse-1.13: A variety of alternative parser combinator libraries.

Safe Haskell | Safe-Inferred
Language | Haskell98

Text.ParserCombinators.Poly.Parser

Contents

- The Parser datatype
  - Basic parsers
  - Re-parsing

Description

This module contains the definitions for a generic parser, without running state. These are the parts that are shared between the Plain and Lazy variations. Do not import this module directly, but only via T.P.Poly.Plain or T.P.Poly.Lazy.

Synopsis

- newtype Parser t a = P ([t] -> Result [t] a)
- data Result z a
  - = Success z a
  - | Failure z String
  - | Committed (Result z a)
- next :: Parser t t
- eof :: Parser t ()
- satisfy :: (t -> Bool) -> Parser t t
- satisfyMsg :: Show t => (t -> Bool) -> String -> Parser t t
- onFail :: Parser t a -> Parser t a -> Parser t a
- reparse :: [t] -> Parser t ()

# The Parser datatype

newtype Parser t a #

This `Parser` datatype is a fairly generic parsing monad with error reporting. It can be used for arbitrary token types, not just String input. (If you require a running state, use module Poly.State instead)

Constructors

P ([t] -> Result [t] a) |

#### Instances

Instances details

MonadFail (Parser t) # |
Instance details Defined in Text.ParserCombinators.Poly.Parser Methods fail :: String -> Parser t a
Alternative (Parser t) # |
Instance details Defined in Text.ParserCombinators.Poly.Parser Methods empty :: Parser t a (<|>) :: Parser t a -> Parser t a -> Parser t a some :: Parser t a -> Parser t [a] many :: Parser t a -> Parser t [a]
Applicative (Parser t) # |
Instance details Defined in Text.ParserCombinators.Poly.Parser Methods pure :: a -> Parser t a (<*>) :: Parser t (a -> b) -> Parser t a -> Parser t b liftA2 :: (a -> b -> c) -> Parser t a -> Parser t b -> Parser t c (*>) :: Parser t a -> Parser t b -> Parser t b (<*) :: Parser t a -> Parser t b -> Parser t a
Functor (Parser t) # |
Instance details Defined in Text.ParserCombinators.Poly.Parser Methods fmap :: (a -> b) -> Parser t a -> Parser t b (<$) :: a -> Parser t b -> Parser t a
Monad (Parser t) # |
Instance details Defined in Text.ParserCombinators.Poly.Parser Methods (>>=) :: Parser t a -> (a -> Parser t b) -> Parser t b (>>) :: Parser t a -> Parser t b -> Parser t b return :: a -> Parser t a
Commitment (Parser t) # |
Instance details Defined in Text.ParserCombinators.Poly.Parser Methods commit :: Parser t a -> Parser t a # adjustErr :: Parser t a -> (String -> String) -> Parser t a # oneOf' :: [(String, Parser t a)] -> Parser t a #
PolyParse (Parser t) # |
Instance details Defined in Text.ParserCombinators.Poly.Parser

data Result z a #

A return type like Either, that distinguishes not only between right and wrong answers, but also has commitment, so that a failure cannot be undone. This should only be used for writing very primitive parsers - really it is an internal detail of the library. The z type is the remaining unconsumed input.

Constructors

Success z a |
Failure z String |
Committed (Result z a) |

#### Instances

Instances details

Functor (Result z) # |
Instance details Defined in Text.ParserCombinators.Poly.Result Methods fmap :: (a -> b) -> Result z a -> Result z b (<$) :: a -> Result z b -> Result z a

## Basic parsers

next :: Parser t t #

Simply return the next token in the input tokenstream.

eof :: Parser t () #

Succeed if the end of file/input has been reached, fail otherwise.

satisfy :: (t -> Bool) -> Parser t t #

Return the next token if it satisfies the given predicate.

satisfyMsg :: Show t => (t -> Bool) -> String -> Parser t t #

Return the next token if it satisfies the given predicate. The String argument describes the function, for better error messages.

onFail :: Parser t a -> Parser t a -> Parser t a infixl 6 #

`p `onFail` q` means parse p, unless p fails, in which case parse q instead. Can be chained together to give multiple attempts to parse something. (Note that q could itself be a failing parser, e.g. to change the error message from that defined in p to something different.) However, a severe failure in p cannot be ignored.

## Re-parsing

reparse :: [t] -> Parser t () #

Push some tokens back onto the front of the input stream and reparse. This is useful e.g. for recursively expanding macros. When the user-parser recognises a macro use, it can lookup the macro expansion from the parse state, lex it, and then stuff the lexed expansion back down into the parser.