Data.InvertibleGrammar

Base

data Grammar p a b

Representation of an invertible grammar -- a grammar that can be run either "forwards" and "backwards".

For a grammar Grammar p a b, running it forwards will take a value of type a and possibly produce a value of type b. Running it backwards will take a value of type b and possibly produce an a. If a value cannot be produced, an error message is generated.

As a common example, running a Grammar forwards corresponds to parsing and running backwards corresponds to prettyprinting.

That is, the grammar defines a partial isomorphism between two values.

Instances

Category (Grammar p :: Type -> Type -> Type)

Defined in Data.InvertibleGrammar.Base

Methods

id :: Grammar p a a

(.) :: Grammar p b c -> Grammar p a b -> Grammar p a c

Semigroup (Grammar p a b)

Defined in Data.InvertibleGrammar.Base

Methods

(<>) :: Grammar p a b -> Grammar p a b -> Grammar p a b

sconcat :: NonEmpty (Grammar p a b) -> Grammar p a b

stimes :: Integral b0 => b0 -> Grammar p a b -> Grammar p a b

data h :- t infixr 5

"Cons" pair of a heterogenous list or a stack with potentially polymophic tail. E.g. "first" :- 2 :- (3,4) :- t

Isomorphic to a tuple with two elments, but is much more convenient for nested pairs.

Instances

Bitraversable (:-)

Defined in Data.InvertibleGrammar.Base

Methods

bitraverse :: Applicative f => (a -> f c) -> (b -> f d) -> (a :- b) -> f (c :- d)

Bifoldable (:-)

Defined in Data.InvertibleGrammar.Base

Methods

bifold :: Monoid m => (m :- m) -> m

bifoldMap :: Monoid m => (a -> m) -> (b -> m) -> (a :- b) -> m

bifoldr :: (a -> c -> c) -> (b -> c -> c) -> c -> (a :- b) -> c

bifoldl :: (c -> a -> c) -> (c -> b -> c) -> c -> (a :- b) -> c

Bifunctor (:-)

Defined in Data.InvertibleGrammar.Base

Methods

bimap :: (a -> b) -> (c -> d) -> (a :- c) -> b :- d

first :: (a -> b) -> (a :- c) -> b :- c

second :: (b -> c) -> (a :- b) -> a :- c

Functor ((:-) h)

Defined in Data.InvertibleGrammar.Base

Methods

fmap :: (a -> b) -> (h :- a) -> h :- b

(<$) :: a -> (h :- b) -> h :- a

Foldable ((:-) h)

Defined in Data.InvertibleGrammar.Base

Methods

fold :: Monoid m => (h :- m) -> m

foldMap :: Monoid m => (a -> m) -> (h :- a) -> m

foldr :: (a -> b -> b) -> b -> (h :- a) -> b

foldr' :: (a -> b -> b) -> b -> (h :- a) -> b

foldl :: (b -> a -> b) -> b -> (h :- a) -> b

foldl' :: (b -> a -> b) -> b -> (h :- a) -> b

foldr1 :: (a -> a -> a) -> (h :- a) -> a

foldl1 :: (a -> a -> a) -> (h :- a) -> a

toList :: (h :- a) -> [a]

null :: (h :- a) -> Bool

length :: (h :- a) -> Int

elem :: Eq a => a -> (h :- a) -> Bool

maximum :: Ord a => (h :- a) -> a

minimum :: Ord a => (h :- a) -> a

sum :: Num a => (h :- a) -> a

product :: Num a => (h :- a) -> a

Traversable ((:-) h)

Defined in Data.InvertibleGrammar.Base

Methods

traverse :: Applicative f => (a -> f b) -> (h :- a) -> f (h :- b)

sequenceA :: Applicative f => (h :- f a) -> f (h :- a)

mapM :: Monad m => (a -> m b) -> (h :- a) -> m (h :- b)

sequence :: Monad m => (h :- m a) -> m (h :- a)

(Eq h, Eq t) => Eq (h :- t)

Defined in Data.InvertibleGrammar.Base

Methods

(==) :: (h :- t) -> (h :- t) -> Bool

(/=) :: (h :- t) -> (h :- t) -> Bool

(Show h, Show t) => Show (h :- t)

Defined in Data.InvertibleGrammar.Base

Methods

showsPrec :: Int -> (h :- t) -> ShowS

show :: (h :- t) -> String

showList :: [h :- t] -> ShowS

forward :: Grammar p a b -> a -> ContextError (Propagation p) (GrammarError p) b

Run Grammar forwards.

For Grammar p a b, given a value of type a tries to produce a value of type b, otherwise reports an error with position of type p.

backward :: Grammar p a b -> b -> ContextError (Propagation p) (GrammarError p) a

Run Grammar backwards.

For Grammar p a b, given a value of type b tries to produce a value of type a, otherwise reports an error with position of type p.

Combinators

module Data.InvertibleGrammar.Combinators

Running grammars

runGrammar :: p -> ContextError (Propagation p) (GrammarError p) a -> Either (ErrorMessage p) a

Run a forward or backward pass of a Grammar.

runGrammarDoc :: Pretty p => p -> ContextError (Propagation p) (GrammarError p) a -> Either (Doc ann) a

Run a forward or backward pass of a Grammar, report errors as pretty printed Doc message.

runGrammarString :: Show p => p -> ContextError (Propagation p) (GrammarError p) a -> Either String a

Run a forward or backward pass of a Grammar, report errors as String message.

Error messages

data ErrorMessage p

Grammar run error messages type.

Constructors

ErrorMessage

Fields

• emPosition :: p
• emAnnotations :: [Text]
• emExpected :: Set Text
• emGot :: Maybe Text

Instances

Eq p => Eq (ErrorMessage p)

Defined in Data.InvertibleGrammar.Monad

Methods

(==) :: ErrorMessage p -> ErrorMessage p -> Bool

(/=) :: ErrorMessage p -> ErrorMessage p -> Bool

Ord p => Ord (ErrorMessage p)

Defined in Data.InvertibleGrammar.Monad

Methods

compare :: ErrorMessage p -> ErrorMessage p -> Ordering

(<) :: ErrorMessage p -> ErrorMessage p -> Bool

(<=) :: ErrorMessage p -> ErrorMessage p -> Bool

(>) :: ErrorMessage p -> ErrorMessage p -> Bool

(>=) :: ErrorMessage p -> ErrorMessage p -> Bool

max :: ErrorMessage p -> ErrorMessage p -> ErrorMessage p

min :: ErrorMessage p -> ErrorMessage p -> ErrorMessage p

Generic (ErrorMessage p)

Defined in Data.InvertibleGrammar.Monad

Associated Types

type Rep (ErrorMessage p) :: Type -> Type

Methods

from :: ErrorMessage p -> Rep (ErrorMessage p) x

to :: Rep (ErrorMessage p) x -> ErrorMessage p

Pretty p => Pretty (ErrorMessage p)

Defined in Data.InvertibleGrammar.Monad

Methods

pretty :: ErrorMessage p -> Doc ann

prettyList :: [ErrorMessage p] -> Doc ann

type Rep (ErrorMessage p)

Defined in Data.InvertibleGrammar.Monad

type Rep (ErrorMessage p) = D1 (MetaData "ErrorMessage" "Data.InvertibleGrammar.Monad" "invertible-grammar-0.1.3-FuAWeov5XtEKdzoIGPkNZj" False) (C1 (MetaCons "ErrorMessage" PrefixI True) ((S1 (MetaSel (Just "emPosition") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 p) :*: S1 (MetaSel (Just "emAnnotations") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Text])) :*: (S1 (MetaSel (Just "emExpected") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Set Text)) :*: S1 (MetaSel (Just "emGot") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Text)))))

type ContextError c e a = ContextErrorT c e Identity a

data Propagation p

Instances

Eq (Propagation p)

Defined in Data.InvertibleGrammar.Monad

Methods

(==) :: Propagation p -> Propagation p -> Bool

(/=) :: Propagation p -> Propagation p -> Bool

Ord (Propagation p)

Defined in Data.InvertibleGrammar.Monad

Methods

compare :: Propagation p -> Propagation p -> Ordering

(<) :: Propagation p -> Propagation p -> Bool

(<=) :: Propagation p -> Propagation p -> Bool

(>) :: Propagation p -> Propagation p -> Bool

(>=) :: Propagation p -> Propagation p -> Bool

max :: Propagation p -> Propagation p -> Propagation p

min :: Propagation p -> Propagation p -> Propagation p

Show p => Show (Propagation p)

Defined in Data.InvertibleGrammar.Monad

Methods

showsPrec :: Int -> Propagation p -> ShowS

show :: Propagation p -> String

showList :: [Propagation p] -> ShowS

data GrammarError p

Instances

Show p => Show (GrammarError p)

Defined in Data.InvertibleGrammar.Monad

Methods

showsPrec :: Int -> GrammarError p -> ShowS

show :: GrammarError p -> String

showList :: [GrammarError p] -> ShowS

Semigroup (GrammarError p)

Defined in Data.InvertibleGrammar.Monad

Methods

(<>) :: GrammarError p -> GrammarError p -> GrammarError p

sconcat :: NonEmpty (GrammarError p) -> GrammarError p

stimes :: Integral b => b -> GrammarError p -> GrammarError p

data Mismatch

Data type to encode mismatches during parsing or generation, kept abstract. Use expected and unexpected constructors to build a mismatch report.

Instances

Eq Mismatch

Defined in Data.InvertibleGrammar.Monad

Methods

(==) :: Mismatch -> Mismatch -> Bool

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

Show Mismatch

Defined in Data.InvertibleGrammar.Monad

Methods

showsPrec :: Int -> Mismatch -> ShowS

show :: Mismatch -> String

showList :: [Mismatch] -> ShowS

Semigroup Mismatch

Defined in Data.InvertibleGrammar.Monad

Methods

(<>) :: Mismatch -> Mismatch -> Mismatch

sconcat :: NonEmpty Mismatch -> Mismatch

stimes :: Integral b => b -> Mismatch -> Mismatch

Monoid Mismatch

Defined in Data.InvertibleGrammar.Monad

Methods

mempty :: Mismatch

mappend :: Mismatch -> Mismatch -> Mismatch

mconcat :: [Mismatch] -> Mismatch

expected :: Text -> Mismatch

Construct a mismatch report with specified expectation. Can be appended to other expectations and unexpected reports to clarify a mismatch.

unexpected :: Text -> Mismatch

Construct a mismatch report with information what occurred during the processing but was not expected.