DsMeta.hs 69.6 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
-----------------------------------------------------------------------------

Ian Lynagh's avatar
Ian Lynagh committed
16
{-# OPTIONS -fno-warn-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

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
import CoreUtils
import SrcLoc
import Unique
import BasicTypes
60
import Outputable
Simon Marlow's avatar
Simon Marlow committed
61 62 63
import Bag
import FastString
import ForeignCall
64

Simon Marlow's avatar
Simon Marlow committed
65 66 67
import Data.Maybe
import Control.Monad
import Data.List
Ian Lynagh's avatar
Ian Lynagh committed
68

69 70
-----------------------------------------------------------------------------
dsBracket :: HsBracket Name -> [PendingSplice] -> DsM CoreExpr
71
-- Returns a CoreExpr of type TH.ExpQ
72 73 74
-- The quoted thing is parameterised over Name, even though it has
-- been type checked.  We don't want all those type decorations!

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

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

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


101 102 103 104
-------------------------------------------------------
-- 			Declarations
-------------------------------------------------------

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

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

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

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

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

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

Ian Lynagh's avatar
Ian Lynagh committed
136
groupBinders :: HsGroup Name -> [Located Name]
137 138
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

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

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

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
291
ds_msg :: SDoc
Ian Lynagh's avatar
Ian Lynagh committed
292
ds_msg = ptext (sLit "Cannot desugar this Template Haskell declaration:")
293

294 295 296 297
-------------------------------------------------------
-- 			Constructors
-------------------------------------------------------

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

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

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

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


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

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

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

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

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


-------------------------------------------------------
-- 			Types
-------------------------------------------------------
369

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

386 387
-- represent a type context
--
388 389 390
repLContext :: LHsContext Name -> DsM (Core TH.CxtQ)
repLContext (L _ ctxt) = repContext ctxt

391
repContext :: HsContext Name -> DsM (Core TH.CxtQ)
392
repContext ctxt = do 
393
	            preds    <- mapM repLPred ctxt
394
		    predList <- coreList typeQTyConName preds
395
		    repCtxt predList
396

397 398
-- represent a type predicate
--
399 400 401
repLPred :: LHsPred Name -> DsM (Core TH.TypeQ)
repLPred (L _ p) = repPred p

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

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

415 416
-- represent a type
--
417 418 419
repLTy :: LHsType Name -> DsM (Core TH.TypeQ)
repLTy (L _ ty) = repTy ty

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

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


464
-----------------------------------------------------------------------------
465
-- 		Expressions
466
-----------------------------------------------------------------------------
467

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

472 473 474
-- 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
475
repLE :: LHsExpr Name -> DsM (Core TH.ExpQ)
476
repLE (L loc e) = putSrcSpanDs loc (repE e)
477

478
repE :: HsExpr Name -> DsM (Core TH.ExpQ)
479 480 481
repE (HsVar x)            =
  do { mb_val <- dsLookupMetaEnv x 
     ; case mb_val of
482
	Nothing	         -> do { str <- globalVar x
483 484 485 486
			       ; 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
487
repE e@(HsIPVar _) = notHandled "Implicit parameters" (ppr e)
488 489 490 491 492

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

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

548
repE (ExprWithTySig e ty) = do { e1 <- repLE e; t1 <- repLTy ty; repSigExp e1 t1 }
549
repE (ArithSeq _ aseq) =
550
  case aseq of
551
    From e              -> do { ds1 <- repLE e; repFrom ds1 }
552
    FromThen e1 e2      -> do 
553 554
		             ds1 <- repLE e1
			     ds2 <- repLE e2
555 556
			     repFromThen ds1 ds2
    FromTo   e1 e2      -> do 
557 558
			     ds1 <- repLE e1
			     ds2 <- repLE e2
559 560
			     repFromTo ds1 ds2
    FromThenTo e1 e2 e3 -> do 
561 562 563
			     ds1 <- repLE e1
			     ds2 <- repLE e2
			     ds3 <- repLE e3
564
			     repFromThenTo ds1 ds2 ds3
565 566 567 568 569
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
570
		 _ -> pprPanic "HsSplice" (ppr n) }
571
			-- Should not happen; statically checked
572

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

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

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

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

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

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

632 633 634

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

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

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


684 685 686
-----------------------------------------------------------
--			Bindings
-----------------------------------------------------------
687

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

693
repBinds b@(HsIPBinds _) = notHandled "Implicit parameters" (ppr b)
694 695 696

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

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

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

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

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

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

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

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

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

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


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

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

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

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

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

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

849 850 851
----------------------------------------------------------
-- Declaration ordering helpers

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

856
de_loc :: [(a, b)] -> [b]
857 858
de_loc = map snd

859 860 861
----------------------------------------------------------
--	The meta-environment

862
-- A name/identifier association for fresh names of locally bound entities
863 864 865 866
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 ...

867
-- Generate a fresh name for a locally bound entity
868

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

883
	     
884
addBinds :: [GenSymBind] -> DsM a -> DsM a
885 886 887
-- 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) 
888 889 890 891
addBinds bs m = dsExtendMetaEnv (mkNameEnv [(n,Bound id) | (n,id) <- bs]) m

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

895
lookupBinder :: Name -> DsM (Core TH.Name)
896 897 898 899
lookupBinder n 
  = do { mb_val <- dsLookupMetaEnv n;
	 case mb_val of
	    Just (Bound x) -> return (coreVar x)
Ian Lynagh's avatar
Ian Lynagh committed
900
	    _              -> failWithDs msg }