DsMeta.hs 85.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 19
	       liftName, liftStringName, expQTyConName, patQTyConName, 
               decQTyConName, decsQTyConName, typeQTyConName,
20
	       decTyConName, typeTyConName, mkNameG_dName, mkNameG_vName, mkNameG_tcName,
21
	       quoteExpName, quotePatName, quoteDecName, quoteTypeName
22
	        ) where
23

24 25
#include "HsVersions.h"

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

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

31
import qualified Language.Haskell.TH as TH
32

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

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

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

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

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

76 77 78 79 80 81
    do_brack (VarBr n)   = do { MkC e1  <- lookupOcc n ; return e1 }
    do_brack (ExpBr e)   = do { MkC e1  <- repLE e     ; return e1 }
    do_brack (PatBr p)   = do { MkC p1  <- repTopP p   ; return p1 }
    do_brack (TypBr t)   = do { MkC t1  <- repLTy t    ; return t1 }
    do_brack (DecBrG gp) = do { MkC ds1 <- repTopDs gp ; return ds1 }
    do_brack (DecBrL _)  = panic "dsBracket: unexpected DecBrL"
82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97

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


98 99 100 101
-------------------------------------------------------
-- 			Declarations
-------------------------------------------------------

102 103 104 105 106
repTopP :: LPat Name -> DsM (Core TH.PatQ)
repTopP pat = do { ss <- mkGenSyms (collectPatBinders pat) 
                 ; pat' <- addBinds ss (repLP pat)
                 ; wrapNongenSyms ss pat' }

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

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

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

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

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

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


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

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

-}

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

165 166 167
repTyClD tydecl@(L _ (TyFamily {}))
  = repTyFamily tydecl addTyVarBinds

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

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

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

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

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

262 263 264 265 266 267 268 269 270 271 272 273 274
-- 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
275

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

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

repCCallConv :: CCallConv -> DsM (Core TH.Callconv)
repCCallConv CCallConv = rep2 cCallName []
repCCallConv StdCallConv = rep2 stdCallName []
348
repCCallConv callConv    = notHandled "repCCallConv" (ppr callConv)
349 350 351

repSafety :: Safety -> DsM (Core TH.Safety)
repSafety PlayRisky = rep2 unsafeName []
352
repSafety PlayInterruptible = rep2 interruptibleName []
353 354 355
repSafety (PlaySafe False) = rep2 safeName []
repSafety (PlaySafe True) = rep2 threadsafeName []

Ian Lynagh's avatar
Ian Lynagh committed
356
ds_msg :: SDoc
Ian Lynagh's avatar
Ian Lynagh committed
357
ds_msg = ptext (sLit "Cannot desugar this Template Haskell declaration:")
358

359 360 361 362
-------------------------------------------------------
-- 			Constructors
-------------------------------------------------------

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

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

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

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


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

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

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

419
rep_sig :: LSig Name -> DsM [(SrcSpan, Core TH.DecQ)]
420 421
	-- Singleton => Ok
	-- Empty     => Too hard, signature ignored
422 423 424 425 426 427 428 429 430 431 432 433 434 435
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)]
       }

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

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

459
-- Extract all the information needed to build a TH.InlinePrag
460
--
461 462 463
rep_InlinePrag :: InlinePragma	-- Never defaultInlinePragma
               -> DsM (Core TH.InlineSpecQ)
rep_InlinePrag (InlinePragma { inl_act = activation, inl_rule = match, inl_inline = inline })
464
  | Just (flag, phase) <- activation1 
465 466 467 468
  = repInlineSpecPhase inline1 match1 flag phase
  | otherwise
  = repInlineSpecNoPhase inline1 match1
  where
469 470
      match1      = coreBool (rep_RuleMatchInfo match)
      activation1 = rep_Activation activation
471 472 473 474
      inline1     = case inline of 
                       Inline -> coreBool True
 		       _other -> coreBool False
		       -- We have no representation for Inlinable
475 476 477 478

      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
    wrapGenSyms 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
    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)
532 533 534 535
repTyVarBndrWithKind (L _ (UserTyVar {})) nm
  = repPlainTV nm
repTyVarBndrWithKind (L _ (KindedTyVar _ ki)) nm
  = repKind ki >>= repKindedTV nm
536

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

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

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

553 554 555 556 557 558 559 560 561 562 563 564
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
565
repPred p@(HsIParam _ _) = notHandled "Implicit parameter constraint" (ppr p)
chak's avatar
chak committed
566

567 568 569 570 571 572 573 574
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
575 576
-- yield the representation of a list of types
--
577 578
repLTys :: [LHsType Name] -> DsM [Core TH.TypeQ]
repLTys tys = mapM repLTy tys
579

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

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

593
repTy (HsTyVar n)
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
  | 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
629 630 631
repTy (HsSpliceTy splice _ _) = repSplice splice
repTy ty@(HsNumTy _)          = notHandled "Number types (for generics)" (ppr ty)
repTy ty		      = notHandled "Exotic form of type" (ppr ty)
632

633 634 635 636 637 638 639
-- 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'
640
       ; foldrM repArrowK ki'_rep kis_rep
641 642 643 644 645
       }
  where
    repNonArrowKind k | isLiftedTypeKind k = repStarK
                      | otherwise          = notHandled "Exotic form of kind" 
                                                        (ppr k)
646

647 648 649 650 651 652 653 654 655 656 657 658 659 660 661
-----------------------------------------------------------------------------
-- 		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
662
-----------------------------------------------------------------------------
663
-- 		Expressions
chak's avatar
chak committed
664
-----------------------------------------------------------------------------
665

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

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

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

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

Ian Lynagh's avatar
Ian Lynagh committed
694
repE (OpApp e1 op _ e2) =
695 696 697
  do { arg1 <- repLE e1; 
       arg2 <- repLE e2; 
       the_op <- repLE op ;
698
       repInfixApp arg1 the_op arg2 } 
Ian Lynagh's avatar
Ian Lynagh committed
699
repE (NegApp x _)        = do
700
			      a         <- repLE x
chak's avatar
chak committed
701 702
			      negateVar <- lookupOcc negateName >>= repVar
			      negateVar `repApp` a
703 704 705
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 } 
706 707 708
repE (HsCase e (MatchGroup ms _)) = do { arg <- repLE e
				       ; ms2 <- mapM repMatchTup ms
				       ; repCaseE arg (nonEmptyCoreList ms2) }
709
repE (HsIf _ x y z)         = do
710 711 712
			      a <- repLE x
			      b <- repLE y
			      c <- repLE z
chak's avatar
chak committed
713 714
			      repCond a b c
repE (HsLet bs e)         = do { (ss,ds) <- repBinds bs
715
			       ; e2 <- addBinds ss (repLE e)
chak's avatar
chak committed
716
			       ; z <- repLetE ds e2
717
			       ; wrapGenSyms ss z }
718

chak's avatar
chak committed
719
-- FIXME: I haven't got the types here right yet
720 721
repE e@(HsDo ctxt sts body _) 
 | case ctxt of { DoExpr -> True; GhciStmt -> True; _ -> False }
722
 = do { (ss,zs) <- repLSts sts; 
723
	body'	<- addBinds ss $ repLE body;
724
	ret	<- repNoBindSt body';	
725
        e'      <- repDoE (nonEmptyCoreList (zs ++ [ret]));
726
        wrapGenSyms ss e' }
727 728

 | ListComp <- ctxt
729
 = do { (ss,zs) <- repLSts sts; 
730
	body'	<- addBinds ss $ repLE body;
731
	ret	<- repNoBindSt body';	
732
        e'      <- repComp (nonEmptyCoreList (zs ++ [ret]));
733
        wrapGenSyms ss e' }
734 735 736 737

  | otherwise
  = notHandled "mdo and [: :]" (ppr e)

Ian Lynagh's avatar
Ian Lynagh committed
738 739
repE (ExplicitList _ es) = do { xs <- repLEs es; repListExp xs }
repE e@(ExplicitPArr _ _) = notHandled "Parallel arrays" (ppr e)
740
repE e@(ExplicitTuple es boxed) 
741 742 743 744
  | 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 }

745
repE (RecordCon c _ flds)
746
 = do { x <- lookupLOcc c;
747 748
        fs <- repFields flds;
        repRecCon x fs }
749
repE (RecordUpd e flds _ _ _)
750
 = do { x <- repLE e;
751 752
        fs <- repFields flds;
        repRecUpd x fs }
753

754
repE (ExprWithTySig e ty) = do { e1 <- repLE e; t1 <- repLTy ty; repSigExp e1 t1 }
755
repE (ArithSeq _ aseq) =
chak's avatar
chak committed
756
  case aseq of
757
    From e              -> do { ds1 <- repLE e; repFrom ds1 }
chak's avatar
chak committed
758
    FromThen e1 e2      -> do 
759 760
		             ds1 <- repLE e1
			     ds2 <- repLE e2
chak's avatar
chak committed
761 762
			     repFromThen ds1 ds2
    FromTo   e1 e2      -> do 
763 764
			     ds1 <- repLE e1
			     ds2 <- repLE e2
chak's avatar
chak committed
765 766
			     repFromTo ds1 ds2
    FromThenTo e1 e2 e3 -> do 
767 768 769
			     ds1 <- repLE e1
			     ds2 <- repLE e2
			     ds3 <- repLE e3
chak's avatar
chak committed
770
			     repFromThenTo ds1 ds2 ds3
771

772
repE (HsSpliceE splice)  = repSplice splice
773 774 775
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
776
repE e@(HsTickPragma {}) = notHandled "Tick Pragma" (ppr e)
777 778
repE e@(HsBracketOut {}) = notHandled "TH brackets" (ppr e)
repE e 			 = notHandled "Expression form" (ppr e)
779 780 781 782

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

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

795
repClauseTup ::  LMatch Name -> DsM (Core TH.ClauseQ)
Ian Lynagh's avatar
Ian Lynagh committed
796
repClauseTup (L _ (Match ps _ (GRHSs guards wheres))) =
797
  do { ss1 <- mkGenSyms (collectPatsBinders ps) 
798
     ; addBinds ss1 $ do {
799
       ps1 <- repLPs ps
800
     ; (ss2,ds) <- repBinds wheres
801 802 803
     ; addBinds ss2 $ do {
       gs <- repGuards guards
     ; clause <- repClause ps1 gs ds
804
     ; wrapGenSyms (ss1++ss2) clause }}}
805

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

825 826
repFields :: HsRecordBinds Name -> DsM (Core [TH.Q TH.FieldExp])
repFields (HsRecFields { rec_flds = flds })
827 828 829 830
  = do	{ fnames <- mapM lookupLOcc (map hsRecFieldId flds)
	; es <- mapM repLE (map hsRecFieldArg flds)
	; fs <- zipWithM repFieldExp fnames es
	; coreList fieldExpQTyConName fs }
831

832 833 834

-----------------------------------------------------------------------------
-- Representing Stmt's is tricky, especially if bound variables
835
-- shadow each other. Consider:  [| do { x <- f 1; x <- f x; g x } |]
836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857
-- 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.

858 859 860
repLSts :: [LStmt Name] -> DsM ([GenSymBind], [Core TH.StmtQ])
repLSts stmts = repSts (map unLoc stmts)

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


884 885 886
-----------------------------------------------------------
--			Bindings
-----------------------------------------------------------
887

888 889 890 891 892
repBinds :: HsLocalBinds Name -> DsM ([GenSymBind], Core [TH.DecQ]) 
repBinds EmptyLocalBinds
  = do	{ core_list <- coreList decQTyConName []
	; return ([], core_list) }

893
repBinds b@(HsIPBinds _) = notHandled "Implicit parameters" (ppr b)
894 895

repBinds (HsValBinds decs)
896
 = do	{ let { bndrs = collectHsValBinders decs }
897 898 899 900
		-- 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
901
	; ss        <- mkGenSyms bndrs
902 903 904
	; prs       <- addBinds ss (rep_val_binds decs)
	; core_list <- coreList decQTyConName 
				(de_loc (sort_by_loc prs))
905
	; return (ss, core_list) }
906

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

916
rep_binds :: LHsBinds Name -> DsM [Core TH.DecQ]
917 918 919 920 921
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)
922

923
rep_bind :: LHsBind Name -> DsM (SrcSpan, Core TH.DecQ)
924
-- Assumes: all the binders of the binding are alrady in the meta-env
925 926 927 928

-- 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