Text.PariPari.Internal.Class

Documentation

class (MonadFail p, MonadPlus p, Chunk k) => ChunkParser k p | p -> k where

Parser class, which specifies the necessary primitives for parsing. All other parser combinators rely on these primitives.

Minimal complete definition

getFile, getPos, getRefPos, withRefPos, notFollowedBy, lookAhead, failWith, eof, label, hidden, commit, element, elementScan, chunk, asChunk

Methods

getFile :: p FilePath

Get file name associated with current parser

getPos :: p Pos

Get current position of the parser

getRefPos :: p Pos

Get reference position used for indentation-sensitive parsing

withRefPos :: p a -> p a

Update reference position with current position

notFollowedBy :: Show a => p a -> p ()

Parser which succeeds when the given parser fails

lookAhead :: p a -> p a

Look ahead and return result of the given parser The current position stays the same.

failWith :: Error -> p a

Parser failure with detailled Error

eof :: p ()

Parser which succeeds at the end of file

label :: String -> p a -> p a

Annotate the given parser with a label used for error reporting

hidden :: p a -> p a

Hide errors occurring within the given parser from the error report. Based on the given labels an Error is constructed instead.

commit :: p a -> p a

Commit to the given branch, increasing the priority of the errors within this branch in contrast to other branches.

This is basically the opposite of the try combinator provided by other parser combinator libraries, which decreases the error priority within the given branch (and usually also influences backtracking).

Note: commit only applies to the reported errors, it has no effect on the backtracking behavior of the parser.

element :: Element k -> p (Element k)

Parse a single element

elementScan :: (Element k -> Maybe a) -> p a

Scan a single element

chunk :: k -> p k

Parse a chunk of elements. The chunk must not contain multiple lines, otherwise the position information will be invalid.

asChunk :: p () -> p k

Run the given parser and return the result as buffer

Instances

Chunk k => ChunkParser k (Acceptor k)

Defined in Text.PariPari.Internal.Acceptor

Methods

getFile :: Acceptor k FilePath

getPos :: Acceptor k Pos

getRefPos :: Acceptor k Pos

withRefPos :: Acceptor k a -> Acceptor k a

notFollowedBy :: Show a => Acceptor k a -> Acceptor k ()

lookAhead :: Acceptor k a -> Acceptor k a

failWith :: Error -> Acceptor k a

eof :: Acceptor k ()

label :: String -> Acceptor k a -> Acceptor k a

hidden :: Acceptor k a -> Acceptor k a

commit :: Acceptor k a -> Acceptor k a

element :: Element k -> Acceptor k (Element k)

elementScan :: (Element k -> Maybe a) -> Acceptor k a

chunk :: k -> Acceptor k k

asChunk :: Acceptor k () -> Acceptor k k

Chunk k => ChunkParser k (Reporter k)

Defined in Text.PariPari.Internal.Reporter

Methods

getFile :: Reporter k FilePath

getPos :: Reporter k Pos

getRefPos :: Reporter k Pos

withRefPos :: Reporter k a -> Reporter k a

notFollowedBy :: Show a => Reporter k a -> Reporter k ()

lookAhead :: Reporter k a -> Reporter k a

failWith :: Error -> Reporter k a

eof :: Reporter k ()

label :: String -> Reporter k a -> Reporter k a

hidden :: Reporter k a -> Reporter k a

commit :: Reporter k a -> Reporter k a

element :: Element k -> Reporter k (Element k)

elementScan :: (Element k -> Maybe a) -> Reporter k a

chunk :: k -> Reporter k k

asChunk :: Reporter k () -> Reporter k k

CharChunk k => ChunkParser k (Tracer k)

Defined in Text.PariPari.Internal.Tracer

Methods

getFile :: Tracer k FilePath

getPos :: Tracer k Pos

getRefPos :: Tracer k Pos

withRefPos :: Tracer k a -> Tracer k a

notFollowedBy :: Show a => Tracer k a -> Tracer k ()

lookAhead :: Tracer k a -> Tracer k a

failWith :: Error -> Tracer k a

eof :: Tracer k ()

label :: String -> Tracer k a -> Tracer k a

hidden :: Tracer k a -> Tracer k a

commit :: Tracer k a -> Tracer k a

element :: Element k -> Tracer k (Element k)

elementScan :: (Element k -> Maybe a) -> Tracer k a

chunk :: k -> Tracer k k

asChunk :: Tracer k () -> Tracer k k

class (ChunkParser k p, IsString (p k), CharChunk k) => CharParser k p | p -> k where

Minimal complete definition

char, scan, asciiByte, asciiScan

Methods

char :: Char -> p Char

Parse a single character

Note: The character '\0' cannot be parsed using this combinator since it is used as decoding sentinel. Use element instead.

scan :: (Char -> Maybe a) -> p a

Scan a single character

Note: The character '\0' cannot be parsed using this combinator since it is used as decoding sentinel. Use elementScan instead.

asciiByte :: Word8 -> p Word8

Parse a single character within the ASCII charset

Note: The character '\0' cannot be parsed using this combinator since it is used as decoding sentinel. Use element instead.

asciiScan :: (Word8 -> Maybe a) -> p a

Scan a single character within the ASCII charset

Note: The character '\0' cannot be parsed using this combinator since it is used as decoding sentinel. Use elementScan instead.

Instances

CharChunk k => CharParser k (Acceptor k)

Defined in Text.PariPari.Internal.Acceptor

Methods

char :: Char -> Acceptor k Char

scan :: (Char -> Maybe a) -> Acceptor k a

asciiByte :: Word8 -> Acceptor k Word8

asciiScan :: (Word8 -> Maybe a) -> Acceptor k a

CharChunk k => CharParser k (Reporter k)

Defined in Text.PariPari.Internal.Reporter

Methods

char :: Char -> Reporter k Char

scan :: (Char -> Maybe a) -> Reporter k a

asciiByte :: Word8 -> Reporter k Word8

asciiScan :: (Word8 -> Maybe a) -> Reporter k a

CharChunk k => CharParser k (Tracer k)

Defined in Text.PariPari.Internal.Tracer

Methods

char :: Char -> Tracer k Char

scan :: (Char -> Maybe a) -> Tracer k a

asciiByte :: Word8 -> Tracer k Word8

asciiScan :: (Word8 -> Maybe a) -> Tracer k a

class Applicative f => Alternative (f :: * -> *) where

A monoid on applicative functors.

If defined, some and many should be the least solutions of the equations:

• some v = (:) <$> v <*> many v

• many v = some v <|> pure []

Minimal complete definition

empty, (<|>)

Methods

empty :: f a

The identity of <|>

(<|>) :: f a -> f a -> f a infixl 3

An associative binary operation

Instances

Alternative []

Since: base-2.1

Defined in GHC.Base

Methods

empty :: [a]

(<|>) :: [a] -> [a] -> [a]

some :: [a] -> [[a]]

many :: [a] -> [[a]]

Alternative Maybe

Since: base-2.1

Defined in GHC.Base

Methods

empty :: Maybe a

(<|>) :: Maybe a -> Maybe a -> Maybe a

some :: Maybe a -> Maybe [a]

many :: Maybe a -> Maybe [a]

Alternative IO

Since: base-4.9.0.0

Defined in GHC.Base

Methods

empty :: IO a

(<|>) :: IO a -> IO a -> IO a

some :: IO a -> IO [a]

many :: IO a -> IO [a]

Alternative Option

Since: base-4.9.0.0

Defined in Data.Semigroup

Methods

empty :: Option a

(<|>) :: Option a -> Option a -> Option a

some :: Option a -> Option [a]

many :: Option a -> Option [a]

Alternative ZipList

Since: base-4.11.0.0

Defined in Control.Applicative

Methods

empty :: ZipList a

(<|>) :: ZipList a -> ZipList a -> ZipList a

some :: ZipList a -> ZipList [a]

many :: ZipList a -> ZipList [a]

Alternative STM

Since: base-4.8.0.0

Defined in GHC.Conc.Sync

Methods

empty :: STM a

(<|>) :: STM a -> STM a -> STM a

some :: STM a -> STM [a]

many :: STM a -> STM [a]

Alternative ReadP

Since: base-4.6.0.0

Defined in Text.ParserCombinators.ReadP

Methods

empty :: ReadP a

(<|>) :: ReadP a -> ReadP a -> ReadP a

some :: ReadP a -> ReadP [a]

many :: ReadP a -> ReadP [a]

Alternative Seq

Since: containers-0.5.4

Defined in Data.Sequence.Internal

Methods

empty :: Seq a

(<|>) :: Seq a -> Seq a -> Seq a

some :: Seq a -> Seq [a]

many :: Seq a -> Seq [a]

Alternative P

Since: base-4.5.0.0

Defined in Text.ParserCombinators.ReadP

Methods

empty :: P a

(<|>) :: P a -> P a -> P a

some :: P a -> P [a]

many :: P a -> P [a]

Alternative (U1 :: * -> *)

Since: base-4.9.0.0

Defined in GHC.Generics

Methods

empty :: U1 a

(<|>) :: U1 a -> U1 a -> U1 a

some :: U1 a -> U1 [a]

many :: U1 a -> U1 [a]

MonadPlus m => Alternative (WrappedMonad m)

Since: base-2.1

Defined in Control.Applicative

Methods

empty :: WrappedMonad m a

(<|>) :: WrappedMonad m a -> WrappedMonad m a -> WrappedMonad m a

some :: WrappedMonad m a -> WrappedMonad m [a]

many :: WrappedMonad m a -> WrappedMonad m [a]

ArrowPlus a => Alternative (ArrowMonad a)

Since: base-4.6.0.0

Defined in Control.Arrow

Methods

empty :: ArrowMonad a a0

(<|>) :: ArrowMonad a a0 -> ArrowMonad a a0 -> ArrowMonad a a0

some :: ArrowMonad a a0 -> ArrowMonad a [a0]

many :: ArrowMonad a a0 -> ArrowMonad a [a0]

Chunk k => Alternative (Acceptor k)

Defined in Text.PariPari.Internal.Acceptor

Methods

empty :: Acceptor k a

(<|>) :: Acceptor k a -> Acceptor k a -> Acceptor k a

some :: Acceptor k a -> Acceptor k [a]

many :: Acceptor k a -> Acceptor k [a]

Chunk k => Alternative (Reporter k)

Defined in Text.PariPari.Internal.Reporter

Methods

empty :: Reporter k a

(<|>) :: Reporter k a -> Reporter k a -> Reporter k a

some :: Reporter k a -> Reporter k [a]

many :: Reporter k a -> Reporter k [a]

Chunk k => Alternative (Tracer k)

Defined in Text.PariPari.Internal.Tracer

Methods

empty :: Tracer k a

(<|>) :: Tracer k a -> Tracer k a -> Tracer k a

some :: Tracer k a -> Tracer k [a]

many :: Tracer k a -> Tracer k [a]

Alternative f => Alternative (Rec1 f)

Since: base-4.9.0.0

Defined in GHC.Generics

Methods

empty :: Rec1 f a

(<|>) :: Rec1 f a -> Rec1 f a -> Rec1 f a

some :: Rec1 f a -> Rec1 f [a]

many :: Rec1 f a -> Rec1 f [a]

(ArrowZero a, ArrowPlus a) => Alternative (WrappedArrow a b)

Since: base-2.1

Defined in Control.Applicative

Methods

empty :: WrappedArrow a b a0

(<|>) :: WrappedArrow a b a0 -> WrappedArrow a b a0 -> WrappedArrow a b a0

some :: WrappedArrow a b a0 -> WrappedArrow a b [a0]

many :: WrappedArrow a b a0 -> WrappedArrow a b [a0]

Alternative f => Alternative (Alt f)

Defined in Data.Semigroup.Internal

Methods

empty :: Alt f a

(<|>) :: Alt f a -> Alt f a -> Alt f a

some :: Alt f a -> Alt f [a]

many :: Alt f a -> Alt f [a]

(Alternative f, Alternative g) => Alternative (f :*: g)

Since: base-4.9.0.0

Defined in GHC.Generics

Methods

empty :: (f :*: g) a

(<|>) :: (f :*: g) a -> (f :*: g) a -> (f :*: g) a

some :: (f :*: g) a -> (f :*: g) [a]

many :: (f :*: g) a -> (f :*: g) [a]

(Alternative f, Alternative g) => Alternative (Product f g)

Since: base-4.9.0.0

Defined in Data.Functor.Product

Methods

empty :: Product f g a

(<|>) :: Product f g a -> Product f g a -> Product f g a

some :: Product f g a -> Product f g [a]

many :: Product f g a -> Product f g [a]

Alternative f => Alternative (M1 i c f)

Since: base-4.9.0.0

Defined in GHC.Generics

Methods

empty :: M1 i c f a

(<|>) :: M1 i c f a -> M1 i c f a -> M1 i c f a

some :: M1 i c f a -> M1 i c f [a]

many :: M1 i c f a -> M1 i c f [a]

(Alternative f, Applicative g) => Alternative (f :.: g)

Since: base-4.9.0.0

Defined in GHC.Generics

Methods

empty :: (f :.: g) a

(<|>) :: (f :.: g) a -> (f :.: g) a -> (f :.: g) a

some :: (f :.: g) a -> (f :.: g) [a]

many :: (f :.: g) a -> (f :.: g) [a]

(Alternative f, Applicative g) => Alternative (Compose f g)

Since: base-4.9.0.0

Defined in Data.Functor.Compose

Methods

empty :: Compose f g a

(<|>) :: Compose f g a -> Compose f g a -> Compose f g a

some :: Compose f g a -> Compose f g [a]

many :: Compose f g a -> Compose f g [a]

class (Alternative m, Monad m) => MonadPlus (m :: * -> *)

Monads that also support choice and failure.

Instances

MonadPlus []

Since: base-2.1

Defined in GHC.Base

Methods

mzero :: [a]

mplus :: [a] -> [a] -> [a]

MonadPlus Maybe

Since: base-2.1

Defined in GHC.Base

Methods

mzero :: Maybe a

mplus :: Maybe a -> Maybe a -> Maybe a

MonadPlus IO

Since: base-4.9.0.0

Defined in GHC.Base

Methods

mzero :: IO a

mplus :: IO a -> IO a -> IO a

MonadPlus Option

Since: base-4.9.0.0

Defined in Data.Semigroup

Methods

mzero :: Option a

mplus :: Option a -> Option a -> Option a

MonadPlus STM

Since: base-4.3.0.0

Defined in GHC.Conc.Sync

Methods

mzero :: STM a

mplus :: STM a -> STM a -> STM a

MonadPlus ReadP

Since: base-2.1

Defined in Text.ParserCombinators.ReadP

Methods

mzero :: ReadP a

mplus :: ReadP a -> ReadP a -> ReadP a

MonadPlus Seq

Defined in Data.Sequence.Internal

Methods

mzero :: Seq a

mplus :: Seq a -> Seq a -> Seq a

MonadPlus P

Since: base-2.1

Defined in Text.ParserCombinators.ReadP

Methods

mzero :: P a

mplus :: P a -> P a -> P a

MonadPlus (U1 :: * -> *)

Since: base-4.9.0.0

Defined in GHC.Generics

Methods

mzero :: U1 a

mplus :: U1 a -> U1 a -> U1 a

(ArrowApply a, ArrowPlus a) => MonadPlus (ArrowMonad a)

Since: base-4.6.0.0

Defined in Control.Arrow

Methods

mzero :: ArrowMonad a a0

mplus :: ArrowMonad a a0 -> ArrowMonad a a0 -> ArrowMonad a a0

Chunk k => MonadPlus (Acceptor k)

Defined in Text.PariPari.Internal.Acceptor

Methods

mzero :: Acceptor k a

mplus :: Acceptor k a -> Acceptor k a -> Acceptor k a

Chunk k => MonadPlus (Reporter k)

Defined in Text.PariPari.Internal.Reporter

Methods

mzero :: Reporter k a

mplus :: Reporter k a -> Reporter k a -> Reporter k a

Chunk k => MonadPlus (Tracer k)

Defined in Text.PariPari.Internal.Tracer

Methods

mzero :: Tracer k a

mplus :: Tracer k a -> Tracer k a -> Tracer k a

MonadPlus f => MonadPlus (Rec1 f)

Since: base-4.9.0.0

Defined in GHC.Generics

Methods

mzero :: Rec1 f a

mplus :: Rec1 f a -> Rec1 f a -> Rec1 f a

MonadPlus f => MonadPlus (Alt f)

Defined in Data.Semigroup.Internal

Methods

mzero :: Alt f a

mplus :: Alt f a -> Alt f a -> Alt f a

(MonadPlus f, MonadPlus g) => MonadPlus (f :*: g)

Since: base-4.9.0.0

Defined in GHC.Generics

Methods

mzero :: (f :*: g) a

mplus :: (f :*: g) a -> (f :*: g) a -> (f :*: g) a

(MonadPlus f, MonadPlus g) => MonadPlus (Product f g)

Since: base-4.9.0.0

Defined in Data.Functor.Product

Methods

mzero :: Product f g a

mplus :: Product f g a -> Product f g a -> Product f g a

MonadPlus f => MonadPlus (M1 i c f)

Since: base-4.9.0.0

Defined in GHC.Generics

Methods

mzero :: M1 i c f a

mplus :: M1 i c f a -> M1 i c f a -> M1 i c f a

data Pos

Line and column position starting at (1,1)

Constructors

Pos

Fields

• _posLine :: !Int
• _posColumn :: !Int

Instances

Eq Pos

Defined in Text.PariPari.Internal.Chunk

Methods

(==) :: Pos -> Pos -> Bool

(/=) :: Pos -> Pos -> Bool

Show Pos

Defined in Text.PariPari.Internal.Chunk

Methods

showsPrec :: Int -> Pos -> ShowS

show :: Pos -> String

showList :: [Pos] -> ShowS

Generic Pos

Defined in Text.PariPari.Internal.Chunk

Associated Types

type Rep Pos :: * -> *

Methods

from :: Pos -> Rep Pos x

to :: Rep Pos x -> Pos

type Rep Pos

Defined in Text.PariPari.Internal.Chunk

type Rep Pos = D1 (MetaData "Pos" "Text.PariPari.Internal.Chunk" "paripari-0.4.0.0-9zVj0AI90vR329B7YG7MGG" False) (C1 (MetaCons "Pos" PrefixI True) (S1 (MetaSel (Just "_posLine") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int) :*: S1 (MetaSel (Just "_posColumn") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))

data Error

Parsing errors

Constructors

EInvalidUtf8

EExpected [String]

EUnexpected String

EFail String

ECombinator String

EIndentNotAligned !Int !Int

EIndentOverLine !Int !Int

ENotEnoughIndent !Int !Int

Instances

Eq Error

Defined in Text.PariPari.Internal.Class

Methods

(==) :: Error -> Error -> Bool

(/=) :: Error -> Error -> Bool

Ord Error

Defined in Text.PariPari.Internal.Class

Methods

compare :: Error -> Error -> Ordering

(<) :: Error -> Error -> Bool

(<=) :: Error -> Error -> Bool

(>) :: Error -> Error -> Bool

(>=) :: Error -> Error -> Bool

max :: Error -> Error -> Error

min :: Error -> Error -> Error

Show Error

Defined in Text.PariPari.Internal.Class

Methods

showsPrec :: Int -> Error -> ShowS

show :: Error -> String

showList :: [Error] -> ShowS

Generic Error

Defined in Text.PariPari.Internal.Class

Associated Types

type Rep Error :: * -> *

Methods

from :: Error -> Rep Error x

to :: Rep Error x -> Error

type Rep Error

Defined in Text.PariPari.Internal.Class

type Rep Error = D1 (MetaData "Error" "Text.PariPari.Internal.Class" "paripari-0.4.0.0-9zVj0AI90vR329B7YG7MGG" False) (((C1 (MetaCons "EInvalidUtf8" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "EExpected" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [String]))) :+: (C1 (MetaCons "EUnexpected" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String)) :+: C1 (MetaCons "EFail" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String)))) :+: ((C1 (MetaCons "ECombinator" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String)) :+: C1 (MetaCons "EIndentNotAligned" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))) :+: (C1 (MetaCons "EIndentOverLine" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)) :+: C1 (MetaCons "ENotEnoughIndent" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))))

showError :: Error -> String

Pretty string representation of Error

expectedEnd :: Error

unexpectedEnd :: Error

string :: CharParser k p => String -> p k

Parse a string