DsMeta.hs 101 KB
Newer Older
1
-----------------------------------------------------------------------------
Simon Marlow's avatar
Simon Marlow committed
2
3
4
--
-- (c) The University of Glasgow 2006
--
5
6
7
8
-- The purpose of this module is to transform an HsExpr into a CoreExpr which
-- when evaluated, returns a (Meta.Q Meta.Exp) computation analogous to the
-- input HsExpr. We do this in the DsM monad, which supplies access to
-- CoreExpr's of the "smart constructors" of the Meta.Exp datatype.
9
10
11
12
13
--
-- It also defines a bunch of knownKeyNames, in the same way as is done
-- in prelude/PrelNames.  It's much more convenient to do it here, becuase
-- otherwise we have to recompile PrelNames whenever we add a Name, which is
-- a Royal Pain (triggers other recompilation).
14
15
-----------------------------------------------------------------------------

Ian Lynagh's avatar
Ian Lynagh committed
16
17
18
19
20
21
22
{-# OPTIONS -fno-warn-tabs #-}
-- The above warning supression flag is a temporary kludge.
-- While working on this module you are encouraged to remove it and
-- detab the module (please do the detabbing in a separate patch). See
--     http://hackage.haskell.org/trac/ghc/wiki/Commentary/CodingStyle#TabsvsSpaces
-- for details

23
module DsMeta( dsBracket,
24
	       templateHaskellNames, qTyConName, nameTyConName,
25
	       liftName, liftStringName, expQTyConName, patQTyConName,
26
               decQTyConName, decsQTyConName, typeQTyConName,
27
	       decTyConName, typeTyConName, mkNameG_dName, mkNameG_vName, mkNameG_tcName,
28
	       quoteExpName, quotePatName, quoteDecName, quoteTypeName
29
	        ) where
30

31
32
#include "HsVersions.h"

33
34
import {-# SOURCE #-}	DsExpr ( dsExpr )

Simon Marlow's avatar
Simon Marlow committed
35
import MatchLit
36
37
import DsMonad

38
import qualified Language.Haskell.TH as TH
39

40
import HsSyn
Simon Marlow's avatar
Simon Marlow committed
41
42
43
44
45
46
import Class
import PrelNames
-- To avoid clashes with DsMeta.varName we must make a local alias for
-- OccName.varName we do this by removing varName from the import of
-- OccName above, making a qualified instance of OccName and using
-- OccNameAlias.varName where varName ws previously used in this file.
47
import qualified OccName( isDataOcc, isVarOcc, isTcOcc, varName, tcName, dataName )
48

Simon Marlow's avatar
Simon Marlow committed
49
50
import Module
import Id
51
import Name hiding( isVarOcc, isTcOcc, varName, tcName )
52
import NameEnv
Simon Marlow's avatar
Simon Marlow committed
53
54
55
import TcType
import TyCon
import TysWiredIn
56
import TysPrim ( liftedTypeKindTyConName, constraintKindTyConName )
57
import CoreSyn
58
import MkCore
Simon Marlow's avatar
Simon Marlow committed
59
60
61
62
import CoreUtils
import SrcLoc
import Unique
import BasicTypes
63
import Outputable
Simon Marlow's avatar
Simon Marlow committed
64
import Bag
65
import DynFlags
Simon Marlow's avatar
Simon Marlow committed
66
67
import FastString
import ForeignCall
68
import MonadUtils
69
import Util
70

Simon Marlow's avatar
Simon Marlow committed
71
72
73
import Data.Maybe
import Control.Monad
import Data.List
Ian Lynagh's avatar
Ian Lynagh committed
74

75
76
-----------------------------------------------------------------------------
dsBracket :: HsBracket Name -> [PendingSplice] -> DsM CoreExpr
77
-- Returns a CoreExpr of type TH.ExpQ
78
79
80
-- The quoted thing is parameterised over Name, even though it has
-- been type checked.  We don't want all those type decorations!

81
82
dsBracket brack splices
  = dsExtendMetaEnv new_bit (do_brack brack)
83
  where
84
    new_bit = mkNameEnv [(n, Splice (unLoc e)) | (n,e) <- splices]
85

dreixel's avatar
dreixel committed
86
    do_brack (VarBr _ n) = do { MkC e1  <- lookupOcc n ; return e1 }
87
88
89
90
91
    do_brack (ExpBr e)   = do { MkC e1  <- repLE e     ; return e1 }
    do_brack (PatBr p)   = do { MkC p1  <- repTopP p   ; return p1 }
    do_brack (TypBr t)   = do { MkC t1  <- repLTy t    ; return t1 }
    do_brack (DecBrG gp) = do { MkC ds1 <- repTopDs gp ; return ds1 }
    do_brack (DecBrL _)  = panic "dsBracket: unexpected DecBrL"
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107

{- -------------- Examples --------------------

  [| \x -> x |]
====>
  gensym (unpackString "x"#) `bindQ` \ x1::String ->
  lam (pvar x1) (var x1)


  [| \x -> $(f [| x |]) |]
====>
  gensym (unpackString "x"#) `bindQ` \ x1::String ->
  lam (pvar x1) (f (var x1))
-}


108
109
110
111
-------------------------------------------------------
-- 			Declarations
-------------------------------------------------------

112
repTopP :: LPat Name -> DsM (Core TH.PatQ)
113
repTopP pat = do { ss <- mkGenSyms (collectPatBinders pat)
114
                 ; pat' <- addBinds ss (repLP pat)
115
                 ; wrapGenSyms ss pat' }
116

117
repTopDs :: HsGroup Name -> DsM (Core (TH.Q [TH.Dec]))
118
repTopDs group
119
120
 = do { let { tv_bndrs = hsSigTvBinders (hs_valds group)
            ; bndrs = tv_bndrs ++ hsGroupBinders group } ;
121
	ss <- mkGenSyms bndrs ;
122

123
124
125
126
127
	-- Bind all the names mainly to avoid repeated use of explicit strings.
	-- Thus	we get
	--	do { t :: String <- genSym "T" ;
	--	     return (Data t [] ...more t's... }
	-- The other important reason is that the output must mention
128
	-- only "T", not "Foo:T" where Foo is the current module
129

130
	decls <- addBinds ss (do {
131
                        fix_ds  <- mapM repFixD (hs_fixds group) ;
132
			val_ds  <- rep_val_binds (hs_valds group) ;
133
			tycl_ds <- mapM repTyClD (concat (hs_tyclds group)) ;
134
			inst_ds <- mapM repInstD (hs_instds group) ;
mikhail.vorozhtsov's avatar
mikhail.vorozhtsov committed
135
136
			rule_ds <- mapM repRuleD (hs_ruleds group) ;
			for_ds  <- mapM repForD  (hs_fords group) ;
137
			-- more needed
138
			return (de_loc $ sort_by_loc $
139
                                val_ds ++ catMaybes tycl_ds ++ fix_ds
mikhail.vorozhtsov's avatar
mikhail.vorozhtsov committed
140
                                       ++ inst_ds ++ rule_ds ++ for_ds) }) ;
141

142
	decl_ty <- lookupType decQTyConName ;
143
	let { core_list = coreList' decl_ty decls } ;
144
145
146

	dec_ty <- lookupType decTyConName ;
	q_decs  <- repSequenceQ dec_ty core_list ;
147

148
	wrapGenSyms ss q_decs
149
150
151
      }


152
153
154
hsSigTvBinders :: HsValBinds Name -> [Name]
-- See Note [Scoped type variables in bindings]
hsSigTvBinders binds
155
156
  = [hsLTyVarName tv | L _ (TypeSig _ (L _ (HsForAllTy Explicit qtvs _ _))) <- sigs
                     , tv <- hsQTvBndrs qtvs]
157
158
159
160
161
162
163
164
165
166
167
168
169
170
  where
    sigs = case binds of
     	     ValBindsIn  _ sigs -> sigs
     	     ValBindsOut _ sigs -> sigs


{- Notes

Note [Scoped type variables in bindings]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Consider
   f :: forall a. a -> a
   f x = x::a
Here the 'forall a' brings 'a' into scope over the binding group.
171
To achieve this we
172
173
174
175
176
177
178
179
180
181

  a) Gensym a binding for 'a' at the same time as we do one for 'f'
     collecting the relevant binders with hsSigTvBinders

  b) When processing the 'forall', don't gensym

The relevant places are signposted with references to this Note

Note [Binders and occurrences]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
182
183
184
185
186
187
188
189
190
191
When we desugar [d| data T = MkT |]
we want to get
	Data "T" [] [Con "MkT" []] []
and *not*
	Data "Foo:T" [] [Con "Foo:MkT" []] []
That is, the new data decl should fit into whatever new module it is
asked to fit in.   We do *not* clone, though; no need for this:
	Data "T79" ....

But if we see this:
192
	data T = MkT
193
194
195
196
197
	foo = reifyDecl T

then we must desugar to
	foo = Data "Foo:T" [] [Con "Foo:MkT" []] []

198
199
So in repTopDs we bring the binders into scope with mkGenSyms and addBinds.
And we use lookupOcc, rather than lookupBinder
200
201
202
203
in repTyClD and repC.

-}

204
205
206
207
208
209
-- represent associated family instances
--
repTyClDs :: [LTyClDecl Name] -> DsM [Core TH.DecQ]
repTyClDs ds = liftM de_loc (mapMaybeM repTyClD ds)


210
repTyClD :: LTyClDecl Name -> DsM (Maybe (SrcSpan, Core TH.DecQ))
211

212
213
214
215
216
217
repTyClD (L loc (TyFamily { tcdFlavour = flavour,
		            tcdLName   = tc, tcdTyVars = tvs, 
		            tcdKindSig = opt_kind }))
  = do { tc1 <- lookupLOcc tc 		-- See note [Binders and occurrences] 
       ; dec <- addTyClTyVarBinds tvs $ \bndrs ->
           do { flav   <- repFamilyFlavour flavour
218
219
	      ; case opt_kind of 
                  Nothing -> repFamilyNoKind flav tc1 bndrs
220
                  Just ki -> do { ki1 <- repLKind ki 
221
                                ; repFamilyKind flav tc1 bndrs ki1 }
222
223
224
              }
       ; return $ Just (loc, dec)
       }
225

226
227
228
repTyClD (L loc (TyDecl { tcdLName = tc, tcdTyVars = tvs, tcdTyDefn = defn }))
  = do { tc1 <- lookupLOcc tc 		-- See note [Binders and occurrences]  
       ; tc_tvs <- mk_extra_tvs tc tvs defn
229
       ; dec <- addTyClTyVarBinds tc_tvs $ \bndrs -> 
230
231
	        repTyDefn tc1 bndrs Nothing (hsLTyVarNames tc_tvs) defn
       ; return (Just (loc, dec)) }
232

233
repTyClD (L loc (ClassDecl { tcdCtxt = cxt, tcdLName = cls, 
234
235
		             tcdTyVars = tvs, tcdFDs = fds,
		             tcdSigs = sigs, tcdMeths = meth_binds, 
236
                             tcdATs = ats, tcdATDefs = [] }))
237
238
239
240
241
242
  = do { cls1 <- lookupLOcc cls 	-- See note [Binders and occurrences] 
       ; dec  <- addTyVarBinds tvs $ \bndrs -> 
           do { cxt1   <- repLContext cxt
 	      ; sigs1  <- rep_sigs sigs
 	      ; binds1 <- rep_binds meth_binds
	      ; fds1   <- repLFunDeps fds
243
              ; ats1   <- repTyClDs ats
244
 	      ; decls1 <- coreList decQTyConName (ats1 ++ sigs1 ++ binds1)
245
 	      ; repClass cxt1 cls1 bndrs fds1 decls1 
246
247
248
              }
       ; return $ Just (loc, dec) 
       }
249
250

-- Un-handled cases
251
repTyClD (L loc d) = putSrcSpanDs loc $
252
		     do { warnDs (hang ds_msg 4 (ppr d))
253
			; return Nothing }
254

255
-------------------------
256
repTyDefn :: Core TH.Name -> Core [TH.TyVarBndr]
257
258
259
260
261
262
263
264
265
266
267
          -> Maybe (Core [TH.TypeQ])
          -> [Name] -> HsTyDefn Name
          -> DsM (Core TH.DecQ)
repTyDefn tc bndrs opt_tys tv_names
          (TyData { td_ND = new_or_data, td_ctxt = cxt
		  , td_cons = cons, td_derivs = mb_derivs })
  = do { cxt1     <- repLContext cxt
       ; derivs1  <- repDerivs mb_derivs
       ; case new_or_data of
           NewType  -> do { con1 <- repC tv_names (head cons)
                          ; repNewtype cxt1 tc bndrs opt_tys con1 derivs1 }
268
269
           DataType -> do { cons1 <- repList conQTyConName (repC tv_names) cons
                          ; repData cxt1 tc bndrs opt_tys cons1 derivs1 } }
270
271
272
273
274
275

repTyDefn tc bndrs opt_tys _ (TySynonym { td_synRhs = ty })
  = do { ty1 <- repLTy ty
       ; repTySyn tc bndrs opt_tys ty1 }

-------------------------
276
277
mk_extra_tvs :: Located Name -> LHsTyVarBndrs Name 
             -> HsTyDefn Name -> DsM (LHsTyVarBndrs Name)
278
279
280
-- If there is a kind signature it must be of form
--    k1 -> .. -> kn -> *
-- Return type variables [tv1:k1, tv2:k2, .., tvn:kn]
281
mk_extra_tvs tc tvs defn
282
  | TyData { td_kindSig = Just hs_kind } <- defn
283
  = do { extra_tvs <- go hs_kind
284
       ; return (tvs { hsq_tvs = hsq_tvs tvs ++ extra_tvs }) }
285
286
  | otherwise
  = return tvs
287
288
289
290
291
292
  where
    go :: LHsKind Name -> DsM [LHsTyVarBndr Name]
    go (L loc (HsFunTy kind rest))
      = do { uniq <- newUnique
           ; let { occ = mkTyVarOccFS (fsLit "t")
                 ; nm = mkInternalName uniq occ loc
293
                 ; hs_tv = L loc (KindedTyVar nm kind) }
294
295
296
297
298
299
           ; hs_tvs <- go rest
           ; return (hs_tv : hs_tvs) }

    go (L _ (HsTyVar n))
      | n == liftedTypeKindTyConName
      = return []
300

301
    go _ = failWithDs (ptext (sLit "Malformed kind signature for") <+> ppr tc)
302
303

-------------------------
304
305
306
-- represent fundeps
--
repLFunDeps :: [Located (FunDep Name)] -> DsM (Core [TH.FunDep])
307
repLFunDeps fds = repList funDepTyConName repLFunDep fds
308
309

repLFunDep :: Located (FunDep Name) -> DsM (Core TH.FunDep)
310
311
312
repLFunDep (L _ (xs, ys)) = do xs' <- repList nameTyConName lookupBinder xs
                               ys' <- repList nameTyConName lookupBinder ys
                               repFunDep xs' ys'
313

314
315
316
317
318
319
-- represent family declaration flavours
--
repFamilyFlavour :: FamilyFlavour -> DsM (Core TH.FamFlavour)
repFamilyFlavour TypeFamily = rep2 typeFamName []
repFamilyFlavour DataFamily = rep2 dataFamName []

320
321
322
-- Represent instance declarations
--
repInstD :: LInstDecl Name -> DsM (SrcSpan, Core TH.DecQ)
323
repInstD (L loc (FamInstD { lid_inst = fi_decl }))
324
325
  = do { dec <- repFamInstD fi_decl
       ; return (loc, dec) }
326

327
328
repInstD (L loc (ClsInstD { cid_poly_ty = ty, cid_binds = binds
                          , cid_sigs = prags, cid_fam_insts = ats }))
329
330
  = do { dec <- addTyVarBinds tvs $ \_ ->
	    -- We must bring the type variables into scope, so their
331
	    -- occurrences don't fail, even though the binders don't
332
333
334
335
336
337
338
339
            -- appear in the resulting data structure
	    --
	    -- But we do NOT bring the binders of 'binds' into scope
	    -- becuase they are properly regarded as occurrences
	    -- For example, the method names should be bound to
	    -- the selector Ids, not to fresh names (Trac #5410)
	    --
            do { cxt1 <- repContext cxt
340
               ; cls_tcon <- repTy (HsTyVar (unLoc cls))
batterseapower's avatar
batterseapower committed
341
342
               ; cls_tys <- repLTys tys
               ; inst_ty1 <- repTapps cls_tcon cls_tys
343
               ; binds1 <- rep_binds binds
344
               ; prags1 <- rep_sigs prags
345
               ; ats1 <- mapM (repFamInstD . unLoc) ats
346
               ; decls <- coreList decQTyConName (ats1 ++ binds1 ++ prags1)
347
               ; repInst cxt1 inst_ty1 decls }
348
       ; return (loc, dec) }
349
 where
350
   Just (tvs, cxt, cls, tys) = splitLHsInstDeclTy_maybe ty
351

352
repFamInstD :: FamInstDecl Name -> DsM (Core TH.DecQ)
353
repFamInstD (FamInstDecl { fid_tycon = tc_name
354
                         , fid_pats = HsWB { hswb_cts = tys, hswb_kvs = kv_names, hswb_tvs = tv_names }
355
356
357
358
                         , fid_defn = defn })
  = WARN( not (null kv_names), ppr kv_names )   -- We have not yet dealt with kind 
                                                -- polymorphism in Template Haskell (sigh)
    do { tc <- lookupLOcc tc_name 		-- See note [Binders and occurrences]  
359
       ; let loc = getLoc tc_name
360
             hs_tvs = HsQTvs { hsq_kvs = kv_names, hsq_tvs = userHsTyVarBndrs loc tv_names }   -- Yuk
361
       ; addTyClTyVarBinds hs_tvs $ \ bndrs ->
362
363
         do { tys1 <- repList typeQTyConName repLTy tys
            ; repTyDefn tc bndrs (Just tys1) tv_names defn } }
364

365
repForD :: Located (ForeignDecl Name) -> DsM (SrcSpan, Core TH.DecQ)
366
repForD (L loc (ForeignImport name typ _ (CImport cc s mch cis)))
367
368
369
370
 = do MkC name' <- lookupLOcc name
      MkC typ' <- repLTy typ
      MkC cc' <- repCCallConv cc
      MkC s' <- repSafety s
371
      cis' <- conv_cimportspec cis
372
      MkC str <- coreStringLit (static ++ chStr ++ cis')
373
374
375
      dec <- rep2 forImpDName [cc', s', str, name', typ']
      return (loc, dec)
 where
376
377
    conv_cimportspec (CLabel cls) = notHandled "Foreign label" (doubleQuotes (ppr cls))
    conv_cimportspec (CFunction DynamicTarget) = return "dynamic"
378
379
    conv_cimportspec (CFunction (StaticTarget fs _ True)) = return (unpackFS fs)
    conv_cimportspec (CFunction (StaticTarget _  _ False)) = panic "conv_cimportspec: values not supported yet"
380
    conv_cimportspec CWrapper = return "wrapper"
381
    static = case cis of
382
                 CFunction (StaticTarget _ _ _) -> "static "
383
                 _ -> ""
384
385
386
    chStr = case mch of
            Nothing -> ""
            Just (Header h) -> unpackFS h ++ " "
387
repForD decl = notHandled "Foreign declaration" (ppr decl)
388
389
390
391

repCCallConv :: CCallConv -> DsM (Core TH.Callconv)
repCCallConv CCallConv = rep2 cCallName []
repCCallConv StdCallConv = rep2 stdCallName []
392
repCCallConv callConv    = notHandled "repCCallConv" (ppr callConv)
393
394
395

repSafety :: Safety -> DsM (Core TH.Safety)
repSafety PlayRisky = rep2 unsafeName []
396
repSafety PlayInterruptible = rep2 interruptibleName []
Ian Lynagh's avatar
Ian Lynagh committed
397
repSafety PlaySafe = rep2 safeName []
398

399
400
401
402
repFixD :: LFixitySig Name -> DsM (SrcSpan, Core TH.DecQ)
repFixD (L loc (FixitySig name (Fixity prec dir)))
  = do { MkC name' <- lookupLOcc name
       ; MkC prec' <- coreIntLit prec
403
       ; let rep_fn = case dir of
404
405
406
407
408
409
                        InfixL -> infixLDName
                        InfixR -> infixRDName
                        InfixN -> infixNDName
       ; dec <- rep2 rep_fn [prec', name']
       ; return (loc, dec) }

mikhail.vorozhtsov's avatar
mikhail.vorozhtsov committed
410
411
repRuleD :: LRuleDecl Name -> DsM (SrcSpan, Core TH.DecQ)
repRuleD (L loc (HsRule n act bndrs lhs _ rhs _))
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
  = do { let bndr_names = concatMap ruleBndrNames bndrs
       ; ss <- mkGenSyms bndr_names
       ; rule1 <- addBinds ss $
                  do { bndrs' <- repList ruleBndrQTyConName repRuleBndr bndrs
                     ; n'   <- coreStringLit $ unpackFS n
                     ; act' <- repPhases act
                     ; lhs' <- repLE lhs
                     ; rhs' <- repLE rhs
                     ; repPragRule n' bndrs' lhs' rhs' act' }
       ; rule2 <- wrapGenSyms ss rule1
       ; return (loc, rule2) }

ruleBndrNames :: RuleBndr Name -> [Name]
ruleBndrNames (RuleBndr n)      = [unLoc n]
ruleBndrNames (RuleBndrSig n (HsWB { hswb_kvs = kvs, hswb_tvs = tvs })) 
  = unLoc n : kvs ++ tvs
mikhail.vorozhtsov's avatar
mikhail.vorozhtsov committed
428
429
430

repRuleBndr :: RuleBndr Name -> DsM (Core TH.RuleBndrQ)
repRuleBndr (RuleBndr n)
431
  = do { MkC n' <- lookupLBinder n
mikhail.vorozhtsov's avatar
mikhail.vorozhtsov committed
432
433
       ; rep2 ruleVarName [n'] }
repRuleBndr (RuleBndrSig n (HsWB { hswb_cts = ty }))
434
  = do { MkC n'  <- lookupLBinder n
mikhail.vorozhtsov's avatar
mikhail.vorozhtsov committed
435
436
437
       ; MkC ty' <- repLTy ty
       ; rep2 typedRuleVarName [n', ty'] }

Ian Lynagh's avatar
Ian Lynagh committed
438
ds_msg :: SDoc
Ian Lynagh's avatar
Ian Lynagh committed
439
ds_msg = ptext (sLit "Cannot desugar this Template Haskell declaration:")
440

441
442
443
444
-------------------------------------------------------
-- 			Constructors
-------------------------------------------------------

445
repC :: [Name] -> LConDecl Name -> DsM (Core TH.ConQ)
446
repC _ (L _ (ConDecl { con_name = con, con_qvars = con_tvs, con_cxt = L _ []
447
                     , con_details = details, con_res = ResTyH98 }))
448
  | null (hsQTvBndrs con_tvs)
449
  = do { con1 <- lookupLOcc con 	-- See Note [Binders and occurrences] 
450
       ; repConstr con1 details  }
451

452
453
454
455
456
repC tvs (L _ (ConDecl { con_name = con
                       , con_qvars = con_tvs, con_cxt = L _ ctxt
                       , con_details = details
                       , con_res = res_ty }))
  = do { (eq_ctxt, con_tv_subst) <- mkGadtCtxt tvs res_ty
457
458
459
       ; let ex_tvs = HsQTvs { hsq_kvs = filterOut (in_subst con_tv_subst) (hsq_kvs con_tvs)
                             , hsq_tvs = filterOut (in_subst con_tv_subst . hsLTyVarName) (hsq_tvs con_tvs) }

460
461
462
       ; binds <- mapM dupBinder con_tv_subst 
       ; dsExtendMetaEnv (mkNameEnv binds) $     -- Binds some of the con_tvs
         addTyVarBinds ex_tvs $ \ ex_bndrs ->   -- Binds the remaining con_tvs
463
    do { con1      <- lookupLOcc con 	-- See Note [Binders and occurrences] 
464
465
       ; c'        <- repConstr con1 details
       ; ctxt'     <- repContext (eq_ctxt ++ ctxt)
466
       ; rep2 forallCName [unC ex_bndrs, unC ctxt', unC c'] } }
467

468
469
470
in_subst :: [(Name,Name)] -> Name -> Bool
in_subst []          _ = False
in_subst ((n',_):ns) n = n==n' || in_subst ns n
471
472

mkGadtCtxt :: [Name]		-- Tyvars of the data type
473
           -> ResType (LHsType Name)
474
	   -> DsM (HsContext Name, [(Name,Name)])
475
476
-- Given a data type in GADT syntax, figure out the equality
-- context, so that we can represent it with an explicit
477
478
479
-- equality context, because that is the only way to express
-- the GADT in TH syntax
--
480
-- Example:
481
482
-- data T a b c where { MkT :: forall d e. d -> e -> T d [e] e
--     mkGadtCtxt [a,b,c] [d,e] (T d [e] e)
483
484
485
--   returns
--     (b~[e], c~e), [d->a]
--
486
487
488
489
490
491
492
493
494
-- This function is fiddly, but not really hard
mkGadtCtxt _ ResTyH98
  = return ([], [])
mkGadtCtxt data_tvs (ResTyGADT res_ty)
  | let (head_ty, tys) = splitHsAppTys res_ty []
  , Just _ <- is_hs_tyvar head_ty
  , data_tvs `equalLength` tys
  = return (go [] [] (data_tvs `zip` tys))

495
  | otherwise
496
  = failWithDs (ptext (sLit "Malformed constructor result type:") <+> ppr res_ty)
497
498
499
500
501
  where
    go cxt subst [] = (cxt, subst)
    go cxt subst ((data_tv, ty) : rest)
       | Just con_tv <- is_hs_tyvar ty
       , isTyVarName con_tv
502
       , not (in_subst subst con_tv)
503
504
505
506
507
       = go cxt ((con_tv, data_tv) : subst) rest
       | otherwise
       = go (eq_pred : cxt) subst rest
       where
         loc = getLoc ty
batterseapower's avatar
batterseapower committed
508
         eq_pred = L loc (HsEqTy (L loc (HsTyVar data_tv)) ty)
509
510
511
512
513

    is_hs_tyvar (L _ (HsTyVar n))  = Just n   -- Type variables *and* tycons
    is_hs_tyvar (L _ (HsParTy ty)) = is_hs_tyvar ty
    is_hs_tyvar _                  = Nothing

514

515
repBangTy :: LBangType Name -> DsM (Core (TH.StrictTypeQ))
516
repBangTy ty= do
517
518
  MkC s <- rep2 str []
  MkC t <- repLTy ty'
519
  rep2 strictTypeName [s, t]
520
  where
521
    (str, ty') = case ty of
522
523
524
		   L _ (HsBangTy (HsBang True) ty) -> (unpackedName,  ty)
		   L _ (HsBangTy _ ty)             -> (isStrictName,  ty)
		   _                               -> (notStrictName, ty)
525
526
527
528
529

-------------------------------------------------------
-- 			Deriving clause
-------------------------------------------------------

530
repDerivs :: Maybe [LHsType Name] -> DsM (Core [TH.Name])
531
repDerivs Nothing = coreList nameTyConName []
532
repDerivs (Just ctxt)
533
  = repList nameTyConName rep_deriv ctxt
534
  where
535
    rep_deriv :: LHsType Name -> DsM (Core TH.Name)
536
	-- Deriving clauses must have the simple H98 form
batterseapower's avatar
batterseapower committed
537
538
539
540
541
    rep_deriv ty
      | Just (cls, []) <- splitHsClassTy_maybe (unLoc ty)
      = lookupOcc cls
      | otherwise
      = notHandled "Non-H98 deriving clause" (ppr ty)
542
543
544
545
546
547


-------------------------------------------------------
--   Signatures in a class decl, or a group of bindings
-------------------------------------------------------

548
rep_sigs :: [LSig Name] -> DsM [Core TH.DecQ]
549
550
551
rep_sigs sigs = do locs_cores <- rep_sigs' sigs
                   return $ de_loc $ sort_by_loc locs_cores

552
rep_sigs' :: [LSig Name] -> DsM [(SrcSpan, Core TH.DecQ)]
553
	-- We silently ignore ones we don't recognise
554
rep_sigs' sigs = do { sigs1 <- mapM rep_sig sigs ;
555
556
		     return (concat sigs1) }

557
rep_sig :: LSig Name -> DsM [(SrcSpan, Core TH.DecQ)]
558
559
	-- Singleton => Ok
	-- Empty     => Too hard, signature ignored
560
rep_sig (L loc (TypeSig nms ty))      = mapM (rep_ty_sig loc ty) nms
dreixel's avatar
dreixel committed
561
562
563
564
rep_sig (L _   (GenericSig nm _))     = failWithDs msg
  where msg = vcat  [ ptext (sLit "Illegal default signature for") <+> quotes (ppr nm)
                    , ptext (sLit "Default signatures are not supported by Template Haskell") ]

565
566
rep_sig (L loc (InlineSig nm ispec))  = rep_inline nm ispec loc
rep_sig (L loc (SpecSig nm ty ispec)) = rep_specialise nm ty ispec loc
mikhail.vorozhtsov's avatar
mikhail.vorozhtsov committed
567
rep_sig (L loc (SpecInstSig ty))      = rep_specialiseInst ty loc
568
569
rep_sig _                             = return []

570
571
rep_ty_sig :: SrcSpan -> LHsType Name -> Located Name
           -> DsM (SrcSpan, Core TH.DecQ)
572
rep_ty_sig loc (L _ ty) nm
573
574
575
576
  = do { nm1 <- lookupLOcc nm
       ; ty1 <- rep_ty ty
       ; sig <- repProto nm1 ty1
       ; return (loc, sig) }
577
  where
578
579
580
581
582
    -- We must special-case the top-level explicit for-all of a TypeSig
    -- See Note [Scoped type variables in bindings]
    rep_ty (HsForAllTy Explicit tvs ctxt ty)
      = do { let rep_in_scope_tv tv = do { name <- lookupBinder (hsLTyVarName tv)
                                         ; repTyVarBndrWithKind tv name }
583
           ; bndrs1 <- repList tyVarBndrTyConName rep_in_scope_tv (hsQTvBndrs tvs)
584
585
           ; ctxt1  <- repLContext ctxt
           ; ty1    <- repLTy ty
586
           ; repTForall bndrs1 ctxt1 ty1 }
587

588
    rep_ty ty = repTy ty
589

590

591
rep_inline :: Located Name
592
           -> InlinePragma	-- Never defaultInlinePragma
593
           -> SrcSpan
594
595
           -> DsM [(SrcSpan, Core TH.DecQ)]
rep_inline nm ispec loc
mikhail.vorozhtsov's avatar
mikhail.vorozhtsov committed
596
597
598
599
600
  = do { nm1    <- lookupLOcc nm
       ; inline <- repInline $ inl_inline ispec
       ; rm     <- repRuleMatch $ inl_rule ispec
       ; phases <- repPhases $ inl_act ispec
       ; pragma <- repPragInl nm1 inline rm phases
601
602
603
       ; return [(loc, pragma)]
       }

604
rep_specialise :: Located Name -> LHsType Name -> InlinePragma -> SrcSpan
605
606
607
608
               -> DsM [(SrcSpan, Core TH.DecQ)]
rep_specialise nm ty ispec loc
  = do { nm1 <- lookupLOcc nm
       ; ty1 <- repLTy ty
mikhail.vorozhtsov's avatar
mikhail.vorozhtsov committed
609
610
611
612
613
614
615
616
       ; phases <- repPhases $ inl_act ispec
       ; let inline = inl_inline ispec
       ; pragma <- if isEmptyInlineSpec inline
                   then -- SPECIALISE
                     repPragSpec nm1 ty1 phases
                   else -- SPECIALISE INLINE
                     do { inline1 <- repInline inline
                        ; repPragSpecInl nm1 ty1 inline1 phases }
617
618
       ; return [(loc, pragma)]
       }
619

mikhail.vorozhtsov's avatar
mikhail.vorozhtsov committed
620
621
622
623
624
625
rep_specialiseInst :: LHsType Name -> SrcSpan -> DsM [(SrcSpan, Core TH.DecQ)]
rep_specialiseInst ty loc
  = do { ty1    <- repLTy ty
       ; pragma <- repPragSpecInst ty1
       ; return [(loc, pragma)] }

626
627
628
629
630
631
repInline :: InlineSpec -> DsM (Core TH.Inline)
repInline NoInline  = dataCon noInlineDataConName
repInline Inline    = dataCon inlineDataConName
repInline Inlinable = dataCon inlinableDataConName
repInline spec      = notHandled "repInline" (ppr spec)

mikhail.vorozhtsov's avatar
mikhail.vorozhtsov committed
632
633
634
repRuleMatch :: RuleMatchInfo -> DsM (Core TH.RuleMatch)
repRuleMatch ConLike = dataCon conLikeDataConName
repRuleMatch FunLike = dataCon funLikeDataConName
635

mikhail.vorozhtsov's avatar
mikhail.vorozhtsov committed
636
637
638
639
640
641
repPhases :: Activation -> DsM (Core TH.Phases)
repPhases (ActiveBefore i) = do { MkC arg <- coreIntLit i
                                ; dataCon' beforePhaseDataConName [arg] }
repPhases (ActiveAfter i)  = do { MkC arg <- coreIntLit i
                                ; dataCon' fromPhaseDataConName [arg] }
repPhases _                = dataCon allPhasesDataConName
642
643
644
645

-------------------------------------------------------
-- 			Types
-------------------------------------------------------
646

647
addTyVarBinds :: LHsTyVarBndrs Name	                       -- the binders to be added
648
649
              -> (Core [TH.TyVarBndr] -> DsM (Core (TH.Q a)))  -- action in the ext env
              -> DsM (Core (TH.Q a))
chak's avatar
chak committed
650
651
-- gensym a list of type variables and enter them into the meta environment;
-- the computations passed as the second argument is executed in that extended
chak's avatar
chak committed
652
-- meta environment and gets the *new* names on Core-level as an argument
653

654
addTyVarBinds tvs m
655
  = do { freshNames <- mkGenSyms (hsLKiTyVarNames tvs)
656
       ; term <- addBinds freshNames $ 
657
658
	    	 do { kbs <- repList tyVarBndrTyConName mk_tv_bndr (hsQTvBndrs tvs `zip` freshNames)
	    	    ; m kbs }
659
660
661
       ; wrapGenSyms freshNames term }
  where
    mk_tv_bndr (tv, (_,v)) = repTyVarBndrWithKind tv (coreVar v)
chak's avatar
chak committed
662

663
addTyClTyVarBinds :: LHsTyVarBndrs Name
664
665
                  -> (Core [TH.TyVarBndr] -> DsM (Core (TH.Q a)))
                  -> DsM (Core (TH.Q a))
666
667
668
669
670
671
672

-- Used for data/newtype declarations, and family instances,
-- so that the nested type variables work right
--    instance C (T a) where
--      type W (T a) = blah
-- The 'a' in the type instance is the one bound by the instance decl
addTyClTyVarBinds tvs m
673
  = do { let tv_names = hsLKiTyVarNames tvs
674
675
676
677
678
679
       ; env <- dsGetMetaEnv
       ; freshNames <- mkGenSyms (filterOut (`elemNameEnv` env) tv_names)
       	    -- Make fresh names for the ones that are not already in scope
            -- This makes things work for family declarations

       ; term <- addBinds freshNames $ 
680
681
	    	 do { kbs <- repList tyVarBndrTyConName mk_tv_bndr (hsQTvBndrs tvs)
	    	    ; m kbs }
682
683
684

       ; wrapGenSyms freshNames term }
  where
685
    mk_tv_bndr tv = do { v <- lookupBinder (hsLTyVarName tv)
686
                       ; repTyVarBndrWithKind tv v }
687
688
689
690
691

-- Produce kinded binder constructors from the Haskell tyvar binders
--
repTyVarBndrWithKind :: LHsTyVarBndr Name 
                     -> Core TH.Name -> DsM (Core TH.TyVarBndr)
692
693
repTyVarBndrWithKind (L _ (UserTyVar {})) nm
  = repPlainTV nm
694
repTyVarBndrWithKind (L _ (KindedTyVar _ ki)) nm
695
  = repLKind ki >>= repKindedTV nm
696

chak's avatar
chak committed
697
698
-- represent a type context
--
699
700
701
repLContext :: LHsContext Name -> DsM (Core TH.CxtQ)
repLContext (L _ ctxt) = repContext ctxt

702
repContext :: HsContext Name -> DsM (Core TH.CxtQ)
703
704
repContext ctxt = do preds <- repList predQTyConName repLPred ctxt
		     repCtxt preds
705

chak's avatar
chak committed
706
707
-- represent a type predicate
--
batterseapower's avatar
batterseapower committed
708
repLPred :: LHsType Name -> DsM (Core TH.PredQ)
709
710
repLPred (L _ p) = repPred p

batterseapower's avatar
batterseapower committed
711
712
713
repPred :: HsType Name -> DsM (Core TH.PredQ)
repPred ty
  | Just (cls, tys) <- splitHsClassTy_maybe ty
714
715
  = do
      cls1 <- lookupOcc cls
716
717
      tys1 <- repList typeQTyConName repLTy tys
      repClassP cls1 tys1
718
repPred (HsEqTy tyleft tyright)
719
720
721
722
  = do
      tyleft1  <- repLTy tyleft
      tyright1 <- repLTy tyright
      repEqualP tyleft1 tyright1
batterseapower's avatar
batterseapower committed
723
724
repPred ty
  = notHandled "Exotic predicate type" (ppr ty)
725

chak's avatar
chak committed
726
727
-- yield the representation of a list of types
--
728
729
repLTys :: [LHsType Name] -> DsM [Core TH.TypeQ]
repLTys tys = mapM repLTy tys
730

chak's avatar
chak committed
731
732
-- represent a type
--
733
734
735
repLTy :: LHsType Name -> DsM (Core TH.TypeQ)
repLTy (L _ ty) = repTy ty

736
repTy :: HsType Name -> DsM (Core TH.TypeQ)
737
repTy (HsForAllTy _ tvs ctxt ty)  =
738
  addTyVarBinds tvs $ \bndrs -> do
739
740
    ctxt1  <- repLContext ctxt
    ty1    <- repLTy ty
741
    repTForall bndrs ctxt1 ty1
742

743
repTy (HsTyVar n)
744
745
746
747
748
749
  | isTvOcc occ   = do tv1 <- lookupOcc n
		       repTvar tv1
  | isDataOcc occ = do tc1 <- lookupOcc n
                       repPromotedTyCon tc1
  | otherwise	  = do tc1 <- lookupOcc n
		       repNamedTyCon tc1
750
751
  where
    occ = nameOccName n
752

753
repTy (HsAppTy f a)         = do
754
755
756
			        f1 <- repLTy f
			        a1 <- repLTy a
			        repTapp f1 a1
757
repTy (HsFunTy f a)         = do
758
759
760
761
762
763
764
765
766
767
768
769
			        f1   <- repLTy f
			        a1   <- repLTy a
			        tcon <- repArrowTyCon
			        repTapps tcon [f1, a1]
repTy (HsListTy t)	    = do
			        t1   <- repLTy t
			        tcon <- repListTyCon
			        repTapp tcon t1
repTy (HsPArrTy t)          = do
			        t1   <- repLTy t
			        tcon <- repTy (HsTyVar (tyConName parrTyCon))
			        repTapp tcon t1
batterseapower's avatar
batterseapower committed
770
repTy (HsTupleTy HsUnboxedTuple tys) = do
771
772
773
			        tys1 <- repLTys tys
			        tcon <- repUnboxedTupleTyCon (length tys)
			        repTapps tcon tys1
774
repTy (HsTupleTy _ tys)     = do tys1 <- repLTys tys
775
776
                                 tcon <- repTupleTyCon (length tys)
                                 repTapps tcon tys1
dreixel's avatar
dreixel committed
777
repTy (HsOpTy ty1 (_, n) ty2) = repLTy ((nlHsTyVar (unLoc n) `nlHsAppTy` ty1)
778
779
780
781
			    	   `nlHsAppTy` ty2)
repTy (HsParTy t)  	    = repLTy t
repTy (HsKindSig t k)       = do
                                t1 <- repLTy t
782
                                k1 <- repLKind k
783
                                repTSig t1 k1
784
repTy (HsSpliceTy splice _ _) = repSplice splice
785
786
787
788
789
790
791
792
793
794
repTy (HsExplicitListTy _ tys)  = do
                                    tys1 <- repLTys tys
                                    repTPromotedList tys1
repTy (HsExplicitTupleTy _ tys) = do
                                    tys1 <- repLTys tys
                                    tcon <- repPromotedTupleTyCon (length tys)
                                    repTapps tcon tys1
repTy (HsTyLit lit) = do
                        lit' <- repTyLit lit
                        repTLit lit'
795
repTy ty		      = notHandled "Exotic form of type" (ppr ty)
796

797
repTyLit :: HsTyLit -> DsM (Core TH.TyLitQ)
798
799
repTyLit (HsNumTy i) = do dflags <- getDynFlags
                          rep2 numTyLitName [mkIntExpr dflags i]
800
801
802
803
repTyLit (HsStrTy s) = do { s' <- mkStringExprFS s
                         ; rep2 strTyLitName [s']
                         }

804
805
-- represent a kind
--
806
807
repLKind :: LHsKind Name -> DsM (Core TH.Kind)
repLKind ki
dreixel's avatar
dreixel committed
808
  = do { let (kis, ki') = splitHsFunType ki
809
810
811
812
813
       ; kis_rep <- mapM repLKind kis
       ; ki'_rep <- repNonArrowLKind ki'
       ; kcon <- repKArrow
       ; let f k1 k2 = repKApp kcon k1 >>= flip repKApp k2
       ; foldrM f ki'_rep kis_rep
814
       }
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837

repNonArrowLKind :: LHsKind Name -> DsM (Core TH.Kind)
repNonArrowLKind (L _ ki) = repNonArrowKind ki

repNonArrowKind :: HsKind Name -> DsM (Core TH.Kind)
repNonArrowKind (HsTyVar name)
  | name == liftedTypeKindTyConName = repKStar
  | name == constraintKindTyConName = repKConstraint
  | isTvOcc (nameOccName name)      = lookupOcc name >>= repKVar
  | otherwise                       = lookupOcc name >>= repKCon
repNonArrowKind (HsAppTy f a)       = do  { f' <- repLKind f
                                          ; a' <- repLKind a
                                          ; repKApp f' a'
                                          }
repNonArrowKind (HsListTy k)        = do  { k' <- repLKind k
                                          ; kcon <- repKList
                                          ; repKApp kcon k'
                                          }
repNonArrowKind (HsTupleTy _ ks)    = do  { ks' <- mapM repLKind ks
                                          ; kcon <- repKTuple (length ks)
                                          ; repKApps kcon ks'
                                          }
repNonArrowKind k                   = notHandled "Exotic form of kind" (ppr k)
838

839
840
841
842
843
844
845
-----------------------------------------------------------------------------
-- 		Splices
-----------------------------------------------------------------------------

repSplice :: HsSplice Name -> DsM (Core a)
-- See Note [How brackets and nested splices are handled] in TcSplice
-- We return a CoreExpr of any old type; the context should know
846
repSplice (HsSplice n _)
847
848
849
850
851
852
853
 = do { mb_val <- dsLookupMetaEnv n
       ; case mb_val of
	   Just (Splice e) -> do { e' <- dsExpr e
				 ; return (MkC e') }
	   _ -> pprPanic "HsSplice" (ppr n) }
			-- Should not happen; statically checked

chak's avatar
chak committed
854
-----------------------------------------------------------------------------
855
-- 		Expressions
chak's avatar
chak committed
856
-----------------------------------------------------------------------------
857

858
repLEs :: [LHsExpr Name] -> DsM (Core [TH.ExpQ])
859
repLEs es = repList expQTyConName repLE es
860

chak's avatar
chak committed
861
862
863
-- FIXME: some of these panics should be converted into proper error messages
--	  unless we can make sure that constructs, which are plainly not
--	  supported in TH already lead to error messages at an earlier stage
864
repLE :: LHsExpr Name -> DsM (Core TH.ExpQ)
865
repLE (L loc e) = putSrcSpanDs loc (repE e)
866

867
repE :: HsExpr Name -> DsM (Core TH.ExpQ)
chak's avatar
chak committed
868
repE (HsVar x)            =
869
  do { mb_val <- dsLookupMetaEnv x
chak's avatar
chak committed
870
     ; case mb_val of
chak's avatar
chak committed
871
	Nothing	         -> do { str <- globalVar x
chak's avatar
chak committed
872
873
874
875
			       ; repVarOrCon x str }
	Just (Bound y)   -> repVarOrCon x (coreVar y)
	Just (Splice e)  -> do { e' <- dsExpr e
			       ; return (MkC e') } }
Ian Lynagh's avatar
Ian Lynagh committed
876
repE e@(HsIPVar _) = notHandled "Implicit parameters" (ppr e)
877
878
879
880
881

	-- Remember, we're desugaring renamer output here, so
	-- HsOverlit can definitely occur
repE (HsOverLit l) = do { a <- repOverloadedLiteral l; repLit a }
repE (HsLit l)     = do { a <- repLiteral l;           repLit a }
882
repE (HsLam (MatchGroup [m] _)) = repLambda m
883
884
885
repE (HsLamCase _ (MatchGroup ms _))
                   = do { ms' <- mapM repMatchTup ms
                        ; repLamCase (nonEmptyCoreList ms') }
886
repE (HsApp x y)   = do {a <- repLE x; b <- repLE y; repApp a b}
887

Ian Lynagh's avatar
Ian Lynagh committed
888
repE (OpApp e1 op _ e2) =
889
890
  do { arg1 <- repLE e1;
       arg2 <- repLE e2;
891
       the_op <- repLE op ;
892
       repInfixApp arg1 the_op arg2 }
Ian Lynagh's avatar
Ian Lynagh committed
893
repE (NegApp x _)        = do
894
			      a         <- repLE x
chak's avatar
chak committed
895
896
			      negateVar <- lookupOcc negateName >>= repVar
			      negateVar `repApp` a
897
repE (HsPar x)            = repLE x
898
899
repE (SectionL x y)       = do { a <- repLE x; b <- repLE y; repSectionL a b }
repE (SectionR x y)       = do { a <- repLE x; b <- repLE y; repSectionR a b }
900
901
902
903
repE (HsCase e (MatchGroup ms _))
                          = do { arg <- repLE e
                               ; ms2 <- mapM repMatchTup ms
                               ; repCaseE arg (nonEmptyCoreList ms2) }
904
repE (HsIf _ x y z)         = do
905
906
907
			      a <- repLE x
			      b <- repLE y
			      c <- repLE z
chak's avatar
chak committed
908
			      repCond a b c
909
910
911
912
repE (HsMultiIf _ alts)
  = do { (binds, alts') <- liftM unzip $ mapM repLGRHS alts
       ; expr' <- repMultiIf (nonEmptyCoreList alts')
       ; wrapGenSyms (concat binds) expr' }
chak's avatar
chak committed
913
repE (HsLet bs e)         = do { (ss,ds) <- repBinds bs
914
			       ; e2 <- addBinds ss (repLE e)
chak's avatar
chak committed
915
			       ; z <- repLetE ds e2
916
			       ; wrapGenSyms ss z }
917

chak's avatar
chak committed
918
-- FIXME: I haven't got the types here right yet
919
repE e@(HsDo ctxt sts _)
920
 | case ctxt of { DoExpr -> True; GhciStmtCtxt -> True; _ -> False }
921
 = do { (ss,zs) <- repLSts sts;
922
        e'      <- repDoE (nonEmptyCoreList zs);
923
        wrapGenSyms ss e' }
924
925

 | ListComp <- ctxt
926
 = do { (ss,zs) <- repLSts sts;
927
        e'      <- repComp (nonEmptyCoreList zs);
928
        wrapGenSyms ss e' }
929
930

  | otherwise
931
  = notHandled "mdo, monad comprehension and [: :]" (ppr e)
932

Ian Lynagh's avatar
Ian Lynagh committed
933
934
repE (ExplicitList _ es) = do { xs <- repLEs es; repListExp xs }
repE e@(ExplicitPArr _ _) = notHandled "Parallel arrays" (ppr e)
935
repE e@(ExplicitTuple es boxed)
936
  | not (all tupArgPresent es) = notHandled "Tuple sections" (ppr e)
937
938
  | isBoxed boxed              = do { xs <- repLEs [e | Present e <- es]; repTup xs }
  | otherwise                  = do { xs <- repLEs [e | Present e <- es]; repUnboxedTup xs }
939