Inline implication constraints
[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 -w #-}
13 -- The above warning supression flag is a temporary kludge.
14 -- While working on this module you are encouraged to remove it and fix
15 -- any warnings in the module. See
16 --     http://hackage.haskell.org/trac/ghc/wiki/Commentary/CodingStyle#Warnings
17 -- for details
18
19 module TcHsSyn (
20         mkHsConApp, mkHsDictLet, mkHsApp,
21         hsLitType, hsLPatType, hsPatType, 
22         mkHsAppTy, mkSimpleHsAlt,
23         nlHsIntLit, mkVanillaTuplePat,
24         
25         mkArbitraryType,        -- Put this elsewhere?
26
27         -- re-exported from TcMonad
28         TcId, TcIdSet, TcDictBinds,
29
30         zonkTopDecls, zonkTopExpr, zonkTopLExpr,
31         zonkId, zonkTopBndrs
32   ) where
33
34 #include "HsVersions.h"
35
36 -- friends:
37 import HsSyn    -- oodles of it
38
39 -- others:
40 import Id
41
42 import TcRnMonad
43 import Type
44 import TcType
45 import TcMType
46 import TysPrim
47 import TysWiredIn
48 import TyCon
49 import Name
50 import Var
51 import VarSet
52 import VarEnv
53 import BasicTypes
54 import Maybes
55 import Unique
56 import SrcLoc
57 import Util
58 import Bag
59 import Outputable
60 \end{code}
61
62
63 %************************************************************************
64 %*                                                                      *
65 \subsection[mkFailurePair]{Code for pattern-matching and other failures}
66 %*                                                                      *
67 %************************************************************************
68
69 Note: If @hsLPatType@ doesn't bear a strong resemblance to @exprType@,
70 then something is wrong.
71 \begin{code}
72 mkVanillaTuplePat :: [OutPat Id] -> Boxity -> Pat Id
73 -- A vanilla tuple pattern simply gets its type from its sub-patterns
74 mkVanillaTuplePat pats box 
75   = TuplePat pats box (mkTupleTy box (length pats) (map hsLPatType pats))
76
77 hsLPatType :: OutPat Id -> Type
78 hsLPatType (L _ pat) = hsPatType pat
79
80 hsPatType (ParPat pat)              = hsLPatType pat
81 hsPatType (WildPat ty)              = ty
82 hsPatType (VarPat var)              = idType var
83 hsPatType (VarPatOut var _)         = idType var
84 hsPatType (BangPat pat)             = hsLPatType pat
85 hsPatType (LazyPat pat)             = hsLPatType pat
86 hsPatType (LitPat lit)              = hsLitType lit
87 hsPatType (AsPat var pat)           = idType (unLoc var)
88 hsPatType (ViewPat expr pat ty)     = ty
89 hsPatType (ListPat _ ty)            = mkListTy ty
90 hsPatType (PArrPat _ ty)            = mkPArrTy ty
91 hsPatType (TuplePat pats box ty)    = ty
92 hsPatType (ConPatOut{ pat_ty = ty })= ty
93 hsPatType (SigPatOut pat ty)        = ty
94 hsPatType (NPat lit _ _)            = overLitType lit
95 hsPatType (NPlusKPat id _ _ _)      = idType (unLoc id)
96 hsPatType (CoPat _ _ ty)            = ty
97
98 hsLitType :: HsLit -> TcType
99 hsLitType (HsChar c)       = charTy
100 hsLitType (HsCharPrim c)   = charPrimTy
101 hsLitType (HsString str)   = stringTy
102 hsLitType (HsStringPrim s) = addrPrimTy
103 hsLitType (HsInt i)        = intTy
104 hsLitType (HsIntPrim i)    = intPrimTy
105 hsLitType (HsInteger i ty) = ty
106 hsLitType (HsRat _ ty)     = ty
107 hsLitType (HsFloatPrim f)  = floatPrimTy
108 hsLitType (HsDoublePrim d) = doublePrimTy
109 \end{code}
110
111
112 %************************************************************************
113 %*                                                                      *
114 \subsection[BackSubst-HsBinds]{Running a substitution over @HsBinds@}
115 %*                                                                      *
116 %************************************************************************
117
118 \begin{code}
119 -- zonkId is used *during* typechecking just to zonk the Id's type
120 zonkId :: TcId -> TcM TcId
121 zonkId id
122   = zonkTcType (idType id) `thenM` \ ty' ->
123     returnM (Id.setIdType id ty')
124 \end{code}
125
126 The rest of the zonking is done *after* typechecking.
127 The main zonking pass runs over the bindings
128
129  a) to convert TcTyVars to TyVars etc, dereferencing any bindings etc
130  b) convert unbound TcTyVar to Void
131  c) convert each TcId to an Id by zonking its type
132
133 The type variables are converted by binding mutable tyvars to immutable ones
134 and then zonking as normal.
135
136 The Ids are converted by binding them in the normal Tc envt; that
137 way we maintain sharing; eg an Id is zonked at its binding site and they
138 all occurrences of that Id point to the common zonked copy
139
140 It's all pretty boring stuff, because HsSyn is such a large type, and 
141 the environment manipulation is tiresome.
142
143 \begin{code}
144 data ZonkEnv = ZonkEnv  (TcType -> TcM Type)    -- How to zonk a type
145                         (IdEnv Id)              -- What variables are in scope
146         -- Maps an Id to its zonked version; both have the same Name
147         -- Is only consulted lazily; hence knot-tying
148
149 emptyZonkEnv = ZonkEnv zonkTypeZapping emptyVarEnv
150
151 extendZonkEnv :: ZonkEnv -> [Id] -> ZonkEnv
152 extendZonkEnv (ZonkEnv zonk_ty env) ids 
153   = ZonkEnv zonk_ty (extendVarEnvList env [(id,id) | id <- ids])
154
155 extendZonkEnv1 :: ZonkEnv -> Id -> ZonkEnv
156 extendZonkEnv1 (ZonkEnv zonk_ty env) id 
157   = ZonkEnv zonk_ty (extendVarEnv env id id)
158
159 setZonkType :: ZonkEnv -> (TcType -> TcM Type) -> ZonkEnv
160 setZonkType (ZonkEnv _ env) zonk_ty = ZonkEnv zonk_ty env
161
162 zonkEnvIds :: ZonkEnv -> [Id]
163 zonkEnvIds (ZonkEnv _ env) = varEnvElts env
164
165 zonkIdOcc :: ZonkEnv -> TcId -> Id
166 -- Ids defined in this module should be in the envt; 
167 -- ignore others.  (Actually, data constructors are also
168 -- not LocalVars, even when locally defined, but that is fine.)
169 -- (Also foreign-imported things aren't currently in the ZonkEnv;
170 --  that's ok because they don't need zonking.)
171 --
172 -- Actually, Template Haskell works in 'chunks' of declarations, and
173 -- an earlier chunk won't be in the 'env' that the zonking phase 
174 -- carries around.  Instead it'll be in the tcg_gbl_env, already fully
175 -- zonked.  There's no point in looking it up there (except for error 
176 -- checking), and it's not conveniently to hand; hence the simple
177 -- 'orElse' case in the LocalVar branch.
178 --
179 -- Even without template splices, in module Main, the checking of
180 -- 'main' is done as a separate chunk.
181 zonkIdOcc (ZonkEnv zonk_ty env) id 
182   | isLocalVar id = lookupVarEnv env id `orElse` id
183   | otherwise     = id
184
185 zonkIdOccs env ids = map (zonkIdOcc env) ids
186
187 -- zonkIdBndr is used *after* typechecking to get the Id's type
188 -- to its final form.  The TyVarEnv give 
189 zonkIdBndr :: ZonkEnv -> TcId -> TcM Id
190 zonkIdBndr env id
191   = zonkTcTypeToType env (idType id)    `thenM` \ ty' ->
192     returnM (Id.setIdType id ty')
193
194 zonkIdBndrs :: ZonkEnv -> [TcId] -> TcM [Id]
195 zonkIdBndrs env ids = mappM (zonkIdBndr env) ids
196
197 zonkDictBndrs :: ZonkEnv -> [Var] -> TcM [Var]
198 -- "Dictionary" binders can be coercion variables or dictionary variables
199 zonkDictBndrs env ids = mappM (zonkDictBndr env) ids
200
201 zonkDictBndr env var | isTyVar var = return var
202                      | otherwise   = zonkIdBndr env var
203
204 zonkTopBndrs :: [TcId] -> TcM [Id]
205 zonkTopBndrs ids = zonkIdBndrs emptyZonkEnv ids
206 \end{code}
207
208
209 \begin{code}
210 zonkTopExpr :: HsExpr TcId -> TcM (HsExpr Id)
211 zonkTopExpr e = zonkExpr emptyZonkEnv e
212
213 zonkTopLExpr :: LHsExpr TcId -> TcM (LHsExpr Id)
214 zonkTopLExpr e = zonkLExpr emptyZonkEnv e
215
216 zonkTopDecls :: LHsBinds TcId -> [LRuleDecl TcId] -> [LForeignDecl TcId]
217              -> TcM ([Id], 
218                      Bag (LHsBind  Id),
219                      [LForeignDecl Id],
220                      [LRuleDecl    Id])
221 zonkTopDecls binds rules fords
222   = do  { (env, binds') <- zonkRecMonoBinds emptyZonkEnv binds
223                         -- Top level is implicitly recursive
224         ; rules' <- zonkRules env rules
225         ; fords' <- zonkForeignExports env fords
226         ; return (zonkEnvIds env, binds', fords', rules') }
227
228 ---------------------------------------------
229 zonkLocalBinds :: ZonkEnv -> HsLocalBinds TcId -> TcM (ZonkEnv, HsLocalBinds Id)
230 zonkLocalBinds env EmptyLocalBinds
231   = return (env, EmptyLocalBinds)
232
233 zonkLocalBinds env (HsValBinds binds)
234   = do  { (env1, new_binds) <- zonkValBinds env binds
235         ; return (env1, HsValBinds new_binds) }
236
237 zonkLocalBinds env (HsIPBinds (IPBinds binds dict_binds))
238   = mappM (wrapLocM zonk_ip_bind) binds `thenM` \ new_binds ->
239     let
240         env1 = extendZonkEnv env [ipNameName n | L _ (IPBind n _) <- new_binds]
241     in
242     zonkRecMonoBinds env1 dict_binds    `thenM` \ (env2, new_dict_binds) -> 
243     returnM (env2, HsIPBinds (IPBinds new_binds new_dict_binds))
244   where
245     zonk_ip_bind (IPBind n e)
246         = mapIPNameTc (zonkIdBndr env) n        `thenM` \ n' ->
247           zonkLExpr env e                       `thenM` \ e' ->
248           returnM (IPBind n' e')
249
250
251 ---------------------------------------------
252 zonkValBinds :: ZonkEnv -> HsValBinds TcId -> TcM (ZonkEnv, HsValBinds Id)
253 zonkValBinds env bs@(ValBindsIn _ _) 
254   = panic "zonkValBinds"        -- Not in typechecker output
255 zonkValBinds env (ValBindsOut binds sigs) 
256   = do  { (env1, new_binds) <- go env binds
257         ; return (env1, ValBindsOut new_binds sigs) }
258   where
259     go env []         = return (env, [])
260     go env ((r,b):bs) = do { (env1, b')  <- zonkRecMonoBinds env b
261                            ; (env2, bs') <- go env1 bs
262                            ; return (env2, (r,b'):bs') }
263
264 ---------------------------------------------
265 zonkRecMonoBinds :: ZonkEnv -> LHsBinds TcId -> TcM (ZonkEnv, LHsBinds Id)
266 zonkRecMonoBinds env binds 
267  = fixM (\ ~(_, new_binds) -> do 
268         { let env1 = extendZonkEnv env (collectHsBindBinders new_binds)
269         ; binds' <- zonkMonoBinds env1 binds
270         ; return (env1, binds') })
271
272 ---------------------------------------------
273 zonkMonoBinds :: ZonkEnv -> LHsBinds TcId -> TcM (LHsBinds Id)
274 zonkMonoBinds env binds = mapBagM (wrapLocM (zonk_bind env)) binds
275
276 zonk_bind :: ZonkEnv -> HsBind TcId -> TcM (HsBind Id)
277 zonk_bind env bind@(PatBind { pat_lhs = pat, pat_rhs = grhss, pat_rhs_ty = ty})
278   = do  { (_env, new_pat) <- zonkPat env pat            -- Env already extended
279         ; new_grhss <- zonkGRHSs env grhss
280         ; new_ty    <- zonkTcTypeToType env ty
281         ; return (bind { pat_lhs = new_pat, pat_rhs = new_grhss, pat_rhs_ty = new_ty }) }
282
283 zonk_bind env (VarBind { var_id = var, var_rhs = expr })
284   = zonkIdBndr env var                  `thenM` \ new_var ->
285     zonkLExpr env expr                  `thenM` \ new_expr ->
286     returnM (VarBind { var_id = new_var, var_rhs = new_expr })
287
288 zonk_bind env bind@(FunBind { fun_id = var, fun_matches = ms, fun_co_fn = co_fn })
289   = wrapLocM (zonkIdBndr env) var       `thenM` \ new_var ->
290     zonkCoFn env co_fn                  `thenM` \ (env1, new_co_fn) ->
291     zonkMatchGroup env1 ms              `thenM` \ new_ms ->
292     returnM (bind { fun_id = new_var, fun_matches = new_ms, fun_co_fn = new_co_fn })
293
294 zonk_bind env (AbsBinds { abs_tvs = tyvars, abs_dicts = dicts, 
295                           abs_exports = exports, abs_binds = val_binds })
296   = ASSERT( all isImmutableTyVar tyvars )
297     zonkDictBndrs env dicts                     `thenM` \ new_dicts ->
298     fixM (\ ~(new_val_binds, _) ->
299         let
300           env1 = extendZonkEnv env new_dicts
301           env2 = extendZonkEnv env1 (collectHsBindBinders new_val_binds)
302         in
303         zonkMonoBinds env2 val_binds            `thenM` \ new_val_binds ->
304         mappM (zonkExport env2) exports         `thenM` \ new_exports ->
305         returnM (new_val_binds, new_exports)
306     )                                           `thenM` \ (new_val_bind, new_exports) ->
307     returnM (AbsBinds { abs_tvs = tyvars, abs_dicts = new_dicts, 
308                         abs_exports = new_exports, abs_binds = new_val_bind })
309   where
310     zonkExport env (tyvars, global, local, prags)
311         -- The tyvars are already zonked
312         = zonkIdBndr env global                 `thenM` \ new_global ->
313           mapM zonk_prag prags                  `thenM` \ new_prags -> 
314           returnM (tyvars, new_global, zonkIdOcc env local, new_prags)
315     zonk_prag prag@(L _ (InlinePrag {}))  = return prag
316     zonk_prag (L loc (SpecPrag expr ty ds inl))
317         = do { expr' <- zonkExpr env expr 
318              ; ty'   <- zonkTcTypeToType env ty
319              ; let ds' = zonkIdOccs env ds
320              ; return (L loc (SpecPrag expr' ty' ds' inl)) }
321 \end{code}
322
323 %************************************************************************
324 %*                                                                      *
325 \subsection[BackSubst-Match-GRHSs]{Match and GRHSs}
326 %*                                                                      *
327 %************************************************************************
328
329 \begin{code}
330 zonkMatchGroup :: ZonkEnv -> MatchGroup TcId-> TcM (MatchGroup Id)
331 zonkMatchGroup env (MatchGroup ms ty) 
332   = do  { ms' <- mapM (zonkMatch env) ms
333         ; ty' <- zonkTcTypeToType env ty
334         ; return (MatchGroup ms' ty') }
335
336 zonkMatch :: ZonkEnv -> LMatch TcId-> TcM (LMatch Id)
337 zonkMatch env (L loc (Match pats _ grhss))
338   = do  { (env1, new_pats) <- zonkPats env pats
339         ; new_grhss <- zonkGRHSs env1 grhss
340         ; return (L loc (Match new_pats Nothing new_grhss)) }
341
342 -------------------------------------------------------------------------
343 zonkGRHSs :: ZonkEnv -> GRHSs TcId -> TcM (GRHSs Id)
344
345 zonkGRHSs env (GRHSs grhss binds)
346   = zonkLocalBinds env binds    `thenM` \ (new_env, new_binds) ->
347     let
348         zonk_grhs (GRHS guarded rhs)
349           = zonkStmts new_env guarded   `thenM` \ (env2, new_guarded) ->
350             zonkLExpr env2 rhs          `thenM` \ new_rhs ->
351             returnM (GRHS new_guarded new_rhs)
352     in
353     mappM (wrapLocM zonk_grhs) grhss    `thenM` \ new_grhss ->
354     returnM (GRHSs new_grhss new_binds)
355 \end{code}
356
357 %************************************************************************
358 %*                                                                      *
359 \subsection[BackSubst-HsExpr]{Running a zonkitution over a TypeCheckedExpr}
360 %*                                                                      *
361 %************************************************************************
362
363 \begin{code}
364 zonkLExprs :: ZonkEnv -> [LHsExpr TcId] -> TcM [LHsExpr Id]
365 zonkLExpr  :: ZonkEnv -> LHsExpr TcId   -> TcM (LHsExpr Id)
366 zonkExpr   :: ZonkEnv -> HsExpr TcId    -> TcM (HsExpr Id)
367
368 zonkLExprs env exprs = mappM (zonkLExpr env) exprs
369 zonkLExpr  env expr  = wrapLocM (zonkExpr env) expr
370
371 zonkExpr env (HsVar id)
372   = returnM (HsVar (zonkIdOcc env id))
373
374 zonkExpr env (HsIPVar id)
375   = returnM (HsIPVar (mapIPName (zonkIdOcc env) id))
376
377 zonkExpr env (HsLit (HsRat f ty))
378   = zonkTcTypeToType env ty        `thenM` \ new_ty  ->
379     returnM (HsLit (HsRat f new_ty))
380
381 zonkExpr env (HsLit lit)
382   = returnM (HsLit lit)
383
384 zonkExpr env (HsOverLit lit)
385   = do  { lit' <- zonkOverLit env lit
386         ; return (HsOverLit lit') }
387
388 zonkExpr env (HsLam matches)
389   = zonkMatchGroup env matches  `thenM` \ new_matches ->
390     returnM (HsLam new_matches)
391
392 zonkExpr env (HsApp e1 e2)
393   = zonkLExpr env e1    `thenM` \ new_e1 ->
394     zonkLExpr env e2    `thenM` \ new_e2 ->
395     returnM (HsApp new_e1 new_e2)
396
397 zonkExpr env (HsBracketOut body bs) 
398   = mappM zonk_b bs     `thenM` \ bs' ->
399     returnM (HsBracketOut body bs')
400   where
401     zonk_b (n,e) = zonkLExpr env e      `thenM` \ e' ->
402                    returnM (n,e')
403
404 zonkExpr env (HsSpliceE s) = WARN( True, ppr s )        -- Should not happen
405                              returnM (HsSpliceE s)
406
407 zonkExpr env (OpApp e1 op fixity e2)
408   = zonkLExpr env e1    `thenM` \ new_e1 ->
409     zonkLExpr env op    `thenM` \ new_op ->
410     zonkLExpr env e2    `thenM` \ new_e2 ->
411     returnM (OpApp new_e1 new_op fixity new_e2)
412
413 zonkExpr env (NegApp expr op)
414   = zonkLExpr env expr  `thenM` \ new_expr ->
415     zonkExpr env op     `thenM` \ new_op ->
416     returnM (NegApp new_expr new_op)
417
418 zonkExpr env (HsPar e)    
419   = zonkLExpr env e     `thenM` \new_e ->
420     returnM (HsPar new_e)
421
422 zonkExpr env (SectionL expr op)
423   = zonkLExpr env expr  `thenM` \ new_expr ->
424     zonkLExpr env op            `thenM` \ new_op ->
425     returnM (SectionL new_expr new_op)
426
427 zonkExpr env (SectionR op expr)
428   = zonkLExpr env op            `thenM` \ new_op ->
429     zonkLExpr env expr          `thenM` \ new_expr ->
430     returnM (SectionR new_op new_expr)
431
432 zonkExpr env (HsCase expr ms)
433   = zonkLExpr env expr          `thenM` \ new_expr ->
434     zonkMatchGroup env ms       `thenM` \ new_ms ->
435     returnM (HsCase new_expr new_ms)
436
437 zonkExpr env (HsIf e1 e2 e3)
438   = zonkLExpr env e1    `thenM` \ new_e1 ->
439     zonkLExpr env e2    `thenM` \ new_e2 ->
440     zonkLExpr env e3    `thenM` \ new_e3 ->
441     returnM (HsIf new_e1 new_e2 new_e3)
442
443 zonkExpr env (HsLet binds expr)
444   = zonkLocalBinds env binds    `thenM` \ (new_env, new_binds) ->
445     zonkLExpr new_env expr      `thenM` \ new_expr ->
446     returnM (HsLet new_binds new_expr)
447
448 zonkExpr env (HsDo do_or_lc stmts body ty)
449   = zonkStmts env stmts         `thenM` \ (new_env, new_stmts) ->
450     zonkLExpr new_env body      `thenM` \ new_body ->
451     zonkTcTypeToType env ty     `thenM` \ new_ty   ->
452     returnM (HsDo (zonkDo env do_or_lc) 
453                   new_stmts new_body new_ty)
454
455 zonkExpr env (ExplicitList ty exprs)
456   = zonkTcTypeToType env ty     `thenM` \ new_ty ->
457     zonkLExprs env exprs        `thenM` \ new_exprs ->
458     returnM (ExplicitList new_ty new_exprs)
459
460 zonkExpr env (ExplicitPArr ty exprs)
461   = zonkTcTypeToType env ty     `thenM` \ new_ty ->
462     zonkLExprs env exprs        `thenM` \ new_exprs ->
463     returnM (ExplicitPArr new_ty new_exprs)
464
465 zonkExpr env (ExplicitTuple exprs boxed)
466   = zonkLExprs env exprs        `thenM` \ new_exprs ->
467     returnM (ExplicitTuple new_exprs boxed)
468
469 zonkExpr env (RecordCon data_con con_expr rbinds)
470   = do  { new_con_expr <- zonkExpr env con_expr
471         ; new_rbinds   <- zonkRecFields env rbinds
472         ; return (RecordCon data_con new_con_expr new_rbinds) }
473
474 zonkExpr env (RecordUpd expr rbinds cons in_tys out_tys)
475   = do  { new_expr    <- zonkLExpr env expr
476         ; new_in_tys  <- mapM (zonkTcTypeToType env) in_tys
477         ; new_out_tys <- mapM (zonkTcTypeToType env) out_tys
478         ; new_rbinds  <- zonkRecFields env rbinds
479         ; return (RecordUpd new_expr new_rbinds cons new_in_tys new_out_tys) }
480
481 zonkExpr env (ExprWithTySigOut e ty) 
482   = do { e' <- zonkLExpr env e
483        ; return (ExprWithTySigOut e' ty) }
484
485 zonkExpr env (ExprWithTySig _ _) = panic "zonkExpr env:ExprWithTySig"
486
487 zonkExpr env (ArithSeq expr info)
488   = zonkExpr env expr           `thenM` \ new_expr ->
489     zonkArithSeq env info       `thenM` \ new_info ->
490     returnM (ArithSeq new_expr new_info)
491
492 zonkExpr env (PArrSeq expr info)
493   = zonkExpr env expr           `thenM` \ new_expr ->
494     zonkArithSeq env info       `thenM` \ new_info ->
495     returnM (PArrSeq new_expr new_info)
496
497 zonkExpr env (HsSCC lbl expr)
498   = zonkLExpr env expr  `thenM` \ new_expr ->
499     returnM (HsSCC lbl new_expr)
500
501 zonkExpr env (HsTickPragma info expr)
502   = zonkLExpr env expr  `thenM` \ new_expr ->
503     returnM (HsTickPragma info new_expr)
504
505 -- hdaume: core annotations
506 zonkExpr env (HsCoreAnn lbl expr)
507   = zonkLExpr env expr   `thenM` \ new_expr ->
508     returnM (HsCoreAnn lbl new_expr)
509
510 -- arrow notation extensions
511 zonkExpr env (HsProc pat body)
512   = do  { (env1, new_pat) <- zonkPat env pat
513         ; new_body <- zonkCmdTop env1 body
514         ; return (HsProc new_pat new_body) }
515
516 zonkExpr env (HsArrApp e1 e2 ty ho rl)
517   = zonkLExpr env e1                    `thenM` \ new_e1 ->
518     zonkLExpr env e2                    `thenM` \ new_e2 ->
519     zonkTcTypeToType env ty             `thenM` \ new_ty ->
520     returnM (HsArrApp new_e1 new_e2 new_ty ho rl)
521
522 zonkExpr env (HsArrForm op fixity args)
523   = zonkLExpr env op                    `thenM` \ new_op ->
524     mappM (zonkCmdTop env) args         `thenM` \ new_args ->
525     returnM (HsArrForm new_op fixity new_args)
526
527 zonkExpr env (HsWrap co_fn expr)
528   = zonkCoFn env co_fn  `thenM` \ (env1, new_co_fn) ->
529     zonkExpr env1 expr  `thenM` \ new_expr ->
530     return (HsWrap new_co_fn new_expr)
531
532 zonkExpr env other = pprPanic "zonkExpr" (ppr other)
533
534 zonkCmdTop :: ZonkEnv -> LHsCmdTop TcId -> TcM (LHsCmdTop Id)
535 zonkCmdTop env cmd = wrapLocM (zonk_cmd_top env) cmd
536
537 zonk_cmd_top env (HsCmdTop cmd stack_tys ty ids)
538   = zonkLExpr env cmd                   `thenM` \ new_cmd ->
539     zonkTcTypeToTypes env stack_tys     `thenM` \ new_stack_tys ->
540     zonkTcTypeToType env ty             `thenM` \ new_ty ->
541     mapSndM (zonkExpr env) ids          `thenM` \ new_ids ->
542     returnM (HsCmdTop new_cmd new_stack_tys new_ty new_ids)
543
544 -------------------------------------------------------------------------
545 zonkCoFn :: ZonkEnv -> HsWrapper -> TcM (ZonkEnv, HsWrapper)
546 zonkCoFn env WpHole   = return (env, WpHole)
547 zonkCoFn env WpInline = return (env, WpInline)
548 zonkCoFn env (WpCompose c1 c2) = do { (env1, c1') <- zonkCoFn env c1
549                                     ; (env2, c2') <- zonkCoFn env1 c2
550                                     ; return (env2, WpCompose c1' c2') }
551 zonkCoFn env (WpCo co)      = do { co' <- zonkTcTypeToType env co
552                                  ; return (env, WpCo co') }
553 zonkCoFn env (WpLam id)     = do { id' <- zonkIdBndr env id
554                                  ; let env1 = extendZonkEnv1 env id'
555                                  ; return (env1, WpLam id') }
556 zonkCoFn env (WpTyLam tv)   = ASSERT( isImmutableTyVar tv )
557                               do { return (env, WpTyLam tv) }
558 zonkCoFn env (WpApp id)     = do { return (env, WpApp (zonkIdOcc env id)) }
559 zonkCoFn env (WpTyApp ty)   = do { ty' <- zonkTcTypeToType env ty
560                                  ; return (env, WpTyApp ty') }
561 zonkCoFn env (WpLet bs)     = do { (env1, bs') <- zonkRecMonoBinds env bs
562                                  ; return (env1, WpLet bs') }
563
564
565 -------------------------------------------------------------------------
566 zonkDo :: ZonkEnv -> HsStmtContext Name -> HsStmtContext Name
567 -- Only used for 'do', so the only Ids are in a MDoExpr table
568 zonkDo env (MDoExpr tbl) = MDoExpr (mapSnd (zonkIdOcc env) tbl)
569 zonkDo env do_or_lc      = do_or_lc
570
571 -------------------------------------------------------------------------
572 zonkOverLit :: ZonkEnv -> HsOverLit TcId -> TcM (HsOverLit Id)
573 zonkOverLit env ol = 
574     let 
575         zonkedStuff = do ty' <- zonkTcTypeToType env (overLitType ol)
576                          e' <- zonkExpr env (overLitExpr ol)
577                          return (e', ty')
578         ru f (x, y) = return (f x y)
579     in
580       case ol of 
581         (HsIntegral i _ _)   -> ru (HsIntegral i) =<< zonkedStuff
582         (HsFractional r _ _) -> ru (HsFractional r) =<< zonkedStuff
583         (HsIsString s _ _)   -> ru (HsIsString s) =<< zonkedStuff
584
585 -------------------------------------------------------------------------
586 zonkArithSeq :: ZonkEnv -> ArithSeqInfo TcId -> TcM (ArithSeqInfo Id)
587
588 zonkArithSeq env (From e)
589   = zonkLExpr env e             `thenM` \ new_e ->
590     returnM (From new_e)
591
592 zonkArithSeq env (FromThen e1 e2)
593   = zonkLExpr env e1    `thenM` \ new_e1 ->
594     zonkLExpr env e2    `thenM` \ new_e2 ->
595     returnM (FromThen new_e1 new_e2)
596
597 zonkArithSeq env (FromTo e1 e2)
598   = zonkLExpr env e1    `thenM` \ new_e1 ->
599     zonkLExpr env e2    `thenM` \ new_e2 ->
600     returnM (FromTo new_e1 new_e2)
601
602 zonkArithSeq env (FromThenTo e1 e2 e3)
603   = zonkLExpr env e1    `thenM` \ new_e1 ->
604     zonkLExpr env e2    `thenM` \ new_e2 ->
605     zonkLExpr env e3    `thenM` \ new_e3 ->
606     returnM (FromThenTo new_e1 new_e2 new_e3)
607
608
609 -------------------------------------------------------------------------
610 zonkStmts :: ZonkEnv -> [LStmt TcId] -> TcM (ZonkEnv, [LStmt Id])
611 zonkStmts env []     = return (env, [])
612 zonkStmts env (s:ss) = do { (env1, s')  <- wrapLocSndM (zonkStmt env) s
613                           ; (env2, ss') <- zonkStmts env1 ss
614                           ; return (env2, s' : ss') }
615
616 zonkStmt :: ZonkEnv -> Stmt TcId -> TcM (ZonkEnv, Stmt Id)
617 zonkStmt env (ParStmt stmts_w_bndrs)
618   = mappM zonk_branch stmts_w_bndrs     `thenM` \ new_stmts_w_bndrs ->
619     let 
620         new_binders = concat (map snd new_stmts_w_bndrs)
621         env1 = extendZonkEnv env new_binders
622     in
623     return (env1, ParStmt new_stmts_w_bndrs)
624   where
625     zonk_branch (stmts, bndrs) = zonkStmts env stmts    `thenM` \ (env1, new_stmts) ->
626                                  returnM (new_stmts, zonkIdOccs env1 bndrs)
627
628 zonkStmt env (RecStmt segStmts lvs rvs rets binds)
629   = zonkIdBndrs env rvs         `thenM` \ new_rvs ->
630     let
631         env1 = extendZonkEnv env new_rvs
632     in
633     zonkStmts env1 segStmts     `thenM` \ (env2, new_segStmts) ->
634         -- Zonk the ret-expressions in an envt that 
635         -- has the polymorphic bindings in the envt
636     mapM (zonkExpr env2) rets   `thenM` \ new_rets ->
637     let
638         new_lvs = zonkIdOccs env2 lvs
639         env3 = extendZonkEnv env new_lvs        -- Only the lvs are needed
640     in
641     zonkRecMonoBinds env3 binds `thenM` \ (env4, new_binds) ->
642     returnM (env4, RecStmt new_segStmts new_lvs new_rvs new_rets new_binds)
643
644 zonkStmt env (ExprStmt expr then_op ty)
645   = zonkLExpr env expr          `thenM` \ new_expr ->
646     zonkExpr env then_op        `thenM` \ new_then ->
647     zonkTcTypeToType env ty     `thenM` \ new_ty ->
648     returnM (env, ExprStmt new_expr new_then new_ty)
649
650 zonkStmt env (LetStmt binds)
651   = zonkLocalBinds env binds    `thenM` \ (env1, new_binds) ->
652     returnM (env1, LetStmt new_binds)
653
654 zonkStmt env (BindStmt pat expr bind_op fail_op)
655   = do  { new_expr <- zonkLExpr env expr
656         ; (env1, new_pat) <- zonkPat env pat
657         ; new_bind <- zonkExpr env bind_op
658         ; new_fail <- zonkExpr env fail_op
659         ; return (env1, BindStmt new_pat new_expr new_bind new_fail) }
660
661
662 -------------------------------------------------------------------------
663 zonkRecFields :: ZonkEnv -> HsRecordBinds TcId -> TcM (HsRecordBinds TcId)
664 zonkRecFields env (HsRecFields flds dd)
665   = do  { flds' <- mappM zonk_rbind flds
666         ; return (HsRecFields flds' dd) }
667   where
668     zonk_rbind fld
669       = do { new_expr <- zonkLExpr env (hsRecFieldArg fld)
670            ; return (fld { hsRecFieldArg = new_expr }) }
671         -- Field selectors have declared types; hence no zonking
672
673 -------------------------------------------------------------------------
674 mapIPNameTc :: (a -> TcM b) -> IPName a -> TcM (IPName b)
675 mapIPNameTc f (IPName n) = f n  `thenM` \ r -> returnM (IPName r)
676 \end{code}
677
678
679 %************************************************************************
680 %*                                                                      *
681 \subsection[BackSubst-Pats]{Patterns}
682 %*                                                                      *
683 %************************************************************************
684
685 \begin{code}
686 zonkPat :: ZonkEnv -> OutPat TcId -> TcM (ZonkEnv, OutPat Id)
687 -- Extend the environment as we go, because it's possible for one
688 -- pattern to bind something that is used in another (inside or
689 -- to the right)
690 zonkPat env pat = wrapLocSndM (zonk_pat env) pat
691
692 zonk_pat env (ParPat p)
693   = do  { (env', p') <- zonkPat env p
694         ; return (env', ParPat p') }
695
696 zonk_pat env (WildPat ty)
697   = do  { ty' <- zonkTcTypeToType env ty
698         ; return (env, WildPat ty') }
699
700 zonk_pat env (VarPat v)
701   = do  { v' <- zonkIdBndr env v
702         ; return (extendZonkEnv1 env v', VarPat v') }
703
704 zonk_pat env (VarPatOut v binds)
705   = do  { v' <- zonkIdBndr env v
706         ; (env', binds') <- zonkRecMonoBinds (extendZonkEnv1 env v') binds
707         ; returnM (env', VarPatOut v' binds') }
708
709 zonk_pat env (LazyPat pat)
710   = do  { (env', pat') <- zonkPat env pat
711         ; return (env',  LazyPat pat') }
712
713 zonk_pat env (BangPat pat)
714   = do  { (env', pat') <- zonkPat env pat
715         ; return (env',  BangPat pat') }
716
717 zonk_pat env (AsPat (L loc v) pat)
718   = do  { v' <- zonkIdBndr env v
719         ; (env', pat') <- zonkPat (extendZonkEnv1 env v') pat
720         ; return (env', AsPat (L loc v') pat') }
721
722 zonk_pat env (ViewPat expr pat ty)
723   = do  { expr' <- zonkLExpr env expr
724         ; (env', pat') <- zonkPat env pat
725         ; return (env', ViewPat expr' pat' ty) }
726
727 zonk_pat env (ListPat pats ty)
728   = do  { ty' <- zonkTcTypeToType env ty
729         ; (env', pats') <- zonkPats env pats
730         ; return (env', ListPat pats' ty') }
731
732 zonk_pat env (PArrPat pats ty)
733   = do  { ty' <- zonkTcTypeToType env ty
734         ; (env', pats') <- zonkPats env pats
735         ; return (env', PArrPat pats' ty') }
736
737 zonk_pat env (TuplePat pats boxed ty)
738   = do  { ty' <- zonkTcTypeToType env ty
739         ; (env', pats') <- zonkPats env pats
740         ; return (env', TuplePat pats' boxed ty') }
741
742 zonk_pat env p@(ConPatOut { pat_ty = ty, pat_dicts = dicts, pat_binds = binds, pat_args = args })
743   = ASSERT( all isImmutableTyVar (pat_tvs p) ) 
744     do  { new_ty <- zonkTcTypeToType env ty
745         ; new_dicts <- zonkIdBndrs env dicts
746         ; let env1 = extendZonkEnv env new_dicts
747         ; (env2, new_binds) <- zonkRecMonoBinds env1 binds
748         ; (env', new_args) <- zonkConStuff env2 args
749         ; returnM (env', p { pat_ty = new_ty, pat_dicts = new_dicts, 
750                              pat_binds = new_binds, pat_args = new_args }) }
751
752 zonk_pat env (LitPat lit) = return (env, LitPat lit)
753
754 zonk_pat env (SigPatOut pat ty)
755   = do  { ty' <- zonkTcTypeToType env ty
756         ; (env', pat') <- zonkPat env pat
757         ; return (env', SigPatOut pat' ty') }
758
759 zonk_pat env (NPat lit mb_neg eq_expr)
760   = do  { lit' <- zonkOverLit env lit
761         ; mb_neg' <- case mb_neg of
762                         Nothing  -> return Nothing
763                         Just neg -> do { neg' <- zonkExpr env neg
764                                        ; return (Just neg') }
765         ; eq_expr' <- zonkExpr env eq_expr
766         ; return (env, NPat lit' mb_neg' eq_expr') }
767
768 zonk_pat env (NPlusKPat (L loc n) lit e1 e2)
769   = do  { n' <- zonkIdBndr env n
770         ; lit' <- zonkOverLit env lit
771         ; e1' <- zonkExpr env e1
772         ; e2' <- zonkExpr env e2
773         ; return (extendZonkEnv1 env n', NPlusKPat (L loc n') lit' e1' e2') }
774
775 zonk_pat env (CoPat co_fn pat ty) 
776   = do { (env', co_fn') <- zonkCoFn env co_fn
777        ; (env'', pat') <- zonkPat env' (noLoc pat)
778        ; ty' <- zonkTcTypeToType env'' ty
779        ; return (env'', CoPat co_fn' (unLoc pat') ty') }
780
781 zonk_pat env pat = pprPanic "zonk_pat" (ppr pat)
782
783 ---------------------------
784 zonkConStuff env (PrefixCon pats)
785   = do  { (env', pats') <- zonkPats env pats
786         ; return (env', PrefixCon pats') }
787
788 zonkConStuff env (InfixCon p1 p2)
789   = do  { (env1, p1') <- zonkPat env  p1
790         ; (env', p2') <- zonkPat env1 p2
791         ; return (env', InfixCon p1' p2') }
792
793 zonkConStuff env (RecCon (HsRecFields rpats dd))
794   = do  { (env', pats') <- zonkPats env (map hsRecFieldArg rpats)
795         ; let rpats' = zipWith (\rp p' -> rp { hsRecFieldArg = p' }) rpats pats'
796         ; returnM (env', RecCon (HsRecFields rpats' dd)) }
797         -- Field selectors have declared types; hence no zonking
798
799 ---------------------------
800 zonkPats env []         = return (env, [])
801 zonkPats env (pat:pats) = do { (env1, pat') <- zonkPat env pat
802                      ; (env', pats') <- zonkPats env1 pats
803                      ; return (env', pat':pats') }
804 \end{code}
805
806 %************************************************************************
807 %*                                                                      *
808 \subsection[BackSubst-Foreign]{Foreign exports}
809 %*                                                                      *
810 %************************************************************************
811
812
813 \begin{code}
814 zonkForeignExports :: ZonkEnv -> [LForeignDecl TcId] -> TcM [LForeignDecl Id]
815 zonkForeignExports env ls = mappM (wrapLocM (zonkForeignExport env)) ls
816
817 zonkForeignExport :: ZonkEnv -> ForeignDecl TcId -> TcM (ForeignDecl Id)
818 zonkForeignExport env (ForeignExport i hs_ty spec) =
819    returnM (ForeignExport (fmap (zonkIdOcc env) i) undefined spec)
820 zonkForeignExport env for_imp 
821   = returnM for_imp     -- Foreign imports don't need zonking
822 \end{code}
823
824 \begin{code}
825 zonkRules :: ZonkEnv -> [LRuleDecl TcId] -> TcM [LRuleDecl Id]
826 zonkRules env rs = mappM (wrapLocM (zonkRule env)) rs
827
828 zonkRule :: ZonkEnv -> RuleDecl TcId -> TcM (RuleDecl Id)
829 zonkRule env (HsRule name act (vars::[RuleBndr TcId]) lhs fv_lhs rhs fv_rhs)
830   = mappM zonk_bndr vars                `thenM` \ new_bndrs ->
831     newMutVar emptyVarSet               `thenM` \ unbound_tv_set ->
832     let
833         env_rhs = extendZonkEnv env [id | b <- new_bndrs, let id = unLoc b, isId id]
834         -- Type variables don't need an envt
835         -- They are bound through the mutable mechanism
836
837         env_lhs = setZonkType env_rhs (zonkTypeCollecting unbound_tv_set)
838         -- We need to gather the type variables mentioned on the LHS so we can 
839         -- quantify over them.  Example:
840         --   data T a = C
841         -- 
842         --   foo :: T a -> Int
843         --   foo C = 1
844         --
845         --   {-# RULES "myrule"  foo C = 1 #-}
846         -- 
847         -- After type checking the LHS becomes (foo a (C a))
848         -- and we do not want to zap the unbound tyvar 'a' to (), because
849         -- that limits the applicability of the rule.  Instead, we
850         -- want to quantify over it!  
851         --
852         -- It's easiest to find the free tyvars here. Attempts to do so earlier
853         -- are tiresome, because (a) the data type is big and (b) finding the 
854         -- free type vars of an expression is necessarily monadic operation.
855         --      (consider /\a -> f @ b, where b is side-effected to a)
856     in
857     zonkLExpr env_lhs lhs               `thenM` \ new_lhs ->
858     zonkLExpr env_rhs rhs               `thenM` \ new_rhs ->
859
860     readMutVar unbound_tv_set           `thenM` \ unbound_tvs ->
861     let
862         final_bndrs :: [Located Var]
863         final_bndrs = map noLoc (varSetElems unbound_tvs) ++ new_bndrs
864     in
865     returnM (HsRule name act (map RuleBndr final_bndrs) new_lhs fv_lhs new_rhs fv_rhs)
866                 -- I hate this map RuleBndr stuff
867   where
868    zonk_bndr (RuleBndr v) 
869         | isId (unLoc v) = wrapLocM (zonkIdBndr env)   v
870         | otherwise      = ASSERT( isImmutableTyVar (unLoc v) )
871                            return v
872 \end{code}
873
874
875 %************************************************************************
876 %*                                                                      *
877 \subsection[BackSubst-Foreign]{Foreign exports}
878 %*                                                                      *
879 %************************************************************************
880
881 \begin{code}
882 zonkTcTypeToType :: ZonkEnv -> TcType -> TcM Type
883 zonkTcTypeToType (ZonkEnv zonk_ty _) ty = zonk_ty ty
884
885 zonkTcTypeToTypes :: ZonkEnv -> [TcType] -> TcM [Type]
886 zonkTcTypeToTypes env tys = mapM (zonkTcTypeToType env) tys
887
888 zonkTypeCollecting :: TcRef TyVarSet -> TcType -> TcM Type
889 -- This variant collects unbound type variables in a mutable variable
890 zonkTypeCollecting unbound_tv_set
891   = zonkType zonk_unbound_tyvar
892   where
893     zonk_unbound_tyvar tv 
894         = zonkQuantifiedTyVar tv                                `thenM` \ tv' ->
895           readMutVar unbound_tv_set                             `thenM` \ tv_set ->
896           writeMutVar unbound_tv_set (extendVarSet tv_set tv')  `thenM_`
897           return (mkTyVarTy tv')
898
899 zonkTypeZapping :: TcType -> TcM Type
900 -- This variant is used for everything except the LHS of rules
901 -- It zaps unbound type variables to (), or some other arbitrary type
902 zonkTypeZapping ty 
903   = zonkType zonk_unbound_tyvar ty 
904   where
905         -- Zonk a mutable but unbound type variable to an arbitrary type
906         -- We know it's unbound even though we don't carry an environment,
907         -- because at the binding site for a type variable we bind the
908         -- mutable tyvar to a fresh immutable one.  So the mutable store
909         -- plays the role of an environment.  If we come across a mutable
910         -- type variable that isn't so bound, it must be completely free.
911     zonk_unbound_tyvar tv = do { writeMetaTyVar tv ty; return ty }
912                           where 
913                             ty = mkArbitraryType tv
914
915
916 -- When the type checker finds a type variable with no binding,
917 -- which means it can be instantiated with an arbitrary type, it
918 -- usually instantiates it to Void.  Eg.
919 -- 
920 --      length []
921 -- ===>
922 --      length Void (Nil Void)
923 -- 
924 -- But in really obscure programs, the type variable might have
925 -- a kind other than *, so we need to invent a suitably-kinded type.
926 -- 
927 -- This commit uses
928 --      Void for kind *
929 --      List for kind *->*
930 --      Tuple for kind *->...*->*
931 -- 
932 -- which deals with most cases.  (Previously, it only dealt with
933 -- kind *.)   
934 -- 
935 -- In the other cases, it just makes up a TyCon with a suitable
936 -- kind.  If this gets into an interface file, anyone reading that
937 -- file won't understand it.  This is fixable (by making the client
938 -- of the interface file make up a TyCon too) but it is tiresome and
939 -- never happens, so I am leaving it 
940
941 mkArbitraryType :: TcTyVar -> Type
942 -- Make up an arbitrary type whose kind is the same as the tyvar.
943 -- We'll use this to instantiate the (unbound) tyvar.
944 mkArbitraryType tv 
945   | liftedTypeKind `isSubKind` kind = anyPrimTy         -- The vastly common case
946   | otherwise                       = mkTyConApp tycon []
947   where
948     kind       = tyVarKind tv
949     (args,res) = splitKindFunTys kind
950
951     tycon | eqKind kind (tyConKind anyPrimTyCon1)       --  *->*
952           = anyPrimTyCon1                               -- No tuples this size
953
954           | all isLiftedTypeKind args && isLiftedTypeKind res
955           = tupleTyCon Boxed (length args)      --  *-> ... ->*->*
956                 -- Horrible hack to make less use of mkAnyPrimTyCon
957
958           | otherwise
959           = mkAnyPrimTyCon (getUnique tv) kind
960                 -- Same name as the tyvar, apart from making it start with a colon (sigh)
961                 -- I dread to think what will happen if this gets out into an 
962                 -- interface file.  Catastrophe likely.  Major sigh.
963 \end{code}