GHC.Boot.TH.Lib · ghc-boot-th-9.14.1

:: 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

#

Variant of dataD that attaches Haddock documentation.

valuedataFamilyD

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

#

valuedataInstD

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

#

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

#

Variant of dataInstD that attaches Haddock documentation.

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

#

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

#

valuederivClause

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

#

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

#

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

#

Document a data/newtype constructor with its arguments.

valuedoublePrimL :: Rational -> Lit

#

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

#

Dynamically binding a variable (unhygienic)

valueequalityT :: Quote m => m Type

#

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

#

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

#

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

#

valuefloatPrimL :: Rational -> Lit

#

valueforImpD

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

#

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

#

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

#

valueforallT

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

#

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

#

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

#

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

#

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

#

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

#

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

#

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

#

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

#

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

#

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

#

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

#

valuefunD_doc

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

#

Variant of funD that attaches Haddock documentation.

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

#

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

#

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

#

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

#

valueimplBidir :: Quote m => m PatSynDir

#

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

#

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

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

#

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

#

valueinferR :: Role

#

valueinferredSpec :: Specificity

#

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

#

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

#

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

#

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

#

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

#

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

#

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

#

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

#

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

#

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

#

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

#

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

#

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

#

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

#

valueinstanceWithOverlapD

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

#

valueintPrimL :: Integer -> Lit

#

valueintegerL :: Integer -> Lit

#

valueinterruptible :: Safety

#

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

#

valuejavaScript :: Callconv

#

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

#

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

#

valuekindedBndrTV

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

#

valuekindedInvisTV

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

#

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

#

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

#

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

#

Single-arg lambda

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

#

Lambda-case (case)

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

#

Lambda-cases (cases)

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

#

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

#

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

#

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

#

valuelistK :: Kind

#

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

#

valuelistT :: Quote m => m Type

#

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

#

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

#

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

#

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

#

Use with caseE

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

#

valuemoduleAnnotation :: AnnTarget

#

valuemulArrowT :: Quote m => m Type

#

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

#

valuenewtypeD

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

#

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

#

Variant of newtypeD that attaches Haddock documentation.

valuenewtypeInstD

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

#

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

#

Variant of newtypeInstD that attaches Haddock documentation.

valuenewtypeStrategy :: Quote m => m DerivStrategy

#

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

#

valuenoSig :: Quote m => m FamilyResultSig

#

valuenoSourceStrictness :: Quote m => m SourceStrictness

#

valuenoSourceUnpackedness :: Quote m => m SourceUnpackedness

#

valuenominalR :: Role

#

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

#

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

#

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

#

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

#

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

#

valueopenTypeFamilyD

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

#

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

#

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

#

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

#

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

#

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

#

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

#

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

#

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

#

Pattern synonym declaration

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

#

Variant of patSynD that attaches Haddock documentation.

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

#

Pattern synonym type signature

valuephantomR :: Role

#

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

#

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

#

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

#

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

#

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

#

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

#

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

#

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

#

valuepragRuleD

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

#

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

#

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

#

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

#

valueprim :: Callconv

#

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

#

valuepromotedConsT :: Quote m => m Type

#

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

#

valuepromotedNilT :: Quote m => m Type

#

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

#

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

#

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

#

valuerationalL :: Rational -> Lit

#

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

#

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

#

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

#

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

#

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

#

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

#

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

#

valuerepresentationalR :: Role

#

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

#

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

#

valuesafe :: Safety

#

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

#

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

#

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

#

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

#

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

#

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

#

valuesourceLazy :: Quote m => m SourceStrictness

#

valuesourceNoUnpack :: Quote m => m SourceUnpackedness

#

valuesourceStrict :: Quote m => m SourceStrictness

#

valuesourceUnpack :: Quote m => m SourceUnpackedness

#

valuespecifiedSpec :: Specificity

#

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

#

valuestandaloneDerivWithStrategyD

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

#

valuestarK :: Quote m => m Kind

#

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

#

staticE x = [| static x |]

valuestdCall :: Callconv

#

valuestockStrategy :: Quote m => m DerivStrategy

#

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

#

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

#

valuestringL :: String -> Lit

#

valuestringPrimL :: [Word8] -> Lit

#

valuethisModule :: Q Module

#

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

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

#

valuetupE :: Quote m => [Maybe (m Exp)] -> m Exp

#

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

#

valuetupleK :: Int -> Kind

#

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

#

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

#

valuetySynEqn

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

#

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

#

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

#

valuetypeAnnotation :: Name -> AnnTarget

#

valuetypeDataD

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

#

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

#

Variant of typeDataD that attaches Haddock documentation.

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

#

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

#

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

#

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

#

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

#

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

#

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

#

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

#

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

#

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

#

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

#

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

#

valueunboxedTupE :: Quote m => [Maybe (m Exp)] -> m Exp

#

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

#

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

#

valueunidir :: Quote m => m PatSynDir

#

valueunsafe :: Safety

#

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

#

valuevalueAnnotation :: Name -> AnnTarget

#

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

#

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

#

valuevarK :: Name -> Kind

#

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

#

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

#

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

#

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

#

valuewildCardT :: Quote m => m Type

#

valuewildP :: Quote m => m Pat

#

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

#

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.