TcSplice.hs 75.2 KB
Newer Older
Austin Seipp's avatar
Austin Seipp committed
1 2 3
{-
(c) The University of Glasgow 2006
(c) The GRASP/AQUA Project, Glasgow University, 1992-1998
4

5

Austin Seipp's avatar
Austin Seipp committed
6 7
TcSplice: Template Haskell splices
-}
8

9 10 11 12 13
{-# LANGUAGE CPP #-}
{-# LANGUAGE FlexibleInstances #-}
{-# LANGUAGE MagicHash #-}
{-# LANGUAGE ScopedTypeVariables #-}
{-# LANGUAGE InstanceSigs #-}
14 15
{-# LANGUAGE GADTs #-}
{-# LANGUAGE RecordWildCards #-}
16
{-# LANGUAGE MultiWayIf #-}
17
{-# OPTIONS_GHC -fno-warn-orphans #-}
18

19 20 21
module TcSplice(
     -- These functions are defined in stage1 and stage2
     -- The raise civilised errors in stage1
22
     tcSpliceExpr, tcTypedBracket, tcUntypedBracket,
23 24
--     runQuasiQuoteExpr, runQuasiQuotePat,
--     runQuasiQuoteDecl, runQuasiQuoteType,
25 26 27 28 29 30
     runAnnotation,

#ifdef GHCI
     -- These ones are defined only in stage2, and are
     -- called only in stage2 (ie GHCI is on)
     runMetaE, runMetaP, runMetaT, runMetaD, runQuasi,
31
     tcTopSpliceExpr, lookupThName_maybe,
32 33
     defaultRunMeta, runMeta',
     finishTH
34 35
#endif
      ) where
36 37 38

#include "HsVersions.h"

39 40 41 42 43 44
import HsSyn
import Annotations
import Name
import TcRnMonad
import TcType

45 46 47
import Outputable
import TcExpr
import SrcLoc
48
import THNames
49 50 51
import TcUnify
import TcEnv

52 53
import Control.Monad

54
#ifdef GHCI
55 56 57
import GHCi.Message
import GHCi.RemoteTypes
import GHCi
58
import HscMain
59 60
        -- These imports are the reason that TcSplice
        -- is very high up the module hierarchy
61 62
import RnSplice( traceSplice, SpliceInfo(..) )
import RdrName
63
import HscTypes
64 65 66 67 68 69
import Convert
import RnExpr
import RnEnv
import RnTypes
import TcHsSyn
import TcSimplify
batterseapower's avatar
batterseapower committed
70
import Type
71
import Kind
72
import NameSet
73 74 75
import TcMType
import TcHsType
import TcIface
76
import TyCoRep
77 78
import FamInst
import FamInstEnv
79
import InstEnv
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
80
import Inst
81
import NameEnv
82
import PrelNames
83
import TysWiredIn
84
import OccName
85
import Hooks
86 87
import Var
import Module
88
import LoadIface
89 90
import Class
import TyCon
91
import CoAxiom
92
import PatSyn ( patSynName )
cactus's avatar
cactus committed
93
import ConLike
94
import DataCon
95
import TcEvidence( TcEvBinds(..) )
96 97 98
import Id
import IdInfo
import DsExpr
99
import DsMonad
100
import GHC.Serialized
101
import ErrUtils
102
import Util
103
import Unique
104
import VarSet           ( isEmptyVarSet, filterVarSet, mkVarSet, elemVarSet )
105
import Data.List        ( find )
Ian Lynagh's avatar
Ian Lynagh committed
106
import Data.Maybe
107
import FastString
108 109
import BasicTypes hiding( SuccessFlag(..) )
import Maybes( MaybeErr(..) )
110
import DynFlags
111
import Panic
112
import Lexeme
113

114 115 116
import qualified Language.Haskell.TH as TH
-- THSyntax gives access to internal functions and data types
import qualified Language.Haskell.TH.Syntax as TH
117

118 119
-- Because GHC.Desugar might not be in the base library of the bootstrapping compiler
import GHC.Desugar      ( AnnotationWrapper(..) )
120

121
import qualified Data.IntSet as IntSet
122 123 124 125 126
import Control.Exception
import Data.Binary
import Data.Binary.Get
import qualified Data.ByteString as B
import qualified Data.ByteString.Lazy as LB
127
import Data.Dynamic  ( fromDynamic, toDyn )
128 129
import qualified Data.Map as Map
import Data.Typeable ( typeOf, Typeable, TypeRep, typeRep )
130
import Data.Data (Data)
131
import Data.Proxy    ( Proxy (..) )
132
import GHC.Exts         ( unsafeCoerce# )
133 134
#endif

Austin Seipp's avatar
Austin Seipp committed
135 136 137
{-
************************************************************************
*                                                                      *
138
\subsection{Main interface + stubs for the non-GHCI case
Austin Seipp's avatar
Austin Seipp committed
139 140 141
*                                                                      *
************************************************************************
-}
142

143 144 145
tcTypedBracket   :: HsBracket Name -> ExpRhoType -> TcM (HsExpr TcId)
tcUntypedBracket :: HsBracket Name -> [PendingRnSplice] -> ExpRhoType -> TcM (HsExpr TcId)
tcSpliceExpr     :: HsSplice Name  -> ExpRhoType -> TcM (HsExpr TcId)
146 147
        -- None of these functions add constraints to the LIE

148 149 150 151
-- runQuasiQuoteExpr :: HsQuasiQuote RdrName -> RnM (LHsExpr RdrName)
-- runQuasiQuotePat  :: HsQuasiQuote RdrName -> RnM (LPat RdrName)
-- runQuasiQuoteType :: HsQuasiQuote RdrName -> RnM (LHsType RdrName)
-- runQuasiQuoteDecl :: HsQuasiQuote RdrName -> RnM [LHsDecl RdrName]
152 153

runAnnotation     :: CoreAnnTarget -> LHsExpr Name -> TcM Annotation
154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181
{-
************************************************************************
*                                                                      *
\subsection{Quoting an expression}
*                                                                      *
************************************************************************
-}

-- See Note [How brackets and nested splices are handled]
-- tcTypedBracket :: HsBracket Name -> TcRhoType -> TcM (HsExpr TcId)
tcTypedBracket brack@(TExpBr expr) res_ty
  = addErrCtxt (quotationCtxtDoc brack) $
    do { cur_stage <- getStage
       ; ps_ref <- newMutVar []
       ; lie_var <- getConstraintVar   -- Any constraints arising from nested splices
                                       -- should get thrown into the constraint set
                                       -- from outside the bracket

       -- Typecheck expr to make sure it is valid,
       -- Throw away the typechecked expression but return its type.
       -- We'll typecheck it again when we splice it in somewhere
       ; (_tc_expr, expr_ty) <- setStage (Brack cur_stage (TcPending ps_ref lie_var)) $
                                tcInferRhoNC expr
                                -- NC for no context; tcBracket does that

       ; meta_ty <- tcTExpTy expr_ty
       ; ps' <- readMutVar ps_ref
       ; texpco <- tcLookupId unsafeTExpCoerceName
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
182 183 184 185
       ; tcWrapResultO (Shouldn'tHappenOrigin "TExpBr")
                       (unLoc (mkHsApp (nlHsTyApp texpco [expr_ty])
                                              (noLoc (HsTcBracketOut brack ps'))))
                       meta_ty res_ty }
186 187 188
tcTypedBracket other_brack _
  = pprPanic "tcTypedBracket" (ppr other_brack)

189
-- tcUntypedBracket :: HsBracket Name -> [PendingRnSplice] -> ExpRhoType -> TcM (HsExpr TcId)
190 191 192 193 194
tcUntypedBracket brack ps res_ty
  = do { traceTc "tc_bracket untyped" (ppr brack $$ ppr ps)
       ; ps' <- mapM tcPendingSplice ps
       ; meta_ty <- tcBrackTy brack
       ; traceTc "tc_bracket done untyped" (ppr meta_ty)
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
195 196
       ; tcWrapResultO (Shouldn'tHappenOrigin "untyped bracket")
                       (HsTcBracketOut brack ps') meta_ty res_ty }
197 198 199 200 201 202 203 204 205 206 207 208 209 210 211

---------------
tcBrackTy :: HsBracket Name -> TcM TcType
tcBrackTy (VarBr _ _) = tcMetaTy nameTyConName  -- Result type is Var (not Q-monadic)
tcBrackTy (ExpBr _)   = tcMetaTy expQTyConName  -- Result type is ExpQ (= Q Exp)
tcBrackTy (TypBr _)   = tcMetaTy typeQTyConName -- Result type is Type (= Q Typ)
tcBrackTy (DecBrG _)  = tcMetaTy decsQTyConName -- Result type is Q [Dec]
tcBrackTy (PatBr _)   = tcMetaTy patQTyConName  -- Result type is PatQ (= Q Pat)
tcBrackTy (DecBrL _)  = panic "tcBrackTy: Unexpected DecBrL"
tcBrackTy (TExpBr _)  = panic "tcUntypedBracket: Unexpected TExpBr"

---------------
tcPendingSplice :: PendingRnSplice -> TcM PendingTcSplice
tcPendingSplice (PendingRnSplice flavour splice_name expr)
  = do { res_ty <- tcMetaTy meta_ty_name
212
       ; expr' <- tcMonoExpr expr (mkCheckExpType res_ty)
213 214 215 216 217 218 219 220 221
       ; return (PendingTcSplice splice_name expr') }
  where
     meta_ty_name = case flavour of
                       UntypedExpSplice  -> expQTyConName
                       UntypedPatSplice  -> patQTyConName
                       UntypedTypeSplice -> typeQTyConName
                       UntypedDeclSplice -> decsQTyConName

---------------
222
-- Takes a tau and returns the type Q (TExp tau)
223
tcTExpTy :: TcType -> TcM TcType
224 225 226
tcTExpTy exp_ty
  = do { unless (isTauTy exp_ty) $ addErr (err_msg exp_ty)
       ; q    <- tcLookupTyCon qTyConName
227
       ; texp <- tcLookupTyCon tExpTyConName
228 229 230 231 232 233
       ; return (mkTyConApp q [mkTyConApp texp [exp_ty]]) }
  where
    err_msg ty
      = vcat [ text "Illegal polytype:" <+> ppr ty
             , text "The type of a Typed Template Haskell expression must" <+>
               text "not have any quantification." ]
234 235 236

quotationCtxtDoc :: HsBracket Name -> SDoc
quotationCtxtDoc br_body
237
  = hang (text "In the Template Haskell quotation")
238 239
         2 (ppr br_body)

240 241

#ifndef GHCI
242
tcSpliceExpr  e _      = failTH e "Template Haskell splice"
243

244 245 246 247
-- runQuasiQuoteExpr q = failTH q "quasiquote"
-- runQuasiQuotePat  q = failTH q "pattern quasiquote"
-- runQuasiQuoteType q = failTH q "type quasiquote"
-- runQuasiQuoteDecl q = failTH q "declaration quasiquote"
248 249 250 251 252
runAnnotation   _ q = failTH q "annotation"

#else
  -- The whole of the rest of the file is the else-branch (ie stage2 only)

Austin Seipp's avatar
Austin Seipp committed
253
{-
254 255 256 257 258 259 260 261 262 263 264 265 266 267 268
Note [How top-level splices are handled]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Top-level splices (those not inside a [| .. |] quotation bracket) are handled
very straightforwardly:

  1. tcTopSpliceExpr: typecheck the body e of the splice $(e)

  2. runMetaT: desugar, compile, run it, and convert result back to
     HsSyn RdrName (of the appropriate flavour, eg HsType RdrName,
     HsExpr RdrName etc)

  3. treat the result as if that's what you saw in the first place
     e.g for HsType, rename and kind-check
         for HsExpr, rename and type-check

Gabor Greif's avatar
typos  
Gabor Greif committed
269
     (The last step is different for decls, because they can *only* be
270 271 272 273
      top-level: we return the result of step 2.)

Note [How brackets and nested splices are handled]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318
Nested splices (those inside a [| .. |] quotation bracket),
are treated quite differently.

Remember, there are two forms of bracket
         typed   [|| e ||]
   and untyped   [|  e  |]

The life cycle of a typed bracket:
   * Starts as HsBracket

   * When renaming:
        * Set the ThStage to (Brack s RnPendingTyped)
        * Rename the body
        * Result is still a HsBracket

   * When typechecking:
        * Set the ThStage to (Brack s (TcPending ps_var lie_var))
        * Typecheck the body, and throw away the elaborated result
        * Nested splices (which must be typed) are typechecked, and
          the results accumulated in ps_var; their constraints
          accumulate in lie_var
        * Result is a HsTcBracketOut rn_brack pending_splices
          where rn_brack is the incoming renamed bracket

The life cycle of a un-typed bracket:
   * Starts as HsBracket

   * When renaming:
        * Set the ThStage to (Brack s (RnPendingUntyped ps_var))
        * Rename the body
        * Nested splices (which must be untyped) are renamed, and the
          results accumulated in ps_var
        * Result is still (HsRnBracketOut rn_body pending_splices)

   * When typechecking a HsRnBracketOut
        * Typecheck the pending_splices individually
        * Ignore the body of the bracket; just check that the context
          expects a bracket of that type (e.g. a [p| pat |] bracket should
          be in a context needing a (Q Pat)
        * Result is a HsTcBracketOut rn_brack pending_splices
          where rn_brack is the incoming renamed bracket


In both cases, desugaring happens like this:
  * HsTcBracketOut is desugared by DsMeta.dsBracket.  It
319 320 321 322 323 324

      a) Extends the ds_meta environment with the PendingSplices
         attached to the bracket

      b) Converts the quoted (HsExpr Name) to a CoreExpr that, when
         run, will produce a suitable TH expression/type/decl.  This
325
         is why we leave the *renamed* expression attached to the bracket:
326 327 328 329 330 331 332 333 334 335 336 337
         the quoted expression should not be decorated with all the goop
         added by the type checker

  * Each splice carries a unique Name, called a "splice point", thus
    ${n}(e).  The name is initialised to an (Unqual "splice") when the
    splice is created; the renamer gives it a unique.

  * When DsMeta (used to desugar the body of the bracket) comes across
    a splice, it looks up the splice's Name, n, in the ds_meta envt,
    to find an (HsExpr Id) that should be substituted for the splice;
    it just desugars it to get a CoreExpr (DsMeta.repSplice).

338 339
Example:
    Source:       f = [| Just $(g 3) |]
340 341 342
      The [| |] part is a HsBracket

    Typechecked:  f = [| Just ${s7}(g 3) |]{s7 = g Int 3}
343 344 345 346
      The [| |] part is a HsBracketOut, containing *renamed*
        (not typechecked) expression
      The "s7" is the "splice point"; the (g Int 3) part
        is a typechecked expression
347

348 349
    Desugared:    f = do { s7 <- g Int 3
                         ; return (ConE "Data.Maybe.Just" s7) }
350 351 352 353 354


Note [Template Haskell state diagram]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Here are the ThStages, s, their corresponding level numbers
355
(the result of (thLevel s)), and their state transitions.
356
The top level of the program is stage Comp:
357

358 359 360
     Start here
         |
         V
361
      -----------     $      ------------   $
362
      |  Comp   | ---------> |  Splice  | -----|
363 364 365 366 367 368 369 370 371 372 373
      |   1     |            |    0     | <----|
      -----------            ------------
        ^     |                ^      |
      $ |     | [||]         $ |      | [||]
        |     v                |      v
   --------------          ----------------
   | Brack Comp |          | Brack Splice |
   |     2      |          |      1       |
   --------------          ----------------

* Normal top-level declarations start in state Comp
374 375 376 377
       (which has level 1).
  Annotations start in state Splice, since they are
       treated very like a splice (only without a '$')

378
* Code compiled in state Splice (and only such code)
379 380 381 382 383
  will be *run at compile time*, with the result replacing
  the splice

* The original paper used level -1 instead of 0, etc.

384 385
* The original paper did not allow a splice within a
  splice, but there is no reason not to. This is the
386 387
  $ transition in the top right.

388 389 390
Note [Template Haskell levels]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* Imported things are impLevel (= 0)
391

392 393 394
* However things at level 0 are not *necessarily* imported.
      eg  $( \b -> ... )   here b is bound at level 0

395 396 397
* In GHCi, variables bound by a previous command are treated
  as impLevel, because we have bytecode for them.

398
* Variables are bound at the "current level"
399

400
* The current level starts off at outerLevel (= 1)
401

402
* The level is decremented by splicing $(..)
403 404
               incremented by brackets [| |]
               incremented by name-quoting 'f
405

406 407 408
When a variable is used, we compare
        bind:  binding level, and
        use:   current level at usage site
409 410

  Generally
411 412
        bind > use      Always error (bound later than used)
                        [| \x -> $(f x) |]
413

414 415 416 417 418 419
        bind = use      Always OK (bound same stage as used)
                        [| \x -> $(f [| x |]) |]

        bind < use      Inside brackets, it depends
                        Inside splice, OK
                        Inside neither, OK
420 421

  For (bind < use) inside brackets, there are three cases:
422 423 424 425
    - Imported things   OK      f = [| map |]
    - Top-level things  OK      g = [| f |]
    - Non-top-level     Only if there is a liftable instance
                                h = \(x:Int) -> [| x |]
426

427
  To track top-level-ness we use the ThBindEnv in TcLclEnv
428

429 430 431 432
  For example:
           f = ...
           g1 = $(map ...)         is OK
           g2 = $(f ...)           is not OK; because we havn't compiled f yet
433

Austin Seipp's avatar
Austin Seipp committed
434
-}
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
435

Austin Seipp's avatar
Austin Seipp committed
436 437 438
{-
************************************************************************
*                                                                      *
439
\subsection{Splicing an expression}
Austin Seipp's avatar
Austin Seipp committed
440 441 442
*                                                                      *
************************************************************************
-}
443

444
tcSpliceExpr splice@(HsTypedSplice name expr) res_ty
445
  = addErrCtxt (spliceCtxtDoc splice) $
446
    setSrcSpan (getLoc expr)    $ do
447
    { stage <- getStage
gmainland's avatar
gmainland committed
448
    ; case stage of
449 450 451
        Splice {}            -> tcTopSplice expr res_ty
        Comp                 -> tcTopSplice expr res_ty
        Brack pop_stage pend -> tcNestedSplice pop_stage pend name expr res_ty }
452 453
tcSpliceExpr splice _
  = pprPanic "tcSpliceExpr" (ppr splice)
454 455

tcNestedSplice :: ThStage -> PendingStuff -> Name
456
                -> LHsExpr Name -> ExpRhoType -> TcM (HsExpr Id)
457 458
    -- See Note [How brackets and nested splices are handled]
    -- A splice inside brackets
459
tcNestedSplice pop_stage (TcPending ps_var lie_var) splice_name expr res_ty
460 461
  = do { res_ty <- expTypeToType res_ty
       ; meta_exp_ty <- tcTExpTy res_ty
462 463
       ; expr' <- setStage pop_stage $
                  setConstraintVar lie_var $
464
                  tcMonoExpr expr (mkCheckExpType meta_exp_ty)
465 466 467
       ; untypeq <- tcLookupId unTypeQName
       ; let expr'' = mkHsApp (nlHsTyApp untypeq [res_ty]) expr'
       ; ps <- readMutVar ps_var
468
       ; writeMutVar ps_var (PendingTcSplice splice_name expr'' : ps)
469 470 471 472 473 474

       -- The returned expression is ignored; it's in the pending splices
       ; return (panic "tcSpliceExpr") }

tcNestedSplice _ _ splice_name _ _
  = pprPanic "tcNestedSplice: rename stage found" (ppr splice_name)
475

476
tcTopSplice :: LHsExpr Name -> ExpRhoType -> TcM (HsExpr Id)
gmainland's avatar
gmainland committed
477
tcTopSplice expr res_ty
478 479
  = do { -- Typecheck the expression,
         -- making sure it has type Q (T res_ty)
480 481
         res_ty <- expTypeToType res_ty
       ; meta_exp_ty <- tcTExpTy res_ty
482
       ; zonked_q_expr <- tcTopSpliceExpr Typed $
483
                          tcMonoExpr expr (mkCheckExpType meta_exp_ty)
484

485
         -- Run the expression
486
       ; expr2 <- runMetaE zonked_q_expr
487 488 489 490
       ; traceSplice (SpliceInfo { spliceDescription = "expression"
                                 , spliceIsDecl      = False
                                 , spliceSource      = Just expr
                                 , spliceGenerated   = ppr expr2 })
491

492 493 494
         -- Rename and typecheck the spliced-in expression,
         -- making sure it has type res_ty
         -- These steps should never fail; this is a *typed* splice
495
       ; addErrCtxt (spliceResultDoc expr) $ do
496
       { (exp3, _fvs) <- rnLExpr expr2
497
       ; exp4 <- tcMonoExpr exp3 (mkCheckExpType res_ty)
498
       ; return (unLoc exp4) } }
gmainland's avatar
gmainland committed
499

Austin Seipp's avatar
Austin Seipp committed
500 501 502
{-
************************************************************************
*                                                                      *
gmainland's avatar
gmainland committed
503
\subsection{Error messages}
Austin Seipp's avatar
Austin Seipp committed
504 505 506
*                                                                      *
************************************************************************
-}
507

508 509
spliceCtxtDoc :: HsSplice Name -> SDoc
spliceCtxtDoc splice
510
  = hang (text "In the Template Haskell splice")
511
         2 (pprSplice splice)
512

513 514
spliceResultDoc :: LHsExpr Name -> SDoc
spliceResultDoc expr
515
  = sep [ text "In the result of the splice:"
516
        , nest 2 (char '$' <> pprParendLExpr expr)
517
        , text "To see what the splice expanded to, use -ddump-splices"]
518

519
-------------------
520
tcTopSpliceExpr :: SpliceType -> TcM (LHsExpr Id) -> TcM (LHsExpr Id)
521
-- Note [How top-level splices are handled]
522 523
-- Type check an expression that is the body of a top-level splice
--   (the caller will compile and run it)
524 525
-- Note that set the level to Splice, regardless of the original level,
-- before typechecking the expression.  For example:
526
--      f x = $( ...$(g 3) ... )
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
527
-- The recursive call to tcPolyExpr will simply expand the
528 529
-- inner escape before dealing with the outer one

530
tcTopSpliceExpr isTypedSplice tc_action
531 532
  = checkNoErrs $  -- checkNoErrs: must not try to run the thing
                   -- if the type checker fails!
ian@well-typed.com's avatar
ian@well-typed.com committed
533
    unsetGOptM Opt_DeferTypeErrors $
534 535 536 537 538
                   -- Don't defer type errors.  Not only are we
                   -- going to run this code, but we do an unsafe
                   -- coerce, so we get a seg-fault if, say we
                   -- splice a type into a place where an expression
                   -- is expected (Trac #7276)
539
    setStage (Splice isTypedSplice) $
540
    do {    -- Typecheck the expression
541 542
         (expr', wanted) <- captureConstraints tc_action
       ; const_binds     <- simplifyTop wanted
543

544
          -- Zonk it and tie the knot of dictionary bindings
545
       ; zonkTopLExpr (mkHsDictLet (EvBinds const_binds) expr') }
546

Austin Seipp's avatar
Austin Seipp committed
547 548 549
{-
************************************************************************
*                                                                      *
550
        Annotations
Austin Seipp's avatar
Austin Seipp committed
551 552 553
*                                                                      *
************************************************************************
-}
554

555 556
runAnnotation target expr = do
    -- Find the classes we want instances for in order to call toAnnotationWrapper
557
    loc <- getSrcSpanM
558
    data_class <- tcLookupClass dataClassName
559
    to_annotation_wrapper_id <- tcLookupId toAnnotationWrapperName
560

561 562 563
    -- Check the instances we require live in another module (we want to execute it..)
    -- and check identifiers live in other modules using TH stage checks. tcSimplifyStagedExpr
    -- also resolves the LIE constraints to detect e.g. instance ambiguity
564
    zonked_wrapped_expr' <- tcTopSpliceExpr Untyped $
565
           do { (expr', expr_ty) <- tcInferRhoNC expr
566 567 568
                -- We manually wrap the typechecked expression in a call to toAnnotationWrapper
                -- By instantiating the call >here< it gets registered in the
                -- LIE consulted by tcTopSpliceExpr
569
                -- and hence ensures the appropriate dictionary is bound by const_binds
570
              ; wrapper <- instCall AnnOrigin [expr_ty] [mkClassPred data_class [expr_ty]]
571
              ; let specialised_to_annotation_wrapper_expr
572 573
                      = L loc (HsWrap wrapper
                                      (HsVar (L loc to_annotation_wrapper_id)))
574
              ; return (L loc (HsApp specialised_to_annotation_wrapper_expr expr')) }
575 576 577 578 579

    -- Run the appropriately wrapped expression to get the value of
    -- the annotation and its dictionaries. The return value is of
    -- type AnnotationWrapper by construction, so this conversion is
    -- safe
Luite Stegeman's avatar
Luite Stegeman committed
580 581 582 583 584 585
    serialized <- runMetaAW zonked_wrapped_expr'
    return Annotation {
               ann_target = target,
               ann_value = serialized
           }

586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607
convertAnnotationWrapper :: ForeignHValue -> TcM (Either MsgDoc Serialized)
convertAnnotationWrapper fhv = do
  dflags <- getDynFlags
  if gopt Opt_ExternalInterpreter dflags
    then do
      Right <$> runTH THAnnWrapper fhv
    else do
      annotation_wrapper <- liftIO $ wormhole dflags fhv
      return $ Right $
        case unsafeCoerce# annotation_wrapper of
           AnnotationWrapper value | let serialized = toSerialized serializeWithData value ->
               -- Got the value and dictionaries: build the serialized value and
               -- call it a day. We ensure that we seq the entire serialized value
               -- in order that any errors in the user-written code for the
               -- annotation are exposed at this point.  This is also why we are
               -- doing all this stuff inside the context of runMeta: it has the
               -- facilities to deal with user error in a meta-level expression
               seqSerialized serialized `seq` serialized

-- | Force the contents of the Serialized value so weknow it doesn't contain any bottoms
seqSerialized :: Serialized -> ()
seqSerialized (Serialized the_type bytes) = the_type `seq` bytes `seqList` ()
608

609

Austin Seipp's avatar
Austin Seipp committed
610 611 612
{-
************************************************************************
*                                                                      *
613
\subsection{Running an expression}
Austin Seipp's avatar
Austin Seipp committed
614 615 616
*                                                                      *
************************************************************************
-}
617

618 619 620
runQuasi :: TH.Q a -> TcM a
runQuasi act = TH.runQ act

621 622 623 624 625 626 627 628 629
runQResult
  :: (a -> String)
  -> (SrcSpan -> a -> b)
  -> (ForeignHValue -> TcM a)
  -> SrcSpan
  -> ForeignHValue {- TH.Q a -}
  -> TcM b
runQResult show_th f runQ expr_span hval
  = do { th_result <- runQ hval
Luite Stegeman's avatar
Luite Stegeman committed
630 631
       ; traceTc "Got TH result:" (text (show_th th_result))
       ; return (f expr_span th_result) }
632

633

Luite Stegeman's avatar
Luite Stegeman committed
634 635 636 637 638 639 640 641 642 643
-----------------
runMeta :: (MetaHook TcM -> LHsExpr Id -> TcM hs_syn)
        -> LHsExpr Id
        -> TcM hs_syn
runMeta unwrap e
  = do { h <- getHooked runMetaHook defaultRunMeta
       ; unwrap h e }

defaultRunMeta :: MetaHook TcM
defaultRunMeta (MetaE r)
644
  = fmap r . runMeta' True ppr (runQResult TH.pprint convertToHsExpr runTHExp)
Luite Stegeman's avatar
Luite Stegeman committed
645
defaultRunMeta (MetaP r)
646
  = fmap r . runMeta' True ppr (runQResult TH.pprint convertToPat runTHPat)
Luite Stegeman's avatar
Luite Stegeman committed
647
defaultRunMeta (MetaT r)
648
  = fmap r . runMeta' True ppr (runQResult TH.pprint convertToHsType runTHType)
Luite Stegeman's avatar
Luite Stegeman committed
649
defaultRunMeta (MetaD r)
650
  = fmap r . runMeta' True ppr (runQResult TH.pprint convertToHsDecls runTHDec)
Luite Stegeman's avatar
Luite Stegeman committed
651
defaultRunMeta (MetaAW r)
652
  = fmap r . runMeta' False (const empty) (const convertAnnotationWrapper)
653 654 655
    -- We turn off showing the code in meta-level exceptions because doing so exposes
    -- the toAnnotationWrapper function that we slap around the users code

Luite Stegeman's avatar
Luite Stegeman committed
656 657 658 659
----------------
runMetaAW :: LHsExpr Id         -- Of type AnnotationWrapper
          -> TcM Serialized
runMetaAW = runMeta metaRequestAW
660

661 662
runMetaE :: LHsExpr Id          -- Of type (Q Exp)
         -> TcM (LHsExpr RdrName)
Luite Stegeman's avatar
Luite Stegeman committed
663
runMetaE = runMeta metaRequestE
664

gmainland's avatar
gmainland committed
665 666
runMetaP :: LHsExpr Id          -- Of type (Q Pat)
         -> TcM (LPat RdrName)
Luite Stegeman's avatar
Luite Stegeman committed
667
runMetaP = runMeta metaRequestP
gmainland's avatar
gmainland committed
668

669 670
runMetaT :: LHsExpr Id          -- Of type (Q Type)
         -> TcM (LHsType RdrName)
Luite Stegeman's avatar
Luite Stegeman committed
671
runMetaT = runMeta metaRequestT
672

673 674
runMetaD :: LHsExpr Id          -- Of type Q [Dec]
         -> TcM [LHsDecl RdrName]
Luite Stegeman's avatar
Luite Stegeman committed
675
runMetaD = runMeta metaRequestD
676 677

---------------
Luite Stegeman's avatar
Luite Stegeman committed
678 679
runMeta' :: Bool                 -- Whether code should be printed in the exception message
         -> (hs_syn -> SDoc)                                    -- how to print the code
680
         -> (SrcSpan -> ForeignHValue -> TcM (Either MsgDoc hs_syn))        -- How to run x
Luite Stegeman's avatar
Luite Stegeman committed
681 682 683
         -> LHsExpr Id           -- Of type x; typically x = Q TH.Exp, or something like that
         -> TcM hs_syn           -- Of type t
runMeta' show_code ppr_hs run_and_convert expr
684
  = do  { traceTc "About to run" (ppr expr)
685 686
        ; recordThSpliceUse -- seems to be the best place to do this,
                            -- we catch all kinds of splices and annotations.
687

688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703
        -- Check that we've had no errors of any sort so far.
        -- For example, if we found an error in an earlier defn f, but
        -- recovered giving it type f :: forall a.a, it'd be very dodgy
        -- to carry ont.  Mind you, the staging restrictions mean we won't
        -- actually run f, but it still seems wrong. And, more concretely,
        -- see Trac #5358 for an example that fell over when trying to
        -- reify a function with a "?" kind in it.  (These don't occur
        -- in type-correct programs.
        ; failIfErrsM

        -- Desugar
        ; ds_expr <- initDsTc (dsLExpr expr)
        -- Compile and link it; might fail if linking fails
        ; hsc_env <- getTopEnv
        ; src_span <- getSrcSpanM
        ; traceTc "About to run (desugared)" (ppr ds_expr)
Simon Peyton Jones's avatar
Simon Peyton Jones committed
704
        ; either_hval <- tryM $ liftIO $
705 706
                         HscMain.hscCompileCoreExpr hsc_env src_span ds_expr
        ; case either_hval of {
707
            Left exn   -> fail_with_exn "compile and link" exn ;
708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724
            Right hval -> do

        {       -- Coerce it to Q t, and run it

                -- Running might fail if it throws an exception of any kind (hence tryAllM)
                -- including, say, a pattern-match exception in the code we are running
                --
                -- We also do the TH -> HS syntax conversion inside the same
                -- exception-cacthing thing so that if there are any lurking
                -- exceptions in the data structure returned by hval, we'll
                -- encounter them inside the try
                --
                -- See Note [Exceptions in TH]
          let expr_span = getLoc expr
        ; either_tval <- tryAllM $
                         setSrcSpan expr_span $ -- Set the span so that qLocation can
                                                -- see where this splice is
725
             do { mb_result <- run_and_convert expr_span hval
726 727
                ; case mb_result of
                    Left err     -> failWithTc err
Luite Stegeman's avatar
Luite Stegeman committed
728
                    Right result -> do { traceTc "Got HsSyn result:" (ppr_hs result)
729
                                       ; return $! result } }
730

731 732 733 734
        ; case either_tval of
            Right v -> return v
            Left se -> case fromException se of
                         Just IOEnvFailure -> failM -- Error already in Tc monad
735
                         _ -> fail_with_exn "run" se -- Exception
736
        }}}
737
  where
738
    -- see Note [Concealed TH exceptions]
739
    fail_with_exn :: Exception e => String -> e -> TcM a
740 741 742 743
    fail_with_exn phase exn = do
        exn_msg <- liftIO $ Panic.safeShowException exn
        let msg = vcat [text "Exception when trying to" <+> text phase <+> text "compile-time code:",
                        nest 2 (text exn_msg),
Simon Peyton Jones's avatar
Simon Peyton Jones committed
744
                        if show_code then text "Code:" <+> ppr expr else empty]
745
        failWithTc msg
746

Austin Seipp's avatar
Austin Seipp committed
747
{-
748 749
Note [Exceptions in TH]
~~~~~~~~~~~~~~~~~~~~~~~
Gabor Greif's avatar
Gabor Greif committed
750
Suppose we have something like this
751
        $( f 4 )
752
where
753 754 755
        f :: Int -> Q [Dec]
        f n | n>3       = fail "Too many declarations"
            | otherwise = ...
756 757 758 759 760 761

The 'fail' is a user-generated failure, and should be displayed as a
perfectly ordinary compiler error message, not a panic or anything
like that.  Here's how it's processed:

  * 'fail' is the monad fail.  The monad instance for Q in TH.Syntax
762 763
    effectively transforms (fail s) to
        qReport True s >> fail
764 765 766 767 768
    where 'qReport' comes from the Quasi class and fail from its monad
    superclass.

  * The TcM monad is an instance of Quasi (see TcSplice), and it implements
    (qReport True s) by using addErr to add an error message to the bag of errors.
769
    The 'fail' in TcM raises an IOEnvFailure exception
770

771 772 773 774 775 776
 * 'qReport' forces the message to ensure any exception hidden in unevaluated
   thunk doesn't get into the bag of errors. Otherwise the following splice
   will triger panic (Trac #8987):
        $(fail undefined)
   See also Note [Concealed TH exceptions]

777 778 779 780
  * So, when running a splice, we catch all exceptions; then for
        - an IOEnvFailure exception, we assume the error is already
                in the error-bag (above)
        - other errors, we add an error to the bag
781 782
    and then fail

783 784 785 786 787 788 789 790 791 792 793 794 795 796 797
Note [Concealed TH exceptions]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
When displaying the error message contained in an exception originated from TH
code, we need to make sure that the error message itself does not contain an
exception.  For example, when executing the following splice:

    $( error ("foo " ++ error "bar") )

the message for the outer exception is a thunk which will throw the inner
exception when evaluated.

For this reason, we display the message of a TH exception using the
'safeShowException' function, which recursively catches any exception thrown
when showing an error message.

798

799
To call runQ in the Tc monad, we need to make TcM an instance of Quasi:
Austin Seipp's avatar
Austin Seipp committed
800
-}
801

802
instance TH.Quasi TcM where
803 804 805
  qNewName s = do { u <- newUnique
                  ; let i = getKey u
                  ; return (TH.mkNameU s i) }
806

807 808 809
  -- 'msg' is forced to ensure exceptions don't escape,
  -- see Note [Exceptions in TH]
  qReport True msg  = seqList msg $ addErr  (text msg)
810
  qReport False msg = seqList msg $ addWarn NoReason (text msg)
811

812
  qLocation = do { m <- getModule
Ian Lynagh's avatar
Ian Lynagh committed
813 814 815 816 817 818 819
                 ; l <- getSrcSpanM
                 ; r <- case l of
                        UnhelpfulSpan _ -> pprPanic "qLocation: Unhelpful location"
                                                    (ppr l)
                        RealSrcSpan s -> return s
                 ; return (TH.Loc { TH.loc_filename = unpackFS (srcSpanFile r)
                                  , TH.loc_module   = moduleNameString (moduleName m)
820
                                  , TH.loc_package  = unitIdString (moduleUnitId m)
Ian Lynagh's avatar
Ian Lynagh committed
821 822 823
                                  , TH.loc_start = (srcSpanStartLine r, srcSpanStartCol r)
                                  , TH.loc_end = (srcSpanEndLine   r, srcSpanEndCol   r) }) }

824 825
  qLookupName       = lookupName
  qReify            = reify
Ryan Scott's avatar
Ryan Scott committed
826
  qReifyFixity nm   = lookupThName nm >>= reifyFixity
827 828 829
  qReifyInstances   = reifyInstances
  qReifyRoles       = reifyRoles
  qReifyAnnotations = reifyAnnotations
830
  qReifyModule      = reifyModule
831 832 833 834
  qReifyConStrictness nm = do { nm' <- lookupThName nm
                              ; dc  <- tcLookupDataCon nm'
                              ; let bangs = dataConImplBangs dc
                              ; return (map reifyDecidedStrictness bangs) }
835

836 837 838
        -- For qRecover, discard error messages if
        -- the recovery action is chosen.  Otherwise
        -- we'll only fail higher up.  c.f. tryTcLIE_
839
  qRecover recover main = do { (msgs, mb_res) <- tryTcErrs main
840 841 842 843 844
                             ; case mb_res of
                                 Just val -> do { addMessages msgs      -- There might be warnings
                                                ; return val }
                                 Nothing  -> recover                    -- Discard all msgs
                          }
845

twanvl's avatar
twanvl committed
846
  qRunIO io = liftIO io
GregWeber's avatar
GregWeber committed
847 848 849 850 851

  qAddDependentFile fp = do
    ref <- fmap tcg_dependent_files getGblEnv
    dep_files <- readTcRef ref
    writeTcRef ref (fp:dep_files)
852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867

  qAddTopDecls thds = do
      l <- getSrcSpanM
      let either_hval = convertToHsDecls l thds
      ds <- case either_hval of
              Left exn -> pprPanic "qAddTopDecls: can't convert top-level declarations" exn
              Right ds -> return ds
      mapM_ (checkTopDecl . unLoc) ds
      th_topdecls_var <- fmap tcg_th_topdecls getGblEnv
      updTcRef th_topdecls_var (\topds -> ds ++ topds)
    where
      checkTopDecl :: HsDecl RdrName -> TcM ()
      checkTopDecl (ValD binds)
        = mapM_ bindName (collectHsBindBinders binds)
      checkTopDecl (SigD _)
        = return ()
868 869
      checkTopDecl (AnnD _)
        = return ()
870
      checkTopDecl (ForD (ForeignImport { fd_name = L _ name }))
871 872
        = bindName name
      checkTopDecl _
873
        = addErr $ text "Only function, value, annotation, and foreign import declarations may be added with addTopDecl"
874

875 876 877
      bindName :: RdrName -> TcM ()
      bindName (Exact n)
        = do { th_topnames_var <- fmap tcg_th_topnames getGblEnv
878
             ; updTcRef th_topnames_var (\ns -> extendNameSet ns n)
879 880 881 882
             }

      bindName name =
          addErr $
883
          hang (text "The binder" <+> quotes (ppr name) <+> ptext (sLit "is not a NameU."))
884
             2 (text "Probable cause: you used mkName instead of newName to generate a binding.")
885 886 887 888

  qAddModFinalizer fin = do
      th_modfinalizers_var <- fmap tcg_th_modfinalizers getGblEnv
      updTcRef th_modfinalizers_var (\fins -> fin:fins)
889

890
  qGetQ :: forall a. Typeable a => TcM (Maybe a)
891 892 893
  qGetQ = do
      th_state_var <- fmap tcg_th_state getGblEnv
      th_state <- readTcRef th_state_var
894
      -- See #10596 for why we use a scoped type variable here.
895
      return (Map.lookup (typeRep (Proxy :: Proxy a)) th_state >>= fromDynamic)
896 897 898 899

  qPutQ x = do
      th_state_var <- fmap tcg_th_state getGblEnv
      updTcRef th_state_var (\m -> Map.insert (typeOf x) (toDyn x) m)
900

901 902 903 904 905
  qIsExtEnabled = xoptM

  qExtsEnabled = do
    dflags <- hsc_dflags <$> getTopEnv
    return $ map toEnum $ IntSet.elems $ extensionFlags dflags
906

907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925

-- | Run all module finalizers
finishTH :: TcM ()
finishTH = do
  hsc_env <- env_top <$> getEnv
  dflags <- getDynFlags
  if not (gopt Opt_ExternalInterpreter dflags)
    then do
      tcg <- getGblEnv
      let th_modfinalizers_var = tcg_th_modfinalizers tcg
      modfinalizers <- readTcRef th_modfinalizers_var
      writeTcRef th_modfinalizers_var []
      mapM_ runQuasi modfinalizers
    else withIServ hsc_env $ \i -> do
      tcg <- getGblEnv
      th_state <- readTcRef (tcg_th_remote_state tcg)
      case th_state of
        Nothing -> return () -- TH was not started, nothing to do
        Just fhv -> do
926
          liftIO $ withForeignRef fhv $ \rhv ->
927
            writeIServ i (putMessage (FinishTH rhv))
928
          () <- runRemoteTH i []
929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958
          writeTcRef (tcg_th_remote_state tcg) Nothing

runTHExp :: ForeignHValue -> TcM TH.Exp
runTHExp = runTH THExp

runTHPat :: ForeignHValue -> TcM TH.Pat
runTHPat = runTH THPat

runTHType :: ForeignHValue -> TcM TH.Type
runTHType = runTH THType

runTHDec :: ForeignHValue -> TcM [TH.Dec]
runTHDec = runTH THDec

runTH :: Binary a => THResultType -> ForeignHValue -> TcM a
runTH ty fhv = do
  hsc_env <- env_top <$> getEnv
  dflags <- getDynFlags
  if not (gopt Opt_ExternalInterpreter dflags)
    then do
       -- just run it in the local TcM
      hv <- liftIO $ wormhole dflags fhv
      r <- runQuasi (unsafeCoerce# hv :: TH.Q a)
      return r
    else
      -- run it on the server
      withIServ hsc_env $ \i -> do
        rstate <- getTHState i
        loc <- TH.qLocation
        liftIO $
959 960
          withForeignRef rstate $ \state_hv ->
          withForeignRef fhv $ \q_hv ->
961
            writeIServ i (putMessage (RunTH state_hv q_hv ty (Just loc)))
962
        bs <- runRemoteTH i []
963 964 965 966
        return $! runGet get (LB.fromStrict bs)

-- | communicate with a remotely-running TH computation until it
-- finishes and returns a result.
967 968 969 970 971 972
runRemoteTH
  :: Binary a
  => IServ
  -> [Messages]   --  saved from nested calls to qRecover
  -> TcM a
runRemoteTH iserv recovers = do
973 974 975 976 977
  Msg msg <- liftIO $ readIServ iserv getMessage
  case msg of
    QDone -> liftIO $ readIServ iserv get
    QException str -> liftIO $ throwIO (ErrorCall str)
    QFail str -> fail str
978 979 980 981 982 983 984 985 986 987 988 989 990 991
    StartRecover -> do -- Note [TH recover with -fexternal-interpreter]
      v <- getErrsVar
      msgs <- readTcRef v
      writeTcRef v emptyMessages
      runRemoteTH iserv (msgs : recovers)
    EndRecover caught_error -> do
      v <- getErrsVar
      let (prev_msgs, rest) = case recovers of
             [] -> panic "EndRecover"
             a : b -> (a,b)
      if caught_error
        then writeTcRef v prev_msgs
        else updTcRef v (unionMessages prev_msgs)
      runRemoteTH iserv rest
992 993 994
    _other -> do
      r <- handleTHMessage msg
      liftIO $ writeIServ iserv (put r)
995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023
      runRemoteTH iserv recovers

{- Note [TH recover with -fexternal-interpreter]

Recover is slightly tricky to implement.

The meaning of "recover a b" is
 - Do a
   - If it finished successfully, then keep the messages it generated
   - If it failed, discard any messages it generated, and do b

The messages are managed by GHC in the TcM monad, whereas the
exception-handling is done in the ghc-iserv process, so we have to
coordinate between the two.

On the server:
  - emit a StartRecover message
  - run "a" inside a catch
    - if it finishes, emit EndRecover False
    - if it fails, emit EndRecover True, then run "b"

Back in GHC, when we receive:

  StartRecover
    save the current messages and start with an empty set.
  EndRecover caught_error
    Restore the previous messages,
    and merge in the new messages if caught_error is false.
-}
1024

1025
getTHState :: IServ -> TcM (ForeignRef (IORef QState))
1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071
getTHState i = do
  tcg <- getGblEnv
  th_state <- readTcRef (tcg_th_remote_state tcg)
  case th_state of
    Just rhv -> return rhv
    Nothing -> do
      hsc_env <- env_top <$> getEnv
      fhv <- liftIO $ mkFinalizedHValue hsc_env =<< iservCall i StartTH
      writeTcRef (tcg_th_remote_state tcg) (Just fhv)
      return fhv

wrapTHResult :: TcM a -> TcM (THResult a)
wrapTHResult tcm = do
  e <- tryM tcm   -- only catch 'fail', treat everything else as catastrophic
  case e of
    Left e -> return (THException (show e))
    Right a -> return (THComplete a)

handleTHMessage :: Message a -> TcM a
handleTHMessage msg = case msg of
  NewName a -> wrapTHResult $ TH.qNewName a
  Report b str -> wrapTHResult $ TH.qReport b str
  LookupName b str -> wrapTHResult $ TH.qLookupName b str