DsMeta.hs 64.2 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
16
-----------------------------------------------------------------------------


17
18
module DsMeta( dsBracket, 
	       templateHaskellNames, qTyConName, nameTyConName,
19
	       liftName, expQTyConName, decQTyConName, typeQTyConName,
20
21
	       decTyConName, typeTyConName, mkNameG_dName, mkNameG_vName, mkNameG_tcName
	        ) where
22
23
24
25
26

#include "HsVersions.h"

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

Simon Marlow's avatar
Simon Marlow committed
27
28
import MatchLit
import DsUtils
29
30
import DsMonad

31
import qualified Language.Haskell.TH as TH
32

33
import HsSyn
Simon Marlow's avatar
Simon Marlow committed
34
35
36
37
38
39
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.
40
import qualified OccName
41

Simon Marlow's avatar
Simon Marlow committed
42
43
44
import Module
import Id
import Name
45
import NameEnv
Simon Marlow's avatar
Simon Marlow committed
46
47
48
import TcType
import TyCon
import TysWiredIn
49
import CoreSyn
Simon Marlow's avatar
Simon Marlow committed
50
51
52
53
54
import CoreUtils
import SrcLoc
import PackageConfig
import Unique
import BasicTypes
55
import Outputable
Simon Marlow's avatar
Simon Marlow committed
56
57
58
import Bag
import FastString
import ForeignCall
59

Simon Marlow's avatar
Simon Marlow committed
60
61
62
import Data.Maybe
import Control.Monad
import Data.List
63
64
65
 
-----------------------------------------------------------------------------
dsBracket :: HsBracket Name -> [PendingSplice] -> DsM CoreExpr
66
-- Returns a CoreExpr of type TH.ExpQ
67
68
69
-- The quoted thing is parameterised over Name, even though it has
-- been type checked.  We don't want all those type decorations!

70
71
dsBracket brack splices
  = dsExtendMetaEnv new_bit (do_brack brack)
72
  where
73
    new_bit = mkNameEnv [(n, Splice (unLoc e)) | (n,e) <- splices]
74

75
    do_brack (VarBr n)  = do { MkC e1  <- lookupOcc n ; return e1 }
76
77
    do_brack (ExpBr e)  = do { MkC e1  <- repLE e     ; return e1 }
    do_brack (PatBr p)  = do { MkC p1  <- repLP p     ; return p1 }
78
    do_brack (TypBr t)  = do { MkC t1  <- repLTy t    ; return t1 }
79
    do_brack (DecBr ds) = do { MkC ds1 <- repTopDs ds ; return ds1 }
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95

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


96
97
98
99
-------------------------------------------------------
-- 			Declarations
-------------------------------------------------------

100
repTopDs :: HsGroup Name -> DsM (Core (TH.Q [TH.Dec]))
101
repTopDs group
102
 = do { let { bndrs = map unLoc (groupBinders group) } ;
103
	ss <- mkGenSyms bndrs ;
104

105
106
107
108
109
	-- 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
110
	-- only "T", not "Foo:T" where Foo is the current module
111
112

	
113
	decls <- addBinds ss (do {
114
			val_ds  <- rep_val_binds (hs_valds group) ;
115
			tycl_ds <- mapM repTyClD (hs_tyclds group) ;
116
			inst_ds <- mapM repInstD' (hs_instds group) ;
117
			for_ds <- mapM repForD (hs_fords group) ;
118
			-- more needed
119
			return (de_loc $ sort_by_loc $ val_ds ++ catMaybes tycl_ds ++ inst_ds ++ for_ds) }) ;
120

121
	decl_ty <- lookupType decQTyConName ;
122
	let { core_list = coreList' decl_ty decls } ;
123
124
125

	dec_ty <- lookupType decTyConName ;
	q_decs  <- repSequenceQ dec_ty core_list ;
126
127

	wrapNongenSyms ss q_decs
128
129
130
131
132
	-- Do *not* gensym top-level binders
      }

groupBinders (HsGroup { hs_valds = val_decls, hs_tyclds = tycl_decls,
			hs_fords = foreign_decls })
133
-- Collect the binders of a Group
134
  = collectHsValBinders val_decls ++
135
    [n | d <- tycl_decls, n <- tyClDeclNames (unLoc d)] ++
136
    [n | L _ (ForeignImport n _ _) <- foreign_decls]
137
138


139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
{- 	Note [Binders and occurrences]
	~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
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:
	data T = MkT 
	foo = reifyDecl T

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

157
158
So in repTopDs we bring the binders into scope with mkGenSyms and addBinds.
And we use lookupOcc, rather than lookupBinder
159
160
161
162
in repTyClD and repC.

-}

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

165
166
167
168
repTyClD (L loc (TyData { tcdND = DataType, tcdCtxt = cxt, 
		    tcdLName = tc, tcdTyVars = tvs, 
		    tcdCons = cons, tcdDerivs = mb_derivs }))
 = do { tc1 <- lookupLOcc tc ;		-- See note [Binders and occurrences] 
169
        dec <- addTyVarBinds tvs $ \bndrs -> do {
170
      	       cxt1    <- repLContext cxt ;
171
               cons1   <- mapM repC cons ;
172
      	       cons2   <- coreList conQTyConName cons1 ;
173
      	       derivs1 <- repDerivs mb_derivs ;
174
175
	       bndrs1  <- coreList nameTyConName bndrs ;
      	       repData cxt1 tc1 bndrs1 cons2 derivs1 } ;
176
        return $ Just (loc, dec) }
177

178
179
180
181
repTyClD (L loc (TyData { tcdND = NewType, tcdCtxt = cxt, 
		    tcdLName = tc, tcdTyVars = tvs, 
		    tcdCons = [con], tcdDerivs = mb_derivs }))
 = do { tc1 <- lookupLOcc tc ;		-- See note [Binders and occurrences] 
182
        dec <- addTyVarBinds tvs $ \bndrs -> do {
183
      	       cxt1   <- repLContext cxt ;
184
185
               con1   <- repC con ;
      	       derivs1 <- repDerivs mb_derivs ;
186
187
	       bndrs1  <- coreList nameTyConName bndrs ;
      	       repNewtype cxt1 tc1 bndrs1 con1 derivs1 } ;
188
189
        return $ Just (loc, dec) }

190
191
repTyClD (L loc (TySynonym { tcdLName = tc, tcdTyVars = tvs, tcdSynRhs = ty }))
 = do { tc1 <- lookupLOcc tc ;		-- See note [Binders and occurrences] 
192
        dec <- addTyVarBinds tvs $ \bndrs -> do {
193
	       ty1     <- repLTy ty ;
194
195
	       bndrs1  <- coreList nameTyConName bndrs ;
	       repTySyn tc1 bndrs1 ty1 } ;
196
 	return (Just (loc, dec)) }
197

198
repTyClD (L loc (ClassDecl { tcdCtxt = cxt, tcdLName = cls, 
199
		      tcdTyVars = tvs, 
200
		      tcdFDs = fds,
201
202
		      tcdSigs = sigs, tcdMeths = meth_binds }))
 = do { cls1 <- lookupLOcc cls ;		-- See note [Binders and occurrences] 
203
    	dec  <- addTyVarBinds tvs $ \bndrs -> do {
204
 		  cxt1   <- repLContext cxt ;
205
 		  sigs1  <- rep_sigs sigs ;
206
 		  binds1 <- rep_binds meth_binds ;
207
	          fds1 <- repLFunDeps fds;
208
 		  decls1 <- coreList decQTyConName (sigs1 ++ binds1) ;
209
	          bndrs1 <- coreList nameTyConName bndrs ;
210
 		  repClass cxt1 cls1 bndrs1 fds1 decls1 } ;
211
    	return $ Just (loc, dec) }
212
213

-- Un-handled cases
214
repTyClD (L loc d) = putSrcSpanDs loc $
215
		     do { warnDs (hang ds_msg 4 (ppr d))
216
			; return Nothing }
217

218
219
220
221
222
223
224
225
226
227
228
229
230
-- 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
231

232
repInstD' (L loc (InstDecl ty binds _ _))		-- Ignore user pragmas for now
233
234
235
236
237
238
239
240
241
242
243
244
245
246
 = do	{ i <- addTyVarBinds tvs $ \tv_bndrs ->
		-- We must bring the type variables into scope, so their occurrences
		-- don't fail,  even though the binders don't appear in the resulting 
		-- data structure
		do {  cxt1 <- repContext cxt
		   ; inst_ty1 <- repPred (HsClassP cls tys)
		   ; ss <- mkGenSyms (collectHsBindBinders binds)
		   ; binds1 <- addBinds ss (rep_binds binds)
		   ; decls1 <- coreList decQTyConName binds1
		   ; decls2 <- wrapNongenSyms ss decls1
		   -- wrapNonGenSyms: do not clone the class op names!
		   -- They must be called 'op' etc, not 'op34'
		   ; repInst cxt1 inst_ty1 decls2 }

247
	; return (loc, i)}
248
 where
249
   (tvs, cxt, cls, tys) = splitHsInstDeclTy (unLoc ty)
250

251
repForD :: Located (ForeignDecl Name) -> DsM (SrcSpan, Core TH.DecQ)
252
repForD (L loc (ForeignImport name typ (CImport cc s ch cn cis)))
253
254
255
256
 = do MkC name' <- lookupLOcc name
      MkC typ' <- repLTy typ
      MkC cc' <- repCCallConv cc
      MkC s' <- repSafety s
257
      cis' <- conv_cimportspec cis
258
259
260
      MkC str <- coreStringLit $ static
                              ++ unpackFS ch ++ " "
                              ++ unpackFS cn ++ " "
261
                              ++ cis'
262
263
264
      dec <- rep2 forImpDName [cc', s', str, name', typ']
      return (loc, dec)
 where
265
266
267
268
    conv_cimportspec (CLabel cls) = notHandled "Foreign label" (doubleQuotes (ppr cls))
    conv_cimportspec (CFunction DynamicTarget) = return "dynamic"
    conv_cimportspec (CFunction (StaticTarget fs)) = return (unpackFS fs)
    conv_cimportspec CWrapper = return "wrapper"
269
270
271
    static = case cis of
                 CFunction (StaticTarget _) -> "static "
                 _ -> ""
272
repForD decl = notHandled "Foreign declaration" (ppr decl)
273
274
275
276
277
278
279
280
281
282

repCCallConv :: CCallConv -> DsM (Core TH.Callconv)
repCCallConv CCallConv = rep2 cCallName []
repCCallConv StdCallConv = rep2 stdCallName []

repSafety :: Safety -> DsM (Core TH.Safety)
repSafety PlayRisky = rep2 unsafeName []
repSafety (PlaySafe False) = rep2 safeName []
repSafety (PlaySafe True) = rep2 threadsafeName []

283
284
ds_msg = ptext SLIT("Cannot desugar this Template Haskell declaration:")

285
286
287
288
-------------------------------------------------------
-- 			Constructors
-------------------------------------------------------

289
repC :: LConDecl Name -> DsM (Core TH.ConQ)
290
repC (L loc (ConDecl con expl [] (L _ []) details ResTyH98 _))
291
  = do { con1 <- lookupLOcc con ;		-- See note [Binders and occurrences] 
292
	 repConstr con1 details }
293
repC (L loc (ConDecl con expl tvs (L cloc ctxt) details ResTyH98 doc))
294
  = do { addTyVarBinds tvs $ \bndrs -> do {
295
             c' <- repC (L loc (ConDecl con expl [] (L cloc []) details ResTyH98 doc));
296
297
298
299
300
             ctxt' <- repContext ctxt;
             bndrs' <- coreList nameTyConName bndrs;
             rep2 forallCName [unC bndrs', unC ctxt', unC c']
         }
       }
301
repC (L loc con_decl)		-- GADTs
302
303
  = putSrcSpanDs loc $
    notHandled "GADT declaration" (ppr con_decl) 
304

305
repBangTy :: LBangType Name -> DsM (Core (TH.StrictTypeQ))
306
307
308
repBangTy ty= do 
  MkC s <- rep2 str []
  MkC t <- repLTy ty'
309
  rep2 strictTypeName [s, t]
310
311
312
313
  where 
    (str, ty') = case ty of
		   L _ (HsBangTy _ ty) -> (isStrictName,  ty)
		   other	       -> (notStrictName, ty)
314
315
316
317
318

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

319
repDerivs :: Maybe [LHsType Name] -> DsM (Core [TH.Name])
320
repDerivs Nothing = coreList nameTyConName []
321
repDerivs (Just ctxt)
322
  = do { strs <- mapM rep_deriv ctxt ; 
323
	 coreList nameTyConName strs }
324
  where
325
    rep_deriv :: LHsType Name -> DsM (Core TH.Name)
326
	-- Deriving clauses must have the simple H98 form
327
    rep_deriv (L _ (HsPredTy (HsClassP cls []))) = lookupOcc cls
328
    rep_deriv other = notHandled "Non-H98 deriving clause" (ppr other)
329
330
331
332
333
334


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

335
rep_sigs :: [LSig Name] -> DsM [Core TH.DecQ]
336
337
338
rep_sigs sigs = do locs_cores <- rep_sigs' sigs
                   return $ de_loc $ sort_by_loc locs_cores

339
rep_sigs' :: [LSig Name] -> DsM [(SrcSpan, Core TH.DecQ)]
340
	-- We silently ignore ones we don't recognise
341
rep_sigs' sigs = do { sigs1 <- mapM rep_sig sigs ;
342
343
		     return (concat sigs1) }

344
rep_sig :: LSig Name -> DsM [(SrcSpan, Core TH.DecQ)]
345
346
	-- Singleton => Ok
	-- Empty     => Too hard, signature ignored
347
348
rep_sig (L loc (TypeSig nm ty)) = rep_proto nm ty loc
rep_sig other		        = return []
349

350
351
352
rep_proto :: Located Name -> LHsType Name -> SrcSpan -> DsM [(SrcSpan, Core TH.DecQ)]
rep_proto nm ty loc = do { nm1 <- lookupLOcc nm ; 
		       ty1 <- repLTy ty ; 
353
		       sig <- repProto nm1 ty1 ;
354
		       return [(loc, sig)] }
355
356
357
358
359


-------------------------------------------------------
-- 			Types
-------------------------------------------------------
360

chak's avatar
chak committed
361
362
-- 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
363
-- meta environment and gets the *new* names on Core-level as an argument
chak's avatar
chak committed
364
--
365
addTyVarBinds :: [LHsTyVarBndr Name]	         -- the binders to be added
366
367
	      -> ([Core TH.Name] -> DsM (Core (TH.Q a))) -- action in the ext env
	      -> DsM (Core (TH.Q a))
368
addTyVarBinds tvs m =
chak's avatar
chak committed
369
  do
370
    let names = map (hsTyVarName.unLoc) tvs
371
    freshNames <- mkGenSyms names
chak's avatar
chak committed
372
373
374
    term       <- addBinds freshNames $ do
		    bndrs <- mapM lookupBinder names 
		    m bndrs
375
    wrapGenSyns freshNames term
chak's avatar
chak committed
376

chak's avatar
chak committed
377
378
-- represent a type context
--
379
380
381
repLContext :: LHsContext Name -> DsM (Core TH.CxtQ)
repLContext (L _ ctxt) = repContext ctxt

382
repContext :: HsContext Name -> DsM (Core TH.CxtQ)
chak's avatar
chak committed
383
repContext ctxt = do 
384
	            preds    <- mapM repLPred ctxt
385
		    predList <- coreList typeQTyConName preds
chak's avatar
chak committed
386
		    repCtxt predList
387

chak's avatar
chak committed
388
389
-- represent a type predicate
--
390
391
392
repLPred :: LHsPred Name -> DsM (Core TH.TypeQ)
repLPred (L _ p) = repPred p

393
repPred :: HsPred Name -> DsM (Core TH.TypeQ)
chak's avatar
chak committed
394
395
repPred (HsClassP cls tys) = do
			       tcon <- repTy (HsTyVar cls)
396
			       tys1 <- repLTys tys
chak's avatar
chak committed
397
			       repTapps tcon tys1
398
repPred p@(HsEqualP _ _) = notHandled "Equational constraint" (ppr p)
399
repPred p@(HsIParam _ _) = notHandled "Implicit parameter constraint" (ppr p)
chak's avatar
chak committed
400
401
402

-- yield the representation of a list of types
--
403
404
repLTys :: [LHsType Name] -> DsM [Core TH.TypeQ]
repLTys tys = mapM repLTy tys
405

chak's avatar
chak committed
406
407
-- represent a type
--
408
409
410
repLTy :: LHsType Name -> DsM (Core TH.TypeQ)
repLTy (L _ ty) = repTy ty

411
412
413
repTy :: HsType Name -> DsM (Core TH.TypeQ)
repTy (HsForAllTy _ tvs ctxt ty)  = 
  addTyVarBinds tvs $ \bndrs -> do
414
415
    ctxt1  <- repLContext ctxt
    ty1    <- repLTy ty
416
417
    bndrs1 <- coreList nameTyConName bndrs
    repTForall bndrs1 ctxt1 ty1
418

419
repTy (HsTyVar n)
chak's avatar
chak committed
420
421
422
423
424
425
426
  | isTvOcc (nameOccName n)       = do 
				      tv1 <- lookupBinder n
				      repTvar tv1
  | otherwise		          = do 
				      tc1 <- lookupOcc n
				      repNamedTyCon tc1
repTy (HsAppTy f a)               = do 
427
428
				      f1 <- repLTy f
				      a1 <- repLTy a
chak's avatar
chak committed
429
430
				      repTapp f1 a1
repTy (HsFunTy f a)               = do 
431
432
				      f1   <- repLTy f
				      a1   <- repLTy a
chak's avatar
chak committed
433
434
435
				      tcon <- repArrowTyCon
				      repTapps tcon [f1, a1]
repTy (HsListTy t)		  = do
436
				      t1   <- repLTy t
chak's avatar
chak committed
437
438
439
				      tcon <- repListTyCon
				      repTapp tcon t1
repTy (HsPArrTy t)                = do
440
				      t1   <- repLTy t
441
				      tcon <- repTy (HsTyVar (tyConName parrTyCon))
chak's avatar
chak committed
442
443
				      repTapp tcon t1
repTy (HsTupleTy tc tys)	  = do
444
				      tys1 <- repLTys tys 
chak's avatar
chak committed
445
446
				      tcon <- repTupleTyCon (length tys)
				      repTapps tcon tys1
447
448
449
repTy (HsOpTy ty1 n ty2) 	  = repLTy ((nlHsTyVar (unLoc n) `nlHsAppTy` ty1) 
					   `nlHsAppTy` ty2)
repTy (HsParTy t)  	       	  = repLTy t
450
repTy (HsPredTy pred)             = repPred pred
451
452
repTy ty@(HsNumTy _)              = notHandled "Number types (for generics)" (ppr ty)
repTy ty			  = notHandled "Exotic form of type" (ppr ty)
453
454


chak's avatar
chak committed
455
-----------------------------------------------------------------------------
456
-- 		Expressions
chak's avatar
chak committed
457
-----------------------------------------------------------------------------
458

459
460
461
repLEs :: [LHsExpr Name] -> DsM (Core [TH.ExpQ])
repLEs es = do { es'  <- mapM repLE es ;
		 coreList expQTyConName es' }
462

chak's avatar
chak committed
463
464
465
-- 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
466
repLE :: LHsExpr Name -> DsM (Core TH.ExpQ)
467
repLE (L loc e) = putSrcSpanDs loc (repE e)
468

469
repE :: HsExpr Name -> DsM (Core TH.ExpQ)
chak's avatar
chak committed
470
471
472
repE (HsVar x)            =
  do { mb_val <- dsLookupMetaEnv x 
     ; case mb_val of
chak's avatar
chak committed
473
	Nothing	         -> do { str <- globalVar x
chak's avatar
chak committed
474
475
476
477
			       ; repVarOrCon x str }
	Just (Bound y)   -> repVarOrCon x (coreVar y)
	Just (Splice e)  -> do { e' <- dsExpr e
			       ; return (MkC e') } }
478
repE e@(HsIPVar x) = notHandled "Implicit parameters" (ppr e)
479
480
481
482
483

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

chak's avatar
chak committed
487
repE (OpApp e1 op fix e2) =
488
489
490
  do { arg1 <- repLE e1; 
       arg2 <- repLE e2; 
       the_op <- repLE op ;
491
       repInfixApp arg1 the_op arg2 } 
chak's avatar
chak committed
492
repE (NegApp x nm)        = do
493
			      a         <- repLE x
chak's avatar
chak committed
494
495
			      negateVar <- lookupOcc negateName >>= repVar
			      negateVar `repApp` a
496
497
498
repE (HsPar x)            = repLE x
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 } 
499
500
501
repE (HsCase e (MatchGroup ms _)) = do { arg <- repLE e
				       ; ms2 <- mapM repMatchTup ms
				       ; repCaseE arg (nonEmptyCoreList ms2) }
502
503
504
505
repE (HsIf x y z)         = do
			      a <- repLE x
			      b <- repLE y
			      c <- repLE z
chak's avatar
chak committed
506
507
			      repCond a b c
repE (HsLet bs e)         = do { (ss,ds) <- repBinds bs
508
			       ; e2 <- addBinds ss (repLE e)
chak's avatar
chak committed
509
			       ; z <- repLetE ds e2
510
			       ; wrapGenSyns ss z }
chak's avatar
chak committed
511
-- FIXME: I haven't got the types here right yet
512
repE (HsDo DoExpr sts body ty) 
513
 = do { (ss,zs) <- repLSts sts; 
514
	body'	<- addBinds ss $ repLE body;
515
516
	ret	<- repNoBindSt body';	
        e       <- repDoE (nonEmptyCoreList (zs ++ [ret]));
517
        wrapGenSyns ss e }
518
repE (HsDo ListComp sts body ty) 
519
 = do { (ss,zs) <- repLSts sts; 
520
	body'	<- addBinds ss $ repLE body;
521
522
	ret	<- repNoBindSt body';	
        e       <- repComp (nonEmptyCoreList (zs ++ [ret]));
523
        wrapGenSyns ss e }
524
repE e@(HsDo _ _ _ _) = notHandled "mdo and [: :]" (ppr e)
525
repE (ExplicitList ty es) = do { xs <- repLEs es; repListExp xs } 
526
527
repE e@(ExplicitPArr ty es) = notHandled "Parallel arrays" (ppr e)
repE e@(ExplicitTuple es boxed) 
528
  | isBoxed boxed         = do { xs <- repLEs es; repTup xs }
529
  | otherwise		  = notHandled "Unboxed tuples" (ppr e)
530
repE (RecordCon c _ flds)
531
 = do { x <- lookupLOcc c;
532
533
        fs <- repFields flds;
        repRecCon x fs }
534
repE (RecordUpd e flds _ _ _)
535
 = do { x <- repLE e;
536
537
        fs <- repFields flds;
        repRecUpd x fs }
538

539
repE (ExprWithTySig e ty) = do { e1 <- repLE e; t1 <- repLTy ty; repSigExp e1 t1 }
540
repE (ArithSeq _ aseq) =
chak's avatar
chak committed
541
  case aseq of
542
    From e              -> do { ds1 <- repLE e; repFrom ds1 }
chak's avatar
chak committed
543
    FromThen e1 e2      -> do 
544
545
		             ds1 <- repLE e1
			     ds2 <- repLE e2
chak's avatar
chak committed
546
547
			     repFromThen ds1 ds2
    FromTo   e1 e2      -> do 
548
549
			     ds1 <- repLE e1
			     ds2 <- repLE e2
chak's avatar
chak committed
550
551
			     repFromTo ds1 ds2
    FromThenTo e1 e2 e3 -> do 
552
553
554
			     ds1 <- repLE e1
			     ds2 <- repLE e2
			     ds3 <- repLE e3
chak's avatar
chak committed
555
			     repFromThenTo ds1 ds2 ds3
556
557
558
559
560
repE (HsSpliceE (HsSplice n _)) 
  = do { mb_val <- dsLookupMetaEnv n
       ; case mb_val of
		 Just (Splice e) -> do { e' <- dsExpr e
				       ; return (MkC e') }
561
562
		 other -> pprPanic "HsSplice" (ppr n) }
			-- Should not happen; statically checked
563

564
565
566
repE e@(PArrSeq {})      = notHandled "Parallel arrays" (ppr e)
repE e@(HsCoreAnn {})    = notHandled "Core annotations" (ppr e)
repE e@(HsSCC {})        = notHandled "Cost centres" (ppr e)
andy@galois.com's avatar
andy@galois.com committed
567
repE e@(HsTickPragma {}) = notHandled "Tick Pragma" (ppr e)
568
569
repE e@(HsBracketOut {}) = notHandled "TH brackets" (ppr e)
repE e 			 = notHandled "Expression form" (ppr e)
570
571
572
573

-----------------------------------------------------------------------------
-- Building representations of auxillary structures like Match, Clause, Stmt, 

574
repMatchTup ::  LMatch Name -> DsM (Core TH.MatchQ) 
575
repMatchTup (L _ (Match [p] ty (GRHSs guards wheres))) =
576
  do { ss1 <- mkGenSyms (collectPatBinders p) 
577
     ; addBinds ss1 $ do {
578
     ; p1 <- repLP p
579
     ; (ss2,ds) <- repBinds wheres
580
581
582
     ; addBinds ss2 $ do {
     ; gs    <- repGuards guards
     ; match <- repMatch p1 gs ds
583
     ; wrapGenSyns (ss1++ss2) match }}}
584
repMatchTup other = panic "repMatchTup: case alt with more than one arg"
585

586
repClauseTup ::  LMatch Name -> DsM (Core TH.ClauseQ)
587
repClauseTup (L _ (Match ps ty (GRHSs guards wheres))) =
588
  do { ss1 <- mkGenSyms (collectPatsBinders ps) 
589
     ; addBinds ss1 $ do {
590
       ps1 <- repLPs ps
591
     ; (ss2,ds) <- repBinds wheres
592
593
594
     ; addBinds ss2 $ do {
       gs <- repGuards guards
     ; clause <- repClause ps1 gs ds
595
     ; wrapGenSyns (ss1++ss2) clause }}}
596

597
repGuards ::  [LGRHS Name] ->  DsM (Core TH.BodyQ)
598
repGuards [L _ (GRHS [] e)]
599
  = do {a <- repLE e; repNormal a }
600
repGuards other 
601
602
603
604
  = do { zs <- mapM process other;
     let {(xs, ys) = unzip zs};
	 gd <- repGuarded (nonEmptyCoreList ys);
     wrapGenSyns (concat xs) gd }
605
  where 
606
    process :: LGRHS Name -> DsM ([GenSymBind], (Core (TH.Q (TH.Guard, TH.Exp))))
607
    process (L _ (GRHS [L _ (ExprStmt e1 _ _)] e2))
608
609
           = do { x <- repLNormalGE e1 e2;
                  return ([], x) }
610
    process (L _ (GRHS ss rhs))
611
           = do (gs, ss') <- repLSts ss
612
		rhs' <- addBinds gs $ repLE rhs
613
                g <- repPatGE (nonEmptyCoreList ss') rhs'
614
                return (gs, g)
615

616
617
618
619
620
621
repFields :: [HsRecField Name (LHsExpr Name)] -> DsM (Core [TH.Q TH.FieldExp])
repFields flds
  = do	{ fnames <- mapM lookupLOcc (map hsRecFieldId flds)
	; es <- mapM repLE (map hsRecFieldArg flds)
	; fs <- zipWithM repFieldExp fnames es
	; coreList fieldExpQTyConName fs }
622

623
624
625

-----------------------------------------------------------------------------
-- Representing Stmt's is tricky, especially if bound variables
626
-- shadow each other. Consider:  [| do { x <- f 1; x <- f x; g x } |]
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
-- First gensym new names for every variable in any of the patterns.
-- both static (x'1 and x'2), and dynamic ((gensym "x") and (gensym "y"))
-- if variables didn't shaddow, the static gensym wouldn't be necessary
-- and we could reuse the original names (x and x).
--
-- do { x'1 <- gensym "x"
--    ; x'2 <- gensym "x"   
--    ; doE [ BindSt (pvar x'1) [| f 1 |]
--          , BindSt (pvar x'2) [| f x |] 
--          , NoBindSt [| g x |] 
--          ]
--    }

-- The strategy is to translate a whole list of do-bindings by building a
-- bigger environment, and a bigger set of meta bindings 
-- (like:  x'1 <- gensym "x" ) and then combining these with the translations
-- of the expressions within the Do
      
-----------------------------------------------------------------------------
-- The helper function repSts computes the translation of each sub expression
-- and a bunch of prefix bindings denoting the dynamic renaming.

649
650
651
repLSts :: [LStmt Name] -> DsM ([GenSymBind], [Core TH.StmtQ])
repLSts stmts = repSts (map unLoc stmts)

652
repSts :: [Stmt Name] -> DsM ([GenSymBind], [Core TH.StmtQ])
653
repSts (BindStmt p e _ _ : ss) =
654
   do { e2 <- repLE e 
655
      ; ss1 <- mkGenSyms (collectPatBinders p) 
656
      ; addBinds ss1 $ do {
657
      ; p1 <- repLP p; 
658
659
660
661
      ; (ss2,zs) <- repSts ss
      ; z <- repBindSt p1 e2
      ; return (ss1++ss2, z : zs) }}
repSts (LetStmt bs : ss) =
662
   do { (ss1,ds) <- repBinds bs
663
664
665
      ; z <- repLetSt ds
      ; (ss2,zs) <- addBinds ss1 (repSts ss)
      ; return (ss1++ss2, z : zs) } 
666
repSts (ExprStmt e _ _ : ss) =       
667
   do { e2 <- repLE e
668
669
670
      ; z <- repNoBindSt e2 
      ; (ss2,zs) <- repSts ss
      ; return (ss2, z : zs) }
671
672
repSts []    = return ([],[])
repSts other = notHandled "Exotic statement" (ppr other)
673
674


675
676
677
-----------------------------------------------------------
--			Bindings
-----------------------------------------------------------
678

679
680
681
682
683
repBinds :: HsLocalBinds Name -> DsM ([GenSymBind], Core [TH.DecQ]) 
repBinds EmptyLocalBinds
  = do	{ core_list <- coreList decQTyConName []
	; return ([], core_list) }

684
repBinds b@(HsIPBinds _) = notHandled "Implicit parameters" (ppr b)
685
686
687

repBinds (HsValBinds decs)
 = do	{ let { bndrs = map unLoc (collectHsValBinders decs) }
688
689
690
691
		-- No need to worrry about detailed scopes within
		-- the binding group, because we are talking Names
		-- here, so we can safely treat it as a mutually 
		-- recursive group
692
	; ss        <- mkGenSyms bndrs
693
694
695
	; prs       <- addBinds ss (rep_val_binds decs)
	; core_list <- coreList decQTyConName 
				(de_loc (sort_by_loc prs))
696
	; return (ss, core_list) }
697

698
rep_val_binds :: HsValBinds Name -> DsM [(SrcSpan, Core TH.DecQ)]
699
-- Assumes: all the binders of the binding are alrady in the meta-env
700
701
rep_val_binds (ValBindsOut binds sigs)
 = do { core1 <- rep_binds' (unionManyBags (map snd binds))
702
      ;	core2 <- rep_sigs' sigs
703
      ;	return (core1 ++ core2) }
704
705
rep_val_binds (ValBindsIn binds sigs)
 = panic "rep_val_binds: ValBindsIn"
706

707
rep_binds :: LHsBinds Name -> DsM [Core TH.DecQ]
708
709
710
711
712
rep_binds binds = do { binds_w_locs <- rep_binds' binds
		     ; return (de_loc (sort_by_loc binds_w_locs)) }

rep_binds' :: LHsBinds Name -> DsM [(SrcSpan, Core TH.DecQ)]
rep_binds' binds = mapM rep_bind (bagToList binds)
713

714
rep_bind :: LHsBind Name -> DsM (SrcSpan, Core TH.DecQ)
715
-- Assumes: all the binders of the binding are alrady in the meta-env
716
717
718
719

-- Note GHC treats declarations of a variable (not a pattern) 
-- e.g.  x = g 5 as a Fun MonoBinds. This is indicated by a single match 
-- with an empty list of patterns
720
721
rep_bind (L loc (FunBind { fun_id = fn, 
			   fun_matches = MatchGroup [L _ (Match [] ty (GRHSs guards wheres))] _ }))
722
 = do { (ss,wherecore) <- repBinds wheres
723
	; guardcore <- addBinds ss (repGuards guards)
724
725
726
727
728
	; fn'  <- lookupLBinder fn
	; p    <- repPvar fn'
	; ans  <- repVal p guardcore wherecore
	; ans' <- wrapGenSyns ss ans
	; return (loc, ans') }
729

730
rep_bind (L loc (FunBind { fun_id = fn, fun_matches = MatchGroup ms _ }))
731
 =   do { ms1 <- mapM repClauseTup ms
732
	; fn' <- lookupLBinder fn
733
        ; ans <- repFun fn' (nonEmptyCoreList ms1)
734
        ; return (loc, ans) }
735

736
rep_bind (L loc (PatBind { pat_lhs = pat, pat_rhs = GRHSs guards wheres }))
737
 =   do { patcore <- repLP pat 
738
        ; (ss,wherecore) <- repBinds wheres
739
	; guardcore <- addBinds ss (repGuards guards)
740
741
742
        ; ans  <- repVal patcore guardcore wherecore
	; ans' <- wrapGenSyns ss ans
        ; return (loc, ans') }
743

744
rep_bind (L loc (VarBind { var_id = v, var_rhs = e}))
745
 =   do { v' <- lookupBinder v 
746
	; e2 <- repLE e
747
748
        ; x <- repNormal e2
        ; patcore <- repPvar v'
749
	; empty_decls <- coreList decQTyConName [] 
750
        ; ans <- repVal patcore x empty_decls
751
        ; return (srcLocSpan (getSrcLoc v), ans) }
752

753
754
rep_bind other = panic "rep_bind: AbsBinds"

755
-----------------------------------------------------------------------------
756
-- Since everything in a Bind is mutually recursive we need rename all
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
-- all the variables simultaneously. For example: 
-- [| AndMonoBinds (f x = x + g 2) (g x = f 1 + 2) |] would translate to
-- do { f'1 <- gensym "f"
--    ; g'2 <- gensym "g"
--    ; [ do { x'3 <- gensym "x"; fun f'1 [pvar x'3] [| x + g2 |]},
--        do { x'4 <- gensym "x"; fun g'2 [pvar x'4] [| f 1 + 2 |]}
--      ]}
-- This requires collecting the bindings (f'1 <- gensym "f"), and the 
-- environment ( f |-> f'1 ) from each binding, and then unioning them 
-- together. As we do this we collect GenSymBinds's which represent the renamed 
-- variables bound by the Bindings. In order not to lose track of these 
-- representations we build a shadow datatype MB with the same structure as 
-- MonoBinds, but which has slots for the representations


-----------------------------------------------------------------------------
773
-- GHC allows a more general form of lambda abstraction than specified
774
775
776
777
778
-- by Haskell 98. In particular it allows guarded lambda's like : 
-- (\  x | even x -> 0 | odd x -> 1) at the moment we can't represent this in
-- Haskell Template's Meta.Exp type so we punt if it isn't a simple thing like
-- (\ p1 .. pn -> exp) by causing an error.  

779
repLambda :: LMatch Name -> DsM (Core TH.ExpQ)
780
repLambda (L _ (Match ps _ (GRHSs [L _ (GRHS [] e)] EmptyLocalBinds)))
781
 = do { let bndrs = collectPatsBinders ps ;
782
      ; ss  <- mkGenSyms bndrs
783
      ; lam <- addBinds ss (
784
		do { xs <- repLPs ps; body <- repLE e; repLam xs body })
785
      ; wrapGenSyns ss lam }
786

787
repLambda (L _ m) = notHandled "Guarded labmdas" (pprMatch LambdaExpr m)
788
789
790

  
-----------------------------------------------------------------------------
791
--			Patterns
792
793
794
795
796
797
-- repP deals with patterns.  It assumes that we have already
-- walked over the pattern(s) once to collect the binders, and 
-- have extended the environment.  So every pattern-bound 
-- variable should already appear in the environment.

-- Process a list of patterns
798
repLPs :: [LPat Name] -> DsM (Core [TH.PatQ])
799
repLPs ps = do { ps' <- mapM repLP ps ;
800
		 coreList patQTyConName ps' }
801

802
repLP :: LPat Name -> DsM (Core TH.PatQ)
803
repLP (L _ p) = repP p
804

805
repP :: Pat Name -> DsM (Core TH.PatQ)
806
807
808
809
810
811
812
813
repP (WildPat _)       = repPwild 
repP (LitPat l)        = do { l2 <- repLiteral l; repPlit l2 }
repP (VarPat x)        = do { x' <- lookupBinder x; repPvar x' }
repP (LazyPat p)       = do { p1 <- repLP p; repPtilde p1 }
repP (AsPat x p)       = do { x' <- lookupLBinder x; p1 <- repLP p; repPaspat x' p1 }
repP (ParPat p)        = repLP p 
repP (ListPat ps _)    = do { qs <- repLPs ps; repPlist qs }
repP (TuplePat ps _ _) = do { qs <- repLPs ps; repPtup qs }
814
repP (ConPatIn dc details)
815
 = do { con_str <- lookupLOcc dc
816
      ; case details of
817
         PrefixCon ps   -> do { qs <- repLPs ps; repPcon con_str qs }
818
819
         RecCon pairs -> do { vs <- sequence $ map lookupLOcc (map hsRecFieldId pairs)
                            ; ps <- sequence $ map repLP (map hsRecFieldArg pairs)
820
                            ; fps <- zipWithM (\x y -> rep2 fieldPatName [unC x,unC y]) vs ps
821
                            ; fps' <- coreList fieldPatQTyConName fps
822
                            ; repPrec con_str fps' }
823
824
825
         InfixCon p1 p2 -> do { p1' <- repLP p1;
                                p2' <- repLP p2;
                                repPinfix p1' con_str p2' }
826
   }
827
repP (NPat l Nothing _ _)  = do { a <- repOverloadedLiteral l; repPlit a }
828
829
830
831
832
833
834
835
836
837
repP p@(NPat l (Just _) _ _) = notHandled "Negative overloaded patterns" (ppr p)
repP p@(SigPatIn {})  = notHandled "Type signatures in patterns" (ppr p)
	-- The problem is to do with scoped type variables.
	-- To implement them, we have to implement the scoping rules
	-- here in DsMeta, and I don't want to do that today!
	--	 do { p' <- repLP p; t' <- repLTy t; repPsig p' t' }
	--	repPsig :: Core TH.PatQ -> Core TH.TypeQ -> DsM (Core TH.PatQ)
	--	repPsig (MkC p) (MkC t) = rep2 sigPName [p, t]

repP other = notHandled "Exotic pattern" (ppr other)
838

839
840
841
----------------------------------------------------------
-- Declaration ordering helpers

842
sort_by_loc :: [(SrcSpan, a)] -> [(SrcSpan, a)]
843
844
845
sort_by_loc xs = sortBy comp xs
    where comp x y = compare (fst x) (fst y)

846
de_loc :: [(a, b)] -> [b]
847
848
de_loc = map snd

849
850
851
----------------------------------------------------------
--	The meta-environment

chak's avatar
chak committed
852
-- A name/identifier association for fresh names of locally bound entities
853
854
855
856
type GenSymBind = (Name, Id)	-- Gensym the string and bind it to the Id
				-- I.e.		(x, x_id) means
				--	let x_id = gensym "x" in ...

chak's avatar
chak committed
857
-- Generate a fresh name for a locally bound entity
858

859
860
mkGenSyms :: [Name] -> DsM [GenSymBind]
-- We can use the existing name.  For example:
861
862
863
864
865
--	[| \x_77 -> x_77 + x_77 |]
-- desugars to
--	do { x_77 <- genSym "x"; .... }
-- We use the same x_77 in the desugared program, but with the type Bndr
-- instead of Int
chak's avatar
chak committed
866
--
867
868
869
870
871
872
-- We do make it an Internal name, though (hence localiseName)
--
-- Nevertheless, it's monadic because we have to generate nameTy
mkGenSyms ns = do { var_ty <- lookupType nameTyConName
		  ; return [(nm, mkLocalId (localiseName nm) var_ty) | nm <- ns] }

873
	     
chak's avatar
chak committed
874
addBinds :: [GenSymBind] -> DsM a -> DsM a
875
876
877
-- Add a list of fresh names for locally bound entities to the 
-- meta environment (which is part of the state carried around 
-- by the desugarer monad) 
chak's avatar
chak committed
878
879
880
881
addBinds bs m = dsExtendMetaEnv (mkNameEnv [(n,Bound id) | (n,id) <- bs]) m

-- Look up a locally bound name
--
882
883
884
lookupLBinder :: Located Name -> DsM (Core TH.Name)
lookupLBinder (L _ n) = lookupBinder n

885
lookupBinder :: Name -> DsM (Core TH.Name)
886
887
888
889
lookupBinder n 
  = do { mb_val <- dsLookupMetaEnv n;
	 case mb_val of
	    Just (Bound x) -> return (coreVar x)
890
891
892
	    other	   -> failWithDs msg }
  where
    msg = ptext SLIT("DsMeta: failed binder lookup when desugaring a TH bracket:") <+> ppr n
893

chak's avatar
chak committed
894
895
-- Look up a name that is either locally bound or a global name
--
896
--  * If it is a global name, generate the "original name" representation (ie,
chak's avatar
chak committed
<