Language.Haskell.TH.Lib

TH.Lib contains lots of useful helper functions for generating and manipulating Template Haskell terms

Type synonyms

type InfoQ = Q Info

type PatQ = Q Pat

type FieldPatQ = Q FieldPat

type ExpQ = Q Exp

type TExpQ a = Q (TExp a)

type DecQ = Q Dec

type DecsQ = Q [Dec]

type ConQ = Q Con

type TypeQ = Q Type

type TyLitQ = Q TyLit

type CxtQ = Q Cxt

type PredQ = Q Pred

type MatchQ = Q Match

type ClauseQ = Q Clause

type BodyQ = Q Body

type GuardQ = Q Guard

type StmtQ = Q Stmt

type RangeQ = Q Range

type SourceStrictnessQ = Q SourceStrictness

type SourceUnpackednessQ = Q SourceUnpackedness

type BangQ = Q Bang

type BangTypeQ = Q BangType

type VarBangTypeQ = Q VarBangType

type StrictTypeQ = Q StrictType

type VarStrictTypeQ = Q VarStrictType

type FieldExpQ = Q FieldExp

type RuleBndrQ = Q RuleBndr

type TySynEqnQ = Q TySynEqn

type Role = Role

type InjectivityAnn = InjectivityAnn

Lowercase pattern syntax functions

intPrimL :: Integer -> Lit

wordPrimL :: Integer -> Lit

floatPrimL :: Rational -> Lit

doublePrimL :: Rational -> Lit

integerL :: Integer -> Lit

charL :: Char -> Lit

charPrimL :: Char -> Lit

stringL :: String -> Lit

stringPrimL :: [Word8] -> Lit

rationalL :: Rational -> Lit

litP :: Lit -> PatQ

varP :: Name -> PatQ

tupP :: [PatQ] -> PatQ

unboxedTupP :: [PatQ] -> PatQ

conP :: Name -> [PatQ] -> PatQ

infixP :: PatQ -> Name -> PatQ -> PatQ

uInfixP :: PatQ -> Name -> PatQ -> PatQ

parensP :: PatQ -> PatQ

tildeP :: PatQ -> PatQ

bangP :: PatQ -> PatQ

asP :: Name -> PatQ -> PatQ

wildP :: PatQ

recP :: Name -> [FieldPatQ] -> PatQ

listP :: [PatQ] -> PatQ

sigP :: PatQ -> TypeQ -> PatQ

viewP :: ExpQ -> PatQ -> PatQ

fieldPat :: Name -> PatQ -> FieldPatQ

Stmt

bindS :: PatQ -> ExpQ -> StmtQ

letS :: [DecQ] -> StmtQ

noBindS :: ExpQ -> StmtQ

parS :: [[StmtQ]] -> StmtQ

Range

fromR :: ExpQ -> RangeQ

fromThenR :: ExpQ -> ExpQ -> RangeQ

fromToR :: ExpQ -> ExpQ -> RangeQ

fromThenToR :: ExpQ -> ExpQ -> ExpQ -> RangeQ

Body

normalB :: ExpQ -> BodyQ

guardedB :: [Q (Guard, Exp)] -> BodyQ

Guard

normalG :: ExpQ -> GuardQ

normalGE :: ExpQ -> ExpQ -> Q (Guard, Exp)

patG :: [StmtQ] -> GuardQ

patGE :: [StmtQ] -> ExpQ -> Q (Guard, Exp)

Match and Clause

match :: PatQ -> BodyQ -> [DecQ] -> MatchQ

Use with caseE

clause :: [PatQ] -> BodyQ -> [DecQ] -> ClauseQ

Use with funD

Exp

dyn :: String -> ExpQ

Dynamically binding a variable (unhygenic)

varE :: Name -> ExpQ

conE :: Name -> ExpQ

litE :: Lit -> ExpQ

appE :: ExpQ -> ExpQ -> ExpQ

parensE :: ExpQ -> ExpQ

uInfixE :: ExpQ -> ExpQ -> ExpQ -> ExpQ

infixE :: Maybe ExpQ -> ExpQ -> Maybe ExpQ -> ExpQ

infixApp :: ExpQ -> ExpQ -> ExpQ -> ExpQ

sectionL :: ExpQ -> ExpQ -> ExpQ

sectionR :: ExpQ -> ExpQ -> ExpQ

lamE :: [PatQ] -> ExpQ -> ExpQ

lam1E :: PatQ -> ExpQ -> ExpQ

Single-arg lambda

lamCaseE :: [MatchQ] -> ExpQ

tupE :: [ExpQ] -> ExpQ

unboxedTupE :: [ExpQ] -> ExpQ

condE :: ExpQ -> ExpQ -> ExpQ -> ExpQ

multiIfE :: [Q (Guard, Exp)] -> ExpQ

letE :: [DecQ] -> ExpQ -> ExpQ

caseE :: ExpQ -> [MatchQ] -> ExpQ

doE :: [StmtQ] -> ExpQ

compE :: [StmtQ] -> ExpQ

arithSeqE :: RangeQ -> ExpQ

listE :: [ExpQ] -> ExpQ

sigE :: ExpQ -> TypeQ -> ExpQ

recConE :: Name -> [Q (Name, Exp)] -> ExpQ

recUpdE :: ExpQ -> [Q (Name, Exp)] -> ExpQ

stringE :: String -> ExpQ

fieldExp :: Name -> ExpQ -> Q (Name, Exp)

staticE :: ExpQ -> ExpQ

staticE x = [| static x |]

unboundVarE :: Name -> ExpQ

arithSeqE Shortcuts

fromE :: ExpQ -> ExpQ

fromThenE :: ExpQ -> ExpQ -> ExpQ

fromToE :: ExpQ -> ExpQ -> ExpQ

fromThenToE :: ExpQ -> ExpQ -> ExpQ -> ExpQ

Dec

valD :: PatQ -> BodyQ -> [DecQ] -> DecQ

funD :: Name -> [ClauseQ] -> DecQ

tySynD :: Name -> [TyVarBndr] -> TypeQ -> DecQ

dataD :: CxtQ -> Name -> [TyVarBndr] -> Maybe Kind -> [ConQ] -> CxtQ -> DecQ

newtypeD :: CxtQ -> Name -> [TyVarBndr] -> Maybe Kind -> ConQ -> CxtQ -> DecQ

classD :: CxtQ -> Name -> [TyVarBndr] -> [FunDep] -> [DecQ] -> DecQ

instanceD :: CxtQ -> TypeQ -> [DecQ] -> DecQ

instanceWithOverlapD :: Maybe Overlap -> CxtQ -> TypeQ -> [DecQ] -> DecQ

sigD :: Name -> TypeQ -> DecQ

forImpD :: Callconv -> Safety -> String -> Name -> TypeQ -> DecQ

infixLD :: Int -> Name -> DecQ

infixRD :: Int -> Name -> DecQ

infixND :: Int -> Name -> DecQ

pragInlD :: Name -> Inline -> RuleMatch -> Phases -> DecQ

pragSpecD :: Name -> TypeQ -> Phases -> DecQ

pragSpecInlD :: Name -> TypeQ -> Inline -> Phases -> DecQ

pragSpecInstD :: TypeQ -> DecQ

pragRuleD :: String -> [RuleBndrQ] -> ExpQ -> ExpQ -> Phases -> DecQ

pragAnnD :: AnnTarget -> ExpQ -> DecQ

pragLineD :: Int -> String -> DecQ

dataInstD :: CxtQ -> Name -> [TypeQ] -> Maybe Kind -> [ConQ] -> CxtQ -> DecQ

newtypeInstD :: CxtQ -> Name -> [TypeQ] -> Maybe Kind -> ConQ -> CxtQ -> DecQ

tySynInstD :: Name -> TySynEqnQ -> DecQ

dataFamilyD :: Name -> [TyVarBndr] -> Maybe Kind -> DecQ

openTypeFamilyD :: Name -> [TyVarBndr] -> FamilyResultSig -> Maybe InjectivityAnn -> DecQ

closedTypeFamilyD :: Name -> [TyVarBndr] -> FamilyResultSig -> Maybe InjectivityAnn -> [TySynEqnQ] -> DecQ

familyNoKindD :: FamFlavour -> Name -> [TyVarBndr] -> DecQ

Deprecated: This function will be removed in the next stable release. Use openTypeFamilyD/dataFamilyD instead.

familyKindD :: FamFlavour -> Name -> [TyVarBndr] -> Kind -> DecQ

Deprecated: This function will be removed in the next stable release. Use openTypeFamilyD/dataFamilyD instead.

closedTypeFamilyNoKindD :: Name -> [TyVarBndr] -> [TySynEqnQ] -> DecQ

Deprecated: This function will be removed in the next stable release. Use closedTypeFamilyD instead.

closedTypeFamilyKindD :: Name -> [TyVarBndr] -> Kind -> [TySynEqnQ] -> DecQ

Deprecated: This function will be removed in the next stable release. Use closedTypeFamilyD instead.

roleAnnotD :: Name -> [Role] -> DecQ

standaloneDerivD :: CxtQ -> TypeQ -> DecQ

defaultSigD :: Name -> TypeQ -> DecQ

tySynEqn :: [TypeQ] -> TypeQ -> TySynEqnQ

cxt :: [PredQ] -> CxtQ

normalC :: Name -> [BangTypeQ] -> ConQ

recC :: Name -> [VarBangTypeQ] -> ConQ

infixC :: Q (Bang, Type) -> Name -> Q (Bang, Type) -> ConQ

forallC :: [TyVarBndr] -> CxtQ -> ConQ -> ConQ

gadtC :: [Name] -> [StrictTypeQ] -> TypeQ -> ConQ

recGadtC :: [Name] -> [VarStrictTypeQ] -> TypeQ -> ConQ

Type

forallT :: [TyVarBndr] -> CxtQ -> TypeQ -> TypeQ

varT :: Name -> TypeQ

conT :: Name -> TypeQ

infixT :: TypeQ -> Name -> TypeQ -> TypeQ

uInfixT :: TypeQ -> Name -> TypeQ -> TypeQ

parensT :: TypeQ -> TypeQ

appT :: TypeQ -> TypeQ -> TypeQ

arrowT :: TypeQ

listT :: TypeQ

litT :: TyLitQ -> TypeQ

tupleT :: Int -> TypeQ

unboxedTupleT :: Int -> TypeQ

sigT :: TypeQ -> Kind -> TypeQ

equalityT :: TypeQ

wildCardT :: TypeQ

classP :: Name -> [Q Type] -> Q Pred

Deprecated: As of template-haskell-2.10, constraint predicates (Pred) are just types (Type), in keeping with ConstraintKinds. Please use conT and appT.

equalP :: TypeQ -> TypeQ -> PredQ

Deprecated: As of template-haskell-2.10, constraint predicates (Pred) are just types (Type), in keeping with ConstraintKinds. Please see equalityT.

promotedT :: Name -> TypeQ

promotedTupleT :: Int -> TypeQ

promotedNilT :: TypeQ

promotedConsT :: TypeQ

noSourceUnpackedness :: SourceUnpackednessQ

sourceNoUnpack :: SourceUnpackednessQ

sourceUnpack :: SourceUnpackednessQ

noSourceStrictness :: SourceStrictnessQ

sourceLazy :: SourceStrictnessQ

sourceStrict :: SourceStrictnessQ

isStrict :: Q Strict

Deprecated: Use bang. See https://ghc.haskell.org/trac/ghc/wiki/Migration/8.0. Example usage: 'bang noSourceUnpackedness sourceStrict'

notStrict :: Q Strict

Deprecated: Use bang. See https://ghc.haskell.org/trac/ghc/wiki/Migration/8.0. Example usage: 'bang noSourceUnpackedness noSourceStrictness'

unpacked :: Q Strict

Deprecated: Use bang. See https://ghc.haskell.org/trac/ghc/wiki/Migration/8.0. Example usage: 'bang sourceUnpack sourceStrict'

bang :: SourceUnpackednessQ -> SourceStrictnessQ -> BangQ

bangType :: BangQ -> TypeQ -> BangTypeQ

varBangType :: Name -> BangTypeQ -> VarBangTypeQ

strictType :: Q Strict -> TypeQ -> StrictTypeQ

Deprecated: As of template-haskell-2.11.0.0, StrictType has been replaced by BangType. Please use bangType instead.

varStrictType :: Name -> StrictTypeQ -> VarStrictTypeQ

Deprecated: As of template-haskell-2.11.0.0, VarStrictType has been replaced by VarBangType. Please use varBangType instead.

Type Literals

numTyLit :: Integer -> TyLitQ

strTyLit :: String -> TyLitQ

Kind

plainTV :: Name -> TyVarBndr

kindedTV :: Name -> Kind -> TyVarBndr

varK :: Name -> Kind

conK :: Name -> Kind

tupleK :: Int -> Kind

arrowK :: Kind

listK :: Kind

appK :: Kind -> Kind -> Kind

starK :: Kind

constraintK :: Kind

Type family result

noSig :: FamilyResultSig

kindSig :: Kind -> FamilyResultSig

tyVarSig :: TyVarBndr -> FamilyResultSig

Injectivity annotation

injectivityAnn :: Name -> [Name] -> InjectivityAnn

Role

nominalR :: Role

representationalR :: Role

phantomR :: Role

inferR :: Role

Callconv

cCall :: Callconv

stdCall :: Callconv

cApi :: Callconv

prim :: Callconv

javaScript :: Callconv

Safety

unsafe :: Safety

safe :: Safety

interruptible :: Safety

FunDep

funDep :: [Name] -> [Name] -> FunDep

FamFlavour

typeFam :: FamFlavour

dataFam :: FamFlavour

RuleBndr

ruleVar :: Name -> RuleBndrQ

typedRuleVar :: Name -> TypeQ -> RuleBndrQ

AnnTarget

valueAnnotation :: Name -> AnnTarget

typeAnnotation :: Name -> AnnTarget

moduleAnnotation :: AnnTarget

Useful helper function

appsE :: [ExpQ] -> ExpQ

thisModule :: Q Module

Return the Module at the place of splicing. Can be used as an input for reifyModule.