DsMeta.hs 84.3 KB
Newer Older
1
-----------------------------------------------------------------------------
Simon Marlow's avatar
Simon Marlow committed
2 3 4
--
-- (c) The University of Glasgow 2006
--
5 6 7 8
-- The purpose of this module is to transform an HsExpr into a CoreExpr which
-- when evaluated, returns a (Meta.Q Meta.Exp) computation analogous to the
-- input HsExpr. We do this in the DsM monad, which supplies access to
-- CoreExpr's of the "smart constructors" of the Meta.Exp datatype.
9 10 11 12 13
--
-- It also defines a bunch of knownKeyNames, in the same way as is done
-- in prelude/PrelNames.  It's much more convenient to do it here, becuase
-- otherwise we have to recompile PrelNames whenever we add a Name, which is
-- a Royal Pain (triggers other recompilation).
14 15
-----------------------------------------------------------------------------

16 17
module DsMeta( dsBracket, 
	       templateHaskellNames, qTyConName, nameTyConName,
18
	       liftName, liftStringName, expQTyConName, patQTyConName, decQTyConName, typeQTyConName,
19 20
	       decTyConName, typeTyConName, mkNameG_dName, mkNameG_vName, mkNameG_tcName,
	       quoteExpName, quotePatName
21
	        ) where
22

23 24
#include "HsVersions.h"

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

Simon Marlow's avatar
Simon Marlow committed
27
import MatchLit
28 29
import DsMonad

30
import qualified Language.Haskell.TH as TH
31

32
import HsSyn
Simon Marlow's avatar
Simon Marlow committed
33 34 35 36 37 38
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.
39
import qualified OccName( isDataOcc, isVarOcc, isTcOcc, varName, tcName ) 
40

Simon Marlow's avatar
Simon Marlow committed
41 42
import Module
import Id
43
import Name hiding( isVarOcc, isTcOcc, varName, tcName ) 
44
import NameEnv
Simon Marlow's avatar
Simon Marlow committed
45 46 47
import TcType
import TyCon
import TysWiredIn
48
import CoreSyn
49
import MkCore
Simon Marlow's avatar
Simon Marlow committed
50 51 52 53
import CoreUtils
import SrcLoc
import Unique
import BasicTypes
54
import Outputable
Simon Marlow's avatar
Simon Marlow committed
55 56 57
import Bag
import FastString
import ForeignCall
58
import MonadUtils
59

Simon Marlow's avatar
Simon Marlow committed
60 61 62
import Data.Maybe
import Control.Monad
import Data.List
Ian Lynagh's avatar
Ian Lynagh committed
63

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

70 71
dsBracket brack splices
  = dsExtendMetaEnv new_bit (do_brack brack)
72
  where
73
    new_bit = mkNameEnv [(n, Splice (unLoc e)) | (n,e) <- splices]
74

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

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


96 97 98 99
-------------------------------------------------------
-- 			Declarations
-------------------------------------------------------

100
repTopDs :: HsGroup Name -> DsM (Core (TH.Q [TH.Dec]))
101
repTopDs group
102
 = do { let { bndrs = map unLoc (groupBinders group) } ;
103
	ss <- mkGenSyms bndrs ;
104

105 106 107 108 109
	-- 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
110
	-- only "T", not "Foo:T" where Foo is the current module
111 112

	
113
	decls <- addBinds ss (do {
114
			val_ds  <- rep_val_binds (hs_valds group) ;
115
			tycl_ds <- mapM repTyClD (hs_tyclds group) ;
116
			inst_ds <- mapM repInstD' (hs_instds group) ;
117
			for_ds <- mapM repForD (hs_fords group) ;
118
			-- more needed
119
			return (de_loc $ sort_by_loc $ val_ds ++ catMaybes tycl_ds ++ inst_ds ++ for_ds) }) ;
120

121
	decl_ty <- lookupType decQTyConName ;
122
	let { core_list = coreList' decl_ty decls } ;
123 124 125

	dec_ty <- lookupType decTyConName ;
	q_decs  <- repSequenceQ dec_ty core_list ;
126 127

	wrapNongenSyms ss q_decs
128 129 130
	-- Do *not* gensym top-level binders
      }

Ian Lynagh's avatar
Ian Lynagh committed
131
groupBinders :: HsGroup Name -> [Located Name]
132
groupBinders (HsGroup { hs_valds = val_decls, hs_tyclds = tycl_decls,
133
                        hs_instds = inst_decls, hs_fords = foreign_decls })
134
-- Collect the binders of a Group
135
  = collectHsValBinders val_decls ++
136
    [n | d <- tycl_decls ++ assoc_tycl_decls, n <- tyClDeclNames (unLoc d)] ++
137
    [n | L _ (ForeignImport n _ _) <- foreign_decls]
138 139
  where
    assoc_tycl_decls = concat [ats | L _ (InstDecl _ _ _ ats) <- inst_decls]
140 141


142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159
{- 	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" []] []

160 161
So in repTopDs we bring the binders into scope with mkGenSyms and addBinds.
And we use lookupOcc, rather than lookupBinder
162 163 164 165
in repTyClD and repC.

-}

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

168 169 170
repTyClD tydecl@(L _ (TyFamily {}))
  = repTyFamily tydecl addTyVarBinds

171
repTyClD (L loc (TyData { tcdND = DataType, tcdCtxt = cxt, 
172 173 174 175 176 177 178 179 180 181
		          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
182
	      ; bndrs1   <- coreList tyVarBndrTyConName bndrs
183 184 185 186
      	      ; repData cxt1 tc1 bndrs1 opt_tys2 cons2 derivs1 
              }
       ; return $ Just (loc, dec) 
       }
187

188
repTyClD (L loc (TyData { tcdND = NewType, tcdCtxt = cxt, 
189 190 191 192 193 194 195 196 197
		          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
198
	      ; bndrs1   <- coreList tyVarBndrTyConName bndrs
199 200 201 202 203 204 205 206 207 208 209 210
      	      ; 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
211
	      ; bndrs1   <- coreList tyVarBndrTyConName bndrs
212 213 214 215
	      ; repTySyn tc1 bndrs1 opt_tys2 ty1 
              }
       ; return (Just (loc, dec)) 
       }
216

217
repTyClD (L loc (ClassDecl { tcdCtxt = cxt, tcdLName = cls, 
218 219 220 221 222 223 224 225 226 227 228
		             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)
229
	      ; bndrs1 <- coreList tyVarBndrTyConName bndrs
230 231 232 233
 	      ; repClass cxt1 cls1 bndrs1 fds1 decls1 
              }
       ; return $ Just (loc, dec) 
       }
234 235

-- Un-handled cases
236
repTyClD (L loc d) = putSrcSpanDs loc $
237
		     do { warnDs (hang ds_msg 4 (ppr d))
238
			; return Nothing }
239

240 241 242 243 244 245 246 247 248
-- 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, 
249
		               tcdKind = opt_kind }))
250 251 252 253
            tyVarBinds
  = do { tc1 <- lookupLOcc tc 		-- See note [Binders and occurrences] 
       ; dec <- tyVarBinds tvs $ \bndrs ->
           do { flav   <- repFamilyFlavour flavour
254 255 256 257 258 259
	      ; bndrs1 <- coreList tyVarBndrTyConName bndrs
              ; case opt_kind of 
                  Nothing -> repFamilyNoKind flav tc1 bndrs1
                  Just ki -> do { ki1 <- repKind ki 
                                ; repFamilyKind flav tc1 bndrs1 ki1
                                }
260 261 262 263 264
              }
       ; return $ Just (loc, dec)
       }
repTyFamily _ _ = panic "DsMeta.repTyFamily: internal error"

265 266 267 268 269 270 271 272 273 274 275 276 277
-- 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
278

279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304
-- 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
305
repInstD' :: LInstDecl Name -> DsM (SrcSpan, Core TH.DecQ)
306 307 308 309 310 311
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
312
		   ; inst_ty1 <- repPredTy (HsClassP cls tys)
313 314
		   ; ss <- mkGenSyms (collectHsBindBinders binds)
		   ; binds1 <- addBinds ss (rep_binds binds)
315 316
                   ; ats1   <- repLAssocFamInst ats
		   ; decls1 <- coreList decQTyConName (ats1 ++ binds1)
317
		   ; decls2 <- wrapNongenSyms ss decls1
318
		   -- wrapNongenSyms: do not clone the class op names!
319
		   -- They must be called 'op' etc, not 'op34'
320 321
		   ; repInst cxt1 inst_ty1 (decls2)
                   }
322
	; return (loc, i)}
323
 where
324
   (tvs, cxt, cls, tys) = splitHsInstDeclTy (unLoc ty)
325

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

repCCallConv :: CCallConv -> DsM (Core TH.Callconv)
repCCallConv CCallConv = rep2 cCallName []
repCCallConv StdCallConv = rep2 stdCallName []
351
repCCallConv callConv    = notHandled "repCCallConv" (ppr callConv)
352 353 354 355 356 357

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

361 362 363 364
-------------------------------------------------------
-- 			Constructors
-------------------------------------------------------

365
repC :: LConDecl Name -> DsM (Core TH.ConQ)
366 367
repC (L _ (ConDecl { con_name = con, con_qvars = [], con_cxt = L _ []
     	           , con_details = details, con_res = ResTyH98 }))
368 369 370
  = do { con1 <- lookupLOcc con 	-- See note [Binders and occurrences] 
       ; repConstr con1 details 
       }
371
repC (L loc con_decl@(ConDecl { con_qvars = tvs, con_cxt = L cloc ctxt, con_res = ResTyH98 }))
372
  = addTyVarBinds tvs $ \bndrs -> 
373
      do { c' <- repC (L loc (con_decl { con_qvars = [], con_cxt = L cloc [] }))
374 375 376
         ; ctxt' <- repContext ctxt
         ; bndrs' <- coreList tyVarBndrTyConName bndrs
         ; rep2 forallCName [unC bndrs', unC ctxt', unC c']
377
         }
378
repC (L loc con_decl)		-- GADTs
379 380
  = putSrcSpanDs loc $
    notHandled "GADT declaration" (ppr con_decl) 
381

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

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

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


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

412
rep_sigs :: [LSig Name] -> DsM [Core TH.DecQ]
413 414 415
rep_sigs sigs = do locs_cores <- rep_sigs' sigs
                   return $ de_loc $ sort_by_loc locs_cores

416
rep_sigs' :: [LSig Name] -> DsM [(SrcSpan, Core TH.DecQ)]
417
	-- We silently ignore ones we don't recognise
418
rep_sigs' sigs = do { sigs1 <- mapM rep_sig sigs ;
419 420
		     return (concat sigs1) }

421
rep_sig :: LSig Name -> DsM [(SrcSpan, Core TH.DecQ)]
422 423
	-- Singleton => Ok
	-- Empty     => Too hard, signature ignored
424 425 426 427 428 429 430 431 432 433 434 435 436 437
rep_sig (L loc (TypeSig nm ty))       = rep_proto nm ty loc
rep_sig (L loc (InlineSig nm ispec))  = rep_inline nm ispec loc
rep_sig (L loc (SpecSig nm ty ispec)) = rep_specialise nm ty ispec loc
rep_sig _                             = return []

rep_proto :: Located Name -> LHsType Name -> SrcSpan 
          -> DsM [(SrcSpan, Core TH.DecQ)]
rep_proto nm ty loc 
  = do { nm1 <- lookupLOcc nm
       ; ty1 <- repLTy ty
       ; sig <- repProto nm1 ty1
       ; return [(loc, sig)]
       }

438 439 440
rep_inline :: Located Name 
           -> InlinePragma	-- Never defaultInlinePragma
           -> SrcSpan 
441 442 443
           -> DsM [(SrcSpan, Core TH.DecQ)]
rep_inline nm ispec loc
  = do { nm1 <- lookupLOcc nm
444
       ; ispec1 <- rep_InlinePrag ispec
445 446 447 448
       ; pragma <- repPragInl nm1 ispec1
       ; return [(loc, pragma)]
       }

449
rep_specialise :: Located Name -> LHsType Name -> InlinePragma -> SrcSpan 
450 451 452 453
               -> DsM [(SrcSpan, Core TH.DecQ)]
rep_specialise nm ty ispec loc
  = do { nm1 <- lookupLOcc nm
       ; ty1 <- repLTy ty
454 455 456 457
       ; pragma <- if isDefaultInlinePragma ispec
                   then repPragSpec nm1 ty1                  -- SPECIALISE
                   else do { ispec1 <- rep_InlinePrag ispec  -- SPECIALISE INLINE
                           ; repPragSpecInl nm1 ty1 ispec1 } 
458 459
       ; return [(loc, pragma)]
       }
460

461
-- Extract all the information needed to build a TH.InlinePrag
462
--
463 464 465
rep_InlinePrag :: InlinePragma	-- Never defaultInlinePragma
               -> DsM (Core TH.InlineSpecQ)
rep_InlinePrag (InlinePragma { inl_act = activation, inl_rule = match, inl_inline = inline })
466
  | Nothing            <- activation1 
467
    = repInlineSpecNoPhase inline1 match1
468
  | Just (flag, phase) <- activation1 
469
    = repInlineSpecPhase inline1 match1 flag phase
470 471 472 473 474 475 476 477 478
  | otherwise = {- unreachable, but shuts up -W -} panic "rep_InlineSpec"
    where
      match1      = coreBool (rep_RuleMatchInfo match)
      activation1 = rep_Activation activation
      inline1     = coreBool inline

      rep_RuleMatchInfo FunLike = False
      rep_RuleMatchInfo ConLike = True

479 480
      rep_Activation NeverActive          = Nothing	-- We never have NOINLINE/AlwaysActive
      rep_Activation AlwaysActive         = Nothing	-- or            INLINE/NeverActive
481 482 483 484
      rep_Activation (ActiveBefore phase) = Just (coreBool False, 
                                                  MkC $ mkIntExprInt phase)
      rep_Activation (ActiveAfter phase)  = Just (coreBool True, 
                                                  MkC $ mkIntExprInt phase)
485 486 487 488 489


-------------------------------------------------------
-- 			Types
-------------------------------------------------------
490

491 492 493 494 495
-- 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 = 
496 497
         [LHsTyVarBndr Name]	                       -- the binders to be added
      -> ([Core TH.TyVarBndr] -> DsM (Core (TH.Q a)))  -- action in the ext env
498 499
      -> DsM (Core (TH.Q a))

chak's avatar
chak committed
500 501
-- 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
502
-- meta environment and gets the *new* names on Core-level as an argument
chak's avatar
chak committed
503
--
504
addTyVarBinds :: ProcessTyVarBinds a
505
addTyVarBinds tvs m =
chak's avatar
chak committed
506
  do
507 508
    let names       = hsLTyVarNames tvs
        mkWithKinds = map repTyVarBndrWithKind tvs
509
    freshNames <- mkGenSyms names
chak's avatar
chak committed
510
    term       <- addBinds freshNames $ do
511 512 513
		    bndrs       <- mapM lookupBinder names 
                    kindedBndrs <- zipWithM ($) mkWithKinds bndrs
		    m kindedBndrs
514
    wrapGenSyns freshNames term
chak's avatar
chak committed
515

516 517 518 519 520 521
-- 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
522 523 524 525 526 527 528 529 530 531 532 533 534
    let names       = hsLTyVarNames tvs
        mkWithKinds = map repTyVarBndrWithKind tvs
    bndrs       <- mapM lookupBinder names 
    kindedBndrs <- zipWithM ($) mkWithKinds bndrs
    m kindedBndrs

-- Produce kinded binder constructors from the Haskell tyvar binders
--
repTyVarBndrWithKind :: LHsTyVarBndr Name 
                     -> Core TH.Name -> DsM (Core TH.TyVarBndr)
repTyVarBndrWithKind (L _ (UserTyVar _))      = repPlainTV
repTyVarBndrWithKind (L _ (KindedTyVar _ ki)) = 
  \nm -> repKind ki >>= repKindedTV nm
535

chak's avatar
chak committed
536 537
-- represent a type context
--
538 539 540
repLContext :: LHsContext Name -> DsM (Core TH.CxtQ)
repLContext (L _ ctxt) = repContext ctxt

541
repContext :: HsContext Name -> DsM (Core TH.CxtQ)
chak's avatar
chak committed
542
repContext ctxt = do 
543
	            preds    <- mapM repLPred ctxt
544
		    predList <- coreList predQTyConName preds
chak's avatar
chak committed
545
		    repCtxt predList
546

chak's avatar
chak committed
547 548
-- represent a type predicate
--
549
repLPred :: LHsPred Name -> DsM (Core TH.PredQ)
550 551
repLPred (L _ p) = repPred p

552 553 554 555 556 557 558 559 560 561 562 563
repPred :: HsPred Name -> DsM (Core TH.PredQ)
repPred (HsClassP cls tys) 
  = do
      cls1 <- lookupOcc cls
      tys1 <- repLTys tys
      tys2 <- coreList typeQTyConName tys1
      repClassP cls1 tys2
repPred (HsEqualP tyleft tyright) 
  = do
      tyleft1  <- repLTy tyleft
      tyright1 <- repLTy tyright
      repEqualP tyleft1 tyright1
564
repPred p@(HsIParam _ _) = notHandled "Implicit parameter constraint" (ppr p)
chak's avatar
chak committed
565

566 567 568 569 570 571 572 573
repPredTy :: HsPred Name -> DsM (Core TH.TypeQ)
repPredTy (HsClassP cls tys) 
  = do
      tcon <- repTy (HsTyVar cls)
      tys1 <- repLTys tys
      repTapps tcon tys1
repPredTy _ = panic "DsMeta.repPredTy: unexpected equality: internal error"

chak's avatar
chak committed
574 575
-- yield the representation of a list of types
--
576 577
repLTys :: [LHsType Name] -> DsM [Core TH.TypeQ]
repLTys tys = mapM repLTy tys
578

chak's avatar
chak committed
579 580
-- represent a type
--
581 582 583
repLTy :: LHsType Name -> DsM (Core TH.TypeQ)
repLTy (L _ ty) = repTy ty

584 585 586
repTy :: HsType Name -> DsM (Core TH.TypeQ)
repTy (HsForAllTy _ tvs ctxt ty)  = 
  addTyVarBinds tvs $ \bndrs -> do
587 588
    ctxt1  <- repLContext ctxt
    ty1    <- repLTy ty
589
    bndrs1 <- coreList tyVarBndrTyConName bndrs
590
    repTForall bndrs1 ctxt1 ty1
591

592
repTy (HsTyVar n)
593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630
  | isTvOcc (nameOccName n) = do 
			        tv1 <- lookupTvOcc n
			        repTvar tv1
  | otherwise		    = do 
			        tc1 <- lookupOcc n
			        repNamedTyCon tc1
repTy (HsAppTy f a)         = do 
			        f1 <- repLTy f
			        a1 <- repLTy a
			        repTapp f1 a1
repTy (HsFunTy f a)         = do 
			        f1   <- repLTy f
			        a1   <- repLTy a
			        tcon <- repArrowTyCon
			        repTapps tcon [f1, a1]
repTy (HsListTy t)	    = do
			        t1   <- repLTy t
			        tcon <- repListTyCon
			        repTapp tcon t1
repTy (HsPArrTy t)          = do
			        t1   <- repLTy t
			        tcon <- repTy (HsTyVar (tyConName parrTyCon))
			        repTapp tcon t1
repTy (HsTupleTy _ tys)	    = do
			        tys1 <- repLTys tys 
			        tcon <- repTupleTyCon (length tys)
			        repTapps tcon tys1
repTy (HsOpTy ty1 n ty2)    = repLTy ((nlHsTyVar (unLoc n) `nlHsAppTy` ty1) 
			    	   `nlHsAppTy` ty2)
repTy (HsParTy t)  	    = repLTy t
repTy (HsPredTy pred)       = repPredTy pred
repTy (HsKindSig t k)       = do
                                t1 <- repLTy t
                                k1 <- repKind k
                                repTSig t1 k1
repTy (HsSpliceTy splice)   = repSplice splice
repTy ty@(HsNumTy _)        = notHandled "Number types (for generics)" (ppr ty)
repTy ty		    = notHandled "Exotic form of type" (ppr ty)
631

632 633 634 635 636 637 638 639 640 641 642 643 644
-- represent a kind
--
repKind :: Kind -> DsM (Core TH.Kind)
repKind ki
  = do { let (kis, ki') = splitKindFunTys ki
       ; kis_rep <- mapM repKind kis
       ; ki'_rep <- repNonArrowKind ki'
       ; foldlM repArrowK ki'_rep kis_rep
       }
  where
    repNonArrowKind k | isLiftedTypeKind k = repStarK
                      | otherwise          = notHandled "Exotic form of kind" 
                                                        (ppr k)
645

646 647 648 649 650 651 652 653 654 655 656 657 658 659 660
-----------------------------------------------------------------------------
-- 		Splices
-----------------------------------------------------------------------------

repSplice :: HsSplice Name -> DsM (Core a)
-- See Note [How brackets and nested splices are handled] in TcSplice
-- We return a CoreExpr of any old type; the context should know
repSplice (HsSplice n _) 
 = do { mb_val <- dsLookupMetaEnv n
       ; case mb_val of
	   Just (Splice e) -> do { e' <- dsExpr e
				 ; return (MkC e') }
	   _ -> pprPanic "HsSplice" (ppr n) }
			-- Should not happen; statically checked

chak's avatar
chak committed
661
-----------------------------------------------------------------------------
662
-- 		Expressions
chak's avatar
chak committed
663
-----------------------------------------------------------------------------
664

665 666 667
repLEs :: [LHsExpr Name] -> DsM (Core [TH.ExpQ])
repLEs es = do { es'  <- mapM repLE es ;
		 coreList expQTyConName es' }
668

chak's avatar
chak committed
669 670 671
-- 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
672
repLE :: LHsExpr Name -> DsM (Core TH.ExpQ)
673
repLE (L loc e) = putSrcSpanDs loc (repE e)
674

675
repE :: HsExpr Name -> DsM (Core TH.ExpQ)
chak's avatar
chak committed
676 677 678
repE (HsVar x)            =
  do { mb_val <- dsLookupMetaEnv x 
     ; case mb_val of
chak's avatar
chak committed
679
	Nothing	         -> do { str <- globalVar x
chak's avatar
chak committed
680 681 682 683
			       ; 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
684
repE e@(HsIPVar _) = notHandled "Implicit parameters" (ppr e)
685 686 687 688 689

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

Ian Lynagh's avatar
Ian Lynagh committed
693
repE (OpApp e1 op _ e2) =
694 695 696
  do { arg1 <- repLE e1; 
       arg2 <- repLE e2; 
       the_op <- repLE op ;
697
       repInfixApp arg1 the_op arg2 } 
Ian Lynagh's avatar
Ian Lynagh committed
698
repE (NegApp x _)        = do
699
			      a         <- repLE x
chak's avatar
chak committed
700 701
			      negateVar <- lookupOcc negateName >>= repVar
			      negateVar `repApp` a
702 703 704
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 } 
705 706 707
repE (HsCase e (MatchGroup ms _)) = do { arg <- repLE e
				       ; ms2 <- mapM repMatchTup ms
				       ; repCaseE arg (nonEmptyCoreList ms2) }
708 709 710 711
repE (HsIf x y z)         = do
			      a <- repLE x
			      b <- repLE y
			      c <- repLE z
chak's avatar
chak committed
712 713
			      repCond a b c
repE (HsLet bs e)         = do { (ss,ds) <- repBinds bs
714
			       ; e2 <- addBinds ss (repLE e)
chak's avatar
chak committed
715
			       ; z <- repLetE ds e2
716
			       ; wrapGenSyns ss z }
chak's avatar
chak committed
717
-- FIXME: I haven't got the types here right yet
Ian Lynagh's avatar
Ian Lynagh committed
718
repE (HsDo DoExpr sts body _) 
719
 = do { (ss,zs) <- repLSts sts; 
720
	body'	<- addBinds ss $ repLE body;
721 722
	ret	<- repNoBindSt body';	
        e       <- repDoE (nonEmptyCoreList (zs ++ [ret]));
723
        wrapGenSyns ss e }
Ian Lynagh's avatar
Ian Lynagh committed
724
repE (HsDo ListComp sts body _)
725
 = do { (ss,zs) <- repLSts sts; 
726
	body'	<- addBinds ss $ repLE body;
727 728
	ret	<- repNoBindSt body';	
        e       <- repComp (nonEmptyCoreList (zs ++ [ret]));
729
        wrapGenSyns ss e }
730
repE e@(HsDo _ _ _ _) = notHandled "mdo and [: :]" (ppr e)
Ian Lynagh's avatar
Ian Lynagh committed
731 732
repE (ExplicitList _ es) = do { xs <- repLEs es; repListExp xs }
repE e@(ExplicitPArr _ _) = notHandled "Parallel arrays" (ppr e)
733
repE e@(ExplicitTuple es boxed) 
734 735 736 737
  | not (isBoxed boxed)        = notHandled "Unboxed tuples" (ppr e)
  | not (all tupArgPresent es) = notHandled "Tuple sections" (ppr e)
  | otherwise                  = do { xs <- repLEs [e | Present e <- es]; repTup xs }

738
repE (RecordCon c _ flds)
739
 = do { x <- lookupLOcc c;
740 741
        fs <- repFields flds;
        repRecCon x fs }
742
repE (RecordUpd e flds _ _ _)
743
 = do { x <- repLE e;
744 745
        fs <- repFields flds;
        repRecUpd x fs }
746

747
repE (ExprWithTySig e ty) = do { e1 <- repLE e; t1 <- repLTy ty; repSigExp e1 t1 }
748
repE (ArithSeq _ aseq) =
chak's avatar
chak committed
749
  case aseq of
750
    From e              -> do { ds1 <- repLE e; repFrom ds1 }
chak's avatar
chak committed
751
    FromThen e1 e2      -> do 
752 753
		             ds1 <- repLE e1
			     ds2 <- repLE e2
chak's avatar
chak committed
754 755
			     repFromThen ds1 ds2
    FromTo   e1 e2      -> do 
756 757
			     ds1 <- repLE e1
			     ds2 <- repLE e2
chak's avatar
chak committed
758 759
			     repFromTo ds1 ds2
    FromThenTo e1 e2 e3 -> do 
760 761 762
			     ds1 <- repLE e1
			     ds2 <- repLE e2
			     ds3 <- repLE e3
chak's avatar
chak committed
763
			     repFromThenTo ds1 ds2 ds3
764

765
repE (HsSpliceE splice)  = repSplice splice
766 767 768
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
769
repE e@(HsTickPragma {}) = notHandled "Tick Pragma" (ppr e)
770 771
repE e@(HsBracketOut {}) = notHandled "TH brackets" (ppr e)
repE e 			 = notHandled "Expression form" (ppr e)
772 773 774 775

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

776
repMatchTup ::  LMatch Name -> DsM (Core TH.MatchQ) 
Ian Lynagh's avatar
Ian Lynagh committed
777
repMatchTup (L _ (Match [p] _ (GRHSs guards wheres))) =
778
  do { ss1 <- mkGenSyms (collectPatBinders p) 
779
     ; addBinds ss1 $ do {
780
     ; p1 <- repLP p
781
     ; (ss2,ds) <- repBinds wheres
782 783 784
     ; addBinds ss2 $ do {
     ; gs    <- repGuards guards
     ; match <- repMatch p1 gs ds
785
     ; wrapGenSyns (ss1++ss2) match }}}
Ian Lynagh's avatar
Ian Lynagh committed
786
repMatchTup _ = panic "repMatchTup: case alt with more than one arg"
787

788
repClauseTup ::  LMatch Name -> DsM (Core TH.ClauseQ)
Ian Lynagh's avatar
Ian Lynagh committed
789
repClauseTup (L _ (Match ps _ (GRHSs guards wheres))) =
790
  do { ss1 <- mkGenSyms (collectPatsBinders ps) 
791
     ; addBinds ss1 $ do {
792
       ps1 <- repLPs ps
793
     ; (ss2,ds) <- repBinds wheres
794 795 796
     ; addBinds ss2 $ do {
       gs <- repGuards guards
     ; clause <- repClause ps1 gs ds
797
     ; wrapGenSyns (ss1++ss2) clause }}}
798

799
repGuards ::  [LGRHS Name] ->  DsM (Core TH.BodyQ)
800
repGuards [L _ (GRHS [] e)]
801
  = do {a <- repLE e; repNormal a }
802
repGuards other 
803 804 805 806
  = do { zs <- mapM process other;
     let {(xs, ys) = unzip zs};
	 gd <- repGuarded (nonEmptyCoreList ys);
     wrapGenSyns (concat xs) gd }
807
  where 
808
    process :: LGRHS Name -> DsM ([GenSymBind], (Core (TH.Q (TH.Guard, TH.Exp))))
809
    process (L _ (GRHS [L _ (ExprStmt e1 _ _)] e2))
810 811
           = do { x <- repLNormalGE e1 e2;
                  return ([], x) }
812
    process (L _ (GRHS ss rhs))
813
           = do (gs, ss') <- repLSts ss
814
		rhs' <- addBinds gs $ repLE rhs
815
                g <- repPatGE (nonEmptyCoreList ss') rhs'
816
                return (gs, g)
817

818 819
repFields :: HsRecordBinds Name -> DsM (Core [TH.Q TH.FieldExp])
repFields (HsRecFields { rec_flds = flds })
820 821 822 823
  = do	{ fnames <- mapM lookupLOcc (map hsRecFieldId flds)
	; es <- mapM repLE (map hsRecFieldArg flds)
	; fs <- zipWithM repFieldExp fnames es
	; coreList fieldExpQTyConName fs }
824

825 826 827

-----------------------------------------------------------------------------
-- Representing Stmt's is tricky, especially if bound variables
828
-- shadow each other. Consider:  [| do { x <- f 1; x <- f x; g x } |]
829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850
-- 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.

851 852 853
repLSts :: [LStmt Name] -> DsM ([GenSymBind], [Core TH.StmtQ])
repLSts stmts = repSts (map unLoc stmts)

854
repSts :: [Stmt Name] -> DsM ([GenSymBind], [Core TH.StmtQ])
855
repSts (BindStmt p e _ _ : ss) =
856
   do { e2 <- repLE e 
857
      ; ss1 <- mkGenSyms (collectPatBinders p) 
858
      ; addBinds ss1 $ do {
859
      ; p1 <- repLP p; 
860 861 862 863
      ; (ss2,zs) <- repSts ss
      ; z <- repBindSt p1 e2
      ; return (ss1++ss2, z : zs) }}
repSts (LetStmt bs : ss) =
864
   do { (ss1,ds) <- repBinds bs
865 866 867
      ; z <- repLetSt ds
      ; (ss2,zs) <- addBinds ss1 (repSts ss)
      ; return (ss1++ss2, z : zs) } 
868
repSts (ExprStmt e _ _ : ss) =       
869
   do { e2 <- repLE e
870 871 872
      ; z <- repNoBindSt e2 
      ; (ss2,zs) <- repSts ss
      ; return (ss2, z : zs) }
873 874
repSts []    = return ([],[])
repSts other = notHandled "Exotic statement" (ppr other)
875 876


877 878 879
-----------------------------------------------------------
--			Bindings
-----------------------------------------------------------
880

881 882 883 884 885
repBinds :: HsLocalBinds Name -> DsM ([GenSymBind], Core [TH.DecQ]) 
repBinds EmptyLocalBinds
  = do	{ core_list <- coreList decQTyConName []
	; return ([], core_list) }

886
repBinds b@(HsIPBinds _) = notHandled "Implicit parameters" (ppr b)
887 888 889

repBinds (HsValBinds decs)
 = do	{ let { bndrs = map unLoc (collectHsValBinders decs) }
890 891 892 893
		-- 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
894
	; ss        <- mkGenSyms bndrs
895 896 897
	; prs       <- addBinds ss (rep_val_binds decs)
	; core_list <- coreList decQTyConName 
				(de_loc (sort_by_loc prs))
898
	; return (ss, core_list) }
899

900
rep_val_binds :: HsValBinds Name -> DsM [(SrcSpan, Core TH.DecQ)]
901
-- Assumes: all the binders of the binding are alrady in the meta-env
902 903
rep_val_binds (ValBindsOut binds sigs)
 = do { core1 <- rep_binds' (unionManyBags (map snd binds))
904
      ;	core2 <- rep_sigs' sigs
905
      ;	return (core1 ++ core2) }
Ian Lynagh's avatar
Ian Lynagh committed
906
rep_val_binds (ValBindsIn _ _)
907
 = panic "rep_val_binds: ValBindsIn"
908

909
rep_binds :: LHsBinds Name -> DsM [Core TH.DecQ]
910 911 912 913 914
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)
915

916
rep_bind :: LHsBind Name -> DsM (SrcSpan, Core TH.DecQ)
917
-- Assumes: all the binders of the binding are alrady in the meta-env
918 919 920 921

-- 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
922
rep_bind (L loc (FunBind { fun_id = fn, 
Ian Lynagh's avatar
Ian Lynagh committed
923
			   fun_matches = MatchGroup [L _ (Match [] _ (GRHSs guards wheres))] _ }))
924
 = do { (ss,wherecore) <- repBinds wheres
925
	; guardcore <- addBinds ss (repGuards guards)
926 927 928 929 930
	; fn'  <- lookupLBinder fn
	; p    <- repPvar fn'
	; ans  <- repVal p guardcore wherecore
	; ans' <- wrapGenSyns ss ans
	; return (loc, ans') }
931