DsMeta.hs 88.2 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
import Util( equalLength )
61

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

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

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

77 78 79 80 81 82
    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"
83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98

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


99 100 101 102
-------------------------------------------------------
-- 			Declarations
-------------------------------------------------------

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

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

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

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

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

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

135
	wrapGenSyms ss q_decs
136 137 138
      }


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
		          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
176
              ; cons1    <- mapM (repC (hsLTyVarNames tvs)) cons
177 178
      	      ; 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
		          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
193
              ; con1     <- repC (hsLTyVarNames tvs) con
194
      	      ; 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
		             tcdTyVars = tvs, tcdFDs = fds,
		             tcdSigs = sigs, tcdMeths = meth_binds, 
217
                             tcdATs = ats, tcdATDefs = [] }))
218 219 220 221 222 223 224 225
  = 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
repInstD' (L loc (InstDecl ty binds _ ats))	-- Ignore user pragmas for now
304 305 306 307 308 309 310 311 312 313 314
  = do { dec <- 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
	    --
	    -- But we do NOT bring the binders of 'binds' into scope
	    -- becuase they are properly regarded as occurrences
	    -- For example, the method names should be bound to
	    -- the selector Ids, not to fresh names (Trac #5410)
	    --
            do { cxt1 <- repContext cxt
batterseapower's avatar
batterseapower committed
315 316 317
               ; cls_tcon <- repTy (HsTyVar cls)
               ; cls_tys <- repLTys tys
               ; inst_ty1 <- repTapps cls_tcon cls_tys
318 319 320 321 322
               ; binds1 <- rep_binds binds
               ; ats1 <- repLAssocFamInst ats
               ; decls <- coreList decQTyConName (ats1 ++ binds1)
               ; repInst cxt1 inst_ty1 decls }
       ; return (loc, dec) }
323
 where
batterseapower's avatar
batterseapower committed
324
   Just (tvs, cxt, cls, tys) = splitHsInstDeclTy_maybe (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
    conv_cimportspec (CLabel cls) = notHandled "Foreign label" (doubleQuotes (ppr cls))
    conv_cimportspec (CFunction DynamicTarget) = return "dynamic"
341
    conv_cimportspec (CFunction (StaticTarget fs _)) = return (unpackFS fs)
342
    conv_cimportspec CWrapper = return "wrapper"
343
    static = case cis of
344
                 CFunction (StaticTarget _ _) -> "static "
345
                 _ -> ""
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

repSafety :: Safety -> DsM (Core TH.Safety)
repSafety PlayRisky = rep2 unsafeName []
355
repSafety PlayInterruptible = rep2 interruptibleName []
Ian Lynagh's avatar
Ian Lynagh committed
356
repSafety PlaySafe = rep2 safeName []
357

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 366 367
repC :: [Name] -> LConDecl Name -> DsM (Core TH.ConQ)
repC _ (L _ (ConDecl { con_name = con, con_qvars = [], con_cxt = L _ []
                       , con_details = details, con_res = ResTyH98 }))
368
  = do { con1 <- lookupLOcc con 	-- See note [Binders and occurrences] 
369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424
       ; repConstr con1 details  }
repC tvs (L _ (ConDecl { con_name = con
                       , con_qvars = con_tvs, con_cxt = L _ ctxt
                       , con_details = details
                       , con_res = res_ty }))
  = do { (eq_ctxt, con_tv_subst) <- mkGadtCtxt tvs res_ty
       ; let ex_tvs = [ tv | tv <- con_tvs, not (hsLTyVarName tv `in_subst` con_tv_subst)]
       ; binds <- mapM dupBinder con_tv_subst 
       ; dsExtendMetaEnv (mkNameEnv binds) $     -- Binds some of the con_tvs
         addTyVarBinds ex_tvs $ \ ex_bndrs ->   -- Binds the remaining con_tvs
    do { con1      <- lookupLOcc con 	-- See note [Binders and occurrences] 
       ; c'        <- repConstr con1 details
       ; ctxt'     <- repContext (eq_ctxt ++ ctxt)
       ; ex_bndrs' <- coreList tyVarBndrTyConName ex_bndrs
       ; rep2 forallCName [unC ex_bndrs', unC ctxt', unC c'] } }

in_subst :: Name -> [(Name,Name)] -> Bool
in_subst _ []          = False
in_subst n ((n',_):ns) = n==n' || in_subst n ns

mkGadtCtxt :: [Name]		-- Tyvars of the data type
           -> ResType Name
	   -> DsM (HsContext Name, [(Name,Name)])
-- Given a data type in GADT syntax, figure out the equality 
-- context, so that we can represent it with an explicit 
-- equality context, because that is the only way to express
-- the GADT in TH syntax
--
-- Example:   
-- data T a b c where { MkT :: forall d e. d -> e -> T d [e] e
--     mkGadtCtxt [a,b,c] [d,e] (T d [e] e)
--   returns 
--     (b~[e], c~e), [d->a] 
-- 
-- This function is fiddly, but not really hard
mkGadtCtxt _ ResTyH98
  = return ([], [])
mkGadtCtxt data_tvs (ResTyGADT res_ty)
  | let (head_ty, tys) = splitHsAppTys res_ty []
  , Just _ <- is_hs_tyvar head_ty
  , data_tvs `equalLength` tys
  = return (go [] [] (data_tvs `zip` tys))

  | otherwise 
  = failWithDs (ptext (sLit "Malformed constructor result type") <+> ppr res_ty)
  where
    go cxt subst [] = (cxt, subst)
    go cxt subst ((data_tv, ty) : rest)
       | Just con_tv <- is_hs_tyvar ty
       , isTyVarName con_tv
       , not (in_subst con_tv subst)
       = go cxt ((con_tv, data_tv) : subst) rest
       | otherwise
       = go (eq_pred : cxt) subst rest
       where
         loc = getLoc ty
batterseapower's avatar
batterseapower committed
425
         eq_pred = L loc (HsEqTy (L loc (HsTyVar data_tv)) ty)
426 427 428 429 430 431

    is_hs_tyvar (L _ (HsTyVar n))  = Just n   -- Type variables *and* tycons
    is_hs_tyvar (L _ (HsParTy ty)) = is_hs_tyvar ty
    is_hs_tyvar _                  = Nothing

    
432
repBangTy :: LBangType Name -> DsM (Core (TH.StrictTypeQ))
433 434 435
repBangTy ty= do 
  MkC s <- rep2 str []
  MkC t <- repLTy ty'
436
  rep2 strictTypeName [s, t]
437 438
  where 
    (str, ty') = case ty of
439 440 441
		   L _ (HsBangTy HsUnpack ty) -> (unpackedName,  ty)
		   L _ (HsBangTy _ ty)        -> (isStrictName,  ty)
		   _                          -> (notStrictName, ty)
442 443 444 445 446

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

447
repDerivs :: Maybe [LHsType Name] -> DsM (Core [TH.Name])
448
repDerivs Nothing = coreList nameTyConName []
449
repDerivs (Just ctxt)
450
  = do { strs <- mapM rep_deriv ctxt ; 
451
	 coreList nameTyConName strs }
452
  where
453
    rep_deriv :: LHsType Name -> DsM (Core TH.Name)
454
	-- Deriving clauses must have the simple H98 form
batterseapower's avatar
batterseapower committed
455 456 457 458 459
    rep_deriv ty
      | Just (cls, []) <- splitHsClassTy_maybe (unLoc ty)
      = lookupOcc cls
      | otherwise
      = notHandled "Non-H98 deriving clause" (ppr ty)
460 461 462 463 464 465


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

466
rep_sigs :: [LSig Name] -> DsM [Core TH.DecQ]
467 468 469
rep_sigs sigs = do locs_cores <- rep_sigs' sigs
                   return $ de_loc $ sort_by_loc locs_cores

470
rep_sigs' :: [LSig Name] -> DsM [(SrcSpan, Core TH.DecQ)]
471
	-- We silently ignore ones we don't recognise
472
rep_sigs' sigs = do { sigs1 <- mapM rep_sig sigs ;
473 474
		     return (concat sigs1) }

475
rep_sig :: LSig Name -> DsM [(SrcSpan, Core TH.DecQ)]
476 477
	-- Singleton => Ok
	-- Empty     => Too hard, signature ignored
478
rep_sig (L loc (TypeSig nms ty))      = rep_proto nms ty loc
dreixel's avatar
dreixel committed
479 480 481 482
rep_sig (L _   (GenericSig nm _))     = failWithDs msg
  where msg = vcat  [ ptext (sLit "Illegal default signature for") <+> quotes (ppr nm)
                    , ptext (sLit "Default signatures are not supported by Template Haskell") ]

483 484 485 486
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 []

487
rep_proto :: [Located Name] -> LHsType Name -> SrcSpan
488
          -> DsM [(SrcSpan, Core TH.DecQ)]
489 490 491 492 493 494 495 496
rep_proto nms ty loc
  = mapM f nms
  where
    f nm = do { nm1 <- lookupLOcc nm
              ; ty1 <- repLTy ty
              ; sig <- repProto nm1 ty1
              ; return (loc, sig)
              }
497

498 499 500
rep_inline :: Located Name 
           -> InlinePragma	-- Never defaultInlinePragma
           -> SrcSpan 
501 502 503
           -> DsM [(SrcSpan, Core TH.DecQ)]
rep_inline nm ispec loc
  = do { nm1 <- lookupLOcc nm
504
       ; ispec1 <- rep_InlinePrag ispec
505 506 507 508
       ; pragma <- repPragInl nm1 ispec1
       ; return [(loc, pragma)]
       }

509
rep_specialise :: Located Name -> LHsType Name -> InlinePragma -> SrcSpan 
510 511 512 513
               -> DsM [(SrcSpan, Core TH.DecQ)]
rep_specialise nm ty ispec loc
  = do { nm1 <- lookupLOcc nm
       ; ty1 <- repLTy ty
514 515 516 517
       ; pragma <- if isDefaultInlinePragma ispec
                   then repPragSpec nm1 ty1                  -- SPECIALISE
                   else do { ispec1 <- rep_InlinePrag ispec  -- SPECIALISE INLINE
                           ; repPragSpecInl nm1 ty1 ispec1 } 
518 519
       ; return [(loc, pragma)]
       }
520

521
-- Extract all the information needed to build a TH.InlinePrag
522
--
523 524 525
rep_InlinePrag :: InlinePragma	-- Never defaultInlinePragma
               -> DsM (Core TH.InlineSpecQ)
rep_InlinePrag (InlinePragma { inl_act = activation, inl_rule = match, inl_inline = inline })
526
  | Just (flag, phase) <- activation1 
527 528 529 530
  = repInlineSpecPhase inline1 match1 flag phase
  | otherwise
  = repInlineSpecNoPhase inline1 match1
  where
531 532
      match1      = coreBool (rep_RuleMatchInfo match)
      activation1 = rep_Activation activation
533 534 535 536
      inline1     = case inline of 
                       Inline -> coreBool True
 		       _other -> coreBool False
		       -- We have no representation for Inlinable
537 538 539 540

      rep_RuleMatchInfo FunLike = False
      rep_RuleMatchInfo ConLike = True

541 542
      rep_Activation NeverActive          = Nothing	-- We never have NOINLINE/AlwaysActive
      rep_Activation AlwaysActive         = Nothing	-- or            INLINE/NeverActive
543 544 545 546
      rep_Activation (ActiveBefore phase) = Just (coreBool False, 
                                                  MkC $ mkIntExprInt phase)
      rep_Activation (ActiveAfter phase)  = Just (coreBool True, 
                                                  MkC $ mkIntExprInt phase)
547 548 549 550 551


-------------------------------------------------------
-- 			Types
-------------------------------------------------------
552

553 554 555 556 557
-- 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 = 
558 559
         [LHsTyVarBndr Name]	                       -- the binders to be added
      -> ([Core TH.TyVarBndr] -> DsM (Core (TH.Q a)))  -- action in the ext env
560 561
      -> DsM (Core (TH.Q a))

chak's avatar
chak committed
562 563
-- 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
564
-- meta environment and gets the *new* names on Core-level as an argument
chak's avatar
chak committed
565
--
566
addTyVarBinds :: ProcessTyVarBinds a
567 568 569 570 571 572 573 574
addTyVarBinds tvs m
  = do { freshNames <- mkGenSyms (hsLTyVarNames tvs)
       ; term <- addBinds freshNames $ 
	    	 do { kindedBndrs <- mapM mk_tv_bndr (tvs `zip` freshNames)
	    	    ; m kindedBndrs }
       ; wrapGenSyms freshNames term }
  where
    mk_tv_bndr (tv, (_,v)) = repTyVarBndrWithKind tv (coreVar v)
chak's avatar
chak committed
575

576 577 578 579 580 581
-- 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
582 583 584 585 586 587 588 589 590 591
    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)
592 593 594 595
repTyVarBndrWithKind (L _ (UserTyVar {})) nm
  = repPlainTV nm
repTyVarBndrWithKind (L _ (KindedTyVar _ ki)) nm
  = repKind ki >>= repKindedTV nm
596

chak's avatar
chak committed
597 598
-- represent a type context
--
599 600 601
repLContext :: LHsContext Name -> DsM (Core TH.CxtQ)
repLContext (L _ ctxt) = repContext ctxt

602
repContext :: HsContext Name -> DsM (Core TH.CxtQ)
chak's avatar
chak committed
603
repContext ctxt = do 
604
	            preds    <- mapM repLPred ctxt
605
		    predList <- coreList predQTyConName preds
chak's avatar
chak committed
606
		    repCtxt predList
607

chak's avatar
chak committed
608 609
-- represent a type predicate
--
batterseapower's avatar
batterseapower committed
610
repLPred :: LHsType Name -> DsM (Core TH.PredQ)
611 612
repLPred (L _ p) = repPred p

batterseapower's avatar
batterseapower committed
613 614 615
repPred :: HsType Name -> DsM (Core TH.PredQ)
repPred ty
  | Just (cls, tys) <- splitHsClassTy_maybe ty
616 617 618 619 620
  = do
      cls1 <- lookupOcc cls
      tys1 <- repLTys tys
      tys2 <- coreList typeQTyConName tys1
      repClassP cls1 tys2
batterseapower's avatar
batterseapower committed
621
repPred (HsEqTy tyleft tyright) 
622 623 624 625
  = do
      tyleft1  <- repLTy tyleft
      tyright1 <- repLTy tyright
      repEqualP tyleft1 tyright1
batterseapower's avatar
batterseapower committed
626 627
repPred ty
  = notHandled "Exotic predicate type" (ppr ty)
628

chak's avatar
chak committed
629 630
-- yield the representation of a list of types
--
631 632
repLTys :: [LHsType Name] -> DsM [Core TH.TypeQ]
repLTys tys = mapM repLTy tys
633

chak's avatar
chak committed
634 635
-- represent a type
--
636 637 638
repLTy :: LHsType Name -> DsM (Core TH.TypeQ)
repLTy (L _ ty) = repTy ty

639 640 641
repTy :: HsType Name -> DsM (Core TH.TypeQ)
repTy (HsForAllTy _ tvs ctxt ty)  = 
  addTyVarBinds tvs $ \bndrs -> do
642 643
    ctxt1  <- repLContext ctxt
    ty1    <- repLTy ty
644
    bndrs1 <- coreList tyVarBndrTyConName bndrs
645
    repTForall bndrs1 ctxt1 ty1
646

647
repTy (HsTyVar n)
648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670
  | 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
batterseapower's avatar
batterseapower committed
671 672
repTy (HsTupleTy (HsBoxyTuple kind) tys)
  | kind `eqKind` liftedTypeKind = do
673 674 675
			        tys1 <- repLTys tys 
			        tcon <- repTupleTyCon (length tys)
			        repTapps tcon tys1
batterseapower's avatar
batterseapower committed
676
repTy (HsTupleTy HsUnboxedTuple tys) = do
677 678 679
			        tys1 <- repLTys tys
			        tcon <- repUnboxedTupleTyCon (length tys)
			        repTapps tcon tys1
680 681 682 683 684 685 686
repTy (HsOpTy ty1 n ty2)    = repLTy ((nlHsTyVar (unLoc n) `nlHsAppTy` ty1) 
			    	   `nlHsAppTy` ty2)
repTy (HsParTy t)  	    = repLTy t
repTy (HsKindSig t k)       = do
                                t1 <- repLTy t
                                k1 <- repKind k
                                repTSig t1 k1
687 688
repTy (HsSpliceTy splice _ _) = repSplice splice
repTy ty		      = notHandled "Exotic form of type" (ppr ty)
689

690 691 692 693 694 695 696
-- 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'
697
       ; foldrM repArrowK ki'_rep kis_rep
698 699 700 701 702
       }
  where
    repNonArrowKind k | isLiftedTypeKind k = repStarK
                      | otherwise          = notHandled "Exotic form of kind" 
                                                        (ppr k)
703

704 705 706 707 708 709 710 711 712 713 714 715 716 717 718
-----------------------------------------------------------------------------
-- 		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
719
-----------------------------------------------------------------------------
720
-- 		Expressions
chak's avatar
chak committed
721
-----------------------------------------------------------------------------
722

723 724 725
repLEs :: [LHsExpr Name] -> DsM (Core [TH.ExpQ])
repLEs es = do { es'  <- mapM repLE es ;
		 coreList expQTyConName es' }
726

chak's avatar
chak committed
727 728 729
-- 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
730
repLE :: LHsExpr Name -> DsM (Core TH.ExpQ)
731
repLE (L loc e) = putSrcSpanDs loc (repE e)
732

733
repE :: HsExpr Name -> DsM (Core TH.ExpQ)
chak's avatar
chak committed
734 735 736
repE (HsVar x)            =
  do { mb_val <- dsLookupMetaEnv x 
     ; case mb_val of
chak's avatar
chak committed
737
	Nothing	         -> do { str <- globalVar x
chak's avatar
chak committed
738 739 740 741
			       ; 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
742
repE e@(HsIPVar _) = notHandled "Implicit parameters" (ppr e)
743 744 745 746 747

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

Ian Lynagh's avatar
Ian Lynagh committed
751
repE (OpApp e1 op _ e2) =
752 753 754
  do { arg1 <- repLE e1; 
       arg2 <- repLE e2; 
       the_op <- repLE op ;
755
       repInfixApp arg1 the_op arg2 } 
Ian Lynagh's avatar
Ian Lynagh committed
756
repE (NegApp x _)        = do
757
			      a         <- repLE x
chak's avatar
chak committed
758 759
			      negateVar <- lookupOcc negateName >>= repVar
			      negateVar `repApp` a
760 761 762
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 } 
763 764 765
repE (HsCase e (MatchGroup ms _)) = do { arg <- repLE e
				       ; ms2 <- mapM repMatchTup ms
				       ; repCaseE arg (nonEmptyCoreList ms2) }
766
repE (HsIf _ x y z)         = do
767 768 769
			      a <- repLE x
			      b <- repLE y
			      c <- repLE z
chak's avatar
chak committed
770 771
			      repCond a b c
repE (HsLet bs e)         = do { (ss,ds) <- repBinds bs
772
			       ; e2 <- addBinds ss (repLE e)
chak's avatar
chak committed
773
			       ; z <- repLetE ds e2
774
			       ; wrapGenSyms ss z }
775

chak's avatar
chak committed
776
-- FIXME: I haven't got the types here right yet
777
repE e@(HsDo ctxt sts _) 
778
 | case ctxt of { DoExpr -> True; GhciStmt -> True; _ -> False }
779
 = do { (ss,zs) <- repLSts sts; 
780
        e'      <- repDoE (nonEmptyCoreList zs);
781
        wrapGenSyms ss e' }
782 783

 | ListComp <- ctxt
784
 = do { (ss,zs) <- repLSts sts; 
785
        e'      <- repComp (nonEmptyCoreList zs);
786
        wrapGenSyms ss e' }
787 788

  | otherwise
789
  = notHandled "mdo, monad comprehension and [: :]" (ppr e)
790

Ian Lynagh's avatar
Ian Lynagh committed
791 792
repE (ExplicitList _ es) = do { xs <- repLEs es; repListExp xs }
repE e@(ExplicitPArr _ _) = notHandled "Parallel arrays" (ppr e)
793
repE e@(ExplicitTuple es boxed) 
794
  | not (all tupArgPresent es) = notHandled "Tuple sections" (ppr e)
795 796
  | isBoxed boxed              = do { xs <- repLEs [e | Present e <- es]; repTup xs }
  | otherwise                  = do { xs <- repLEs [e | Present e <- es]; repUnboxedTup xs }
797

798
repE (RecordCon c _ flds)
799
 = do { x <- lookupLOcc c;
800 801
        fs <- repFields flds;
        repRecCon x fs }
802
repE (RecordUpd e flds _ _ _)
803
 = do { x <- repLE e;
804 805
        fs <- repFields flds;
        repRecUpd x fs }
806

807
repE (ExprWithTySig e ty) = do { e1 <- repLE e; t1 <- repLTy ty; repSigExp e1 t1 }
808
repE (ArithSeq _ aseq) =
chak's avatar
chak committed
809
  case aseq of
810
    From e              -> do { ds1 <- repLE e; repFrom ds1 }
chak's avatar
chak committed
811
    FromThen e1 e2      -> do 
812 813
		             ds1 <- repLE e1
			     ds2 <- repLE e2
chak's avatar
chak committed
814 815
			     repFromThen ds1 ds2
    FromTo   e1 e2      -> do 
816 817
			     ds1 <- repLE e1
			     ds2 <- repLE e2
chak's avatar
chak committed
818 819
			     repFromTo ds1 ds2
    FromThenTo e1 e2 e3 -> do 
820 821 822
			     ds1 <- repLE e1
			     ds2 <- repLE e2
			     ds3 <- repLE e3
chak's avatar
chak committed
823
			     repFromThenTo ds1 ds2 ds3
824

825
repE (HsSpliceE splice)  = repSplice splice
826 827 828
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
829
repE e@(HsTickPragma {}) = notHandled "Tick Pragma" (ppr e)
830 831
repE e@(HsBracketOut {}) = notHandled "TH brackets" (ppr e)
repE e 			 = notHandled "Expression form" (ppr e)
832 833 834 835

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

836
repMatchTup ::  LMatch Name -> DsM (Core TH.MatchQ) 
Ian Lynagh's avatar
Ian Lynagh committed
837
repMatchTup (L _ (Match [p] _ (GRHSs guards wheres))) =
838
  do { ss1 <- mkGenSyms (collectPatBinders p) 
839
     ; addBinds ss1 $ do {
840
     ; p1 <- repLP p
841
     ; (ss2,ds) <- repBinds wheres
842 843 844
     ; addBinds ss2 $ do {
     ; gs    <- repGuards guards
     ; match <- repMatch p1 gs ds
845
     ; wrapGenSyms (ss1++ss2) match }}}
Ian Lynagh's avatar
Ian Lynagh committed
846
repMatchTup _ = panic "repMatchTup: case alt with more than one arg"
847

848
repClauseTup ::  LMatch Name -> DsM (Core TH.ClauseQ)
Ian Lynagh's avatar
Ian Lynagh committed
849
repClauseTup (L _ (Match ps _ (GRHSs guards wheres))) =
850
  do { ss1 <- mkGenSyms (collectPatsBinders ps) 
851
     ; addBinds ss1 $ do {
852
       ps1 <- repLPs ps
853
     ; (ss2,ds) <- repBinds wheres
854 855 856
     ; addBinds ss2 $ do {
       gs <- repGuards guards
     ; clause <- repClause ps1 gs ds
857
     ; wrapGenSyms (ss1++ss2) clause }}}
858

859
repGuards ::  [LGRHS Name] ->  DsM (Core TH.BodyQ)
860
repGuards [L _ (GRHS [] e)]
861
  = do {a <- repLE e; repNormal a }
862
repGuards other 
863 864 865
  = do { zs <- mapM process other;
     let {(xs, ys) = unzip zs};
	 gd <- repGuarded (nonEmptyCoreList ys);
866
     wrapGenSyms (concat xs) gd }
867
  where 
868
    process :: LGRHS Name -> DsM ([GenSymBind], (Core (TH.Q (TH.Guard, TH.Exp))))
869
    process (L _ (GRHS [L _ (ExprStmt e1 _ _ _)] e2))
870 871
           = do { x <- repLNormalGE e1 e2;
                  return ([], x) }
872
    process (L _ (GRHS ss rhs))
873
           = do (gs, ss') <- repLSts ss
874
		rhs' <- addBinds gs $ repLE rhs
875
                g <- repPatGE (nonEmptyCoreList ss') rhs'
876
                return (gs, g)
877

878 879
repFields :: HsRecordBinds Name -> DsM (Core [TH.Q TH.FieldExp])
repFields (HsRecFields { rec_flds = flds })
880 881 882 883
  = do	{ fnames <- mapM lookupLOcc (map hsRecFieldId flds)
	; es <- mapM repLE (map hsRecFieldArg flds)
	; fs <- zipWithM repFieldExp fnames es
	; coreList fieldExpQTyConName fs }
884

885 886 887

-----------------------------------------------------------------------------
-- Representing Stmt's is tricky, especially if bound variables
888
-- shadow each other. Consider:  [| do { x <- f 1; x <- f x; g x } |]
889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910
-- 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.

911 912 913
repLSts :: [LStmt Name] -> DsM ([GenSymBind], [Core TH.StmtQ])
repLSts stmts = repSts (map unLoc stmts)

914
repSts :: [Stmt Name] -> DsM ([GenSymBind], [Core TH.StmtQ])
915
repSts (BindStmt p e _ _ : ss) =
916
   do { e2 <- repLE e 
917
      ; ss1 <- mkGenSyms (collectPatBinders p) 
918
      ; addBinds ss1 $ do {
919
      ; p1 <- repLP p; 
920 921 922 923
      ; (ss2,zs) <- repSts ss
      ; z <- repBindSt p1 e2
      ; return (ss1++ss2, z : zs) }}
repSts (LetStmt bs : ss) =
924
   do { (ss1,ds) <- repBinds bs
925 926 927
      ; z <- repLetSt ds
      ; (ss2,zs) <- addBinds ss1 (repSts ss)
      ; return (ss1++ss2, z : zs) } 
928
repSts (ExprStmt e _ _ _ : ss) =       
929
   do { e2 <- repLE e
930 931 932
      ; z <- repNoBindSt e2 
      ; (ss2,zs) <- repSts ss
      ; return (ss2, z : zs) }
933 934 935 936
repSts [LastStmt e _] 
  = do { e2 <- repLE e
       ; z <- repNoBindSt e2
       ; return ([], [z]) }
937 938
repSts []    = return ([],[])
repSts other = notHandled "Exotic statement" (ppr other)
939 940


941 942 943
-----------------------------------------------------------
--			Bindings
-----------------------------------------------------------
944

945 946 947 948 949
repBinds :: HsLocalBinds Name -> DsM ([GenSymBind], Core [TH.DecQ]) 
repBinds EmptyLocalBinds
  = do	{ core_list <- coreList decQTyConName []
	; return ([], core_list) }

950
repBinds b@(HsIPBinds _) = notHandled "Implicit parameters" (ppr b)
951 952

repBinds (HsValBinds decs)
953
 = do	{ let { bndrs = collectHsValBinders decs }
954 955 956 957
		-- 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
958
	; ss        <- mkGenSyms bndrs