Merge remote-tracking branch 'origin/master' into type-nats
[ghc.git] / compiler / typecheck / TcSplice.lhs
1 %
2 % (c) The University of Glasgow 2006
3 % (c) The GRASP/AQUA Project, Glasgow University, 1992-1998
4 %
5
6 TcSplice: Template Haskell splices
7
8
9 \begin{code}
10 module TcSplice( kcSpliceType, tcSpliceExpr, tcSpliceDecls, tcBracket,
11                  lookupThName_maybe,
12                  runQuasiQuoteExpr, runQuasiQuotePat,
13                  runQuasiQuoteDecl, runQuasiQuoteType,
14                  runAnnotation ) where
15
16 #include "HsVersions.h"
17
18 import HscMain
19 import TcRnDriver
20         -- These imports are the reason that TcSplice
21         -- is very high up the module hierarchy
22
23 import HsSyn
24 import Convert
25 import RnExpr
26 import RnEnv
27 import RdrName
28 import RnTypes
29 import TcPat
30 import TcExpr
31 import TcHsSyn
32 import TcSimplify
33 import TcUnify
34 import Type
35 import Kind
36 import TcType
37 import TcEnv
38 import TcMType
39 import TcHsType
40 import TcIface
41 import TypeRep
42 import FamInst
43 import FamInstEnv
44 import InstEnv
45 import Name
46 import NameEnv
47 import NameSet
48 import PrelNames
49 import HscTypes
50 import OccName
51 import Var
52 import Module
53 import Annotations
54 import TcRnMonad
55 import Class
56 import Inst
57 import TyCon
58 import DataCon
59 import TcEvidence( TcEvBinds(..) )
60 import Id
61 import IdInfo
62 import DsMeta
63 import DsExpr
64 import DsMonad hiding (Splice)
65 import Serialized
66 import ErrUtils
67 import SrcLoc
68 import Outputable
69 import Util             ( dropList )
70 import Data.List        ( mapAccumL )
71 import Pair
72 import Unique
73 import Data.Maybe
74 import BasicTypes
75 import Panic
76 import FastString
77 import Control.Monad    ( when )
78
79 import qualified Language.Haskell.TH as TH
80 -- THSyntax gives access to internal functions and data types
81 import qualified Language.Haskell.TH.Syntax as TH
82
83 #ifdef GHCI
84 -- Because GHC.Desugar might not be in the base library of the bootstrapping compiler
85 import GHC.Desugar      ( AnnotationWrapper(..) )
86 #endif
87
88 import GHC.Exts         ( unsafeCoerce# )
89 \end{code}
90
91 Note [How top-level splices are handled]
92 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
93 Top-level splices (those not inside a [| .. |] quotation bracket) are handled
94 very straightforwardly:
95
96   1. tcTopSpliceExpr: typecheck the body e of the splice $(e)
97
98   2. runMetaT: desugar, compile, run it, and convert result back to
99      HsSyn RdrName (of the appropriate flavour, eg HsType RdrName,
100      HsExpr RdrName etc)
101
102   3. treat the result as if that's what you saw in the first place
103      e.g for HsType, rename and kind-check
104          for HsExpr, rename and type-check
105
106      (The last step is different for decls, becuase they can *only* be
107       top-level: we return the result of step 2.)
108
109 Note [How brackets and nested splices are handled]
110 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
111 Nested splices (those inside a [| .. |] quotation bracket), are treated
112 quite differently.
113
114   * After typechecking, the bracket [| |] carries
115
116      a) A mutable list of PendingSplice
117           type PendingSplice = (Name, LHsExpr Id)
118
119      b) The quoted expression e, *renamed*: (HsExpr Name)
120           The expression e has been typechecked, but the result of
121           that typechecking is discarded.
122
123   * The brakcet is desugared by DsMeta.dsBracket.  It
124
125       a) Extends the ds_meta environment with the PendingSplices
126          attached to the bracket
127
128       b) Converts the quoted (HsExpr Name) to a CoreExpr that, when
129          run, will produce a suitable TH expression/type/decl.  This
130          is why we leave the *renamed* expression attached to the bracket:
131          the quoted expression should not be decorated with all the goop
132          added by the type checker
133
134   * Each splice carries a unique Name, called a "splice point", thus
135     ${n}(e).  The name is initialised to an (Unqual "splice") when the
136     splice is created; the renamer gives it a unique.
137
138   * When the type checker type-checks a nested splice ${n}(e), it
139         - typechecks e
140         - adds the typechecked expression (of type (HsExpr Id))
141           as a pending splice to the enclosing bracket
142         - returns something non-committal
143     Eg for [| f ${n}(g x) |], the typechecker
144         - attaches the typechecked term (g x) to the pending splices for n
145           in the outer bracket
146         - returns a non-committal type \alpha.
147         Remember that the bracket discards the typechecked term altogether
148
149   * When DsMeta (used to desugar the body of the bracket) comes across
150     a splice, it looks up the splice's Name, n, in the ds_meta envt,
151     to find an (HsExpr Id) that should be substituted for the splice;
152     it just desugars it to get a CoreExpr (DsMeta.repSplice).
153
154 Example:
155     Source:       f = [| Just $(g 3) |]
156       The [| |] part is a HsBracket
157
158     Typechecked:  f = [| Just ${s7}(g 3) |]{s7 = g Int 3}
159       The [| |] part is a HsBracketOut, containing *renamed*
160         (not typechecked) expression
161       The "s7" is the "splice point"; the (g Int 3) part
162         is a typechecked expression
163
164     Desugared:    f = do { s7 <- g Int 3
165                          ; return (ConE "Data.Maybe.Just" s7) }
166
167
168 Note [Template Haskell state diagram]
169 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
170 Here are the ThStages, s, their corresponding level numbers
171 (the result of (thLevel s)), and their state transitions.
172
173       -----------     $      ------------   $
174       |  Comp   | ---------> |  Splice  | -----|
175       |   1     |            |    0     | <----|
176       -----------            ------------
177         ^     |                ^      |
178       $ |     | [||]         $ |      | [||]
179         |     v                |      v
180    --------------          ----------------
181    | Brack Comp |          | Brack Splice |
182    |     2      |          |      1       |
183    --------------          ----------------
184
185 * Normal top-level declarations start in state Comp
186        (which has level 1).
187   Annotations start in state Splice, since they are
188        treated very like a splice (only without a '$')
189
190 * Code compiled in state Splice (and only such code)
191   will be *run at compile time*, with the result replacing
192   the splice
193
194 * The original paper used level -1 instead of 0, etc.
195
196 * The original paper did not allow a splice within a
197   splice, but there is no reason not to. This is the
198   $ transition in the top right.
199
200 Note [Template Haskell levels]
201 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
202 * Imported things are impLevel (= 0)
203
204 * In GHCi, variables bound by a previous command are treated
205   as impLevel, because we have bytecode for them.
206
207 * Variables are bound at the "current level"
208
209 * The current level starts off at outerLevel (= 1)
210
211 * The level is decremented by splicing $(..)
212                incremented by brackets [| |]
213                incremented by name-quoting 'f
214
215 When a variable is used, we compare
216         bind:  binding level, and
217         use:   current level at usage site
218
219   Generally
220         bind > use      Always error (bound later than used)
221                         [| \x -> $(f x) |]
222
223         bind = use      Always OK (bound same stage as used)
224                         [| \x -> $(f [| x |]) |]
225
226         bind < use      Inside brackets, it depends
227                         Inside splice, OK
228                         Inside neither, OK
229
230   For (bind < use) inside brackets, there are three cases:
231     - Imported things   OK      f = [| map |]
232     - Top-level things  OK      g = [| f |]
233     - Non-top-level     Only if there is a liftable instance
234                                 h = \(x:Int) -> [| x |]
235
236 See Note [What is a top-level Id?]
237
238 Note [Quoting names]
239 ~~~~~~~~~~~~~~~~~~~~
240 A quoted name 'n is a bit like a quoted expression [| n |], except that we
241 have no cross-stage lifting (c.f. TcExpr.thBrackId).  So, after incrementing
242 the use-level to account for the brackets, the cases are:
243
244         bind > use                      Error
245         bind = use                      OK
246         bind < use
247                 Imported things         OK
248                 Top-level things        OK
249                 Non-top-level           Error
250
251 See Note [What is a top-level Id?] in TcEnv.  Examples:
252
253   f 'map        -- OK; also for top-level defns of this module
254
255   \x. f 'x      -- Not ok (whereas \x. f [| x |] might have been ok, by
256                 --                               cross-stage lifting
257
258   \y. [| \x. $(f 'y) |] -- Not ok (same reason)
259
260   [| \x. $(f 'x) |]     -- OK
261
262
263 Note [What is a top-level Id?]
264 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
265 In the level-control criteria above, we need to know what a "top level Id" is.
266 There are three kinds:
267   * Imported from another module                (GlobalId, ExternalName)
268   * Bound at the top level of this module       (ExternalName)
269   * In GHCi, bound by a previous stmt           (GlobalId)
270 It's strange that there is no one criterion tht picks out all three, but that's
271 how it is right now.  (The obvious thing is to give an ExternalName to GHCi Ids
272 bound in an earlier Stmt, but what module would you choose?  See
273 Note [Interactively-bound Ids in GHCi] in TcRnDriver.)
274
275 The predicate we use is TcEnv.thTopLevelId.
276
277
278 %************************************************************************
279 %*                                                                      *
280 \subsection{Main interface + stubs for the non-GHCI case
281 %*                                                                      *
282 %************************************************************************
283
284 \begin{code}
285 tcBracket     :: HsBracket Name -> TcRhoType -> TcM (LHsExpr TcId)
286 tcSpliceDecls :: LHsExpr Name -> TcM [LHsDecl RdrName]
287 tcSpliceExpr  :: HsSplice Name -> TcRhoType -> TcM (HsExpr TcId)
288 kcSpliceType  :: HsSplice Name -> FreeVars -> TcM (HsType Name, TcKind)
289         -- None of these functions add constraints to the LIE
290
291 lookupThName_maybe :: TH.Name -> TcM (Maybe Name)
292
293 runQuasiQuoteExpr :: HsQuasiQuote RdrName -> RnM (LHsExpr RdrName)
294 runQuasiQuotePat  :: HsQuasiQuote RdrName -> RnM (LPat RdrName)
295 runQuasiQuoteType :: HsQuasiQuote RdrName -> RnM (LHsType RdrName)
296 runQuasiQuoteDecl :: HsQuasiQuote RdrName -> RnM [LHsDecl RdrName]
297
298 runAnnotation     :: CoreAnnTarget -> LHsExpr Name -> TcM Annotation
299
300 #ifndef GHCI
301 tcBracket     x _ = pprPanic "Cant do tcBracket without GHCi"     (ppr x)
302 tcSpliceExpr  e   = pprPanic "Cant do tcSpliceExpr without GHCi"  (ppr e)
303 tcSpliceDecls x   = pprPanic "Cant do tcSpliceDecls without GHCi" (ppr x)
304 kcSpliceType  x fvs = pprPanic "Cant do kcSpliceType without GHCi"  (ppr x)
305
306 lookupThName_maybe n = pprPanic "Cant do lookupThName_maybe without GHCi" (ppr n)
307
308 runQuasiQuoteExpr q = pprPanic "Cant do runQuasiQuoteExpr without GHCi" (ppr q)
309 runQuasiQuotePat  q = pprPanic "Cant do runQuasiQuotePat without GHCi" (ppr q)
310 runQuasiQuoteType q = pprPanic "Cant do runQuasiQuoteType without GHCi" (ppr q)
311 runQuasiQuoteDecl q = pprPanic "Cant do runQuasiQuoteDecl without GHCi" (ppr q)
312 runAnnotation   _ q = pprPanic "Cant do runAnnotation without GHCi" (ppr q)
313 #else
314 \end{code}
315
316 %************************************************************************
317 %*                                                                      *
318 \subsection{Quoting an expression}
319 %*                                                                      *
320 %************************************************************************
321
322
323 \begin{code}
324 -- See Note [How brackets and nested splices are handled]
325 tcBracket brack res_ty
326   = addErrCtxt (hang (ptext (sLit "In the Template Haskell quotation"))
327                    2 (ppr brack)) $
328     do {        -- Check for nested brackets
329          cur_stage <- getStage
330        ; checkTc (not (isBrackStage cur_stage)) illegalBracket
331
332         -- Brackets are desugared to code that mentions the TH package
333        ; recordThUse
334
335         -- Typecheck expr to make sure it is valid,
336         -- but throw away the results.  We'll type check
337         -- it again when we actually use it.
338        ; pending_splices <- newMutVar []
339        ; lie_var <- getConstraintVar
340        ; let brack_stage = Brack cur_stage pending_splices lie_var
341
342           -- We want to check that there aren't any constraints that
343           -- can't be satisfied (e.g. Show Foo, where Foo has no Show
344           -- instance), but we aren't otherwise interested in the
345           -- results. Nor do we care about ambiguous dictionaries etc.
346           -- We will type check this bracket again at its usage site.
347           --
348           -- We build a single implication constraint with a BracketSkol;
349           -- that in turn tells simplifyCheck to report only definite
350           -- errors
351        ; (_,lie) <- captureConstraints $
352                     newImplication BracketSkol [] [] $
353                     setStage brack_stage $
354                     do { meta_ty <- tc_bracket cur_stage brack
355                        ; unifyType meta_ty res_ty }
356
357           -- It's best to simplify the constraint now, even though in
358           -- principle some later unification might be useful for it,
359           -- because we don't want these essentially-junk TH implication
360           -- contraints floating around nested inside other constraints
361           -- See for example Trac #4949
362        ; _ <- simplifyTop lie
363
364         -- Return the original expression, not the type-decorated one
365        ; pendings <- readMutVar pending_splices
366        ; return (noLoc (HsBracketOut brack pendings)) }
367
368 tc_bracket :: ThStage -> HsBracket Name -> TcM TcType
369 tc_bracket outer_stage br@(VarBr _ name)     -- Note [Quoting names]
370   = do  { thing <- tcLookup name
371         ; case thing of
372             AGlobal {} -> return ()
373             ATyVar {}  -> return ()
374             ATcId { tct_level = bind_lvl, tct_id = id }
375                 | thTopLevelId id       -- C.f TcExpr.checkCrossStageLifting
376                 -> keepAliveTc id
377                 | otherwise
378                 -> do { checkTc (thLevel outer_stage + 1 == bind_lvl)
379                                 (quotedNameStageErr br) }
380             _ -> pprPanic "th_bracket" (ppr name $$ ppr thing)
381
382         ; tcMetaTy nameTyConName        -- Result type is Var (not Q-monadic)
383         }
384
385 tc_bracket _ (ExpBr expr)
386   = do  { any_ty <- newFlexiTyVarTy openTypeKind
387         ; _ <- tcMonoExprNC expr any_ty  -- NC for no context; tcBracket does that
388         ; tcMetaTy expQTyConName }
389         -- Result type is ExpQ (= Q Exp)
390
391 tc_bracket _ (TypBr typ)
392   = do  { _ <- tcHsSigTypeNC ThBrackCtxt typ
393         ; tcMetaTy typeQTyConName }
394         -- Result type is Type (= Q Typ)
395
396 tc_bracket _ (DecBrG decls)
397   = do  { _ <- tcTopSrcDecls emptyModDetails decls
398                -- Typecheck the declarations, dicarding the result
399                -- We'll get all that stuff later, when we splice it in
400
401                -- Top-level declarations in the bracket get unqualified names
402                -- See Note [Top-level Names in Template Haskell decl quotes] in RnNames
403
404         ; tcMetaTy decsQTyConName } -- Result type is Q [Dec]
405
406 tc_bracket _ (PatBr pat)
407   = do  { any_ty <- newFlexiTyVarTy openTypeKind
408         ; _ <- tcPat ThPatQuote pat any_ty $
409                return ()
410         ; tcMetaTy patQTyConName }
411         -- Result type is PatQ (= Q Pat)
412
413 tc_bracket _ (DecBrL _)
414   = panic "tc_bracket: Unexpected DecBrL"
415
416 quotedNameStageErr :: HsBracket Name -> SDoc
417 quotedNameStageErr br
418   = sep [ ptext (sLit "Stage error: the non-top-level quoted name") <+> ppr br
419         , ptext (sLit "must be used at the same stage at which is is bound")]
420 \end{code}
421
422
423 %************************************************************************
424 %*                                                                      *
425 \subsection{Splicing an expression}
426 %*                                                                      *
427 %************************************************************************
428
429 \begin{code}
430 tcSpliceExpr (HsSplice name expr) res_ty
431   = setSrcSpan (getLoc expr)    $ do
432     { stage <- getStage
433     ; case stage of {
434         Splice -> tcTopSplice expr res_ty ;
435         Comp   -> tcTopSplice expr res_ty ;
436
437         Brack pop_stage ps_var lie_var -> do
438
439         -- See Note [How brackets and nested splices are handled]
440         -- A splice inside brackets
441         -- NB: ignore res_ty, apart from zapping it to a mono-type
442         -- e.g.   [| reverse $(h 4) |]
443         -- Here (h 4) :: Q Exp
444         -- but $(h 4) :: forall a.a     i.e. anything!
445
446      { meta_exp_ty <- tcMetaTy expQTyConName
447      ; expr' <- setStage pop_stage $
448                 setConstraintVar lie_var    $
449                 tcMonoExpr expr meta_exp_ty
450
451         -- Write the pending splice into the bucket
452      ; ps <- readMutVar ps_var
453      ; writeMutVar ps_var ((name,expr') : ps)
454
455      ; return (panic "tcSpliceExpr")    -- The returned expression is ignored
456      }}}
457
458 tcTopSplice :: LHsExpr Name -> TcRhoType -> TcM (HsExpr Id)
459 -- Note [How top-level splices are handled]
460 tcTopSplice expr res_ty
461   = do { meta_exp_ty <- tcMetaTy expQTyConName
462
463         -- Typecheck the expression
464        ; zonked_q_expr <- tcTopSpliceExpr (tcMonoExpr expr meta_exp_ty)
465
466         -- Run the expression
467        ; expr2 <- runMetaE zonked_q_expr
468        ; showSplice "expression" expr (ppr expr2)
469
470         -- Rename it, but bale out if there are errors
471         -- otherwise the type checker just gives more spurious errors
472        ; addErrCtxt (spliceResultDoc expr) $ do
473        { (exp3, _fvs) <- checkNoErrs (rnLExpr expr2)
474
475        ; exp4 <- tcMonoExpr exp3 res_ty
476        ; return (unLoc exp4) } }
477
478 spliceResultDoc :: LHsExpr Name -> SDoc
479 spliceResultDoc expr
480   = sep [ ptext (sLit "In the result of the splice:")
481         , nest 2 (char '$' <> pprParendExpr expr)
482         , ptext (sLit "To see what the splice expanded to, use -ddump-splices")]
483
484 -------------------
485 tcTopSpliceExpr :: TcM (LHsExpr Id) -> TcM (LHsExpr Id)
486 -- Note [How top-level splices are handled]
487 -- Type check an expression that is the body of a top-level splice
488 --   (the caller will compile and run it)
489 -- Note that set the level to Splice, regardless of the original level,
490 -- before typechecking the expression.  For example:
491 --      f x = $( ...$(g 3) ... )
492 -- The recursive call to tcMonoExpr will simply expand the
493 -- inner escape before dealing with the outer one
494
495 tcTopSpliceExpr tc_action
496   = checkNoErrs $  -- checkNoErrs: must not try to run the thing
497                    -- if the type checker fails!
498     setStage Splice $
499     do {    -- Typecheck the expression
500          (expr', lie) <- captureConstraints tc_action
501
502         -- Solve the constraints
503         ; const_binds <- simplifyTop lie
504
505           -- Zonk it and tie the knot of dictionary bindings
506        ; zonkTopLExpr (mkHsDictLet (EvBinds const_binds) expr') }
507 \end{code}
508
509
510 %************************************************************************
511 %*                                                                      *
512                 Splicing a type
513 %*                                                                      *
514 %************************************************************************
515
516 Very like splicing an expression, but we don't yet share code.
517
518 \begin{code}
519 kcSpliceType splice@(HsSplice name hs_expr) fvs
520   = setSrcSpan (getLoc hs_expr) $ do
521     { stage <- getStage
522     ; case stage of {
523         Splice -> kcTopSpliceType hs_expr ;
524         Comp   -> kcTopSpliceType hs_expr ;
525
526         Brack pop_level ps_var lie_var -> do
527            -- See Note [How brackets and nested splices are handled]
528            -- A splice inside brackets
529     { meta_ty <- tcMetaTy typeQTyConName
530     ; expr' <- setStage pop_level $
531                setConstraintVar lie_var $
532                tcMonoExpr hs_expr meta_ty
533
534         -- Write the pending splice into the bucket
535     ; ps <- readMutVar ps_var
536     ; writeMutVar ps_var ((name,expr') : ps)
537
538     -- e.g.   [| f (g :: Int -> $(h 4)) |]
539     -- Here (h 4) :: Q Type
540     -- but $(h 4) :: a  i.e. any type, of any kind
541
542     ; kind <- newMetaKindVar
543     ; return (HsSpliceTy splice fvs kind, kind) 
544     }}}
545
546 kcTopSpliceType :: LHsExpr Name -> TcM (HsType Name, TcKind)
547 -- Note [How top-level splices are handled]
548 kcTopSpliceType expr
549   = do  { meta_ty <- tcMetaTy typeQTyConName
550
551         -- Typecheck the expression
552         ; zonked_q_expr <- tcTopSpliceExpr (tcMonoExpr expr meta_ty)
553
554         -- Run the expression
555         ; hs_ty2 <- runMetaT zonked_q_expr
556         ; showSplice "type" expr (ppr hs_ty2)
557   
558         -- Rename it, but bale out if there are errors
559         -- otherwise the type checker just gives more spurious errors
560         ; addErrCtxt (spliceResultDoc expr) $ do 
561         { let doc = SpliceTypeCtx hs_ty2
562         ; hs_ty3 <- checkNoErrs (rnLHsType doc hs_ty2)
563         ; (ty4, kind) <- kcLHsType hs_ty3
564         ; return (unLoc ty4, kind) }}
565 \end{code}
566
567 %************************************************************************
568 %*                                                                      *
569 \subsection{Splicing an expression}
570 %*                                                                      *
571 %************************************************************************
572
573 \begin{code}
574 -- Note [How top-level splices are handled]
575 -- Always at top level
576 -- Type sig at top of file:
577 --      tcSpliceDecls :: LHsExpr Name -> TcM [LHsDecl RdrName]
578 tcSpliceDecls expr
579   = do  { list_q <- tcMetaTy decsQTyConName     -- Q [Dec]
580         ; zonked_q_expr <- tcTopSpliceExpr (tcMonoExpr expr list_q)
581
582                 -- Run the expression
583         ; decls <- runMetaD zonked_q_expr
584         ; showSplice "declarations" expr
585                      (ppr (getLoc expr) $$ (vcat (map ppr decls)))
586
587         ; return decls }
588 \end{code}
589
590
591 %************************************************************************
592 %*                                                                      *
593         Annotations
594 %*                                                                      *
595 %************************************************************************
596
597 \begin{code}
598 runAnnotation target expr = do
599     -- Find the classes we want instances for in order to call toAnnotationWrapper
600     loc <- getSrcSpanM
601     data_class <- tcLookupClass dataClassName
602     to_annotation_wrapper_id <- tcLookupId toAnnotationWrapperName
603
604     -- Check the instances we require live in another module (we want to execute it..)
605     -- and check identifiers live in other modules using TH stage checks. tcSimplifyStagedExpr
606     -- also resolves the LIE constraints to detect e.g. instance ambiguity
607     zonked_wrapped_expr' <- tcTopSpliceExpr $
608            do { (expr', expr_ty) <- tcInferRhoNC expr
609                 -- We manually wrap the typechecked expression in a call to toAnnotationWrapper
610                 -- By instantiating the call >here< it gets registered in the
611                 -- LIE consulted by tcTopSpliceExpr
612                 -- and hence ensures the appropriate dictionary is bound by const_binds
613               ; wrapper <- instCall AnnOrigin [expr_ty] [mkClassPred data_class [expr_ty]]
614               ; let specialised_to_annotation_wrapper_expr
615                       = L loc (HsWrap wrapper (HsVar to_annotation_wrapper_id))
616               ; return (L loc (HsApp specialised_to_annotation_wrapper_expr expr')) }
617
618     -- Run the appropriately wrapped expression to get the value of
619     -- the annotation and its dictionaries. The return value is of
620     -- type AnnotationWrapper by construction, so this conversion is
621     -- safe
622     flip runMetaAW zonked_wrapped_expr' $ \annotation_wrapper ->
623         case annotation_wrapper of
624             AnnotationWrapper value | let serialized = toSerialized serializeWithData value ->
625                 -- Got the value and dictionaries: build the serialized value and
626                 -- call it a day. We ensure that we seq the entire serialized value
627                 -- in order that any errors in the user-written code for the
628                 -- annotation are exposed at this point.  This is also why we are
629                 -- doing all this stuff inside the context of runMeta: it has the
630                 -- facilities to deal with user error in a meta-level expression
631                 seqSerialized serialized `seq` Annotation {
632                     ann_target = target,
633                     ann_value = serialized
634                 }
635 \end{code}
636
637
638 %************************************************************************
639 %*                                                                      *
640         Quasi-quoting
641 %*                                                                      *
642 %************************************************************************
643
644 Note [Quasi-quote overview]
645 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
646 The GHC "quasi-quote" extension is described by Geoff Mainland's paper
647 "Why it's nice to be quoted: quasiquoting for Haskell" (Haskell
648 Workshop 2007).
649
650 Briefly, one writes
651         [p| stuff |]
652 and the arbitrary string "stuff" gets parsed by the parser 'p', whose
653 type should be Language.Haskell.TH.Quote.QuasiQuoter.  'p' must be
654 defined in another module, because we are going to run it here.  It's
655 a bit like a TH splice:
656         $(p "stuff")
657
658 However, you can do this in patterns as well as terms.  Becuase of this,
659 the splice is run by the *renamer* rather than the type checker.
660
661 %************************************************************************
662 %*                                                                      *
663 \subsubsection{Quasiquotation}
664 %*                                                                      *
665 %************************************************************************
666
667 See Note [Quasi-quote overview] in TcSplice.
668
669 \begin{code}
670 runQuasiQuote :: Outputable hs_syn
671               => HsQuasiQuote RdrName   -- Contains term of type QuasiQuoter, and the String
672               -> Name                   -- Of type QuasiQuoter -> String -> Q th_syn
673               -> Name                   -- Name of th_syn type
674               -> MetaOps th_syn hs_syn
675               -> RnM hs_syn
676 runQuasiQuote (HsQuasiQuote quoter q_span quote) quote_selector meta_ty meta_ops
677   = do  {     -- Drop the leading "$" from the quoter name, if present
678               -- This is old-style syntax, now deprecated
679               -- NB: when removing this backward-compat, remove
680               --     the matching code in Lexer.x (around line 310)
681           let occ_str = occNameString (rdrNameOcc quoter)
682         ; quoter <- ASSERT( not (null occ_str) )  -- Lexer ensures this
683                     if head occ_str /= '$' then return quoter
684                     else do { addWarn (deprecatedDollar quoter)
685                             ; return (mkRdrUnqual (mkVarOcc (tail occ_str))) }
686
687         ; quoter' <- lookupOccRn quoter
688                 -- We use lookupOcc rather than lookupGlobalOcc because in the
689                 -- erroneous case of \x -> [x| ...|] we get a better error message
690                 -- (stage restriction rather than out of scope).
691
692         ; when (isUnboundName quoter') failM
693                 -- If 'quoter' is not in scope, proceed no further
694                 -- The error message was generated by lookupOccRn, but it then
695                 -- succeeds with an "unbound name", which makes the subsequent
696                 -- attempt to run the quote fail in a confusing way
697
698           -- Check that the quoter is not locally defined, otherwise the TH
699           -- machinery will not be able to run the quasiquote.
700         ; this_mod <- getModule
701         ; let is_local = nameIsLocalOrFrom this_mod quoter'
702         ; checkTc (not is_local) (quoteStageError quoter')
703
704         ; traceTc "runQQ" (ppr quoter <+> ppr is_local)
705
706           -- Build the expression
707         ; let quoterExpr = L q_span $! HsVar $! quoter'
708         ; let quoteExpr = L q_span $! HsLit $! HsString quote
709         ; let expr = L q_span $
710                      HsApp (L q_span $
711                             HsApp (L q_span (HsVar quote_selector)) quoterExpr) quoteExpr
712         ; meta_exp_ty <- tcMetaTy meta_ty
713
714         -- Typecheck the expression
715         ; zonked_q_expr <- tcTopSpliceExpr (tcMonoExpr expr meta_exp_ty)
716
717         -- Run the expression
718         ; result <- runMetaQ meta_ops zonked_q_expr
719         ; showSplice (mt_desc meta_ops) quoteExpr (ppr result)
720
721         ; return result }
722
723 runQuasiQuoteExpr qq = runQuasiQuote qq quoteExpName  expQTyConName  exprMetaOps
724 runQuasiQuotePat  qq = runQuasiQuote qq quotePatName  patQTyConName  patMetaOps
725 runQuasiQuoteType qq = runQuasiQuote qq quoteTypeName typeQTyConName typeMetaOps
726 runQuasiQuoteDecl qq = runQuasiQuote qq quoteDecName  decsQTyConName declMetaOps
727
728 quoteStageError :: Name -> SDoc
729 quoteStageError quoter
730   = sep [ptext (sLit "GHC stage restriction:") <+> ppr quoter,
731          nest 2 (ptext (sLit "is used in a quasiquote, and must be imported, not defined locally"))]
732
733 deprecatedDollar :: RdrName -> SDoc
734 deprecatedDollar quoter
735   = hang (ptext (sLit "Deprecated syntax:"))
736        2 (ptext (sLit "quasiquotes no longer need a dollar sign:")
737           <+> ppr quoter)
738 \end{code}
739
740
741 %************************************************************************
742 %*                                                                      *
743 \subsection{Running an expression}
744 %*                                                                      *
745 %************************************************************************
746
747 \begin{code}
748 data MetaOps th_syn hs_syn
749   = MT { mt_desc :: String             -- Type of beast (expression, type etc)
750        , mt_show :: th_syn -> String   -- How to show the th_syn thing
751        , mt_cvt  :: SrcSpan -> th_syn -> Either Message hs_syn
752                                        -- How to convert to hs_syn
753     }
754
755 exprMetaOps :: MetaOps TH.Exp (LHsExpr RdrName)
756 exprMetaOps = MT { mt_desc = "expression", mt_show = TH.pprint, mt_cvt = convertToHsExpr }
757
758 patMetaOps :: MetaOps TH.Pat (LPat RdrName)
759 patMetaOps = MT { mt_desc = "pattern", mt_show = TH.pprint, mt_cvt = convertToPat }
760
761 typeMetaOps :: MetaOps TH.Type (LHsType RdrName)
762 typeMetaOps = MT { mt_desc = "type", mt_show = TH.pprint, mt_cvt = convertToHsType }
763
764 declMetaOps :: MetaOps [TH.Dec] [LHsDecl RdrName]
765 declMetaOps = MT { mt_desc = "declarations", mt_show = TH.pprint, mt_cvt = convertToHsDecls }
766
767 ----------------
768 runMetaAW :: Outputable output
769           => (AnnotationWrapper -> output)
770           -> LHsExpr Id         -- Of type AnnotationWrapper
771           -> TcM output
772 runMetaAW k = runMeta False (\_ -> return . Right . k)
773     -- We turn off showing the code in meta-level exceptions because doing so exposes
774     -- the toAnnotationWrapper function that we slap around the users code
775
776 -----------------
777 runMetaQ :: Outputable hs_syn
778          => MetaOps th_syn hs_syn
779          -> LHsExpr Id
780          -> TcM hs_syn
781 runMetaQ (MT { mt_show = show_th, mt_cvt = cvt }) expr
782   = runMeta True run_and_cvt expr
783   where
784     run_and_cvt expr_span hval
785        = do { th_result <- TH.runQ hval
786             ; traceTc "Got TH result:" (text (show_th th_result))
787             ; return (cvt expr_span th_result) }
788
789 runMetaE :: LHsExpr Id          -- Of type (Q Exp)
790          -> TcM (LHsExpr RdrName)
791 runMetaE = runMetaQ exprMetaOps
792
793 runMetaT :: LHsExpr Id          -- Of type (Q Type)
794          -> TcM (LHsType RdrName)
795 runMetaT = runMetaQ typeMetaOps
796
797 runMetaD :: LHsExpr Id          -- Of type Q [Dec]
798          -> TcM [LHsDecl RdrName]
799 runMetaD = runMetaQ declMetaOps
800
801 ---------------
802 runMeta :: (Outputable hs_syn)
803         => Bool                 -- Whether code should be printed in the exception message
804         -> (SrcSpan -> x -> TcM (Either Message hs_syn))        -- How to run x
805         -> LHsExpr Id           -- Of type x; typically x = Q TH.Exp, or something like that
806         -> TcM hs_syn           -- Of type t
807 runMeta show_code run_and_convert expr
808   = do  { traceTc "About to run" (ppr expr)
809         ; recordThSpliceUse -- seems to be the best place to do this,
810                             -- we catch all kinds of splices and annotations.
811
812         -- Check that we've had no errors of any sort so far.
813         -- For example, if we found an error in an earlier defn f, but
814         -- recovered giving it type f :: forall a.a, it'd be very dodgy
815         -- to carry ont.  Mind you, the staging restrictions mean we won't
816         -- actually run f, but it still seems wrong. And, more concretely,
817         -- see Trac #5358 for an example that fell over when trying to
818         -- reify a function with a "?" kind in it.  (These don't occur
819         -- in type-correct programs.
820         ; failIfErrsM
821
822         -- Desugar
823         ; ds_expr <- initDsTc (dsLExpr expr)
824         -- Compile and link it; might fail if linking fails
825         ; hsc_env <- getTopEnv
826         ; src_span <- getSrcSpanM
827         ; traceTc "About to run (desugared)" (ppr ds_expr)
828         ; either_hval <- tryM $ liftIO $
829                          HscMain.hscCompileCoreExpr hsc_env src_span ds_expr
830         ; case either_hval of {
831             Left exn   -> failWithTc (mk_msg "compile and link" exn) ;
832             Right hval -> do
833
834         {       -- Coerce it to Q t, and run it
835
836                 -- Running might fail if it throws an exception of any kind (hence tryAllM)
837                 -- including, say, a pattern-match exception in the code we are running
838                 --
839                 -- We also do the TH -> HS syntax conversion inside the same
840                 -- exception-cacthing thing so that if there are any lurking
841                 -- exceptions in the data structure returned by hval, we'll
842                 -- encounter them inside the try
843                 --
844                 -- See Note [Exceptions in TH]
845           let expr_span = getLoc expr
846         ; either_tval <- tryAllM $
847                          setSrcSpan expr_span $ -- Set the span so that qLocation can
848                                                 -- see where this splice is
849              do { mb_result <- run_and_convert expr_span (unsafeCoerce# hval)
850                 ; case mb_result of
851                     Left err     -> failWithTc err
852                     Right result -> do { traceTc "Got HsSyn result:" (ppr result)
853                                        ; return $! result } }
854
855         ; case either_tval of
856             Right v -> return v
857             Left se -> case fromException se of
858                          Just IOEnvFailure -> failM -- Error already in Tc monad
859                          _ -> failWithTc (mk_msg "run" se)      -- Exception
860         }}}
861   where
862     mk_msg s exn = vcat [text "Exception when trying to" <+> text s <+> text "compile-time code:",
863                          nest 2 (text (Panic.showException exn)),
864                          if show_code then nest 2 (text "Code:" <+> ppr expr) else empty]
865 \end{code}
866
867 Note [Exceptions in TH]
868 ~~~~~~~~~~~~~~~~~~~~~~~
869 Supppose we have something like this
870         $( f 4 )
871 where
872         f :: Int -> Q [Dec]
873         f n | n>3       = fail "Too many declarations"
874             | otherwise = ...
875
876 The 'fail' is a user-generated failure, and should be displayed as a
877 perfectly ordinary compiler error message, not a panic or anything
878 like that.  Here's how it's processed:
879
880   * 'fail' is the monad fail.  The monad instance for Q in TH.Syntax
881     effectively transforms (fail s) to
882         qReport True s >> fail
883     where 'qReport' comes from the Quasi class and fail from its monad
884     superclass.
885
886   * The TcM monad is an instance of Quasi (see TcSplice), and it implements
887     (qReport True s) by using addErr to add an error message to the bag of errors.
888     The 'fail' in TcM raises an IOEnvFailure exception
889
890   * So, when running a splice, we catch all exceptions; then for
891         - an IOEnvFailure exception, we assume the error is already
892                 in the error-bag (above)
893         - other errors, we add an error to the bag
894     and then fail
895
896
897 To call runQ in the Tc monad, we need to make TcM an instance of Quasi:
898
899 \begin{code}
900 instance TH.Quasi (IOEnv (Env TcGblEnv TcLclEnv)) where
901   qNewName s = do { u <- newUnique
902                   ; let i = getKey u
903                   ; return (TH.mkNameU s i) }
904
905   qReport True msg  = addErr (text msg)
906   qReport False msg = addReport (text msg) empty
907
908   qLocation = do { m <- getModule
909                  ; l <- getSrcSpanM
910                  ; r <- case l of
911                         UnhelpfulSpan _ -> pprPanic "qLocation: Unhelpful location"
912                                                     (ppr l)
913                         RealSrcSpan s -> return s
914                  ; return (TH.Loc { TH.loc_filename = unpackFS (srcSpanFile r)
915                                   , TH.loc_module   = moduleNameString (moduleName m)
916                                   , TH.loc_package  = packageIdString (modulePackageId m)
917                                   , TH.loc_start = (srcSpanStartLine r, srcSpanStartCol r)
918                                   , TH.loc_end = (srcSpanEndLine   r, srcSpanEndCol   r) }) }
919
920   qLookupName     = lookupName
921   qReify          = reify
922   qReifyInstances = reifyInstances
923
924         -- For qRecover, discard error messages if
925         -- the recovery action is chosen.  Otherwise
926         -- we'll only fail higher up.  c.f. tryTcLIE_
927   qRecover recover main = do { (msgs, mb_res) <- tryTcErrs main
928                              ; case mb_res of
929                                  Just val -> do { addMessages msgs      -- There might be warnings
930                                                 ; return val }
931                                  Nothing  -> recover                    -- Discard all msgs
932                           }
933
934   qRunIO io = liftIO io
935
936   qAddDependentFile fp = do
937     ref <- fmap tcg_dependent_files getGblEnv
938     dep_files <- readTcRef ref
939     writeTcRef ref (fp:dep_files)
940 \end{code}
941
942
943 %************************************************************************
944 %*                                                                      *
945 \subsection{Errors and contexts}
946 %*                                                                      *
947 %************************************************************************
948
949 \begin{code}
950 showSplice :: String -> LHsExpr Name -> SDoc -> TcM ()
951 -- Note that 'before' is *renamed* but not *typechecked*
952 -- Reason (a) less typechecking crap
953 --        (b) data constructors after type checking have been
954 --            changed to their *wrappers*, and that makes them
955 --            print always fully qualified
956 showSplice what before after
957   = do { loc <- getSrcSpanM
958        ; traceSplice (vcat [ppr loc <> colon <+> text "Splicing" <+> text what,
959                             nest 2 (sep [nest 2 (ppr before),
960                                          text "======>",
961                                          nest 2 after])]) }
962
963 illegalBracket :: SDoc
964 illegalBracket = ptext (sLit "Template Haskell brackets cannot be nested (without intervening splices)")
965 #endif  /* GHCI */
966 \end{code}
967
968
969 %************************************************************************
970 %*                                                                      *
971             Instance Testing
972 %*                                                                      *
973 %************************************************************************
974
975 \begin{code}
976 reifyInstances :: TH.Name -> [TH.Type] -> TcM [TH.Dec]
977 reifyInstances th_nm th_tys
978    = addErrCtxt (ptext (sLit "In reifyInstances")
979                  <+> ppr_th th_nm <+> sep (map ppr_th th_tys)) $
980      do { thing <- getThing th_nm
981         ; case thing of
982             AGlobal (ATyCon tc)
983               | Just cls <- tyConClass_maybe tc
984               -> do { tys <- tc_types (classTyCon cls) th_tys
985                     ; inst_envs <- tcGetInstEnvs
986                     ; let (matches, unifies, _) = lookupInstEnv inst_envs cls tys
987                     ; mapM reifyClassInstance (map fst matches ++ unifies) }
988               | otherwise
989               -> do { tys <- tc_types tc th_tys
990                     ; inst_envs <- tcGetFamInstEnvs
991                     ; let matches = lookupFamInstEnv inst_envs tc tys
992                     ; mapM (reifyFamilyInstance . fst) matches }
993             _ -> bale_out (ppr_th th_nm <+> ptext (sLit "is not a class or type constructor"))
994         }
995   where
996     doc = ClassInstanceCtx
997     bale_out msg = failWithTc msg
998
999     tc_types :: TyCon -> [TH.Type] -> TcM [Type]
1000     tc_types tc th_tys
1001       = do { let tc_arity = tyConArity tc
1002            ; when (length th_tys /= tc_arity)
1003                   (bale_out (ptext (sLit "Wrong number of types (expected")
1004                              <+> int tc_arity <> rparen))
1005            ; loc <- getSrcSpanM
1006            ; rdr_tys <- mapM (cvt loc) th_tys    -- Convert to HsType RdrName
1007            ; rn_tys  <- rnLHsTypes doc rdr_tys   -- Rename  to HsType Name
1008            ; (tys, _res_k) <- kcApps tc (tyConKind tc) rn_tys
1009            ; mapM dsHsType tys }
1010
1011     cvt :: SrcSpan -> TH.Type -> TcM (LHsType RdrName)
1012     cvt loc th_ty = case convertToHsType loc th_ty of
1013                       Left msg -> failWithTc msg
1014                       Right ty -> return ty
1015 \end{code}
1016
1017
1018 %************************************************************************
1019 %*                                                                      *
1020                         Reification
1021 %*                                                                      *
1022 %************************************************************************
1023
1024
1025 \begin{code}
1026 lookupName :: Bool      -- True  <=> type namespace
1027                         -- False <=> value namespace
1028            -> String -> TcM (Maybe TH.Name)
1029 lookupName is_type_name s
1030   = do { lcl_env <- getLocalRdrEnv
1031        ; case lookupLocalRdrEnv lcl_env rdr_name of
1032            Just n  -> return (Just (reifyName n))
1033            Nothing -> do { mb_nm <- lookupGlobalOccRn_maybe rdr_name
1034                          ; return (fmap reifyName mb_nm) } }
1035   where
1036     th_name = TH.mkName s       -- Parses M.x into a base of 'x' and a module of 'M'
1037
1038     occ_fs :: FastString
1039     occ_fs = mkFastString (TH.nameBase th_name)
1040
1041     occ :: OccName
1042     occ | is_type_name
1043         = if isLexCon occ_fs then mkTcOccFS    occ_fs
1044                              else mkTyVarOccFS occ_fs
1045         | otherwise
1046         = if isLexCon occ_fs then mkDataOccFS occ_fs
1047                              else mkVarOccFS  occ_fs
1048
1049     rdr_name = case TH.nameModule th_name of
1050                  Nothing  -> mkRdrUnqual occ
1051                  Just mod -> mkRdrQual (mkModuleName mod) occ
1052
1053 getThing :: TH.Name -> TcM TcTyThing
1054 getThing th_name
1055   = do  { name <- lookupThName th_name
1056         ; traceIf (text "reify" <+> text (show th_name) <+> brackets (ppr_ns th_name) <+> ppr name)
1057         ; tcLookupTh name }
1058         -- ToDo: this tcLookup could fail, which would give a
1059         --       rather unhelpful error message
1060   where
1061     ppr_ns (TH.Name _ (TH.NameG TH.DataName _pkg _mod)) = text "data"
1062     ppr_ns (TH.Name _ (TH.NameG TH.TcClsName _pkg _mod)) = text "tc"
1063     ppr_ns (TH.Name _ (TH.NameG TH.VarName _pkg _mod)) = text "var"
1064     ppr_ns _ = panic "reify/ppr_ns"
1065
1066 reify :: TH.Name -> TcM TH.Info
1067 reify th_name
1068   = do  { thing <- getThing th_name
1069         ; reifyThing thing }
1070
1071 lookupThName :: TH.Name -> TcM Name
1072 lookupThName th_name = do
1073     mb_name <- lookupThName_maybe th_name
1074     case mb_name of
1075         Nothing   -> failWithTc (notInScope th_name)
1076         Just name -> return name
1077
1078 lookupThName_maybe th_name
1079   =  do { names <- mapMaybeM lookup (thRdrNameGuesses th_name)
1080           -- Pick the first that works
1081           -- E.g. reify (mkName "A") will pick the class A in preference to the data constructor A
1082         ; return (listToMaybe names) }
1083   where
1084     lookup rdr_name
1085         = do {  -- Repeat much of lookupOccRn, becase we want
1086                 -- to report errors in a TH-relevant way
1087              ; rdr_env <- getLocalRdrEnv
1088              ; case lookupLocalRdrEnv rdr_env rdr_name of
1089                  Just name -> return (Just name)
1090                  Nothing   -> lookupGlobalOccRn_maybe rdr_name }
1091
1092 tcLookupTh :: Name -> TcM TcTyThing
1093 -- This is a specialised version of TcEnv.tcLookup; specialised mainly in that
1094 -- it gives a reify-related error message on failure, whereas in the normal
1095 -- tcLookup, failure is a bug.
1096 tcLookupTh name
1097   = do  { (gbl_env, lcl_env) <- getEnvs
1098         ; case lookupNameEnv (tcl_env lcl_env) name of {
1099                 Just thing -> return thing;
1100                 Nothing    -> do
1101         { if nameIsLocalOrFrom (tcg_mod gbl_env) name
1102           then  -- It's defined in this module
1103               case lookupNameEnv (tcg_type_env gbl_env) name of
1104                 Just thing -> return (AGlobal thing)
1105                 Nothing    -> failWithTc (notInEnv name)
1106
1107           else do               -- It's imported
1108         { (eps,hpt) <- getEpsAndHpt
1109         ; dflags <- getDOpts
1110         ; case lookupType dflags hpt (eps_PTE eps) name of
1111             Just thing -> return (AGlobal thing)
1112             Nothing    -> do { thing <- tcImportDecl name
1113                              ; return (AGlobal thing) }
1114                 -- Imported names should always be findable;
1115                 -- if not, we fail hard in tcImportDecl
1116     }}}}
1117
1118 notInScope :: TH.Name -> SDoc
1119 notInScope th_name = quotes (text (TH.pprint th_name)) <+>
1120                      ptext (sLit "is not in scope at a reify")
1121         -- Ugh! Rather an indirect way to display the name
1122
1123 notInEnv :: Name -> SDoc
1124 notInEnv name = quotes (ppr name) <+>
1125                      ptext (sLit "is not in the type environment at a reify")
1126
1127 ------------------------------
1128 reifyThing :: TcTyThing -> TcM TH.Info
1129 -- The only reason this is monadic is for error reporting,
1130 -- which in turn is mainly for the case when TH can't express
1131 -- some random GHC extension
1132
1133 reifyThing (AGlobal (AnId id))
1134   = do  { ty <- reifyType (idType id)
1135         ; fix <- reifyFixity (idName id)
1136         ; let v = reifyName id
1137         ; case idDetails id of
1138             ClassOpId cls -> return (TH.ClassOpI v ty (reifyName cls) fix)
1139             _             -> return (TH.VarI     v ty Nothing fix)
1140     }
1141
1142 reifyThing (AGlobal (ATyCon tc))   = reifyTyCon tc
1143 reifyThing (AGlobal (ACoAxiom ax)) = reifyAxiom ax
1144 reifyThing (AGlobal (ADataCon dc))
1145   = do  { let name = dataConName dc
1146         ; ty <- reifyType (idType (dataConWrapId dc))
1147         ; fix <- reifyFixity name
1148         ; return (TH.DataConI (reifyName name) ty
1149                               (reifyName (dataConOrigTyCon dc)) fix)
1150         }
1151
1152 reifyThing (ATcId {tct_id = id})
1153   = do  { ty1 <- zonkTcType (idType id) -- Make use of all the info we have, even
1154                                         -- though it may be incomplete
1155         ; ty2 <- reifyType ty1
1156         ; fix <- reifyFixity (idName id)
1157         ; return (TH.VarI (reifyName id) ty2 Nothing fix) }
1158
1159 reifyThing (ATyVar tv ty)
1160   = do  { ty1 <- zonkTcType ty
1161         ; ty2 <- reifyType ty1
1162         ; return (TH.TyVarI (reifyName tv) ty2) }
1163
1164 reifyThing (AThing {}) = panic "reifyThing AThing"
1165 reifyThing ANothing = panic "reifyThing ANothing"
1166
1167 ------------------------------
1168 reifyAxiom :: CoAxiom -> TcM TH.Info
1169 reifyAxiom ax@(CoAxiom { co_ax_lhs = lhs, co_ax_rhs = rhs })
1170   | Just (tc, args) <- tcSplitTyConApp_maybe lhs
1171   = do { args' <- mapM reifyType args
1172        ; rhs'  <- reifyType rhs
1173        ; return (TH.TyConI (TH.TySynInstD (reifyName tc) args' rhs') )}
1174   | otherwise
1175   = failWith (ptext (sLit "Can't reify the axiom") <+> ppr ax
1176               <+> dcolon <+> pprEqPred (Pair lhs rhs))
1177
1178 reifyTyCon :: TyCon -> TcM TH.Info
1179 reifyTyCon tc
1180   | Just cls <- tyConClass_maybe tc
1181   = reifyClass cls
1182
1183   | isFunTyCon tc
1184   = return (TH.PrimTyConI (reifyName tc) 2                False)
1185
1186   | isPrimTyCon tc
1187   = return (TH.PrimTyConI (reifyName tc) (tyConArity tc) (isUnLiftedTyCon tc))
1188
1189   | isFamilyTyCon tc
1190   = do { let flavour = reifyFamFlavour tc
1191              tvs     = tyConTyVars tc
1192              kind    = tyConKind tc
1193        ; kind' <- if isLiftedTypeKind kind then return Nothing
1194                   else fmap Just (reifyKind kind)
1195
1196        ; fam_envs <- tcGetFamInstEnvs
1197        ; instances <- mapM reifyFamilyInstance (familyInstances fam_envs tc)
1198        ; tvs' <- reifyTyVars tvs
1199        ; return (TH.FamilyI
1200                     (TH.FamilyD flavour (reifyName tc) tvs' kind')
1201                     instances) }
1202
1203   | isSynTyCon tc
1204   = do { let (tvs, rhs) = synTyConDefn tc
1205        ; rhs' <- reifyType rhs
1206        ; tvs' <- reifyTyVars tvs
1207        ; return (TH.TyConI
1208                    (TH.TySynD (reifyName tc) tvs' rhs'))
1209        }
1210
1211   | otherwise
1212   = do  { cxt <- reifyCxt (tyConStupidTheta tc)
1213         ; let tvs = tyConTyVars tc
1214         ; cons <- mapM (reifyDataCon (mkTyVarTys tvs)) (tyConDataCons tc)
1215         ; r_tvs <- reifyTyVars tvs
1216         ; let name = reifyName tc
1217               deriv = []        -- Don't know about deriving
1218               decl | isNewTyCon tc = TH.NewtypeD cxt name r_tvs (head cons) deriv
1219                    | otherwise     = TH.DataD    cxt name r_tvs cons        deriv
1220         ; return (TH.TyConI decl) }
1221
1222 reifyDataCon :: [Type] -> DataCon -> TcM TH.Con
1223 -- For GADTs etc, see Note [Reifying data constructors]
1224 reifyDataCon tys dc
1225   = do { let (tvs, theta, arg_tys, _) = dataConSig dc
1226              subst             = mkTopTvSubst (tvs `zip` tys)   -- Dicard ex_tvs
1227              (subst', ex_tvs') = mapAccumL substTyVarBndr subst (dropList tys tvs)
1228              theta'   = substTheta subst' theta
1229              arg_tys' = substTys subst' arg_tys
1230              stricts  = map reifyStrict (dataConStrictMarks dc)
1231              fields   = dataConFieldLabels dc
1232              name     = reifyName dc
1233
1234        ; r_arg_tys <- reifyTypes arg_tys'
1235
1236        ; let main_con | not (null fields)
1237                       = TH.RecC name (zip3 (map reifyName fields) stricts r_arg_tys)
1238                       | dataConIsInfix dc
1239                       = ASSERT( length arg_tys == 2 )
1240                         TH.InfixC (s1,r_a1) name (s2,r_a2)
1241                       | otherwise
1242                       = TH.NormalC name (stricts `zip` r_arg_tys)
1243              [r_a1, r_a2] = r_arg_tys
1244              [s1,   s2]   = stricts
1245
1246        ; ASSERT( length arg_tys == length stricts )
1247          if null ex_tvs' && null theta then
1248              return main_con
1249          else do
1250          { cxt <- reifyCxt theta'
1251          ; ex_tvs'' <- reifyTyVars ex_tvs'
1252          ; return (TH.ForallC ex_tvs'' cxt main_con) } }
1253
1254 ------------------------------
1255 reifyClass :: Class -> TcM TH.Info
1256 reifyClass cls
1257   = do  { cxt <- reifyCxt theta
1258         ; inst_envs <- tcGetInstEnvs
1259         ; insts <- mapM reifyClassInstance (InstEnv.classInstances inst_envs cls)
1260         ; ops <- mapM reify_op op_stuff
1261         ; tvs' <- reifyTyVars tvs
1262         ; let dec = TH.ClassD cxt (reifyName cls) tvs' fds' ops
1263         ; return (TH.ClassI dec insts ) }
1264   where
1265     (tvs, fds, theta, _, _, op_stuff) = classExtraBigSig cls
1266     fds' = map reifyFunDep fds
1267     reify_op (op, _) = do { ty <- reifyType (idType op)
1268                           ; return (TH.SigD (reifyName op) ty) }
1269
1270 ------------------------------
1271 reifyClassInstance :: ClsInst -> TcM TH.Dec
1272 reifyClassInstance i
1273   = do { cxt <- reifyCxt theta
1274        ; thtypes <- reifyTypes types
1275        ; let head_ty = foldl TH.AppT (TH.ConT (reifyName cls)) thtypes
1276        ; return $ (TH.InstanceD cxt head_ty []) }
1277   where
1278      (_tvs, theta, cls, types) = instanceHead i
1279
1280 ------------------------------
1281 reifyFamilyInstance :: FamInst -> TcM TH.Dec
1282 reifyFamilyInstance fi
1283   = case fi_flavor fi of
1284       SynFamilyInst ->
1285         do { th_tys <- reifyTypes (fi_tys fi)
1286            ; rhs_ty <- reifyType (coAxiomRHS rep_ax)
1287            ; return (TH.TySynInstD fam th_tys rhs_ty) }
1288
1289       DataFamilyInst rep_tc ->
1290         do { let tvs = tyConTyVars rep_tc
1291                  fam = reifyName (fi_fam fi)
1292            ; cons <- mapM (reifyDataCon (mkTyVarTys tvs)) (tyConDataCons rep_tc)
1293            ; th_tys <- reifyTypes (fi_tys fi)
1294            ; return (if isNewTyCon rep_tc
1295                      then TH.NewtypeInstD [] fam th_tys (head cons) []
1296                      else TH.DataInstD    [] fam th_tys cons        []) }
1297   where
1298     rep_ax = fi_axiom fi
1299     fam = reifyName (fi_fam fi)
1300
1301 ------------------------------
1302 reifyType :: TypeRep.Type -> TcM TH.Type
1303 -- Monadic only because of failure
1304 reifyType ty@(ForAllTy _ _)        = reify_for_all ty
1305 reifyType (TyVarTy tv)      = return (TH.VarT (reifyName tv))
1306 reifyType (TyConApp tc tys) = reify_tc_app tc tys   -- Do not expand type synonyms here
1307 reifyType (AppTy t1 t2)     = do { [r1,r2] <- reifyTypes [t1,t2] ; return (r1 `TH.AppT` r2) }
1308 reifyType ty@(FunTy t1 t2)
1309   | isPredTy t1 = reify_for_all ty  -- Types like ((?x::Int) => Char -> Char)
1310   | otherwise   = do { [r1,r2] <- reifyTypes [t1,t2] ; return (TH.ArrowT `TH.AppT` r1 `TH.AppT` r2) }
1311 reifyType (LiteralTy _)    = failWith $ ptext $ sLit "Type-level literal canont be reifyed yet."
1312
1313 reify_for_all :: TypeRep.Type -> TcM TH.Type
1314 reify_for_all ty
1315   = do { cxt' <- reifyCxt cxt;
1316        ; tau' <- reifyType tau
1317        ; tvs' <- reifyTyVars tvs
1318        ; return (TH.ForallT tvs' cxt' tau') }
1319   where
1320     (tvs, cxt, tau) = tcSplitSigmaTy ty
1321
1322 reifyTypes :: [Type] -> TcM [TH.Type]
1323 reifyTypes = mapM reifyType
1324
1325 reifyKind :: Kind -> TcM TH.Kind
1326 reifyKind  ki
1327   = do { let (kis, ki') = splitKindFunTys ki
1328        ; ki'_rep <- reifyNonArrowKind ki'
1329        ; kis_rep <- mapM reifyKind kis
1330        ; return (foldr TH.ArrowK ki'_rep kis_rep) }
1331   where
1332     reifyNonArrowKind k | isLiftedTypeKind k = return TH.StarK 
1333                         | otherwise          = noTH (sLit "this kind") (ppr k)
1334
1335 reifyCxt :: [PredType] -> TcM [TH.Pred]
1336 reifyCxt   = mapM reifyPred
1337
1338 reifyFunDep :: ([TyVar], [TyVar]) -> TH.FunDep
1339 reifyFunDep (xs, ys) = TH.FunDep (map reifyName xs) (map reifyName ys)
1340
1341 reifyFamFlavour :: TyCon -> TH.FamFlavour
1342 reifyFamFlavour tc | isSynFamilyTyCon tc = TH.TypeFam
1343                    | isFamilyTyCon    tc = TH.DataFam
1344                    | otherwise
1345                    = panic "TcSplice.reifyFamFlavour: not a type family"
1346
1347 reifyTyVars :: [TyVar] -> TcM [TH.TyVarBndr]
1348 reifyTyVars = mapM reifyTyVar
1349   where
1350     reifyTyVar tv | isLiftedTypeKind kind = return (TH.PlainTV  name)
1351                   | otherwise             = do kind' <- reifyKind kind
1352                                                return (TH.KindedTV name kind')
1353       where
1354         kind = tyVarKind tv
1355         name = reifyName tv
1356
1357 reify_tc_app :: TyCon -> [TypeRep.Type] -> TcM TH.Type
1358 reify_tc_app tc tys
1359   = do { tys' <- reifyTypes tys
1360        ; return (foldl TH.AppT r_tc tys') }
1361   where
1362     r_tc | isTupleTyCon tc          = TH.TupleT (tyConArity tc)
1363          | tc `hasKey` listTyConKey = TH.ListT
1364          | otherwise                = TH.ConT (reifyName tc)
1365
1366 reifyPred :: TypeRep.PredType -> TcM TH.Pred
1367 reifyPred ty = case classifyPredType ty of
1368   ClassPred cls tys -> do { tys' <- reifyTypes tys 
1369                           ; return $ TH.ClassP (reifyName cls) tys' }
1370   IPPred _ _        -> noTH (sLit "implicit parameters") (ppr ty)
1371   EqPred ty1 ty2    -> do { ty1' <- reifyType ty1
1372                           ; ty2' <- reifyType ty2
1373                           ; return $ TH.EqualP ty1' ty2'
1374                           }
1375   TuplePred _ -> noTH (sLit "tuple predicates") (ppr ty)
1376   IrredPred _ -> noTH (sLit "irreducible predicates") (ppr ty)
1377
1378
1379 ------------------------------
1380 reifyName :: NamedThing n => n -> TH.Name
1381 reifyName thing
1382   | isExternalName name = mk_varg pkg_str mod_str occ_str
1383   | otherwise           = TH.mkNameU occ_str (getKey (getUnique name))
1384         -- Many of the things we reify have local bindings, and
1385         -- NameL's aren't supposed to appear in binding positions, so
1386         -- we use NameU.  When/if we start to reify nested things, that
1387         -- have free variables, we may need to generate NameL's for them.
1388   where
1389     name    = getName thing
1390     mod     = ASSERT( isExternalName name ) nameModule name
1391     pkg_str = packageIdString (modulePackageId mod)
1392     mod_str = moduleNameString (moduleName mod)
1393     occ_str = occNameString occ
1394     occ     = nameOccName name
1395     mk_varg | OccName.isDataOcc occ = TH.mkNameG_d
1396             | OccName.isVarOcc  occ = TH.mkNameG_v
1397             | OccName.isTcOcc   occ = TH.mkNameG_tc
1398             | otherwise             = pprPanic "reifyName" (ppr name)
1399
1400 ------------------------------
1401 reifyFixity :: Name -> TcM TH.Fixity
1402 reifyFixity name
1403   = do  { fix <- lookupFixityRn name
1404         ; return (conv_fix fix) }
1405     where
1406       conv_fix (BasicTypes.Fixity i d) = TH.Fixity i (conv_dir d)
1407       conv_dir BasicTypes.InfixR = TH.InfixR
1408       conv_dir BasicTypes.InfixL = TH.InfixL
1409       conv_dir BasicTypes.InfixN = TH.InfixN
1410
1411 reifyStrict :: BasicTypes.HsBang -> TH.Strict
1412 reifyStrict bang | bang == HsUnpack = TH.Unpacked
1413                  | isBanged bang    = TH.IsStrict
1414                  | otherwise        = TH.NotStrict
1415
1416 ------------------------------
1417 noTH :: LitString -> SDoc -> TcM a
1418 noTH s d = failWithTc (hsep [ptext (sLit "Can't represent") <+> ptext s <+>
1419                                 ptext (sLit "in Template Haskell:"),
1420                              nest 2 d])
1421
1422 ppr_th :: TH.Ppr a => a -> SDoc
1423 ppr_th x = text (TH.pprint x)
1424 \end{code}
1425
1426 Note [Reifying data constructors]
1427 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1428 Template Haskell syntax is rich enough to express even GADTs,
1429 provided we do so in the equality-predicate form.  So a GADT
1430 like
1431
1432   data T a where
1433      MkT1 :: a -> T [a]
1434      MkT2 :: T Int
1435
1436 will appear in TH syntax like this
1437
1438   data T a = forall b. (a ~ [b]) => MkT1 b
1439            | (a ~ Int) => MkT2
1440