DsMeta.hs 69.7 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 -fwarn-unused-imports #-}
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
-- The kludge is only needed in this module because of trac #2267.
23

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

31
32
#include "HsVersions.h"

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

Simon Marlow's avatar
Simon Marlow committed
35
import MatchLit
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( isDataOcc, isVarOcc, isTcOcc, varName, tcName ) 
48

Simon Marlow's avatar
Simon Marlow committed
49
50
import Module
import Id
51
import Name hiding( isVarOcc, isTcOcc, varName, tcName ) 
52
import NameEnv
Simon Marlow's avatar
Simon Marlow committed
53
54
55
import TcType
import TyCon
import TysWiredIn
56
import CoreSyn
57
import MkCore
Simon Marlow's avatar
Simon Marlow committed
58
59
60
61
import CoreUtils
import SrcLoc
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
Ian Lynagh's avatar
Ian Lynagh committed
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
	-- Do *not* gensym top-level binders
      }

Ian Lynagh's avatar
Ian Lynagh committed
138
groupBinders :: HsGroup Name -> [Located Name]
139
140
groupBinders (HsGroup { hs_valds = val_decls, hs_tyclds = tycl_decls,
			hs_fords = foreign_decls })
141
-- Collect the binders of a Group
142
  = collectHsValBinders val_decls ++
143
    [n | d <- tycl_decls, n <- tyClDeclNames (unLoc d)] ++
144
    [n | L _ (ForeignImport n _ _) <- foreign_decls]
145
146


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

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

-}

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

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

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

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

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

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

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

Ian Lynagh's avatar
Ian Lynagh committed
240
repInstD' :: LInstDecl Name -> DsM (SrcSpan, Core TH.DecQ)
241
repInstD' (L loc (InstDecl ty binds _ _))		-- Ignore user pragmas for now
Ian Lynagh's avatar
Ian Lynagh committed
242
 = do	{ i <- addTyVarBinds tvs $ \_ ->
243
244
245
246
247
248
249
250
251
252
253
254
255
		-- 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 }

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

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

repCCallConv :: CCallConv -> DsM (Core TH.Callconv)
repCCallConv CCallConv = rep2 cCallName []
repCCallConv StdCallConv = rep2 stdCallName []
Ian Lynagh's avatar
Ian Lynagh committed
286
repCCallConv CmmCallConv = notHandled "repCCallConv" (ppr CmmCallConv)
287
288
289
290
291
292

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

Ian Lynagh's avatar
Ian Lynagh committed
293
ds_msg :: SDoc
Ian Lynagh's avatar
Ian Lynagh committed
294
ds_msg = ptext (sLit "Cannot desugar this Template Haskell declaration:")
295

296
297
298
299
-------------------------------------------------------
-- 			Constructors
-------------------------------------------------------

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

316
repBangTy :: LBangType Name -> DsM (Core (TH.StrictTypeQ))
317
318
319
repBangTy ty= do 
  MkC s <- rep2 str []
  MkC t <- repLTy ty'
320
  rep2 strictTypeName [s, t]
321
322
323
  where 
    (str, ty') = case ty of
		   L _ (HsBangTy _ ty) -> (isStrictName,  ty)
Ian Lynagh's avatar
Ian Lynagh committed
324
		   _                   -> (notStrictName, ty)
325
326
327
328
329

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

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


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

346
rep_sigs :: [LSig Name] -> DsM [Core TH.DecQ]
347
348
349
rep_sigs sigs = do locs_cores <- rep_sigs' sigs
                   return $ de_loc $ sort_by_loc locs_cores

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

355
rep_sig :: LSig Name -> DsM [(SrcSpan, Core TH.DecQ)]
356
357
	-- Singleton => Ok
	-- Empty     => Too hard, signature ignored
358
rep_sig (L loc (TypeSig nm ty)) = rep_proto nm ty loc
Ian Lynagh's avatar
Ian Lynagh committed
359
rep_sig _                       = return []
360

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


-------------------------------------------------------
-- 			Types
-------------------------------------------------------
371

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

chak's avatar
chak committed
388
389
-- represent a type context
--
390
391
392
repLContext :: LHsContext Name -> DsM (Core TH.CxtQ)
repLContext (L _ ctxt) = repContext ctxt

393
repContext :: HsContext Name -> DsM (Core TH.CxtQ)
chak's avatar
chak committed
394
repContext ctxt = do 
395
	            preds    <- mapM repLPred ctxt
396
		    predList <- coreList typeQTyConName preds
chak's avatar
chak committed
397
		    repCtxt predList
398

chak's avatar
chak committed
399
400
-- represent a type predicate
--
401
402
403
repLPred :: LHsPred Name -> DsM (Core TH.TypeQ)
repLPred (L _ p) = repPred p

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

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

chak's avatar
chak committed
417
418
-- represent a type
--
419
420
421
repLTy :: LHsType Name -> DsM (Core TH.TypeQ)
repLTy (L _ ty) = repTy ty

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

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


chak's avatar
chak committed
466
-----------------------------------------------------------------------------
467
-- 		Expressions
chak's avatar
chak committed
468
-----------------------------------------------------------------------------
469

470
471
472
repLEs :: [LHsExpr Name] -> DsM (Core [TH.ExpQ])
repLEs es = do { es'  <- mapM repLE es ;
		 coreList expQTyConName es' }
473

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

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

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

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

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

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

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

585
repMatchTup ::  LMatch Name -> DsM (Core TH.MatchQ) 
Ian Lynagh's avatar
Ian Lynagh committed
586
repMatchTup (L _ (Match [p] _ (GRHSs guards wheres))) =
587
  do { ss1 <- mkGenSyms (collectPatBinders p) 
588
     ; addBinds ss1 $ do {
589
     ; p1 <- repLP p
590
     ; (ss2,ds) <- repBinds wheres
591
592
593
     ; addBinds ss2 $ do {
     ; gs    <- repGuards guards
     ; match <- repMatch p1 gs ds
594
     ; wrapGenSyns (ss1++ss2) match }}}
Ian Lynagh's avatar
Ian Lynagh committed
595
repMatchTup _ = panic "repMatchTup: case alt with more than one arg"
596

597
repClauseTup ::  LMatch Name -> DsM (Core TH.ClauseQ)
Ian Lynagh's avatar
Ian Lynagh committed
598
repClauseTup (L _ (Match ps _ (GRHSs guards wheres))) =
599
  do { ss1 <- mkGenSyms (collectPatsBinders ps) 
600
     ; addBinds ss1 $ do {
601
       ps1 <- repLPs ps
602
     ; (ss2,ds) <- repBinds wheres
603
604
605
     ; addBinds ss2 $ do {
       gs <- repGuards guards
     ; clause <- repClause ps1 gs ds
606
     ; wrapGenSyns (ss1++ss2) clause }}}
607

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

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

634
635
636

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

660
661
662
repLSts :: [LStmt Name] -> DsM ([GenSymBind], [Core TH.StmtQ])
repLSts stmts = repSts (map unLoc stmts)

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


686
687
688
-----------------------------------------------------------
--			Bindings
-----------------------------------------------------------
689

690
691
692
693
694
repBinds :: HsLocalBinds Name -> DsM ([GenSymBind], Core [TH.DecQ]) 
repBinds EmptyLocalBinds
  = do	{ core_list <- coreList decQTyConName []
	; return ([], core_list) }

695
repBinds b@(HsIPBinds _) = notHandled "Implicit parameters" (ppr b)
696
697
698

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

709
rep_val_binds :: HsValBinds Name -> DsM [(SrcSpan, Core TH.DecQ)]
710
-- Assumes: all the binders of the binding are alrady in the meta-env
711
712
rep_val_binds (ValBindsOut binds sigs)
 = do { core1 <- rep_binds' (unionManyBags (map snd binds))
713
      ;	core2 <- rep_sigs' sigs
714
      ;	return (core1 ++ core2) }
Ian Lynagh's avatar
Ian Lynagh committed
715
rep_val_binds (ValBindsIn _ _)
716
 = panic "rep_val_binds: ValBindsIn"
717

718
rep_binds :: LHsBinds Name -> DsM [Core TH.DecQ]
719
720
721
722
723
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)
724

725
rep_bind :: LHsBind Name -> DsM (SrcSpan, Core TH.DecQ)
726
-- Assumes: all the binders of the binding are alrady in the meta-env
727
728
729
730

-- 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
731
rep_bind (L loc (FunBind { fun_id = fn, 
Ian Lynagh's avatar
Ian Lynagh committed
732
			   fun_matches = MatchGroup [L _ (Match [] _ (GRHSs guards wheres))] _ }))
733
 = do { (ss,wherecore) <- repBinds wheres
734
	; guardcore <- addBinds ss (repGuards guards)
735
736
737
738
739
	; fn'  <- lookupLBinder fn
	; p    <- repPvar fn'
	; ans  <- repVal p guardcore wherecore
	; ans' <- wrapGenSyns ss ans
	; return (loc, ans') }
740

741
rep_bind (L loc (FunBind { fun_id = fn, fun_matches = MatchGroup ms _ }))
742
 =   do { ms1 <- mapM repClauseTup ms
743
	; fn' <- lookupLBinder fn
744
        ; ans <- repFun fn' (nonEmptyCoreList ms1)
745
        ; return (loc, ans) }
746

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

Ian Lynagh's avatar
Ian Lynagh committed
755
rep_bind (L _ (VarBind { var_id = v, var_rhs = e}))
756
 =   do { v' <- lookupBinder v 
757
	; e2 <- repLE e
758
759
        ; x <- repNormal e2
        ; patcore <- repPvar v'
760
	; empty_decls <- coreList decQTyConName [] 
761
        ; ans <- repVal patcore x empty_decls
762
        ; return (srcLocSpan (getSrcLoc v), ans) }
763

Ian Lynagh's avatar
Ian Lynagh committed
764
rep_bind (L _ (AbsBinds {})) = panic "rep_bind: AbsBinds"
765

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


-----------------------------------------------------------------------------
784
-- GHC allows a more general form of lambda abstraction than specified
785
786
787
788
789
-- 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.  

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

798
repLambda (L _ m) = notHandled "Guarded labmdas" (pprMatch (LambdaExpr :: HsMatchContext Name) m)
799
800
801

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

813
repLP :: LPat Name -> DsM (Core TH.PatQ)
814
repLP (L _ p) = repP p
815

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

851
852
853
----------------------------------------------------------
-- Declaration ordering helpers

854
sort_by_loc :: [(SrcSpan, a)] -> [(SrcSpan, a)]
855
856
857
sort_by_loc xs = sortBy comp xs
    where comp x y = compare (fst x) (fst y)

858
de_loc :: [(a, b)] -> [b]
859
860
de_loc = map snd