DsMeta.hs 63.6 KB
Newer Older
1
2
3
4
5
-----------------------------------------------------------------------------
-- 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.
6
7
8
9
10
--
-- 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).
11
12
13
-----------------------------------------------------------------------------


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

#include "HsVersions.h"

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

24
import MatchLit	  ( dsLit )
25
import DsUtils    ( mkListExpr, mkStringExpr, mkCoreTup, mkIntExpr )
26
27
import DsMonad

28
import qualified Language.Haskell.TH as TH
29

30
import HsSyn
31
import Class (FunDep)
32
import PrelNames  ( rationalTyConName, integerTyConName, negateName )
33
import OccName	  ( isDataOcc, isTvOcc, occNameUserString )
34
35
36
37
-- 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.
38
import qualified OccName
39

40
import Module	  ( Module, mkModule, moduleUserString )
41
import Id         ( Id, mkLocalId )
42
import OccName	  ( mkOccFS )
43
44
import Name       ( Name, mkExternalName, localiseName, nameOccName, nameModule, 
		    isExternalName, getSrcLoc )
45
import NameEnv
46
import Type       ( Type, mkGenTyConApp )
47
import TcType	  ( tcTyConAppArgs )
48
49
import TyCon	  ( tyConName )
import TysWiredIn ( parrTyCon )
50
51
import CoreSyn
import CoreUtils  ( exprType )
52
53
import SrcLoc	  ( noSrcLoc, unLoc, Located(..), SrcSpan, srcLocSpan )
import Maybe	  ( catMaybes )
54
import Unique	  ( mkPreludeTyConUnique, mkPreludeMiscIdUnique, getKey, Uniquable(..) )
55
import BasicTypes ( isBoxed ) 
56
import Outputable
57
import Bag	  ( bagToList, unionManyBags )
58
import FastString ( unpackFS )
59
import ForeignCall ( Safety(..), CCallConv(..), CCallTarget(..) )
60
61

import Monad ( zipWithM )
62
import List ( sortBy )
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
136
    [n | d <- tycl_decls, n <- tyClDeclNames (unLoc d)] ++
    [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
215
216
repTyClD (L loc d) = putSrcSpanDs loc $
		     do { dsWarn (hang ds_msg 4 (ppr d))
			; 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
233
234
235
236
237
238
239
240
241
242
243
244
245
246
repInstD' (L loc (InstDecl ty binds _))		-- Ignore user pragmas for now
 = 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
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
repForD :: Located (ForeignDecl Name) -> DsM (SrcSpan, Core TH.DecQ)
repForD (L loc (ForeignImport name typ (CImport cc s ch cn cis) _))
 = do MkC name' <- lookupLOcc name
      MkC typ' <- repLTy typ
      MkC cc' <- repCCallConv cc
      MkC s' <- repSafety s
      MkC str <- coreStringLit $ static
                              ++ unpackFS ch ++ " "
                              ++ unpackFS cn ++ " "
                              ++ conv_cimportspec cis
      dec <- rep2 forImpDName [cc', s', str, name', typ']
      return (loc, dec)
 where
    conv_cimportspec (CLabel cls) = panic "repForD': CLabel Not handled"
    conv_cimportspec (CFunction DynamicTarget) = "dynamic"
    conv_cimportspec (CFunction (StaticTarget fs)) = unpackFS fs
    conv_cimportspec CWrapper = "wrapper"
    static = case cis of
                 CFunction (StaticTarget _) -> "static "
                 _ -> ""

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 []

281
282
ds_msg = ptext SLIT("Cannot desugar this Template Haskell declaration:")

283
284
285
286
-------------------------------------------------------
-- 			Constructors
-------------------------------------------------------

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

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

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

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


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

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

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

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

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


-------------------------------------------------------
-- 			Types
-------------------------------------------------------
359

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

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

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

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

392
repPred :: HsPred Name -> DsM (Core TH.TypeQ)
chak's avatar
chak committed
393
394
repPred (HsClassP cls tys) = do
			       tcon <- repTy (HsTyVar cls)
395
			       tys1 <- repLTys tys
chak's avatar
chak committed
396
397
398
399
400
401
			       repTapps tcon tys1
repPred (HsIParam _ _)     = 
  panic "DsMeta.repTy: Can't represent predicates with implicit parameters"

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

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

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

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


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

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

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

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

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

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

541
repE (ExprWithTySig e ty) = do { e1 <- repLE e; t1 <- repLTy ty; repSigExp e1 t1 }
542
repE (ArithSeq _ aseq) =
chak's avatar
chak committed
543
  case aseq of
544
    From e              -> do { ds1 <- repLE e; repFrom ds1 }
chak's avatar
chak committed
545
    FromThen e1 e2      -> do 
546
547
		             ds1 <- repLE e1
			     ds2 <- repLE e2
chak's avatar
chak committed
548
549
			     repFromThen ds1 ds2
    FromTo   e1 e2      -> do 
550
551
			     ds1 <- repLE e1
			     ds2 <- repLE e2
chak's avatar
chak committed
552
553
			     repFromTo ds1 ds2
    FromThenTo e1 e2 e3 -> do 
554
555
556
			     ds1 <- repLE e1
			     ds2 <- repLE e2
			     ds3 <- repLE e3
chak's avatar
chak committed
557
			     repFromThenTo ds1 ds2 ds3
558
repE (PArrSeq _ aseq)     = panic "DsMeta.repE: parallel array seq.s missing"
559
repE (HsCoreAnn _ _)      = panic "DsMeta.repE: Can't represent CoreAnn" -- hdaume: core annotations
chak's avatar
chak committed
560
repE (HsSCC _ _)          = panic "DsMeta.repE: Can't represent SCC"
561
562
563
564
565
566
567
568
569
repE (HsBracketOut _ _)   = panic "DsMeta.repE: Can't represent Oxford brackets"
repE (HsSpliceE (HsSplice n _)) 
  = do { mb_val <- dsLookupMetaEnv n
       ; case mb_val of
		 Just (Splice e) -> do { e' <- dsExpr e
				       ; return (MkC e') }
		 other	     -> pprPanic "HsSplice" (ppr n) }

repE e = pprPanic "DsMeta.repE: Illegal 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

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

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

615
repFields :: [(Located Name, LHsExpr Name)] -> DsM (Core [TH.Q TH.FieldExp])
616
repFields flds = do
617
618
        fnames <- mapM lookupLOcc (map fst flds)
        es <- mapM repLE (map snd flds)
619
620
        fs <- zipWithM repFieldExp fnames es
        coreList fieldExpQTyConName fs
621

622
623
624

-----------------------------------------------------------------------------
-- Representing Stmt's is tricky, especially if bound variables
625
-- shadow each other. Consider:  [| do { x <- f 1; x <- f x; g x } |]
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
-- 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.

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

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


674
675
676
-----------------------------------------------------------
--			Bindings
-----------------------------------------------------------
677

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

repBinds (HsIPBinds _)
  = panic "DsMeta:repBinds: can't do implicit parameters"

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
704
      ;	return (core1 ++ core2) }

705
rep_binds :: LHsBinds Name -> DsM [Core TH.DecQ]
706
707
708
709
710
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)
711

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

-- 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
718
rep_bind (L loc (FunBind fn infx (MatchGroup [L _ (Match [] ty (GRHSs guards wheres))] _) _))
719
 = do { (ss,wherecore) <- repBinds wheres
720
	; guardcore <- addBinds ss (repGuards guards)
721
722
723
724
725
	; fn'  <- lookupLBinder fn
	; p    <- repPvar fn'
	; ans  <- repVal p guardcore wherecore
	; ans' <- wrapGenSyns ss ans
	; return (loc, ans') }
726

727
rep_bind (L loc (FunBind fn infx (MatchGroup ms _) _))
728
 =   do { ms1 <- mapM repClauseTup ms
729
	; fn' <- lookupLBinder fn
730
        ; ans <- repFun fn' (nonEmptyCoreList ms1)
731
        ; return (loc, ans) }
732

733
rep_bind (L loc (PatBind pat (GRHSs guards wheres) ty2 _))
734
 =   do { patcore <- repLP pat 
735
        ; (ss,wherecore) <- repBinds wheres
736
	; guardcore <- addBinds ss (repGuards guards)
737
738
739
        ; ans  <- repVal patcore guardcore wherecore
	; ans' <- wrapGenSyns ss ans
        ; return (loc, ans') }
740

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

-----------------------------------------------------------------------------
751
-- Since everything in a Bind is mutually recursive we need rename all
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
-- 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


-----------------------------------------------------------------------------
768
-- GHC allows a more general form of lambda abstraction than specified
769
770
771
772
773
-- 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.  

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

repLambda z = panic "Can't represent a guarded lambda in Template Haskell"  

  
-----------------------------------------------------------------------------
786
--			Patterns
787
788
789
790
791
792
-- 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
793
repLPs :: [LPat Name] -> DsM (Core [TH.PatQ])
794
repLPs ps = do { ps' <- mapM repLP ps ;
795
		 coreList patQTyConName ps' }
796

797
repLP :: LPat Name -> DsM (Core TH.PatQ)
798
repLP (L _ p) = repP p
799

800
repP :: Pat Name -> DsM (Core TH.PatQ)
801
802
803
repP (WildPat _)     = repPwild 
repP (LitPat l)      = do { l2 <- repLiteral l; repPlit l2 }
repP (VarPat x)      = do { x' <- lookupBinder x; repPvar x' }
804
805
806
807
808
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 }
809
repP (ConPatIn dc details)
810
 = do { con_str <- lookupLOcc dc
811
      ; case details of
812
813
814
         PrefixCon ps   -> do { qs <- repLPs ps; repPcon con_str qs }
         RecCon pairs -> do { vs <- sequence $ map lookupLOcc (map fst pairs)
                            ; ps <- sequence $ map repLP (map snd pairs)
815
                            ; fps <- zipWithM (\x y -> rep2 fieldPatName [unC x,unC y]) vs ps
816
                            ; fps' <- coreList fieldPatQTyConName fps
817
                            ; repPrec con_str fps' }
818
819
820
         InfixCon p1 p2 -> do { p1' <- repLP p1;
                                p2' <- repLP p2;
                                repPinfix p1' con_str p2' }
821
   }
822
823
repP (NPat l (Just _) _ _) = panic "Can't cope with negative overloaded patterns yet (repP (NPat _ (Just _)))"
repP (NPat l Nothing _ _)  = do { a <- repOverloadedLiteral l; repPlit a }
824
repP (SigPatIn p t)  = do { p' <- repLP p; t' <- repLTy t; repPsig p' t' }
825
826
repP other = panic "Exotic pattern inside meta brackets"

827
828
829
----------------------------------------------------------
-- Declaration ordering helpers

830
sort_by_loc :: [(SrcSpan, a)] -> [(SrcSpan, a)]
831
832
833
sort_by_loc xs = sortBy comp xs
    where comp x y = compare (fst x) (fst y)

834
de_loc :: [(a, b)] -> [b]
835
836
de_loc = map snd

837
838
839
----------------------------------------------------------
--	The meta-environment

chak's avatar
chak committed
840
-- A name/identifier association for fresh names of locally bound entities
841
842
843
844
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
845
-- Generate a fresh name for a locally bound entity
846

847
848
mkGenSyms :: [Name] -> DsM [GenSymBind]
-- We can use the existing name.  For example:
849
850
851
852
853
--	[| \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
854
--
855
856
857
858
859
860
-- 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] }

861
	     
chak's avatar
chak committed
862
addBinds :: [GenSymBind] -> DsM a -> DsM a
863
864
865
-- 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
866
867
868
869
addBinds bs m = dsExtendMetaEnv (mkNameEnv [(n,Bound id) | (n,id) <- bs]) m

-- Look up a locally bound name
--
870
871
872
lookupLBinder :: Located Name -> DsM (Core TH.Name)
lookupLBinder (L _ n) = lookupBinder n

873
lookupBinder :: Name -> DsM (Core TH.Name)
874
875
876
877
878
879
lookupBinder n 
  = do { mb_val <- dsLookupMetaEnv n;
	 case mb_val of
	    Just (Bound x) -> return (coreVar x)
	    other	   -> pprPanic "Failed binder lookup:" (ppr n) }

chak's avatar
chak committed
880
881
-- Look up a name that is either locally bound or a global name
--
882
--  * If it is a global name, generate the "original name" representation (ie,
chak's avatar
chak committed
883
884
--   the <module>:<name> form) for the associated entity
--
885
lookupLOcc :: Located Name -> DsM (Core TH.Name)
886
887
-- Lookup an occurrence; it can't be a splice.
-- Use the in-scope bindings if they exist
888
889
890
lookupLOcc (L _ n) = lookupOcc n

lookupOcc :: Name -> DsM (Core TH.Name)
891
892
893
894
895
896
897
898
lookupOcc n
  = do {  mb_val <- dsLookupMetaEnv n ;
          case mb_val of
		Nothing         -> globalVar n
		Just (Bound x)  -> return (coreVar x)
		Just (Splice _) -> pprPanic "repE:lookupOcc" (ppr n) 
    }

899
900
901
902
903
904
905
906
907
908
909
910
911
globalVar :: Name -> DsM (Core TH.Name)
-- Not bound by the meta-env
-- Could be top-level; or could be local
--	f x = $(g [| x |])
-- Here the x will be local
globalVar name
  | isExternalName name
  = do	{ MkC mod <- coreStringLit name_mod
	; MkC occ <- occNameLit name
	; rep2 mk_varg [mod,occ] }
  | otherwise
  = do 	{ MkC occ <- occNameLit name
	; MkC uni <- coreIntLit (getKey (getUnique name))
912
	; rep2 mkNameLName [occ,uni] }
913
914
915
916
917
918
919
920
921
  where
      name_mod = moduleUserString (nameModule name)
      name_occ = nameOccName name
      mk_varg | OccName.isDataOcc name_occ = mkNameG_dName
	      | OccName.isVarOcc  name_occ = mkNameG_vName
	      | OccName.isTcOcc   name_occ = mkNameG_tcName
	      | otherwise 	           = pprPanic "DsMeta.globalVar" (ppr name)

lookupType :: Name 	-- Name of type constructor (e.g. TH.ExpQ)
922
923
924
925
	   -> DsM Type	-- The type
lookupType tc_name = do { tc <- dsLookupTyCon tc_name ;
		          return (mkGenTyConApp tc []) }

926
wrapGenSyns :: [GenSymBind] 
927
	    -> Core (TH.Q a) -> DsM (Core (TH.Q a))
928
929
930
931
-- wrapGenSyns [(nm1,id1), (nm2,id2)] y 
--	--> bindQ (gensym nm1) (\ id1 -> 
--	    bindQ (gensym nm2 (\ id2 -> 
--	    y))
932

933
wrapGenSyns binds body@(MkC b)