Merge remote-tracking branch 'origin/master' into tc-untouchables
[ghc.git] / compiler / typecheck / TcHsSyn.lhs
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 {-# OPTIONS -fno-warn-tabs #-}
13 -- The above warning supression flag is a temporary kludge.
14 -- While working on this module you are encouraged to remove it and
15 -- detab the module (please do the detabbing in a separate patch). See
16 --     http://hackage.haskell.org/trac/ghc/wiki/Commentary/CodingStyle#TabsvsSpaces
17 -- for details
18
19 module TcHsSyn (
20         mkHsConApp, mkHsDictLet, mkHsApp,
21         hsLitType, hsLPatType, hsPatType, 
22         mkHsAppTy, mkSimpleHsAlt,
23         nlHsIntLit, 
24         shortCutLit, hsOverLitName,
25         
26         -- re-exported from TcMonad
27         TcId, TcIdSet, 
28
29         zonkTopDecls, zonkTopExpr, zonkTopLExpr, 
30         zonkTopBndrs, zonkTyBndrsX,
31         emptyZonkEnv, mkEmptyZonkEnv, mkTyVarZonkEnv, 
32         zonkTcTypeToType, zonkTcTypeToTypes, zonkTyVarOcc,
33   ) where
34
35 #include "HsVersions.h"
36
37 import HsSyn
38 import Id
39 import TcRnMonad
40 import PrelNames
41 import TypeRep     -- We can see the representation of types
42 import TcType
43 import TcMType ( defaultKindVarToStar, zonkQuantifiedTyVar, writeMetaTyVar )
44 import TcEvidence
45 import TysPrim
46 import TysWiredIn
47 import Type
48 import DataCon
49 import Name
50 import NameSet
51 import Var
52 import VarSet
53 import VarEnv
54 import DynFlags
55 import Literal
56 import BasicTypes
57 import Maybes
58 import SrcLoc
59 import Bag
60 import FastString
61 import Outputable
62 import Util
63 -- import Data.Traversable( traverse )
64 \end{code}
65
66 \begin{code}
67 -- XXX
68 thenM :: Monad a => a b -> (b -> a c) -> a c
69 thenM = (>>=)
70
71 returnM :: Monad m => a -> m a
72 returnM = return
73
74 mappM :: (Monad m) => (a -> m b) -> [a] -> m [b]
75 mappM = mapM
76 \end{code}
77
78
79 %************************************************************************
80 %*                                                                      *
81 \subsection[mkFailurePair]{Code for pattern-matching and other failures}
82 %*                                                                      *
83 %************************************************************************
84
85 Note: If @hsLPatType@ doesn't bear a strong resemblance to @exprType@,
86 then something is wrong.
87 \begin{code}
88 hsLPatType :: OutPat Id -> Type
89 hsLPatType (L _ pat) = hsPatType pat
90
91 hsPatType :: Pat Id -> Type
92 hsPatType (ParPat pat)                = hsLPatType pat
93 hsPatType (WildPat ty)                = ty
94 hsPatType (VarPat var)                = idType var
95 hsPatType (BangPat pat)               = hsLPatType pat
96 hsPatType (LazyPat pat)               = hsLPatType pat
97 hsPatType (LitPat lit)                = hsLitType lit
98 hsPatType (AsPat var _)               = idType (unLoc var)
99 hsPatType (ViewPat _ _ ty)            = ty
100 hsPatType (ListPat _ ty)              = mkListTy ty
101 hsPatType (PArrPat _ ty)              = mkPArrTy ty
102 hsPatType (TuplePat _ _ ty)           = ty
103 hsPatType (ConPatOut { pat_ty = ty }) = ty
104 hsPatType (SigPatOut _ ty)            = ty
105 hsPatType (NPat lit _ _)              = overLitType lit
106 hsPatType (NPlusKPat id _ _ _)        = idType (unLoc id)
107 hsPatType (CoPat _ _ ty)              = ty
108 hsPatType p                           = pprPanic "hsPatType" (ppr p)
109
110 hsLitType :: HsLit -> TcType
111 hsLitType (HsChar _)       = charTy
112 hsLitType (HsCharPrim _)   = charPrimTy
113 hsLitType (HsString _)     = stringTy
114 hsLitType (HsStringPrim _) = addrPrimTy
115 hsLitType (HsInt _)        = intTy
116 hsLitType (HsIntPrim _)    = intPrimTy
117 hsLitType (HsWordPrim _)   = wordPrimTy
118 hsLitType (HsInt64Prim _)  = int64PrimTy
119 hsLitType (HsWord64Prim _) = word64PrimTy
120 hsLitType (HsInteger _ ty) = ty
121 hsLitType (HsRat _ ty)     = ty
122 hsLitType (HsFloatPrim _)  = floatPrimTy
123 hsLitType (HsDoublePrim _) = doublePrimTy
124 \end{code}
125
126 Overloaded literals. Here mainly becuase it uses isIntTy etc
127
128 \begin{code}
129 shortCutLit :: DynFlags -> OverLitVal -> TcType -> Maybe (HsExpr TcId)
130 shortCutLit dflags (HsIntegral i) ty
131   | isIntTy ty  && inIntRange  dflags i = Just (HsLit (HsInt i))
132   | isWordTy ty && inWordRange dflags i = Just (mkLit wordDataCon (HsWordPrim i))
133   | isIntegerTy ty = Just (HsLit (HsInteger i ty))
134   | otherwise = shortCutLit dflags (HsFractional (integralFractionalLit i)) ty
135         -- The 'otherwise' case is important
136         -- Consider (3 :: Float).  Syntactically it looks like an IntLit,
137         -- so we'll call shortCutIntLit, but of course it's a float
138         -- This can make a big difference for programs with a lot of
139         -- literals, compiled without -O
140
141 shortCutLit _ (HsFractional f) ty
142   | isFloatTy ty  = Just (mkLit floatDataCon  (HsFloatPrim f))
143   | isDoubleTy ty = Just (mkLit doubleDataCon (HsDoublePrim f))
144   | otherwise     = Nothing
145
146 shortCutLit _ (HsIsString s) ty
147   | isStringTy ty = Just (HsLit (HsString s))
148   | otherwise     = Nothing
149
150 mkLit :: DataCon -> HsLit -> HsExpr Id
151 mkLit con lit = HsApp (nlHsVar (dataConWrapId con)) (nlHsLit lit)
152
153 ------------------------------
154 hsOverLitName :: OverLitVal -> Name
155 -- Get the canonical 'fromX' name for a particular OverLitVal
156 hsOverLitName (HsIntegral {})   = fromIntegerName
157 hsOverLitName (HsFractional {}) = fromRationalName
158 hsOverLitName (HsIsString {})   = fromStringName
159 \end{code}
160
161 %************************************************************************
162 %*                                                                      *
163 \subsection[BackSubst-HsBinds]{Running a substitution over @HsBinds@}
164 %*                                                                      *
165 %************************************************************************
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 type UnboundTyVarZonker = TcTyVar-> TcM Type 
186         -- How to zonk an unbound type variable
187         -- Note [Zonking the LHS of a RULE]
188
189 data ZonkEnv 
190   = ZonkEnv 
191       UnboundTyVarZonker
192       (TyVarEnv TyVar)          -- 
193       (IdEnv    Var)            -- What variables are in scope
194         -- Maps an Id or EvVar to its zonked version; both have the same Name
195         -- Note that all evidence (coercion variables as well as dictionaries)
196         --      are kept in the ZonkEnv
197         -- Only *type* abstraction is done by side effect
198         -- Is only consulted lazily; hence knot-tying
199
200 instance Outputable ZonkEnv where 
201   ppr (ZonkEnv _ _ty_env var_env) = vcat (map ppr (varEnvElts var_env))
202
203
204 emptyZonkEnv :: ZonkEnv
205 emptyZonkEnv = mkEmptyZonkEnv zonkTypeZapping
206
207 mkEmptyZonkEnv :: UnboundTyVarZonker -> ZonkEnv
208 mkEmptyZonkEnv zonker = ZonkEnv zonker emptyVarEnv emptyVarEnv
209
210 extendIdZonkEnv :: ZonkEnv -> [Var] -> ZonkEnv
211 extendIdZonkEnv (ZonkEnv zonk_ty ty_env id_env) ids 
212   = ZonkEnv zonk_ty ty_env (extendVarEnvList id_env [(id,id) | id <- ids])
213
214 extendIdZonkEnv1 :: ZonkEnv -> Var -> ZonkEnv
215 extendIdZonkEnv1 (ZonkEnv zonk_ty ty_env id_env) id 
216   = ZonkEnv zonk_ty ty_env (extendVarEnv id_env id id)
217
218 extendTyZonkEnv1 :: ZonkEnv -> TyVar -> ZonkEnv
219 extendTyZonkEnv1 (ZonkEnv zonk_ty ty_env id_env) ty
220   = ZonkEnv zonk_ty (extendVarEnv ty_env ty ty) id_env
221
222 mkTyVarZonkEnv :: [TyVar] -> ZonkEnv
223 mkTyVarZonkEnv tvs = ZonkEnv zonkTypeZapping (mkVarEnv [(tv,tv) | tv <- tvs]) emptyVarEnv
224
225 setZonkType :: ZonkEnv -> UnboundTyVarZonker -> ZonkEnv
226 setZonkType (ZonkEnv _ ty_env id_env) zonk_ty = ZonkEnv zonk_ty ty_env id_env
227
228 zonkEnvIds :: ZonkEnv -> [Id]
229 zonkEnvIds (ZonkEnv _ _ id_env) = varEnvElts id_env
230
231 zonkIdOcc :: ZonkEnv -> TcId -> Id
232 -- Ids defined in this module should be in the envt; 
233 -- ignore others.  (Actually, data constructors are also
234 -- not LocalVars, even when locally defined, but that is fine.)
235 -- (Also foreign-imported things aren't currently in the ZonkEnv;
236 --  that's ok because they don't need zonking.)
237 --
238 -- Actually, Template Haskell works in 'chunks' of declarations, and
239 -- an earlier chunk won't be in the 'env' that the zonking phase 
240 -- carries around.  Instead it'll be in the tcg_gbl_env, already fully
241 -- zonked.  There's no point in looking it up there (except for error 
242 -- checking), and it's not conveniently to hand; hence the simple
243 -- 'orElse' case in the LocalVar branch.
244 --
245 -- Even without template splices, in module Main, the checking of
246 -- 'main' is done as a separate chunk.
247 zonkIdOcc (ZonkEnv _zonk_ty _ty_env env) id 
248   | isLocalVar id = lookupVarEnv env id `orElse` id
249   | otherwise     = id
250
251 zonkIdOccs :: ZonkEnv -> [TcId] -> [Id]
252 zonkIdOccs env ids = map (zonkIdOcc env) ids
253
254 -- zonkIdBndr is used *after* typechecking to get the Id's type
255 -- to its final form.  The TyVarEnv give 
256 zonkIdBndr :: ZonkEnv -> TcId -> TcM Id
257 zonkIdBndr env id
258   = zonkTcTypeToType env (idType id)    `thenM` \ ty' ->
259     returnM (Id.setIdType id ty')
260
261 zonkIdBndrs :: ZonkEnv -> [TcId] -> TcM [Id]
262 zonkIdBndrs env ids = mappM (zonkIdBndr env) ids
263
264 zonkTopBndrs :: [TcId] -> TcM [Id]
265 zonkTopBndrs ids = zonkIdBndrs emptyZonkEnv ids
266
267 zonkEvBndrsX :: ZonkEnv -> [EvVar] -> TcM (ZonkEnv, [Var])
268 zonkEvBndrsX = mapAccumLM zonkEvBndrX 
269
270 zonkEvBndrX :: ZonkEnv -> EvVar -> TcM (ZonkEnv, EvVar)
271 -- Works for dictionaries and coercions
272 zonkEvBndrX env var
273   = do { var' <- zonkEvBndr env var
274        ; return (extendIdZonkEnv1 env var', var') }
275
276 zonkEvBndr :: ZonkEnv -> EvVar -> TcM EvVar
277 -- Works for dictionaries and coercions
278 -- Does not extend the ZonkEnv
279 zonkEvBndr env var 
280   = do { let var_ty = varType var
281        ; ty <- 
282            {-# SCC "zonkEvBndr_zonkTcTypeToType" #-}
283            zonkTcTypeToType env var_ty
284        ; return (setVarType var ty) }
285
286 zonkEvVarOcc :: ZonkEnv -> EvVar -> EvVar
287 zonkEvVarOcc env v = zonkIdOcc env v
288
289 zonkTyBndrsX :: ZonkEnv -> [TyVar] -> TcM (ZonkEnv, [TyVar])
290 zonkTyBndrsX = mapAccumLM zonkTyBndrX 
291
292 zonkTyBndrX :: ZonkEnv -> TyVar -> TcM (ZonkEnv, TyVar)
293 -- This guarantees to return a TyVar (not a TcTyVar)
294 -- then we add it to the envt, so all occurrences are replaced
295 zonkTyBndrX env tv
296   = do { ki <- zonkTcTypeToType env (tyVarKind tv)
297        ; let tv' = mkTyVar (tyVarName tv) ki
298        ; return (extendTyZonkEnv1 env tv', tv') }
299 \end{code}
300
301
302 \begin{code}
303 zonkTopExpr :: HsExpr TcId -> TcM (HsExpr Id)
304 zonkTopExpr e = zonkExpr emptyZonkEnv e
305
306 zonkTopLExpr :: LHsExpr TcId -> TcM (LHsExpr Id)
307 zonkTopLExpr e = zonkLExpr emptyZonkEnv e
308
309 zonkTopDecls :: Bag EvBind 
310              -> LHsBinds TcId -> NameSet
311              -> [LRuleDecl TcId] -> [LVectDecl TcId] -> [LTcSpecPrag] -> [LForeignDecl TcId]
312              -> TcM ([Id], 
313                      Bag EvBind,
314                      Bag (LHsBind  Id),
315                      [LForeignDecl Id],
316                      [LTcSpecPrag],
317                      [LRuleDecl    Id],
318                      [LVectDecl    Id])
319 zonkTopDecls ev_binds binds sig_ns rules vects imp_specs fords
320   = do  { (env1, ev_binds') <- zonkEvBinds emptyZonkEnv ev_binds
321
322          -- Warn about missing signatures
323          -- Do this only when we we have a type to offer
324         ; warn_missing_sigs <- woptM Opt_WarnMissingSigs
325         ; let sig_warn | warn_missing_sigs = topSigWarn sig_ns
326                        | otherwise         = noSigWarn
327
328         ; (env2, binds') <- zonkRecMonoBinds env1 sig_warn binds
329                         -- Top level is implicitly recursive
330         ; rules' <- zonkRules env2 rules
331         ; vects' <- zonkVects env2 vects
332         ; specs' <- zonkLTcSpecPrags env2 imp_specs
333         ; fords' <- zonkForeignExports env2 fords
334         ; return (zonkEnvIds env2, ev_binds', binds', fords', specs', rules', vects') }
335
336 ---------------------------------------------
337 zonkLocalBinds :: ZonkEnv -> HsLocalBinds TcId -> TcM (ZonkEnv, HsLocalBinds Id)
338 zonkLocalBinds env EmptyLocalBinds
339   = return (env, EmptyLocalBinds)
340
341 zonkLocalBinds _ (HsValBinds (ValBindsIn {}))
342   = panic "zonkLocalBinds" -- Not in typechecker output
343
344 zonkLocalBinds env (HsValBinds vb@(ValBindsOut binds sigs))
345   = do  { warn_missing_sigs <- woptM Opt_WarnMissingLocalSigs
346         ; let sig_warn | not warn_missing_sigs = noSigWarn
347                        | otherwise             = localSigWarn sig_ns
348               sig_ns = getTypeSigNames vb
349         ; (env1, new_binds) <- go env sig_warn binds
350         ; return (env1, HsValBinds (ValBindsOut new_binds sigs)) }
351   where
352     go env _ []
353       = return (env, [])
354     go env sig_warn ((r,b):bs) 
355       = do { (env1, b')  <- zonkRecMonoBinds env sig_warn b
356            ; (env2, bs') <- go env1 sig_warn bs
357            ; return (env2, (r,b'):bs') }
358
359 zonkLocalBinds env (HsIPBinds (IPBinds binds dict_binds))
360   = mappM (wrapLocM zonk_ip_bind) binds `thenM` \ new_binds ->
361     let
362         env1 = extendIdZonkEnv env [ n | L _ (IPBind (Right n) _) <- new_binds]
363     in
364     zonkTcEvBinds env1 dict_binds       `thenM` \ (env2, new_dict_binds) -> 
365     returnM (env2, HsIPBinds (IPBinds new_binds new_dict_binds))
366   where
367     zonk_ip_bind (IPBind n e)
368         = mapIPNameTc (zonkIdBndr env) n        `thenM` \ n' ->
369           zonkLExpr env e                       `thenM` \ e' ->
370           returnM (IPBind n' e')
371
372 ---------------------------------------------
373 zonkRecMonoBinds :: ZonkEnv -> SigWarn -> LHsBinds TcId -> TcM (ZonkEnv, LHsBinds Id)
374 zonkRecMonoBinds env sig_warn binds 
375  = fixM (\ ~(_, new_binds) -> do 
376         { let env1 = extendIdZonkEnv env (collectHsBindsBinders new_binds)
377         ; binds' <- zonkMonoBinds env1 sig_warn binds
378         ; return (env1, binds') })
379
380 ---------------------------------------------
381 type SigWarn = Bool -> [Id] -> TcM ()   
382      -- Missing-signature warning
383      -- The Bool is True for an AbsBinds, False otherwise
384
385 noSigWarn :: SigWarn
386 noSigWarn _ _ = return ()
387
388 topSigWarn :: NameSet -> SigWarn
389 topSigWarn sig_ns _ ids = mapM_ (topSigWarnId sig_ns) ids
390
391 topSigWarnId :: NameSet -> Id -> TcM ()
392 -- The NameSet is the Ids that *lack* a signature
393 -- We have to do it this way round because there are
394 -- lots of top-level bindings that are generated by GHC
395 -- and that don't have signatures
396 topSigWarnId sig_ns id
397   | idName id `elemNameSet` sig_ns = warnMissingSig msg id
398   | otherwise                      = return ()
399   where
400     msg = ptext (sLit "Top-level binding with no type signature:")
401
402 localSigWarn :: NameSet -> SigWarn
403 localSigWarn sig_ns is_abs_bind ids
404   | not is_abs_bind = return ()
405   | otherwise       = mapM_ (localSigWarnId sig_ns) ids
406
407 localSigWarnId :: NameSet -> Id -> TcM ()
408 -- NameSet are the Ids that *have* type signatures
409 localSigWarnId sig_ns id
410   | not (isSigmaTy (idType id))    = return ()
411   | idName id `elemNameSet` sig_ns = return ()
412   | otherwise                      = warnMissingSig msg id
413   where
414     msg = ptext (sLit "Polymophic local binding with no type signature:")
415
416 warnMissingSig :: SDoc -> Id -> TcM ()
417 warnMissingSig msg id
418   = do  { env0 <- tcInitTidyEnv
419         ; let (env1, tidy_ty) = tidyOpenType env0 (idType id)
420         ; addWarnTcM (env1, mk_msg tidy_ty) }
421   where
422     mk_msg ty = sep [ msg, nest 2 $ pprPrefixName (idName id) <+> dcolon <+> ppr ty ]
423
424 ---------------------------------------------
425 zonkMonoBinds :: ZonkEnv -> SigWarn -> LHsBinds TcId -> TcM (LHsBinds Id)
426 zonkMonoBinds env sig_warn binds = mapBagM (wrapLocM (zonk_bind env sig_warn)) binds
427
428 zonk_bind :: ZonkEnv -> SigWarn -> HsBind TcId -> TcM (HsBind Id)
429 zonk_bind env sig_warn bind@(PatBind { pat_lhs = pat, pat_rhs = grhss, pat_rhs_ty = ty})
430   = do  { (_env, new_pat) <- zonkPat env pat            -- Env already extended
431         ; sig_warn False (collectPatBinders new_pat)
432         ; new_grhss <- zonkGRHSs env grhss
433         ; new_ty    <- zonkTcTypeToType env ty
434         ; return (bind { pat_lhs = new_pat, pat_rhs = new_grhss, pat_rhs_ty = new_ty }) }
435
436 zonk_bind env sig_warn (VarBind { var_id = var, var_rhs = expr, var_inline = inl })
437   = do { new_var  <- zonkIdBndr env var
438        ; sig_warn False [new_var]
439        ; new_expr <- zonkLExpr env expr
440        ; return (VarBind { var_id = new_var, var_rhs = new_expr, var_inline = inl }) }
441
442 zonk_bind env sig_warn bind@(FunBind { fun_id = L loc var, fun_matches = ms
443                                      , fun_co_fn = co_fn })
444   = do { new_var <- zonkIdBndr env var
445        ; sig_warn False [new_var]
446        ; (env1, new_co_fn) <- zonkCoFn env co_fn
447        ; new_ms <- zonkMatchGroup env1 ms
448        ; return (bind { fun_id = L loc new_var, fun_matches = new_ms
449                       , fun_co_fn = new_co_fn }) }
450
451 zonk_bind env sig_warn (AbsBinds { abs_tvs = tyvars, abs_ev_vars = evs
452                                  , abs_ev_binds = ev_binds
453                                  , abs_exports = exports
454                                  , abs_binds = val_binds })
455   = ASSERT( all isImmutableTyVar tyvars )
456     do { (env0, new_tyvars) <- zonkTyBndrsX env tyvars
457        ; (env1, new_evs) <- zonkEvBndrsX env0 evs
458        ; (env2, new_ev_binds) <- zonkTcEvBinds env1 ev_binds
459        ; (new_val_bind, new_exports) <- fixM $ \ ~(new_val_binds, _) ->
460          do { let env3 = extendIdZonkEnv env2 (collectHsBindsBinders new_val_binds)
461             ; new_val_binds <- zonkMonoBinds env3 noSigWarn val_binds
462             ; new_exports   <- mapM (zonkExport env3) exports
463             ; return (new_val_binds, new_exports) } 
464        ; sig_warn True (map abe_poly new_exports)
465        ; return (AbsBinds { abs_tvs = new_tyvars, abs_ev_vars = new_evs
466                           , abs_ev_binds = new_ev_binds
467                           , abs_exports = new_exports, abs_binds = new_val_bind }) }
468   where
469     zonkExport env (ABE{ abe_wrap = wrap, abe_poly = poly_id
470                        , abe_mono = mono_id, abe_prags = prags })
471         = zonkIdBndr env poly_id                `thenM` \ new_poly_id ->
472           zonkCoFn env wrap                     `thenM` \ (_, new_wrap) ->
473           zonkSpecPrags env prags               `thenM` \ new_prags -> 
474           returnM (ABE{ abe_wrap = new_wrap, abe_poly = new_poly_id
475                       , abe_mono = zonkIdOcc env mono_id, abe_prags = new_prags })
476
477 zonkSpecPrags :: ZonkEnv -> TcSpecPrags -> TcM TcSpecPrags
478 zonkSpecPrags _   IsDefaultMethod = return IsDefaultMethod
479 zonkSpecPrags env (SpecPrags ps)  = do { ps' <- zonkLTcSpecPrags env ps
480                                        ; return (SpecPrags ps') }
481
482 zonkLTcSpecPrags :: ZonkEnv -> [LTcSpecPrag] -> TcM [LTcSpecPrag]
483 zonkLTcSpecPrags env ps
484   = mapM zonk_prag ps
485   where
486     zonk_prag (L loc (SpecPrag id co_fn inl))
487         = do { (_, co_fn') <- zonkCoFn env co_fn
488              ; return (L loc (SpecPrag (zonkIdOcc env id) co_fn' inl)) }
489 \end{code}
490
491 %************************************************************************
492 %*                                                                      *
493 \subsection[BackSubst-Match-GRHSs]{Match and GRHSs}
494 %*                                                                      *
495 %************************************************************************
496
497 \begin{code}
498 zonkMatchGroup :: ZonkEnv -> MatchGroup TcId-> TcM (MatchGroup Id)
499 zonkMatchGroup env (MatchGroup ms ty) 
500   = do  { ms' <- mapM (zonkMatch env) ms
501         ; ty' <- zonkTcTypeToType env ty
502         ; return (MatchGroup ms' ty') }
503
504 zonkMatch :: ZonkEnv -> LMatch TcId-> TcM (LMatch Id)
505 zonkMatch env (L loc (Match pats _ grhss))
506   = do  { (env1, new_pats) <- zonkPats env pats
507         ; new_grhss <- zonkGRHSs env1 grhss
508         ; return (L loc (Match new_pats Nothing new_grhss)) }
509
510 -------------------------------------------------------------------------
511 zonkGRHSs :: ZonkEnv -> GRHSs TcId -> TcM (GRHSs Id)
512
513 zonkGRHSs env (GRHSs grhss binds)
514   = zonkLocalBinds env binds    `thenM` \ (new_env, new_binds) ->
515     let
516         zonk_grhs (GRHS guarded rhs)
517           = zonkStmts new_env guarded   `thenM` \ (env2, new_guarded) ->
518             zonkLExpr env2 rhs          `thenM` \ new_rhs ->
519             returnM (GRHS new_guarded new_rhs)
520     in
521     mappM (wrapLocM zonk_grhs) grhss    `thenM` \ new_grhss ->
522     returnM (GRHSs new_grhss new_binds)
523 \end{code}
524
525 %************************************************************************
526 %*                                                                      *
527 \subsection[BackSubst-HsExpr]{Running a zonkitution over a TypeCheckedExpr}
528 %*                                                                      *
529 %************************************************************************
530
531 \begin{code}
532 zonkLExprs :: ZonkEnv -> [LHsExpr TcId] -> TcM [LHsExpr Id]
533 zonkLExpr  :: ZonkEnv -> LHsExpr TcId   -> TcM (LHsExpr Id)
534 zonkExpr   :: ZonkEnv -> HsExpr TcId    -> TcM (HsExpr Id)
535
536 zonkLExprs env exprs = mappM (zonkLExpr env) exprs
537 zonkLExpr  env expr  = wrapLocM (zonkExpr env) expr
538
539 zonkExpr env (HsVar id)
540   = returnM (HsVar (zonkIdOcc env id))
541
542 zonkExpr _ (HsIPVar id)
543   = returnM (HsIPVar id)
544
545 zonkExpr env (HsLit (HsRat f ty))
546   = zonkTcTypeToType env ty        `thenM` \ new_ty  ->
547     returnM (HsLit (HsRat f new_ty))
548
549 zonkExpr _ (HsLit lit)
550   = returnM (HsLit lit)
551
552 zonkExpr env (HsOverLit lit)
553   = do  { lit' <- zonkOverLit env lit
554         ; return (HsOverLit lit') }
555
556 zonkExpr env (HsLam matches)
557   = zonkMatchGroup env matches  `thenM` \ new_matches ->
558     returnM (HsLam new_matches)
559
560 zonkExpr env (HsLamCase arg matches)
561   = zonkTcTypeToType env arg    `thenM` \ new_arg ->
562     zonkMatchGroup env matches  `thenM` \ new_matches ->
563     returnM (HsLamCase new_arg new_matches)
564
565 zonkExpr env (HsApp e1 e2)
566   = zonkLExpr env e1    `thenM` \ new_e1 ->
567     zonkLExpr env e2    `thenM` \ new_e2 ->
568     returnM (HsApp new_e1 new_e2)
569
570 zonkExpr env (HsBracketOut body bs) 
571   = mappM zonk_b bs     `thenM` \ bs' ->
572     returnM (HsBracketOut body bs')
573   where
574     zonk_b (n,e) = zonkLExpr env e      `thenM` \ e' ->
575                    returnM (n,e')
576
577 zonkExpr _ (HsSpliceE s) = WARN( True, ppr s ) -- Should not happen
578                              returnM (HsSpliceE s)
579
580 zonkExpr env (OpApp e1 op fixity e2)
581   = zonkLExpr env e1    `thenM` \ new_e1 ->
582     zonkLExpr env op    `thenM` \ new_op ->
583     zonkLExpr env e2    `thenM` \ new_e2 ->
584     returnM (OpApp new_e1 new_op fixity new_e2)
585
586 zonkExpr env (NegApp expr op)
587   = zonkLExpr env expr  `thenM` \ new_expr ->
588     zonkExpr env op     `thenM` \ new_op ->
589     returnM (NegApp new_expr new_op)
590
591 zonkExpr env (HsPar e)    
592   = zonkLExpr env e     `thenM` \new_e ->
593     returnM (HsPar new_e)
594
595 zonkExpr env (SectionL expr op)
596   = zonkLExpr env expr  `thenM` \ new_expr ->
597     zonkLExpr env op            `thenM` \ new_op ->
598     returnM (SectionL new_expr new_op)
599
600 zonkExpr env (SectionR op expr)
601   = zonkLExpr env op            `thenM` \ new_op ->
602     zonkLExpr env expr          `thenM` \ new_expr ->
603     returnM (SectionR new_op new_expr)
604
605 zonkExpr env (ExplicitTuple tup_args boxed)
606   = do { new_tup_args <- mapM zonk_tup_arg tup_args
607        ; return (ExplicitTuple new_tup_args boxed) }
608   where
609     zonk_tup_arg (Present e) = do { e' <- zonkLExpr env e; return (Present e') }
610     zonk_tup_arg (Missing t) = do { t' <- zonkTcTypeToType env t; return (Missing t') }
611
612 zonkExpr env (HsCase expr ms)
613   = zonkLExpr env expr          `thenM` \ new_expr ->
614     zonkMatchGroup env ms       `thenM` \ new_ms ->
615     returnM (HsCase new_expr new_ms)
616
617 zonkExpr env (HsIf e0 e1 e2 e3)
618   = do { new_e0 <- fmapMaybeM (zonkExpr env) e0
619        ; new_e1 <- zonkLExpr env e1
620        ; new_e2 <- zonkLExpr env e2
621        ; new_e3 <- zonkLExpr env e3
622        ; returnM (HsIf new_e0 new_e1 new_e2 new_e3) }
623
624 zonkExpr env (HsMultiIf ty alts)
625   = do { alts' <- mapM (wrapLocM zonk_alt) alts
626        ; ty'   <- zonkTcTypeToType env ty
627        ; returnM $ HsMultiIf ty' alts' }
628   where zonk_alt (GRHS guard expr)
629           = do { (env', guard') <- zonkStmts env guard
630                ; expr'          <- zonkLExpr env' expr
631                ; returnM $ GRHS guard' expr' }
632
633 zonkExpr env (HsLet binds expr)
634   = zonkLocalBinds env binds    `thenM` \ (new_env, new_binds) ->
635     zonkLExpr new_env expr      `thenM` \ new_expr ->
636     returnM (HsLet new_binds new_expr)
637
638 zonkExpr env (HsDo do_or_lc stmts ty)
639   = zonkStmts env stmts         `thenM` \ (_, new_stmts) ->
640     zonkTcTypeToType env ty     `thenM` \ new_ty   ->
641     returnM (HsDo do_or_lc new_stmts new_ty)
642
643 zonkExpr env (ExplicitList ty exprs)
644   = zonkTcTypeToType env ty     `thenM` \ new_ty ->
645     zonkLExprs env exprs        `thenM` \ new_exprs ->
646     returnM (ExplicitList new_ty new_exprs)
647
648 zonkExpr env (ExplicitPArr ty exprs)
649   = zonkTcTypeToType env ty     `thenM` \ new_ty ->
650     zonkLExprs env exprs        `thenM` \ new_exprs ->
651     returnM (ExplicitPArr new_ty new_exprs)
652
653 zonkExpr env (RecordCon data_con con_expr rbinds)
654   = do  { new_con_expr <- zonkExpr env con_expr
655         ; new_rbinds   <- zonkRecFields env rbinds
656         ; return (RecordCon data_con new_con_expr new_rbinds) }
657
658 zonkExpr env (RecordUpd expr rbinds cons in_tys out_tys)
659   = do  { new_expr    <- zonkLExpr env expr
660         ; new_in_tys  <- mapM (zonkTcTypeToType env) in_tys
661         ; new_out_tys <- mapM (zonkTcTypeToType env) out_tys
662         ; new_rbinds  <- zonkRecFields env rbinds
663         ; return (RecordUpd new_expr new_rbinds cons new_in_tys new_out_tys) }
664
665 zonkExpr env (ExprWithTySigOut e ty) 
666   = do { e' <- zonkLExpr env e
667        ; return (ExprWithTySigOut e' ty) }
668
669 zonkExpr _ (ExprWithTySig _ _) = panic "zonkExpr env:ExprWithTySig"
670
671 zonkExpr env (ArithSeq expr info)
672   = zonkExpr env expr           `thenM` \ new_expr ->
673     zonkArithSeq env info       `thenM` \ new_info ->
674     returnM (ArithSeq new_expr new_info)
675
676 zonkExpr env (PArrSeq expr info)
677   = zonkExpr env expr           `thenM` \ new_expr ->
678     zonkArithSeq env info       `thenM` \ new_info ->
679     returnM (PArrSeq new_expr new_info)
680
681 zonkExpr env (HsSCC lbl expr)
682   = zonkLExpr env expr  `thenM` \ new_expr ->
683     returnM (HsSCC lbl new_expr)
684
685 zonkExpr env (HsTickPragma info expr)
686   = zonkLExpr env expr  `thenM` \ new_expr ->
687     returnM (HsTickPragma info new_expr)
688
689 -- hdaume: core annotations
690 zonkExpr env (HsCoreAnn lbl expr)
691   = zonkLExpr env expr   `thenM` \ new_expr ->
692     returnM (HsCoreAnn lbl new_expr)
693
694 -- arrow notation extensions
695 zonkExpr env (HsProc pat body)
696   = do  { (env1, new_pat) <- zonkPat env pat
697         ; new_body <- zonkCmdTop env1 body
698         ; return (HsProc new_pat new_body) }
699
700 zonkExpr env (HsArrApp e1 e2 ty ho rl)
701   = zonkLExpr env e1                    `thenM` \ new_e1 ->
702     zonkLExpr env e2                    `thenM` \ new_e2 ->
703     zonkTcTypeToType env ty             `thenM` \ new_ty ->
704     returnM (HsArrApp new_e1 new_e2 new_ty ho rl)
705
706 zonkExpr env (HsArrForm op fixity args)
707   = zonkLExpr env op                    `thenM` \ new_op ->
708     mappM (zonkCmdTop env) args         `thenM` \ new_args ->
709     returnM (HsArrForm new_op fixity new_args)
710
711 zonkExpr env (HsWrap co_fn expr)
712   = zonkCoFn env co_fn  `thenM` \ (env1, new_co_fn) ->
713     zonkExpr env1 expr  `thenM` \ new_expr ->
714     return (HsWrap new_co_fn new_expr)
715
716 zonkExpr _ HsHole
717   = return HsHole
718
719 zonkExpr _ expr = pprPanic "zonkExpr" (ppr expr)
720
721 zonkCmdTop :: ZonkEnv -> LHsCmdTop TcId -> TcM (LHsCmdTop Id)
722 zonkCmdTop env cmd = wrapLocM (zonk_cmd_top env) cmd
723
724 zonk_cmd_top :: ZonkEnv -> HsCmdTop TcId -> TcM (HsCmdTop Id)
725 zonk_cmd_top env (HsCmdTop cmd stack_tys ty ids)
726   = zonkLExpr env cmd                   `thenM` \ new_cmd ->
727     zonkTcTypeToTypes env stack_tys     `thenM` \ new_stack_tys ->
728     zonkTcTypeToType env ty             `thenM` \ new_ty ->
729     mapSndM (zonkExpr env) ids          `thenM` \ new_ids ->
730     returnM (HsCmdTop new_cmd new_stack_tys new_ty new_ids)
731
732 -------------------------------------------------------------------------
733 zonkCoFn :: ZonkEnv -> HsWrapper -> TcM (ZonkEnv, HsWrapper)
734 zonkCoFn env WpHole   = return (env, WpHole)
735 zonkCoFn env (WpCompose c1 c2) = do { (env1, c1') <- zonkCoFn env c1
736                                     ; (env2, c2') <- zonkCoFn env1 c2
737                                     ; return (env2, WpCompose c1' c2') }
738 zonkCoFn env (WpCast co) = do { co' <- zonkTcLCoToLCo env co
739                               ; return (env, WpCast co') }
740 zonkCoFn env (WpEvLam ev)   = do { (env', ev') <- zonkEvBndrX env ev
741                                  ; return (env', WpEvLam ev') }
742 zonkCoFn env (WpEvApp arg)  = do { arg' <- zonkEvTerm env arg 
743                                  ; return (env, WpEvApp arg') }
744 zonkCoFn env (WpTyLam tv)   = ASSERT( isImmutableTyVar tv )
745                               do { (env', tv') <- zonkTyBndrX env tv
746                                  ; return (env', WpTyLam tv') }
747 zonkCoFn env (WpTyApp ty)   = do { ty' <- zonkTcTypeToType env ty
748                                  ; return (env, WpTyApp ty') }
749 zonkCoFn env (WpLet bs)     = do { (env1, bs') <- zonkTcEvBinds env bs
750                                  ; return (env1, WpLet bs') }
751
752 -------------------------------------------------------------------------
753 zonkOverLit :: ZonkEnv -> HsOverLit TcId -> TcM (HsOverLit Id)
754 zonkOverLit env lit@(OverLit { ol_witness = e, ol_type = ty })
755   = do  { ty' <- zonkTcTypeToType env ty
756         ; e' <- zonkExpr env e
757         ; return (lit { ol_witness = e', ol_type = ty' }) }
758
759 -------------------------------------------------------------------------
760 zonkArithSeq :: ZonkEnv -> ArithSeqInfo TcId -> TcM (ArithSeqInfo Id)
761
762 zonkArithSeq env (From e)
763   = zonkLExpr env e             `thenM` \ new_e ->
764     returnM (From new_e)
765
766 zonkArithSeq env (FromThen e1 e2)
767   = zonkLExpr env e1    `thenM` \ new_e1 ->
768     zonkLExpr env e2    `thenM` \ new_e2 ->
769     returnM (FromThen new_e1 new_e2)
770
771 zonkArithSeq env (FromTo e1 e2)
772   = zonkLExpr env e1    `thenM` \ new_e1 ->
773     zonkLExpr env e2    `thenM` \ new_e2 ->
774     returnM (FromTo new_e1 new_e2)
775
776 zonkArithSeq env (FromThenTo e1 e2 e3)
777   = zonkLExpr env e1    `thenM` \ new_e1 ->
778     zonkLExpr env e2    `thenM` \ new_e2 ->
779     zonkLExpr env e3    `thenM` \ new_e3 ->
780     returnM (FromThenTo new_e1 new_e2 new_e3)
781
782
783 -------------------------------------------------------------------------
784 zonkStmts :: ZonkEnv -> [LStmt TcId] -> TcM (ZonkEnv, [LStmt Id])
785 zonkStmts env []     = return (env, [])
786 zonkStmts env (s:ss) = do { (env1, s')  <- wrapLocSndM (zonkStmt env) s
787                           ; (env2, ss') <- zonkStmts env1 ss
788                           ; return (env2, s' : ss') }
789
790 zonkStmt :: ZonkEnv -> Stmt TcId -> TcM (ZonkEnv, Stmt Id)
791 zonkStmt env (ParStmt stmts_w_bndrs mzip_op bind_op)
792   = do { new_stmts_w_bndrs <- mapM zonk_branch stmts_w_bndrs
793        ; let new_binders = [b | ParStmtBlock _ bs _ <- new_stmts_w_bndrs, b <- bs]
794              env1 = extendIdZonkEnv env new_binders
795        ; new_mzip <- zonkExpr env1 mzip_op
796        ; new_bind <- zonkExpr env1 bind_op
797        ; return (env1, ParStmt new_stmts_w_bndrs new_mzip new_bind) }
798   where
799     zonk_branch (ParStmtBlock stmts bndrs return_op) 
800        = do { (env1, new_stmts) <- zonkStmts env stmts
801             ; new_return <- zonkExpr env1 return_op
802             ; return (ParStmtBlock new_stmts (zonkIdOccs env1 bndrs) new_return) }
803
804 zonkStmt env (RecStmt { recS_stmts = segStmts, recS_later_ids = lvs, recS_rec_ids = rvs
805                       , recS_ret_fn = ret_id, recS_mfix_fn = mfix_id, recS_bind_fn = bind_id
806                       , recS_later_rets = later_rets, recS_rec_rets = rec_rets
807                       , recS_ret_ty = ret_ty })
808   = do { new_rvs <- zonkIdBndrs env rvs
809        ; new_lvs <- zonkIdBndrs env lvs
810        ; new_ret_ty  <- zonkTcTypeToType env ret_ty
811        ; new_ret_id  <- zonkExpr env ret_id
812        ; new_mfix_id <- zonkExpr env mfix_id
813        ; new_bind_id <- zonkExpr env bind_id
814        ; let env1 = extendIdZonkEnv env new_rvs
815        ; (env2, new_segStmts) <- zonkStmts env1 segStmts
816         -- Zonk the ret-expressions in an envt that 
817         -- has the polymorphic bindings in the envt
818        ; new_later_rets <- mapM (zonkExpr env2) later_rets
819        ; new_rec_rets <- mapM (zonkExpr env2) rec_rets
820        ; return (extendIdZonkEnv env new_lvs,     -- Only the lvs are needed
821                  RecStmt { recS_stmts = new_segStmts, recS_later_ids = new_lvs
822                          , recS_rec_ids = new_rvs, recS_ret_fn = new_ret_id
823                          , recS_mfix_fn = new_mfix_id, recS_bind_fn = new_bind_id
824                          , recS_later_rets = new_later_rets
825                          , recS_rec_rets = new_rec_rets, recS_ret_ty = new_ret_ty }) }
826
827 zonkStmt env (ExprStmt expr then_op guard_op ty)
828   = zonkLExpr env expr          `thenM` \ new_expr ->
829     zonkExpr env then_op        `thenM` \ new_then ->
830     zonkExpr env guard_op       `thenM` \ new_guard ->
831     zonkTcTypeToType env ty     `thenM` \ new_ty ->
832     returnM (env, ExprStmt new_expr new_then new_guard new_ty)
833
834 zonkStmt env (LastStmt expr ret_op)
835   = zonkLExpr env expr          `thenM` \ new_expr ->
836     zonkExpr env ret_op         `thenM` \ new_ret ->
837     returnM (env, LastStmt new_expr new_ret)
838
839 zonkStmt env (TransStmt { trS_stmts = stmts, trS_bndrs = binderMap
840                         , trS_by = by, trS_form = form, trS_using = using
841                         , trS_ret = return_op, trS_bind = bind_op, trS_fmap = liftM_op })
842   = do { (env', stmts') <- zonkStmts env stmts 
843     ; binderMap' <- mappM (zonkBinderMapEntry env') binderMap
844     ; by'        <- fmapMaybeM (zonkLExpr env') by
845     ; using'     <- zonkLExpr env using
846     ; return_op' <- zonkExpr env' return_op
847     ; bind_op'   <- zonkExpr env' bind_op
848     ; liftM_op'  <- zonkExpr env' liftM_op
849     ; let env'' = extendIdZonkEnv env' (map snd binderMap')
850     ; return (env'', TransStmt { trS_stmts = stmts', trS_bndrs = binderMap'
851                                , trS_by = by', trS_form = form, trS_using = using'
852                                , trS_ret = return_op', trS_bind = bind_op', trS_fmap = liftM_op' }) }
853   where
854     zonkBinderMapEntry env (oldBinder, newBinder) = do 
855         let oldBinder' = zonkIdOcc env oldBinder
856         newBinder' <- zonkIdBndr env newBinder
857         return (oldBinder', newBinder') 
858
859 zonkStmt env (LetStmt binds)
860   = zonkLocalBinds env binds    `thenM` \ (env1, new_binds) ->
861     returnM (env1, LetStmt new_binds)
862
863 zonkStmt env (BindStmt pat expr bind_op fail_op)
864   = do  { new_expr <- zonkLExpr env expr
865         ; (env1, new_pat) <- zonkPat env pat
866         ; new_bind <- zonkExpr env bind_op
867         ; new_fail <- zonkExpr env fail_op
868         ; return (env1, BindStmt new_pat new_expr new_bind new_fail) }
869
870 -------------------------------------------------------------------------
871 zonkRecFields :: ZonkEnv -> HsRecordBinds TcId -> TcM (HsRecordBinds TcId)
872 zonkRecFields env (HsRecFields flds dd)
873   = do  { flds' <- mappM zonk_rbind flds
874         ; return (HsRecFields flds' dd) }
875   where
876     zonk_rbind fld
877       = do { new_id   <- wrapLocM (zonkIdBndr env) (hsRecFieldId fld)
878            ; new_expr <- zonkLExpr env (hsRecFieldArg fld)
879            ; return (fld { hsRecFieldId = new_id, hsRecFieldArg = new_expr }) }
880
881 -------------------------------------------------------------------------
882 mapIPNameTc :: (a -> TcM b) -> Either HsIPName a -> TcM (Either HsIPName b)
883 mapIPNameTc _ (Left x)  = returnM (Left x)
884 mapIPNameTc f (Right x) = f x  `thenM` \ r -> returnM (Right r)
885 \end{code}
886
887
888 %************************************************************************
889 %*                                                                      *
890 \subsection[BackSubst-Pats]{Patterns}
891 %*                                                                      *
892 %************************************************************************
893
894 \begin{code}
895 zonkPat :: ZonkEnv -> OutPat TcId -> TcM (ZonkEnv, OutPat Id)
896 -- Extend the environment as we go, because it's possible for one
897 -- pattern to bind something that is used in another (inside or
898 -- to the right)
899 zonkPat env pat = wrapLocSndM (zonk_pat env) pat
900
901 zonk_pat :: ZonkEnv -> Pat TcId -> TcM (ZonkEnv, Pat Id)
902 zonk_pat env (ParPat p)
903   = do  { (env', p') <- zonkPat env p
904         ; return (env', ParPat p') }
905
906 zonk_pat env (WildPat ty)
907   = do  { ty' <- zonkTcTypeToType env ty
908         ; return (env, WildPat ty') }
909
910 zonk_pat env (VarPat v)
911   = do  { v' <- zonkIdBndr env v
912         ; return (extendIdZonkEnv1 env v', VarPat v') }
913
914 zonk_pat env (LazyPat pat)
915   = do  { (env', pat') <- zonkPat env pat
916         ; return (env',  LazyPat pat') }
917
918 zonk_pat env (BangPat pat)
919   = do  { (env', pat') <- zonkPat env pat
920         ; return (env',  BangPat pat') }
921
922 zonk_pat env (AsPat (L loc v) pat)
923   = do  { v' <- zonkIdBndr env v
924         ; (env', pat') <- zonkPat (extendIdZonkEnv1 env v') pat
925         ; return (env', AsPat (L loc v') pat') }
926
927 zonk_pat env (ViewPat expr pat ty)
928   = do  { expr' <- zonkLExpr env expr
929         ; (env', pat') <- zonkPat env pat
930         ; ty' <- zonkTcTypeToType env ty
931         ; return (env', ViewPat expr' pat' ty') }
932
933 zonk_pat env (ListPat pats ty)
934   = do  { ty' <- zonkTcTypeToType env ty
935         ; (env', pats') <- zonkPats env pats
936         ; return (env', ListPat pats' ty') }
937
938 zonk_pat env (PArrPat pats ty)
939   = do  { ty' <- zonkTcTypeToType env ty
940         ; (env', pats') <- zonkPats env pats
941         ; return (env', PArrPat pats' ty') }
942
943 zonk_pat env (TuplePat pats boxed ty)
944   = do  { ty' <- zonkTcTypeToType env ty
945         ; (env', pats') <- zonkPats env pats
946         ; return (env', TuplePat pats' boxed ty') }
947
948 zonk_pat env p@(ConPatOut { pat_ty = ty, pat_tvs = tyvars
949                           , pat_dicts = evs, pat_binds = binds
950                           , pat_args = args })
951   = ASSERT( all isImmutableTyVar tyvars ) 
952     do  { new_ty <- zonkTcTypeToType env ty
953         ; (env0, new_tyvars) <- zonkTyBndrsX env tyvars
954           -- Must zonk the existential variables, because their
955           -- /kind/ need potential zonking.
956           -- cf typecheck/should_compile/tc221.hs
957         ; (env1, new_evs) <- zonkEvBndrsX env0 evs
958         ; (env2, new_binds) <- zonkTcEvBinds env1 binds
959         ; (env', new_args) <- zonkConStuff env2 args
960         ; returnM (env', p { pat_ty = new_ty, 
961                              pat_tvs = new_tyvars,
962                              pat_dicts = new_evs, 
963                              pat_binds = new_binds, 
964                              pat_args = new_args }) }
965
966 zonk_pat env (LitPat lit) = return (env, LitPat lit)
967
968 zonk_pat env (SigPatOut pat ty)
969   = do  { ty' <- zonkTcTypeToType env ty
970         ; (env', pat') <- zonkPat env pat
971         ; return (env', SigPatOut pat' ty') }
972
973 zonk_pat env (NPat lit mb_neg eq_expr)
974   = do  { lit' <- zonkOverLit env lit
975         ; mb_neg' <- fmapMaybeM (zonkExpr env) mb_neg
976         ; eq_expr' <- zonkExpr env eq_expr
977         ; return (env, NPat lit' mb_neg' eq_expr') }
978
979 zonk_pat env (NPlusKPat (L loc n) lit e1 e2)
980   = do  { n' <- zonkIdBndr env n
981         ; lit' <- zonkOverLit env lit
982         ; e1' <- zonkExpr env e1
983         ; e2' <- zonkExpr env e2
984         ; return (extendIdZonkEnv1 env n', NPlusKPat (L loc n') lit' e1' e2') }
985
986 zonk_pat env (CoPat co_fn pat ty) 
987   = do { (env', co_fn') <- zonkCoFn env co_fn
988        ; (env'', pat') <- zonkPat env' (noLoc pat)
989        ; ty' <- zonkTcTypeToType env'' ty
990        ; return (env'', CoPat co_fn' (unLoc pat') ty') }
991
992 zonk_pat _ pat = pprPanic "zonk_pat" (ppr pat)
993
994 ---------------------------
995 zonkConStuff :: ZonkEnv
996              -> HsConDetails (OutPat TcId) (HsRecFields id (OutPat TcId))
997              -> TcM (ZonkEnv,
998                      HsConDetails (OutPat Id) (HsRecFields id (OutPat Id)))
999 zonkConStuff env (PrefixCon pats)
1000   = do  { (env', pats') <- zonkPats env pats
1001         ; return (env', PrefixCon pats') }
1002
1003 zonkConStuff env (InfixCon p1 p2)
1004   = do  { (env1, p1') <- zonkPat env  p1
1005         ; (env', p2') <- zonkPat env1 p2
1006         ; return (env', InfixCon p1' p2') }
1007
1008 zonkConStuff env (RecCon (HsRecFields rpats dd))
1009   = do  { (env', pats') <- zonkPats env (map hsRecFieldArg rpats)
1010         ; let rpats' = zipWith (\rp p' -> rp { hsRecFieldArg = p' }) rpats pats'
1011         ; returnM (env', RecCon (HsRecFields rpats' dd)) }
1012         -- Field selectors have declared types; hence no zonking
1013
1014 ---------------------------
1015 zonkPats :: ZonkEnv -> [OutPat TcId] -> TcM (ZonkEnv, [OutPat Id])
1016 zonkPats env []         = return (env, [])
1017 zonkPats env (pat:pats) = do { (env1, pat') <- zonkPat env pat
1018                      ; (env', pats') <- zonkPats env1 pats
1019                      ; return (env', pat':pats') }
1020 \end{code}
1021
1022 %************************************************************************
1023 %*                                                                      *
1024 \subsection[BackSubst-Foreign]{Foreign exports}
1025 %*                                                                      *
1026 %************************************************************************
1027
1028
1029 \begin{code}
1030 zonkForeignExports :: ZonkEnv -> [LForeignDecl TcId] -> TcM [LForeignDecl Id]
1031 zonkForeignExports env ls = mappM (wrapLocM (zonkForeignExport env)) ls
1032
1033 zonkForeignExport :: ZonkEnv -> ForeignDecl TcId -> TcM (ForeignDecl Id)
1034 zonkForeignExport env (ForeignExport i _hs_ty co spec) =
1035    returnM (ForeignExport (fmap (zonkIdOcc env) i) undefined co spec)
1036 zonkForeignExport _ for_imp 
1037   = returnM for_imp     -- Foreign imports don't need zonking
1038 \end{code}
1039
1040 \begin{code}
1041 zonkRules :: ZonkEnv -> [LRuleDecl TcId] -> TcM [LRuleDecl Id]
1042 zonkRules env rs = mappM (wrapLocM (zonkRule env)) rs
1043
1044 zonkRule :: ZonkEnv -> RuleDecl TcId -> TcM (RuleDecl Id)
1045 zonkRule env (HsRule name act (vars{-::[RuleBndr TcId]-}) lhs fv_lhs rhs fv_rhs)
1046   = do { unbound_tkv_set <- newMutVar emptyVarSet
1047        ; let env_rule = setZonkType env (zonkTvCollecting unbound_tkv_set)
1048               -- See Note [Zonking the LHS of a RULE]
1049
1050        ; (env_inside, new_bndrs) <- mapAccumLM zonk_bndr env_rule vars
1051
1052        ; new_lhs <- zonkLExpr env_inside lhs
1053        ; new_rhs <- zonkLExpr env_inside rhs
1054
1055        ; unbound_tkvs <- readMutVar unbound_tkv_set
1056
1057        ; let final_bndrs :: [RuleBndr Var]
1058              final_bndrs = map (RuleBndr . noLoc)
1059                                (varSetElemsKvsFirst unbound_tkvs)
1060                            ++ new_bndrs
1061
1062        ; return $ 
1063          HsRule name act final_bndrs new_lhs fv_lhs new_rhs fv_rhs }
1064   where
1065    zonk_bndr env (RuleBndr (L loc v)) 
1066       = do { (env', v') <- zonk_it env v
1067            ; return (env', RuleBndr (L loc v')) }
1068    zonk_bndr _ (RuleBndrSig {}) = panic "zonk_bndr RuleBndrSig"
1069
1070    zonk_it env v
1071      | isId v     = do { v' <- zonkIdBndr env v
1072                        ; return (extendIdZonkEnv1 env v', v') }
1073      | otherwise  = ASSERT( isImmutableTyVar v)
1074                     zonkTyBndrX env v
1075                     -- DV: used to be return (env,v) but that is plain 
1076                     -- wrong because we may need to go inside the kind 
1077                     -- of v and zonk there!
1078 \end{code}
1079
1080 \begin{code}
1081 zonkVects :: ZonkEnv -> [LVectDecl TcId] -> TcM [LVectDecl Id]
1082 zonkVects env = mappM (wrapLocM (zonkVect env))
1083
1084 zonkVect :: ZonkEnv -> VectDecl TcId -> TcM (VectDecl Id)
1085 zonkVect env (HsVect v e)
1086   = do { v' <- wrapLocM (zonkIdBndr env) v
1087        ; e' <- fmapMaybeM (zonkLExpr env) e
1088        ; return $ HsVect v' e'
1089        }
1090 zonkVect env (HsNoVect v)
1091   = do { v' <- wrapLocM (zonkIdBndr env) v
1092        ; return $ HsNoVect v'
1093        }
1094 zonkVect _env (HsVectTypeOut s t rt)
1095   = return $ HsVectTypeOut s t rt
1096 zonkVect _ (HsVectTypeIn _ _ _) = panic "TcHsSyn.zonkVect: HsVectTypeIn"
1097 zonkVect _env (HsVectClassOut c)
1098   = return $ HsVectClassOut c
1099 zonkVect _ (HsVectClassIn _) = panic "TcHsSyn.zonkVect: HsVectClassIn"
1100 zonkVect _env (HsVectInstOut i)
1101   = return $ HsVectInstOut i
1102 zonkVect _ (HsVectInstIn _) = panic "TcHsSyn.zonkVect: HsVectInstIn"
1103 \end{code}
1104
1105 %************************************************************************
1106 %*                                                                      *
1107               Constraints and evidence
1108 %*                                                                      *
1109 %************************************************************************
1110
1111 \begin{code}
1112 zonkEvTerm :: ZonkEnv -> EvTerm -> TcM EvTerm
1113 zonkEvTerm env (EvId v)           = ASSERT2( isId v, ppr v ) 
1114                                     return (EvId (zonkIdOcc env v))
1115 zonkEvTerm env (EvCoercion co)    = do { co' <- zonkTcLCoToLCo env co
1116                                        ; return (EvCoercion co') }
1117 zonkEvTerm env (EvCast tm co)     = do { tm' <- zonkEvTerm env tm
1118                                        ; co' <- zonkTcLCoToLCo env co
1119                                        ; return (mkEvCast tm' co') }
1120
1121 zonkEvTerm env (EvKindCast v co)  = do { v'  <- zonkEvTerm env v
1122                                        ; co' <- zonkTcLCoToLCo env co
1123                                        ; return (mkEvKindCast v' co') }
1124
1125 zonkEvTerm env (EvTupleSel tm n)  = do { tm' <- zonkEvTerm env tm
1126                                        ; return (EvTupleSel tm' n) }
1127 zonkEvTerm env (EvTupleMk tms)    = do { tms' <- mapM (zonkEvTerm env) tms
1128                                        ; return (EvTupleMk tms') }
1129 zonkEvTerm _   (EvLit l)          = return (EvLit l)
1130 zonkEvTerm env (EvSuperClass d n) = do { d' <- zonkEvTerm env d
1131                                        ; return (EvSuperClass d' n) }
1132 zonkEvTerm env (EvDFunApp df tys tms)
1133   = do { tys' <- zonkTcTypeToTypes env tys
1134        ; tms' <- mapM (zonkEvTerm env) tms
1135        ; return (EvDFunApp (zonkIdOcc env df) tys' tms') }
1136 zonkEvTerm env (EvDelayedError ty msg)
1137   = do { ty' <- zonkTcTypeToType env ty
1138        ; return (EvDelayedError ty' msg) }
1139
1140 zonkTcEvBinds :: ZonkEnv -> TcEvBinds -> TcM (ZonkEnv, TcEvBinds)
1141 zonkTcEvBinds env (TcEvBinds var) = do { (env', bs') <- zonkEvBindsVar env var
1142                                        ; return (env', EvBinds bs') }
1143 zonkTcEvBinds env (EvBinds bs)    = do { (env', bs') <- zonkEvBinds env bs
1144                                        ; return (env', EvBinds bs') }
1145
1146 zonkEvBindsVar :: ZonkEnv -> EvBindsVar -> TcM (ZonkEnv, Bag EvBind)
1147 zonkEvBindsVar env (EvBindsVar ref _) = do { bs <- readMutVar ref
1148                                            ; zonkEvBinds env (evBindMapBinds bs) }
1149
1150 zonkEvBinds :: ZonkEnv -> Bag EvBind -> TcM (ZonkEnv, Bag EvBind)
1151 zonkEvBinds env binds
1152   = {-# SCC "zonkEvBinds" #-}
1153     fixM (\ ~( _, new_binds) -> do
1154          { let env1 = extendIdZonkEnv env (collect_ev_bndrs new_binds)
1155          ; binds' <- mapBagM (zonkEvBind env1) binds
1156          ; return (env1, binds') })
1157   where
1158     collect_ev_bndrs :: Bag EvBind -> [EvVar]
1159     collect_ev_bndrs = foldrBag add [] 
1160     add (EvBind var _) vars = var : vars
1161
1162 zonkEvBind :: ZonkEnv -> EvBind -> TcM EvBind
1163 zonkEvBind env (EvBind var term)
1164   = case term of 
1165       -- Special-case fast paths for small coercions
1166       -- NB: could be optimized further! (e.g. SymCo cv)
1167       -- See Note [Optimized Evidence Binding Zonking]
1168       EvCoercion co 
1169         | Just ty <- isTcReflCo_maybe co
1170         -> do { zty  <- zonkTcTypeToType env ty
1171               ; let var' = setVarType var (mkEqPred zty zty)
1172                   -- Here we save the task of zonking var's type, 
1173                   -- because we know just what it is!
1174               ; return (EvBind var' (EvCoercion (mkTcReflCo zty))) }
1175
1176         | Just cv <- getTcCoVar_maybe co 
1177         -> do { let cv'   = zonkIdOcc env cv -- Just lazily look up
1178                     term' = EvCoercion (TcCoVarCo cv')
1179                     var'  = setVarType var (varType cv')
1180               ; return (EvBind var' term') }
1181
1182       -- The default path
1183       _ -> do { var'  <- {-# SCC "zonkEvBndr" #-} zonkEvBndr env var
1184               ; term' <- zonkEvTerm env term 
1185               ; return (EvBind var' term')
1186               }
1187 \end{code}
1188
1189 %************************************************************************
1190 %*                                                                      *
1191                          Zonking types
1192 %*                                                                      *
1193 %************************************************************************
1194
1195 Note [Zonking the LHS of a RULE]
1196 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1197 We need to gather the type variables mentioned on the LHS so we can 
1198 quantify over them.  Example:
1199   data T a = C
1200
1201   foo :: T a -> Int
1202   foo C = 1
1203
1204   {-# RULES "myrule"  foo C = 1 #-}
1205
1206 After type checking the LHS becomes (foo a (C a))
1207 and we do not want to zap the unbound tyvar 'a' to (), because
1208 that limits the applicability of the rule.  Instead, we
1209 want to quantify over it!  
1210
1211 It's easiest to get zonkTvCollecting to gather the free tyvars
1212 here. Attempts to do so earlier are tiresome, because (a) the data
1213 type is big and (b) finding the free type vars of an expression is
1214 necessarily monadic operation. (consider /\a -> f @ b, where b is
1215 side-effected to a)
1216
1217 And that in turn is why ZonkEnv carries the function to use for
1218 type variables!
1219
1220 Note [Zonking mutable unbound type or kind variables]
1221 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1222 In zonkTypeZapping, we zonk mutable but unbound type or kind variables to an
1223 arbitrary type. We know if they are unbound even though we don't carry an
1224 environment, because at the binding site for a variable we bind the mutable
1225 var to a fresh immutable one.  So the mutable store plays the role of an
1226 environment.  If we come across a mutable variable that isn't so bound, it
1227 must be completely free. We zonk the expected kind to make sure we don't get
1228 some unbound meta variable as the kind.
1229
1230 Note that since we have kind polymorphism, zonk_unbound_tyvar will handle both
1231 type and kind variables. Consider the following datatype:
1232
1233   data Phantom a = Phantom Int
1234
1235 The type of Phantom is (forall (k : BOX). forall (a : k). Int). Both `a` and
1236 `k` are unbound variables. We want to zonk this to
1237 (forall (k : AnyK). forall (a : Any AnyK). Int). For that we have to check if
1238 we have a type or a kind variable; for kind variables we just return AnyK (and
1239 not the ill-kinded Any BOX).
1240
1241 Note [Optimized Evidence Binding Zonking]
1242 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1243 When optimising evidence binds we may come across situations where 
1244 a coercion looks like
1245       cv = ReflCo ty
1246 or    cv1 = cv2
1247 where the type 'ty' is big.  In such cases it is a waste of time to zonk both 
1248   * The variable on the LHS
1249   * The coercion on the RHS
1250 Rather, we can zonk the coercion, take its type and use that for 
1251 the variable.  For big coercions this might be a lose, though, so we
1252 just have a fast case for a couple of special cases.
1253
1254
1255 \begin{code}
1256 zonkTyVarOcc :: ZonkEnv -> TyVar -> TcM TcType
1257 zonkTyVarOcc env@(ZonkEnv zonk_unbound_tyvar tv_env _) tv
1258   | isTcTyVar tv
1259   = case tcTyVarDetails tv of
1260          SkolemTv {}    -> lookup_in_env
1261          RuntimeUnk {}  -> lookup_in_env
1262          FlatSkol ty    -> zonkTcTypeToType env ty
1263          MetaTv { mtv_ref = ref }  
1264            -> do { cts <- readMutVar ref
1265                  ; case cts of    
1266                       Flexi -> do { kind <- {-# SCC "zonkKind1" #-}
1267                                             zonkTcTypeToType env (tyVarKind tv)
1268                                   ; zonk_unbound_tyvar (setTyVarKind tv kind) }
1269                       Indirect ty -> do { zty <- zonkTcTypeToType env ty 
1270                                         -- Small optimisation: shortern-out indirect steps
1271                                         -- so that the old type may be more easily collected.
1272                                         ; writeMutVar ref (Indirect zty)
1273                                         ; return zty } }
1274   | otherwise
1275   = lookup_in_env
1276   where
1277     lookup_in_env    -- Look up in the env just as we do for Ids
1278       = case lookupVarEnv tv_env tv of
1279           Nothing  -> return (mkTyVarTy tv)
1280           Just tv' -> return (mkTyVarTy tv')
1281
1282 zonkTcTypeToType :: ZonkEnv -> TcType -> TcM Type
1283 zonkTcTypeToType env ty
1284   = go ty
1285   where
1286     go (TyConApp tc tys) = do tys' <- mapM go tys
1287                               return (TyConApp tc tys')
1288
1289     go (LitTy n)         = return (LitTy n)
1290
1291     go (FunTy arg res)   = do arg' <- go arg
1292                               res' <- go res
1293                               return (FunTy arg' res')
1294
1295     go (AppTy fun arg)   = do fun' <- go fun
1296                               arg' <- go arg
1297                               return (mkAppTy fun' arg')
1298                 -- NB the mkAppTy; we might have instantiated a
1299                 -- type variable to a type constructor, so we need
1300                 -- to pull the TyConApp to the top.
1301
1302         -- The two interesting cases!
1303     go (TyVarTy tv) = zonkTyVarOcc env tv
1304
1305     go (ForAllTy tv ty) = ASSERT( isImmutableTyVar tv ) do
1306                           do { (env', tv') <- zonkTyBndrX env tv
1307                              ; ty' <- zonkTcTypeToType env' ty
1308                              ; return (ForAllTy tv' ty') }
1309
1310 zonkTcTypeToTypes :: ZonkEnv -> [TcType] -> TcM [Type]
1311 zonkTcTypeToTypes env tys = mapM (zonkTcTypeToType env) tys
1312
1313 zonkTvCollecting :: TcRef TyVarSet -> UnboundTyVarZonker
1314 -- This variant collects unbound type variables in a mutable variable
1315 -- Works on both types and kinds
1316 zonkTvCollecting unbound_tv_set tv
1317   = do { poly_kinds <- xoptM Opt_PolyKinds
1318        ; if isKindVar tv && not poly_kinds then defaultKindVarToStar tv
1319          else do
1320        { tv' <- zonkQuantifiedTyVar tv
1321        ; tv_set <- readMutVar unbound_tv_set
1322        ; writeMutVar unbound_tv_set (extendVarSet tv_set tv')
1323        ; return (mkTyVarTy tv') } }
1324
1325 zonkTypeZapping :: UnboundTyVarZonker
1326 -- This variant is used for everything except the LHS of rules
1327 -- It zaps unbound type variables to (), or some other arbitrary type
1328 -- Works on both types and kinds
1329 zonkTypeZapping tv
1330   = do { let ty = if isKindVar tv
1331                   -- ty is actually a kind, zonk to AnyK
1332                   then anyKind
1333                   else anyTypeOfKind (defaultKind (tyVarKind tv))
1334        ; writeMetaTyVar tv ty
1335        ; return ty }
1336
1337
1338 zonkTcLCoToLCo :: ZonkEnv -> TcCoercion -> TcM TcCoercion
1339 -- NB: zonking often reveals that the coercion is an identity
1340 --     in which case the Refl-ness can propagate up to the top
1341 --     which in turn gives more efficient desugaring.  So it's
1342 --     worth using the 'mk' smart constructors on the RHS
1343 zonkTcLCoToLCo env co
1344   = go co
1345   where
1346     go (TcLetCo bs co)        = do { (env', bs') <- zonkTcEvBinds env bs
1347                                    ; co' <- zonkTcLCoToLCo env' co
1348                                    ; return (TcLetCo bs' co') }
1349     go (TcCoVarCo cv)         = return (mkTcCoVarCo (zonkEvVarOcc env cv))
1350     go (TcRefl ty)            = do { ty' <- zonkTcTypeToType env ty
1351                                    ; return (TcRefl ty') }
1352     go (TcTyConAppCo tc cos)  = do { cos' <- mapM go cos; return (mkTcTyConAppCo tc cos') }
1353     go (TcAxiomInstCo ax tys) = do { tys' <- zonkTcTypeToTypes env tys; return (TcAxiomInstCo ax tys') }
1354     go (TcAppCo co1 co2)      = do { co1' <- go co1; co2' <- go co2
1355                                    ; return (mkTcAppCo co1' co2') }
1356     go (TcCastCo co1 co2)     = do { co1' <- go co1; co2' <- go co2
1357                                    ; return (TcCastCo co1' co2') }
1358     go (TcSymCo co)           = do { co' <- go co; return (mkTcSymCo co')  }
1359     go (TcNthCo n co)         = do { co' <- go co; return (mkTcNthCo n co')  }
1360     go (TcLRCo lr co)         = do { co' <- go co; return (mkTcLRCo lr co')  }
1361     go (TcTransCo co1 co2)    = do { co1' <- go co1; co2' <- go co2
1362                                    ; return (mkTcTransCo co1' co2')  }
1363     go (TcForAllCo tv co)     = ASSERT( isImmutableTyVar tv )
1364                                 do { co' <- go co; return (mkTcForAllCo tv co') }
1365     go (TcInstCo co ty)       = do { co' <- go co; ty' <- zonkTcTypeToType env ty; return (TcInstCo co' ty') }
1366 \end{code}