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

Simon Marlow's avatar
Simon Marlow 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
#include "HsVersions.h"

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

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

39
import qualified Language.Haskell.TH as TH
40

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

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

Simon Marlow's avatar
Simon Marlow committed
69 70 71
import Data.Maybe
import Control.Monad
import Data.List
Ian Lynagh's avatar
Ian Lynagh committed
72

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

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

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

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


105 106 107 108
-------------------------------------------------------
-- 			Declarations
-------------------------------------------------------

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

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

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

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

	dec_ty <- lookupType decTyConName ;
	q_decs  <- repSequenceQ dec_ty core_list ;
135 136

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

Ian Lynagh's avatar
Ian Lynagh committed
140
groupBinders :: HsGroup Name -> [Located Name]
141
groupBinders (HsGroup { hs_valds = val_decls, hs_tyclds = tycl_decls,
142
                        hs_instds = inst_decls, hs_fords = foreign_decls })
143
-- Collect the binders of a Group
144
  = collectHsValBinders val_decls ++
145
    [n | d <- tycl_decls ++ assoc_tycl_decls, n <- tyClDeclNames (unLoc d)] ++
146
    [n | L _ (ForeignImport n _ _) <- foreign_decls]
147 148
  where
    assoc_tycl_decls = concat [ats | L _ (InstDecl _ _ _ ats) <- inst_decls]
149 150


151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168
{- 	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" []] []

169 170
So in repTopDs we bring the binders into scope with mkGenSyms and addBinds.
And we use lookupOcc, rather than lookupBinder
171 172 173 174
in repTyClD and repC.

-}

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

177 178 179
repTyClD tydecl@(L _ (TyFamily {}))
  = repTyFamily tydecl addTyVarBinds

180
repTyClD (L loc (TyData { tcdND = DataType, tcdCtxt = cxt, 
181 182 183 184 185 186 187 188 189 190 191 192 193 194 195
		          tcdLName = tc, tcdTyVars = tvs, tcdTyPats = opt_tys,
		          tcdCons = cons, tcdDerivs = mb_derivs }))
  = do { tc1 <- lookupLOcc tc 		-- See note [Binders and occurrences] 
       ; dec <- addTyVarBinds tvs $ \bndrs -> 
           do { cxt1     <- repLContext cxt
              ; opt_tys1 <- maybeMapM repLTys opt_tys   -- only for family insts
              ; opt_tys2 <- maybeMapM (coreList typeQTyConName) opt_tys1
              ; cons1    <- mapM repC cons
      	      ; cons2    <- coreList conQTyConName cons1
      	      ; derivs1  <- repDerivs mb_derivs
	      ; bndrs1   <- coreList nameTyConName bndrs
      	      ; repData cxt1 tc1 bndrs1 opt_tys2 cons2 derivs1 
              }
       ; return $ Just (loc, dec) 
       }
196

197
repTyClD (L loc (TyData { tcdND = NewType, tcdCtxt = cxt, 
198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224
		          tcdLName = tc, tcdTyVars = tvs, tcdTyPats = opt_tys,
		          tcdCons = [con], tcdDerivs = mb_derivs }))
  = do { tc1 <- lookupLOcc tc 		-- See note [Binders and occurrences] 
       ; dec <- addTyVarBinds tvs $ \bndrs -> 
           do { cxt1     <- repLContext cxt
              ; opt_tys1 <- maybeMapM repLTys opt_tys   -- only for family insts
              ; opt_tys2 <- maybeMapM (coreList typeQTyConName) opt_tys1
              ; con1     <- repC con
      	      ; derivs1  <- repDerivs mb_derivs
	      ; bndrs1   <- coreList nameTyConName bndrs
      	      ; repNewtype cxt1 tc1 bndrs1 opt_tys2 con1 derivs1
              }
       ; return $ Just (loc, dec) 
       }

repTyClD (L loc (TySynonym { tcdLName = tc, tcdTyVars = tvs, tcdTyPats = opt_tys,
                             tcdSynRhs = ty }))
  = do { tc1 <- lookupLOcc tc 		-- See note [Binders and occurrences] 
       ; dec <- addTyVarBinds tvs $ \bndrs -> 
           do { opt_tys1 <- maybeMapM repLTys opt_tys   -- only for family insts
              ; opt_tys2 <- maybeMapM (coreList typeQTyConName) opt_tys1
	      ; ty1      <- repLTy ty
	      ; bndrs1   <- coreList nameTyConName bndrs
	      ; repTySyn tc1 bndrs1 opt_tys2 ty1 
              }
       ; return (Just (loc, dec)) 
       }
225

226
repTyClD (L loc (ClassDecl { tcdCtxt = cxt, tcdLName = cls, 
227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242
		             tcdTyVars = tvs, tcdFDs = fds,
		             tcdSigs = sigs, tcdMeths = meth_binds, 
                             tcdATs = ats }))
  = do { cls1 <- lookupLOcc cls 	-- See note [Binders and occurrences] 
       ; dec  <- addTyVarBinds tvs $ \bndrs -> 
           do { cxt1   <- repLContext cxt
 	      ; sigs1  <- rep_sigs sigs
 	      ; binds1 <- rep_binds meth_binds
	      ; fds1   <- repLFunDeps fds
              ; ats1   <- repLAssocFamilys ats
 	      ; decls1 <- coreList decQTyConName (ats1 ++ sigs1 ++ binds1)
	      ; bndrs1 <- coreList nameTyConName bndrs
 	      ; repClass cxt1 cls1 bndrs1 fds1 decls1 
              }
       ; return $ Just (loc, dec) 
       }
243 244

-- Un-handled cases
245
repTyClD (L loc d) = putSrcSpanDs loc $
246
		     do { warnDs (hang ds_msg 4 (ppr d))
247
			; return Nothing }
248

249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269
-- The type variables in the head of families are treated differently when the
-- family declaration is associated.  In that case, they are usage, not binding
-- occurences.
--
repTyFamily :: LTyClDecl Name 
            -> ProcessTyVarBinds TH.Dec
            -> DsM (Maybe (SrcSpan, Core TH.DecQ))
repTyFamily (L loc (TyFamily { tcdFlavour = flavour,
		               tcdLName = tc, tcdTyVars = tvs, 
		               tcdKind = _kind }))
            tyVarBinds
  = do { tc1 <- lookupLOcc tc 		-- See note [Binders and occurrences] 
       ; dec <- tyVarBinds tvs $ \bndrs ->
           do { flav   <- repFamilyFlavour flavour
	      ; bndrs1 <- coreList nameTyConName bndrs
              ; repFamily flav tc1 bndrs1
              }
       ; return $ Just (loc, dec)
       }
repTyFamily _ _ = panic "DsMeta.repTyFamily: internal error"

270 271 272 273 274 275 276 277 278 279 280 281 282
-- 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
283

284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309
-- represent family declaration flavours
--
repFamilyFlavour :: FamilyFlavour -> DsM (Core TH.FamFlavour)
repFamilyFlavour TypeFamily = rep2 typeFamName []
repFamilyFlavour DataFamily = rep2 dataFamName []

-- represent associated family declarations
--
repLAssocFamilys :: [LTyClDecl Name] -> DsM [Core TH.DecQ]
repLAssocFamilys = mapM repLAssocFamily
  where
    repLAssocFamily tydecl@(L _ (TyFamily {})) 
      = liftM (snd . fromJust) $ repTyFamily tydecl lookupTyVarBinds
    repLAssocFamily tydecl
      = failWithDs msg
      where
        msg = ptext (sLit "Illegal associated declaration in class:") <+> 
              ppr tydecl

-- represent associated family instances
--
repLAssocFamInst :: [LTyClDecl Name] -> DsM [Core TH.DecQ]
repLAssocFamInst = liftM de_loc . mapMaybeM repTyClD

-- represent instance declarations
--
Ian Lynagh's avatar
Ian Lynagh committed
310
repInstD' :: LInstDecl Name -> DsM (SrcSpan, Core TH.DecQ)
311 312 313 314 315 316
repInstD' (L loc (InstDecl ty binds _ ats))	-- Ignore user pragmas for now
  = do { i <- addTyVarBinds tvs $ \_ ->
		-- 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
317 318 319
		   ; inst_ty1 <- repPred (HsClassP cls tys)
		   ; ss <- mkGenSyms (collectHsBindBinders binds)
		   ; binds1 <- addBinds ss (rep_binds binds)
320 321
                   ; ats1   <- repLAssocFamInst ats
		   ; decls1 <- coreList decQTyConName (ats1 ++ binds1)
322
		   ; decls2 <- wrapNongenSyms ss decls1
323
		   -- wrapNongenSyms: do not clone the class op names!
324
		   -- They must be called 'op' etc, not 'op34'
325 326
		   ; repInst cxt1 inst_ty1 (decls2)
                   }
327
	; return (loc, i)}
328
 where
329
   (tvs, cxt, cls, tys) = splitHsInstDeclTy (unLoc ty)
330

331
repForD :: Located (ForeignDecl Name) -> DsM (SrcSpan, Core TH.DecQ)
332
repForD (L loc (ForeignImport name typ (CImport cc s ch cn cis)))
333 334 335 336
 = do MkC name' <- lookupLOcc name
      MkC typ' <- repLTy typ
      MkC cc' <- repCCallConv cc
      MkC s' <- repSafety s
337
      cis' <- conv_cimportspec cis
338 339 340
      MkC str <- coreStringLit $ static
                              ++ unpackFS ch ++ " "
                              ++ unpackFS cn ++ " "
341
                              ++ cis'
342 343 344
      dec <- rep2 forImpDName [cc', s', str, name', typ']
      return (loc, dec)
 where
345 346 347 348
    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"
349 350 351
    static = case cis of
                 CFunction (StaticTarget _) -> "static "
                 _ -> ""
352
repForD decl = notHandled "Foreign declaration" (ppr decl)
353 354 355 356

repCCallConv :: CCallConv -> DsM (Core TH.Callconv)
repCCallConv CCallConv = rep2 cCallName []
repCCallConv StdCallConv = rep2 stdCallName []
Ian Lynagh's avatar
Ian Lynagh committed
357
repCCallConv CmmCallConv = notHandled "repCCallConv" (ppr CmmCallConv)
358 359 360 361 362 363

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

367 368 369 370
-------------------------------------------------------
-- 			Constructors
-------------------------------------------------------

371
repC :: LConDecl Name -> DsM (Core TH.ConQ)
Ian Lynagh's avatar
Ian Lynagh committed
372
repC (L _ (ConDecl con _ [] (L _ []) details ResTyH98 _))
373
  = do { con1 <- lookupLOcc con ;		-- See note [Binders and occurrences] 
374
	 repConstr con1 details }
375
repC (L loc (ConDecl con expl tvs (L cloc ctxt) details ResTyH98 doc))
376
  = do { addTyVarBinds tvs $ \bndrs -> do {
377
             c' <- repC (L loc (ConDecl con expl [] (L cloc []) details ResTyH98 doc));
378 379 380 381 382
             ctxt' <- repContext ctxt;
             bndrs' <- coreList nameTyConName bndrs;
             rep2 forallCName [unC bndrs', unC ctxt', unC c']
         }
       }
383
repC (L loc con_decl)		-- GADTs
384 385
  = putSrcSpanDs loc $
    notHandled "GADT declaration" (ppr con_decl) 
386

387
repBangTy :: LBangType Name -> DsM (Core (TH.StrictTypeQ))
388 389 390
repBangTy ty= do 
  MkC s <- rep2 str []
  MkC t <- repLTy ty'
391
  rep2 strictTypeName [s, t]
392 393 394
  where 
    (str, ty') = case ty of
		   L _ (HsBangTy _ ty) -> (isStrictName,  ty)
Ian Lynagh's avatar
Ian Lynagh committed
395
		   _                   -> (notStrictName, ty)
396 397 398 399 400

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

401
repDerivs :: Maybe [LHsType Name] -> DsM (Core [TH.Name])
402
repDerivs Nothing = coreList nameTyConName []
403
repDerivs (Just ctxt)
404
  = do { strs <- mapM rep_deriv ctxt ; 
405
	 coreList nameTyConName strs }
406
  where
407
    rep_deriv :: LHsType Name -> DsM (Core TH.Name)
408
	-- Deriving clauses must have the simple H98 form
409
    rep_deriv (L _ (HsPredTy (HsClassP cls []))) = lookupOcc cls
410
    rep_deriv other = notHandled "Non-H98 deriving clause" (ppr other)
411 412 413 414 415 416


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

417
rep_sigs :: [LSig Name] -> DsM [Core TH.DecQ]
418 419 420
rep_sigs sigs = do locs_cores <- rep_sigs' sigs
                   return $ de_loc $ sort_by_loc locs_cores

421
rep_sigs' :: [LSig Name] -> DsM [(SrcSpan, Core TH.DecQ)]
422
	-- We silently ignore ones we don't recognise
423
rep_sigs' sigs = do { sigs1 <- mapM rep_sig sigs ;
424 425
		     return (concat sigs1) }

426
rep_sig :: LSig Name -> DsM [(SrcSpan, Core TH.DecQ)]
427 428
	-- Singleton => Ok
	-- Empty     => Too hard, signature ignored
429
rep_sig (L loc (TypeSig nm ty)) = rep_proto nm ty loc
Ian Lynagh's avatar
Ian Lynagh committed
430
rep_sig _                       = return []
431

432 433 434
rep_proto :: Located Name -> LHsType Name -> SrcSpan -> DsM [(SrcSpan, Core TH.DecQ)]
rep_proto nm ty loc = do { nm1 <- lookupLOcc nm ; 
		       ty1 <- repLTy ty ; 
435
		       sig <- repProto nm1 ty1 ;
436
		       return [(loc, sig)] }
437 438 439 440 441


-------------------------------------------------------
-- 			Types
-------------------------------------------------------
442

443 444 445 446 447 448 449 450 451
-- We process type variable bindings in two ways, either by generating fresh
-- names or looking up existing names.  The difference is crucial for type
-- families, depending on whether they are associated or not.
--
type ProcessTyVarBinds a = 
         [LHsTyVarBndr Name]	                 -- the binders to be added
      -> ([Core TH.Name] -> DsM (Core (TH.Q a))) -- action in the ext env
      -> DsM (Core (TH.Q a))

chak's avatar
chak committed
452 453
-- 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
454
-- meta environment and gets the *new* names on Core-level as an argument
chak's avatar
chak committed
455
--
456
addTyVarBinds :: ProcessTyVarBinds a
457
addTyVarBinds tvs m =
chak's avatar
chak committed
458
  do
459
    let names = map (hsTyVarName.unLoc) tvs
460
    freshNames <- mkGenSyms names
chak's avatar
chak committed
461 462 463
    term       <- addBinds freshNames $ do
		    bndrs <- mapM lookupBinder names 
		    m bndrs
464
    wrapGenSyns freshNames term
chak's avatar
chak committed
465

466 467 468 469 470 471 472 473 474 475
-- Look up a list of type variables; the computations passed as the second 
-- argument gets the *new* names on Core-level as an argument
--
lookupTyVarBinds :: ProcessTyVarBinds a
lookupTyVarBinds tvs m =
  do
    let names = map (hsTyVarName.unLoc) tvs
    bndrs <- mapM lookupBinder names 
    m bndrs

chak's avatar
chak committed
476 477
-- represent a type context
--
478 479 480
repLContext :: LHsContext Name -> DsM (Core TH.CxtQ)
repLContext (L _ ctxt) = repContext ctxt

481
repContext :: HsContext Name -> DsM (Core TH.CxtQ)
chak's avatar
chak committed
482
repContext ctxt = do 
483
	            preds    <- mapM repLPred ctxt
484
		    predList <- coreList typeQTyConName preds
chak's avatar
chak committed
485
		    repCtxt predList
486

chak's avatar
chak committed
487 488
-- represent a type predicate
--
489 490 491
repLPred :: LHsPred Name -> DsM (Core TH.TypeQ)
repLPred (L _ p) = repPred p

492
repPred :: HsPred Name -> DsM (Core TH.TypeQ)
chak's avatar
chak committed
493 494
repPred (HsClassP cls tys) = do
			       tcon <- repTy (HsTyVar cls)
495
			       tys1 <- repLTys tys
chak's avatar
chak committed
496
			       repTapps tcon tys1
497
repPred p@(HsEqualP _ _) = notHandled "Equational constraint" (ppr p)
498
repPred p@(HsIParam _ _) = notHandled "Implicit parameter constraint" (ppr p)
chak's avatar
chak committed
499 500 501

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

chak's avatar
chak committed
505 506
-- represent a type
--
507 508 509
repLTy :: LHsType Name -> DsM (Core TH.TypeQ)
repLTy (L _ ty) = repTy ty

510 511 512
repTy :: HsType Name -> DsM (Core TH.TypeQ)
repTy (HsForAllTy _ tvs ctxt ty)  = 
  addTyVarBinds tvs $ \bndrs -> do
513 514
    ctxt1  <- repLContext ctxt
    ty1    <- repLTy ty
515 516
    bndrs1 <- coreList nameTyConName bndrs
    repTForall bndrs1 ctxt1 ty1
517

518
repTy (HsTyVar n)
chak's avatar
chak committed
519
  | isTvOcc (nameOccName n)       = do 
520
				      tv1 <- lookupTvOcc n
chak's avatar
chak committed
521 522 523 524 525
				      repTvar tv1
  | otherwise		          = do 
				      tc1 <- lookupOcc n
				      repNamedTyCon tc1
repTy (HsAppTy f a)               = do 
526 527
				      f1 <- repLTy f
				      a1 <- repLTy a
chak's avatar
chak committed
528 529
				      repTapp f1 a1
repTy (HsFunTy f a)               = do 
530 531
				      f1   <- repLTy f
				      a1   <- repLTy a
chak's avatar
chak committed
532 533 534
				      tcon <- repArrowTyCon
				      repTapps tcon [f1, a1]
repTy (HsListTy t)		  = do
535
				      t1   <- repLTy t
chak's avatar
chak committed
536 537 538
				      tcon <- repListTyCon
				      repTapp tcon t1
repTy (HsPArrTy t)                = do
539
				      t1   <- repLTy t
540
				      tcon <- repTy (HsTyVar (tyConName parrTyCon))
chak's avatar
chak committed
541
				      repTapp tcon t1
Ian Lynagh's avatar
Ian Lynagh committed
542
repTy (HsTupleTy _ tys)	  = do
543
				      tys1 <- repLTys tys 
chak's avatar
chak committed
544 545
				      tcon <- repTupleTyCon (length tys)
				      repTapps tcon tys1
546 547 548
repTy (HsOpTy ty1 n ty2) 	  = repLTy ((nlHsTyVar (unLoc n) `nlHsAppTy` ty1) 
					   `nlHsAppTy` ty2)
repTy (HsParTy t)  	       	  = repLTy t
549
repTy (HsPredTy pred)             = repPred pred
550 551
repTy ty@(HsNumTy _)              = notHandled "Number types (for generics)" (ppr ty)
repTy ty			  = notHandled "Exotic form of type" (ppr ty)
552 553


chak's avatar
chak committed
554
-----------------------------------------------------------------------------
555
-- 		Expressions
chak's avatar
chak committed
556
-----------------------------------------------------------------------------
557

558 559 560
repLEs :: [LHsExpr Name] -> DsM (Core [TH.ExpQ])
repLEs es = do { es'  <- mapM repLE es ;
		 coreList expQTyConName es' }
561

chak's avatar
chak committed
562 563 564
-- 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
565
repLE :: LHsExpr Name -> DsM (Core TH.ExpQ)
566
repLE (L loc e) = putSrcSpanDs loc (repE e)
567

568
repE :: HsExpr Name -> DsM (Core TH.ExpQ)
chak's avatar
chak committed
569 570 571
repE (HsVar x)            =
  do { mb_val <- dsLookupMetaEnv x 
     ; case mb_val of
chak's avatar
chak committed
572
	Nothing	         -> do { str <- globalVar x
chak's avatar
chak committed
573 574 575 576
			       ; 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
577
repE e@(HsIPVar _) = notHandled "Implicit parameters" (ppr e)
578 579 580 581 582

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

Ian Lynagh's avatar
Ian Lynagh committed
586
repE (OpApp e1 op _ e2) =
587 588 589
  do { arg1 <- repLE e1; 
       arg2 <- repLE e2; 
       the_op <- repLE op ;
590
       repInfixApp arg1 the_op arg2 } 
Ian Lynagh's avatar
Ian Lynagh committed
591
repE (NegApp x _)        = do
592
			      a         <- repLE x
chak's avatar
chak committed
593 594
			      negateVar <- lookupOcc negateName >>= repVar
			      negateVar `repApp` a
595 596 597
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 } 
598 599 600
repE (HsCase e (MatchGroup ms _)) = do { arg <- repLE e
				       ; ms2 <- mapM repMatchTup ms
				       ; repCaseE arg (nonEmptyCoreList ms2) }
601 602 603 604
repE (HsIf x y z)         = do
			      a <- repLE x
			      b <- repLE y
			      c <- repLE z
chak's avatar
chak committed
605 606
			      repCond a b c
repE (HsLet bs e)         = do { (ss,ds) <- repBinds bs
607
			       ; e2 <- addBinds ss (repLE e)
chak's avatar
chak committed
608
			       ; z <- repLetE ds e2
609
			       ; wrapGenSyns ss z }
chak's avatar
chak committed
610
-- FIXME: I haven't got the types here right yet
Ian Lynagh's avatar
Ian Lynagh committed
611
repE (HsDo DoExpr sts body _) 
612
 = do { (ss,zs) <- repLSts sts; 
613
	body'	<- addBinds ss $ repLE body;
614 615
	ret	<- repNoBindSt body';	
        e       <- repDoE (nonEmptyCoreList (zs ++ [ret]));
616
        wrapGenSyns ss e }
Ian Lynagh's avatar
Ian Lynagh committed
617
repE (HsDo ListComp sts body _)
618
 = do { (ss,zs) <- repLSts sts; 
619
	body'	<- addBinds ss $ repLE body;
620 621
	ret	<- repNoBindSt body';	
        e       <- repComp (nonEmptyCoreList (zs ++ [ret]));
622
        wrapGenSyns ss e }
623
repE e@(HsDo _ _ _ _) = notHandled "mdo and [: :]" (ppr e)
Ian Lynagh's avatar
Ian Lynagh committed
624 625
repE (ExplicitList _ es) = do { xs <- repLEs es; repListExp xs }
repE e@(ExplicitPArr _ _) = notHandled "Parallel arrays" (ppr e)
626
repE e@(ExplicitTuple es boxed) 
627
  | isBoxed boxed         = do { xs <- repLEs es; repTup xs }
628
  | otherwise		  = notHandled "Unboxed tuples" (ppr e)
629
repE (RecordCon c _ flds)
630
 = do { x <- lookupLOcc c;
631 632
        fs <- repFields flds;
        repRecCon x fs }
633
repE (RecordUpd e flds _ _ _)
634
 = do { x <- repLE e;
635 636
        fs <- repFields flds;
        repRecUpd x fs }
637

638
repE (ExprWithTySig e ty) = do { e1 <- repLE e; t1 <- repLTy ty; repSigExp e1 t1 }
639
repE (ArithSeq _ aseq) =
chak's avatar
chak committed
640
  case aseq of
641
    From e              -> do { ds1 <- repLE e; repFrom ds1 }
chak's avatar
chak committed
642
    FromThen e1 e2      -> do 
643 644
		             ds1 <- repLE e1
			     ds2 <- repLE e2
chak's avatar
chak committed
645 646
			     repFromThen ds1 ds2
    FromTo   e1 e2      -> do 
647 648
			     ds1 <- repLE e1
			     ds2 <- repLE e2
chak's avatar
chak committed
649 650
			     repFromTo ds1 ds2
    FromThenTo e1 e2 e3 -> do 
651 652 653
			     ds1 <- repLE e1
			     ds2 <- repLE e2
			     ds3 <- repLE e3
chak's avatar
chak committed
654
			     repFromThenTo ds1 ds2 ds3
655 656 657 658 659
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
660
		 _ -> pprPanic "HsSplice" (ppr n) }
661
			-- Should not happen; statically checked
662

663 664 665
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
666
repE e@(HsTickPragma {}) = notHandled "Tick Pragma" (ppr e)
667 668
repE e@(HsBracketOut {}) = notHandled "TH brackets" (ppr e)
repE e 			 = notHandled "Expression form" (ppr e)
669 670 671 672

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

673
repMatchTup ::  LMatch Name -> DsM (Core TH.MatchQ) 
Ian Lynagh's avatar
Ian Lynagh committed
674
repMatchTup (L _ (Match [p] _ (GRHSs guards wheres))) =
675
  do { ss1 <- mkGenSyms (collectPatBinders p) 
676
     ; addBinds ss1 $ do {
677
     ; p1 <- repLP p
678
     ; (ss2,ds) <- repBinds wheres
679 680 681
     ; addBinds ss2 $ do {
     ; gs    <- repGuards guards
     ; match <- repMatch p1 gs ds
682
     ; wrapGenSyns (ss1++ss2) match }}}
Ian Lynagh's avatar
Ian Lynagh committed
683
repMatchTup _ = panic "repMatchTup: case alt with more than one arg"
684

685
repClauseTup ::  LMatch Name -> DsM (Core TH.ClauseQ)
Ian Lynagh's avatar
Ian Lynagh committed
686
repClauseTup (L _ (Match ps _ (GRHSs guards wheres))) =
687
  do { ss1 <- mkGenSyms (collectPatsBinders ps) 
688
     ; addBinds ss1 $ do {
689
       ps1 <- repLPs ps
690
     ; (ss2,ds) <- repBinds wheres
691 692 693
     ; addBinds ss2 $ do {
       gs <- repGuards guards
     ; clause <- repClause ps1 gs ds
694
     ; wrapGenSyns (ss1++ss2) clause }}}
695

696
repGuards ::  [LGRHS Name] ->  DsM (Core TH.BodyQ)
697
repGuards [L _ (GRHS [] e)]
698
  = do {a <- repLE e; repNormal a }
699
repGuards other 
700 701 702 703
  = do { zs <- mapM process other;
     let {(xs, ys) = unzip zs};
	 gd <- repGuarded (nonEmptyCoreList ys);
     wrapGenSyns (concat xs) gd }
704
  where 
705
    process :: LGRHS Name -> DsM ([GenSymBind], (Core (TH.Q (TH.Guard, TH.Exp))))
706
    process (L _ (GRHS [L _ (ExprStmt e1 _ _)] e2))
707 708
           = do { x <- repLNormalGE e1 e2;
                  return ([], x) }
709
    process (L _ (GRHS ss rhs))
710
           = do (gs, ss') <- repLSts ss
711
		rhs' <- addBinds gs $ repLE rhs
712
                g <- repPatGE (nonEmptyCoreList ss') rhs'
713
                return (gs, g)
714

715 716
repFields :: HsRecordBinds Name -> DsM (Core [TH.Q TH.FieldExp])
repFields (HsRecFields { rec_flds = flds })
717 718 719 720
  = do	{ fnames <- mapM lookupLOcc (map hsRecFieldId flds)
	; es <- mapM repLE (map hsRecFieldArg flds)
	; fs <- zipWithM repFieldExp fnames es
	; coreList fieldExpQTyConName fs }
721

722 723 724

-----------------------------------------------------------------------------
-- Representing Stmt's is tricky, especially if bound variables
725
-- shadow each other. Consider:  [| do { x <- f 1; x <- f x; g x } |]
726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747
-- 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.

748 749 750
repLSts :: [LStmt Name] -> DsM ([GenSymBind], [Core TH.StmtQ])
repLSts stmts = repSts (map unLoc stmts)

751
repSts :: [Stmt Name] -> DsM ([GenSymBind], [Core TH.StmtQ])
752
repSts (BindStmt p e _ _ : ss) =
753
   do { e2 <- repLE e 
754
      ; ss1 <- mkGenSyms (collectPatBinders p) 
755
      ; addBinds ss1 $ do {
756
      ; p1 <- repLP p; 
757 758 759 760
      ; (ss2,zs) <- repSts ss
      ; z <- repBindSt p1 e2
      ; return (ss1++ss2, z : zs) }}
repSts (LetStmt bs : ss) =
761
   do { (ss1,ds) <- repBinds bs
762 763 764
      ; z <- repLetSt ds
      ; (ss2,zs) <- addBinds ss1 (repSts ss)
      ; return (ss1++ss2, z : zs) } 
765
repSts (ExprStmt e _ _ : ss) =       
766
   do { e2 <- repLE e
767 768 769
      ; z <- repNoBindSt e2 
      ; (ss2,zs) <- repSts ss
      ; return (ss2, z : zs) }
770 771
repSts []    = return ([],[])
repSts other = notHandled "Exotic statement" (ppr other)
772 773


774 775 776
-----------------------------------------------------------
--			Bindings
-----------------------------------------------------------
777

778 779 780 781 782
repBinds :: HsLocalBinds Name -> DsM ([GenSymBind], Core [TH.DecQ]) 
repBinds EmptyLocalBinds
  = do	{ core_list <- coreList decQTyConName []
	; return ([], core_list) }

783
repBinds b@(HsIPBinds _) = notHandled "Implicit parameters" (ppr b)
784 785 786

repBinds (HsValBinds decs)
 = do	{ let { bndrs = map unLoc (collectHsValBinders decs) }
787 788 789 790
		-- 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
791
	; ss        <- mkGenSyms bndrs
792 793 794
	; prs       <- addBinds ss (rep_val_binds decs)
	; core_list <- coreList decQTyConName 
				(de_loc (sort_by_loc prs))
795
	; return (ss, core_list) }
796

797
rep_val_binds :: HsValBinds Name -> DsM [(SrcSpan, Core TH.DecQ)]
798
-- Assumes: all the binders of the binding are alrady in the meta-env
799 800
rep_val_binds (ValBindsOut binds sigs)
 = do { core1 <- rep_binds' (unionManyBags (map snd binds))
801
      ;	core2 <- rep_sigs' sigs
802
      ;	return (core1 ++ core2) }
Ian Lynagh's avatar
Ian Lynagh committed
803
rep_val_binds (ValBindsIn _ _)
804
 = panic "rep_val_binds: ValBindsIn"
805

806
rep_binds :: LHsBinds Name -> DsM [Core TH.DecQ]
807 808 809 810 811
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)
812

813
rep_bind :: LHsBind Name -> DsM (SrcSpan, Core TH.DecQ)
814
-- Assumes: all the binders of the binding are alrady in the meta-env
815 816 817 818

-- 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
819
rep_bind (L loc (FunBind { fun_id = fn, 
Ian Lynagh's avatar
Ian Lynagh committed
820
			   fun_matches = MatchGroup [L _ (Match [] _ (GRHSs guards wheres))] _ }))
821
 = do { (ss,wherecore) <- repBinds wheres
822
	; guardcore <- addBinds ss (repGuards guards)
823 824 825 826 827
	; fn'  <- lookupLBinder fn
	; p    <- repPvar fn'
	; ans  <- repVal p guardcore wherecore
	; ans' <- wrapGenSyns ss ans
	; return (loc, ans') }
828

829
rep_bind (L loc (FunBind { fun_id = fn, fun_matches = MatchGroup ms _ }))
830
 =   do { ms1 <- mapM repClauseTup ms
831
	; fn' <- lookupLBinder fn
832
        ; ans <- repFun fn' (nonEmptyCoreList ms1)
833
        ; return (loc, ans) }
834

835
rep_bind (L loc (PatBind { pat_lhs = pat, pat_rhs = GRHSs guards wheres }))
836
 =   do { patcore <- repLP pat 
837
        ; (ss,wherecore) <- repBinds wheres
838
	; guardcore <- addBinds ss (repGuards guards)
839 840 841
        ; ans  <- repVal patcore guardcore wherecore
	; ans' <- wrapGenSyns ss ans
        ; return (loc, ans') }
842

Ian Lynagh's avatar
Ian Lynagh committed
843
rep_bind (L _ (VarBind { var_id = v, var_rhs = e}))
844
 =   do { v' <- lookupBinder v 
845
	; e2 <- repLE e
846 847
        ; x <- repNormal e2
        ; patcore <- repPvar v'
848
	; empty_decls <- coreList decQTyConName [] 
849
        ; ans <- repVal patcore x empty_decls
850
        ; return (srcLocSpan (getSrcLoc v), ans) }
851

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

854
-----------------------------------------------------------------------------
855
-- Since everything in a Bind is mutually recursive we need rename all
856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871
-- 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


-----------------------------------------------------------------------------
872
-- GHC allows a more general form of lambda abstraction than specified
873 874 875 876 877
-- 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.  

878
repLambda :: LMatch Name -> DsM (Core TH.ExpQ)
879
repLambda (L _ (Match ps _ (GRHSs [L _ (GRHS [] e)] Em