Language.Haskell.TH.Lib.Internal · template-haskell-2.22.0.0

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.

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

#

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.

Type Literals

3 declarations

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

#

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

#

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

#

Kind

18 declarations

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

3 declarations

valuenoSig :: Quote m => m FamilyResultSig

#

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

#

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

#

Injectivity annotation

1 declaration

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

#

Role

4 declarations

valuenominalR :: Role

#

valuerepresentationalR :: Role

#

valuephantomR :: Role

#

valueinferR :: Role

#

Callconv

5 declarations

valuecCall :: Callconv

#

valuestdCall :: Callconv

#

valuecApi :: Callconv

#

valueprim :: Callconv

#

valuejavaScript :: Callconv

#

Safety

3 declarations

valueunsafe :: Safety

#

valuesafe :: Safety

#

valueinterruptible :: Safety

#

FunDep

1 declaration

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

#

RuleBndr

2 declarations

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

#

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

#

AnnTarget

3 declarations

valuevalueAnnotation :: Name -> AnnTarget

#

valuetypeAnnotation :: Name -> AnnTarget

#

valuemoduleAnnotation :: AnnTarget

#

Pattern Synonyms (sub constructs)

6 declarations

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

2 declarations

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

#

valuethisModule :: Q Module

#

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

Documentation combinators

10 declarations

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.

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

#

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

#

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

#

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

#

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

#

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

#

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

#

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

#

Variant of patSynD that attaches Haddock documentation.

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

#

Document a data/newtype constructor with its arguments.