Moduletemplate-haskell-2.25.0.0Haskell2010

Language.Haskell.TH.Lib

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

Contents

Library functions
Abbreviations
Constructors lifted to Q
Literals
Patterns
Pattern Guards
Expressions
Ranges
Ranges with more indirection
Statements
Types
Type literals
Strictness
Class Contexts
Constructors
Kinds
Type variable binders
Roles
Top Level Declarations
Data
Class
Role annotations
Type Family / Data Family
Fixity
Default declaration
Foreign Function Interface (FFI)
Functional dependencies
Pragmas
Pattern Synonyms
Implicit Parameters
Reify
Documentation

Synopsis

type InfoQ
type ExpQ
type TExpQ
type CodeQ
type DecQ
type DecsQ
type ConQ
type TypeQ
type KindQ
type TyLitQ
type CxtQ
type PredQ
type DerivClauseQ
type MatchQ
type ClauseQ
type BodyQ
type GuardQ
type StmtQ
type RangeQ
type SourceStrictnessQ
type SourceUnpackednessQ
type BangQ
type BangTypeQ
type VarBangTypeQ
type StrictTypeQ
type VarStrictTypeQ
type FieldExpQ
type PatQ
type FieldPatQ
type RuleBndrQ
type TySynEqnQ
type PatSynDirQ
type PatSynArgsQ
type FamilyResultSigQ
type DerivStrategyQ
type TyVarBndrUnit
type TyVarBndrSpec
type TyVarBndrVis
value intPrimL
value wordPrimL
value floatPrimL
value doublePrimL
value integerL
value rationalL
value charL
value stringL
value stringPrimL
value charPrimL
value bytesPrimL
value mkBytes
value litP
value varP
value tupP
value unboxedTupP
value unboxedSumP
value conP
value uInfixP
value parensP
value infixP
value tildeP
value bangP
value asP
value wildP
value recP
value listP
value sigP
value viewP
value typeP
value invisP
value fieldPat
value normalB
value guardedB
value normalG
value normalGE
value patG
value patGE
value match
value clause
value dyn
value varE
value unboundVarE
value labelE
value implicitParamVarE
value conE
value litE
value staticE
value appE
value appTypeE
value uInfixE
value parensE
value infixE
value infixApp
value sectionL
value sectionR
value lamE
value lam1E
value lamCaseE
value lamCasesE
value tupE
value unboxedTupE
value unboxedSumE
value condE
value multiIfE
value letE
value caseE
value appsE
value listE
value sigE
value recConE
value recUpdE
value stringE
value fieldExp
value getFieldE
value projectionE
value typedSpliceE
value typedBracketE
value typeE
value forallE
value forallVisE
value constrainedE
value fromE
value fromThenE
value fromToE
value fromThenToE
value arithSeqE
value fromR
value fromThenR
value fromToR
value fromThenToR
value doE
value mdoE
value compE
value bindS
value letS
value noBindS
value parS
value recS
value forallT
value forallVisT
value varT
value conT
value appT
value appKindT
value arrowT
value mulArrowT
value infixT
value uInfixT
value promotedInfixT
value promotedUInfixT
value parensT
value equalityT
value listT
value tupleT
value unboxedTupleT
value unboxedSumT
value sigT
value litT
value wildCardT
value promotedT
value promotedTupleT
value promotedNilT
value promotedConsT
value implicitParamT
value numTyLit
value strTyLit
value charTyLit
value noSourceUnpackedness
value sourceNoUnpack
value sourceUnpack
value noSourceStrictness
value sourceLazy
value sourceStrict
value isStrict
value notStrict
value unpacked
value bang
value bangType
value varBangType
value strictType
value varStrictType
value cxt
value classP
value equalP
value normalC
value recC
value infixC
value forallC
value gadtC
value recGadtC
value varK
value conK
value tupleK
value arrowK
value listK
value appK
value starK
value constraintK
class DefaultBndrFlag
value plainTV
value kindedTV
value plainInvisTV
value kindedInvisTV
value plainBndrTV
value kindedBndrTV
value specifiedSpec
value inferredSpec
value bndrReq
value bndrInvis
value nominalR
value representationalR
value phantomR
value inferR
value valD
value funD
value tySynD
value dataD
value newtypeD
value typeDataD
value derivClause
data DerivClause
value stockStrategy
value anyclassStrategy
value newtypeStrategy
value viaStrategy
data DerivStrategy
value classD
value instanceD
value instanceWithOverlapD
data Overlap
value sigD
value kiSigD
value standaloneDerivD
value standaloneDerivWithStrategyD
value defaultSigD
value roleAnnotD
value dataFamilyD
value openTypeFamilyD
value closedTypeFamilyD
value dataInstD
value newtypeInstD
value tySynInstD
value tySynEqn
value injectivityAnn
value noSig
value kindSig
value tyVarSig
value infixLD
value infixRD
value infixND
value defaultD
value cCall
value stdCall
value cApi
value prim
value javaScript
value unsafe
value safe
value interruptible
value forImpD
value funDep
value ruleVar
value typedRuleVar
value valueAnnotation
value typeAnnotation
value moduleAnnotation
value pragInlD
value pragSpecD
value pragSpecInlD
value pragSpecED
value pragSpecInlED
value pragSpecInstD
value pragRuleD
value pragAnnD
value pragLineD
value pragCompleteD
value patSynD
value patSynSigD
value unidir
value implBidir
value explBidir
value prefixPatSyn
value infixPatSyn
value recordPatSyn
value implicitParamBindD
value thisModule
value withDecDoc
value withDecsDoc
value funD_doc
value dataD_doc
value newtypeD_doc
value typeDataD_doc
value dataInstD_doc
value newtypeInstD_doc
value patSynD_doc

Packagetemplate-haskell-2.25.0.0
Exports294
LanguageHaskell2010
LicenceBSD-3-Clause
SourceLib.hs

Library functions

Abbreviations

typetype InfoQ = Q Info

typetype ExpQ = Q Exp

typetype TExpQ (a :: TYPE r) = Q (TExp a)

Source#

Representation-polymorphic since template-haskell-2.17.0.0.

typetype CodeQ = Code Q

typetype DecQ = Q Dec

typetype DecsQ = Q [Dec]

typetype ConQ = Q Con

typetype TypeQ = Q Type

typetype KindQ = Q Kind

typetype TyLitQ = Q TyLit

typetype CxtQ = Q Cxt

typetype PredQ = Q Pred

typetype DerivClauseQ = Q DerivClause

typetype MatchQ = Q Match

typetype ClauseQ = Q Clause

typetype BodyQ = Q Body

typetype GuardQ = Q Guard

typetype StmtQ = Q Stmt

typetype RangeQ = Q Range

typetype SourceStrictnessQ = Q SourceStrictness

typetype SourceUnpackednessQ = Q SourceUnpackedness

typetype BangQ = Q Bang

typetype BangTypeQ = Q BangType

typetype VarBangTypeQ = Q VarBangType

typetype StrictTypeQ = Q StrictType

typetype VarStrictTypeQ = Q VarStrictType

typetype FieldExpQ = Q FieldExp

typetype PatQ = Q Pat

typetype FieldPatQ = Q FieldPat

typetype RuleBndrQ = Q RuleBndr

typetype TySynEqnQ = Q TySynEqn

typetype PatSynDirQ = Q PatSynDir

typetype PatSynArgsQ = Q PatSynArgs

typetype FamilyResultSigQ = Q FamilyResultSig

typetype DerivStrategyQ = Q DerivStrategy

typetype TyVarBndrUnit = TyVarBndr ()

typetype TyVarBndrSpec = TyVarBndr Specificity

typetype TyVarBndrVis = TyVarBndr BndrVis

Constructors lifted to Q

Literals

valueintPrimL :: Integer -> Lit

valuewordPrimL :: Integer -> Lit

valuefloatPrimL :: Rational -> Lit

valuedoublePrimL :: Rational -> Lit

valueintegerL :: Integer -> Lit

valuerationalL :: Rational -> Lit

valuecharL :: Char -> Lit

valuestringL :: String -> Lit

valuestringPrimL :: [Word8] -> Lit

valuecharPrimL :: Char -> Lit

valuebytesPrimL :: Bytes -> Lit

valuemkBytes

:: ForeignPtr Word8
Pointer to the data
-> Word
Offset from the pointer
-> Word
Number of bytes
-> Bytes

Source#

Create a Bytes datatype representing raw bytes to be embedded into the program/library binary.

Patterns

valuelitP :: Quote m => Lit -> m Pat

valuevarP :: Quote m => Name -> m Pat

valuetupP :: Quote m => [m Pat] -> m Pat

valueunboxedTupP :: Quote m => [m Pat] -> m Pat

valueunboxedSumP :: Quote m => m Pat -> SumAlt -> SumArity -> m Pat

valueconP :: Quote m => Name -> [m Pat] -> m Pat

valueuInfixP :: Quote m => m Pat -> Name -> m Pat -> m Pat

valueparensP :: Quote m => m Pat -> m Pat

valueinfixP :: Quote m => m Pat -> Name -> m Pat -> m Pat

valuetildeP :: Quote m => m Pat -> m Pat

valuebangP :: Quote m => m Pat -> m Pat

valueasP :: Quote m => Name -> m Pat -> m Pat

valuewildP :: Quote m => m Pat

valuerecP :: Quote m => Name -> [m FieldPat] -> m Pat

valuelistP :: Quote m => [m Pat] -> m Pat

valuesigP :: Quote m => m Pat -> m Type -> m Pat

valueviewP :: Quote m => m Exp -> m Pat -> m Pat

valuetypeP :: Quote m => m Type -> m Pat

valueinvisP :: Quote m => m Type -> m Pat

valuefieldPat :: Quote m => Name -> m Pat -> m FieldPat

Pattern Guards

valuenormalB :: Quote m => m Exp -> m Body

valueguardedB :: Quote m => [m (Guard, Exp)] -> m Body

valuenormalG :: Quote m => m Exp -> m Guard

valuenormalGE :: Quote m => m Exp -> m Exp -> m (Guard, Exp)

valuepatG :: Quote m => [m Stmt] -> m Guard

valuepatGE :: Quote m => [m Stmt] -> m Exp -> m (Guard, Exp)

valuematch :: Quote m => m Pat -> m Body -> [m Dec] -> m Match

Source#

Use with caseE

valueclause :: Quote m => [m Pat] -> m Body -> [m Dec] -> m Clause

Source#

Use with funD

Expressions

valuedyn :: Quote m => String -> m Exp

Source#

Dynamically binding a variable (unhygienic)

valuevarE :: Quote m => Name -> m Exp

valueunboundVarE :: Quote m => Name -> m Exp

valuelabelE :: Quote m => String -> m Exp

valueimplicitParamVarE :: Quote m => String -> m Exp

valueconE :: Quote m => Name -> m Exp

valuelitE :: Quote m => Lit -> m Exp

valuestaticE :: Quote m => m Exp -> m Exp

Source#

staticE x = [| static x |]

valueappE :: Quote m => m Exp -> m Exp -> m Exp

valueappTypeE :: Quote m => m Exp -> m Type -> m Exp

valueuInfixE :: Quote m => m Exp -> m Exp -> m Exp -> m Exp

valueparensE :: Quote m => m Exp -> m Exp

valueinfixE :: Quote m => Maybe (m Exp) -> m Exp -> Maybe (m Exp) -> m Exp

valueinfixApp :: Quote m => m Exp -> m Exp -> m Exp -> m Exp

valuesectionL :: Quote m => m Exp -> m Exp -> m Exp

valuesectionR :: Quote m => m Exp -> m Exp -> m Exp

valuelamE :: Quote m => [m Pat] -> m Exp -> m Exp

valuelam1E :: Quote m => m Pat -> m Exp -> m Exp

Source#

Single-arg lambda

valuelamCaseE :: Quote m => [m Match] -> m Exp

Source#

Lambda-case (case)

valuelamCasesE :: Quote m => [m Clause] -> m Exp

Source#

Lambda-cases (cases)

valuetupE :: Quote m => [m Exp] -> m Exp

valueunboxedTupE :: Quote m => [m Exp] -> m Exp

valueunboxedSumE :: Quote m => m Exp -> SumAlt -> SumArity -> m Exp

valuecondE :: Quote m => m Exp -> m Exp -> m Exp -> m Exp

valuemultiIfE :: Quote m => [m (Guard, Exp)] -> m Exp

valueletE :: Quote m => [m Dec] -> m Exp -> m Exp

valuecaseE :: Quote m => m Exp -> [m Match] -> m Exp

valueappsE :: Quote m => [m Exp] -> m Exp

valuelistE :: Quote m => [m Exp] -> m Exp

valuesigE :: Quote m => m Exp -> m Type -> m Exp

valuerecConE :: Quote m => Name -> [m (Name, Exp)] -> m Exp

valuerecUpdE :: Quote m => m Exp -> [m (Name, Exp)] -> m Exp

valuestringE :: Quote m => String -> m Exp

valuefieldExp :: Quote m => Name -> m Exp -> m (Name, Exp)

valuegetFieldE :: Quote m => m Exp -> String -> m Exp

valueprojectionE :: Quote m => NonEmpty String -> m Exp

valuetypedSpliceE :: Quote m => m Exp -> m Exp

valuetypedBracketE :: Quote m => m Exp -> m Exp

valuetypeE :: Quote m => m Type -> m Exp

valueforallE :: Quote m => [m (TyVarBndr Specificity)] -> m Exp -> m Exp

valueforallVisE :: Quote m => [m (TyVarBndr ())] -> m Exp -> m Exp

valueconstrainedE :: Quote m => [m Exp] -> m Exp -> m Exp

Ranges

valuefromE :: Quote m => m Exp -> m Exp

valuefromThenE :: Quote m => m Exp -> m Exp -> m Exp

valuefromToE :: Quote m => m Exp -> m Exp -> m Exp

valuefromThenToE :: Quote m => m Exp -> m Exp -> m Exp -> m Exp

Ranges with more indirection

valuearithSeqE :: Quote m => m Range -> m Exp

valuefromR :: Quote m => m Exp -> m Range

valuefromThenR :: Quote m => m Exp -> m Exp -> m Range

valuefromToR :: Quote m => m Exp -> m Exp -> m Range

valuefromThenToR :: Quote m => m Exp -> m Exp -> m Exp -> m Range

Statements

valuedoE :: Quote m => [m Stmt] -> m Exp

valuemdoE :: Quote m => [m Stmt] -> m Exp

valuecompE :: Quote m => [m Stmt] -> m Exp

valuebindS :: Quote m => m Pat -> m Exp -> m Stmt

valueletS :: Quote m => [m Dec] -> m Stmt

valuenoBindS :: Quote m => m Exp -> m Stmt

valueparS :: Quote m => [[m Stmt]] -> m Stmt

valuerecS :: Quote m => [m Stmt] -> m Stmt

Types

valueforallT :: Quote m => [TyVarBndr Specificity] -> m Cxt -> m Type -> m Type

valueforallVisT :: Quote m => [m (TyVarBndr ())] -> m Type -> m Type

valuevarT :: Quote m => Name -> m Type

valueconT :: Quote m => Name -> m Type

valueappT :: Quote m => m Type -> m Type -> m Type

valueappKindT :: Quote m => m Type -> m Kind -> m Type

valuearrowT :: Quote m => m Type

valuemulArrowT :: Quote m => m Type

valueinfixT :: Quote m => m Type -> Name -> m Type -> m Type

valueuInfixT :: Quote m => m Type -> Name -> m Type -> m Type

valuepromotedInfixT :: Quote m => m Type -> Name -> m Type -> m Type

valuepromotedUInfixT :: Quote m => m Type -> Name -> m Type -> m Type

valueparensT :: Quote m => m Type -> m Type

valueequalityT :: Quote m => m Type

valuelistT :: Quote m => m Type

valuetupleT :: Quote m => Int -> m Type

valueunboxedTupleT :: Quote m => Int -> m Type

valueunboxedSumT :: Quote m => SumArity -> m Type

valuesigT :: Quote m => m Type -> Kind -> m Type

valuelitT :: Quote m => m TyLit -> m Type

valuewildCardT :: Quote m => m Type

valuepromotedT :: Quote m => Name -> m Type

valuepromotedTupleT :: Quote m => Int -> m Type

valuepromotedNilT :: Quote m => m Type

valuepromotedConsT :: Quote m => m Type

valueimplicitParamT :: Quote m => String -> m Type -> m Type

Type literals

valuenumTyLit :: Quote m => Integer -> m TyLit

valuestrTyLit :: Quote m => String -> m TyLit

valuecharTyLit :: Quote m => Char -> m TyLit

Strictness

valuenoSourceUnpackedness :: Quote m => m SourceUnpackedness

valuesourceNoUnpack :: Quote m => m SourceUnpackedness

valuesourceUnpack :: Quote m => m SourceUnpackedness

valuenoSourceStrictness :: Quote m => m SourceStrictness

valuesourceLazy :: Quote m => m SourceStrictness

valuesourceStrict :: Quote m => m SourceStrictness

valueisStrict :: Quote m => m Strict

Deprecated. Use bang. See https://gitlab.haskell.org/ghc/ghc/wikis/migration/8.0. Example usage: 'bang noSourceUnpackedness sourceStrict'

valuenotStrict :: Quote m => m Strict

Deprecated. Use bang. See https://gitlab.haskell.org/ghc/ghc/wikis/migration/8.0. Example usage: 'bang noSourceUnpackedness noSourceStrictness'

valueunpacked :: Quote m => m Strict

Deprecated. Use bang. See https://gitlab.haskell.org/ghc/ghc/wikis/migration/8.0. Example usage: 'bang sourceUnpack sourceStrict'

valuebang :: Quote m => m SourceUnpackedness -> m SourceStrictness -> m Bang

valuebangType :: Quote m => m Bang -> m Type -> m BangType

valuevarBangType :: Quote m => Name -> m BangType -> m VarBangType

valuestrictType :: Quote m => m Strict -> m Type -> m StrictType

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

valuevarStrictType :: Quote m => Name -> m StrictType -> m VarStrictType

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

Class Contexts

valuecxt :: Quote m => [m Pred] -> m Cxt

valueclassP :: Quote m => Name -> [m Type] -> m Pred

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

valueequalP :: Quote m => m Type -> m Type -> m Pred

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

Constructors

valuenormalC :: Quote m => Name -> [m BangType] -> m Con

valuerecC :: Quote m => Name -> [m VarBangType] -> m Con

valueinfixC :: Quote m => m (Bang, Type) -> Name -> m (Bang, Type) -> m Con

valueforallC :: Quote m => [TyVarBndr Specificity] -> m Cxt -> m Con -> m Con

valuegadtC :: Quote m => [Name] -> [m StrictType] -> m Type -> m Con

valuerecGadtC :: Quote m => [Name] -> [m VarStrictType] -> m Type -> m Con

Kinds

valuevarK :: Name -> Kind

valueconK :: Name -> Kind

valuetupleK :: Int -> Kind

valuearrowK :: Kind

valuelistK :: Kind

valueappK :: Kind -> Kind -> Kind

valuestarK :: Kind

valueconstraintK :: Kind

Type variable binders

classclass DefaultBndrFlag flag where

Methods

defaultBndrFlag :: flag

Instances3DefaultBndrFlag

DefaultBndrFlag BndrVisDefined in template-haskell-2.25.0.0 · Language.Haskell.TH.Lib
DefaultBndrFlag SpecificityDefined in template-haskell-2.25.0.0 · Language.Haskell.TH.Lib
DefaultBndrFlag ()Defined in template-haskell-2.25.0.0 · Language.Haskell.TH.Lib

valueplainTV :: DefaultBndrFlag flag => Name -> TyVarBndr flag

valuekindedTV :: DefaultBndrFlag flag => Name -> Kind -> TyVarBndr flag

valueplainInvisTV :: Quote m => Name -> Specificity -> m (TyVarBndr Specificity)

valuekindedInvisTV

:: Quote m
=> Name
-> Specificity
-> m Kind
-> m (TyVarBndr Specificity)

valueplainBndrTV :: Quote m => Name -> BndrVis -> m (TyVarBndr BndrVis)

valuekindedBndrTV

:: Quote m
=> Name
-> BndrVis
-> m Kind
-> m (TyVarBndr BndrVis)

valuespecifiedSpec :: Specificity

valueinferredSpec :: Specificity

valuebndrReq :: BndrVis

valuebndrInvis :: BndrVis

Roles

valuenominalR :: Role

valuerepresentationalR :: Role

valuephantomR :: Role

valueinferR :: Role

Top Level Declarations

Data

valuevalD :: Quote m => m Pat -> m Body -> [m Dec] -> m Dec

valuefunD :: Quote m => Name -> [m Clause] -> m Dec

valuetySynD :: Quote m => Name -> [TyVarBndr BndrVis] -> m Type -> m Dec

valuedataD

:: Quote m
=> m Cxt
-> Name
-> [TyVarBndr BndrVis]
-> Maybe Kind
-> [m Con]
-> [m DerivClause]
-> m Dec

valuenewtypeD

:: Quote m
=> m Cxt
-> Name
-> [TyVarBndr BndrVis]
-> Maybe Kind
-> m Con
-> [m DerivClause]
-> m Dec

valuetypeDataD

:: Quote m
=> Name
-> [TyVarBndr BndrVis]
-> Maybe Kind
-> [m Con]
-> m Dec

valuederivClause :: Quote m => Maybe DerivStrategy -> [m Pred] -> m DerivClause

datadata DerivClause

Source#

A single deriving clause at the end of a datatype declaration.

Constructors

DerivClause (Maybe DerivStrategy) Cxt
```
{ deriving stock (Eq, Ord) }
```

Instances7Eq, Data, Ord, Show, Generic, Lift, …

Eq DerivClauseDefined in ghc-internal-10.0.0 · GHC.Internal.TH.Syntax
Data DerivClauseDefined in ghc-internal-10.0.0 · GHC.Internal.Data.Data
Ord DerivClauseDefined in ghc-internal-10.0.0 · GHC.Internal.TH.Syntax
Show DerivClauseDefined in ghc-internal-10.0.0 · GHC.Internal.TH.Syntax
Generic DerivClauseDefined in ghc-internal-10.0.0 · GHC.Internal.TH.Syntax
Lift DerivClauseDefined in ghc-internal-10.0.0 · GHC.Internal.TH.Lift
type Rep DerivClause = D1 ('MetaData "DerivClause" "GHC.Internal.TH.Syntax" "ghc-internal" 'False) (C1 ('MetaCons "DerivClause" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe DerivStrategy)) :*: S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Cxt)))Defined in ghc-internal-10.0.0 · GHC.Internal.TH.Syntax

valuestockStrategy :: Quote m => m DerivStrategy

valueanyclassStrategy :: Quote m => m DerivStrategy

valuenewtypeStrategy :: Quote m => m DerivStrategy

valueviaStrategy :: Quote m => m Type -> m DerivStrategy

datadata DerivStrategy

Source#

What the user explicitly requests when deriving an instance with -XDerivingStrategies.

Constructors

StockStrategy
```
deriving {stock} C
```
AnyclassStrategy
deriving {anyclass} C, -XDeriveAnyClass
NewtypeStrategy
deriving {newtype} C, -XGeneralizedNewtypeDeriving
ViaStrategy Type
deriving C {via T}, -XDerivingVia

Instances7Eq, Data, Ord, Show, Generic, Lift, …

Eq DerivStrategyDefined in ghc-internal-10.0.0 · GHC.Internal.TH.Syntax
Data DerivStrategyDefined in ghc-internal-10.0.0 · GHC.Internal.Data.Data
Ord DerivStrategyDefined in ghc-internal-10.0.0 · GHC.Internal.TH.Syntax
Show DerivStrategyDefined in ghc-internal-10.0.0 · GHC.Internal.TH.Syntax
Generic DerivStrategyDefined in ghc-internal-10.0.0 · GHC.Internal.TH.Syntax
Lift DerivStrategyDefined in ghc-internal-10.0.0 · GHC.Internal.TH.Lift
type Rep DerivStrategy = D1 ('MetaData "DerivStrategy" "GHC.Internal.TH.Syntax" "ghc-internal" 'False) ((C1 ('MetaCons "StockStrategy" 'PrefixI 'False) U1 :+: C1 ('MetaCons "AnyclassStrategy" 'PrefixI 'False) U1) :+: (C1 ('MetaCons "NewtypeStrategy" 'PrefixI 'False) U1 :+: C1 ('MetaCons "ViaStrategy" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Type))))Defined in ghc-internal-10.0.0 · GHC.Internal.TH.Syntax

Class

valueclassD

:: Quote m
=> m Cxt
-> Name
-> [TyVarBndr BndrVis]
-> [FunDep]
-> [m Dec]
-> m Dec

valueinstanceD :: Quote m => m Cxt -> m Type -> [m Dec] -> m Dec

valueinstanceWithOverlapD

:: Quote m
=> Maybe Overlap
-> m Cxt
-> m Type
-> [m Dec]
-> m Dec

datadata Overlap

Source#

Varieties of allowed instance overlap.

Constructors

Overlappable
May be overlapped by more specific instances
Overlapping
May overlap a more general instance
Overlaps
Both Overlapping and Overlappable
Incoherent
Both Overlapping and Overlappable, and pick an arbitrary one if multiple choices are available.

Instances7Eq, Data, Ord, Show, Generic, Lift, …

Eq OverlapDefined in ghc-internal-10.0.0 · GHC.Internal.TH.Syntax
Data OverlapDefined in ghc-internal-10.0.0 · GHC.Internal.Data.Data
Ord OverlapDefined in ghc-internal-10.0.0 · GHC.Internal.TH.Syntax
Show OverlapDefined in ghc-internal-10.0.0 · GHC.Internal.TH.Syntax
Generic OverlapDefined in ghc-internal-10.0.0 · GHC.Internal.TH.Syntax
Lift OverlapDefined in ghc-internal-10.0.0 · GHC.Internal.TH.Lift
type Rep Overlap = D1 ('MetaData "Overlap" "GHC.Internal.TH.Syntax" "ghc-internal" 'False) ((C1 ('MetaCons "Overlappable" 'PrefixI 'False) U1 :+: C1 ('MetaCons "Overlapping" 'PrefixI 'False) U1) :+: (C1 ('MetaCons "Overlaps" 'PrefixI 'False) U1 :+: C1 ('MetaCons "Incoherent" 'PrefixI 'False) U1))Defined in ghc-internal-10.0.0 · GHC.Internal.TH.Syntax

valuesigD :: Quote m => Name -> m Type -> m Dec

valuekiSigD :: Quote m => Name -> m Kind -> m Dec

valuestandaloneDerivD :: Quote m => m Cxt -> m Type -> m Dec

valuestandaloneDerivWithStrategyD

:: Quote m
=> Maybe DerivStrategy
-> m Cxt
-> m Type
-> m Dec

valuedefaultSigD :: Quote m => Name -> m Type -> m Dec

Role annotations

valueroleAnnotD :: Quote m => Name -> [Role] -> m Dec

Type Family / Data Family

valuedataFamilyD :: Quote m => Name -> [TyVarBndr BndrVis] -> Maybe Kind -> m Dec

valueopenTypeFamilyD

:: Quote m
=> Name
-> [TyVarBndr BndrVis]
-> FamilyResultSig
-> Maybe InjectivityAnn
-> m Dec

valueclosedTypeFamilyD

:: Quote m
=> Name
-> [TyVarBndr BndrVis]
-> FamilyResultSig
-> Maybe InjectivityAnn
-> [m TySynEqn]
-> m Dec

valuedataInstD

:: Quote m
=> m Cxt
-> Name
-> [m Type]
-> Maybe Kind
-> [m Con]
-> [m DerivClause]
-> m Dec

valuenewtypeInstD

:: Quote m
=> m Cxt
-> Name
-> [m Type]
-> Maybe Kind
-> m Con
-> [m DerivClause]
-> m Dec

valuetySynInstD :: Quote m => m TySynEqn -> m Dec

valuetySynEqn

:: Quote m
=> Maybe [TyVarBndr ()]
-> m Type
-> m Type
-> m TySynEqn

valueinjectivityAnn :: Name -> [Name] -> InjectivityAnn

valuenoSig :: FamilyResultSig

valuekindSig :: Kind -> FamilyResultSig

valuetyVarSig :: TyVarBndr () -> FamilyResultSig

Fixity

valueinfixLD :: Quote m => Int -> Name -> m Dec

valueinfixRD :: Quote m => Int -> Name -> m Dec

valueinfixND :: Quote m => Int -> Name -> m Dec

Default declaration

valuedefaultD :: Quote m => [m Type] -> m Dec

Foreign Function Interface (FFI)

valuecCall :: Callconv

valuestdCall :: Callconv

valuecApi :: Callconv

valueprim :: Callconv

valuejavaScript :: Callconv

valueunsafe :: Safety

valuesafe :: Safety

valueinterruptible :: Safety

valueforImpD

:: Quote m
=> Callconv
-> Safety
-> String
-> Name
-> m Type
-> m Dec

Functional dependencies

valuefunDep :: [Name] -> [Name] -> FunDep

Pragmas

valueruleVar :: Quote m => Name -> m RuleBndr

valuetypedRuleVar :: Quote m => Name -> m Type -> m RuleBndr

valuevalueAnnotation :: Name -> AnnTarget

valuetypeAnnotation :: Name -> AnnTarget

valuemoduleAnnotation :: AnnTarget

valuepragInlD :: Quote m => Name -> Inline -> RuleMatch -> Phases -> m Dec

valuepragSpecD :: Quote m => Name -> m Type -> Phases -> m Dec

valuepragSpecInlD :: Quote m => Name -> m Type -> Inline -> Phases -> m Dec

valuepragSpecED

:: Quote m
=> Maybe [m (TyVarBndr ())]
-> [m RuleBndr]
-> m Exp
-> Phases
-> m Dec

valuepragSpecInlED

:: Quote m
=> Maybe [m (TyVarBndr ())]
-> [m RuleBndr]
-> m Exp
-> Inline
-> Phases
-> m Dec

valuepragSpecInstD :: Quote m => m Type -> m Dec

valuepragRuleD

:: Quote m
=> String
-> [m RuleBndr]
-> m Exp
-> m Exp
-> Phases
-> m Dec

valuepragAnnD :: Quote m => AnnTarget -> m Exp -> m Dec

valuepragLineD :: Quote m => Int -> String -> m Dec

valuepragCompleteD :: Quote m => [Name] -> Maybe Name -> m Dec

Pattern Synonyms

valuepatSynD :: Quote m => Name -> m PatSynArgs -> m PatSynDir -> m Pat -> m Dec

Source#

Pattern synonym declaration

valuepatSynSigD :: Quote m => Name -> m Type -> m Dec

Source#

Pattern synonym type signature

valueunidir :: Quote m => m PatSynDir

valueimplBidir :: Quote m => m PatSynDir

valueexplBidir :: Quote m => [m Clause] -> m PatSynDir

valueprefixPatSyn :: Quote m => [Name] -> m PatSynArgs

valueinfixPatSyn :: Quote m => Name -> Name -> m PatSynArgs

valuerecordPatSyn :: Quote m => [Name] -> m PatSynArgs

Implicit Parameters

valueimplicitParamBindD :: Quote m => String -> m Exp -> m Dec

Source#

Implicit parameter binding declaration. Can only be used in let and where clauses which consist entirely of implicit bindings.

Reify

valuethisModule :: Q Module

Source#

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

Documentation

valuewithDecDoc :: String -> Q Dec -> Q Dec

Source#

Attaches Haddock documentation to the declaration provided. Unlike putDoc, the names do not need to be in scope when calling this function so it can be used for quoted declarations and anything else currently being spliced. Not all declarations can have documentation attached to them. For those that can't, withDecDoc will return it unchanged without any side effects.

valuewithDecsDoc :: String -> Q [Dec] -> Q [Dec]

Source#

Variant of withDecDoc that applies the same documentation to multiple declarations. Useful for documenting quoted declarations.

valuefunD_doc

:: Name
-> [Q Clause]
-> Maybe String
Documentation to attach to function
-> [Maybe String]
Documentation to attach to arguments
-> Q Dec

Source#

Variant of funD that attaches Haddock documentation.

valuedataD_doc

:: Q Cxt
-> Name
-> [Q (TyVarBndr BndrVis)]
-> Maybe (Q Kind)
-> [(Q Con, Maybe String, [Maybe String])]
List of constructors, documentation for the constructor, and documentation for the arguments
-> [Q DerivClause]
-> Maybe String
Documentation to attach to the data declaration
-> Q Dec

Source#

Variant of dataD that attaches Haddock documentation.

valuenewtypeD_doc

:: Q Cxt
-> Name
-> [Q (TyVarBndr BndrVis)]
-> Maybe (Q Kind)
-> (Q Con, Maybe String, [Maybe String])
The constructor, documentation for the constructor, and documentation for the arguments
-> [Q DerivClause]
-> Maybe String
Documentation to attach to the newtype declaration
-> Q Dec

Source#

Variant of newtypeD that attaches Haddock documentation.

valuetypeDataD_doc

:: Name
-> [Q (TyVarBndr BndrVis)]
-> Maybe (Q Kind)
-> [(Q Con, Maybe String, [Maybe String])]
List of constructors, documentation for the constructor, and documentation for the arguments
-> Maybe String
Documentation to attach to the data declaration
-> Q Dec

Source#

Variant of typeDataD that attaches Haddock documentation.

valuedataInstD_doc

:: Q Cxt
-> Maybe [Q (TyVarBndr ())]
-> Q Type
-> Maybe (Q Kind)
-> [(Q Con, Maybe String, [Maybe String])]
List of constructors, documentation for the constructor, and documentation for the arguments
-> [Q DerivClause]
-> Maybe String
Documentation to attach to the instance declaration
-> Q Dec

Source#

Variant of dataInstD that attaches Haddock documentation.

valuenewtypeInstD_doc

:: Q Cxt
-> Maybe [Q (TyVarBndr ())]
-> Q Type
-> Maybe (Q Kind)
-> (Q Con, Maybe String, [Maybe String])
The constructor, documentation for the constructor, and documentation for the arguments
-> [Q DerivClause]
-> Maybe String
Documentation to attach to the instance declaration
-> Q Dec

Source#

Variant of newtypeInstD that attaches Haddock documentation.

valuepatSynD_doc

:: Name
-> Q PatSynArgs
-> Q PatSynDir
-> Q Pat
-> Maybe String
Documentation to attach to the pattern synonym
-> [Maybe String]
Documentation to attach to the pattern arguments
-> Q Dec

Source#

Variant of patSynD that attaches Haddock documentation.