Language.Haskell.TH.Lift.Generics

GHC.Generics-based approach to implementing lift.

Documentation

genericLiftWithPkg :: (Quote m, Generic a, GLift (Rep a)) => String -> a -> m Exp

GHC.Generics-based lift implementation.

API limitations of early versions of GHC (7.10 and earlier) require the user to produce the package name themselves. This isn't as easy to come up with as it sounds, because GHC 7.10 uses a hashed package ID for a name. To make things worse, if you produce the wrong package name, you might get bizarre compilation errors!

There's no need to fear, though—the code sample below shows an example of how to properly use genericLiftWithPkg without shooting yourself in the foot:

{-# LANGUAGE CPP, DeriveGeneric #-}
-- part of package foobar
module Foo where

import GHC.Generics
import Language.Haskell.Lift.Generics

#ifndef CURRENT_PACKAGE_KEY
import Data.Version (showVersion)
import Paths_foobar (version)
#endif

pkgName :: String
#ifdef CURRENT_PACKAGE_KEY
pkgName = CURRENT_PACKAGE_KEY
#else
pkgName = "foobar-" ++ showVersion version
#endif

data Foo = Foo Int Char String
  deriving Generic

instance Lift Foo where
  lift = genericLiftWithPkg pkgName

As you can see, this trick only works if (1) the current package key is known (i.e., the Lift instance is defined in the same package as the datatype), or (2) you're dealing with a package that has a fixed package name (e.g., base, ghc-prim, template-haskell, etc.).

Once the Lift Foo instance is defined, you can splice Foo values directly into Haskell source code:

{-# LANGUAGE TemplateHaskell #-}
module Bar where

import Foo
import Language.Haskell.TH.Syntax

foo :: Foo
foo = $(lift (Foo 1 a "baz"))

genericLiftTypedWithPkg :: (Quote m, Generic a, GLift (Rep a)) => String -> a -> Code m a

Like genericLiftWithPkg, but returns a Code instead of an Exp.

genericLiftTypedTExpWithPkg :: (Quote m, Generic a, GLift (Rep a)) => String -> a -> m (TExp a)

Like genericLiftWithPkg, but returns a TExp instead of an Exp.

genericLiftTypedCompatWithPkg :: (Quote m, Generic a, GLift (Rep a)) => String -> a -> Splice m a

Lift genericLiftWithPkg, but returns:

• A Code (if using template-haskell-2.17.0.0 or later), or
• A TExp (if using an older version of template-haskell)

This function is ideal for implementing the liftTyped method of Lift directly, as its type changed in template-haskell-2.17.0.0.

genericLift :: (Quote m, Generic a, GLift (Rep a)) => a -> m Exp

GHC.Generics-based lift implementation. Only available on GHC 8.0 and later due to API limitations of earlier GHC versions.

Unlike genericLiftWithPkg, this function does all of the work for you:

{-# LANGUAGE DeriveGeneric #-}
module Foo where

import GHC.Generics
import Language.Haskell.Lift.Generics

data Foo = Foo Int Char String
  deriving Generic

instance Lift Foo where
  lift = genericLift

Now you can splice Foo values directly into Haskell source code:

{-# LANGUAGE TemplateHaskell #-}
module Bar where

import Foo
import Language.Haskell.TH.Syntax

foo :: Foo
foo = $(lift (Foo 1 a "baz"))

genericLiftTyped :: (Quote m, Generic a, GLift (Rep a)) => a -> Code m a

Like genericLift, but returns a Code instead of an Exp.

genericLiftTypedTExp :: (Quote m, Generic a, GLift (Rep a)) => a -> m (TExp a)

Like genericLift, but returns a TExp instead of an Exp.

genericLiftTypedCompat :: (Quote m, Generic a, GLift (Rep a)) => a -> Splice m a

Lift genericLift, but returns:

• A Code (if using template-haskell-2.17.0.0 or later), or
• A TExp (if using an older version of template-haskell)

This function is ideal for implementing the liftTyped method of Lift directly, as its type changed in template-haskell-2.17.0.0.

class GLift f where

Class of generic representation types which can be converted to Template Haskell expressions. You shouldn't need to use this typeclass directly; it is only exported for educational purposes.

Methods

glift

Arguments

:: Quote m

=> String

The package name (not used on GHC 8.0 and later)

-> f a

The generic value

-> m Exp

The resulting Template Haskell expression

Instances

(Datatype d, GLiftDatatype f) => GLift (D1 d f)

Defined in Language.Haskell.TH.Lift.Generics

Methods

glift :: Quote m => String -> D1 d f a -> m Exp

class GLiftDatatype f where

Class of generic representation types which can be converted to Template Haskell expressions, given a package and module name. You shouldn't need to use this typeclass directly; it is only exported for educational purposes.

Methods

gliftWith

Arguments

:: Quote m

=> String

The package name

-> String

The module name

-> f a

The generic value

-> m Exp

The resulting Template Haskell expression

Instances

GLiftDatatype (V1 :: Type -> Type)

Defined in Language.Haskell.TH.Lift.Generics

Methods

gliftWith :: Quote m => String -> String -> V1 a -> m Exp

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

Defined in Language.Haskell.TH.Lift.Generics

Methods

gliftWith :: Quote m => String -> String -> (f :+: g) a -> m Exp

(Constructor c, GLiftArgs f) => GLiftDatatype (C1 c f)

Defined in Language.Haskell.TH.Lift.Generics

Methods

gliftWith :: Quote m => String -> String -> C1 c f a -> m Exp

class GLiftArgs f where

Class of generic representation types which can be converted to a list of Template Haskell expressions (which represent a constructors' arguments). You shouldn't need to use this typeclass directly; it is only exported for educational purposes.

Methods

gliftArgs :: Quote m => f a -> [m Exp]

Instances

GLiftArgs (U1 :: Type -> Type)

Defined in Language.Haskell.TH.Lift.Generics

Methods

gliftArgs :: Quote m => U1 a -> [m Exp]

GLiftArgs (UAddr :: Type -> Type)

Defined in Language.Haskell.TH.Lift.Generics

Methods

gliftArgs :: Quote m => UAddr a -> [m Exp]

GLiftArgs (UChar :: Type -> Type)

Defined in Language.Haskell.TH.Lift.Generics

Methods

gliftArgs :: Quote m => UChar a -> [m Exp]

GLiftArgs (UDouble :: Type -> Type)

Defined in Language.Haskell.TH.Lift.Generics

Methods

gliftArgs :: Quote m => UDouble a -> [m Exp]

GLiftArgs (UFloat :: Type -> Type)

Defined in Language.Haskell.TH.Lift.Generics

Methods

gliftArgs :: Quote m => UFloat a -> [m Exp]

GLiftArgs (UInt :: Type -> Type)

Defined in Language.Haskell.TH.Lift.Generics

Methods

gliftArgs :: Quote m => UInt a -> [m Exp]

GLiftArgs (UWord :: Type -> Type)

Defined in Language.Haskell.TH.Lift.Generics

Methods

gliftArgs :: Quote m => UWord a -> [m Exp]

Lift c => GLiftArgs (K1 i c :: Type -> Type)

Defined in Language.Haskell.TH.Lift.Generics

Methods

gliftArgs :: Quote m => K1 i c a -> [m Exp]

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

Defined in Language.Haskell.TH.Lift.Generics

Methods

gliftArgs :: Quote m => (f :*: g) a -> [m Exp]

GLiftArgs f => GLiftArgs (S1 s f)

Defined in Language.Haskell.TH.Lift.Generics

Methods

gliftArgs :: Quote m => S1 s f a -> [m Exp]

Lift reexport

class Lift t where

A Lift instance can have any of its values turned into a Template Haskell expression. This is needed when a value used within a Template Haskell quotation is bound outside the Oxford brackets ([| ... |]) but not at the top level. As an example:

add1 :: Int -> Q Exp
add1 x = [| x + 1 |]

Template Haskell has no way of knowing what value x will take on at splice-time, so it requires the type of x to be an instance of Lift.

A Lift instance must satisfy $(lift x) ≡ x for all x, where $(...) is a Template Haskell splice.

Lift instances can be derived automatically by use of the -XDeriveLift GHC language extension:

{-# LANGUAGE DeriveLift #-}
module Foo where

import Language.Haskell.TH.Syntax

data Bar a = Bar1 a (Bar a) | Bar2 String
  deriving Lift

Minimal complete definition

Nothing

Methods

lift :: t -> Q Exp

Turn a value into a Template Haskell expression, suitable for use in a splice.

Instances

Lift Bool

Defined in Language.Haskell.TH.Syntax

Methods

lift :: Bool -> Q Exp

Lift Char

Defined in Language.Haskell.TH.Syntax

Methods

lift :: Char -> Q Exp

Lift Double

Defined in Language.Haskell.TH.Syntax

Methods

lift :: Double -> Q Exp

Lift Float

Defined in Language.Haskell.TH.Syntax

Methods

lift :: Float -> Q Exp

Lift Int

Defined in Language.Haskell.TH.Syntax

Methods

lift :: Int -> Q Exp

Lift Int8

Defined in Language.Haskell.TH.Syntax

Methods

lift :: Int8 -> Q Exp

Lift Int16

Defined in Language.Haskell.TH.Syntax

Methods

lift :: Int16 -> Q Exp

Lift Int32

Defined in Language.Haskell.TH.Syntax

Methods

lift :: Int32 -> Q Exp

Lift Int64

Defined in Language.Haskell.TH.Syntax

Methods

lift :: Int64 -> Q Exp

Lift Integer

Defined in Language.Haskell.TH.Syntax

Methods

lift :: Integer -> Q Exp

Lift Natural

Defined in Language.Haskell.TH.Syntax

Methods

lift :: Natural -> Q Exp

Lift Word

Defined in Language.Haskell.TH.Syntax

Methods

lift :: Word -> Q Exp

Lift Word8

Defined in Language.Haskell.TH.Syntax

Methods

lift :: Word8 -> Q Exp

Lift Word16

Defined in Language.Haskell.TH.Syntax

Methods

lift :: Word16 -> Q Exp

Lift Word32

Defined in Language.Haskell.TH.Syntax

Methods

lift :: Word32 -> Q Exp

Lift Word64

Defined in Language.Haskell.TH.Syntax

Methods

lift :: Word64 -> Q Exp

Lift ()

Defined in Language.Haskell.TH.Syntax

Methods

lift :: () -> Q Exp

Lift a => Lift [a]

Defined in Language.Haskell.TH.Syntax

Methods

lift :: [a] -> Q Exp

Lift a => Lift (Maybe a)

Defined in Language.Haskell.TH.Syntax

Methods

lift :: Maybe a -> Q Exp

Integral a => Lift (Ratio a)

Defined in Language.Haskell.TH.Syntax

Methods

lift :: Ratio a -> Q Exp

(Lift a, Lift b) => Lift (Either a b)

Defined in Language.Haskell.TH.Syntax

Methods

lift :: Either a b -> Q Exp

(Lift a, Lift b) => Lift (a, b)

Defined in Language.Haskell.TH.Syntax

Methods

lift :: (a, b) -> Q Exp

(Lift a, Lift b, Lift c) => Lift (a, b, c)

Defined in Language.Haskell.TH.Syntax

Methods

lift :: (a, b, c) -> Q Exp

(Lift a, Lift b, Lift c, Lift d) => Lift (a, b, c, d)

Defined in Language.Haskell.TH.Syntax

Methods

lift :: (a, b, c, d) -> Q Exp

(Lift a, Lift b, Lift c, Lift d, Lift e) => Lift (a, b, c, d, e)

Defined in Language.Haskell.TH.Syntax

Methods

lift :: (a, b, c, d, e) -> Q Exp

(Lift a, Lift b, Lift c, Lift d, Lift e, Lift f) => Lift (a, b, c, d, e, f)

Defined in Language.Haskell.TH.Syntax

Methods

lift :: (a, b, c, d, e, f) -> Q Exp

(Lift a, Lift b, Lift c, Lift d, Lift e, Lift f, Lift g) => Lift (a, b, c, d, e, f, g)

Defined in Language.Haskell.TH.Syntax

Methods

lift :: (a, b, c, d, e, f, g) -> Q Exp