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

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

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

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

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

{- -------------- Examples --------------------

  [| \x -> x |]
====>
  gensym (unpackString "x"#) `bindQ` \ x1::String ->
  lam (pvar x1) (var x1)


  [| \x -> $(f [| x |]) |]
====>
  gensym (unpackString "x"#) `bindQ` \ x1::String ->
  lam (pvar x1) (f (var x1))
-}


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

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

111 112 113 114 115
	-- Bind all the names mainly to avoid repeated use of explicit strings.
	-- Thus	we get
	--	do { t :: String <- genSym "T" ;
	--	     return (Data t [] ...more t's... }
	-- The other important reason is that the output must mention
116
	-- only "T", not "Foo:T" where Foo is the current module
117 118

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

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

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

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

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

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

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

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

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

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

295 296 297 298
-------------------------------------------------------
-- 			Constructors
-------------------------------------------------------

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

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

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

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


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

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

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

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

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


-------------------------------------------------------
-- 			Types
-------------------------------------------------------
370

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

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

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

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

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

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

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

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

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


465
-----------------------------------------------------------------------------
466
-- 		Expressions
467
-----------------------------------------------------------------------------
468

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

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

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

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

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

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

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

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

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

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

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

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

633 634 635

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

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

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


685 686 687
-----------------------------------------------------------
--			Bindings
-----------------------------------------------------------
688

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

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

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

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

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

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

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

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

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

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

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

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


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

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

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

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

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

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

850 851 852
----------------------------------------------------------
-- Declaration ordering helpers

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

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

860 861 862
----------------------------------------------------------
--	The meta-environment

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

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

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

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

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

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