Data.Comp.Multi.Derive

This module contains functionality for automatically deriving boilerplate code using Template Haskell. Examples include instances of HFunctor, HFoldable, and HTraversable.

Documentation

derive :: [Name -> Q [Dec]] -> [Name] -> Q [Dec]

Helper function for generating a list of instances for a list of named signatures. For example, in order to derive instances Functor and ShowF for a signature Exp, use derive as follows (requires Template Haskell):

$(derive [makeFunctor, makeShowF] [''Exp])

Derive boilerplate instances for higher-order signatures, i.e. signatures for generalised compositional data types.

HShowF

class ShowHF f where

Signature printing. An instance ShowHF f gives rise to an instance KShow (HTerm f).

Minimal complete definition

Nothing

Methods

showHF :: Alg f (K String)

showHF' :: f (K String) :=> String

Instances

(ShowHF f, HFunctor f) => ShowHF (Cxt h f)

Defined in Data.Comp.Multi.Show

Methods

showHF :: Alg (Cxt h f) (K String)

showHF' :: Cxt h f (K String) :=> String

(ShowHF f, Show p) => ShowHF (f :&: p)

Defined in Data.Comp.Multi.Show

Methods

showHF :: Alg (f :&: p) (K String)

showHF' :: (f :&: p) (K String) :=> String

(ShowHF f, ShowHF g) => ShowHF (f :+: g)

Defined in Data.Comp.Multi.Show

Methods

showHF :: Alg (f :+: g) (K String)

showHF' :: (f :+: g) (K String) :=> String

class KShow a where

Methods

kshow :: a i -> K String i

Instances

KShow (K ())

Defined in Data.Comp.Multi.Show

Methods

kshow :: K () i -> K String i

KShow (K String)

Defined in Data.Comp.Multi.Show

Methods

kshow :: K String i -> K String i

(ShowHF f, HFunctor f, KShow a) => KShow (Cxt h f a)

Defined in Data.Comp.Multi.Show

Methods

kshow :: Cxt h f a i -> K String i

makeShowHF :: Name -> Q [Dec]

Derive an instance of ShowHF for a type constructor of any higher-order kind taking at least two arguments.

EqHF

class EqHF f where

Signature equality. An instance EqHF f gives rise to an instance KEq (HTerm f).

Methods

eqHF :: KEq g => f g i -> f g j -> Bool

Instances

EqHF f => EqHF (Cxt h f)

Defined in Data.Comp.Multi.Equality

Methods

eqHF :: forall (g :: Type -> Type) i j. KEq g => Cxt h f g i -> Cxt h f g j -> Bool

(EqHF f, EqHF g) => EqHF (f :+: g)

EqF is propagated through sums.

Defined in Data.Comp.Multi.Equality

Methods

eqHF :: forall (g0 :: Type -> Type) i j. KEq g0 => (f :+: g) g0 i -> (f :+: g) g0 j -> Bool

class KEq f where

Methods

keq :: f i -> f j -> Bool

Instances

Eq a => KEq (K a)

Defined in Data.Comp.Multi.Equality

Methods

keq :: K a i -> K a j -> Bool

(EqHF f, KEq a) => KEq (Cxt h f a)

Defined in Data.Comp.Multi.Equality

Methods

keq :: Cxt h f a i -> Cxt h f a j -> Bool

makeEqHF :: Name -> Q [Dec]

Derive an instance of EqHF for a type constructor of any higher-order kind taking at least two arguments.

OrdHF

class EqHF f => OrdHF f where

Signature ordering. An instance OrdHF f gives rise to an instance Ord (Term f).

Methods

compareHF :: KOrd a => f a i -> f a j -> Ordering

Instances

(HFunctor f, OrdHF f) => OrdHF (Cxt h f)

From an OrdHF difunctor an Ord instance of the corresponding term type can be derived.

Defined in Data.Comp.Multi.Ordering

Methods

compareHF :: forall (a :: Type -> Type) i j. KOrd a => Cxt h f a i -> Cxt h f a j -> Ordering

(OrdHF f, OrdHF g) => OrdHF (f :+: g)

OrdHF is propagated through sums.

Defined in Data.Comp.Multi.Ordering

Methods

compareHF :: forall (a :: Type -> Type) i j. KOrd a => (f :+: g) a i -> (f :+: g) a j -> Ordering

makeOrdHF :: Name -> Q [Dec]

Derive an instance of OrdHF for a type constructor of any parametric kind taking at least three arguments.

HFunctor

class HFunctor h

This class represents higher-order functors (Johann, Ghani, POPL '08) which are endofunctors on the category of endofunctors.

Minimal complete definition

hfmap

Instances

HFunctor f => HFunctor (Cxt h f)

Defined in Data.Comp.Multi.Term

Methods

hfmap :: forall (f0 :: Type -> Type) (g :: Type -> Type). (f0 :-> g) -> Cxt h f f0 :-> Cxt h f g

Functor f => HFunctor (Compose f :: (Type -> Type) -> Type -> Type)

Defined in Data.Comp.Multi.HFunctor

Methods

hfmap :: forall (f0 :: Type -> Type) (g :: Type -> Type). (f0 :-> g) -> Compose f f0 :-> Compose f g

HFunctor f => HFunctor (f :&: a)

Defined in Data.Comp.Multi.Ops

Methods

hfmap :: forall (f0 :: Type -> Type) (g :: Type -> Type). (f0 :-> g) -> (f :&: a) f0 :-> (f :&: a) g

(HFunctor f, HFunctor g) => HFunctor (f :+: g)

Defined in Data.Comp.Multi.Ops

Methods

hfmap :: forall (f0 :: Type -> Type) (g0 :: Type -> Type). (f0 :-> g0) -> (f :+: g) f0 :-> (f :+: g) g0

makeHFunctor :: Name -> Q [Dec]

Derive an instance of HFunctor for a type constructor of any higher-order kind taking at least two arguments.

HFoldable

class HFunctor h => HFoldable h

Higher-order functors that can be folded.

Minimal complete definition: hfoldMap or hfoldr.

Instances

HFoldable f => HFoldable (Cxt h f)

Defined in Data.Comp.Multi.Term

Methods

hfold :: Monoid m => Cxt h f (K m) :=> m

hfoldMap :: forall m (a :: Type -> Type). Monoid m => (a :=> m) -> Cxt h f a :=> m

hfoldr :: forall (a :: Type -> Type) b. (a :=> (b -> b)) -> b -> Cxt h f a :=> b

hfoldl :: forall b (a :: Type -> Type). (b -> a :=> b) -> b -> Cxt h f a :=> b

hfoldr1 :: (a -> a -> a) -> Cxt h f (K a) :=> a

hfoldl1 :: (a -> a -> a) -> Cxt h f (K a) :=> a

HFoldable f => HFoldable (f :&: a)

Defined in Data.Comp.Multi.Ops

Methods

hfold :: Monoid m => (f :&: a) (K m) :=> m

hfoldMap :: forall m (a0 :: Type -> Type). Monoid m => (a0 :=> m) -> (f :&: a) a0 :=> m

hfoldr :: forall (a0 :: Type -> Type) b. (a0 :=> (b -> b)) -> b -> (f :&: a) a0 :=> b

hfoldl :: forall b (a0 :: Type -> Type). (b -> a0 :=> b) -> b -> (f :&: a) a0 :=> b

hfoldr1 :: (a0 -> a0 -> a0) -> (f :&: a) (K a0) :=> a0

hfoldl1 :: (a0 -> a0 -> a0) -> (f :&: a) (K a0) :=> a0

(HFoldable f, HFoldable g) => HFoldable (f :+: g)

Defined in Data.Comp.Multi.Ops

Methods

hfold :: Monoid m => (f :+: g) (K m) :=> m

hfoldMap :: forall m (a :: Type -> Type). Monoid m => (a :=> m) -> (f :+: g) a :=> m

hfoldr :: forall (a :: Type -> Type) b. (a :=> (b -> b)) -> b -> (f :+: g) a :=> b

hfoldl :: forall b (a :: Type -> Type). (b -> a :=> b) -> b -> (f :+: g) a :=> b

hfoldr1 :: (a -> a -> a) -> (f :+: g) (K a) :=> a

hfoldl1 :: (a -> a -> a) -> (f :+: g) (K a) :=> a

makeHFoldable :: Name -> Q [Dec]

Derive an instance of HFoldable for a type constructor of any higher-order kind taking at least two arguments.

HTraversable

class HFoldable t => HTraversable t

Minimal complete definition

hmapM, htraverse

Instances

HTraversable f => HTraversable (Cxt h f)

Defined in Data.Comp.Multi.Term

Methods

hmapM :: forall (m :: Type -> Type) (a :: Type -> Type) (b :: Type -> Type). Monad m => NatM m a b -> NatM m (Cxt h f a) (Cxt h f b)

htraverse :: forall (f0 :: Type -> Type) (a :: Type -> Type) (b :: Type -> Type). Applicative f0 => NatM f0 a b -> NatM f0 (Cxt h f a) (Cxt h f b)

HTraversable f => HTraversable (f :&: a)

Defined in Data.Comp.Multi.Ops

Methods

hmapM :: forall (m :: Type -> Type) (a0 :: Type -> Type) (b :: Type -> Type). Monad m => NatM m a0 b -> NatM m ((f :&: a) a0) ((f :&: a) b)

htraverse :: forall (f0 :: Type -> Type) (a0 :: Type -> Type) (b :: Type -> Type). Applicative f0 => NatM f0 a0 b -> NatM f0 ((f :&: a) a0) ((f :&: a) b)

(HTraversable f, HTraversable g) => HTraversable (f :+: g)

Defined in Data.Comp.Multi.Ops

Methods

hmapM :: forall (m :: Type -> Type) (a :: Type -> Type) (b :: Type -> Type). Monad m => NatM m a b -> NatM m ((f :+: g) a) ((f :+: g) b)

htraverse :: forall (f0 :: Type -> Type) (a :: Type -> Type) (b :: Type -> Type). Applicative f0 => NatM f0 a b -> NatM f0 ((f :+: g) a) ((f :+: g) b)

makeHTraversable :: Name -> Q [Dec]

Derive an instance of HTraversable for a type constructor of any higher-order kind taking at least two arguments.

Smart Constructors

smartConstructors :: Name -> Q [Dec]

Derive smart constructors for a type constructor of any higher-order kind taking at least two arguments. The smart constructors are similar to the ordinary constructors, but an inject is automatically inserted.

Smart Constructors w/ Annotations

smartAConstructors :: Name -> Q [Dec]

Derive smart constructors with products for a type constructor of any parametric kind taking at least two arguments. The smart constructors are similar to the ordinary constructors, but an injectA is automatically inserted.

Lifting to Sums

liftSum :: Name -> Q [Dec]

Given the name of a type class, where the first parameter is a higher-order functor, lift it to sums of higher-order. Example: class HShowF f where ... is lifted as instance (HShowF f, HShowF g) => HShowF (f :+: g) where ... .