Moduleghc-internal-10.0.0Haskell2010

GHC.Internal.TH.Lib

GHC.Internal.TH.Lib exposes some additional functionality that is used internally in GHC's integration with Template Haskell. This is not a part of the public API, and as such, there are no API guarantees for this module from version to version.

Contents

Type synonyms
Lowercase pattern syntax functions
Stmt
Range
Body
Guard
Match and Clause
Exp
arithSeqE Shortcuts
Dec
Type
Type Literals
Kind
Type family result
Injectivity annotation
Role
Callconv
Safety
FunDep
RuleBndr
AnnTarget
Pattern Synonyms (sub constructs)
Useful helper function
Documentation combinators

Synopsis

type TExpQ
type CodeQ
type InfoQ
type PatQ
type FieldPatQ
type ExpQ
type DecQ
type DecsQ
type Decs
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 RuleBndrQ
type TySynEqnQ
type PatSynDirQ
type PatSynArgsQ
type FamilyResultSigQ
type DerivStrategyQ
type Role
type InjectivityAnn
type TyVarBndrUnit
type TyVarBndrSpec
type TyVarBndrVis
value intPrimL
value wordPrimL
value floatPrimL
value doublePrimL
value integerL
value charL
value charPrimL
value stringL
value stringPrimL
value bytesPrimL
value rationalL
value litP
value varP
value tupP
value unboxedTupP
value unboxedSumP
value conP
value infixP
value uInfixP
value parensP
value tildeP
value bangP
value asP
value wildP
value recP
value listP
value sigP
value typeP
value invisP
value viewP
value orP
value fieldPat
value bindS
value letS
value noBindS
value parS
value recS
value fromR
value fromThenR
value fromToR
value fromThenToR
value normalB
value guardedB
value normalG
value normalGE
value patG
value patGE
value match
value clause
value dyn
value varE
value conE
value litE
value appE
value appTypeE
value parensE
value uInfixE
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 doE
value mdoE
value compE
value arithSeqE
value listE
value sigE
value recConE
value recUpdE
value stringE
value fieldExp
value staticE
value unboundVarE
value labelE
value implicitParamVarE
value getFieldE
value projectionE
value typedSpliceE
value typedBracketE
value fromE
value fromThenE
value fromToE
value fromThenToE
value typeE
value forallE
value forallVisE
value constrainedE
value valD
value funD
value tySynD
value dataD
value newtypeD
value typeDataD
value classD
value instanceD
value instanceWithOverlapD
value sigD
value kiSigD
value forImpD
value infixLD
value infixRD
value infixND
value infixLWithSpecD
value infixRWithSpecD
value infixNWithSpecD
value defaultD
value pragInlD
value pragOpaqueD
value pragSpecED
value pragSpecInlED
value pragSpecInstD
value pragRuleD
value pragAnnD
value pragLineD
value pragCompleteD
value pragSCCFunD
value pragSCCFunNamedD
value dataInstD
value newtypeInstD
value tySynInstD
value dataFamilyD
value openTypeFamilyD
value closedTypeFamilyD
value roleAnnotD
value standaloneDerivD
value standaloneDerivWithStrategyD
value defaultSigD
value patSynD
value patSynSigD
value implicitParamBindD
value tySynEqn
value cxt
value derivClause
value stockStrategy
value anyclassStrategy
value newtypeStrategy
value viaStrategy
value normalC
value recC
value infixC
value forallC
value gadtC
value recGadtC
value forallT
value forallVisT
value varT
value conT
value infixT
value uInfixT
value promotedInfixT
value promotedUInfixT
value parensT
value appT
value appKindT
value arrowT
value mulArrowT
value listT
value litT
value tupleT
value unboxedTupleT
value unboxedSumT
value sigT
value equalityT
value wildCardT
value implicitParamT
value promotedT
value promotedTupleT
value promotedNilT
value promotedConsT
value noSourceUnpackedness
value sourceNoUnpack
value sourceUnpack
value noSourceStrictness
value sourceLazy
value sourceStrict
value bang
value bangType
value varBangType
value numTyLit
value strTyLit
value charTyLit
value plainTV
value plainInvisTV
value plainBndrTV
value kindedTV
value kindedInvisTV
value kindedBndrTV
value specifiedSpec
value inferredSpec
value bndrReq
value bndrInvis
value varK
value conK
value tupleK
value arrowK
value listK
value appK
value starK
value constraintK
value noSig
value kindSig
value tyVarSig
value injectivityAnn
value nominalR
value representationalR
value phantomR
value inferR
value cCall
value stdCall
value cApi
value prim
value javaScript
value unsafe
value safe
value interruptible
value funDep
value ruleVar
value typedRuleVar
value valueAnnotation
value typeAnnotation
value moduleAnnotation
value unidir
value implBidir
value explBidir
value prefixPatSyn
value recordPatSyn
value infixPatSyn
value appsE
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
value docCons

Packageghc-internal-10.0.0
Exports291
LanguageHaskell2010
LicenceBSD-3-Clause
SourceLib.hs

Type synonyms

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

Source#

Representation-polymorphic since template-haskell-2.17.0.0.

typetype CodeQ = Code Q

typetype InfoQ = Q Info

typetype PatQ = Q Pat

typetype FieldPatQ = Q FieldPat

typetype ExpQ = Q Exp

typetype DecQ = Q Dec

typetype DecsQ = Q [Dec]

typetype Decs = [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 RuleBndrQ = Q RuleBndr

typetype TySynEqnQ = Q TySynEqn

typetype PatSynDirQ = Q PatSynDir

typetype PatSynArgsQ = Q PatSynArgs

typetype FamilyResultSigQ = Q FamilyResultSig

typetype DerivStrategyQ = Q DerivStrategy

typetype Role = Role

typetype InjectivityAnn = InjectivityAnn

typetype TyVarBndrUnit = TyVarBndr ()

typetype TyVarBndrSpec = TyVarBndr Specificity

typetype TyVarBndrVis = TyVarBndr BndrVis

Lowercase pattern syntax functions

valueintPrimL :: Integer -> Lit

valuewordPrimL :: Integer -> Lit

valuefloatPrimL :: Rational -> Lit

valuedoublePrimL :: Rational -> Lit

valueintegerL :: Integer -> Lit

valuecharL :: Char -> Lit

valuecharPrimL :: Char -> Lit

valuestringL :: String -> Lit

valuestringPrimL :: [Word8] -> Lit

valuebytesPrimL :: Bytes -> Lit

valuerationalL :: Rational -> Lit

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 Type] -> [m Pat] -> m Pat

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

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

valueparensP :: Quote m => 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

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

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

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

valueorP :: Quote m => NonEmpty (m Pat) -> m Pat

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

Stmt

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

Range

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

Body

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

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

Guard

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)

Match and Clause

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

Exp

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

Source#

Dynamically binding a variable (unhygienic)

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

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

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

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

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

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

valueuInfixE :: Quote m => m Exp -> m Exp -> 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 => [Maybe (m Exp)] -> m Exp

valueunboxedTupE :: Quote m => [Maybe (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

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

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

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

valuearithSeqE :: Quote m => m Range -> 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)

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

Source#

staticE x = [| static x |]

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

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

valueimplicitParamVarE :: Quote m => String -> m 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

arithSeqE Shortcuts

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

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

Dec

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

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

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

valuedataD

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

valuenewtypeD

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

valuetypeDataD

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

valueclassD

:: Quote m
=> m Cxt
-> Name
-> [m (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

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

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

valueforImpD

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

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

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

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

valueinfixLWithSpecD :: Quote m => Int -> NamespaceSpecifier -> Name -> m Dec

valueinfixRWithSpecD :: Quote m => Int -> NamespaceSpecifier -> Name -> m Dec

valueinfixNWithSpecD :: Quote m => Int -> NamespaceSpecifier -> Name -> m Dec

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

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

valuepragOpaqueD :: Quote m => Name -> 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
-> Maybe [m (TyVarBndr ())]
-> [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

valuepragSCCFunD :: Quote m => Name -> m Dec

valuepragSCCFunNamedD :: Quote m => Name -> String -> m Dec

valuedataInstD

:: Quote m
=> m Cxt
-> Maybe [m (TyVarBndr ())]
-> m Type
-> Maybe (m Kind)
-> [m Con]
-> [m DerivClause]
-> m Dec

valuenewtypeInstD

:: Quote m
=> m Cxt
-> Maybe [m (TyVarBndr ())]
-> m Type
-> Maybe (m Kind)
-> m Con
-> [m DerivClause]
-> m Dec

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

valuedataFamilyD

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

valueopenTypeFamilyD

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

valueclosedTypeFamilyD

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

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

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

valuestandaloneDerivWithStrategyD

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

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

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

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.

valuetySynEqn

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

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

valuederivClause

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

valuestockStrategy :: Quote m => m DerivStrategy

valueanyclassStrategy :: Quote m => m DerivStrategy

valuenewtypeStrategy :: Quote m => m DerivStrategy

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

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 => [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

Type

valueforallT

:: Quote m
=> [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

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

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

valuelistT :: Quote m => m Type

valuelitT :: Quote m => m TyLit -> 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 -> m Kind -> m Type

valueequalityT :: Quote m => m Type

valuewildCardT :: Quote m => m Type

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

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

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

valuepromotedNilT :: Quote m => m Type

valuepromotedConsT :: Quote m => m Type

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

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

Type Literals

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

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

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

Kind

valueplainTV :: Quote m => Name -> m (TyVarBndr ())

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

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

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

valuekindedInvisTV

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

valuekindedBndrTV

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

valuespecifiedSpec :: Specificity

valueinferredSpec :: Specificity

valuebndrReq :: BndrVis

valuebndrInvis :: BndrVis

valuevarK :: Name -> Kind

valueconK :: Name -> Kind

valuetupleK :: Int -> Kind

valuearrowK :: Kind

valuelistK :: Kind

valueappK :: Kind -> Kind -> Kind

valuestarK :: Quote m => m Kind

valueconstraintK :: Quote m => m Kind

Type family result

valuenoSig :: Quote m => m FamilyResultSig

valuekindSig :: Quote m => m Kind -> m FamilyResultSig

valuetyVarSig :: Quote m => m (TyVarBndr ()) -> m FamilyResultSig

Injectivity annotation

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

Role

valuenominalR :: Role

valuerepresentationalR :: Role

valuephantomR :: Role

valueinferR :: Role

Callconv

valuecCall :: Callconv

valuestdCall :: Callconv

valuecApi :: Callconv

valueprim :: Callconv

valuejavaScript :: Callconv

Safety

valueunsafe :: Safety

valuesafe :: Safety

valueinterruptible :: Safety

FunDep

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

RuleBndr

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

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

AnnTarget

valuevalueAnnotation :: Name -> AnnTarget

valuetypeAnnotation :: Name -> AnnTarget

valuemoduleAnnotation :: AnnTarget

Pattern Synonyms (sub constructs)

valueunidir :: Quote m => m PatSynDir

valueimplBidir :: Quote m => m PatSynDir

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

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

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

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

Useful helper function

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

valuethisModule :: Q Module

Source#

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

Documentation combinators

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.

valuedocCons :: (Q Con, Maybe String, [Maybe String]) -> Q ()

Source#

Document a data/newtype constructor with its arguments.