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