ghc/compiler/typecheck/TcSplice.lhs

   1 2%
   2 % (c) The GRASP/AQUA Project, Glasgow University, 1992-1998
   3 %
   4 \section[TcSplice]{Template Haskell splices}
   5
   6 \begin{code}
   7 module TcSplice( tcSpliceExpr, tcSpliceDecls, tcBracket ) where
   8
   9 #include "HsVersions.h"
  10
  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
  15
  16 import qualified Language.Haskell.THSyntax as Meta
  17
  18 import HscTypes         ( HscEnv(..), GhciMode(..), PersistentCompilerState(..), unQualInScope )
  19 import HsSyn            ( HsBracket(..) )
  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 )
  27 import TcType           ( TcType, openTypeKind, mkAppTy )
  28 import TcEnv            ( spliceOK, tcMetaTy )
  29 import TcRnTypes        ( TopEnv(..) )
  30 import TcMType          ( newTyVarTy )
  31 import Name             ( Name )
  32 import TcRnMonad
  33
  34 import TysWiredIn       ( mkListTy )
  35 import DsMeta           ( exprTyConName, declTyConName, decTyConName, qTyConName )
  36 import Outputable
  37 import GHC.Base         ( unsafeCoerce# )       -- Should have a better home in the module hierarchy
  38 \end{code}
  39
  40
  41 %************************************************************************
  42 %*                                                                      *
  43 \subsection{Main interface + stubs for the non-GHCI case
  44 %*                                                                      *
  45 %************************************************************************
  46
  47 \begin{code}
  48 tcSpliceDecls :: RenamedHsExpr -> TcM [RdrNameHsDecl]
  49
  50 tcSpliceExpr :: Name
  51              -> RenamedHsExpr
  52              -> TcType
  53              -> TcM TcExpr
  54
  55 #ifndef GHCI
  56 tcSpliceExpr n e ty = pprPanic "Cant do tcSpliceExpr without GHCi" (ppr e)
  57 tcSpliceDecls e     = pprPanic "Cant do tcSpliceDecls without GHCi" (ppr e)
  58 #else
  59 \end{code}
  60
  61 %************************************************************************
  62 %*                                                                      *
  63 \subsection{Splicing an expression}
  64 %*                                                                      *
  65 %************************************************************************
  66
  67 \begin{code}
  68 tcBracket :: HsBracket Name -> TcM TcType
  69 tcBracket (ExpBr expr)
  70   = newTyVarTy openTypeKind             `thenM` \ any_ty ->
  71     tcMonoExpr expr any_ty              `thenM_`
  72     tcMetaTy exprTyConName
  73         -- Result type is Expr (= Q Exp)
  74
  75 tcBracket (DecBr decls)
  76   = tcTopSrcDecls decls                 `thenM_`
  77     tcMetaTy decTyConName               `thenM` \ decl_ty ->
  78     tcMetaTy qTyConName                 `thenM` \ q_ty ->
  79     returnM (mkAppTy q_ty (mkListTy decl_ty))
  80         -- Result type is Q [Dec]
  81 \end{code}
  82
  83
  84 %************************************************************************
  85 %*                                                                      *
  86 \subsection{Splicing an expression}
  87 %*                                                                      *
  88 %************************************************************************
  89
  90 \begin{code}
  91 tcSpliceExpr name expr res_ty
  92   = getStage            `thenM` \ level ->
  93     case spliceOK level of {
  94         Nothing         -> failWithTc (illegalSplice level) ;
  95         Just next_level ->
  96
  97     case level of {
  98         Comp                   -> tcTopSplice expr res_ty ;
  99         Brack _ ps_var lie_var ->
 100
 101         -- A splice inside brackets
 102         -- NB: ignore res_ty
 103         -- e.g.   [| reverse $(h 4) |]
 104         -- Here (h 4) :: Q Exp
 105         -- but $(h 4) :: forall a.a     i.e. anything!
 106
 107     tcMetaTy exprTyConName                      `thenM` \ meta_exp_ty ->
 108     setStage (Splice next_level) (
 109         setLIEVar lie_var          $
 110         tcMonoExpr expr meta_exp_ty
 111     )                                           `thenM` \ expr' ->
 112
 113         -- Write the pending splice into the bucket
 114     readMutVar ps_var                           `thenM` \ ps ->
 115     writeMutVar ps_var ((name,expr') : ps)      `thenM_`
 116
 117     returnM (panic "tcSpliceExpr")      -- The returned expression is ignored
 118     }}
 119
 120 -- tcTopSplice used to have this:
 121 -- Note that we do not decrement the level (to -1) before
 122 -- typechecking the expression.  For example:
 123 --      f x = $( ...$(g 3) ... )
 124 -- The recursive call to tcMonoExpr will simply expand the
 125 -- inner escape before dealing with the outer one
 126
 127 tcTopSplice expr res_ty
 128   = tcMetaTy exprTyConName              `thenM` \ meta_exp_ty ->
 129     setStage topSpliceStage (
 130         getLIE (tcMonoExpr expr meta_exp_ty)
 131     )                                   `thenM` \ (expr', lie) ->
 132
 133         -- Solve the constraints
 134     tcSimplifyTop lie                   `thenM` \ const_binds ->
 135     let
 136         q_expr = mkHsLet const_binds expr'
 137     in
 138     zonkTopExpr q_expr                  `thenM` \ zonked_q_expr ->
 139
 140         -- Run the expression
 141     traceTc (text "About to run" <+> ppr zonked_q_expr)         `thenM_`
 142     runMetaE zonked_q_expr              `thenM` \ simple_expr ->
 143
 144     let
 145         -- simple_expr :: Meta.Exp
 146
 147         expr2 :: RdrNameHsExpr
 148         expr2 = convertToHsExpr simple_expr
 149     in
 150     traceTc (text "Got result" <+> ppr expr2)   `thenM_`
 151
 152     showSplice "expression"
 153                zonked_q_expr (ppr expr2)        `thenM_`
 154     initRn SourceMode (rnExpr expr2)            `thenM` \ (exp3, fvs) ->
 155     importSupportingDecls fvs                   `thenM` \ env ->
 156
 157     setGblEnv env (tcMonoExpr exp3 res_ty)
 158 \end{code}
 159
 160
 161 %************************************************************************
 162 %*                                                                      *
 163 \subsection{Splicing an expression}
 164 %*                                                                      *
 165 %************************************************************************
 166
 167 \begin{code}
 168 -- Always at top level
 169 tcSpliceDecls expr
 170   = tcMetaTy decTyConName               `thenM` \ meta_dec_ty ->
 171     tcMetaTy qTyConName                 `thenM` \ meta_q_ty ->
 172     setStage topSpliceStage (
 173         getLIE (tcMonoExpr expr (mkAppTy meta_q_ty (mkListTy meta_dec_ty)))
 174     )                                   `thenM` \ (expr', lie) ->
 175         -- Solve the constraints
 176     tcSimplifyTop lie                   `thenM` \ const_binds ->
 177     let
 178         q_expr = mkHsLet const_binds expr'
 179     in
 180     zonkTopExpr q_expr                  `thenM` \ zonked_q_expr ->
 181
 182         -- Run the expression
 183     traceTc (text "About to run" <+> ppr zonked_q_expr)         `thenM_`
 184     runMetaD zonked_q_expr              `thenM` \ simple_expr ->
 185     let
 186         -- simple_expr :: [Meta.Dec]
 187         decls :: [RdrNameHsDecl]
 188         decls = convertToHsDecls simple_expr
 189     in
 190     traceTc (text "Got result" <+> vcat (map ppr decls))        `thenM_`
 191     showSplice "declarations"
 192                zonked_q_expr (vcat (map ppr decls))             `thenM_`
 193     returnM decls
 194 \end{code}
 195
 196
 197 %************************************************************************
 198 %*                                                                      *
 199 \subsection{Running an expression}
 200 %*                                                                      *
 201 %************************************************************************
 202
 203 \begin{code}
 204 runMetaE :: TypecheckedHsExpr   -- Of type (Q Exp)
 205          -> TcM Meta.Exp        -- Of type Exp
 206 runMetaE e = runMeta e
 207
 208 runMetaD :: TypecheckedHsExpr   -- Of type Q [Dec]
 209          -> TcM [Meta.Dec]      -- Of type [Dec]
 210 runMetaD e = runMeta e
 211
 212 -- Warning: if Q is anything other than IO, we need to change this
 213 tcRunQ :: Meta.Q a -> TcM a
 214 tcRunQ thing = ioToTcRn thing
 215
 216
 217 runMeta :: TypecheckedHsExpr    -- Of type X
 218         -> TcM t                -- Of type t
 219 runMeta expr
 220   = getTopEnv           `thenM` \ top_env ->
 221     getEps              `thenM` \ eps ->
 222     getNameCache        `thenM` \ name_cache ->
 223     getModule           `thenM` \ this_mod ->
 224     getGlobalRdrEnv     `thenM` \ rdr_env ->
 225     let
 226         ghci_mode = top_mode top_env
 227
 228         hsc_env = HscEnv { hsc_mode = ghci_mode, hsc_HPT = top_hpt top_env,
 229                            hsc_dflags = top_dflags top_env }
 230
 231         pcs = PCS { pcs_nc = name_cache, pcs_EPS = eps }
 232
 233         print_unqual = unQualInScope rdr_env
 234     in
 235     if (ghci_mode == OneShot) then
 236         failWithTc (ptext SLIT("You must use --make or --interactive to run splice expressions"))
 237         -- The reason for this is that the demand-linker doesn't have
 238         -- enough information available to link all the things that
 239         -- are needed when you try to run a splice
 240     else
 241
 242     ioToTcRn (HscMain.compileExpr hsc_env pcs this_mod
 243                                   print_unqual expr) `thenM` \ hval ->
 244
 245     tryM (tcRunQ (unsafeCoerce# hval))  `thenM` \ either_tval ->
 246
 247     case either_tval of
 248           Left exn -> failWithTc (vcat [text "Exception when running compile-time code:",
 249                                         nest 4 (vcat [text "Code:" <+> ppr expr,
 250                                                       text ("Exn: " ++ show exn)])])
 251           Right v  -> returnM v
 252 \end{code}
 253
 254
 255
 256 -----------------------------------
 257         Random comments
 258
 259
 260       module Foo where
 261         import Lib( g :: Int -> M Exp )
 262         h x = not x
 263         f x y = [| \z -> (x, $(g y), z, map, h) |]
 264
 265         h p = $( (\q r -> if q then [| \s -> (p,r,s) |]
 266                                else ... ) True 3)   )
 267
 268 ==> core
 269
 270         f :: Liftable a => a -> Int -> M Exp
 271         f = /\a -> \d::Liftable a ->
 272             \ x y -> genSym "z"         `bindM` \ z::String ->
 273                      g y                `bindM` \ vv::Exp ->
 274                      Lam z (Tup [lift d x, v, Var z,
 275                                  Glob "Prelude" "map",
 276                                  Glob "Foo" "h"])
 277
 278
 279         h :: Tree Int -> M Exp
 280         h = \p -> \s' -> (p,3,s')
 281
 282
 283                 Bound   Used
 284
 285         map:    C0      C1      (top-level/imp)
 286         x:      C0      C1      (lam/case)
 287         y:      C0      C0
 288         z:      C1      C1
 289
 290         p:      C0      S1
 291         r:      S0      S1
 292         q:      S0      S0
 293         s:      S1      S1
 294
 295 -------
 296
 297         f x y = lam "z" (tup [lift x, g y, var "z",
 298                               [| map |], [| h |] ])
 299 ==> core
 300
 301         f = \x y -> lam "z" (tup [lift d x, g y, var "z",
 302                                   return (Glob "Prelude" "map"),
 303                                   return (Glob "Foo" "h")])
 304
 305
 306
 307
 308
 309
 310
 311         h :: M Exp -> M Exp
 312         h v = [| \x -> map $v x |]
 313
 314         g :: Tree Int -> M Exp
 315         g x = $(h [| x |])
 316 ==>
 317         g x = \x' -> map x x'
 318
 319 *** Simon claims x does not have to be liftable! **
 320
 321 Level 0 compile time
 322 Level 1 run time
 323 Level 2 code returned by run time (generation time)
 324
 325 Non-top-level variables
 326         x occurs at level 1
 327           inside brackets
 328             bound at level 0    --> x
 329             bound at level 1    --> var "x"
 330
 331           not inside brackets   --> x
 332
 333         x at level 2
 334           inside brackets
 335             bound at level 0    --> x
 336             bound at level 1    --> var "x"
 337
 338         f x = x
 339
 340 Two successive brackets aren't allowed
 341
 342
 343 %************************************************************************
 344 %*                                                                      *
 345 \subsection{Errors and contexts}
 346 %*                                                                      *
 347 %************************************************************************
 348
 349 \begin{code}
 350 showSplice :: String -> TypecheckedHsExpr -> SDoc -> TcM ()
 351 showSplice what before after
 352   = getSrcLocM          `thenM` \ loc ->
 353     traceSplice (vcat [ppr loc <> colon <+> text "Splicing" <+> text what,
 354                        nest 2 (sep [nest 2 (ppr before),
 355                                     text "======>",
 356                                     nest 2 after])])
 357
 358 illegalSplice level
 359   = ptext SLIT("Illegal splice at level") <+> ppr level
 360
 361 #endif  /* GHCI */
 362 \end{code}