2 % (c) The GRASP/AQUA Project, Glasgow University, 1992-1998
4 \section[TcSplice]{Template Haskell splices}
7 module TcSplice( tcSpliceExpr, tcSpliceDecls, tcBracket ) where
9 #include "HsVersions.h"
11 import HscMain ( compileExpr )
12 import TcRnDriver ( importSupportingDecls, tcTopSrcDecls )
13 -- These imports are the reason that TcSplice
14 -- is very high up the module hierarchy
16 import qualified Language.Haskell.THSyntax as Meta
18 import HscTypes ( HscEnv(..), GhciMode(..), PersistentCompilerState(..), unQualInScope )
19 import HsSyn ( HsBracket(..), HsExpr(..) )
20 import Convert ( convertToHsExpr, convertToHsDecls )
21 import RnExpr ( rnExpr )
22 import RdrHsSyn ( RdrNameHsExpr, RdrNameHsDecl )
23 import RnHsSyn ( RenamedHsExpr )
24 import TcExpr ( tcMonoExpr )
25 import TcHsSyn ( TcExpr, TypecheckedHsExpr, mkHsLet, zonkTopExpr )
26 import TcSimplify ( tcSimplifyTop, tcSimplifyBracket )
27 import TcUnify ( unifyTauTy )
28 import TcType ( TcType, openTypeKind, mkAppTy )
29 import TcEnv ( spliceOK, tcMetaTy, tcWithTempInstEnv, bracketOK )
30 import TcRnTypes ( TopEnv(..) )
31 import TcMType ( newTyVarTy, zapToType )
35 import TysWiredIn ( mkListTy )
36 import DsMeta ( exprTyConName, declTyConName, decTyConName, qTyConName )
37 import ErrUtils (Message)
39 import Panic ( showException )
40 import GHC.Base ( unsafeCoerce# ) -- Should have a better home in the module hierarchy
45 %************************************************************************
47 \subsection{Main interface + stubs for the non-GHCI case
49 %************************************************************************
52 tcSpliceDecls :: RenamedHsExpr -> TcM [RdrNameHsDecl]
60 tcSpliceExpr n e ty = pprPanic "Cant do tcSpliceExpr without GHCi" (ppr e)
61 tcSpliceDecls e = pprPanic "Cant do tcSpliceDecls without GHCi" (ppr e)
65 %************************************************************************
67 \subsection{Quoting an expression}
69 %************************************************************************
72 tcBracket :: HsBracket Name -> TcType -> TcM TcExpr
73 tcBracket brack res_ty
74 = getStage `thenM` \ level ->
75 case bracketOK level of {
76 Nothing -> failWithTc (illegalBracket level) ;
79 -- Typecheck expr to make sure it is valid,
80 -- but throw away the results. We'll type check
81 -- it again when we actually use it.
82 newMutVar [] `thenM` \ pending_splices ->
83 getLIEVar `thenM` \ lie_var ->
85 setStage (Brack next_level pending_splices lie_var) (
86 getLIE (tc_bracket brack)
87 ) `thenM` \ (meta_ty, lie) ->
88 tcSimplifyBracket lie `thenM_`
90 unifyTauTy res_ty meta_ty `thenM_`
92 -- Return the original expression, not the type-decorated one
93 readMutVar pending_splices `thenM` \ pendings ->
94 returnM (HsBracketOut brack pendings)
97 tc_bracket (ExpBr expr)
98 = newTyVarTy openTypeKind `thenM` \ any_ty ->
99 tcMonoExpr expr any_ty `thenM_`
100 tcMetaTy exprTyConName
101 -- Result type is Expr (= Q Exp)
103 tc_bracket (DecBr decls)
104 = tcWithTempInstEnv (tcTopSrcDecls decls) `thenM_`
105 -- Typecheck the declarations, dicarding any side effects
106 -- on the instance environment (which is in a mutable variable)
107 -- and the extended environment. We'll get all that stuff
108 -- later, when we splice it in
110 tcMetaTy decTyConName `thenM` \ decl_ty ->
111 tcMetaTy qTyConName `thenM` \ q_ty ->
112 returnM (mkAppTy q_ty (mkListTy decl_ty))
113 -- Result type is Q [Dec]
117 %************************************************************************
119 \subsection{Splicing an expression}
121 %************************************************************************
124 tcSpliceExpr name expr res_ty
125 = getStage `thenM` \ level ->
126 case spliceOK level of {
127 Nothing -> failWithTc (illegalSplice level) ;
131 Comp -> tcTopSplice expr res_ty ;
132 Brack _ ps_var lie_var ->
134 -- A splice inside brackets
135 -- NB: ignore res_ty, apart from zapping it to a mono-type
136 -- e.g. [| reverse $(h 4) |]
137 -- Here (h 4) :: Q Exp
138 -- but $(h 4) :: forall a.a i.e. anything!
140 zapToType res_ty `thenM_`
141 tcMetaTy exprTyConName `thenM` \ meta_exp_ty ->
142 setStage (Splice next_level) (
144 tcMonoExpr expr meta_exp_ty
147 -- Write the pending splice into the bucket
148 readMutVar ps_var `thenM` \ ps ->
149 writeMutVar ps_var ((name,expr') : ps) `thenM_`
151 returnM (panic "tcSpliceExpr") -- The returned expression is ignored
154 -- tcTopSplice used to have this:
155 -- Note that we do not decrement the level (to -1) before
156 -- typechecking the expression. For example:
157 -- f x = $( ...$(g 3) ... )
158 -- The recursive call to tcMonoExpr will simply expand the
159 -- inner escape before dealing with the outer one
161 tcTopSplice expr res_ty
162 = tcMetaTy exprTyConName `thenM` \ meta_exp_ty ->
164 -- Typecheck the expression
165 tcTopSpliceExpr expr meta_exp_ty `thenM` \ zonked_q_expr ->
167 -- Run the expression
168 traceTc (text "About to run" <+> ppr zonked_q_expr) `thenM_`
169 runMetaE zonked_q_expr `thenM` \ simple_expr ->
172 -- simple_expr :: Meta.Exp
174 expr2 :: RdrNameHsExpr
175 expr2 = convertToHsExpr simple_expr
177 traceTc (text "Got result" <+> ppr expr2) `thenM_`
179 showSplice "expression"
180 zonked_q_expr (ppr expr2) `thenM_`
181 initRn SourceMode (rnExpr expr2) `thenM` \ (exp3, fvs) ->
182 importSupportingDecls fvs `thenM` \ env ->
184 setGblEnv env (tcMonoExpr exp3 res_ty)
187 tcTopSpliceExpr :: RenamedHsExpr -> TcType -> TcM TypecheckedHsExpr
188 -- Type check an expression that is the body of a top-level splice
189 -- (the caller will compile and run it)
190 tcTopSpliceExpr expr meta_ty
191 = checkNoErrs $ -- checkNoErrs: must not try to run the thing
192 -- if the type checker fails!
194 setStage topSpliceStage $
196 -- Typecheck the expression
197 getLIE (tcMonoExpr expr meta_ty) `thenM` \ (expr', lie) ->
199 -- Solve the constraints
200 tcSimplifyTop lie `thenM` \ const_binds ->
203 zonkTopExpr (mkHsLet const_binds expr')
207 %************************************************************************
209 \subsection{Splicing an expression}
211 %************************************************************************
214 -- Always at top level
216 = tcMetaTy decTyConName `thenM` \ meta_dec_ty ->
217 tcMetaTy qTyConName `thenM` \ meta_q_ty ->
219 list_q = mkAppTy meta_q_ty (mkListTy meta_dec_ty)
221 tcTopSpliceExpr expr list_q `thenM` \ zonked_q_expr ->
223 -- Run the expression
224 traceTc (text "About to run" <+> ppr zonked_q_expr) `thenM_`
225 runMetaD zonked_q_expr `thenM` \ simple_expr ->
226 -- simple_expr :: [Meta.Dec]
227 -- decls :: [RdrNameHsDecl]
228 handleErrors (convertToHsDecls simple_expr) `thenM` \ decls ->
229 traceTc (text "Got result" <+> vcat (map ppr decls)) `thenM_`
230 showSplice "declarations"
231 zonked_q_expr (vcat (map ppr decls)) `thenM_`
234 where handleErrors :: [Either a Message] -> TcM [a]
235 handleErrors [] = return []
236 handleErrors (Left x:xs) = liftM (x:) (handleErrors xs)
237 handleErrors (Right m:xs) = do addErrTc m
242 %************************************************************************
244 \subsection{Running an expression}
246 %************************************************************************
249 runMetaE :: TypecheckedHsExpr -- Of type (Q Exp)
250 -> TcM Meta.Exp -- Of type Exp
251 runMetaE e = runMeta e
253 runMetaD :: TypecheckedHsExpr -- Of type Q [Dec]
254 -> TcM [Meta.Dec] -- Of type [Dec]
255 runMetaD e = runMeta e
257 runMeta :: TypecheckedHsExpr -- Of type X
258 -> TcM t -- Of type t
260 = getTopEnv `thenM` \ top_env ->
261 getGblEnv `thenM` \ tcg_env ->
262 getEps `thenM` \ eps ->
263 getNameCache `thenM` \ name_cache ->
264 getModule `thenM` \ this_mod ->
266 ghci_mode = top_mode top_env
268 hsc_env = HscEnv { hsc_mode = ghci_mode, hsc_HPT = top_hpt top_env,
269 hsc_dflags = top_dflags top_env }
271 pcs = PCS { pcs_nc = name_cache, pcs_EPS = eps }
273 type_env = tcg_type_env tcg_env
274 rdr_env = tcg_rdr_env tcg_env
276 -- Wrap the compile-and-run in an exception-catcher
277 -- Compiling might fail if linking fails
278 -- Running might fail if it throws an exception
280 hval <- HscMain.compileExpr
282 rdr_env type_env expr
283 Meta.runQ (unsafeCoerce# hval) -- Coerce it to Q t, and run it
284 )) `thenM` \ either_tval ->
287 Left exn -> failWithTc (vcat [text "Exception when trying to run compile-time code:",
288 nest 4 (vcat [text "Code:" <+> ppr expr,
289 text ("Exn: " ++ Panic.showException exn)])])
295 -----------------------------------
300 import Lib( g :: Int -> M Exp )
302 f x y = [| \z -> (x, $(g y), z, map, h) |]
304 h p = $( (\q r -> if q then [| \s -> (p,r,s) |]
309 f :: Liftable a => a -> Int -> M Exp
310 f = /\a -> \d::Liftable a ->
311 \ x y -> genSym "z" `bindM` \ z::String ->
312 g y `bindM` \ vv::Exp ->
313 Lam z (Tup [lift d x, v, Var z,
314 Glob "Prelude" "map",
318 h :: Tree Int -> M Exp
319 h = \p -> \s' -> (p,3,s')
324 map: C0 C1 (top-level/imp)
336 f x y = lam "z" (tup [lift x, g y, var "z",
337 [| map |], [| h |] ])
340 f = \x y -> lam "z" (tup [lift d x, g y, var "z",
341 return (Glob "Prelude" "map"),
342 return (Glob "Foo" "h")])
351 h v = [| \x -> map $v x |]
353 g :: Tree Int -> M Exp
356 g x = \x' -> map x x'
358 *** Simon claims x does not have to be liftable! **
362 Level 2 code returned by run time (generation time)
364 Non-top-level variables
367 bound at level 0 --> x
368 bound at level 1 --> var "x"
370 not inside brackets --> x
374 bound at level 0 --> x
375 bound at level 1 --> var "x"
379 Two successive brackets aren't allowed
382 %************************************************************************
384 \subsection{Errors and contexts}
386 %************************************************************************
389 showSplice :: String -> TypecheckedHsExpr -> SDoc -> TcM ()
390 showSplice what before after
391 = getSrcLocM `thenM` \ loc ->
392 traceSplice (vcat [ppr loc <> colon <+> text "Splicing" <+> text what,
393 nest 2 (sep [nest 2 (ppr before),
398 = ptext SLIT("Illegal bracket at level") <+> ppr level
401 = ptext SLIT("Illegal splice at level") <+> ppr level