DsMeta.hs 83.8 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
	       liftName, liftStringName, expQTyConName, patQTyConName, decQTyConName, typeQTyConName,
27 28
	       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
		          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
191
	      ; bndrs1   <- coreList tyVarBndrTyConName bndrs
192 193 194 195
      	      ; 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
		          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
207
	      ; bndrs1   <- coreList tyVarBndrTyConName bndrs
208 209 210 211 212 213 214 215 216 217 218 219
      	      ; 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
220
	      ; bndrs1   <- coreList tyVarBndrTyConName bndrs
221 222 223 224
	      ; 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
		             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)
238
	      ; bndrs1 <- coreList tyVarBndrTyConName bndrs
239 240 241 242
 	      ; 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
-- 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, 
258
		               tcdKind = opt_kind }))
259 260 261 262
            tyVarBinds
  = do { tc1 <- lookupLOcc tc 		-- See note [Binders and occurrences] 
       ; dec <- tyVarBinds tvs $ \bndrs ->
           do { flav   <- repFamilyFlavour flavour
263 264 265 266 267 268
	      ; bndrs1 <- coreList tyVarBndrTyConName bndrs
              ; case opt_kind of 
                  Nothing -> repFamilyNoKind flav tc1 bndrs1
                  Just ki -> do { ki1 <- repKind ki 
                                ; repFamilyKind flav tc1 bndrs1 ki1
                                }
269 270 271 272 273
              }
       ; return $ Just (loc, dec)
       }
repTyFamily _ _ = panic "DsMeta.repTyFamily: internal error"

274 275 276 277 278 279 280 281 282 283 284 285 286
-- 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
287

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

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

repCCallConv :: CCallConv -> DsM (Core TH.Callconv)
repCCallConv CCallConv = rep2 cCallName []
repCCallConv StdCallConv = rep2 stdCallName []
360
repCCallConv callConv    = notHandled "repCCallConv" (ppr callConv)
361 362 363 364 365 366

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

370 371 372 373
-------------------------------------------------------
-- 			Constructors
-------------------------------------------------------

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

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

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

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


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

421
rep_sigs :: [LSig Name] -> DsM [Core TH.DecQ]
422 423 424
rep_sigs sigs = do locs_cores <- rep_sigs' sigs
                   return $ de_loc $ sort_by_loc locs_cores

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

430
rep_sig :: LSig Name -> DsM [(SrcSpan, Core TH.DecQ)]
431 432
	-- Singleton => Ok
	-- Empty     => Too hard, signature ignored
433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466
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)]
       }

rep_inline :: Located Name -> InlineSpec -> SrcSpan 
           -> DsM [(SrcSpan, Core TH.DecQ)]
rep_inline nm ispec loc
  = do { nm1 <- lookupLOcc nm
       ; (_, ispec1) <- rep_InlineSpec ispec
       ; pragma <- repPragInl nm1 ispec1
       ; return [(loc, pragma)]
       }

rep_specialise :: Located Name -> LHsType Name -> InlineSpec -> SrcSpan 
               -> DsM [(SrcSpan, Core TH.DecQ)]
rep_specialise nm ty ispec loc
  = do { nm1 <- lookupLOcc nm
       ; ty1 <- repLTy ty
       ; (hasSpec, ispec1) <- rep_InlineSpec ispec
       ; pragma <- if hasSpec
                   then repPragSpecInl nm1 ty1 ispec1
                   else repPragSpec    nm1 ty1 
       ; return [(loc, pragma)]
       }
467

468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490
-- extract all the information needed to build a TH.InlineSpec
--
rep_InlineSpec :: InlineSpec -> DsM (Bool, Core TH.InlineSpecQ)
rep_InlineSpec (Inline (InlinePragma activation match) inline)
  | Nothing            <- activation1 
    = liftM ((,) False) $ repInlineSpecNoPhase inline1 match1
  | Just (flag, phase) <- activation1 
    = liftM ((,) True)  $ repInlineSpecPhase inline1 match1 flag phase
  | 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

      rep_Activation NeverActive          = Nothing
      rep_Activation AlwaysActive         = Nothing
      rep_Activation (ActiveBefore phase) = Just (coreBool False, 
                                                  MkC $ mkIntExprInt phase)
      rep_Activation (ActiveAfter phase)  = Just (coreBool True, 
                                                  MkC $ mkIntExprInt phase)
491 492 493 494 495


-------------------------------------------------------
-- 			Types
-------------------------------------------------------
496

497 498 499 500 501
-- 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 = 
502 503
         [LHsTyVarBndr Name]	                       -- the binders to be added
      -> ([Core TH.TyVarBndr] -> DsM (Core (TH.Q a)))  -- action in the ext env
504 505
      -> DsM (Core (TH.Q a))

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

522 523 524 525 526 527
-- 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
528 529 530 531 532 533 534 535 536 537 538 539 540
    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
541

chak's avatar
chak committed
542 543
-- represent a type context
--
544 545 546
repLContext :: LHsContext Name -> DsM (Core TH.CxtQ)
repLContext (L _ ctxt) = repContext ctxt

547
repContext :: HsContext Name -> DsM (Core TH.CxtQ)
chak's avatar
chak committed
548
repContext ctxt = do 
549
	            preds    <- mapM repLPred ctxt
550
		    predList <- coreList predQTyConName preds
chak's avatar
chak committed
551
		    repCtxt predList
552

chak's avatar
chak committed
553 554
-- represent a type predicate
--
555
repLPred :: LHsPred Name -> DsM (Core TH.PredQ)
556 557
repLPred (L _ p) = repPred p

558 559 560 561 562 563 564 565 566 567 568 569
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
570
repPred p@(HsIParam _ _) = notHandled "Implicit parameter constraint" (ppr p)
chak's avatar
chak committed
571

572 573 574 575 576 577 578 579
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
580 581
-- yield the representation of a list of types
--
582 583
repLTys :: [LHsType Name] -> DsM [Core TH.TypeQ]
repLTys tys = mapM repLTy tys
584

chak's avatar
chak committed
585 586
-- represent a type
--
587 588 589
repLTy :: LHsType Name -> DsM (Core TH.TypeQ)
repLTy (L _ ty) = repTy ty

590 591 592
repTy :: HsType Name -> DsM (Core TH.TypeQ)
repTy (HsForAllTy _ tvs ctxt ty)  = 
  addTyVarBinds tvs $ \bndrs -> do
593 594
    ctxt1  <- repLContext ctxt
    ty1    <- repLTy ty
595
    bndrs1 <- coreList tyVarBndrTyConName bndrs
596
    repTForall bndrs1 ctxt1 ty1
597

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

637 638 639 640 641 642 643 644 645 646 647 648 649
-- 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)
650

chak's avatar
chak committed
651
-----------------------------------------------------------------------------
652
-- 		Expressions
chak's avatar
chak committed
653
-----------------------------------------------------------------------------
654

655 656 657
repLEs :: [LHsExpr Name] -> DsM (Core [TH.ExpQ])
repLEs es = do { es'  <- mapM repLE es ;
		 coreList expQTyConName es' }
658

chak's avatar
chak committed
659 660 661
-- 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
662
repLE :: LHsExpr Name -> DsM (Core TH.ExpQ)
663
repLE (L loc e) = putSrcSpanDs loc (repE e)
664

665
repE :: HsExpr Name -> DsM (Core TH.ExpQ)
chak's avatar
chak committed
666 667 668
repE (HsVar x)            =
  do { mb_val <- dsLookupMetaEnv x 
     ; case mb_val of
chak's avatar
chak committed
669
	Nothing	         -> do { str <- globalVar x
chak's avatar
chak committed
670 671 672 673
			       ; 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
674
repE e@(HsIPVar _) = notHandled "Implicit parameters" (ppr e)
675 676 677 678 679

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

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

735
repE (ExprWithTySig e ty) = do { e1 <- repLE e; t1 <- repLTy ty; repSigExp e1 t1 }
736
repE (ArithSeq _ aseq) =
chak's avatar
chak committed
737
  case aseq of
738
    From e              -> do { ds1 <- repLE e; repFrom ds1 }
chak's avatar
chak committed
739
    FromThen e1 e2      -> do 
740 741
		             ds1 <- repLE e1
			     ds2 <- repLE e2
chak's avatar
chak committed
742 743
			     repFromThen ds1 ds2
    FromTo   e1 e2      -> do 
744 745
			     ds1 <- repLE e1
			     ds2 <- repLE e2
chak's avatar
chak committed
746 747
			     repFromTo ds1 ds2
    FromThenTo e1 e2 e3 -> do 
748 749 750
			     ds1 <- repLE e1
			     ds2 <- repLE e2
			     ds3 <- repLE e3
chak's avatar
chak committed
751
			     repFromThenTo ds1 ds2 ds3
752 753 754 755 756
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
757
		 _ -> pprPanic "HsSplice" (ppr n) }
758
			-- Should not happen; statically checked
759

760 761 762
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
763
repE e@(HsTickPragma {}) = notHandled "Tick Pragma" (ppr e)
764 765
repE e@(HsBracketOut {}) = notHandled "TH brackets" (ppr e)
repE e 			 = notHandled "Expression form" (ppr e)
766 767 768 769

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

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

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

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

812 813
repFields :: HsRecordBinds Name -> DsM (Core [TH.Q TH.FieldExp])
repFields (HsRecFields { rec_flds = flds })
814 815 816 817
  = do	{ fnames <- mapM lookupLOcc (map hsRecFieldId flds)
	; es <- mapM repLE (map hsRecFieldArg flds)
	; fs <- zipWithM repFieldExp fnames es
	; coreList fieldExpQTyConName fs }
818

819 820 821

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

845 846 847
repLSts :: [LStmt Name] -> DsM ([GenSymBind], [Core TH.StmtQ])
repLSts stmts = repSts (map unLoc stmts)

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


871 872 873
-----------------------------------------------------------
--			Bindings
-----------------------------------------------------------
874

875 876 877 878 879
repBinds :: HsLocalBinds Name -> DsM ([GenSymBind], Core [TH.DecQ]) 
repBinds EmptyLocalBinds
  = do	{ core_list <- coreList decQTyConName []
	; return ([], core_list) }

880
repBinds b@(HsIPBinds _) = notHandled "Implicit parameters" (ppr b)
881 882 883

repBinds (HsValBinds decs)
 = do	{ let { bndrs = map unLoc (collectHsValBinders decs) }
884 885 886 887
		-- 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
888
	; ss        <- mkGenSyms bndrs
889 890 891
	; prs       <- addBinds ss (rep_val_binds decs)
	; core_list <- coreList decQTyConName 
				(de_loc (sort_by_loc prs))
892
	; return (ss, core_list) }
893

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

903
rep_binds :: LHsBinds Name -> DsM [Core TH.DecQ]
904 905 906 907 908
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)
909

910
rep_bind :: LHsBind Name -> DsM (SrcSpan, Core TH.DecQ)
911
-- Assumes: all the binders of the binding are alrady in the meta-env
912 913 914 915

-- 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
916
rep_bind (L loc (FunBind { fun_id = fn, 
Ian Lynagh's avatar
Ian Lynagh committed
917
			   fun_matches = MatchGroup [L _ (Match [] _ (GRHSs guards wheres))] _ }))
918
 = do { (ss,wherecore) <- repBinds wheres
919