TcSplice.hs 76.4 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
48
import Outputable
import TcExpr
import SrcLoc
import FastString
49
import THNames
50
51
52
import TcUnify
import TcEnv

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

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

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

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

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

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

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

runAnnotation     :: CoreAnnTarget -> LHsExpr Name -> TcM Annotation
152
153
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
{-
************************************************************************
*                                                                      *
\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
180
181
182
183
       ; tcWrapResultO (Shouldn'tHappenOrigin "TExpBr")
                       (unLoc (mkHsApp (nlHsTyApp texpco [expr_ty])
                                              (noLoc (HsTcBracketOut brack ps'))))
                       meta_ty res_ty }
184
185
186
187
188
189
190
191
192
tcTypedBracket other_brack _
  = pprPanic "tcTypedBracket" (ppr other_brack)

-- tcUntypedBracket :: HsBracket Name -> [PendingRnSplice] -> TcRhoType -> TcM (HsExpr TcId)
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
193
194
       ; tcWrapResultO (Shouldn'tHappenOrigin "untyped bracket")
                       (HsTcBracketOut brack ps') meta_ty res_ty }
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231

---------------
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
       ; expr' <- tcMonoExpr expr res_ty
       ; return (PendingTcSplice splice_name expr') }
  where
     meta_ty_name = case flavour of
                       UntypedExpSplice  -> expQTyConName
                       UntypedPatSplice  -> patQTyConName
                       UntypedTypeSplice -> typeQTyConName
                       UntypedDeclSplice -> decsQTyConName

---------------
-- Takes a type tau and returns the type Q (TExp tau)
tcTExpTy :: TcType -> TcM TcType
tcTExpTy tau
  = do { q    <- tcLookupTyCon qTyConName
       ; texp <- tcLookupTyCon tExpTyConName
       ; return (mkTyConApp q [mkTyConApp texp [tau]]) }

quotationCtxtDoc :: HsBracket Name -> SDoc
quotationCtxtDoc br_body
  = hang (ptext (sLit "In the Template Haskell quotation"))
         2 (ppr br_body)

232
233

#ifndef GHCI
234
tcSpliceExpr  e _      = failTH e "Template Haskell splice"
235

236
237
238
239
-- runQuasiQuoteExpr q = failTH q "quasiquote"
-- runQuasiQuotePat  q = failTH q "pattern quasiquote"
-- runQuasiQuoteType q = failTH q "type quasiquote"
-- runQuasiQuoteDecl q = failTH q "declaration quasiquote"
240
241
242
243
244
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
245
{-
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
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
261
     (The last step is different for decls, because they can *only* be
262
263
264
265
      top-level: we return the result of step 2.)

Note [How brackets and nested splices are handled]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
266
267
268
269
270
271
272
273
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
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
311
312
313
314
315
316

      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
317
         is why we leave the *renamed* expression attached to the bracket:
318
319
320
321
322
323
324
325
326
327
328
329
         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).

330
331
Example:
    Source:       f = [| Just $(g 3) |]
332
333
334
      The [| |] part is a HsBracket

    Typechecked:  f = [| Just ${s7}(g 3) |]{s7 = g Int 3}
335
336
337
338
      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
339

340
341
    Desugared:    f = do { s7 <- g Int 3
                         ; return (ConE "Data.Maybe.Just" s7) }
342
343
344
345
346


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

350
351
352
     Start here
         |
         V
353
      -----------     $      ------------   $
354
      |  Comp   | ---------> |  Splice  | -----|
355
356
357
358
359
360
361
362
363
364
365
      |   1     |            |    0     | <----|
      -----------            ------------
        ^     |                ^      |
      $ |     | [||]         $ |      | [||]
        |     v                |      v
   --------------          ----------------
   | Brack Comp |          | Brack Splice |
   |     2      |          |      1       |
   --------------          ----------------

* Normal top-level declarations start in state Comp
366
367
368
369
       (which has level 1).
  Annotations start in state Splice, since they are
       treated very like a splice (only without a '$')

370
* Code compiled in state Splice (and only such code)
371
372
373
374
375
  will be *run at compile time*, with the result replacing
  the splice

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

376
377
* The original paper did not allow a splice within a
  splice, but there is no reason not to. This is the
378
379
  $ transition in the top right.

380
381
382
Note [Template Haskell levels]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* Imported things are impLevel (= 0)
383

384
385
386
* However things at level 0 are not *necessarily* imported.
      eg  $( \b -> ... )   here b is bound at level 0

387
388
389
* In GHCi, variables bound by a previous command are treated
  as impLevel, because we have bytecode for them.

390
* Variables are bound at the "current level"
391

392
* The current level starts off at outerLevel (= 1)
393

394
* The level is decremented by splicing $(..)
395
396
               incremented by brackets [| |]
               incremented by name-quoting 'f
397

398
399
400
When a variable is used, we compare
        bind:  binding level, and
        use:   current level at usage site
401
402

  Generally
403
404
        bind > use      Always error (bound later than used)
                        [| \x -> $(f x) |]
405

406
407
408
409
410
411
        bind = use      Always OK (bound same stage as used)
                        [| \x -> $(f [| x |]) |]

        bind < use      Inside brackets, it depends
                        Inside splice, OK
                        Inside neither, OK
412
413

  For (bind < use) inside brackets, there are three cases:
414
415
416
417
    - 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 |]
418

419
  To track top-level-ness we use the ThBindEnv in TcLclEnv
420

421
422
423
424
  For example:
           f = ...
           g1 = $(map ...)         is OK
           g2 = $(f ...)           is not OK; because we havn't compiled f yet
425

Austin Seipp's avatar
Austin Seipp committed
426
-}
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
427

Austin Seipp's avatar
Austin Seipp committed
428
429
430
{-
************************************************************************
*                                                                      *
431
\subsection{Splicing an expression}
Austin Seipp's avatar
Austin Seipp committed
432
433
434
*                                                                      *
************************************************************************
-}
435

436
tcSpliceExpr splice@(HsTypedSplice name expr) res_ty
437
  = addErrCtxt (spliceCtxtDoc splice) $
438
    setSrcSpan (getLoc expr)    $ do
439
    { stage <- getStage
gmainland's avatar
gmainland committed
440
    ; case stage of
441
442
443
        Splice {}            -> tcTopSplice expr res_ty
        Comp                 -> tcTopSplice expr res_ty
        Brack pop_stage pend -> tcNestedSplice pop_stage pend name expr res_ty }
444
445
tcSpliceExpr splice _
  = pprPanic "tcSpliceExpr" (ppr splice)
446
447
448

tcNestedSplice :: ThStage -> PendingStuff -> Name
                -> LHsExpr Name -> TcRhoType -> TcM (HsExpr Id)
449
450
    -- See Note [How brackets and nested splices are handled]
    -- A splice inside brackets
451
452
453
454
455
456
457
458
tcNestedSplice pop_stage (TcPending ps_var lie_var) splice_name expr res_ty
  = do { meta_exp_ty <- tcTExpTy res_ty
       ; expr' <- setStage pop_stage $
                  setConstraintVar lie_var $
                  tcMonoExpr expr meta_exp_ty
       ; untypeq <- tcLookupId unTypeQName
       ; let expr'' = mkHsApp (nlHsTyApp untypeq [res_ty]) expr'
       ; ps <- readMutVar ps_var
459
       ; writeMutVar ps_var (PendingTcSplice splice_name expr'' : ps)
460
461
462
463
464
465

       -- 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)
466

gmainland's avatar
gmainland committed
467
468
tcTopSplice :: LHsExpr Name -> TcRhoType -> TcM (HsExpr Id)
tcTopSplice expr res_ty
469
470
471
  = do { -- Typecheck the expression,
         -- making sure it has type Q (T res_ty)
         meta_exp_ty <- tcTExpTy res_ty
472
       ; zonked_q_expr <- tcTopSpliceExpr Typed $
gmainland's avatar
gmainland committed
473
                          tcMonoExpr expr meta_exp_ty
474

475
         -- Run the expression
476
       ; expr2 <- runMetaE zonked_q_expr
477
478
479
480
       ; traceSplice (SpliceInfo { spliceDescription = "expression"
                                 , spliceIsDecl      = False
                                 , spliceSource      = Just expr
                                 , spliceGenerated   = ppr expr2 })
481

482
483
484
         -- Rename and typecheck the spliced-in expression,
         -- making sure it has type res_ty
         -- These steps should never fail; this is a *typed* splice
485
       ; addErrCtxt (spliceResultDoc expr) $ do
486
       { (exp3, _fvs) <- rnLExpr expr2
487
       ; exp4 <- tcMonoExpr exp3 res_ty
488
       ; return (unLoc exp4) } }
gmainland's avatar
gmainland committed
489

Austin Seipp's avatar
Austin Seipp committed
490
491
492
{-
************************************************************************
*                                                                      *
gmainland's avatar
gmainland committed
493
\subsection{Error messages}
Austin Seipp's avatar
Austin Seipp committed
494
495
496
*                                                                      *
************************************************************************
-}
497

498
499
500
spliceCtxtDoc :: HsSplice Name -> SDoc
spliceCtxtDoc splice
  = hang (ptext (sLit "In the Template Haskell splice"))
501
         2 (pprSplice splice)
502

503
504
505
506
507
spliceResultDoc :: LHsExpr Name -> SDoc
spliceResultDoc expr
  = sep [ ptext (sLit "In the result of the splice:")
        , nest 2 (char '$' <> pprParendExpr expr)
        , ptext (sLit "To see what the splice expanded to, use -ddump-splices")]
508

509
-------------------
510
tcTopSpliceExpr :: SpliceType -> TcM (LHsExpr Id) -> TcM (LHsExpr Id)
511
-- Note [How top-level splices are handled]
512
513
-- Type check an expression that is the body of a top-level splice
--   (the caller will compile and run it)
514
515
-- Note that set the level to Splice, regardless of the original level,
-- before typechecking the expression.  For example:
516
--      f x = $( ...$(g 3) ... )
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
517
-- The recursive call to tcPolyExpr will simply expand the
518
519
-- inner escape before dealing with the outer one

520
tcTopSpliceExpr isTypedSplice tc_action
521
522
  = 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
523
    unsetGOptM Opt_DeferTypeErrors $
524
525
526
527
528
                   -- 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)
529
    setStage (Splice isTypedSplice) $
530
    do {    -- Typecheck the expression
531
532
         (expr', wanted) <- captureConstraints tc_action
       ; const_binds     <- simplifyTop wanted
533

534
          -- Zonk it and tie the knot of dictionary bindings
535
       ; zonkTopLExpr (mkHsDictLet (EvBinds const_binds) expr') }
536

Austin Seipp's avatar
Austin Seipp committed
537
538
539
{-
************************************************************************
*                                                                      *
540
        Annotations
Austin Seipp's avatar
Austin Seipp committed
541
542
543
*                                                                      *
************************************************************************
-}
544

545
546
runAnnotation target expr = do
    -- Find the classes we want instances for in order to call toAnnotationWrapper
547
    loc <- getSrcSpanM
548
    data_class <- tcLookupClass dataClassName
549
    to_annotation_wrapper_id <- tcLookupId toAnnotationWrapperName
550

551
552
553
    -- 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
554
    zonked_wrapped_expr' <- tcTopSpliceExpr Untyped $
555
           do { (expr', expr_ty) <- tcInferRhoNC expr
556
557
558
                -- 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
559
                -- and hence ensures the appropriate dictionary is bound by const_binds
560
              ; wrapper <- instCall AnnOrigin [expr_ty] [mkClassPred data_class [expr_ty]]
561
              ; let specialised_to_annotation_wrapper_expr
562
563
                      = L loc (HsWrap wrapper
                                      (HsVar (L loc to_annotation_wrapper_id)))
564
              ; return (L loc (HsApp specialised_to_annotation_wrapper_expr expr')) }
565
566
567
568
569

    -- 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
570
571
572
573
574
575
    serialized <- runMetaAW zonked_wrapped_expr'
    return Annotation {
               ann_target = target,
               ann_value = serialized
           }

576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
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` ()
598

599

Austin Seipp's avatar
Austin Seipp committed
600
601
602
{-
************************************************************************
*                                                                      *
603
\subsection{Running an expression}
Austin Seipp's avatar
Austin Seipp committed
604
605
606
*                                                                      *
************************************************************************
-}
607

608
609
610
runQuasi :: TH.Q a -> TcM a
runQuasi act = TH.runQ act

611
612
613
614
615
616
617
618
619
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
620
621
       ; traceTc "Got TH result:" (text (show_th th_result))
       ; return (f expr_span th_result) }
622

623

Luite Stegeman's avatar
Luite Stegeman committed
624
625
626
627
628
629
630
631
632
633
-----------------
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)
634
  = fmap r . runMeta' True ppr (runQResult TH.pprint convertToHsExpr runTHExp)
Luite Stegeman's avatar
Luite Stegeman committed
635
defaultRunMeta (MetaP r)
636
  = fmap r . runMeta' True ppr (runQResult TH.pprint convertToPat runTHPat)
Luite Stegeman's avatar
Luite Stegeman committed
637
defaultRunMeta (MetaT r)
638
  = fmap r . runMeta' True ppr (runQResult TH.pprint convertToHsType runTHType)
Luite Stegeman's avatar
Luite Stegeman committed
639
defaultRunMeta (MetaD r)
640
  = fmap r . runMeta' True ppr (runQResult TH.pprint convertToHsDecls runTHDec)
Luite Stegeman's avatar
Luite Stegeman committed
641
defaultRunMeta (MetaAW r)
642
  = fmap r . runMeta' False (const empty) (const convertAnnotationWrapper)
643
644
645
    -- 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
646
647
648
649
----------------
runMetaAW :: LHsExpr Id         -- Of type AnnotationWrapper
          -> TcM Serialized
runMetaAW = runMeta metaRequestAW
650

651
652
runMetaE :: LHsExpr Id          -- Of type (Q Exp)
         -> TcM (LHsExpr RdrName)
Luite Stegeman's avatar
Luite Stegeman committed
653
runMetaE = runMeta metaRequestE
654

gmainland's avatar
gmainland committed
655
656
runMetaP :: LHsExpr Id          -- Of type (Q Pat)
         -> TcM (LPat RdrName)
Luite Stegeman's avatar
Luite Stegeman committed
657
runMetaP = runMeta metaRequestP
gmainland's avatar
gmainland committed
658

659
660
runMetaT :: LHsExpr Id          -- Of type (Q Type)
         -> TcM (LHsType RdrName)
Luite Stegeman's avatar
Luite Stegeman committed
661
runMetaT = runMeta metaRequestT
662

663
664
runMetaD :: LHsExpr Id          -- Of type Q [Dec]
         -> TcM [LHsDecl RdrName]
Luite Stegeman's avatar
Luite Stegeman committed
665
runMetaD = runMeta metaRequestD
666
667

---------------
Luite Stegeman's avatar
Luite Stegeman committed
668
669
runMeta' :: Bool                 -- Whether code should be printed in the exception message
         -> (hs_syn -> SDoc)                                    -- how to print the code
670
         -> (SrcSpan -> ForeignHValue -> TcM (Either MsgDoc hs_syn))        -- How to run x
Luite Stegeman's avatar
Luite Stegeman committed
671
672
673
         -> 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
674
  = do  { traceTc "About to run" (ppr expr)
675
676
        ; recordThSpliceUse -- seems to be the best place to do this,
                            -- we catch all kinds of splices and annotations.
677

678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
        -- 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
694
        ; either_hval <- tryM $ liftIO $
695
696
                         HscMain.hscCompileCoreExpr hsc_env src_span ds_expr
        ; case either_hval of {
697
            Left exn   -> fail_with_exn "compile and link" exn ;
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
            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
715
             do { mb_result <- run_and_convert expr_span hval
716
717
                ; case mb_result of
                    Left err     -> failWithTc err
Luite Stegeman's avatar
Luite Stegeman committed
718
                    Right result -> do { traceTc "Got HsSyn result:" (ppr_hs result)
719
                                       ; return $! result } }
720

721
722
723
724
        ; case either_tval of
            Right v -> return v
            Left se -> case fromException se of
                         Just IOEnvFailure -> failM -- Error already in Tc monad
725
                         _ -> fail_with_exn "run" se -- Exception
726
        }}}
727
  where
728
    -- see Note [Concealed TH exceptions]
729
    fail_with_exn :: Exception e => String -> e -> TcM a
730
731
732
733
    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
734
                        if show_code then text "Code:" <+> ppr expr else empty]
735
        failWithTc msg
736

Austin Seipp's avatar
Austin Seipp committed
737
{-
738
739
Note [Exceptions in TH]
~~~~~~~~~~~~~~~~~~~~~~~
Gabor Greif's avatar
Gabor Greif committed
740
Suppose we have something like this
741
        $( f 4 )
742
where
743
744
745
        f :: Int -> Q [Dec]
        f n | n>3       = fail "Too many declarations"
            | otherwise = ...
746
747
748
749
750
751

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
752
753
    effectively transforms (fail s) to
        qReport True s >> fail
754
755
756
757
758
    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.
759
    The 'fail' in TcM raises an IOEnvFailure exception
760

761
762
763
764
765
766
 * '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]

767
768
769
770
  * 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
771
772
    and then fail

773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
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.

788

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

792
instance TH.Quasi TcM where
793
794
795
  qNewName s = do { u <- newUnique
                  ; let i = getKey u
                  ; return (TH.mkNameU s i) }
796

797
798
799
800
  -- 'msg' is forced to ensure exceptions don't escape,
  -- see Note [Exceptions in TH]
  qReport True msg  = seqList msg $ addErr  (text msg)
  qReport False msg = seqList msg $ addWarn (text msg)
801

802
  qLocation = do { m <- getModule
Ian Lynagh's avatar
Ian Lynagh committed
803
804
805
806
807
808
809
                 ; 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)
810
                                  , TH.loc_package  = unitIdString (moduleUnitId m)
Ian Lynagh's avatar
Ian Lynagh committed
811
812
813
                                  , TH.loc_start = (srcSpanStartLine r, srcSpanStartCol r)
                                  , TH.loc_end = (srcSpanEndLine   r, srcSpanEndCol   r) }) }

814
815
  qLookupName       = lookupName
  qReify            = reify
Ryan Scott's avatar
Ryan Scott committed
816
  qReifyFixity nm   = lookupThName nm >>= reifyFixity
817
818
819
  qReifyInstances   = reifyInstances
  qReifyRoles       = reifyRoles
  qReifyAnnotations = reifyAnnotations
820
  qReifyModule      = reifyModule
821
822
823
824
  qReifyConStrictness nm = do { nm' <- lookupThName nm
                              ; dc  <- tcLookupDataCon nm'
                              ; let bangs = dataConImplBangs dc
                              ; return (map reifyDecidedStrictness bangs) }
825

826
827
828
        -- For qRecover, discard error messages if
        -- the recovery action is chosen.  Otherwise
        -- we'll only fail higher up.  c.f. tryTcLIE_
829
  qRecover recover main = do { (msgs, mb_res) <- tryTcErrs main
830
831
832
833
834
                             ; case mb_res of
                                 Just val -> do { addMessages msgs      -- There might be warnings
                                                ; return val }
                                 Nothing  -> recover                    -- Discard all msgs
                          }
835

twanvl's avatar
twanvl committed
836
  qRunIO io = liftIO io
GregWeber's avatar
GregWeber committed
837
838
839
840
841

  qAddDependentFile fp = do
    ref <- fmap tcg_dependent_files getGblEnv
    dep_files <- readTcRef ref
    writeTcRef ref (fp:dep_files)
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857

  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 ()
858
859
      checkTopDecl (AnnD _)
        = return ()
860
      checkTopDecl (ForD (ForeignImport { fd_name = L _ name }))
861
862
        = bindName name
      checkTopDecl _
863
        = addErr $ text "Only function, value, annotation, and foreign import declarations may be added with addTopDecl"
864

865
866
867
      bindName :: RdrName -> TcM ()
      bindName (Exact n)
        = do { th_topnames_var <- fmap tcg_th_topnames getGblEnv
868
             ; updTcRef th_topnames_var (\ns -> extendNameSet ns n)
869
870
871
872
873
874
             }

      bindName name =
          addErr $
          hang (ptext (sLit "The binder") <+> quotes (ppr name) <+> ptext (sLit "is not a NameU."))
             2 (text "Probable cause: you used mkName instead of newName to generate a binding.")
875
876
877
878

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

880
  qGetQ :: forall a. Typeable a => TcM (Maybe a)
881
882
883
  qGetQ = do
      th_state_var <- fmap tcg_th_state getGblEnv
      th_state <- readTcRef th_state_var
884
      -- See #10596 for why we use a scoped type variable here.
885
      return (Map.lookup (typeRep (Proxy :: Proxy a)) th_state >>= fromDynamic)
886
887
888
889

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

891
892
893
894
895
  qIsExtEnabled = xoptM

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

897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915

-- | 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
916
          liftIO $ withForeignRef fhv $ \rhv ->
917
            writeIServ i (putMessage (FinishTH rhv))
918
          () <- runRemoteTH i []
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
          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 $
949
950
          withForeignRef rstate $ \state_hv ->
          withForeignRef fhv $ \q_hv ->
951
            writeIServ i (putMessage (RunTH state_hv q_hv ty (Just loc)))
952
        bs <- runRemoteTH i []
953
954
955
956
        return $! runGet get (LB.fromStrict bs)

-- | communicate with a remotely-running TH computation until it
-- finishes and returns a result.
957
958
959
960
961
962
runRemoteTH
  :: Binary a
  => IServ
  -> [Messages]   --  saved from nested calls to qRecover
  -> TcM a
runRemoteTH iserv recovers = do
963
964
965
966
967
  Msg msg <- liftIO $ readIServ iserv getMessage
  case msg of
    QDone -> liftIO $ readIServ iserv get
    QException str -> liftIO $ throwIO (ErrorCall str)
    QFail str -> fail str
968
969
970
971
972
973
974
975
976
977
978
979
980
981
    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
982
983
984
    _other -> do
      r <- handleTHMessage msg
      liftIO $ writeIServ iserv (put r)
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
      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.
-}
1014

1015
getTHState :: IServ -> TcM (ForeignRef (IORef QState))
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
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
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
  Reify n -> wrapTHResult $ TH.qReify n
  ReifyFixity n -> wrapTHResult $ TH.qReifyFixity n
  ReifyInstances n ts -> wrapTHResult $ TH.qReifyInstances n ts
  ReifyRoles n -> wrapTHResult $ TH.qReifyRoles n
  ReifyAnnotations lookup tyrep ->
    wrapTHResult $ (map B.pack <$> getAnnotationsByTypeRep lookup tyrep)
  ReifyModule m -> wrapTHResult $ TH.qReifyModule m
  AddDependentFile f -> wrapTHResult $ TH.qAddDependentFile f
  AddTopDecls decs -> wrapTHResult $ TH.qAddTopDecls decs
  IsExtEnabled ext -> wrapTHResult $ TH.qIsExtEnabled ext
  ExtsEnabled -> wrapTHResult $ TH.qExtsEnabled
  _ -> panic ("handleTHMessage: unexpected message " ++ show msg)

getAnnotationsByTypeRep :: TH.AnnLookup -> TypeRep -> TcM [[Word8]]
getAnnotationsByTypeRep th_name tyrep
  = do { name <- lookupThAnnLookup th_name
       ; topEnv <- getTopEnv
       ; epsHptAnns <- liftIO $ prepareAnnotations topEnv Nothing
       ; tcg <- getGblEnv
       ; let selectedEpsHptAnns = findAnnsByTypeRep epsHptAnns name tyrep
       ; let selectedTcgAnns = findAnnsByTypeRep (tcg_ann_env tcg) name tyrep
       ; return (selectedEpsHptAnns ++ selectedTcgAnns) }

Austin Seipp's avatar
Austin Seipp committed
1062
1063
1064
{-
************************************************************************
*                                                                      *
1065
            Instance Testing
Austin Seipp's avatar
Austin Seipp committed
1066
1067
1068
*                                                                      *
************************************************************************
-}
1069

1070
1071
reifyInstances :: TH.Name -> [TH.Type] -> TcM [TH.Dec]
reifyInstances th_nm th_tys
1072
   = addErrCtxt (ptext (sLit "In the argument of reifyInstances:")
1073
                 <+> ppr_th th_nm <+> sep (map ppr_th th_tys)) $
1074
1075
     do { loc <- getSrcSpanM
        ; rdr_ty <- cvt loc (mkThAppTs (TH.ConT th_nm) th_tys)
1076
1077
          -- #9262 says to bring vars into scope, like in HsForAllTy case
          -- of rnHsTyKi
1078
1079
        ; free_vars <- extractHsTyRdrTyVars rdr_ty
        ; let tv_rdrs = freeKiTyVarsAllVars free_vars
1080
          -- Rename  to HsType Name
1081
1082
        ; ((tv_names, rn_ty), _fvs)
            <- bindLRdrNames tv_rdrs $ \ tv_names ->
1083
               do { (rn_ty, fvs) <- rnLHsType doc rdr_ty
1084
1085
1086
1087
1088
                  ; return ((tv_names, rn_ty), fvs) }
        ; (_tvs, ty)
            <- solveEqualities $
               tcImplicitTKBndrsType tv_names $
               fst <$> tcLHsType rn_ty
1089
1090
1091
1092
        ; ty <- zonkTcTypeToType emptyZonkEnv ty
                -- Substitute out the meta type variables
                -- In particular, the type might have kind
                -- variables inside it (Trac #7477)
1093

1094
        ; traceTc "reifyInstances" (ppr ty $$ ppr (typeKind ty))
1095
1096
1097
1098
        ; case splitTyConApp_maybe ty of   -- This expands any type synonyms
            Just (tc, tys)                 -- See Trac #7910
               | Just cls <- tyConClass_maybe tc
               -> do { inst_envs <- tcGetInstEnvs
1099
                     ; let (matches, unifies, _) = lookupInstEnv False inst_envs cls tys
1100
                     ; traceTc "reifyInstances1" (ppr matches)
1101
                     ; reifyClassInstances cls (map fst matches ++ unifies) }
1102
               | isOpenFamilyTyCon tc
1103
1104
               -> do { inst_envs <- tcGetFamInstEnvs
                     ; let matches = lookupFamInstEnv inst_envs tc tys
1105
                     ; traceTc "reifyInstances2" (ppr matches)
1106
                     ; reifyFamilyInstances tc (map fim_instance matches) }
1107
            _  -> bale_out (hang (ptext (sLit "reifyInstances:") <+> quotes (ppr ty))
1108
                               2 (ptext (sLit "is not a class constraint or type family application"))) }
1109
  where
dreixel's avatar
dreixel committed
1110
    doc = ClassInstanceCtx
1111
1112
1113
1114
1115
1116
    bale_out msg = failWithTc msg

    cvt :: SrcSpan -> TH.Type -> TcM (LHsType RdrName)
    cvt loc th_ty = case convertToHsType loc th_ty of
                      Left msg -> failWithTc msg
                      Right ty -> return ty
1117

Austin Seipp's avatar
Austin Seipp committed
1118
1119
1120
{-
************************************************************************
*                                                                      *
1121
                        Reification
Austin Seipp's avatar
Austin Seipp committed
1122
1123
1124
*                                                                      *
************************************************************************
-}
1125

1126
1127
lookupName :: Bool      -- True  <=> type namespace
                        -- False <=> value namespace
1128
1129
1130
1131
1132
1133
1134
1135
           -> String -> TcM (Maybe TH.Name)
lookupName is_type_name s
  = do { lcl_env <- getLocalRdrEnv
       ; case lookupLocalRdrEnv lcl_env rdr_name of
           Just n  -> return (Just (reifyName n))
           Nothing -> do { mb_nm <- lookupGlobalOccRn_maybe rdr_name
                         ; return (fmap reifyName mb_nm) } }
  where
1136
    th_name = TH.mkName s       -- Parses M.x into a base of 'x' and a module of 'M'
1137
1138
1139
1140
1141

    occ_fs :: FastString
    occ_fs = mkFastString (TH.nameBase th_name)

    occ :: OccName
1142
1143
    occ | is_type_name
        = if isLexCon occ_fs then mkTcOccFS    occ_fs
1144
                             else mkTyVarOccFS occ_fs
1145
        | otherwise
1146
1147
1148
1149
1150
1151
1152
1153
        = if isLexCon occ_fs then mkDataOccFS occ_fs
                             else mkVarOccFS  occ_fs

    rdr_name = case TH.nameModule th_name of
                 Nothing  -> mkRdrUnqual occ
                 Just mod -> mkRdrQual (mkModuleName mod) occ

getThing :: TH.Name -> TcM TcTyThing
1154
1155
1156
1157
1158
1159
getThing th_name
  = do  { name <- lookupThName th_name
        ; traceIf (text "reify" <+> text (show th_name) <+> brackets (ppr_ns th_name) <+> ppr name)
        ; tcLookupTh name }
        -- ToDo: this tcLookup could fail, which would give a
        --       rather unhelpful error message
1160
  where
1161
    ppr_ns (TH.Name _ (TH.NameG TH.DataName  _pkg _mod)) = text "data"
Simon Marlow's avatar
Simon Marlow committed
1162
    ppr_ns (TH.Name _ (TH.NameG TH.TcClsName _pkg _mod)) = text "tc"
1163
    ppr_ns (TH.Name _ (TH.NameG TH.VarName   _pkg _mod)) = text "var"
1164
    ppr_ns _ = panic "reify/ppr_ns"