DsMeta.hs 65 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
{-# OPTIONS -w #-}
17
18
19
-- The above warning supression flag is a temporary kludge.
-- While working on this module you are encouraged to remove it and fix
-- any warnings in the module. See
Ian Lynagh's avatar
Ian Lynagh committed
20
--     http://hackage.haskell.org/trac/ghc/wiki/Commentary/CodingStyle#Warnings
21
-- for details
22

23
24
module DsMeta( dsBracket, 
	       templateHaskellNames, qTyConName, nameTyConName,
25
	       liftName, expQTyConName, decQTyConName, typeQTyConName,
26
27
	       decTyConName, typeTyConName, mkNameG_dName, mkNameG_vName, mkNameG_tcName
	        ) where
28
29
30
31
32

#include "HsVersions.h"

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

Simon Marlow's avatar
Simon Marlow committed
33
34
import MatchLit
import DsUtils
35
36
import DsMonad

37
import qualified Language.Haskell.TH as TH
38

39
import HsSyn
Simon Marlow's avatar
Simon Marlow committed
40
41
42
43
44
45
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.
46
import qualified OccName
47

Simon Marlow's avatar
Simon Marlow committed
48
49
50
import Module
import Id
import Name
51
import NameEnv
Simon Marlow's avatar
Simon Marlow committed
52
53
54
import TcType
import TyCon
import TysWiredIn
55
import CoreSyn
Simon Marlow's avatar
Simon Marlow committed
56
57
58
59
60
import CoreUtils
import SrcLoc
import PackageConfig
import Unique
import BasicTypes
61
import Outputable
Simon Marlow's avatar
Simon Marlow committed
62
63
64
import Bag
import FastString
import ForeignCall
65

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

76
77
dsBracket brack splices
  = dsExtendMetaEnv new_bit (do_brack brack)
78
  where
79
    new_bit = mkNameEnv [(n, Splice (unLoc e)) | (n,e) <- splices]
80

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

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


102
103
104
105
-------------------------------------------------------
-- 			Declarations
-------------------------------------------------------

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

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

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

127
	decl_ty <- lookupType decQTyConName ;
128
	let { core_list = coreList' decl_ty decls } ;
129
130
131

	dec_ty <- lookupType decTyConName ;
	q_decs  <- repSequenceQ dec_ty core_list ;
132
133

	wrapNongenSyms ss q_decs
134
135
136
137
138
	-- Do *not* gensym top-level binders
      }

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


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

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

-}

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

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

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

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

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

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

224
225
226
227
228
229
230
231
232
233
234
235
236
-- 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
237

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

253
	; return (loc, i)}
254
 where
255
   (tvs, cxt, cls, tys) = splitHsInstDeclTy (unLoc ty)
256

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

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

289
290
ds_msg = ptext SLIT("Cannot desugar this Template Haskell declaration:")

291
292
293
294
-------------------------------------------------------
-- 			Constructors
-------------------------------------------------------

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

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

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

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


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

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

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

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

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


-------------------------------------------------------
-- 			Types
-------------------------------------------------------
366

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

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

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

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

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

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

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

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

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


chak's avatar
chak committed
461
-----------------------------------------------------------------------------
462
-- 		Expressions
chak's avatar
chak committed
463
-----------------------------------------------------------------------------
464

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

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

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

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

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

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

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

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

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

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

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

622
623
repFields :: HsRecordBinds Name -> DsM (Core [TH.Q TH.FieldExp])
repFields (HsRecFields { rec_flds = flds })
624
625
626
627
  = do	{ fnames <- mapM lookupLOcc (map hsRecFieldId flds)
	; es <- mapM repLE (map hsRecFieldArg flds)
	; fs <- zipWithM repFieldExp fnames es
	; coreList fieldExpQTyConName fs }
628

629
630
631

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

655
656
657
repLSts :: [LStmt Name] -> DsM ([GenSymBind], [Core TH.StmtQ])
repLSts stmts = repSts (map unLoc stmts)

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


681
682
683
-----------------------------------------------------------
--			Bindings
-----------------------------------------------------------
684

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

690
repBinds b@(HsIPBinds _) = notHandled "Implicit parameters" (ppr b)
691
692
693

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

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

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

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

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

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

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

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

759
760
rep_bind other = panic "rep_bind: AbsBinds"

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


-----------------------------------------------------------------------------
779
-- GHC allows a more general form of lambda abstraction than specified
780
781
782
783
784
-- 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.  

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

793
repLambda (L _ m) = notHandled "Guarded labmdas" (pprMatch (LambdaExpr :: HsMatchContext Name) m)
794
795
796

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

808
repLP :: LPat Name -> DsM (Core TH.PatQ)
809
repLP (L _ p) = repP p
810

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

846
847
848
----------------------------------------------------------
-- Declaration ordering helpers

849
sort_by_loc :: [(SrcSpan, a)] -> [(SrcSpan, a)]
850
851
852
sort_by_loc xs = sortBy comp xs
    where comp x y = compare (fst x) (fst y)

853
de_loc :: [(a, b)] -> [b]
854
855
de_loc = map snd

856
857
858
----------------------------------------------------------
--	The meta-environment

chak's avatar
chak committed
859
-- A name/identifier association for fresh names of locally bound entities
860
861
862
863
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
864
-- Generate a fresh name for a locally bound entity
865

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

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

-- Look up a locally bound name
--
889
890
891
lookupLBinder :: Located Name -> DsM (Core TH.Name)
lookupLBinder (L _ n) = lookupBinder n

892
lookupBinder :: Name -> DsM (