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

Safe Haskell | Safe-Inferred
Language | Haskell2010

Text.ParserCombinators.Poly.ByteString

Contents

- The Parser datatype
  - Basic parsers
  - Derived parsers (but implemented more efficiently)
  - Re-parsing
- Re-export all more general combinators

Synopsis

- newtype Parser a = P (ByteString -> Result ByteString a)
- data Result z a
  - = Success z a
  - | Failure z String
  - | Committed (Result z a)
- runParser :: Parser a -> ByteString -> (Either String a, ByteString)
- next :: Parser Word8
- eof :: Parser ()
- satisfy :: (Word8 -> Bool) -> Parser Word8
- onFail :: Parser a -> Parser a -> Parser a
- manySatisfy :: (Word8 -> Bool) -> Parser ByteString
- many1Satisfy :: (Word8 -> Bool) -> Parser ByteString
- reparse :: ByteString -> Parser ()
- module Text.ParserCombinators.Poly.Base

# The Parser datatype

newtype Parser a Source #

This `Parser` datatype is a specialised parsing monad with error reporting. Whereas the standard version can be used for arbitrary token types, this version is specialised to ByteString input only.

Constructors

P (ByteString -> Result ByteString a) |

#### Instances

Instances details

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

data Result z a Source #

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) Source # |
Instance details Defined in Text.ParserCombinators.Poly.Result Methods fmap :: (a -> b) -> Result z a -> Result z b Source # (<$) :: a -> Result z b -> Result z a Source #

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

Apply a parser to an input token sequence.

## Basic parsers

next :: Parser Word8 Source #

Simply return the next token in the input tokenstream.

eof :: Parser () Source #

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

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

Return the next token if it satisfies the given predicate.

onFail :: Parser a -> Parser a -> Parser a Source #

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

## Derived parsers (but implemented more efficiently)

manySatisfy :: (Word8 -> Bool) -> Parser ByteString Source #

`manySatisfy p` is a more efficient fused version of `many (satisfy p)`

many1Satisfy :: (Word8 -> Bool) -> Parser ByteString Source #

`many1Satisfy p` is a more efficient fused version of `many1 (satisfy p)`

## Re-parsing

reparse :: ByteString -> Parser () Source #

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.

# Re-export all more general combinators

module Text.ParserCombinators.Poly.Base