DsMeta.hs 64.3 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
40
import Class
import PrelNames
import OccName
-- 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.
41
import qualified OccName
42

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

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

73
74
dsBracket brack splices
  = dsExtendMetaEnv new_bit (do_brack brack)
75
  where
76
    new_bit = mkNameEnv [(n, Splice (unLoc e)) | (n,e) <- splices]
77

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

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


99
100
101
102
-------------------------------------------------------
-- 			Declarations
-------------------------------------------------------

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

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

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

124
	decl_ty <- lookupType decQTyConName ;
125
	let { core_list = coreList' decl_ty decls } ;
126
127
128

	dec_ty <- lookupType decTyConName ;
	q_decs  <- repSequenceQ dec_ty core_list ;
129
130

	wrapNongenSyms ss q_decs
131
132
133
134
135
	-- Do *not* gensym top-level binders
      }

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


142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
{- 	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" []] []

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

-}

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

168
169
170
171
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] 
172
        dec <- addTyVarBinds tvs $ \bndrs -> do {
173
      	       cxt1    <- repLContext cxt ;
174
               cons1   <- mapM repC cons ;
175
      	       cons2   <- coreList conQTyConName cons1 ;
176
      	       derivs1 <- repDerivs mb_derivs ;
177
178
	       bndrs1  <- coreList nameTyConName bndrs ;
      	       repData cxt1 tc1 bndrs1 cons2 derivs1 } ;
179
        return $ Just (loc, dec) }
180

181
182
183
184
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] 
185
        dec <- addTyVarBinds tvs $ \bndrs -> do {
186
      	       cxt1   <- repLContext cxt ;
187
188
               con1   <- repC con ;
      	       derivs1 <- repDerivs mb_derivs ;
189
190
	       bndrs1  <- coreList nameTyConName bndrs ;
      	       repNewtype cxt1 tc1 bndrs1 con1 derivs1 } ;
191
192
        return $ Just (loc, dec) }

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

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

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

221
222
223
224
225
226
227
228
229
230
231
232
233
-- 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
234

235
repInstD' (L loc (InstDecl ty binds _ _))		-- Ignore user pragmas for now
236
237
238
239
240
241
242
243
244
245
246
247
248
249
 = 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 }

250
	; return (loc, i)}
251
 where
252
   (tvs, cxt, cls, tys) = splitHsInstDeclTy (unLoc ty)
253

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

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

286
287
ds_msg = ptext SLIT("Cannot desugar this Template Haskell declaration:")

288
289
290
291
-------------------------------------------------------
-- 			Constructors
-------------------------------------------------------

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

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

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

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


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

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

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

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

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


-------------------------------------------------------
-- 			Types
-------------------------------------------------------
363

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

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

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

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

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

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

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

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

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


chak's avatar
chak committed
458
-----------------------------------------------------------------------------
459
-- 		Expressions
chak's avatar
chak committed
460
-----------------------------------------------------------------------------
461

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

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

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

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

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

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

567
568
569
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
570
repE e@(HsTickPragma {}) = notHandled "Tick Pragma" (ppr e)
571
572
repE e@(HsBracketOut {}) = notHandled "TH brackets" (ppr e)
repE e 			 = notHandled "Expression form" (ppr e)
573
574
575
576

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

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

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

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

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

626
627
628

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

652
653
654
repLSts :: [LStmt Name] -> DsM ([GenSymBind], [Core TH.StmtQ])
repLSts stmts = repSts (map unLoc stmts)

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


678
679
680
-----------------------------------------------------------
--			Bindings
-----------------------------------------------------------
681

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

687
repBinds b@(HsIPBinds _) = notHandled "Implicit parameters" (ppr b)
688
689
690

repBinds (HsValBinds decs)
 = do	{ let { bndrs = map unLoc (collectHsValBinders decs) }
691
692
693
694
		-- 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
695
	; ss        <- mkGenSyms bndrs
696
697
698
	; prs       <- addBinds ss (rep_val_binds decs)
	; core_list <- coreList decQTyConName 
				(de_loc (sort_by_loc prs))
699
	; return (ss, core_list) }
700

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

710
rep_binds :: LHsBinds Name -> DsM [Core TH.DecQ]
711
712
713
714
715
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)
716

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

-- 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
723
724
rep_bind (L loc (FunBind { fun_id = fn, 
			   fun_matches = MatchGroup [L _ (Match [] ty (GRHSs guards wheres))] _ }))
725
 = do { (ss,wherecore) <- repBinds wheres
726
	; guardcore <- addBinds ss (repGuards guards)
727
728
729
730
731
	; fn'  <- lookupLBinder fn
	; p    <- repPvar fn'
	; ans  <- repVal p guardcore wherecore
	; ans' <- wrapGenSyns ss ans
	; return (loc, ans') }
732

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

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

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

756
757
rep_bind other = panic "rep_bind: AbsBinds"

758
-----------------------------------------------------------------------------
759
-- Since everything in a Bind is mutually recursive we need rename all
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
-- 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


-----------------------------------------------------------------------------
776
-- GHC allows a more general form of lambda abstraction than specified
777
778
779
780
781
-- 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.  

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

790
repLambda (L _ m) = notHandled "Guarded labmdas" (pprMatch LambdaExpr m)
791
792
793

  
-----------------------------------------------------------------------------
794
--			Patterns
795
796
797
798
799
800
-- 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
801
repLPs :: [LPat Name] -> DsM (Core [TH.PatQ])
802
repLPs ps = do { ps' <- mapM repLP ps ;
803
		 coreList patQTyConName ps' }
804

805
repLP :: LPat Name -> DsM (Core TH.PatQ)
806
repLP (L _ p) = repP p
807

808
repP :: Pat Name -> DsM (Core TH.PatQ)
809
810
811
812
813
814
815
816
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 }
817
repP (ConPatIn dc details)
818
 = do { con_str <- lookupLOcc dc
819
      ; case details of
820
         PrefixCon ps   -> do { qs <- repLPs ps; repPcon con_str qs }
821
822
         RecCon pairs -> do { vs <- sequence $ map lookupLOcc (map hsRecFieldId pairs)
                            ; ps <- sequence $ map repLP (map hsRecFieldArg pairs)
823
                            ; fps <- zipWithM (\x y -> rep2 fieldPatName [unC x,unC y]) vs ps
824
                            ; fps' <- coreList fieldPatQTyConName fps
825
                            ; repPrec con_str fps' }
826
827
828
         InfixCon p1 p2 -> do { p1' <- repLP p1;
                                p2' <- repLP p2;
                                repPinfix p1' con_str p2' }
829
   }
830
repP (NPat l Nothing _ _)  = do { a <- repOverloadedLiteral l; repPlit a }
831
832
833
834
835
836
837
838
839
840
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)
841

842
843
844
----------------------------------------------------------
-- Declaration ordering helpers

845
sort_by_loc :: [(SrcSpan, a)] -> [(SrcSpan, a)]
846
847
848
sort_by_loc xs = sortBy comp xs
    where comp x y = compare (fst x) (fst y)

849
de_loc :: [(a, b)] -> [b]
850
851
de_loc = map snd

852
853
854
----------------------------------------------------------
--	The meta-environment

chak's avatar
chak committed
855
-- A name/identifier association for fresh names of locally bound entities
856
857
858
859
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
860
-- Generate a fresh name for a locally bound entity
861

862
863
mkGenSyms :: [Name] -> DsM [GenSymBind]
-- We can use the existing name.  For example:
864
865
866
867
868
--	[| \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
869
--
870
871
872
873
874
875
-- 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] }

876
	     
chak's avatar
chak committed
877
addBinds :: [GenSymBind] -> DsM a -> DsM a
878
879
880
-- 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
881
882
883
884
addBinds bs m = dsExtendMetaEnv (mkNameEnv [(n,Bound id) | (n,id) <- bs]) m

-- Look up a locally bound name
--
885
886
887
lookupLBinder :: Located Name -> DsM (Core TH.Name)
lookupLBinder (L _ n) = lookupBinder n

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