Copyright | (c) The University of Glasgow 2003 |
---|---|
License | BSD-style (see the file libraries/base/LICENSE) |
Maintainer | libraries@haskell.org |
Stability | experimental |
Portability | portable |
Safe Haskell | Trustworthy |
Language | Haskell2010 |
Abstract syntax definitions for Template Haskell.
Synopsis
- returnQ :: a -> Q a
- bindQ :: Q a -> (a -> Q b) -> Q b
- sequenceQ :: [Q a] -> Q [a]
- newName :: String -> Q Name
- mkName :: String -> Name
- mkNameG_v :: String -> String -> String -> Name
- mkNameG_d :: String -> String -> String -> Name
- mkNameG_tc :: String -> String -> String -> Name
- mkNameL :: String -> Uniq -> Name
- mkNameS :: String -> Name
- unTypeQ :: Q (TExp a) -> Q Exp
- unsafeTExpCoerce :: Q Exp -> Q (TExp a)
- liftString :: String -> Q Exp
- class Lift t where
- data Exp
- = VarE Name
- | ConE Name
- | LitE Lit
- | AppE Exp Exp
- | AppTypeE Exp Type
- | InfixE (Maybe Exp) Exp (Maybe Exp)
- | UInfixE Exp Exp Exp
- | ParensE Exp
- | LamE [Pat] Exp
- | LamCaseE [Match]
- | TupE [Exp]
- | UnboxedTupE [Exp]
- | UnboxedSumE Exp SumAlt SumArity
- | CondE Exp Exp Exp
- | MultiIfE [(Guard, Exp)]
- | LetE [Dec] Exp
- | CaseE Exp [Match]
- | DoE [Stmt]
- | CompE [Stmt]
- | ArithSeqE Range
- | ListE [Exp]
- | SigE Exp Type
- | RecConE Name [FieldExp]
- | RecUpdE Exp [FieldExp]
- | StaticE Exp
- | UnboundVarE Name
- | LabelE String
- data Match = Match Pat Body [Dec]
- data Clause = Clause [Pat] Body [Dec]
- newtype Q a = Q {}
- data Pat
- data Type
- = ForallT [TyVarBndr] Cxt Type
- | AppT Type Type
- | SigT Type Kind
- | VarT Name
- | ConT Name
- | PromotedT Name
- | InfixT Type Name Type
- | UInfixT Type Name Type
- | ParensT Type
- | TupleT Int
- | UnboxedTupleT Int
- | UnboxedSumT SumArity
- | ArrowT
- | EqualityT
- | ListT
- | PromotedTupleT Int
- | PromotedNilT
- | PromotedConsT
- | StarT
- | ConstraintT
- | LitT TyLit
- | WildCardT
- data Dec
- = FunD Name [Clause]
- | ValD Pat Body [Dec]
- | DataD Cxt Name [TyVarBndr] (Maybe Kind) [Con] [DerivClause]
- | NewtypeD Cxt Name [TyVarBndr] (Maybe Kind) Con [DerivClause]
- | TySynD Name [TyVarBndr] Type
- | ClassD Cxt Name [TyVarBndr] [FunDep] [Dec]
- | InstanceD (Maybe Overlap) Cxt Type [Dec]
- | SigD Name Type
- | ForeignD Foreign
- | InfixD Fixity Name
- | PragmaD Pragma
- | DataFamilyD Name [TyVarBndr] (Maybe Kind)
- | DataInstD Cxt Name [Type] (Maybe Kind) [Con] [DerivClause]
- | NewtypeInstD Cxt Name [Type] (Maybe Kind) Con [DerivClause]
- | TySynInstD Name TySynEqn
- | OpenTypeFamilyD TypeFamilyHead
- | ClosedTypeFamilyD TypeFamilyHead [TySynEqn]
- | RoleAnnotD Name [Role]
- | StandaloneDerivD (Maybe DerivStrategy) Cxt Type
- | DefaultSigD Name Type
- | PatSynD Name PatSynArgs PatSynDir Pat
- | PatSynSigD Name PatSynType
- type FieldExp = (Name, Exp)
- type FieldPat = (Name, Pat)
- data Name = Name OccName NameFlavour
- data FunDep = FunDep [Name] [Name]
- type Pred = Type
- newtype TExp a = TExp {}
- data InjectivityAnn = InjectivityAnn Name [Name]
- data Overlap
- data DerivStrategy
- type Kind = Type
- data AnnLookup
- data Role
- data TyLit
- data FamilyResultSig
- data TyVarBndr
- data PatSynArgs
- = PrefixPatSyn [Name]
- | InfixPatSyn Name Name
- | RecordPatSyn [Name]
- data PatSynDir
- type VarStrictType = VarBangType
- type StrictType = BangType
- type Strict = Bang
- type VarBangType = (Name, Bang, Type)
- type BangType = (Bang, Type)
- data Bang = Bang SourceUnpackedness SourceStrictness
- data Con
- data DecidedStrictness
- data SourceStrictness
- data SourceUnpackedness
- type Cxt = [Pred]
- data AnnTarget
- data RuleBndr
- data Phases
- data RuleMatch
- data Inline
- data Pragma
- data Safety
- = Unsafe
- | Safe
- | Interruptible
- data Callconv
- = CCall
- | StdCall
- | CApi
- | Prim
- | JavaScript
- data Foreign
- data TySynEqn = TySynEqn [Type] Type
- data TypeFamilyHead = TypeFamilyHead Name [TyVarBndr] FamilyResultSig (Maybe InjectivityAnn)
- type PatSynType = Type
- data DerivClause = DerivClause (Maybe DerivStrategy) Cxt
- data Range
- data Stmt
- data Guard
- data Body
- data Lit
- data FixityDirection
- data Fixity = Fixity Int FixityDirection
- type InstanceDec = Dec
- type Unlifted = Bool
- type Arity = Int
- type SumArity = Int
- type SumAlt = Int
- type ParentName = Name
- data ModuleInfo = ModuleInfo [Module]
- data Info
- type CharPos = (Int, Int)
- data Loc = Loc {}
- data NameIs
- type Uniq = Int
- data NameSpace
- data NameFlavour
- newtype OccName = OccName String
- data Module = Module PkgName ModName
- newtype PkgName = PkgName String
- newtype ModName = ModName String
- class (MonadIO m, MonadFail m) => Quasi m where
- badIO :: String -> IO a
- counter :: IORef Int
- runQ :: Quasi m => Q a -> m a
- report :: Bool -> String -> Q ()
- reportError :: String -> Q ()
- reportWarning :: String -> Q ()
- recover :: Q a -> Q a -> Q a
- lookupName :: Bool -> String -> Q (Maybe Name)
- lookupTypeName :: String -> Q (Maybe Name)
- lookupValueName :: String -> Q (Maybe Name)
- reify :: Name -> Q Info
- reifyFixity :: Name -> Q (Maybe Fixity)
- reifyInstances :: Name -> [Type] -> Q [InstanceDec]
- reifyRoles :: Name -> Q [Role]
- reifyAnnotations :: Data a => AnnLookup -> Q [a]
- reifyModule :: Module -> Q ModuleInfo
- reifyConStrictness :: Name -> Q [DecidedStrictness]
- isInstance :: Name -> [Type] -> Q Bool
- location :: Q Loc
- runIO :: IO a -> Q a
- addDependentFile :: FilePath -> Q ()
- addTopDecls :: [Dec] -> Q ()
- addForeignFile :: ForeignSrcLang -> String -> Q ()
- addModFinalizer :: Q () -> Q ()
- addCorePlugin :: String -> Q ()
- getQ :: Typeable a => Q (Maybe a)
- putQ :: Typeable a => a -> Q ()
- isExtEnabled :: Extension -> Q Bool
- extsEnabled :: Q [Extension]
- trueName :: Name
- falseName :: Name
- nothingName :: Name
- justName :: Name
- leftName :: Name
- rightName :: Name
- dataToQa :: forall a k q. Data a => (Name -> k) -> (Lit -> Q q) -> (k -> [Q q] -> Q q) -> (forall b. Data b => b -> Maybe (Q q)) -> a -> Q q
- dataToExpQ :: Data a => (forall b. Data b => b -> Maybe (Q Exp)) -> a -> Q Exp
- liftData :: Data a => a -> Q Exp
- dataToPatQ :: Data a => (forall b. Data b => b -> Maybe (Q Pat)) -> a -> Q Pat
- mkModName :: String -> ModName
- modString :: ModName -> String
- mkPkgName :: String -> PkgName
- pkgString :: PkgName -> String
- mkOccName :: String -> OccName
- occString :: OccName -> String
- nameBase :: Name -> String
- nameModule :: Name -> Maybe String
- namePackage :: Name -> Maybe String
- nameSpace :: Name -> Maybe NameSpace
- mkNameU :: String -> Uniq -> Name
- mkNameG :: NameSpace -> String -> String -> String -> Name
- showName :: Name -> String
- showName' :: NameIs -> Name -> String
- tupleDataName :: Int -> Name
- tupleTypeName :: Int -> Name
- mk_tup_name :: Int -> NameSpace -> Name
- unboxedTupleDataName :: Int -> Name
- unboxedTupleTypeName :: Int -> Name
- mk_unboxed_tup_name :: Int -> NameSpace -> Name
- unboxedSumDataName :: SumAlt -> SumArity -> Name
- unboxedSumTypeName :: SumArity -> Name
- maxPrecedence :: Int
- defaultFixity :: Fixity
- cmpEq :: Ordering -> Bool
- thenCmp :: Ordering -> Ordering -> Ordering
- module Language.Haskell.TH.LanguageExtensions
- data ForeignSrcLang
- = LangC
- | LangCxx
- | LangObjc
- | LangObjcxx
Documentation
newName :: String -> Q Name Source #
Generate a fresh name, which cannot be captured.
For example, this:
f = $(do nm1 <- newName "x" let nm2 =mkName
"x" return (LamE
[VarP
nm1] (LamE [VarP nm2] (VarE
nm1))) )
will produce the splice
f = \x0 -> \x -> x0
In particular, the occurrence VarE nm1
refers to the binding VarP nm1
,
and is not captured by the binding VarP nm2
.
Although names generated by newName
cannot be captured, they can
capture other names. For example, this:
g = $(do nm1 <- newName "x" let nm2 = mkName "x" return (LamE [VarP nm2] (LamE [VarP nm1] (VarE nm2))) )
will produce the splice
g = \x -> \x0 -> x0
since the occurrence VarE nm2
is captured by the innermost binding
of x
, namely VarP nm1
.
mkName :: String -> Name Source #
Generate a capturable name. Occurrences of such names will be resolved according to the Haskell scoping rules at the occurrence site.
For example:
f = [| pi + $(varE (mkName "pi")) |] ... g = let pi = 3 in $f
In this case, g
is desugared to
g = Prelude.pi + 3
Note that mkName
may be used with qualified names:
mkName "Prelude.pi"
See also dyn
for a useful combinator. The above example could
be rewritten using dyn
as
f = [| pi + $(dyn "pi") |]
A Lift
instance can have any of its values turned into a Template
Haskell expression. This is needed when a value used within a Template
Haskell quotation is bound outside the Oxford brackets ([| ... |]
) but not
at the top level. As an example:
add1 :: Int -> Q Exp add1 x = [| x + 1 |]
Template Haskell has no way of knowing what value x
will take on at
splice-time, so it requires the type of x
to be an instance of Lift
.
A Lift
instance must satisfy $(lift x) ≡ x
for all x
, where $(...)
is a Template Haskell splice.
Lift
instances can be derived automatically by use of the -XDeriveLift
GHC language extension:
{-# LANGUAGE DeriveLift #-} module Foo where import Language.Haskell.TH.Syntax data Bar a = Bar1 a (Bar a) | Bar2 String deriving Lift
Turn a value into a Template Haskell expression, suitable for use in a splice.
lift :: Data t => t -> Q Exp Source #
Turn a value into a Template Haskell expression, suitable for use in a splice.
Instances
Lift Bool Source # | |
Lift Char Source # | |
Lift Double Source # | |
Lift Float Source # | |
Lift Int Source # | |
Lift Int8 Source # | |
Lift Int16 Source # | |
Lift Int32 Source # | |
Lift Int64 Source # | |
Lift Integer Source # | |
Lift Natural Source # | |
Lift Word Source # | |
Lift Word8 Source # | |
Lift Word16 Source # | |
Lift Word32 Source # | |
Lift Word64 Source # | |
Lift () Source # | |
Lift a => Lift [a] Source # | |
Lift a => Lift (Maybe a) Source # | |
Integral a => Lift (Ratio a) Source # | |
(Lift a, Lift b) => Lift (Either a b) Source # | |
(Lift a, Lift b) => Lift (a, b) Source # | |
(Lift a, Lift b, Lift c) => Lift (a, b, c) Source # | |
(Lift a, Lift b, Lift c, Lift d) => Lift (a, b, c, d) Source # | |
(Lift a, Lift b, Lift c, Lift d, Lift e) => Lift (a, b, c, d, e) Source # | |
(Lift a, Lift b, Lift c, Lift d, Lift e, Lift f) => Lift (a, b, c, d, e, f) Source # | |
(Lift a, Lift b, Lift c, Lift d, Lift e, Lift f, Lift g) => Lift (a, b, c, d, e, f, g) Source # | |
VarE Name | { x } |
ConE Name | data T1 = C1 t1 t2; p = {C1} e1 e2 |
LitE Lit | { 5 or 'c'} |
AppE Exp Exp | { f x } |
AppTypeE Exp Type | { f @Int } |
InfixE (Maybe Exp) Exp (Maybe Exp) | {x + y} or {(x+)} or {(+ x)} or {(+)} |
UInfixE Exp Exp Exp | {x + y} |
ParensE Exp | { (e) } |
LamE [Pat] Exp | { \ p1 p2 -> e } |
LamCaseE [Match] | { \case m1; m2 } |
TupE [Exp] | { (e1,e2) } |
UnboxedTupE [Exp] | { (# e1,e2 #) } |
UnboxedSumE Exp SumAlt SumArity | { (#|e|#) } |
CondE Exp Exp Exp | { if e1 then e2 else e3 } |
MultiIfE [(Guard, Exp)] | { if | g1 -> e1 | g2 -> e2 } |
LetE [Dec] Exp | { let x=e1; y=e2 in e3 } |
CaseE Exp [Match] | { case e of m1; m2 } |
DoE [Stmt] | { do { p <- e1; e2 } } |
CompE [Stmt] | { [ (x,y) | x <- xs, y <- ys ] } The result expression of the comprehension is
the last of the E.g. translation: [ f x | x <- xs ] CompE [BindS (VarP x) (VarE xs), NoBindS (AppE (VarE f) (VarE x))] |
ArithSeqE Range | { [ 1 ,2 .. 10 ] } |
ListE [Exp] | { [1,2,3] } |
SigE Exp Type | { e :: t } |
RecConE Name [FieldExp] | { T { x = y, z = w } } |
RecUpdE Exp [FieldExp] | { (f x) { z = w } } |
StaticE Exp | { static e } |
UnboundVarE Name |
|
LabelE String |
|
Instances
Instances
Eq Match Source # | |
Data Match Source # | |
Defined in Language.Haskell.TH.Syntax gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Match -> c Match Source # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Match Source # toConstr :: Match -> Constr Source # dataTypeOf :: Match -> DataType Source # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Match) Source # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Match) Source # gmapT :: (forall b. Data b => b -> b) -> Match -> Match Source # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Match -> r Source # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Match -> r Source # gmapQ :: (forall d. Data d => d -> u) -> Match -> [u] Source # gmapQi :: Int -> (forall d. Data d => d -> u) -> Match -> u Source # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Match -> m Match Source # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Match -> m Match Source # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Match -> m Match Source # | |
Ord Match Source # | |
Show Match Source # | |
Generic Match Source # | |
Ppr Match Source # | |
type Rep Match Source # | |
Defined in Language.Haskell.TH.Syntax type Rep Match = D1 (MetaData "Match" "Language.Haskell.TH.Syntax" "template-haskell" False) (C1 (MetaCons "Match" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Pat) :*: (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Body) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Dec])))) |
Instances
Instances
Pattern in Haskell given in {}
LitP Lit | { 5 or 'c' } |
VarP Name | { x } |
TupP [Pat] | { (p1,p2) } |
UnboxedTupP [Pat] | { (# p1,p2 #) } |
UnboxedSumP Pat SumAlt SumArity | { (#|p|#) } |
ConP Name [Pat] | data T1 = C1 t1 t2; {C1 p1 p1} = e |
InfixP Pat Name Pat | foo ({x :+ y}) = e |
UInfixP Pat Name Pat | foo ({x :+ y}) = e |
ParensP Pat | {(p)} |
TildeP Pat | { ~p } |
BangP Pat | { !p } |
AsP Name Pat | { x @ p } |
WildP | { _ } |
RecP Name [FieldPat] | f (Pt { pointx = x }) = g x |
ListP [Pat] | { [1,2,3] } |
SigP Pat Type | { p :: t } |
ViewP Exp Pat | { e -> p } |
Instances
ForallT [TyVarBndr] Cxt Type | forall <vars>. <ctxt> => <type> |
AppT Type Type | T a b |
SigT Type Kind | t :: k |
VarT Name | a |
ConT Name | T |
PromotedT Name | 'T |
InfixT Type Name Type | T + T |
UInfixT Type Name Type | T + T |
ParensT Type | (T) |
TupleT Int | (,), (,,), etc. |
UnboxedTupleT Int | (#,#), (#,,#), etc. |
UnboxedSumT SumArity | (#|#), (#||#), etc. |
ArrowT | -> |
EqualityT | ~ |
ListT | [] |
PromotedTupleT Int | '(), '(,), '(,,), etc. |
PromotedNilT | '[] |
PromotedConsT | (':) |
StarT | * |
ConstraintT | Constraint |
LitT TyLit | 0,1,2, etc. |
WildCardT | _ |
Instances
FunD Name [Clause] | { f p1 p2 = b where decs } |
ValD Pat Body [Dec] | { p = b where decs } |
DataD Cxt Name [TyVarBndr] (Maybe Kind) [Con] [DerivClause] | { data Cxt x => T x = A x | B (T x) deriving (Z,W) deriving stock Eq } |
NewtypeD Cxt Name [TyVarBndr] (Maybe Kind) Con [DerivClause] | { newtype Cxt x => T x = A (B x) deriving (Z,W Q) deriving stock Eq } |
TySynD Name [TyVarBndr] Type | { type T x = (x,x) } |
ClassD Cxt Name [TyVarBndr] [FunDep] [Dec] | { class Eq a => Ord a where ds } |
InstanceD (Maybe Overlap) Cxt Type [Dec] | { instance {-# OVERLAPS #-} Show w => Show [w] where ds } |
SigD Name Type | { length :: [a] -> Int } |
ForeignD Foreign | { foreign import ... } { foreign export ... } |
InfixD Fixity Name | { infix 3 foo } |
PragmaD Pragma | { {-# INLINE [1] foo #-} } |
DataFamilyD Name [TyVarBndr] (Maybe Kind) | { data family T a b c :: * } |
DataInstD Cxt Name [Type] (Maybe Kind) [Con] [DerivClause] | { data instance Cxt x => T [x] = A x | B (T x) deriving (Z,W) deriving stock Eq } |
NewtypeInstD Cxt Name [Type] (Maybe Kind) Con [DerivClause] | { newtype instance Cxt x => T [x] = A (B x) deriving (Z,W) deriving stock Eq } |
TySynInstD Name TySynEqn | { type instance ... } |
OpenTypeFamilyD TypeFamilyHead | { type family T a b c = (r :: *) | r -> a b } |
ClosedTypeFamilyD TypeFamilyHead [TySynEqn] | { type family F a b = (r :: *) | r -> a where ... } |
RoleAnnotD Name [Role] | { type role T nominal representational } |
StandaloneDerivD (Maybe DerivStrategy) Cxt Type | { deriving stock instance Ord a => Ord (Foo a) } |
DefaultSigD Name Type | { default size :: Data a => a -> Int } |
PatSynD Name PatSynArgs PatSynDir Pat |
also, besides prefix pattern synonyms, both infix and record
pattern synonyms are supported. See |
PatSynSigD Name PatSynType | A pattern synonym's type signature. |
Instances
An abstract type representing names in the syntax tree.
Name
s can be constructed in several ways, which come with different
name-capture guarantees (see Language.Haskell.TH.Syntax for
an explanation of name capture):
- the built-in syntax
'f
and''T
can be used to construct names, The expression'f
gives aName
which refers to the valuef
currently in scope, and''T
gives aName
which refers to the typeT
currently in scope. These names can never be captured. lookupValueName
andlookupTypeName
are similar to'f
and''T
respectively, but theName
s are looked up at the point where the current splice is being run. These names can never be captured.newName
monadically generates a new name, which can never be captured.mkName
generates a capturable name.
Names constructed using newName
and mkName
may be used in bindings
(such as let x = ...
or x -> ...
), but names constructed using
lookupValueName
, lookupTypeName
, 'f
, ''T
may not.
Instances
Eq Name Source # | |
Data Name Source # | |
Defined in Language.Haskell.TH.Syntax gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Name -> c Name Source # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Name Source # toConstr :: Name -> Constr Source # dataTypeOf :: Name -> DataType Source # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Name) Source # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Name) Source # gmapT :: (forall b. Data b => b -> b) -> Name -> Name Source # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Name -> r Source # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Name -> r Source # gmapQ :: (forall d. Data d => d -> u) -> Name -> [u] Source # gmapQi :: Int -> (forall d. Data d => d -> u) -> Name -> u Source # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Name -> m Name Source # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Name -> m Name Source # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Name -> m Name Source # | |
Ord Name Source # | |
Show Name Source # | |
Generic Name Source # | |
Ppr Name Source # | |
type Rep Name Source # | |
Defined in Language.Haskell.TH.Syntax type Rep Name = D1 (MetaData "Name" "Language.Haskell.TH.Syntax" "template-haskell" False) (C1 (MetaCons "Name" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 OccName) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 NameFlavour))) |
Instances
Eq FunDep Source # | |
Data FunDep Source # | |
Defined in Language.Haskell.TH.Syntax gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> FunDep -> c FunDep Source # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c FunDep Source # toConstr :: FunDep -> Constr Source # dataTypeOf :: FunDep -> DataType Source # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c FunDep) Source # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c FunDep) Source # gmapT :: (forall b. Data b => b -> b) -> FunDep -> FunDep Source # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> FunDep -> r Source # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> FunDep -> r Source # gmapQ :: (forall d. Data d => d -> u) -> FunDep -> [u] Source # gmapQi :: Int -> (forall d. Data d => d -> u) -> FunDep -> u Source # gmapM :: Monad m => (forall d. Data d => d -> m d) -> FunDep -> m FunDep Source # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> FunDep -> m FunDep Source # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> FunDep -> m FunDep Source # | |
Ord FunDep Source # | |
Show FunDep Source # | |
Generic FunDep Source # | |
Ppr FunDep Source # | |
type Rep FunDep Source # | |
Defined in Language.Haskell.TH.Syntax type Rep FunDep = D1 (MetaData "FunDep" "Language.Haskell.TH.Syntax" "template-haskell" False) (C1 (MetaCons "FunDep" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Name]) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Name]))) |
Since the advent of ConstraintKinds
, constraints are really just types.
Equality constraints use the EqualityT
constructor. Constraints may also
be tuples of other constraints.
data InjectivityAnn Source #
Injectivity annotation
Instances
Varieties of allowed instance overlap.
Overlappable | May be overlapped by more specific instances |
Overlapping | May overlap a more general instance |
Overlaps | Both |
Incoherent | Both |
Instances
Eq Overlap Source # | |
Data Overlap Source # | |
Defined in Language.Haskell.TH.Syntax gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Overlap -> c Overlap Source # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Overlap Source # toConstr :: Overlap -> Constr Source # dataTypeOf :: Overlap -> DataType Source # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Overlap) Source # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Overlap) Source # gmapT :: (forall b. Data b => b -> b) -> Overlap -> Overlap Source # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Overlap -> r Source # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Overlap -> r Source # gmapQ :: (forall d. Data d => d -> u) -> Overlap -> [u] Source # gmapQi :: Int -> (forall d. Data d => d -> u) -> Overlap -> u Source # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Overlap -> m Overlap Source # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Overlap -> m Overlap Source # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Overlap -> m Overlap Source # | |
Ord Overlap Source # | |
Show Overlap Source # | |
Generic Overlap Source # | |
type Rep Overlap Source # | |
Defined in Language.Haskell.TH.Syntax type Rep Overlap = D1 (MetaData "Overlap" "Language.Haskell.TH.Syntax" "template-haskell" 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 :: * -> *))) |
data DerivStrategy Source #
What the user explicitly requests when deriving an instance.
StockStrategy | A "standard" derived instance |
AnyclassStrategy | -XDeriveAnyClass |
NewtypeStrategy | -XGeneralizedNewtypeDeriving |
Instances
To avoid duplication between kinds and types, they
are defined to be the same. Naturally, you would never
have a type be StarT
and you would never have a kind
be SigT
, but many of the other constructors are shared.
Note that the kind Bool
is denoted with ConT
, not
PromotedT
. Similarly, tuple kinds are made with TupleT
,
not PromotedTupleT
.
Annotation target for reifyAnnotations
Instances
Role annotations
NominalR | nominal |
RepresentationalR | representational |
PhantomR | phantom |
InferR | _ |
Instances
Eq Role Source # | |
Data Role Source # | |
Defined in Language.Haskell.TH.Syntax gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Role -> c Role Source # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Role Source # toConstr :: Role -> Constr Source # dataTypeOf :: Role -> DataType Source # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Role) Source # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Role) Source # gmapT :: (forall b. Data b => b -> b) -> Role -> Role Source # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Role -> r Source # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Role -> r Source # gmapQ :: (forall d. Data d => d -> u) -> Role -> [u] Source # gmapQi :: Int -> (forall d. Data d => d -> u) -> Role -> u Source # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Role -> m Role Source # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Role -> m Role Source # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Role -> m Role Source # | |
Ord Role Source # | |
Show Role Source # | |
Generic Role Source # | |
Ppr Role Source # | |
type Rep Role Source # | |
Defined in Language.Haskell.TH.Syntax type Rep Role = D1 (MetaData "Role" "Language.Haskell.TH.Syntax" "template-haskell" False) ((C1 (MetaCons "NominalR" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "RepresentationalR" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "PhantomR" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "InferR" PrefixI False) (U1 :: * -> *))) |
Instances
Eq TyLit Source # | |
Data TyLit Source # | |
Defined in Language.Haskell.TH.Syntax gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> TyLit -> c TyLit Source # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c TyLit Source # toConstr :: TyLit -> Constr Source # dataTypeOf :: TyLit -> DataType Source # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c TyLit) Source # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c TyLit) Source # gmapT :: (forall b. Data b => b -> b) -> TyLit -> TyLit Source # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> TyLit -> r Source # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> TyLit -> r Source # gmapQ :: (forall d. Data d => d -> u) -> TyLit -> [u] Source # gmapQi :: Int -> (forall d. Data d => d -> u) -> TyLit -> u Source # gmapM :: Monad m => (forall d. Data d => d -> m d) -> TyLit -> m TyLit Source # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> TyLit -> m TyLit Source # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> TyLit -> m TyLit Source # | |
Ord TyLit Source # | |
Show TyLit Source # | |
Generic TyLit Source # | |
Ppr TyLit Source # | |
type Rep TyLit Source # | |
Defined in Language.Haskell.TH.Syntax type Rep TyLit = D1 (MetaData "TyLit" "Language.Haskell.TH.Syntax" "template-haskell" False) (C1 (MetaCons "NumTyLit" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Integer)) :+: C1 (MetaCons "StrTyLit" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String))) |
data FamilyResultSig Source #
Type family result signature
Instances
Instances
data PatSynArgs Source #
A pattern synonym's argument type.
PrefixPatSyn [Name] | pattern P {x y z} = p |
InfixPatSyn Name Name | pattern {x P y} = p |
RecordPatSyn [Name] | pattern P { {x,y,z} } = p |
Instances
A pattern synonym's directionality.
Unidir | pattern P x {<-} p |
ImplBidir | pattern P x {=} p |
ExplBidir [Clause] | pattern P x {<-} p where P x = e |
Instances
Eq PatSynDir Source # | |
Data PatSynDir Source # | |
Defined in Language.Haskell.TH.Syntax gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> PatSynDir -> c PatSynDir Source # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c PatSynDir Source # toConstr :: PatSynDir -> Constr Source # dataTypeOf :: PatSynDir -> DataType Source # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c PatSynDir) Source # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c PatSynDir) Source # gmapT :: (forall b. Data b => b -> b) -> PatSynDir -> PatSynDir Source # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> PatSynDir -> r Source # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> PatSynDir -> r Source # gmapQ :: (forall d. Data d => d -> u) -> PatSynDir -> [u] Source # gmapQi :: Int -> (forall d. Data d => d -> u) -> PatSynDir -> u Source # gmapM :: Monad m => (forall d. Data d => d -> m d) -> PatSynDir -> m PatSynDir Source # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> PatSynDir -> m PatSynDir Source # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> PatSynDir -> m PatSynDir Source # | |
Ord PatSynDir Source # | |
Defined in Language.Haskell.TH.Syntax | |
Show PatSynDir Source # | |
Generic PatSynDir Source # | |
Ppr PatSynDir Source # | |
type Rep PatSynDir Source # | |
Defined in Language.Haskell.TH.Syntax type Rep PatSynDir = D1 (MetaData "PatSynDir" "Language.Haskell.TH.Syntax" "template-haskell" False) (C1 (MetaCons "Unidir" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "ImplBidir" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "ExplBidir" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Clause])))) |
type VarStrictType = VarBangType Source #
As of template-haskell-2.11.0.0
, VarStrictType
has been replaced by
VarBangType
.
type StrictType = BangType Source #
As of template-haskell-2.11.0.0
, StrictType
has been replaced by
BangType
.
Bang SourceUnpackedness SourceStrictness | C { {-# UNPACK #-} !}a |
Instances
Eq Bang Source # | |
Data Bang Source # | |
Defined in Language.Haskell.TH.Syntax gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Bang -> c Bang Source # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Bang Source # toConstr :: Bang -> Constr Source # dataTypeOf :: Bang -> DataType Source # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Bang) Source # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Bang) Source # gmapT :: (forall b. Data b => b -> b) -> Bang -> Bang Source # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Bang -> r Source # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Bang -> r Source # gmapQ :: (forall d. Data d => d -> u) -> Bang -> [u] Source # gmapQi :: Int -> (forall d. Data d => d -> u) -> Bang -> u Source # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Bang -> m Bang Source # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Bang -> m Bang Source # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Bang -> m Bang Source # | |
Ord Bang Source # | |
Show Bang Source # | |
Generic Bang Source # | |
Ppr Bang Source # | |
type Rep Bang Source # | |
Defined in Language.Haskell.TH.Syntax type Rep Bang = D1 (MetaData "Bang" "Language.Haskell.TH.Syntax" "template-haskell" False) (C1 (MetaCons "Bang" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 SourceUnpackedness) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 SourceStrictness))) |
A single data constructor.
The constructors for Con
can roughly be divided up into two categories:
those for constructors with "vanilla" syntax (NormalC
, RecC
, and
InfixC
), and those for constructors with GADT syntax (GadtC
and
RecGadtC
). The ForallC
constructor, which quantifies additional type
variables and class contexts, can surround either variety of constructor.
However, the type variables that it quantifies are different depending
on what constructor syntax is used:
- If a
ForallC
surrounds a constructor with vanilla syntax, then theForallC
will only quantify existential type variables. For example:
data Foo a = forall b. MkFoo a b
In MkFoo
, ForallC
will quantify b
, but not a
.
- If a
ForallC
surrounds a constructor with GADT syntax, then theForallC
will quantify all type variables used in the constructor. For example:
data Bar a b where MkBar :: (a ~ b) => c -> MkBar a b
In MkBar
, ForallC
will quantify a
, b
, and c
.
NormalC Name [BangType] | C Int a |
RecC Name [VarBangType] | C { v :: Int, w :: a } |
InfixC BangType Name BangType | Int :+ a |
ForallC [TyVarBndr] Cxt Con | forall a. Eq a => C [a] |
GadtC [Name] [BangType] Type | C :: a -> b -> T b Int |
RecGadtC [Name] [VarBangType] Type | C :: { v :: Int } -> T b Int |
Instances
data DecidedStrictness Source #
Unlike SourceStrictness
and SourceUnpackedness
, DecidedStrictness
refers to the strictness that the compiler chooses for a data constructor
field, which may be different from what is written in source code. See
reifyConStrictness
for more information.
Instances
data SourceStrictness Source #
NoSourceStrictness | C a |
SourceLazy | C {~}a |
SourceStrict | C {!}a |
Instances
data SourceUnpackedness Source #
NoSourceUnpackedness | C a |
SourceNoUnpack | C { {-# NOUNPACK #-} } a |
SourceUnpack | C { {-# UNPACK #-} } a |
Instances
Instances
Instances
Instances
Eq Phases Source # | |
Data Phases Source # | |
Defined in Language.Haskell.TH.Syntax gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Phases -> c Phases Source # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Phases Source # toConstr :: Phases -> Constr Source # dataTypeOf :: Phases -> DataType Source # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Phases) Source # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Phases) Source # gmapT :: (forall b. Data b => b -> b) -> Phases -> Phases Source # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Phases -> r Source # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Phases -> r Source # gmapQ :: (forall d. Data d => d -> u) -> Phases -> [u] Source # gmapQi :: Int -> (forall d. Data d => d -> u) -> Phases -> u Source # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Phases -> m Phases Source # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Phases -> m Phases Source # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Phases -> m Phases Source # | |
Ord Phases Source # | |
Show Phases Source # | |
Generic Phases Source # | |
Ppr Phases Source # | |
type Rep Phases Source # | |
Defined in Language.Haskell.TH.Syntax type Rep Phases = D1 (MetaData "Phases" "Language.Haskell.TH.Syntax" "template-haskell" False) (C1 (MetaCons "AllPhases" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "FromPhase" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int)) :+: C1 (MetaCons "BeforePhase" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int)))) |
Instances
Eq RuleMatch Source # | |
Data RuleMatch Source # | |
Defined in Language.Haskell.TH.Syntax gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> RuleMatch -> c RuleMatch Source # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c RuleMatch Source # toConstr :: RuleMatch -> Constr Source # dataTypeOf :: RuleMatch -> DataType Source # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c RuleMatch) Source # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c RuleMatch) Source # gmapT :: (forall b. Data b => b -> b) -> RuleMatch -> RuleMatch Source # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> RuleMatch -> r Source # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> RuleMatch -> r Source # gmapQ :: (forall d. Data d => d -> u) -> RuleMatch -> [u] Source # gmapQi :: Int -> (forall d. Data d => d -> u) -> RuleMatch -> u Source # gmapM :: Monad m => (forall d. Data d => d -> m d) -> RuleMatch -> m RuleMatch Source # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> RuleMatch -> m RuleMatch Source # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> RuleMatch -> m RuleMatch Source # | |
Ord RuleMatch Source # | |
Defined in Language.Haskell.TH.Syntax | |
Show RuleMatch Source # | |
Generic RuleMatch Source # | |
Ppr RuleMatch Source # | |
type Rep RuleMatch Source # | |
Instances
Eq Inline Source # | |
Data Inline Source # | |
Defined in Language.Haskell.TH.Syntax gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Inline -> c Inline Source # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Inline Source # toConstr :: Inline -> Constr Source # dataTypeOf :: Inline -> DataType Source # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Inline) Source # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Inline) Source # gmapT :: (forall b. Data b => b -> b) -> Inline -> Inline Source # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Inline -> r Source # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Inline -> r Source # gmapQ :: (forall d. Data d => d -> u) -> Inline -> [u] Source # gmapQi :: Int -> (forall d. Data d => d -> u) -> Inline -> u Source # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Inline -> m Inline Source # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Inline -> m Inline Source # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Inline -> m Inline Source # | |
Ord Inline Source # | |
Show Inline Source # | |
Generic Inline Source # | |
Ppr Inline Source # | |
type Rep Inline Source # | |
Defined in Language.Haskell.TH.Syntax |
InlineP Name Inline RuleMatch Phases | |
SpecialiseP Name Type (Maybe Inline) Phases | |
SpecialiseInstP Type | |
RuleP String [RuleBndr] Exp Exp Phases | |
AnnP AnnTarget Exp | |
LineP Int String | |
CompleteP [Name] (Maybe Name) | { {-# COMPLETE C_1, ..., C_i [ :: T ] #-} } |
Instances
Instances
Eq Safety Source # | |
Data Safety Source # | |
Defined in Language.Haskell.TH.Syntax gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Safety -> c Safety Source # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Safety Source # toConstr :: Safety -> Constr Source # dataTypeOf :: Safety -> DataType Source # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Safety) Source # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Safety) Source # gmapT :: (forall b. Data b => b -> b) -> Safety -> Safety Source # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Safety -> r Source # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Safety -> r Source # gmapQ :: (forall d. Data d => d -> u) -> Safety -> [u] Source # gmapQi :: Int -> (forall d. Data d => d -> u) -> Safety -> u Source # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Safety -> m Safety Source # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Safety -> m Safety Source # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Safety -> m Safety Source # | |
Ord Safety Source # | |
Show Safety Source # | |
Generic Safety Source # | |
type Rep Safety Source # | |
Defined in Language.Haskell.TH.Syntax |
Instances
Eq Callconv Source # | |
Data Callconv Source # | |
Defined in Language.Haskell.TH.Syntax gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Callconv -> c Callconv Source # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Callconv Source # toConstr :: Callconv -> Constr Source # dataTypeOf :: Callconv -> DataType Source # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Callconv) Source # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Callconv) Source # gmapT :: (forall b. Data b => b -> b) -> Callconv -> Callconv Source # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Callconv -> r Source # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Callconv -> r Source # gmapQ :: (forall d. Data d => d -> u) -> Callconv -> [u] Source # gmapQi :: Int -> (forall d. Data d => d -> u) -> Callconv -> u Source # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Callconv -> m Callconv Source # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Callconv -> m Callconv Source # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Callconv -> m Callconv Source # | |
Ord Callconv Source # | |
Defined in Language.Haskell.TH.Syntax | |
Show Callconv Source # | |
Generic Callconv Source # | |
type Rep Callconv Source # | |
Defined in Language.Haskell.TH.Syntax type Rep Callconv = D1 (MetaData "Callconv" "Language.Haskell.TH.Syntax" "template-haskell" False) ((C1 (MetaCons "CCall" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "StdCall" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "CApi" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "Prim" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "JavaScript" PrefixI False) (U1 :: * -> *)))) |
Instances
One equation of a type family instance or closed type family. The arguments are the left-hand-side type patterns and the right-hand-side result.
Instances
data TypeFamilyHead Source #
Common elements of OpenTypeFamilyD
and ClosedTypeFamilyD
. By
analogy with "head" for type classes and type class instances as
defined in Type classes: an exploration of the design space, the
TypeFamilyHead
is defined to be the elements of the declaration
between type family
and where
.
Instances
type PatSynType = Type Source #
A Pattern synonym's type. Note that a pattern synonym's *fully* specified type has a peculiar shape coming with two forall quantifiers and two constraint contexts. For example, consider the pattern synonym
pattern P x1 x2 ... xn = some-pattern
P's complete type is of the following form
forall universals. required constraints => forall existentials. provided constraints => t1 -> t2 -> ... -> tn -> t
consisting of four parts:
1) the (possibly empty lists of) universally quantified type variables and required constraints on them. 2) the (possibly empty lists of) existentially quantified type variables and the provided constraints on them. 3) the types t1, t2, .., tn of x1, x2, .., xn, respectively 4) the type t of some-pattern, mentioning only universals.
Pattern synonym types interact with TH when (a) reifying a pattern synonym, (b) pretty printing, or (c) specifying a pattern synonym's type signature explicitly:
(a) Reification always returns a pattern synonym's *fully* specified type in abstract syntax.
(b) Pretty printing via pprPatSynType
abbreviates a pattern
synonym's type unambiguously in concrete syntax: The rule of
thumb is to print initial empty universals and the required
context as `() =>`, if existentials and a provided context
follow. If only universals and their required context, but no
existentials are specified, only the universals and their
required context are printed. If both or none are specified, so
both (or none) are printed.
(c) When specifying a pattern synonym's type explicitly with
PatSynSigD
either one of the universals, the existentials, or
their contexts may be left empty.
See the GHC user's guide for more information on pattern synonyms and their types: https://downloads.haskell.org/~ghc/latest/docs/html/ users_guide/syntax-extns.html#pattern-synonyms.
data DerivClause Source #
A single deriving
clause at the end of a datatype.
DerivClause (Maybe DerivStrategy) Cxt | { deriving stock (Eq, Ord) } |
Instances
Instances
Instances
Instances
Eq Guard Source # | |
Data Guard Source # | |
Defined in Language.Haskell.TH.Syntax gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Guard -> c Guard Source # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Guard Source # toConstr :: Guard -> Constr Source # dataTypeOf :: Guard -> DataType Source # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Guard) Source # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Guard) Source # gmapT :: (forall b. Data b => b -> b) -> Guard -> Guard Source # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Guard -> r Source # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Guard -> r Source # gmapQ :: (forall d. Data d => d -> u) -> Guard -> [u] Source # gmapQi :: Int -> (forall d. Data d => d -> u) -> Guard -> u Source # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Guard -> m Guard Source # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Guard -> m Guard Source # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Guard -> m Guard Source # | |
Ord Guard Source # | |
Show Guard Source # | |
Generic Guard Source # | |
type Rep Guard Source # | |
Defined in Language.Haskell.TH.Syntax type Rep Guard = D1 (MetaData "Guard" "Language.Haskell.TH.Syntax" "template-haskell" False) (C1 (MetaCons "NormalG" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Exp)) :+: C1 (MetaCons "PatG" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Stmt]))) |
Instances
Eq Body Source # | |
Data Body Source # | |
Defined in Language.Haskell.TH.Syntax gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Body -> c Body Source # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Body Source # toConstr :: Body -> Constr Source # dataTypeOf :: Body -> DataType Source # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Body) Source # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Body) Source # gmapT :: (forall b. Data b => b -> b) -> Body -> Body Source # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Body -> r Source # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Body -> r Source # gmapQ :: (forall d. Data d => d -> u) -> Body -> [u] Source # gmapQi :: Int -> (forall d. Data d => d -> u) -> Body -> u Source # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Body -> m Body Source # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Body -> m Body Source # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Body -> m Body Source # | |
Ord Body Source # | |
Show Body Source # | |
Generic Body Source # | |
type Rep Body Source # | |
Defined in Language.Haskell.TH.Syntax type Rep Body = D1 (MetaData "Body" "Language.Haskell.TH.Syntax" "template-haskell" False) (C1 (MetaCons "GuardedB" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(Guard, Exp)])) :+: C1 (MetaCons "NormalB" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Exp))) |
CharL Char | |
StringL String | |
IntegerL Integer | Used for overloaded and non-overloaded literals. We don't have a good way to represent non-overloaded literals at the moment. Maybe that doesn't matter? |
RationalL Rational | |
IntPrimL Integer | |
WordPrimL Integer | |
FloatPrimL Rational | |
DoublePrimL Rational | |
StringPrimL [Word8] | A primitive C-style string, type Addr# |
CharPrimL Char |
Instances
data FixityDirection Source #
Instances
Instances
Eq Fixity Source # | |
Data Fixity Source # | |
Defined in Language.Haskell.TH.Syntax gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Fixity -> c Fixity Source # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Fixity Source # toConstr :: Fixity -> Constr Source # dataTypeOf :: Fixity -> DataType Source # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Fixity) Source # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Fixity) Source # gmapT :: (forall b. Data b => b -> b) -> Fixity -> Fixity Source # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Fixity -> r Source # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Fixity -> r Source # gmapQ :: (forall d. Data d => d -> u) -> Fixity -> [u] Source # gmapQi :: Int -> (forall d. Data d => d -> u) -> Fixity -> u Source # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Fixity -> m Fixity Source # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Fixity -> m Fixity Source # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Fixity -> m Fixity Source # | |
Ord Fixity Source # | |
Show Fixity Source # | |
Generic Fixity Source # | |
type Rep Fixity Source # | |
Defined in Language.Haskell.TH.Syntax type Rep Fixity = D1 (MetaData "Fixity" "Language.Haskell.TH.Syntax" "template-haskell" False) (C1 (MetaCons "Fixity" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 FixityDirection))) |
type InstanceDec = Dec Source #
InstanceDec
desribes a single instance of a class or type function.
It is just a Dec
, but guaranteed to be one of the following:
InstanceD
(with empty[
)Dec
]DataInstD
orNewtypeInstD
(with empty derived[
)Name
]TySynInstD
In PrimTyConI
, is the type constructor unlifted?
In PrimTyConI
, arity of the type constructor
In UnboxedSumE
, UnboxedSumT
, and UnboxedSumP
, the total number of
SumAlt
s. For example, (#|#)
has a SumArity
of 2.
In UnboxedSumE
and UnboxedSumP
, the number associated with a
particular data constructor. SumAlt
s are one-indexed and should never
exceed the value of its corresponding SumArity
. For example:
data ModuleInfo Source #
Obtained from reifyModule
in the Q
Monad.
ModuleInfo [Module] | Contains the import list of the module. |
Instances
ClassI Dec [InstanceDec] | A class, with a list of its visible instances |
ClassOpI Name Type ParentName | A class method |
TyConI Dec | A "plain" type constructor. "Fancier" type constructors are returned using |
FamilyI Dec [InstanceDec] | A type or data family, with a list of its visible instances. A closed type family is returned with 0 instances. |
PrimTyConI Name Arity Unlifted | A "primitive" type constructor, which can't be expressed with a |
DataConI Name Type ParentName | A data constructor |
PatSynI Name PatSynType | A pattern synonym. |
VarI Name Type (Maybe Dec) | A "value" variable (as opposed to a type variable, see The |
TyVarI Name Type | A type variable. The |
Instances
Loc | |
|
Instances
Eq Loc Source # | |
Data Loc Source # | |
Defined in Language.Haskell.TH.Syntax gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Loc -> c Loc Source # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Loc Source # toConstr :: Loc -> Constr Source # dataTypeOf :: Loc -> DataType Source # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Loc) Source # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Loc) Source # gmapT :: (forall b. Data b => b -> b) -> Loc -> Loc Source # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Loc -> r Source # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Loc -> r Source # gmapQ :: (forall d. Data d => d -> u) -> Loc -> [u] Source # gmapQi :: Int -> (forall d. Data d => d -> u) -> Loc -> u Source # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Loc -> m Loc Source # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Loc -> m Loc Source # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Loc -> m Loc Source # | |
Ord Loc Source # | |
Show Loc Source # | |
Generic Loc Source # | |
Ppr Loc Source # | |
type Rep Loc Source # | |
Defined in Language.Haskell.TH.Syntax type Rep Loc = D1 (MetaData "Loc" "Language.Haskell.TH.Syntax" "template-haskell" False) (C1 (MetaCons "Loc" PrefixI True) ((S1 (MetaSel (Just "loc_filename") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String) :*: S1 (MetaSel (Just "loc_package") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String)) :*: (S1 (MetaSel (Just "loc_module") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String) :*: (S1 (MetaSel (Just "loc_start") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 CharPos) :*: S1 (MetaSel (Just "loc_end") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 CharPos))))) |
VarName | Variables |
DataName | Data constructors |
TcClsName | Type constructors and classes; Haskell has them in the same name space for now. |
Instances
Eq NameSpace Source # | |
Data NameSpace Source # | |
Defined in Language.Haskell.TH.Syntax gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> NameSpace -> c NameSpace Source # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c NameSpace Source # toConstr :: NameSpace -> Constr Source # dataTypeOf :: NameSpace -> DataType Source # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c NameSpace) Source # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c NameSpace) Source # gmapT :: (forall b. Data b => b -> b) -> NameSpace -> NameSpace Source # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> NameSpace -> r Source # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> NameSpace -> r Source # gmapQ :: (forall d. Data d => d -> u) -> NameSpace -> [u] Source # gmapQi :: Int -> (forall d. Data d => d -> u) -> NameSpace -> u Source # gmapM :: Monad m => (forall d. Data d => d -> m d) -> NameSpace -> m NameSpace Source # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> NameSpace -> m NameSpace Source # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> NameSpace -> m NameSpace Source # | |
Ord NameSpace Source # | |
Defined in Language.Haskell.TH.Syntax | |
Show NameSpace Source # | |
Generic NameSpace Source # | |
type Rep NameSpace Source # | |
Defined in Language.Haskell.TH.Syntax |
data NameFlavour Source #
NameS | An unqualified name; dynamically bound |
NameQ ModName | A qualified name; dynamically bound |
NameU !Int | A unique local name |
NameL !Int | Local name bound outside of the TH AST |
NameG NameSpace PkgName ModName | Global name bound outside of the TH AST: An original name (occurrences only, not binders) Need the namespace too to be sure which thing we are naming |
Instances
Instances
Eq OccName Source # | |
Data OccName Source # | |
Defined in Language.Haskell.TH.Syntax gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> OccName -> c OccName Source # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c OccName Source # toConstr :: OccName -> Constr Source # dataTypeOf :: OccName -> DataType Source # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c OccName) Source # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c OccName) Source # gmapT :: (forall b. Data b => b -> b) -> OccName -> OccName Source # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> OccName -> r Source # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> OccName -> r Source # gmapQ :: (forall d. Data d => d -> u) -> OccName -> [u] Source # gmapQi :: Int -> (forall d. Data d => d -> u) -> OccName -> u Source # gmapM :: Monad m => (forall d. Data d => d -> m d) -> OccName -> m OccName Source # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> OccName -> m OccName Source # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> OccName -> m OccName Source # | |
Ord OccName Source # | |
Show OccName Source # | |
Generic OccName Source # | |
type Rep OccName Source # | |
Defined in Language.Haskell.TH.Syntax |
Obtained from reifyModule
and thisModule
.
Instances
Eq Module Source # | |
Data Module Source # | |
Defined in Language.Haskell.TH.Syntax gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Module -> c Module Source # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Module Source # toConstr :: Module -> Constr Source # dataTypeOf :: Module -> DataType Source # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Module) Source # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Module) Source # gmapT :: (forall b. Data b => b -> b) -> Module -> Module Source # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Module -> r Source # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Module -> r Source # gmapQ :: (forall d. Data d => d -> u) -> Module -> [u] Source # gmapQi :: Int -> (forall d. Data d => d -> u) -> Module -> u Source # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Module -> m Module Source # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Module -> m Module Source # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Module -> m Module Source # | |
Ord Module Source # | |
Show Module Source # | |
Generic Module Source # | |
Ppr Module Source # | |
type Rep Module Source # | |
Defined in Language.Haskell.TH.Syntax type Rep Module = D1 (MetaData "Module" "Language.Haskell.TH.Syntax" "template-haskell" False) (C1 (MetaCons "Module" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 PkgName) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ModName))) |
Instances
Eq PkgName Source # | |
Data PkgName Source # | |
Defined in Language.Haskell.TH.Syntax gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> PkgName -> c PkgName Source # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c PkgName Source # toConstr :: PkgName -> Constr Source # dataTypeOf :: PkgName -> DataType Source # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c PkgName) Source # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c PkgName) Source # gmapT :: (forall b. Data b => b -> b) -> PkgName -> PkgName Source # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> PkgName -> r Source # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> PkgName -> r Source # gmapQ :: (forall d. Data d => d -> u) -> PkgName -> [u] Source # gmapQi :: Int -> (forall d. Data d => d -> u) -> PkgName -> u Source # gmapM :: Monad m => (forall d. Data d => d -> m d) -> PkgName -> m PkgName Source # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> PkgName -> m PkgName Source # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> PkgName -> m PkgName Source # | |
Ord PkgName Source # | |
Show PkgName Source # | |
Generic PkgName Source # | |
type Rep PkgName Source # | |
Defined in Language.Haskell.TH.Syntax |
Instances
Eq ModName Source # | |
Data ModName Source # | |
Defined in Language.Haskell.TH.Syntax gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ModName -> c ModName Source # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ModName Source # toConstr :: ModName -> Constr Source # dataTypeOf :: ModName -> DataType Source # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ModName) Source # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ModName) Source # gmapT :: (forall b. Data b => b -> b) -> ModName -> ModName Source # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ModName -> r Source # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ModName -> r Source # gmapQ :: (forall d. Data d => d -> u) -> ModName -> [u] Source # gmapQi :: Int -> (forall d. Data d => d -> u) -> ModName -> u Source # gmapM :: Monad m => (forall d. Data d => d -> m d) -> ModName -> m ModName Source # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ModName -> m ModName Source # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ModName -> m ModName Source # | |
Ord ModName Source # | |
Show ModName Source # | |
Generic ModName Source # | |
type Rep ModName Source # | |
Defined in Language.Haskell.TH.Syntax |
class (MonadIO m, MonadFail m) => Quasi m where Source #
qNewName, qReport, qRecover, qLookupName, qReify, qReifyFixity, qReifyInstances, qReifyRoles, qReifyAnnotations, qReifyModule, qReifyConStrictness, qLocation, qAddDependentFile, qAddTopDecls, qAddForeignFile, qAddModFinalizer, qAddCorePlugin, qGetQ, qPutQ, qIsExtEnabled, qExtsEnabled
:: Bool | |
-> String | |
-> m () | Report an error (True) or warning (False)
...but carry on; use |
:: m a | the error handler |
-> m a | action which may fail |
-> m a | Recover from the monadic |
qLookupName :: Bool -> String -> m (Maybe Name) Source #
qReify :: Name -> m Info Source #
qReifyFixity :: Name -> m (Maybe Fixity) Source #
qReifyInstances :: Name -> [Type] -> m [Dec] Source #
qReifyRoles :: Name -> m [Role] Source #
qReifyAnnotations :: Data a => AnnLookup -> m [a] Source #
qReifyModule :: Module -> m ModuleInfo Source #
qReifyConStrictness :: Name -> m [DecidedStrictness] Source #
qRunIO :: IO a -> m a Source #
qAddDependentFile :: FilePath -> m () Source #
qAddTopDecls :: [Dec] -> m () Source #
qAddForeignFile :: ForeignSrcLang -> String -> m () Source #
qAddModFinalizer :: Q () -> m () Source #
qAddCorePlugin :: String -> m () Source #
qGetQ :: Typeable a => m (Maybe a) Source #
qPutQ :: Typeable a => a -> m () Source #
qIsExtEnabled :: Extension -> m Bool Source #
qExtsEnabled :: m [Extension] Source #
Instances
report :: Bool -> String -> Q () Source #
Deprecated: Use reportError or reportWarning instead
Report an error (True) or warning (False),
but carry on; use fail
to stop.
reportError :: String -> Q () Source #
Report an error to the user, but allow the current splice's computation to carry on. To abort the computation, use fail
.
reportWarning :: String -> Q () Source #
Report a warning to the user, and carry on.
Recover from errors raised by reportError
or fail
.
lookupTypeName :: String -> Q (Maybe Name) Source #
Look up the given name in the (type namespace of the) current splice's scope. See Language.Haskell.TH.Syntax for more details.
lookupValueName :: String -> Q (Maybe Name) Source #
Look up the given name in the (value namespace of the) current splice's scope. See Language.Haskell.TH.Syntax for more details.
reify :: Name -> Q Info Source #
reify
looks up information about the Name
.
It is sometimes useful to construct the argument name using lookupTypeName
or lookupValueName
to ensure that we are reifying from the right namespace. For instance, in this context:
data D = D
which D
does reify (mkName "D")
return information about? (Answer: D
-the-type, but don't rely on it.)
To ensure we get information about D
-the-value, use lookupValueName
:
do Just nm <- lookupValueName "D" reify nm
and to get information about D
-the-type, use lookupTypeName
.
reifyFixity :: Name -> Q (Maybe Fixity) Source #
reifyFixity nm
attempts to find a fixity declaration for nm
. For
example, if the function foo
has the fixity declaration infixr 7 foo
, then
reifyFixity 'foo
would return
. If the function
Just
(Fixity
7 InfixR
)bar
does not have a fixity declaration, then reifyFixity 'bar
returns
Nothing
, so you may assume bar
has defaultFixity
.
reifyInstances :: Name -> [Type] -> Q [InstanceDec] Source #
reifyInstances nm tys
returns a list of visible instances of nm tys
. That is,
if nm
is the name of a type class, then all instances of this class at the types tys
are returned. Alternatively, if nm
is the name of a data family or type family,
all instances of this family at the types tys
are returned.
reifyRoles :: Name -> Q [Role] Source #
reifyRoles nm
returns the list of roles associated with the parameters of
the tycon nm
. Fails if nm
cannot be found or is not a tycon.
The returned list should never contain InferR
.
reifyAnnotations :: Data a => AnnLookup -> Q [a] Source #
reifyAnnotations target
returns the list of annotations
associated with target
. Only the annotations that are
appropriately typed is returned. So if you have Int
and String
annotations for the same target, you have to call this function twice.
reifyModule :: Module -> Q ModuleInfo Source #
reifyModule mod
looks up information about module mod
. To
look up the current module, call this function with the return
value of thisModule
.
reifyConStrictness :: Name -> Q [DecidedStrictness] Source #
reifyConStrictness nm
looks up the strictness information for the fields
of the constructor with the name nm
. Note that the strictness information
that reifyConStrictness
returns may not correspond to what is written in
the source code. For example, in the following data declaration:
data Pair a = Pair a a
reifyConStrictness
would return [
under most
circumstances, but it would return DecidedLazy
, DecidedLazy][
if the
DecidedStrict
, DecidedStrict]-XStrictData
language extension was enabled.
isInstance :: Name -> [Type] -> Q Bool Source #
Is the list of instances returned by reifyInstances
nonempty?
The runIO
function lets you run an I/O computation in the Q
monad.
Take care: you are guaranteed the ordering of calls to runIO
within
a single Q
computation, but not about the order in which splices are run.
Note: for various murky reasons, stdout and stderr handles are not necessarily flushed when the compiler finishes running, so you should flush them yourself.
addDependentFile :: FilePath -> Q () Source #
Record external files that runIO is using (dependent upon). The compiler can then recognize that it should re-compile the Haskell file when an external file changes.
Expects an absolute file path.
Notes:
- ghc -M does not know about these dependencies - it does not execute TH.
- The dependency is based on file content, not a modification time
addTopDecls :: [Dec] -> Q () Source #
Add additional top-level declarations. The added declarations will be type checked along with the current declaration group.
addForeignFile :: ForeignSrcLang -> String -> Q () Source #
Emit a foreign file which will be compiled and linked to the object for the current module. Currently only languages that can be compiled with the C compiler are supported, and the flags passed as part of -optc will be also applied to the C compiler invocation that will compile them.
Note that for non-C languages (for example C++) extern C
directives
must be used to get symbols that we can access from Haskell.
To get better errors, it is reccomended to use #line pragmas when emitting C files, e.g.
{-# LANGUAGE CPP #-} ... addForeignFile LangC $ unlines [ "#line " ++ show (__LINE__ + 1) ++ " " ++ show __FILE__ , ... ]
addModFinalizer :: Q () -> Q () Source #
Add a finalizer that will run in the Q monad after the current module has been type checked. This only makes sense when run within a top-level splice.
The finalizer is given the local type environment at the splice point. Thus
reify
is able to find the local definitions when executed inside the
finalizer.
addCorePlugin :: String -> Q () Source #
Adds a core plugin to the compilation pipeline.
addCorePlugin m
has almost the same effect as passing -fplugin=m
to ghc
in the command line. The major difference is that the plugin module m
must not belong to the current package. When TH executes, it is too late
to tell the compiler that we needed to compile first a plugin module in the
current package.
getQ :: Typeable a => Q (Maybe a) Source #
Get state from the Q
monad. Note that the state is local to the
Haskell module in which the Template Haskell expression is executed.
putQ :: Typeable a => a -> Q () Source #
Replace the state in the Q
monad. Note that the state is local to the
Haskell module in which the Template Haskell expression is executed.
isExtEnabled :: Extension -> Q Bool Source #
Determine whether the given language extension is enabled in the Q
monad.
extsEnabled :: Q [Extension] Source #
List all enabled language extensions.
nothingName :: Name Source #
dataToQa :: forall a k q. Data a => (Name -> k) -> (Lit -> Q q) -> (k -> [Q q] -> Q q) -> (forall b. Data b => b -> Maybe (Q q)) -> a -> Q q Source #
dataToQa
is an internal utility function for constructing generic
conversion functions from types with Data
instances to various
quasi-quoting representations. See the source of dataToExpQ
and
dataToPatQ
for two example usages: mkCon
, mkLit
and appQ
are overloadable to account for different syntax for
expressions and patterns; antiQ
allows you to override type-specific
cases, a common usage is just const Nothing
, which results in
no overloading.
dataToExpQ :: Data a => (forall b. Data b => b -> Maybe (Q Exp)) -> a -> Q Exp Source #
dataToExpQ
converts a value to a 'Q Exp' representation of the
same value, in the SYB style. It is generalized to take a function
override type-specific cases; see liftData
for a more commonly
used variant.
dataToPatQ :: Data a => (forall b. Data b => b -> Maybe (Q Pat)) -> a -> Q Pat Source #
dataToPatQ
converts a value to a 'Q Pat' representation of the same
value, in the SYB style. It takes a function to handle type-specific cases,
alternatively, pass const Nothing
to get default behavior.
nameBase :: Name -> String Source #
The name without its module prefix.
Examples
>>>
nameBase ''Data.Either.Either
"Either">>>
nameBase (mkName "foo")
"foo">>>
nameBase (mkName "Module.foo")
"foo"
nameModule :: Name -> Maybe String Source #
Module prefix of a name, if it exists.
Examples
>>>
nameModule ''Data.Either.Either
Just "Data.Either">>>
nameModule (mkName "foo")
Nothing>>>
nameModule (mkName "Module.foo")
Just "Module"
namePackage :: Name -> Maybe String Source #
A name's package, if it exists.
Examples
>>>
namePackage ''Data.Either.Either
Just "base">>>
namePackage (mkName "foo")
Nothing>>>
namePackage (mkName "Module.foo")
Nothing
nameSpace :: Name -> Maybe NameSpace Source #
Returns whether a name represents an occurrence of a top-level variable
(VarName
), data constructor (DataName
), type constructor, or type class
(TcClsName
). If we can't be sure, it returns Nothing
.
Examples
>>>
nameSpace 'Prelude.id
Just VarName>>>
nameSpace (mkName "id")
Nothing -- only works for top-level variable names>>>
nameSpace 'Data.Maybe.Just
Just DataName>>>
nameSpace ''Data.Maybe.Maybe
Just TcClsName>>>
nameSpace ''Data.Ord.Ord
Just TcClsName
mkNameG :: NameSpace -> String -> String -> String -> Name Source #
Used for 'x etc, but not available to the programmer
tupleDataName :: Int -> Name Source #
Tuple data constructor
tupleTypeName :: Int -> Name Source #
Tuple type constructor
unboxedTupleDataName :: Int -> Name Source #
Unboxed tuple data constructor
unboxedTupleTypeName :: Int -> Name Source #
Unboxed tuple type constructor
unboxedSumTypeName :: SumArity -> Name Source #
Unboxed sum type constructor
maxPrecedence :: Int Source #
Highest allowed operator precedence for Fixity
constructor (answer: 9)
defaultFixity :: Fixity Source #
Default fixity: infixl 9
Language extensions
data ForeignSrcLang Source #
Instances
Eq ForeignSrcLang | |
Defined in GHC.ForeignSrcLang.Type (==) :: ForeignSrcLang -> ForeignSrcLang -> Bool # (/=) :: ForeignSrcLang -> ForeignSrcLang -> Bool # | |
Show ForeignSrcLang | |
Defined in GHC.ForeignSrcLang.Type | |
Generic ForeignSrcLang | |
Defined in GHC.ForeignSrcLang.Type from :: ForeignSrcLang -> Rep ForeignSrcLang x Source # to :: Rep ForeignSrcLang x -> ForeignSrcLang Source # | |
type Rep ForeignSrcLang | |
Defined in GHC.ForeignSrcLang.Type type Rep ForeignSrcLang = D1 (MetaData "ForeignSrcLang" "GHC.ForeignSrcLang.Type" "ghc-boot-th-8.4.4" False) ((C1 (MetaCons "LangC" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "LangCxx" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "LangObjc" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "LangObjcxx" PrefixI False) (U1 :: * -> *))) |