DsMeta.hs 65.4 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
26
27
	       liftName, expQTyConName, patQTyConName, decQTyConName, typeQTyConName,
	       decTyConName, typeTyConName, mkNameG_dName, mkNameG_vName, mkNameG_tcName,
	       quoteExpName, quotePatName
28
	        ) where
29
30
31
32
33

#include "HsVersions.h"

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

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

38
import qualified Language.Haskell.TH as TH
39

40
import HsSyn
Simon Marlow's avatar
Simon Marlow committed
41
42
43
44
45
46
import Class
import PrelNames
-- To avoid clashes with DsMeta.varName we must make a local alias for
-- OccName.varName we do this by removing varName from the import of
-- OccName above, making a qualified instance of OccName and using
-- OccNameAlias.varName where varName ws previously used in this file.
47
import qualified OccName
48

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

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

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

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

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


103
104
105
106
-------------------------------------------------------
-- 			Declarations
-------------------------------------------------------

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

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

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

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

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

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

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


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

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

-}

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

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

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

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

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

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

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

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

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

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

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

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

292
293
294
295
-------------------------------------------------------
-- 			Constructors
-------------------------------------------------------

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

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

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

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


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

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

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

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

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


-------------------------------------------------------
-- 			Types
-------------------------------------------------------
367

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

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

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

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

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

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

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

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

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


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

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

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

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

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

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

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

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

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

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

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

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

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

630
631
632

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

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

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


682
683
684
-----------------------------------------------------------
--			Bindings
-----------------------------------------------------------
685

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

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

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

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

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

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

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

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

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

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

760
761
rep_bind other = panic "rep_bind: AbsBinds"

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


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

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

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

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

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

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

847
848
849
----------------------------------------------------------
-- Declaration ordering helpers

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

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

857
858
859
----------------------------------------------------------
--	The meta-environment

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

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

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

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

</