Portability	non-portable (GHC Extensions)
Stability	experimental
Maintainer	Tom Hvitved <[email protected]>

Data.Comp.MultiParam.Derive

Contents

Description

This module contains functionality for automatically deriving boilerplate code using Template Haskell. Examples include instances of HDifunctor, ShowHD, and EqHD.

Synopsis

Documentation

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

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 parametric signatures, i.e. signatures for parametric compositional data types.

EqHD

class EqHD f whereSource

Signature equality. An instance EqHD f gives rise to an instance Eq (Term f i). The equality test is performed inside the FreshM monad for generating fresh identifiers.

Methods

eqHD :: PEq a => f Var a i -> f Var a j -> FreshM Bool Source

Instances

EqHD f => EqHD (Cxt h f)	From an `EqHD` difunctor an `Eq` instance of the corresponding term type can be derived.
(EqHD f, EqHD g) => EqHD (:+: f g)	`EqHD` is propagated through sums.

makeEqHD :: Name -> Q [Dec]Source

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

OrdHD

class EqHD f => OrdHD f whereSource

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

Methods

compareHD :: POrd a => f Var a i -> f Var a j -> FreshM Ordering Source

Instances

OrdHD f => OrdHD (Cxt h f)	From an `OrdHD` difunctor an `Ord` instance of the corresponding term type can be derived.
(OrdHD f, OrdHD g) => OrdHD (:+: f g)	`OrdHD` is propagated through sums.

makeOrdHD :: Name -> Q [Dec]Source

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

ShowHD

class PShow a whereSource

Printing of parametric values.

Methods

pshow :: a i -> FreshM String Source

Instances

PShow Var
Show a => PShow (K a)
(ShowHD f, PShow a) => PShow (Cxt h f Var a)	From an `ShowHD` higher-order difunctor an `ShowHD` instance of the corresponding term type can be derived.

class ShowHD f whereSource

Signature printing. An instance ShowHD f gives rise to an instance Show (Term f i).

Methods

showHD :: PShow a => f Var a i -> FreshM String Source

Instances

(ShowHD f, PShow (K p)) => ShowHD (:&: f p)
(ShowHD f, ShowHD g) => ShowHD (:+: f g)

makeShowHD :: Name -> Q [Dec]Source

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

HDifunctor

class HDifunctor f Source

This class represents higher-order difunctors.

Instances

HDifunctor f => HDifunctor (:&: f p)
(HDifunctor f, HDifunctor g) => HDifunctor (:+: f g)

makeHDifunctor :: Name -> Q [Dec]Source

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

HFoldable

class HFunctor h => HFoldable h Source

Higher-order functors that can be folded.

Minimal complete definition: hfoldMap or hfoldr.

Instances

HFoldable f => HFoldable (Cxt h f)
HFoldable f => HFoldable (:&: f a)
(HFoldable f, HFoldable g) => HFoldable (:+: f g)

makeHFoldable :: Name -> Q [Dec]Source

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 Source

Instances

HTraversable f => HTraversable (Cxt h f)
HTraversable f => HTraversable (:&: f a)
(HTraversable f, HTraversable g) => HTraversable (:+: f g)

makeHTraversable :: Name -> Q [Dec]Source

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]Source

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

Smart Constructors w/ Annotations

smartAConstructors :: Name -> Q [Dec]Source

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

Lifting to Sums

liftSum :: Name -> Q [Dec]Source

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

caseHD :: (f a b i -> c) -> (g a b i -> c) -> (f :+: g) a b i -> cSource

Utility function to case on a higher-order difunctor sum, without exposing the internal representation of sums.