Merge branch 'master' of http://darcs.haskell.org/ghc
[ghc.git] / compiler / typecheck / TcHsSyn.lhs
1 1%
2 % (c) The University of Glasgow 2006
3 % (c) The AQUA Project, Glasgow University, 1996-1998
4 %
5
6 TcHsSyn: Specialisations of the @HsSyn@ syntax for the typechecker
7
8 This module is an extension of @HsSyn@ syntax, for use in the type
9 checker.
10
11 \begin{code}
12 module TcHsSyn (
13         mkHsConApp, mkHsDictLet, mkHsApp,
14         hsLitType, hsLPatType, hsPatType, 
15         mkHsAppTy, mkSimpleHsAlt,
16         nlHsIntLit, 
17         shortCutLit, hsOverLitName,
18         
19         -- re-exported from TcMonad
20         TcId, TcIdSet, 
21
22         zonkTopDecls, zonkTopExpr, zonkTopLExpr,
23         zonkId, zonkTopBndrs
24   ) where
25
26 #include "HsVersions.h"
27
28 -- friends:
29 import HsSyn    -- oodles of it
30
31 -- others:
32 import Id
33
34 import TcRnMonad
35 import PrelNames
36 import TcType
37 import TcMType
38 import Coercion
39 import TysPrim
40 import TysWiredIn
41 import DataCon
42 import Name
43 import NameSet
44 import Var
45 import VarSet
46 import VarEnv
47 import DynFlags
48 import Literal
49 import BasicTypes
50 import Maybes
51 import SrcLoc
52 import Bag
53 import FastString
54 import Outputable
55 -- import Data.Traversable( traverse )
56 \end{code}
57
58 \begin{code}
59 -- XXX
60 thenM :: Monad a => a b -> (b -> a c) -> a c
61 thenM = (>>=)
62
63 returnM :: Monad m => a -> m a
64 returnM = return
65
66 mappM :: (Monad m) => (a -> m b) -> [a] -> m [b]
67 mappM = mapM
68 \end{code}
69
70
71 %************************************************************************
72 %*                                                                      *
73 \subsection[mkFailurePair]{Code for pattern-matching and other failures}
74 %*                                                                      *
75 %************************************************************************
76
77 Note: If @hsLPatType@ doesn't bear a strong resemblance to @exprType@,
78 then something is wrong.
79 \begin{code}
80 hsLPatType :: OutPat Id -> Type
81 hsLPatType (L _ pat) = hsPatType pat
82
83 hsPatType :: Pat Id -> Type
84 hsPatType (ParPat pat)                = hsLPatType pat
85 hsPatType (WildPat ty)                = ty
86 hsPatType (VarPat var)                = idType var
87 hsPatType (BangPat pat)               = hsLPatType pat
88 hsPatType (LazyPat pat)               = hsLPatType pat
89 hsPatType (LitPat lit)                = hsLitType lit
90 hsPatType (AsPat var _)               = idType (unLoc var)
91 hsPatType (ViewPat _ _ ty)            = ty
92 hsPatType (ListPat _ ty)              = mkListTy ty
93 hsPatType (PArrPat _ ty)              = mkPArrTy ty
94 hsPatType (TuplePat _ _ ty)           = ty
95 hsPatType (ConPatOut { pat_ty = ty }) = ty
96 hsPatType (SigPatOut _ ty)            = ty
97 hsPatType (NPat lit _ _)              = overLitType lit
98 hsPatType (NPlusKPat id _ _ _)        = idType (unLoc id)
99 hsPatType (CoPat _ _ ty)              = ty
100 hsPatType p                           = pprPanic "hsPatType" (ppr p)
101
102 hsLitType :: HsLit -> TcType
103 hsLitType (HsChar _)       = charTy
104 hsLitType (HsCharPrim _)   = charPrimTy
105 hsLitType (HsString _)     = stringTy
106 hsLitType (HsStringPrim _) = addrPrimTy
107 hsLitType (HsInt _)        = intTy
108 hsLitType (HsIntPrim _)    = intPrimTy
109 hsLitType (HsWordPrim _)   = wordPrimTy
110 hsLitType (HsInt64Prim _)  = int64PrimTy
111 hsLitType (HsWord64Prim _) = word64PrimTy
112 hsLitType (HsInteger _ ty) = ty
113 hsLitType (HsRat _ ty)     = ty
114 hsLitType (HsFloatPrim _)  = floatPrimTy
115 hsLitType (HsDoublePrim _) = doublePrimTy
116 \end{code}
117
118 Overloaded literals. Here mainly becuase it uses isIntTy etc
119
120 \begin{code}
121 shortCutLit :: OverLitVal -> TcType -> Maybe (HsExpr TcId)
122 shortCutLit (HsIntegral i) ty
123   | isIntTy ty && inIntRange i   = Just (HsLit (HsInt i))
124   | isWordTy ty && inWordRange i = Just (mkLit wordDataCon (HsWordPrim i))
125   | isIntegerTy ty               = Just (HsLit (HsInteger i ty))
126   | otherwise                    = shortCutLit (HsFractional (integralFractionalLit i)) ty
127         -- The 'otherwise' case is important
128         -- Consider (3 :: Float).  Syntactically it looks like an IntLit,
129         -- so we'll call shortCutIntLit, but of course it's a float
130         -- This can make a big difference for programs with a lot of
131         -- literals, compiled without -O
132
133 shortCutLit (HsFractional f) ty
134   | isFloatTy ty  = Just (mkLit floatDataCon  (HsFloatPrim f))
135   | isDoubleTy ty = Just (mkLit doubleDataCon (HsDoublePrim f))
136   | otherwise     = Nothing
137
138 shortCutLit (HsIsString s) ty
139   | isStringTy ty = Just (HsLit (HsString s))
140   | otherwise     = Nothing
141
142 mkLit :: DataCon -> HsLit -> HsExpr Id
143 mkLit con lit = HsApp (nlHsVar (dataConWrapId con)) (nlHsLit lit)
144
145 ------------------------------
146 hsOverLitName :: OverLitVal -> Name
147 -- Get the canonical 'fromX' name for a particular OverLitVal
148 hsOverLitName (HsIntegral {})   = fromIntegerName
149 hsOverLitName (HsFractional {}) = fromRationalName
150 hsOverLitName (HsIsString {})   = fromStringName
151 \end{code}
152
153 %************************************************************************
154 %*                                                                      *
155 \subsection[BackSubst-HsBinds]{Running a substitution over @HsBinds@}
156 %*                                                                      *
157 %************************************************************************
158
159 \begin{code}
160 -- zonkId is used *during* typechecking just to zonk the Id's type
161 zonkId :: TcId -> TcM TcId
162 zonkId id
163   = zonkTcType (idType id) `thenM` \ ty' ->
164     returnM (Id.setIdType id ty')
165 \end{code}
166
167 The rest of the zonking is done *after* typechecking.
168 The main zonking pass runs over the bindings
169
170  a) to convert TcTyVars to TyVars etc, dereferencing any bindings etc
171  b) convert unbound TcTyVar to Void
172  c) convert each TcId to an Id by zonking its type
173
174 The type variables are converted by binding mutable tyvars to immutable ones
175 and then zonking as normal.
176
177 The Ids are converted by binding them in the normal Tc envt; that
178 way we maintain sharing; eg an Id is zonked at its binding site and they
179 all occurrences of that Id point to the common zonked copy
180
181 It's all pretty boring stuff, because HsSyn is such a large type, and 
182 the environment manipulation is tiresome.
183
184 \begin{code}
185 data ZonkEnv = ZonkEnv  (TcType -> TcM Type)    -- How to zonk a type
186                         (VarEnv Var)            -- What variables are in scope
187         -- Maps an Id or EvVar to its zonked version; both have the same Name
188         -- Note that all evidence (coercion variables as well as dictionaries)
189         --      are kept in the ZonkEnv
190         -- Only *type* abstraction is done by side effect
191         -- Is only consulted lazily; hence knot-tying
192
193 emptyZonkEnv :: ZonkEnv
194 emptyZonkEnv = ZonkEnv zonkTypeZapping emptyVarEnv
195
196 extendZonkEnv :: ZonkEnv -> [Var] -> ZonkEnv
197 extendZonkEnv (ZonkEnv zonk_ty env) ids 
198   = ZonkEnv zonk_ty (extendVarEnvList env [(id,id) | id <- ids])
199
200 extendZonkEnv1 :: ZonkEnv -> Var -> ZonkEnv
201 extendZonkEnv1 (ZonkEnv zonk_ty env) id 
202   = ZonkEnv zonk_ty (extendVarEnv env id id)
203
204 setZonkType :: ZonkEnv -> (TcType -> TcM Type) -> ZonkEnv
205 setZonkType (ZonkEnv _ env) zonk_ty = ZonkEnv zonk_ty env
206
207 zonkEnvIds :: ZonkEnv -> [Id]
208 zonkEnvIds (ZonkEnv _ env) = varEnvElts env
209
210 zonkIdOcc :: ZonkEnv -> TcId -> Id
211 -- Ids defined in this module should be in the envt; 
212 -- ignore others.  (Actually, data constructors are also
213 -- not LocalVars, even when locally defined, but that is fine.)
214 -- (Also foreign-imported things aren't currently in the ZonkEnv;
215 --  that's ok because they don't need zonking.)
216 --
217 -- Actually, Template Haskell works in 'chunks' of declarations, and
218 -- an earlier chunk won't be in the 'env' that the zonking phase 
219 -- carries around.  Instead it'll be in the tcg_gbl_env, already fully
220 -- zonked.  There's no point in looking it up there (except for error 
221 -- checking), and it's not conveniently to hand; hence the simple
222 -- 'orElse' case in the LocalVar branch.
223 --
224 -- Even without template splices, in module Main, the checking of
225 -- 'main' is done as a separate chunk.
226 zonkIdOcc (ZonkEnv _zonk_ty env) id 
227   | isLocalVar id = lookupVarEnv env id `orElse` id
228   | otherwise     = id
229
230 zonkIdOccs :: ZonkEnv -> [TcId] -> [Id]
231 zonkIdOccs env ids = map (zonkIdOcc env) ids
232
233 -- zonkIdBndr is used *after* typechecking to get the Id's type
234 -- to its final form.  The TyVarEnv give 
235 zonkIdBndr :: ZonkEnv -> TcId -> TcM Id
236 zonkIdBndr env id
237   = zonkTcTypeToType env (idType id)    `thenM` \ ty' ->
238     returnM (Id.setIdType id ty')
239
240 zonkIdBndrs :: ZonkEnv -> [TcId] -> TcM [Id]
241 zonkIdBndrs env ids = mappM (zonkIdBndr env) ids
242
243 zonkTopBndrs :: [TcId] -> TcM [Id]
244 zonkTopBndrs ids = zonkIdBndrs emptyZonkEnv ids
245
246 zonkEvBndrsX :: ZonkEnv -> [EvVar] -> TcM (ZonkEnv, [Var])
247 zonkEvBndrsX = mapAccumLM zonkEvBndrX 
248
249 zonkEvBndrX :: ZonkEnv -> EvVar -> TcM (ZonkEnv, EvVar)
250 -- Works for dictionaries and coercions
251 zonkEvBndrX env var
252   = do { var' <- zonkEvBndr env var
253        ; return (extendZonkEnv1 env var', var') }
254
255 zonkEvBndr :: ZonkEnv -> EvVar -> TcM EvVar
256 -- Works for dictionaries and coercions
257 -- Does not extend the ZonkEnv
258 zonkEvBndr env var 
259   = do { ty' <- zonkTcTypeToType env (varType var)
260        ; return (setVarType var ty') }
261
262 zonkEvVarOcc :: ZonkEnv -> EvVar -> EvVar
263 zonkEvVarOcc env v = zonkIdOcc env v
264 \end{code}
265
266
267 \begin{code}
268 zonkTopExpr :: HsExpr TcId -> TcM (HsExpr Id)
269 zonkTopExpr e = zonkExpr emptyZonkEnv e
270
271 zonkTopLExpr :: LHsExpr TcId -> TcM (LHsExpr Id)
272 zonkTopLExpr e = zonkLExpr emptyZonkEnv e
273
274 zonkTopDecls :: Bag EvBind 
275              -> LHsBinds TcId -> NameSet
276              -> [LRuleDecl TcId] -> [LVectDecl TcId] -> [LTcSpecPrag] -> [LForeignDecl TcId]
277              -> TcM ([Id], 
278                      Bag EvBind,
279                      Bag (LHsBind  Id),
280                      [LForeignDecl Id],
281                      [LTcSpecPrag],
282                      [LRuleDecl    Id],
283                      [LVectDecl    Id])
284 zonkTopDecls ev_binds binds sig_ns rules vects imp_specs fords
285   = do  { (env1, ev_binds') <- zonkEvBinds emptyZonkEnv ev_binds
286
287          -- Warn about missing signatures
288          -- Do this only when we we have a type to offer
289         ; warn_missing_sigs <- woptM Opt_WarnMissingSigs
290         ; let sig_warn | warn_missing_sigs = topSigWarn sig_ns
291                        | otherwise         = noSigWarn
292
293         ; (env2, binds') <- zonkRecMonoBinds env1 sig_warn binds
294                         -- Top level is implicitly recursive
295         ; rules' <- zonkRules env2 rules
296         ; vects' <- zonkVects env2 vects
297         ; specs' <- zonkLTcSpecPrags env2 imp_specs
298         ; fords' <- zonkForeignExports env2 fords
299         ; return (zonkEnvIds env2, ev_binds', binds', fords', specs', rules', vects') }
300
301 ---------------------------------------------
302 zonkLocalBinds :: ZonkEnv -> HsLocalBinds TcId -> TcM (ZonkEnv, HsLocalBinds Id)
303 zonkLocalBinds env EmptyLocalBinds
304   = return (env, EmptyLocalBinds)
305
306 zonkLocalBinds _ (HsValBinds (ValBindsIn {}))
307   = panic "zonkLocalBinds" -- Not in typechecker output
308
309 zonkLocalBinds env (HsValBinds vb@(ValBindsOut binds sigs))
310   = do  { warn_missing_sigs <- woptM Opt_WarnMissingLocalSigs
311         ; let sig_warn | not warn_missing_sigs = noSigWarn
312                        | otherwise             = localSigWarn sig_ns
313               sig_ns = getTypeSigNames vb
314         ; (env1, new_binds) <- go env sig_warn binds
315         ; return (env1, HsValBinds (ValBindsOut new_binds sigs)) }
316   where
317     go env _ []
318       = return (env, [])
319     go env sig_warn ((r,b):bs) 
320       = do { (env1, b')  <- zonkRecMonoBinds env sig_warn b
321            ; (env2, bs') <- go env1 sig_warn bs
322            ; return (env2, (r,b'):bs') }
323
324 zonkLocalBinds env (HsIPBinds (IPBinds binds dict_binds))
325   = mappM (wrapLocM zonk_ip_bind) binds `thenM` \ new_binds ->
326     let
327         env1 = extendZonkEnv env [ipNameName n | L _ (IPBind n _) <- new_binds]
328     in
329     zonkTcEvBinds env1 dict_binds       `thenM` \ (env2, new_dict_binds) -> 
330     returnM (env2, HsIPBinds (IPBinds new_binds new_dict_binds))
331   where
332     zonk_ip_bind (IPBind n e)
333         = mapIPNameTc (zonkIdBndr env) n        `thenM` \ n' ->
334           zonkLExpr env e                       `thenM` \ e' ->
335           returnM (IPBind n' e')
336
337 ---------------------------------------------
338 zonkRecMonoBinds :: ZonkEnv -> SigWarn -> LHsBinds TcId -> TcM (ZonkEnv, LHsBinds Id)
339 zonkRecMonoBinds env sig_warn binds 
340  = fixM (\ ~(_, new_binds) -> do 
341         { let env1 = extendZonkEnv env (collectHsBindsBinders new_binds)
342         ; binds' <- zonkMonoBinds env1 sig_warn binds
343         ; return (env1, binds') })
344
345 ---------------------------------------------
346 type SigWarn = Bool -> [Id] -> TcM ()   
347      -- Missing-signature warning
348      -- The Bool is True for an AbsBinds, False otherwise
349
350 noSigWarn :: SigWarn
351 noSigWarn _ _ = return ()
352
353 topSigWarn :: NameSet -> SigWarn
354 topSigWarn sig_ns _ ids = mapM_ (topSigWarnId sig_ns) ids
355
356 topSigWarnId :: NameSet -> Id -> TcM ()
357 -- The NameSet is the Ids that *lack* a signature
358 -- We have to do it this way round because there are
359 -- lots of top-level bindings that are generated by GHC
360 -- and that don't have signatures
361 topSigWarnId sig_ns id
362   | idName id `elemNameSet` sig_ns = warnMissingSig msg id
363   | otherwise                      = return ()
364   where
365     msg = ptext (sLit "Top-level binding with no type signature:")
366
367 localSigWarn :: NameSet -> SigWarn
368 localSigWarn sig_ns is_abs_bind ids
369   | not is_abs_bind = return ()
370   | otherwise       = mapM_ (localSigWarnId sig_ns) ids
371
372 localSigWarnId :: NameSet -> Id -> TcM ()
373 -- NameSet are the Ids that *have* type signatures
374 localSigWarnId sig_ns id
375   | not (isSigmaTy (idType id))    = return ()
376   | idName id `elemNameSet` sig_ns = return ()
377   | otherwise                      = warnMissingSig msg id
378   where
379     msg = ptext (sLit "Polymophic local binding with no type signature:")
380
381 warnMissingSig :: SDoc -> Id -> TcM ()
382 warnMissingSig msg id
383   = do  { env0 <- tcInitTidyEnv
384         ; let (env1, tidy_ty) = tidyOpenType env0 (idType id)
385         ; addWarnTcM (env1, mk_msg tidy_ty) }
386   where
387     mk_msg ty = sep [ msg, nest 2 $ pprHsVar (idName id) <+> dcolon <+> ppr ty ]
388
389 ---------------------------------------------
390 zonkMonoBinds :: ZonkEnv -> SigWarn -> LHsBinds TcId -> TcM (LHsBinds Id)
391 zonkMonoBinds env sig_warn binds = mapBagM (wrapLocM (zonk_bind env sig_warn)) binds
392
393 zonk_bind :: ZonkEnv -> SigWarn -> HsBind TcId -> TcM (HsBind Id)
394 zonk_bind env sig_warn bind@(PatBind { pat_lhs = pat, pat_rhs = grhss, pat_rhs_ty = ty})
395   = do  { (_env, new_pat) <- zonkPat env pat            -- Env already extended
396         ; sig_warn False (collectPatBinders new_pat)
397         ; new_grhss <- zonkGRHSs env grhss
398         ; new_ty    <- zonkTcTypeToType env ty
399         ; return (bind { pat_lhs = new_pat, pat_rhs = new_grhss, pat_rhs_ty = new_ty }) }
400
401 zonk_bind env sig_warn (VarBind { var_id = var, var_rhs = expr, var_inline = inl })
402   = do { new_var  <- zonkIdBndr env var
403        ; sig_warn False [new_var]
404        ; new_expr <- zonkLExpr env expr
405        ; return (VarBind { var_id = new_var, var_rhs = new_expr, var_inline = inl }) }
406
407 zonk_bind env sig_warn bind@(FunBind { fun_id = L loc var, fun_matches = ms
408                                      , fun_co_fn = co_fn })
409   = do { new_var <- zonkIdBndr env var
410        ; sig_warn False [new_var]
411        ; (env1, new_co_fn) <- zonkCoFn env co_fn
412        ; new_ms <- zonkMatchGroup env1 ms
413        ; return (bind { fun_id = L loc new_var, fun_matches = new_ms
414                       , fun_co_fn = new_co_fn }) }
415
416 zonk_bind env sig_warn (AbsBinds { abs_tvs = tyvars, abs_ev_vars = evs
417                                  , abs_ev_binds = ev_binds
418                                  , abs_exports = exports
419                                  , abs_binds = val_binds })
420   = ASSERT( all isImmutableTyVar tyvars )
421     do { (env1, new_evs) <- zonkEvBndrsX env evs
422        ; (env2, new_ev_binds) <- zonkTcEvBinds env1 ev_binds
423        ; (new_val_bind, new_exports) <- fixM $ \ ~(new_val_binds, _) ->
424          do { let env3 = extendZonkEnv env2 (collectHsBindsBinders new_val_binds)
425             ; new_val_binds <- zonkMonoBinds env3 noSigWarn val_binds
426             ; new_exports   <- mapM (zonkExport env3) exports
427             ; return (new_val_binds, new_exports) } 
428        ; sig_warn True [b | (_,b,_,_) <- new_exports]
429        ; return (AbsBinds { abs_tvs = tyvars, abs_ev_vars = new_evs, abs_ev_binds = new_ev_binds
430                           , abs_exports = new_exports, abs_binds = new_val_bind }) }
431   where
432     zonkExport env (tyvars, global, local, prags)
433         -- The tyvars are already zonked
434         = zonkIdBndr env global                 `thenM` \ new_global ->
435           zonkSpecPrags env prags               `thenM` \ new_prags -> 
436           returnM (tyvars, new_global, zonkIdOcc env local, new_prags)
437
438 zonkSpecPrags :: ZonkEnv -> TcSpecPrags -> TcM TcSpecPrags
439 zonkSpecPrags _   IsDefaultMethod = return IsDefaultMethod
440 zonkSpecPrags env (SpecPrags ps)  = do { ps' <- zonkLTcSpecPrags env ps
441                                        ; return (SpecPrags ps') }
442
443 zonkLTcSpecPrags :: ZonkEnv -> [LTcSpecPrag] -> TcM [LTcSpecPrag]
444 zonkLTcSpecPrags env ps
445   = mapM zonk_prag ps
446   where
447     zonk_prag (L loc (SpecPrag id co_fn inl))
448         = do { (_, co_fn') <- zonkCoFn env co_fn
449              ; return (L loc (SpecPrag (zonkIdOcc env id) co_fn' inl)) }
450 \end{code}
451
452 %************************************************************************
453 %*                                                                      *
454 \subsection[BackSubst-Match-GRHSs]{Match and GRHSs}
455 %*                                                                      *
456 %************************************************************************
457
458 \begin{code}
459 zonkMatchGroup :: ZonkEnv -> MatchGroup TcId-> TcM (MatchGroup Id)
460 zonkMatchGroup env (MatchGroup ms ty) 
461   = do  { ms' <- mapM (zonkMatch env) ms
462         ; ty' <- zonkTcTypeToType env ty
463         ; return (MatchGroup ms' ty') }
464
465 zonkMatch :: ZonkEnv -> LMatch TcId-> TcM (LMatch Id)
466 zonkMatch env (L loc (Match pats _ grhss))
467   = do  { (env1, new_pats) <- zonkPats env pats
468         ; new_grhss <- zonkGRHSs env1 grhss
469         ; return (L loc (Match new_pats Nothing new_grhss)) }
470
471 -------------------------------------------------------------------------
472 zonkGRHSs :: ZonkEnv -> GRHSs TcId -> TcM (GRHSs Id)
473
474 zonkGRHSs env (GRHSs grhss binds)
475   = zonkLocalBinds env binds    `thenM` \ (new_env, new_binds) ->
476     let
477         zonk_grhs (GRHS guarded rhs)
478           = zonkStmts new_env guarded   `thenM` \ (env2, new_guarded) ->
479             zonkLExpr env2 rhs          `thenM` \ new_rhs ->
480             returnM (GRHS new_guarded new_rhs)
481     in
482     mappM (wrapLocM zonk_grhs) grhss    `thenM` \ new_grhss ->
483     returnM (GRHSs new_grhss new_binds)
484 \end{code}
485
486 %************************************************************************
487 %*                                                                      *
488 \subsection[BackSubst-HsExpr]{Running a zonkitution over a TypeCheckedExpr}
489 %*                                                                      *
490 %************************************************************************
491
492 \begin{code}
493 zonkLExprs :: ZonkEnv -> [LHsExpr TcId] -> TcM [LHsExpr Id]
494 zonkLExpr  :: ZonkEnv -> LHsExpr TcId   -> TcM (LHsExpr Id)
495 zonkExpr   :: ZonkEnv -> HsExpr TcId    -> TcM (HsExpr Id)
496
497 zonkLExprs env exprs = mappM (zonkLExpr env) exprs
498 zonkLExpr  env expr  = wrapLocM (zonkExpr env) expr
499
500 zonkExpr env (HsVar id)
501   = returnM (HsVar (zonkIdOcc env id))
502
503 zonkExpr env (HsIPVar id)
504   = returnM (HsIPVar (mapIPName (zonkIdOcc env) id))
505
506 zonkExpr env (HsLit (HsRat f ty))
507   = zonkTcTypeToType env ty        `thenM` \ new_ty  ->
508     returnM (HsLit (HsRat f new_ty))
509
510 zonkExpr _ (HsLit lit)
511   = returnM (HsLit lit)
512
513 zonkExpr env (HsOverLit lit)
514   = do  { lit' <- zonkOverLit env lit
515         ; return (HsOverLit lit') }
516
517 zonkExpr env (HsLam matches)
518   = zonkMatchGroup env matches  `thenM` \ new_matches ->
519     returnM (HsLam new_matches)
520
521 zonkExpr env (HsApp e1 e2)
522   = zonkLExpr env e1    `thenM` \ new_e1 ->
523     zonkLExpr env e2    `thenM` \ new_e2 ->
524     returnM (HsApp new_e1 new_e2)
525
526 zonkExpr env (HsBracketOut body bs) 
527   = mappM zonk_b bs     `thenM` \ bs' ->
528     returnM (HsBracketOut body bs')
529   where
530     zonk_b (n,e) = zonkLExpr env e      `thenM` \ e' ->
531                    returnM (n,e')
532
533 zonkExpr _ (HsSpliceE s) = WARN( True, ppr s ) -- Should not happen
534                              returnM (HsSpliceE s)
535
536 zonkExpr env (OpApp e1 op fixity e2)
537   = zonkLExpr env e1    `thenM` \ new_e1 ->
538     zonkLExpr env op    `thenM` \ new_op ->
539     zonkLExpr env e2    `thenM` \ new_e2 ->
540     returnM (OpApp new_e1 new_op fixity new_e2)
541
542 zonkExpr env (NegApp expr op)
543   = zonkLExpr env expr  `thenM` \ new_expr ->
544     zonkExpr env op     `thenM` \ new_op ->
545     returnM (NegApp new_expr new_op)
546
547 zonkExpr env (HsPar e)    
548   = zonkLExpr env e     `thenM` \new_e ->
549     returnM (HsPar new_e)
550
551 zonkExpr env (SectionL expr op)
552   = zonkLExpr env expr  `thenM` \ new_expr ->
553     zonkLExpr env op            `thenM` \ new_op ->
554     returnM (SectionL new_expr new_op)
555
556 zonkExpr env (SectionR op expr)
557   = zonkLExpr env op            `thenM` \ new_op ->
558     zonkLExpr env expr          `thenM` \ new_expr ->
559     returnM (SectionR new_op new_expr)
560
561 zonkExpr env (ExplicitTuple tup_args boxed)
562   = do { new_tup_args <- mapM zonk_tup_arg tup_args
563        ; return (ExplicitTuple new_tup_args boxed) }
564   where
565     zonk_tup_arg (Present e) = do { e' <- zonkLExpr env e; return (Present e') }
566     zonk_tup_arg (Missing t) = do { t' <- zonkTcTypeToType env t; return (Missing t') }
567
568 zonkExpr env (HsCase expr ms)
569   = zonkLExpr env expr          `thenM` \ new_expr ->
570     zonkMatchGroup env ms       `thenM` \ new_ms ->
571     returnM (HsCase new_expr new_ms)
572
573 zonkExpr env (HsIf e0 e1 e2 e3)
574   = do { new_e0 <- fmapMaybeM (zonkExpr env) e0
575        ; new_e1 <- zonkLExpr env e1
576        ; new_e2 <- zonkLExpr env e2
577        ; new_e3 <- zonkLExpr env e3
578        ; returnM (HsIf new_e0 new_e1 new_e2 new_e3) }
579
580 zonkExpr env (HsLet binds expr)
581   = zonkLocalBinds env binds    `thenM` \ (new_env, new_binds) ->
582     zonkLExpr new_env expr      `thenM` \ new_expr ->
583     returnM (HsLet new_binds new_expr)
584
585 zonkExpr env (HsDo do_or_lc stmts ty)
586   = zonkStmts env stmts         `thenM` \ (_, new_stmts) ->
587     zonkTcTypeToType env ty     `thenM` \ new_ty   ->
588     returnM (HsDo do_or_lc new_stmts new_ty)
589
590 zonkExpr env (ExplicitList ty exprs)
591   = zonkTcTypeToType env ty     `thenM` \ new_ty ->
592     zonkLExprs env exprs        `thenM` \ new_exprs ->
593     returnM (ExplicitList new_ty new_exprs)
594
595 zonkExpr env (ExplicitPArr ty exprs)
596   = zonkTcTypeToType env ty     `thenM` \ new_ty ->
597     zonkLExprs env exprs        `thenM` \ new_exprs ->
598     returnM (ExplicitPArr new_ty new_exprs)
599
600 zonkExpr env (RecordCon data_con con_expr rbinds)
601   = do  { new_con_expr <- zonkExpr env con_expr
602         ; new_rbinds   <- zonkRecFields env rbinds
603         ; return (RecordCon data_con new_con_expr new_rbinds) }
604
605 zonkExpr env (RecordUpd expr rbinds cons in_tys out_tys)
606   = do  { new_expr    <- zonkLExpr env expr
607         ; new_in_tys  <- mapM (zonkTcTypeToType env) in_tys
608         ; new_out_tys <- mapM (zonkTcTypeToType env) out_tys
609         ; new_rbinds  <- zonkRecFields env rbinds
610         ; return (RecordUpd new_expr new_rbinds cons new_in_tys new_out_tys) }
611
612 zonkExpr env (ExprWithTySigOut e ty) 
613   = do { e' <- zonkLExpr env e
614        ; return (ExprWithTySigOut e' ty) }
615
616 zonkExpr _ (ExprWithTySig _ _) = panic "zonkExpr env:ExprWithTySig"
617
618 zonkExpr env (ArithSeq expr info)
619   = zonkExpr env expr           `thenM` \ new_expr ->
620     zonkArithSeq env info       `thenM` \ new_info ->
621     returnM (ArithSeq new_expr new_info)
622
623 zonkExpr env (PArrSeq expr info)
624   = zonkExpr env expr           `thenM` \ new_expr ->
625     zonkArithSeq env info       `thenM` \ new_info ->
626     returnM (PArrSeq new_expr new_info)
627
628 zonkExpr env (HsSCC lbl expr)
629   = zonkLExpr env expr  `thenM` \ new_expr ->
630     returnM (HsSCC lbl new_expr)
631
632 zonkExpr env (HsTickPragma info expr)
633   = zonkLExpr env expr  `thenM` \ new_expr ->
634     returnM (HsTickPragma info new_expr)
635
636 -- hdaume: core annotations
637 zonkExpr env (HsCoreAnn lbl expr)
638   = zonkLExpr env expr   `thenM` \ new_expr ->
639     returnM (HsCoreAnn lbl new_expr)
640
641 -- arrow notation extensions
642 zonkExpr env (HsProc pat body)
643   = do  { (env1, new_pat) <- zonkPat env pat
644         ; new_body <- zonkCmdTop env1 body
645         ; return (HsProc new_pat new_body) }
646
647 zonkExpr env (HsArrApp e1 e2 ty ho rl)
648   = zonkLExpr env e1                    `thenM` \ new_e1 ->
649     zonkLExpr env e2                    `thenM` \ new_e2 ->
650     zonkTcTypeToType env ty             `thenM` \ new_ty ->
651     returnM (HsArrApp new_e1 new_e2 new_ty ho rl)
652
653 zonkExpr env (HsArrForm op fixity args)
654   = zonkLExpr env op                    `thenM` \ new_op ->
655     mappM (zonkCmdTop env) args         `thenM` \ new_args ->
656     returnM (HsArrForm new_op fixity new_args)
657
658 zonkExpr env (HsWrap co_fn expr)
659   = zonkCoFn env co_fn  `thenM` \ (env1, new_co_fn) ->
660     zonkExpr env1 expr  `thenM` \ new_expr ->
661     return (HsWrap new_co_fn new_expr)
662
663 zonkExpr _ expr = pprPanic "zonkExpr" (ppr expr)
664
665 zonkCmdTop :: ZonkEnv -> LHsCmdTop TcId -> TcM (LHsCmdTop Id)
666 zonkCmdTop env cmd = wrapLocM (zonk_cmd_top env) cmd
667
668 zonk_cmd_top :: ZonkEnv -> HsCmdTop TcId -> TcM (HsCmdTop Id)
669 zonk_cmd_top env (HsCmdTop cmd stack_tys ty ids)
670   = zonkLExpr env cmd                   `thenM` \ new_cmd ->
671     zonkTcTypeToTypes env stack_tys     `thenM` \ new_stack_tys ->
672     zonkTcTypeToType env ty             `thenM` \ new_ty ->
673     mapSndM (zonkExpr env) ids          `thenM` \ new_ids ->
674     returnM (HsCmdTop new_cmd new_stack_tys new_ty new_ids)
675
676 -------------------------------------------------------------------------
677 zonkCoFn :: ZonkEnv -> HsWrapper -> TcM (ZonkEnv, HsWrapper)
678 zonkCoFn env WpHole   = return (env, WpHole)
679 zonkCoFn env (WpCompose c1 c2) = do { (env1, c1') <- zonkCoFn env c1
680                                     ; (env2, c2') <- zonkCoFn env1 c2
681                                     ; return (env2, WpCompose c1' c2') }
682 zonkCoFn env (WpCast co)    = do { co' <- zonkTcCoToCo env co
683                                  ; return (env, WpCast co') }
684 zonkCoFn env (WpEvLam ev)   = do { (env', ev') <- zonkEvBndrX env ev
685                                  ; return (env', WpEvLam ev') }
686 zonkCoFn env (WpEvApp arg)  = do { arg' <- zonkEvTerm env arg 
687                                  ; return (env, WpEvApp arg') }
688 zonkCoFn env (WpTyLam tv)   = ASSERT( isImmutableTyVar tv )
689                               return (env, WpTyLam tv) 
690 zonkCoFn env (WpTyApp ty)   = do { ty' <- zonkTcTypeToType env ty
691                                  ; return (env, WpTyApp ty') }
692 zonkCoFn env (WpLet bs)     = do { (env1, bs') <- zonkTcEvBinds env bs
693                                  ; return (env1, WpLet bs') }
694
695 -------------------------------------------------------------------------
696 zonkOverLit :: ZonkEnv -> HsOverLit TcId -> TcM (HsOverLit Id)
697 zonkOverLit env lit@(OverLit { ol_witness = e, ol_type = ty })
698   = do  { ty' <- zonkTcTypeToType env ty
699         ; e' <- zonkExpr env e
700         ; return (lit { ol_witness = e', ol_type = ty' }) }
701
702 -------------------------------------------------------------------------
703 zonkArithSeq :: ZonkEnv -> ArithSeqInfo TcId -> TcM (ArithSeqInfo Id)
704
705 zonkArithSeq env (From e)
706   = zonkLExpr env e             `thenM` \ new_e ->
707     returnM (From new_e)
708
709 zonkArithSeq env (FromThen e1 e2)
710   = zonkLExpr env e1    `thenM` \ new_e1 ->
711     zonkLExpr env e2    `thenM` \ new_e2 ->
712     returnM (FromThen new_e1 new_e2)
713
714 zonkArithSeq env (FromTo e1 e2)
715   = zonkLExpr env e1    `thenM` \ new_e1 ->
716     zonkLExpr env e2    `thenM` \ new_e2 ->
717     returnM (FromTo new_e1 new_e2)
718
719 zonkArithSeq env (FromThenTo e1 e2 e3)
720   = zonkLExpr env e1    `thenM` \ new_e1 ->
721     zonkLExpr env e2    `thenM` \ new_e2 ->
722     zonkLExpr env e3    `thenM` \ new_e3 ->
723     returnM (FromThenTo new_e1 new_e2 new_e3)
724
725
726 -------------------------------------------------------------------------
727 zonkStmts :: ZonkEnv -> [LStmt TcId] -> TcM (ZonkEnv, [LStmt Id])
728 zonkStmts env []     = return (env, [])
729 zonkStmts env (s:ss) = do { (env1, s')  <- wrapLocSndM (zonkStmt env) s
730                           ; (env2, ss') <- zonkStmts env1 ss
731                           ; return (env2, s' : ss') }
732
733 zonkStmt :: ZonkEnv -> Stmt TcId -> TcM (ZonkEnv, Stmt Id)
734 zonkStmt env (ParStmt stmts_w_bndrs mzip_op bind_op return_op)
735   = mappM zonk_branch stmts_w_bndrs     `thenM` \ new_stmts_w_bndrs ->
736     let 
737         new_binders = concat (map snd new_stmts_w_bndrs)
738         env1 = extendZonkEnv env new_binders
739     in
740     zonkExpr env1 mzip_op   `thenM` \ new_mzip ->
741     zonkExpr env1 bind_op   `thenM` \ new_bind ->
742     zonkExpr env1 return_op `thenM` \ new_return ->
743     return (env1, ParStmt new_stmts_w_bndrs new_mzip new_bind new_return)
744   where
745     zonk_branch (stmts, bndrs) = zonkStmts env stmts    `thenM` \ (env1, new_stmts) ->
746                                  returnM (new_stmts, zonkIdOccs env1 bndrs)
747
748 zonkStmt env (RecStmt { recS_stmts = segStmts, recS_later_ids = lvs, recS_rec_ids = rvs
749                       , recS_ret_fn = ret_id, recS_mfix_fn = mfix_id, recS_bind_fn = bind_id
750                       , recS_rec_rets = rets, recS_ret_ty = ret_ty })
751   = do { new_rvs <- zonkIdBndrs env rvs
752        ; new_lvs <- zonkIdBndrs env lvs
753        ; new_ret_ty  <- zonkTcTypeToType env ret_ty
754        ; new_ret_id  <- zonkExpr env ret_id
755        ; new_mfix_id <- zonkExpr env mfix_id
756        ; new_bind_id <- zonkExpr env bind_id
757        ; let env1 = extendZonkEnv env new_rvs
758        ; (env2, new_segStmts) <- zonkStmts env1 segStmts
759         -- Zonk the ret-expressions in an envt that 
760         -- has the polymorphic bindings in the envt
761        ; new_rets <- mapM (zonkExpr env2) rets
762        ; return (extendZonkEnv env new_lvs,     -- Only the lvs are needed
763                  RecStmt { recS_stmts = new_segStmts, recS_later_ids = new_lvs
764                          , recS_rec_ids = new_rvs, recS_ret_fn = new_ret_id
765                          , recS_mfix_fn = new_mfix_id, recS_bind_fn = new_bind_id
766                          , recS_rec_rets = new_rets, recS_ret_ty = new_ret_ty }) }
767
768 zonkStmt env (ExprStmt expr then_op guard_op ty)
769   = zonkLExpr env expr          `thenM` \ new_expr ->
770     zonkExpr env then_op        `thenM` \ new_then ->
771     zonkExpr env guard_op       `thenM` \ new_guard ->
772     zonkTcTypeToType env ty     `thenM` \ new_ty ->
773     returnM (env, ExprStmt new_expr new_then new_guard new_ty)
774
775 zonkStmt env (LastStmt expr ret_op)
776   = zonkLExpr env expr          `thenM` \ new_expr ->
777     zonkExpr env ret_op         `thenM` \ new_ret ->
778     returnM (env, LastStmt new_expr new_ret)
779
780 zonkStmt env (TransStmt { trS_stmts = stmts, trS_bndrs = binderMap
781                         , trS_by = by, trS_form = form, trS_using = using
782                         , trS_ret = return_op, trS_bind = bind_op, trS_fmap = liftM_op })
783   = do { (env', stmts') <- zonkStmts env stmts 
784     ; binderMap' <- mappM (zonkBinderMapEntry env') binderMap
785     ; by'        <- fmapMaybeM (zonkLExpr env') by
786     ; using'     <- zonkLExpr env using
787     ; return_op' <- zonkExpr env' return_op
788     ; bind_op'   <- zonkExpr env' bind_op
789     ; liftM_op'  <- zonkExpr env' liftM_op
790     ; let env'' = extendZonkEnv env' (map snd binderMap')
791     ; return (env'', TransStmt { trS_stmts = stmts', trS_bndrs = binderMap'
792                                , trS_by = by', trS_form = form, trS_using = using'
793                                , trS_ret = return_op', trS_bind = bind_op', trS_fmap = liftM_op' }) }
794   where
795     zonkBinderMapEntry env (oldBinder, newBinder) = do 
796         let oldBinder' = zonkIdOcc env oldBinder
797         newBinder' <- zonkIdBndr env newBinder
798         return (oldBinder', newBinder') 
799
800 zonkStmt env (LetStmt binds)
801   = zonkLocalBinds env binds    `thenM` \ (env1, new_binds) ->
802     returnM (env1, LetStmt new_binds)
803
804 zonkStmt env (BindStmt pat expr bind_op fail_op)
805   = do  { new_expr <- zonkLExpr env expr
806         ; (env1, new_pat) <- zonkPat env pat
807         ; new_bind <- zonkExpr env bind_op
808         ; new_fail <- zonkExpr env fail_op
809         ; return (env1, BindStmt new_pat new_expr new_bind new_fail) }
810
811 -------------------------------------------------------------------------
812 zonkRecFields :: ZonkEnv -> HsRecordBinds TcId -> TcM (HsRecordBinds TcId)
813 zonkRecFields env (HsRecFields flds dd)
814   = do  { flds' <- mappM zonk_rbind flds
815         ; return (HsRecFields flds' dd) }
816   where
817     zonk_rbind fld
818       = do { new_id   <- wrapLocM (zonkIdBndr env) (hsRecFieldId fld)
819            ; new_expr <- zonkLExpr env (hsRecFieldArg fld)
820            ; return (fld { hsRecFieldId = new_id, hsRecFieldArg = new_expr }) }
821
822 -------------------------------------------------------------------------
823 mapIPNameTc :: (a -> TcM b) -> IPName a -> TcM (IPName b)
824 mapIPNameTc f (IPName n) = f n  `thenM` \ r -> returnM (IPName r)
825 \end{code}
826
827
828 %************************************************************************
829 %*                                                                      *
830 \subsection[BackSubst-Pats]{Patterns}
831 %*                                                                      *
832 %************************************************************************
833
834 \begin{code}
835 zonkPat :: ZonkEnv -> OutPat TcId -> TcM (ZonkEnv, OutPat Id)
836 -- Extend the environment as we go, because it's possible for one
837 -- pattern to bind something that is used in another (inside or
838 -- to the right)
839 zonkPat env pat = wrapLocSndM (zonk_pat env) pat
840
841 zonk_pat :: ZonkEnv -> Pat TcId -> TcM (ZonkEnv, Pat Id)
842 zonk_pat env (ParPat p)
843   = do  { (env', p') <- zonkPat env p
844         ; return (env', ParPat p') }
845
846 zonk_pat env (WildPat ty)
847   = do  { ty' <- zonkTcTypeToType env ty
848         ; return (env, WildPat ty') }
849
850 zonk_pat env (VarPat v)
851   = do  { v' <- zonkIdBndr env v
852         ; return (extendZonkEnv1 env v', VarPat v') }
853
854 zonk_pat env (LazyPat pat)
855   = do  { (env', pat') <- zonkPat env pat
856         ; return (env',  LazyPat pat') }
857
858 zonk_pat env (BangPat pat)
859   = do  { (env', pat') <- zonkPat env pat
860         ; return (env',  BangPat pat') }
861
862 zonk_pat env (AsPat (L loc v) pat)
863   = do  { v' <- zonkIdBndr env v
864         ; (env', pat') <- zonkPat (extendZonkEnv1 env v') pat
865         ; return (env', AsPat (L loc v') pat') }
866
867 zonk_pat env (ViewPat expr pat ty)
868   = do  { expr' <- zonkLExpr env expr
869         ; (env', pat') <- zonkPat env pat
870         ; ty' <- zonkTcTypeToType env ty
871         ; return (env', ViewPat expr' pat' ty') }
872
873 zonk_pat env (ListPat pats ty)
874   = do  { ty' <- zonkTcTypeToType env ty
875         ; (env', pats') <- zonkPats env pats
876         ; return (env', ListPat pats' ty') }
877
878 zonk_pat env (PArrPat pats ty)
879   = do  { ty' <- zonkTcTypeToType env ty
880         ; (env', pats') <- zonkPats env pats
881         ; return (env', PArrPat pats' ty') }
882
883 zonk_pat env (TuplePat pats boxed ty)
884   = do  { ty' <- zonkTcTypeToType env ty
885         ; (env', pats') <- zonkPats env pats
886         ; return (env', TuplePat pats' boxed ty') }
887
888 zonk_pat env p@(ConPatOut { pat_ty = ty, pat_dicts = evs, pat_binds = binds, pat_args = args })
889   = ASSERT( all isImmutableTyVar (pat_tvs p) ) 
890     do  { new_ty <- zonkTcTypeToType env ty
891         ; (env1, new_evs) <- zonkEvBndrsX env evs
892         ; (env2, new_binds) <- zonkTcEvBinds env1 binds
893         ; (env', new_args) <- zonkConStuff env2 args
894         ; returnM (env', p { pat_ty = new_ty, pat_dicts = new_evs, 
895                              pat_binds = new_binds, pat_args = new_args }) }
896
897 zonk_pat env (LitPat lit) = return (env, LitPat lit)
898
899 zonk_pat env (SigPatOut pat ty)
900   = do  { ty' <- zonkTcTypeToType env ty
901         ; (env', pat') <- zonkPat env pat
902         ; return (env', SigPatOut pat' ty') }
903
904 zonk_pat env (NPat lit mb_neg eq_expr)
905   = do  { lit' <- zonkOverLit env lit
906         ; mb_neg' <- fmapMaybeM (zonkExpr env) mb_neg
907         ; eq_expr' <- zonkExpr env eq_expr
908         ; return (env, NPat lit' mb_neg' eq_expr') }
909
910 zonk_pat env (NPlusKPat (L loc n) lit e1 e2)
911   = do  { n' <- zonkIdBndr env n
912         ; lit' <- zonkOverLit env lit
913         ; e1' <- zonkExpr env e1
914         ; e2' <- zonkExpr env e2
915         ; return (extendZonkEnv1 env n', NPlusKPat (L loc n') lit' e1' e2') }
916
917 zonk_pat env (CoPat co_fn pat ty) 
918   = do { (env', co_fn') <- zonkCoFn env co_fn
919        ; (env'', pat') <- zonkPat env' (noLoc pat)
920        ; ty' <- zonkTcTypeToType env'' ty
921        ; return (env'', CoPat co_fn' (unLoc pat') ty') }
922
923 zonk_pat _ pat = pprPanic "zonk_pat" (ppr pat)
924
925 ---------------------------
926 zonkConStuff :: ZonkEnv
927              -> HsConDetails (OutPat TcId) (HsRecFields id (OutPat TcId))
928              -> TcM (ZonkEnv,
929                      HsConDetails (OutPat Id) (HsRecFields id (OutPat Id)))
930 zonkConStuff env (PrefixCon pats)
931   = do  { (env', pats') <- zonkPats env pats
932         ; return (env', PrefixCon pats') }
933
934 zonkConStuff env (InfixCon p1 p2)
935   = do  { (env1, p1') <- zonkPat env  p1
936         ; (env', p2') <- zonkPat env1 p2
937         ; return (env', InfixCon p1' p2') }
938
939 zonkConStuff env (RecCon (HsRecFields rpats dd))
940   = do  { (env', pats') <- zonkPats env (map hsRecFieldArg rpats)
941         ; let rpats' = zipWith (\rp p' -> rp { hsRecFieldArg = p' }) rpats pats'
942         ; returnM (env', RecCon (HsRecFields rpats' dd)) }
943         -- Field selectors have declared types; hence no zonking
944
945 ---------------------------
946 zonkPats :: ZonkEnv -> [OutPat TcId] -> TcM (ZonkEnv, [OutPat Id])
947 zonkPats env []         = return (env, [])
948 zonkPats env (pat:pats) = do { (env1, pat') <- zonkPat env pat
949                      ; (env', pats') <- zonkPats env1 pats
950                      ; return (env', pat':pats') }
951 \end{code}
952
953 %************************************************************************
954 %*                                                                      *
955 \subsection[BackSubst-Foreign]{Foreign exports}
956 %*                                                                      *
957 %************************************************************************
958
959
960 \begin{code}
961 zonkForeignExports :: ZonkEnv -> [LForeignDecl TcId] -> TcM [LForeignDecl Id]
962 zonkForeignExports env ls = mappM (wrapLocM (zonkForeignExport env)) ls
963
964 zonkForeignExport :: ZonkEnv -> ForeignDecl TcId -> TcM (ForeignDecl Id)
965 zonkForeignExport env (ForeignExport i _hs_ty spec) =
966    returnM (ForeignExport (fmap (zonkIdOcc env) i) undefined spec)
967 zonkForeignExport _ for_imp 
968   = returnM for_imp     -- Foreign imports don't need zonking
969 \end{code}
970
971 \begin{code}
972 zonkRules :: ZonkEnv -> [LRuleDecl TcId] -> TcM [LRuleDecl Id]
973 zonkRules env rs = mappM (wrapLocM (zonkRule env)) rs
974
975 zonkRule :: ZonkEnv -> RuleDecl TcId -> TcM (RuleDecl Id)
976 zonkRule env (HsRule name act (vars{-::[RuleBndr TcId]-}) lhs fv_lhs rhs fv_rhs)
977   = do { (env_rhs, new_bndrs) <- mapAccumLM zonk_bndr env vars
978
979        ; unbound_tv_set <- newMutVar emptyVarSet
980        ; let env_lhs = setZonkType env_rhs (zonkTypeCollecting unbound_tv_set)
981         -- We need to gather the type variables mentioned on the LHS so we can 
982         -- quantify over them.  Example:
983         --   data T a = C
984         -- 
985         --   foo :: T a -> Int
986         --   foo C = 1
987         --
988         --   {-# RULES "myrule"  foo C = 1 #-}
989         -- 
990         -- After type checking the LHS becomes (foo a (C a))
991         -- and we do not want to zap the unbound tyvar 'a' to (), because
992         -- that limits the applicability of the rule.  Instead, we
993         -- want to quantify over it!  
994         --
995         -- It's easiest to find the free tyvars here. Attempts to do so earlier
996         -- are tiresome, because (a) the data type is big and (b) finding the 
997         -- free type vars of an expression is necessarily monadic operation.
998         --      (consider /\a -> f @ b, where b is side-effected to a)
999
1000        ; new_lhs <- zonkLExpr env_lhs lhs
1001        ; new_rhs <- zonkLExpr env_rhs rhs
1002
1003        ; unbound_tvs <- readMutVar unbound_tv_set
1004        ; let final_bndrs :: [RuleBndr Var]
1005              final_bndrs = map (RuleBndr . noLoc) (varSetElems unbound_tvs) ++ new_bndrs
1006
1007        ; return (HsRule name act final_bndrs new_lhs fv_lhs new_rhs fv_rhs) }
1008   where
1009    zonk_bndr env (RuleBndr (L loc v)) 
1010       = do { (env', v') <- zonk_it env v; return (env', RuleBndr (L loc v')) }
1011    zonk_bndr _ (RuleBndrSig {}) = panic "zonk_bndr RuleBndrSig"
1012
1013    zonk_it env v
1014      | isId v     = do { v' <- zonkIdBndr env v; return (extendZonkEnv1 env v', v') }
1015      | otherwise  = ASSERT( isImmutableTyVar v) return (env, v)
1016 \end{code}
1017
1018 \begin{code}
1019 zonkVects :: ZonkEnv -> [LVectDecl TcId] -> TcM [LVectDecl Id]
1020 zonkVects env = mappM (wrapLocM (zonkVect env))
1021
1022 zonkVect :: ZonkEnv -> VectDecl TcId -> TcM (VectDecl Id)
1023 zonkVect env (HsVect v Nothing)
1024   = do { v' <- wrapLocM (zonkIdBndr env) v
1025        ; return $ HsVect v' Nothing
1026        }
1027 zonkVect env (HsVect v (Just e))
1028   = do { v' <- wrapLocM (zonkIdBndr env) v
1029        ; e' <- zonkLExpr env e
1030        ; return $ HsVect v' (Just e')
1031        }
1032 zonkVect env (HsNoVect v)
1033   = do { v' <- wrapLocM (zonkIdBndr env) v
1034        ; return $ HsNoVect v'
1035        }
1036 \end{code}
1037
1038 %************************************************************************
1039 %*                                                                      *
1040               Constraints and evidence
1041 %*                                                                      *
1042 %************************************************************************
1043
1044 \begin{code}
1045 zonkEvTerm :: ZonkEnv -> EvTerm -> TcM EvTerm
1046 zonkEvTerm env (EvId v)           = ASSERT2( isId v, ppr v ) 
1047                                     return (EvId (zonkIdOcc env v))
1048 zonkEvTerm env (EvCoercion co)    = do { co' <- zonkTcCoToCo env co
1049                                        ; return (EvCoercion co') }
1050 zonkEvTerm env (EvCast v co)      = ASSERT( isId v) 
1051                                     do { co' <- zonkTcCoToCo env co
1052                                        ; return (EvCast (zonkIdOcc env v) co') }
1053 zonkEvTerm env (EvSuperClass d n) = return (EvSuperClass (zonkIdOcc env d) n)
1054 zonkEvTerm env (EvDFunApp df tys tms)
1055   = do { tys' <- zonkTcTypeToTypes env tys
1056        ; let tms' = map (zonkEvVarOcc env) tms
1057        ; return (EvDFunApp (zonkIdOcc env df) tys' tms') }
1058
1059 zonkTcEvBinds :: ZonkEnv -> TcEvBinds -> TcM (ZonkEnv, TcEvBinds)
1060 zonkTcEvBinds env (TcEvBinds var) = do { (env', bs') <- zonkEvBindsVar env var
1061                                        ; return (env', EvBinds bs') }
1062 zonkTcEvBinds env (EvBinds bs)    = do { (env', bs') <- zonkEvBinds env bs
1063                                        ; return (env', EvBinds bs') }
1064
1065 zonkEvBindsVar :: ZonkEnv -> EvBindsVar -> TcM (ZonkEnv, Bag EvBind)
1066 zonkEvBindsVar env (EvBindsVar ref _) = do { bs <- readMutVar ref
1067                                            ; zonkEvBinds env (evBindMapBinds bs) }
1068
1069 zonkEvBinds :: ZonkEnv -> Bag EvBind -> TcM (ZonkEnv, Bag EvBind)
1070 zonkEvBinds env binds
1071   = fixM (\ ~( _, new_binds) -> do
1072          { let env1 = extendZonkEnv env (collect_ev_bndrs new_binds)
1073          ; binds' <- mapBagM (zonkEvBind env1) binds
1074          ; return (env1, binds') })
1075   where
1076     collect_ev_bndrs :: Bag EvBind -> [EvVar]
1077     collect_ev_bndrs = foldrBag add [] 
1078     add (EvBind var _) vars = var : vars
1079
1080 zonkEvBind :: ZonkEnv -> EvBind -> TcM EvBind
1081 zonkEvBind env (EvBind var term)
1082   = do { var' <- zonkEvBndr env var
1083        ; term' <- zonkEvTerm env term
1084        ; return (EvBind var' term') }
1085 \end{code}
1086
1087 %************************************************************************
1088 %*                                                                      *
1089                          Zonking types
1090 %*                                                                      *
1091 %************************************************************************
1092
1093 \begin{code}
1094 zonkTcTypeToType :: ZonkEnv -> TcType -> TcM Type
1095 zonkTcTypeToType (ZonkEnv zonk_ty _) ty = zonk_ty ty
1096
1097 zonkTcTypeToTypes :: ZonkEnv -> [TcType] -> TcM [Type]
1098 zonkTcTypeToTypes env tys = mapM (zonkTcTypeToType env) tys
1099
1100 zonkTypeCollecting :: TcRef TyVarSet -> TcType -> TcM Type
1101 -- This variant collects unbound type variables in a mutable variable
1102 zonkTypeCollecting unbound_tv_set
1103   = zonkType (mkZonkTcTyVar zonk_unbound_tyvar)
1104   where
1105     zonk_unbound_tyvar tv 
1106         = do { tv' <- zonkQuantifiedTyVar tv
1107              ; tv_set <- readMutVar unbound_tv_set
1108              ; writeMutVar unbound_tv_set (extendVarSet tv_set tv')
1109              ; return (mkTyVarTy tv') }
1110
1111 zonkTypeZapping :: TcType -> TcM Type
1112 -- This variant is used for everything except the LHS of rules
1113 -- It zaps unbound type variables to (), or some other arbitrary type
1114 zonkTypeZapping ty 
1115   = zonkType (mkZonkTcTyVar zonk_unbound_tyvar) ty 
1116   where
1117         -- Zonk a mutable but unbound type variable to an arbitrary type
1118         -- We know it's unbound even though we don't carry an environment,
1119         -- because at the binding site for a type variable we bind the
1120         -- mutable tyvar to a fresh immutable one.  So the mutable store
1121         -- plays the role of an environment.  If we come across a mutable
1122         -- type variable that isn't so bound, it must be completely free.
1123     zonk_unbound_tyvar tv = do { let ty = anyTypeOfKind (tyVarKind tv)
1124                                ; writeMetaTyVar tv ty
1125                                ; return ty }
1126
1127 zonkTcCoToCo :: ZonkEnv -> Coercion -> TcM Coercion
1128 zonkTcCoToCo env co
1129   = go co
1130   where
1131     go (CoVarCo cv)         = return (CoVarCo (zonkEvVarOcc env cv))
1132     go (Refl ty)            = do { ty' <- zonkTcTypeToType env ty
1133                                  ; return (Refl ty') }
1134     go (TyConAppCo tc cos)  = do { cos' <- mapM go cos; return (mkTyConAppCo tc cos') }
1135     go (AxiomInstCo ax cos) = do { cos' <- mapM go cos; return (AxiomInstCo ax cos') }
1136     go (AppCo co1 co2)      = do { co1' <- go co1; co2' <- go co2
1137                                  ; return (mkAppCo co1' co2') }
1138     go (UnsafeCo t1 t2)     = do { t1' <- zonkTcTypeToType env t1
1139                                  ; t2' <- zonkTcTypeToType env t2
1140                                  ; return (mkUnsafeCo t1' t2') }
1141     go (SymCo co)           = do { co' <- go co; return (mkSymCo co')  }
1142     go (NthCo n co)         = do { co' <- go co; return (mkNthCo n co')  }
1143     go (TransCo co1 co2)    = do { co1' <- go co1; co2' <- go co2
1144                                  ; return (mkTransCo co1' co2')  }
1145     go (InstCo co ty)       = do { co' <- go co; ty' <- zonkTcTypeToType env ty
1146                                  ; return (mkInstCo co' ty')  }
1147     go (ForAllCo tv co)     = ASSERT( isImmutableTyVar tv )
1148                               do { co' <- go co; return (mkForAllCo tv co') }
1149 \end{code}