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

Ian Lynagh's avatar
Ian Lynagh committed
16 17 18 19 20 21 22
{-# OPTIONS -fno-warn-tabs #-}
-- The above warning supression flag is a temporary kludge.
-- While working on this module you are encouraged to remove it and
-- detab the module (please do the detabbing in a separate patch). See
--     http://hackage.haskell.org/trac/ghc/wiki/Commentary/CodingStyle#TabsvsSpaces
-- for details

23 24
module DsMeta( dsBracket, 
	       templateHaskellNames, qTyConName, nameTyConName,
25 26
	       liftName, liftStringName, expQTyConName, patQTyConName, 
               decQTyConName, decsQTyConName, typeQTyConName,
27
	       decTyConName, typeTyConName, mkNameG_dName, mkNameG_vName, mkNameG_tcName,
28
	       quoteExpName, quotePatName, quoteDecName, quoteTypeName
29
	        ) where
30

31 32
#include "HsVersions.h"

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

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

38
import qualified Language.Haskell.TH as TH
39

40
import HsSyn
Simon Marlow's avatar
Simon Marlow committed
41 42 43 44 45 46
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.
47
import qualified OccName( isDataOcc, isVarOcc, isTcOcc, varName, tcName ) 
48

Simon Marlow's avatar
Simon Marlow committed
49 50
import Module
import Id
51
import Name hiding( isVarOcc, isTcOcc, varName, tcName ) 
52
import NameEnv
Simon Marlow's avatar
Simon Marlow committed
53 54 55
import TcType
import TyCon
import TysWiredIn
56
import CoreSyn
57
import MkCore
Simon Marlow's avatar
Simon Marlow committed
58 59 60 61
import CoreUtils
import SrcLoc
import Unique
import BasicTypes
62
import Outputable
Simon Marlow's avatar
Simon Marlow committed
63 64 65
import Bag
import FastString
import ForeignCall
66
import MonadUtils
67
import Util( equalLength )
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 85 86 87 88 89
    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"
90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105

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


106 107 108 109
-------------------------------------------------------
-- 			Declarations
-------------------------------------------------------

110 111 112
repTopP :: LPat Name -> DsM (Core TH.PatQ)
repTopP pat = do { ss <- mkGenSyms (collectPatBinders pat) 
                 ; pat' <- addBinds ss (repLP pat)
113
                 ; wrapGenSyms ss pat' }
114

115
repTopDs :: HsGroup Name -> DsM (Core (TH.Q [TH.Dec]))
116
repTopDs group
117
 = do { let { bndrs = hsGroupBinders group } ;
118
	ss <- mkGenSyms bndrs ;
119

120 121 122 123 124
	-- 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
125
	-- only "T", not "Foo:T" where Foo is the current module
126 127

	
128
	decls <- addBinds ss (do {
129
			val_ds  <- rep_val_binds (hs_valds group) ;
130
			tycl_ds <- mapM repTyClD (concat (hs_tyclds group)) ;
131
			inst_ds <- mapM repInstD' (hs_instds group) ;
132
			for_ds <- mapM repForD (hs_fords group) ;
133
			-- more needed
134
			return (de_loc $ sort_by_loc $ val_ds ++ catMaybes tycl_ds ++ inst_ds ++ for_ds) }) ;
135

136
	decl_ty <- lookupType decQTyConName ;
137
	let { core_list = coreList' decl_ty decls } ;
138 139 140

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

142
	wrapGenSyms ss q_decs
143 144 145
      }


146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163
{- 	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" []] []

164 165
So in repTopDs we bring the binders into scope with mkGenSyms and addBinds.
And we use lookupOcc, rather than lookupBinder
166 167 168 169
in repTyClD and repC.

-}

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

172 173 174
repTyClD tydecl@(L _ (TyFamily {}))
  = repTyFamily tydecl addTyVarBinds

175
repTyClD (L loc (TyData { tcdND = DataType, tcdCtxt = cxt, 
176 177 178 179 180 181 182
		          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
183
              ; cons1    <- mapM (repC (hsLTyVarNames tvs)) cons
184 185
      	      ; cons2    <- coreList conQTyConName cons1
      	      ; derivs1  <- repDerivs mb_derivs
186
	      ; bndrs1   <- coreList tyVarBndrTyConName bndrs
187 188 189 190
      	      ; repData cxt1 tc1 bndrs1 opt_tys2 cons2 derivs1 
              }
       ; return $ Just (loc, dec) 
       }
191

192
repTyClD (L loc (TyData { tcdND = NewType, tcdCtxt = cxt, 
193 194 195 196 197 198 199
		          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
200
              ; con1     <- repC (hsLTyVarNames tvs) con
201
      	      ; derivs1  <- repDerivs mb_derivs
202
	      ; bndrs1   <- coreList tyVarBndrTyConName bndrs
203 204 205 206 207 208 209 210 211 212 213 214
      	      ; 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
215
	      ; bndrs1   <- coreList tyVarBndrTyConName bndrs
216 217 218 219
	      ; repTySyn tc1 bndrs1 opt_tys2 ty1 
              }
       ; return (Just (loc, dec)) 
       }
220

221
repTyClD (L loc (ClassDecl { tcdCtxt = cxt, tcdLName = cls, 
222 223
		             tcdTyVars = tvs, tcdFDs = fds,
		             tcdSigs = sigs, tcdMeths = meth_binds, 
224
                             tcdATs = ats, tcdATDefs = [] }))
225 226 227 228 229 230 231 232
  = 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)
233
	      ; bndrs1 <- coreList tyVarBndrTyConName bndrs
234 235 236 237
 	      ; repClass cxt1 cls1 bndrs1 fds1 decls1 
              }
       ; return $ Just (loc, dec) 
       }
238 239

-- Un-handled cases
240
repTyClD (L loc d) = putSrcSpanDs loc $
241
		     do { warnDs (hang ds_msg 4 (ppr d))
242
			; return Nothing }
243

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

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

283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308
-- 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
309
repInstD' :: LInstDecl Name -> DsM (SrcSpan, Core TH.DecQ)
310
repInstD' (L loc (InstDecl ty binds _ ats))	-- Ignore user pragmas for now
311 312 313 314 315 316 317 318 319 320 321
  = 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
322 323 324
               ; cls_tcon <- repTy (HsTyVar cls)
               ; cls_tys <- repLTys tys
               ; inst_ty1 <- repTapps cls_tcon cls_tys
325 326 327 328 329
               ; binds1 <- rep_binds binds
               ; ats1 <- repLAssocFamInst ats
               ; decls <- coreList decQTyConName (ats1 ++ binds1)
               ; repInst cxt1 inst_ty1 decls }
       ; return (loc, dec) }
330
 where
batterseapower's avatar
batterseapower committed
331
   Just (tvs, cxt, cls, tys) = splitHsInstDeclTy_maybe (unLoc ty)
332

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

repCCallConv :: CCallConv -> DsM (Core TH.Callconv)
repCCallConv CCallConv = rep2 cCallName []
repCCallConv StdCallConv = rep2 stdCallName []
358
repCCallConv callConv    = notHandled "repCCallConv" (ppr callConv)
359 360 361

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

Ian Lynagh's avatar
Ian Lynagh committed
365
ds_msg :: SDoc
Ian Lynagh's avatar
Ian Lynagh committed
366
ds_msg = ptext (sLit "Cannot desugar this Template Haskell declaration:")
367

368 369 370 371
-------------------------------------------------------
-- 			Constructors
-------------------------------------------------------

372 373 374
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 }))
375
  = do { con1 <- lookupLOcc con 	-- See note [Binders and occurrences] 
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 425 426 427 428 429 430 431
       ; 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
432
         eq_pred = L loc (HsEqTy (L loc (HsTyVar data_tv)) ty)
433 434 435 436 437 438

    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

    
439
repBangTy :: LBangType Name -> DsM (Core (TH.StrictTypeQ))
440 441 442
repBangTy ty= do 
  MkC s <- rep2 str []
  MkC t <- repLTy ty'
443
  rep2 strictTypeName [s, t]
444 445
  where 
    (str, ty') = case ty of
446 447 448
		   L _ (HsBangTy HsUnpack ty) -> (unpackedName,  ty)
		   L _ (HsBangTy _ ty)        -> (isStrictName,  ty)
		   _                          -> (notStrictName, ty)
449 450 451 452 453

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

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


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

473
rep_sigs :: [LSig Name] -> DsM [Core TH.DecQ]
474 475 476
rep_sigs sigs = do locs_cores <- rep_sigs' sigs
                   return $ de_loc $ sort_by_loc locs_cores

477
rep_sigs' :: [LSig Name] -> DsM [(SrcSpan, Core TH.DecQ)]
478
	-- We silently ignore ones we don't recognise
479
rep_sigs' sigs = do { sigs1 <- mapM rep_sig sigs ;
480 481
		     return (concat sigs1) }

482
rep_sig :: LSig Name -> DsM [(SrcSpan, Core TH.DecQ)]
483 484
	-- Singleton => Ok
	-- Empty     => Too hard, signature ignored
485
rep_sig (L loc (TypeSig nms ty))      = rep_proto nms ty loc
dreixel's avatar
dreixel committed
486 487 488 489
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") ]

490 491 492 493
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 []

494
rep_proto :: [Located Name] -> LHsType Name -> SrcSpan
495
          -> DsM [(SrcSpan, Core TH.DecQ)]
496 497 498 499 500 501 502 503
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)
              }
504

505 506 507
rep_inline :: Located Name 
           -> InlinePragma	-- Never defaultInlinePragma
           -> SrcSpan 
508 509 510
           -> DsM [(SrcSpan, Core TH.DecQ)]
rep_inline nm ispec loc
  = do { nm1 <- lookupLOcc nm
511
       ; ispec1 <- rep_InlinePrag ispec
512 513 514 515
       ; pragma <- repPragInl nm1 ispec1
       ; return [(loc, pragma)]
       }

516
rep_specialise :: Located Name -> LHsType Name -> InlinePragma -> SrcSpan 
517 518 519 520
               -> DsM [(SrcSpan, Core TH.DecQ)]
rep_specialise nm ty ispec loc
  = do { nm1 <- lookupLOcc nm
       ; ty1 <- repLTy ty
521 522 523 524
       ; pragma <- if isDefaultInlinePragma ispec
                   then repPragSpec nm1 ty1                  -- SPECIALISE
                   else do { ispec1 <- rep_InlinePrag ispec  -- SPECIALISE INLINE
                           ; repPragSpecInl nm1 ty1 ispec1 } 
525 526
       ; return [(loc, pragma)]
       }
527

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

      rep_RuleMatchInfo FunLike = False
      rep_RuleMatchInfo ConLike = True

548 549
      rep_Activation NeverActive          = Nothing	-- We never have NOINLINE/AlwaysActive
      rep_Activation AlwaysActive         = Nothing	-- or            INLINE/NeverActive
550 551 552 553
      rep_Activation (ActiveBefore phase) = Just (coreBool False, 
                                                  MkC $ mkIntExprInt phase)
      rep_Activation (ActiveAfter phase)  = Just (coreBool True, 
                                                  MkC $ mkIntExprInt phase)
554 555 556 557 558


-------------------------------------------------------
-- 			Types
-------------------------------------------------------
559

560 561 562 563 564
-- 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 = 
565 566
         [LHsTyVarBndr Name]	                       -- the binders to be added
      -> ([Core TH.TyVarBndr] -> DsM (Core (TH.Q a)))  -- action in the ext env
567 568
      -> DsM (Core (TH.Q a))

chak's avatar
chak committed
569 570
-- 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
571
-- meta environment and gets the *new* names on Core-level as an argument
chak's avatar
chak committed
572
--
573
addTyVarBinds :: ProcessTyVarBinds a
574 575 576 577 578 579 580 581
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
582

583 584 585 586 587 588
-- 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
589 590 591 592 593 594 595 596 597 598
    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)
599 600 601 602
repTyVarBndrWithKind (L _ (UserTyVar {})) nm
  = repPlainTV nm
repTyVarBndrWithKind (L _ (KindedTyVar _ ki)) nm
  = repKind ki >>= repKindedTV nm
603

chak's avatar
chak committed
604 605
-- represent a type context
--
606 607 608
repLContext :: LHsContext Name -> DsM (Core TH.CxtQ)
repLContext (L _ ctxt) = repContext ctxt

609
repContext :: HsContext Name -> DsM (Core TH.CxtQ)
chak's avatar
chak committed
610
repContext ctxt = do 
611
	            preds    <- mapM repLPred ctxt
612
		    predList <- coreList predQTyConName preds
chak's avatar
chak committed
613
		    repCtxt predList
614

chak's avatar
chak committed
615 616
-- represent a type predicate
--
batterseapower's avatar
batterseapower committed
617
repLPred :: LHsType Name -> DsM (Core TH.PredQ)
618 619
repLPred (L _ p) = repPred p

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

chak's avatar
chak committed
636 637
-- yield the representation of a list of types
--
638 639
repLTys :: [LHsType Name] -> DsM [Core TH.TypeQ]
repLTys tys = mapM repLTy tys
640

chak's avatar
chak committed
641 642
-- represent a type
--
643 644 645
repLTy :: LHsType Name -> DsM (Core TH.TypeQ)
repLTy (L _ ty) = repTy ty

646 647 648
repTy :: HsType Name -> DsM (Core TH.TypeQ)
repTy (HsForAllTy _ tvs ctxt ty)  = 
  addTyVarBinds tvs $ \bndrs -> do
649 650
    ctxt1  <- repLContext ctxt
    ty1    <- repLTy ty
651
    bndrs1 <- coreList tyVarBndrTyConName bndrs
652
    repTForall bndrs1 ctxt1 ty1
653

654
repTy (HsTyVar n)
655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677
  | 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
678 679
repTy (HsTupleTy (HsBoxyTuple kind) tys)
  | kind `eqKind` liftedTypeKind = do
680 681 682
			        tys1 <- repLTys tys 
			        tcon <- repTupleTyCon (length tys)
			        repTapps tcon tys1
batterseapower's avatar
batterseapower committed
683
repTy (HsTupleTy HsUnboxedTuple tys) = do
684 685 686
			        tys1 <- repLTys tys
			        tcon <- repUnboxedTupleTyCon (length tys)
			        repTapps tcon tys1
687 688 689 690 691 692 693
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
694 695
repTy (HsSpliceTy splice _ _) = repSplice splice
repTy ty		      = notHandled "Exotic form of type" (ppr ty)
696

697 698 699 700 701 702 703
-- 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'
704
       ; foldrM repArrowK ki'_rep kis_rep
705 706 707 708 709
       }
  where
    repNonArrowKind k | isLiftedTypeKind k = repStarK
                      | otherwise          = notHandled "Exotic form of kind" 
                                                        (ppr k)
710

711 712 713 714 715 716 717 718 719 720 721 722 723 724 725
-----------------------------------------------------------------------------
-- 		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
726
-----------------------------------------------------------------------------
727
-- 		Expressions
chak's avatar
chak committed
728
-----------------------------------------------------------------------------
729

730 731 732
repLEs :: [LHsExpr Name] -> DsM (Core [TH.ExpQ])
repLEs es = do { es'  <- mapM repLE es ;
		 coreList expQTyConName es' }
733

chak's avatar
chak committed
734 735 736
-- 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
737
repLE :: LHsExpr Name -> DsM (Core TH.ExpQ)
738
repLE (L loc e) = putSrcSpanDs loc (repE e)
739

740
repE :: HsExpr Name -> DsM (Core TH.ExpQ)
chak's avatar
chak committed
741 742 743
repE (HsVar x)            =
  do { mb_val <- dsLookupMetaEnv x 
     ; case mb_val of
chak's avatar
chak committed
744
	Nothing	         -> do { str <- globalVar x
chak's avatar
chak committed
745 746 747 748
			       ; 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
749
repE e@(HsIPVar _) = notHandled "Implicit parameters" (ppr e)
750 751 752 753 754

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

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

chak's avatar
chak committed
783
-- FIXME: I haven't got the types here right yet
784
repE e@(HsDo ctxt sts _) 
785
 | case ctxt of { DoExpr -> True; GhciStmt -> True; _ -> False }
786
 = do { (ss,zs) <- repLSts sts; 
787
        e'      <- repDoE (nonEmptyCoreList zs);
788
        wrapGenSyms ss e' }
789 790

 | ListComp <- ctxt
791
 = do { (ss,zs) <- repLSts sts; 
792
        e'      <- repComp (nonEmptyCoreList zs);
793
        wrapGenSyms ss e' }
794 795

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

Ian Lynagh's avatar
Ian Lynagh committed
798 799
repE (ExplicitList _ es) = do { xs <- repLEs es; repListExp xs }
repE e@(ExplicitPArr _ _) = notHandled "Parallel arrays" (ppr e)
800
repE e@(ExplicitTuple es boxed) 
801
  | not (all tupArgPresent es) = notHandled "Tuple sections" (ppr e)
802 803
  | isBoxed boxed              = do { xs <- repLEs [e | Present e <- es]; repTup xs }
  | otherwise                  = do { xs <- repLEs [e | Present e <- es]; repUnboxedTup xs }
804

805
repE (RecordCon c _ flds)
806
 = do { x <- lookupLOcc c;
807 808
        fs <- repFields flds;
        repRecCon x fs }
809
repE (RecordUpd e flds _ _ _)
810
 = do { x <- repLE e;
811 812
        fs <- repFields flds;
        repRecUpd x fs }
813

814
repE (ExprWithTySig e ty) = do { e1 <- repLE e; t1 <- repLTy ty; repSigExp e1 t1 }
815
repE (ArithSeq _ aseq) =
chak's avatar
chak committed
816
  case aseq of
817
    From e              -> do { ds1 <- repLE e; repFrom ds1 }
chak's avatar
chak committed
818
    FromThen e1 e2      -> do 
819 820
		             ds1 <- repLE e1
			     ds2 <- repLE e2
chak's avatar
chak committed
821 822
			     repFromThen ds1 ds2
    FromTo   e1 e2      -> do 
823 824
			     ds1 <- repLE e1
			     ds2 <- repLE e2
chak's avatar
chak committed
825 826
			     repFromTo ds1 ds2
    FromThenTo e1 e2 e3 -> do 
827 828 829
			     ds1 <- repLE e1
			     ds2 <- repLE e2
			     ds3 <- repLE e3
chak's avatar
chak committed
830
			     repFromThenTo ds1 ds2 ds3
831

832
repE (HsSpliceE splice)  = repSplice splice
833 834 835
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
836
repE e@(HsTickPragma {}) = notHandled "Tick Pragma" (ppr e)
837 838
repE e@(HsBracketOut {}) = notHandled "TH brackets" (ppr e)
repE e 			 = notHandled "Expression form" (ppr e)
839 840 841 842

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

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

855
repClauseTup ::  LMatch Name -> DsM (Core TH.ClauseQ)
Ian Lynagh's avatar
Ian Lynagh committed
856
repClauseTup (L _ (Match ps _ (GRHSs guards wheres))) =
857
  do { ss1 <- mkGenSyms (collectPatsBinders ps) 
858
     ; addBinds ss1 $ do {
859
       ps1 <- repLPs ps
860
     ; (ss2,ds) <- repBinds wheres
861 862 863
     ; addBinds ss2 $ do {
       gs <- repGuards guards
     ; clause <- repClause ps1 gs ds
864
     ; wrapGenSyms (ss1++ss2) clause }}}
865

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

885 886
repFields :: HsRecordBinds Name -> DsM (Core [TH.Q TH.FieldExp])
repFields (HsRecFields { rec_flds = flds })
887 888 889 890
  = do	{ fnames <- mapM lookupLOcc (map hsRecFieldId flds)
	; es <- mapM repLE (map hsRecFieldArg flds)
	; fs <- zipWithM repFieldExp fnames es
	; coreList fieldExpQTyConName fs }
891

892 893 894

-----------------------------------------------------------------------------
-- Representing Stmt's is tricky, especially if bound variables
895
-- shadow each other. Consider:  [| do { x <- f 1; x <- f x; g x } |]
896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917
-- 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.

918 919 920
repLSts :: [LStmt Name] -> DsM ([GenSymBind], [Core TH.StmtQ])
repLSts stmts = repSts (map unLoc stmts)

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


948 949 950
-----------------------------------------------------------
--			Bindings
-----------------------------------------------------------
951

952 953 954 955 956
repBinds :: HsLocalBinds Name -> DsM ([GenSymBind], Core [TH.DecQ]) 
repBinds EmptyLocalBinds
  = do	{ core_list <- coreList decQTyConName []
	; return ([], core_list) }

957
repBinds b@(HsIPBinds _) = notHandled "Implicit parameters" (ppr b)
958 959

repBinds (HsValBinds decs)
960
 = do	{ let { bndrs = collectHsValBinders decs }