DsMeta.hs 97.5 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
65
66
import Bag
import FastString
import ForeignCall
67
import MonadUtils
68
import Util( equalLength, filterOut )
69

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

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

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

dreixel's avatar
dreixel committed
85
    do_brack (VarBr _ n) = do { MkC e1  <- lookupOcc n ; return e1 }
86
87
88
89
90
    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"
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106

{- -------------- 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))
-}


107
108
109
110
-------------------------------------------------------
-- 			Declarations
-------------------------------------------------------

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

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

122
123
124
125
126
	-- 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
127
	-- only "T", not "Foo:T" where Foo is the current module
128

129
	decls <- addBinds ss (do {
130
                        fix_ds  <- mapM repFixD (hs_fixds group) ;
131
			val_ds  <- rep_val_binds (hs_valds group) ;
132
			tycl_ds <- mapM repTyClD (concat (hs_tyclds group)) ;
133
			inst_ds <- mapM repInstD (hs_instds group) ;
134
			for_ds <- mapM repForD (hs_fords group) ;
135
			-- more needed
136
			return (de_loc $ sort_by_loc $
137
                                val_ds ++ catMaybes tycl_ds ++ fix_ds
138
                                       ++ inst_ds ++ for_ds) }) ;
139

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

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

146
	wrapGenSyms ss q_decs
147
148
149
      }


150
151
152
hsSigTvBinders :: HsValBinds Name -> [Name]
-- See Note [Scoped type variables in bindings]
hsSigTvBinders binds
153
154
  = [hsLTyVarName tv | L _ (TypeSig _ (L _ (HsForAllTy Explicit qtvs _ _))) <- sigs
                     , tv <- hsQTvBndrs qtvs]
155
156
157
158
159
160
161
162
163
164
165
166
167
168
  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.
169
To achieve this we
170
171
172
173
174
175
176
177
178
179

  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]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
180
181
182
183
184
185
186
187
188
189
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:
190
	data T = MkT
191
192
193
194
195
	foo = reifyDecl T

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

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

-}

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


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

210
211
212
213
214
215
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
216
217
	      ; case opt_kind of 
                  Nothing -> repFamilyNoKind flav tc1 bndrs
218
                  Just ki -> do { ki1 <- repLKind ki 
219
                                ; repFamilyKind flav tc1 bndrs ki1 }
220
221
222
              }
       ; return $ Just (loc, dec)
       }
223

224
225
226
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
227
       ; dec <- addTyClTyVarBinds tc_tvs $ \bndrs -> 
228
229
	        repTyDefn tc1 bndrs Nothing (hsLTyVarNames tc_tvs) defn
       ; return (Just (loc, dec)) }
230

231
repTyClD (L loc (ClassDecl { tcdCtxt = cxt, tcdLName = cls, 
232
233
		             tcdTyVars = tvs, tcdFDs = fds,
		             tcdSigs = sigs, tcdMeths = meth_binds, 
234
                             tcdATs = ats, tcdATDefs = [] }))
235
236
237
238
239
240
  = 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
241
              ; ats1   <- repTyClDs ats
242
 	      ; decls1 <- coreList decQTyConName (ats1 ++ sigs1 ++ binds1)
243
 	      ; repClass cxt1 cls1 bndrs fds1 decls1 
244
245
246
              }
       ; return $ Just (loc, dec) 
       }
247
248

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

253
-------------------------
254
repTyDefn :: Core TH.Name -> Core [TH.TyVarBndr]
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
          -> 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 }
           DataType -> do { cons1 <- mapM (repC tv_names) cons
                          ; cons2 <- coreList conQTyConName cons1
                          ; repData cxt1 tc bndrs opt_tys cons2 derivs1 } }

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

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

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

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

-------------------------
303
304
305
306
307
308
309
310
311
312
313
314
315
-- represent fundeps
--
repLFunDeps :: [Located (FunDep Name)] -> DsM (Core [TH.FunDep])
repLFunDeps fds = do fds' <- mapM repLFunDep fds
                     fdList <- coreList funDepTyConName fds'
                     return fdList

repLFunDep :: Located (FunDep Name) -> DsM (Core TH.FunDep)
repLFunDep (L _ (xs, ys)) = do xs' <- mapM lookupBinder xs
                               ys' <- mapM lookupBinder ys
                               xs_list <- coreList nameTyConName xs'
                               ys_list <- coreList nameTyConName ys'
                               repFunDep xs_list ys_list
316

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

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

330
331
repInstD (L loc (ClsInstD { cid_poly_ty = ty, cid_binds = binds
                          , cid_sigs = prags, cid_fam_insts = ats }))
332
333
  = do { dec <- addTyVarBinds tvs $ \_ ->
	    -- We must bring the type variables into scope, so their
334
	    -- occurrences don't fail, even though the binders don't
335
336
337
338
339
340
341
342
            -- 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
343
               ; cls_tcon <- repTy (HsTyVar (unLoc cls))
batterseapower's avatar
batterseapower committed
344
345
               ; cls_tys <- repLTys tys
               ; inst_ty1 <- repTapps cls_tcon cls_tys
346
               ; binds1 <- rep_binds binds
347
               ; prags1 <- rep_sigs prags
348
               ; ats1 <- mapM (repFamInstD . unLoc) ats
349
               ; decls <- coreList decQTyConName (ats1 ++ binds1 ++ prags1)
350
               ; repInst cxt1 inst_ty1 decls }
351
       ; return (loc, dec) }
352
 where
353
   Just (tvs, cxt, cls, tys) = splitLHsInstDeclTy_maybe ty
354

355
repFamInstD :: FamInstDecl Name -> DsM (Core TH.DecQ)
356
repFamInstD (FamInstDecl { fid_tycon = tc_name
357
                         , fid_pats = HsWB { hswb_cts = tys, hswb_kvs = kv_names, hswb_tvs = tv_names }
358
359
360
361
                         , 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]  
362
       ; let loc = getLoc tc_name
363
             hs_tvs = HsQTvs { hsq_kvs = kv_names, hsq_tvs = userHsTyVarBndrs loc tv_names }   -- Yuk
364
       ; addTyClTyVarBinds hs_tvs $ \ bndrs ->
365
366
367
368
         do { tys1 <- repLTys tys
            ; tys2 <- coreList typeQTyConName tys1
            ; repTyDefn tc bndrs (Just tys2) tv_names defn } }

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

repCCallConv :: CCallConv -> DsM (Core TH.Callconv)
repCCallConv CCallConv = rep2 cCallName []
repCCallConv StdCallConv = rep2 stdCallName []
396
repCCallConv callConv    = notHandled "repCCallConv" (ppr callConv)
397
398
399

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

403
404
405
406
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
407
       ; let rep_fn = case dir of
408
409
410
411
412
413
                        InfixL -> infixLDName
                        InfixR -> infixRDName
                        InfixN -> infixNDName
       ; dec <- rep2 rep_fn [prec', name']
       ; return (loc, dec) }

Ian Lynagh's avatar
Ian Lynagh committed
414
ds_msg :: SDoc
Ian Lynagh's avatar
Ian Lynagh committed
415
ds_msg = ptext (sLit "Cannot desugar this Template Haskell declaration:")
416

417
418
419
420
-------------------------------------------------------
-- 			Constructors
-------------------------------------------------------

421
repC :: [Name] -> LConDecl Name -> DsM (Core TH.ConQ)
422
repC _ (L _ (ConDecl { con_name = con, con_qvars = con_tvs, con_cxt = L _ []
423
                     , con_details = details, con_res = ResTyH98 }))
424
  | null (hsQTvBndrs con_tvs)
425
  = do { con1 <- lookupLOcc con 	-- See Note [Binders and occurrences] 
426
       ; repConstr con1 details  }
427

428
429
430
431
432
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
433
434
435
       ; 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) }

436
437
438
       ; 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
439
    do { con1      <- lookupLOcc con 	-- See Note [Binders and occurrences] 
440
441
       ; c'        <- repConstr con1 details
       ; ctxt'     <- repContext (eq_ctxt ++ ctxt)
442
       ; rep2 forallCName [unC ex_bndrs, unC ctxt', unC c'] } }
443

444
445
446
in_subst :: [(Name,Name)] -> Name -> Bool
in_subst []          _ = False
in_subst ((n',_):ns) n = n==n' || in_subst ns n
447
448

mkGadtCtxt :: [Name]		-- Tyvars of the data type
449
           -> ResType (LHsType Name)
450
	   -> DsM (HsContext Name, [(Name,Name)])
451
452
-- Given a data type in GADT syntax, figure out the equality
-- context, so that we can represent it with an explicit
453
454
455
-- equality context, because that is the only way to express
-- the GADT in TH syntax
--
456
-- Example:
457
458
-- 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)
459
460
461
--   returns
--     (b~[e], c~e), [d->a]
--
462
463
464
465
466
467
468
469
470
-- 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))

471
  | otherwise
472
  = failWithDs (ptext (sLit "Malformed constructor result type:") <+> ppr res_ty)
473
474
475
476
477
  where
    go cxt subst [] = (cxt, subst)
    go cxt subst ((data_tv, ty) : rest)
       | Just con_tv <- is_hs_tyvar ty
       , isTyVarName con_tv
478
       , not (in_subst subst con_tv)
479
480
481
482
483
       = go cxt ((con_tv, data_tv) : subst) rest
       | otherwise
       = go (eq_pred : cxt) subst rest
       where
         loc = getLoc ty
batterseapower's avatar
batterseapower committed
484
         eq_pred = L loc (HsEqTy (L loc (HsTyVar data_tv)) ty)
485
486
487
488
489

    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

490

491
repBangTy :: LBangType Name -> DsM (Core (TH.StrictTypeQ))
492
repBangTy ty= do
493
494
  MkC s <- rep2 str []
  MkC t <- repLTy ty'
495
  rep2 strictTypeName [s, t]
496
  where
497
    (str, ty') = case ty of
498
499
500
		   L _ (HsBangTy HsUnpack ty) -> (unpackedName,  ty)
		   L _ (HsBangTy _ ty)        -> (isStrictName,  ty)
		   _                          -> (notStrictName, ty)
501
502
503
504
505

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

506
repDerivs :: Maybe [LHsType Name] -> DsM (Core [TH.Name])
507
repDerivs Nothing = coreList nameTyConName []
508
repDerivs (Just ctxt)
509
  = do { strs <- mapM rep_deriv ctxt ;
510
	 coreList nameTyConName strs }
511
  where
512
    rep_deriv :: LHsType Name -> DsM (Core TH.Name)
513
	-- Deriving clauses must have the simple H98 form
batterseapower's avatar
batterseapower committed
514
515
516
517
518
    rep_deriv ty
      | Just (cls, []) <- splitHsClassTy_maybe (unLoc ty)
      = lookupOcc cls
      | otherwise
      = notHandled "Non-H98 deriving clause" (ppr ty)
519
520
521
522
523
524


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

525
rep_sigs :: [LSig Name] -> DsM [Core TH.DecQ]
526
527
528
rep_sigs sigs = do locs_cores <- rep_sigs' sigs
                   return $ de_loc $ sort_by_loc locs_cores

529
rep_sigs' :: [LSig Name] -> DsM [(SrcSpan, Core TH.DecQ)]
530
	-- We silently ignore ones we don't recognise
531
rep_sigs' sigs = do { sigs1 <- mapM rep_sig sigs ;
532
533
		     return (concat sigs1) }

534
rep_sig :: LSig Name -> DsM [(SrcSpan, Core TH.DecQ)]
535
536
	-- Singleton => Ok
	-- Empty     => Too hard, signature ignored
537
rep_sig (L loc (TypeSig nms ty))      = mapM (rep_ty_sig loc ty) nms
dreixel's avatar
dreixel committed
538
539
540
541
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") ]

542
543
544
545
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
rep_sig _                             = return []

546
547
rep_ty_sig :: SrcSpan -> LHsType Name -> Located Name
           -> DsM (SrcSpan, Core TH.DecQ)
548
rep_ty_sig loc (L _ ty) nm
549
550
551
552
  = do { nm1 <- lookupLOcc nm
       ; ty1 <- rep_ty ty
       ; sig <- repProto nm1 ty1
       ; return (loc, sig) }
553
  where
554
555
556
557
558
    -- 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 }
559
           ; bndrs1 <- mapM rep_in_scope_tv (hsQTvBndrs tvs)
560
561
562
563
564
           ; bndrs2 <- coreList tyVarBndrTyConName bndrs1
           ; ctxt1  <- repLContext ctxt
           ; ty1    <- repLTy ty
           ; repTForall bndrs2 ctxt1 ty1 }

565
    rep_ty ty = repTy ty
566

567

568
rep_inline :: Located Name
569
           -> InlinePragma	-- Never defaultInlinePragma
570
           -> SrcSpan
571
572
573
           -> DsM [(SrcSpan, Core TH.DecQ)]
rep_inline nm ispec loc
  = do { nm1 <- lookupLOcc nm
574
       ; ispec1 <- rep_InlinePrag ispec
575
576
577
578
       ; pragma <- repPragInl nm1 ispec1
       ; return [(loc, pragma)]
       }

579
rep_specialise :: Located Name -> LHsType Name -> InlinePragma -> SrcSpan
580
581
582
583
               -> DsM [(SrcSpan, Core TH.DecQ)]
rep_specialise nm ty ispec loc
  = do { nm1 <- lookupLOcc nm
       ; ty1 <- repLTy ty
584
585
586
       ; pragma <- if isDefaultInlinePragma ispec
                   then repPragSpec nm1 ty1                  -- SPECIALISE
                   else do { ispec1 <- rep_InlinePrag ispec  -- SPECIALISE INLINE
587
                           ; repPragSpecInl nm1 ty1 ispec1 }
588
589
       ; return [(loc, pragma)]
       }
590

591
592
593
594
595
596
repInline :: InlineSpec -> DsM (Core TH.Inline)
repInline NoInline  = dataCon noInlineDataConName
repInline Inline    = dataCon inlineDataConName
repInline Inlinable = dataCon inlinableDataConName
repInline spec      = notHandled "repInline" (ppr spec)

597
-- Extract all the information needed to build a TH.InlinePrag
598
--
599
600
601
rep_InlinePrag :: InlinePragma	-- Never defaultInlinePragma
               -> DsM (Core TH.InlineSpecQ)
rep_InlinePrag (InlinePragma { inl_act = activation, inl_rule = match, inl_inline = inline })
602
  | Just (flag, phase) <- activation1
603
604
  = do { inline1 <- repInline inline
       ; repInlineSpecPhase inline1 match1 flag phase }
605
  | otherwise
606
607
  = do { inline1 <- repInline inline
       ; repInlineSpecNoPhase inline1 match1 }
608
  where
609
610
611
612
613
      match1      = coreBool (rep_RuleMatchInfo match)
      activation1 = rep_Activation activation
      rep_RuleMatchInfo FunLike = False
      rep_RuleMatchInfo ConLike = True

614
615
      rep_Activation NeverActive          = Nothing	-- We never have NOINLINE/AlwaysActive
      rep_Activation AlwaysActive         = Nothing	-- or            INLINE/NeverActive
616
      rep_Activation (ActiveBefore phase) = Just (coreBool False,
617
                                                  MkC $ mkIntExprInt phase)
618
      rep_Activation (ActiveAfter phase)  = Just (coreBool True,
619
                                                  MkC $ mkIntExprInt phase)
620
621
622
623
624


-------------------------------------------------------
-- 			Types
-------------------------------------------------------
625

626
addTyVarBinds :: LHsTyVarBndrs Name	                       -- the binders to be added
627
628
              -> (Core [TH.TyVarBndr] -> DsM (Core (TH.Q a)))  -- action in the ext env
              -> DsM (Core (TH.Q a))
chak's avatar
chak committed
629
630
-- 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
631
-- meta environment and gets the *new* names on Core-level as an argument
632

633
addTyVarBinds tvs m
634
  = do { freshNames <- mkGenSyms (hsLKiTyVarNames tvs)
635
       ; term <- addBinds freshNames $ 
636
	    	 do { kbs1 <- mapM mk_tv_bndr (hsQTvBndrs tvs `zip` freshNames)
637
638
                    ; kbs2 <- coreList tyVarBndrTyConName kbs1
	    	    ; m kbs2 }
639
640
641
       ; wrapGenSyms freshNames term }
  where
    mk_tv_bndr (tv, (_,v)) = repTyVarBndrWithKind tv (coreVar v)
chak's avatar
chak committed
642

643
addTyClTyVarBinds :: LHsTyVarBndrs Name
644
645
                  -> (Core [TH.TyVarBndr] -> DsM (Core (TH.Q a)))
                  -> DsM (Core (TH.Q a))
646
647
648
649
650
651
652

-- 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
653
  = do { let tv_names = hsLKiTyVarNames tvs
654
655
656
657
658
659
       ; 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 $ 
660
	    	 do { kbs1 <- mapM mk_tv_bndr (hsQTvBndrs tvs)
661
662
                    ; kbs2 <- coreList tyVarBndrTyConName kbs1
	    	    ; m kbs2 }
663
664
665

       ; wrapGenSyms freshNames term }
  where
666
667
    mk_tv_bndr tv = do { v <- lookupOcc (hsLTyVarName tv)
                       ; repTyVarBndrWithKind tv v }
668
669
670
671
672

-- Produce kinded binder constructors from the Haskell tyvar binders
--
repTyVarBndrWithKind :: LHsTyVarBndr Name 
                     -> Core TH.Name -> DsM (Core TH.TyVarBndr)
673
674
repTyVarBndrWithKind (L _ (UserTyVar {})) nm
  = repPlainTV nm
675
repTyVarBndrWithKind (L _ (KindedTyVar _ ki)) nm
676
  = repLKind ki >>= repKindedTV nm
677

chak's avatar
chak committed
678
679
-- represent a type context
--
680
681
682
repLContext :: LHsContext Name -> DsM (Core TH.CxtQ)
repLContext (L _ ctxt) = repContext ctxt

683
repContext :: HsContext Name -> DsM (Core TH.CxtQ)
684
repContext ctxt = do
685
	            preds    <- mapM repLPred ctxt
686
		    predList <- coreList predQTyConName preds
chak's avatar
chak committed
687
		    repCtxt predList
688

chak's avatar
chak committed
689
690
-- represent a type predicate
--
batterseapower's avatar
batterseapower committed
691
repLPred :: LHsType Name -> DsM (Core TH.PredQ)
692
693
repLPred (L _ p) = repPred p

batterseapower's avatar
batterseapower committed
694
695
696
repPred :: HsType Name -> DsM (Core TH.PredQ)
repPred ty
  | Just (cls, tys) <- splitHsClassTy_maybe ty
697
698
699
700
701
  = do
      cls1 <- lookupOcc cls
      tys1 <- repLTys tys
      tys2 <- coreList typeQTyConName tys1
      repClassP cls1 tys2
702
repPred (HsEqTy tyleft tyright)
703
704
705
706
  = do
      tyleft1  <- repLTy tyleft
      tyright1 <- repLTy tyright
      repEqualP tyleft1 tyright1
batterseapower's avatar
batterseapower committed
707
708
repPred ty
  = notHandled "Exotic predicate type" (ppr ty)
709

chak's avatar
chak committed
710
711
-- yield the representation of a list of types
--
712
713
repLTys :: [LHsType Name] -> DsM [Core TH.TypeQ]
repLTys tys = mapM repLTy tys
714

chak's avatar
chak committed
715
716
-- represent a type
--
717
718
719
repLTy :: LHsType Name -> DsM (Core TH.TypeQ)
repLTy (L _ ty) = repTy ty

720
repTy :: HsType Name -> DsM (Core TH.TypeQ)
721
repTy (HsForAllTy _ tvs ctxt ty)  =
722
  addTyVarBinds tvs $ \bndrs -> do
723
724
    ctxt1  <- repLContext ctxt
    ty1    <- repLTy ty
725
    repTForall bndrs ctxt1 ty1
726

727
repTy (HsTyVar n)
728
729
730
731
732
733
  | isTvOcc occ   = do tv1 <- lookupOcc n
		       repTvar tv1
  | isDataOcc occ = do tc1 <- lookupOcc n
                       repPromotedTyCon tc1
  | otherwise	  = do tc1 <- lookupOcc n
		       repNamedTyCon tc1
734
735
  where
    occ = nameOccName n
736

737
repTy (HsAppTy f a)         = do
738
739
740
			        f1 <- repLTy f
			        a1 <- repLTy a
			        repTapp f1 a1
741
repTy (HsFunTy f a)         = do
742
743
744
745
746
747
748
749
750
751
752
753
			        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
754
repTy (HsTupleTy HsUnboxedTuple tys) = do
755
756
757
			        tys1 <- repLTys tys
			        tcon <- repUnboxedTupleTyCon (length tys)
			        repTapps tcon tys1
758
repTy (HsTupleTy _ tys)     = do tys1 <- repLTys tys
759
760
                                 tcon <- repTupleTyCon (length tys)
                                 repTapps tcon tys1
dreixel's avatar
dreixel committed
761
repTy (HsOpTy ty1 (_, n) ty2) = repLTy ((nlHsTyVar (unLoc n) `nlHsAppTy` ty1)
762
763
764
765
			    	   `nlHsAppTy` ty2)
repTy (HsParTy t)  	    = repLTy t
repTy (HsKindSig t k)       = do
                                t1 <- repLTy t
766
                                k1 <- repLKind k
767
                                repTSig t1 k1
768
repTy (HsSpliceTy splice _ _) = repSplice splice
769
770
771
772
773
774
775
776
777
778
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'
779
repTy ty		      = notHandled "Exotic form of type" (ppr ty)
780

781
782
783
784
785
786
repTyLit :: HsTyLit -> DsM (Core TH.TyLitQ)
repTyLit (HsNumTy i) = rep2 numTyLitName [mkIntExpr i]
repTyLit (HsStrTy s) = do { s' <- mkStringExprFS s
                         ; rep2 strTyLitName [s']
                         }

787
788
-- represent a kind
--
789
790
repLKind :: LHsKind Name -> DsM (Core TH.Kind)
repLKind ki
dreixel's avatar
dreixel committed
791
  = do { let (kis, ki') = splitHsFunType ki
792
793
794
795
796
       ; 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
797
       }
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820

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

822
823
824
825
826
827
828
-----------------------------------------------------------------------------
-- 		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
829
repSplice (HsSplice n _)
830
831
832
833
834
835
836
 = 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
837
-----------------------------------------------------------------------------
838
-- 		Expressions
chak's avatar
chak committed
839
-----------------------------------------------------------------------------
840

841
842
843
repLEs :: [LHsExpr Name] -> DsM (Core [TH.ExpQ])
repLEs es = do { es'  <- mapM repLE es ;
		 coreList expQTyConName es' }
844

chak's avatar
chak committed
845
846
847
-- 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
848
repLE :: LHsExpr Name -> DsM (Core TH.ExpQ)
849
repLE (L loc e) = putSrcSpanDs loc (repE e)
850

851
repE :: HsExpr Name -> DsM (Core TH.ExpQ)
chak's avatar
chak committed
852
repE (HsVar x)            =
853
  do { mb_val <- dsLookupMetaEnv x
chak's avatar
chak committed
854
     ; case mb_val of
chak's avatar
chak committed
855
	Nothing	         -> do { str <- globalVar x
chak's avatar
chak committed
856
857
858
859
			       ; 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
860
repE e@(HsIPVar _) = notHandled "Implicit parameters" (ppr e)
861
862
863
864
865

	-- 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 }
866
repE (HsLam (MatchGroup [m] _)) = repLambda m
867
repE (HsApp x y)   = do {a <- repLE x; b <- repLE y; repApp a b}
868

Ian Lynagh's avatar
Ian Lynagh committed
869
repE (OpApp e1 op _ e2) =
870
871
  do { arg1 <- repLE e1;
       arg2 <- repLE e2;
872
       the_op <- repLE op ;
873
       repInfixApp arg1 the_op arg2 }
Ian Lynagh's avatar
Ian Lynagh committed
874
repE (NegApp x _)        = do
875
			      a         <- repLE x
chak's avatar
chak committed
876
877
			      negateVar <- lookupOcc negateName >>= repVar
			      negateVar `repApp` a
878
repE (HsPar x)            = repLE x
879
880
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 }
881
882
883
repE (HsCase e (MatchGroup ms _)) = do { arg <- repLE e
				       ; ms2 <- mapM repMatchTup ms
				       ; repCaseE arg (nonEmptyCoreList ms2) }
884
repE (HsIf _ x y z)         = do
885
886
887
			      a <- repLE x
			      b <- repLE y
			      c <- repLE z
chak's avatar
chak committed
888
889
			      repCond a b c
repE (HsLet bs e)         = do { (ss,ds) <- repBinds bs
890
			       ; e2 <- addBinds ss (repLE e)
chak's avatar
chak committed
891
			       ; z <- repLetE ds e2
892
			       ; wrapGenSyms ss z }
893

chak's avatar
chak committed
894
-- FIXME: I haven't got the types here right yet
895
repE e@(HsDo ctxt sts _)
896
 | case ctxt of { DoExpr -> True; GhciStmt -> True; _ -> False }
897
 = do { (ss,zs) <- repLSts sts;
898
        e'      <- repDoE (nonEmptyCoreList zs);
899
        wrapGenSyms ss e' }
900
901

 | ListComp <- ctxt
902
 = do { (ss,zs) <- repLSts sts;
903
        e'      <- repComp (nonEmptyCoreList zs);
904
        wrapGenSyms ss e' }
905
906

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

Ian Lynagh's avatar
Ian Lynagh committed
909
910
repE (ExplicitList _ es) = do { xs <- repLEs es; repListExp xs }
repE e@(ExplicitPArr _ _) = notHandled "Parallel arrays" (ppr e)
911
repE e@(ExplicitTuple es boxed)
912
  | not (all tupArgPresent es) = notHandled "Tuple sections" (ppr e)
913
914
  | isBoxed boxed              = do { xs <- repLEs [e | Present e <- es]; repTup xs }
  | otherwise                  = do { xs <- repLEs [e | Present e <- es]; repUnboxedTup xs }
915

916
repE (RecordCon c _ flds)
917
 = do { x <- lookupLOcc c;
918
919
        fs <- repFields flds;
        repRecCon x fs }
920
repE (RecordUpd e flds _ _ _)
921
 = do { x <- repLE e;
922
923
        fs <- repFields flds;
        repRecUpd x fs }
924

925
repE (ExprWithTySig e ty) = do { e1 <- repLE e; t1 <- repLTy ty; repSigExp e1 t1 }
926
repE (ArithSeq _ aseq) =
chak's avatar
chak committed
927
  case aseq of
928
    From e              -> do { ds1 <- repLE e; repFrom ds1 }
929
    FromThen e1 e2      -> do
930
931
		             ds1 <- repLE e1
			     ds2 <- repLE e2
chak's avatar
chak committed