2 % (c) The University of Glasgow 2006
3 % (c) The AQUA Project, Glasgow University, 1996-1998
6 TcHsSyn: Specialisations of the @HsSyn@ syntax for the typechecker
8 This module is an extension of @HsSyn@ syntax, for use in the type
13 mkHsConApp, mkHsDictLet, mkHsApp,
14 hsLitType, hsLPatType, hsPatType,
15 mkHsAppTy, mkSimpleHsAlt,
16 nlHsIntLit, mkVanillaTuplePat,
17 shortCutLit, hsOverLitName,
19 mkArbitraryType, -- Put this elsewhere?
21 -- re-exported from TcMonad
22 TcId, TcIdSet, TcDictBinds,
24 zonkTopDecls, zonkTopExpr, zonkTopLExpr,
28 #include "HsVersions.h"
31 import HsSyn -- oodles of it
62 thenM :: Monad a => a b -> (b -> a c) -> a c
65 thenM_ :: Monad a => a b -> a c -> a c
68 returnM :: Monad m => a -> m a
71 mappM :: (Monad m) => (a -> m b) -> [a] -> m [b]
76 %************************************************************************
78 \subsection[mkFailurePair]{Code for pattern-matching and other failures}
80 %************************************************************************
82 Note: If @hsLPatType@ doesn't bear a strong resemblance to @exprType@,
83 then something is wrong.
85 mkVanillaTuplePat :: [OutPat Id] -> Boxity -> Pat Id
86 -- A vanilla tuple pattern simply gets its type from its sub-patterns
87 mkVanillaTuplePat pats box
88 = TuplePat pats box (mkTupleTy box (length pats) (map hsLPatType pats))
90 hsLPatType :: OutPat Id -> Type
91 hsLPatType (L _ pat) = hsPatType pat
93 hsPatType :: Pat Id -> Type
94 hsPatType (ParPat pat) = hsLPatType pat
95 hsPatType (WildPat ty) = ty
96 hsPatType (VarPat var) = idType var
97 hsPatType (VarPatOut var _) = idType var
98 hsPatType (BangPat pat) = hsLPatType pat
99 hsPatType (LazyPat pat) = hsLPatType pat
100 hsPatType (LitPat lit) = hsLitType lit
101 hsPatType (AsPat var _) = idType (unLoc var)
102 hsPatType (ViewPat _ _ ty) = ty
103 hsPatType (ListPat _ ty) = mkListTy ty
104 hsPatType (PArrPat _ ty) = mkPArrTy ty
105 hsPatType (TuplePat _ _ ty) = ty
106 hsPatType (ConPatOut { pat_ty = ty }) = ty
107 hsPatType (SigPatOut _ ty) = ty
108 hsPatType (NPat lit _ _) = overLitType lit
109 hsPatType (NPlusKPat id _ _ _) = idType (unLoc id)
110 hsPatType (CoPat _ _ ty) = ty
111 hsPatType p = pprPanic "hsPatType" (ppr p)
113 hsLitType :: HsLit -> TcType
114 hsLitType (HsChar _) = charTy
115 hsLitType (HsCharPrim _) = charPrimTy
116 hsLitType (HsString _) = stringTy
117 hsLitType (HsStringPrim _) = addrPrimTy
118 hsLitType (HsInt _) = intTy
119 hsLitType (HsIntPrim _) = intPrimTy
120 hsLitType (HsWordPrim _) = wordPrimTy
121 hsLitType (HsInteger _ ty) = ty
122 hsLitType (HsRat _ ty) = ty
123 hsLitType (HsFloatPrim _) = floatPrimTy
124 hsLitType (HsDoublePrim _) = doublePrimTy
127 Overloaded literals. Here mainly becuase it uses isIntTy etc
130 shortCutLit :: OverLitVal -> TcType -> Maybe (HsExpr TcId)
131 shortCutLit (HsIntegral i) ty
132 | isIntTy ty && inIntRange i = Just (HsLit (HsInt i))
133 | isWordTy ty && inWordRange i = Just (mkLit wordDataCon (HsWordPrim i))
134 | isIntegerTy ty = Just (HsLit (HsInteger i ty))
135 | otherwise = shortCutLit (HsFractional (fromInteger i)) ty
136 -- The 'otherwise' case is important
137 -- Consider (3 :: Float). Syntactically it looks like an IntLit,
138 -- so we'll call shortCutIntLit, but of course it's a float
139 -- This can make a big difference for programs with a lot of
140 -- literals, compiled without -O
142 shortCutLit (HsFractional f) ty
143 | isFloatTy ty = Just (mkLit floatDataCon (HsFloatPrim f))
144 | isDoubleTy ty = Just (mkLit doubleDataCon (HsDoublePrim f))
145 | otherwise = Nothing
147 shortCutLit (HsIsString s) ty
148 | isStringTy ty = Just (HsLit (HsString s))
149 | otherwise = Nothing
151 mkLit :: DataCon -> HsLit -> HsExpr Id
152 mkLit con lit = HsApp (nlHsVar (dataConWrapId con)) (nlHsLit lit)
154 ------------------------------
155 hsOverLitName :: OverLitVal -> Name
156 -- Get the canonical 'fromX' name for a particular OverLitVal
157 hsOverLitName (HsIntegral {}) = fromIntegerName
158 hsOverLitName (HsFractional {}) = fromRationalName
159 hsOverLitName (HsIsString {}) = fromStringName
162 %************************************************************************
164 \subsection[BackSubst-HsBinds]{Running a substitution over @HsBinds@}
166 %************************************************************************
169 -- zonkId is used *during* typechecking just to zonk the Id's type
170 zonkId :: TcId -> TcM TcId
172 = zonkTcType (idType id) `thenM` \ ty' ->
173 returnM (Id.setIdType id ty')
176 The rest of the zonking is done *after* typechecking.
177 The main zonking pass runs over the bindings
179 a) to convert TcTyVars to TyVars etc, dereferencing any bindings etc
180 b) convert unbound TcTyVar to Void
181 c) convert each TcId to an Id by zonking its type
183 The type variables are converted by binding mutable tyvars to immutable ones
184 and then zonking as normal.
186 The Ids are converted by binding them in the normal Tc envt; that
187 way we maintain sharing; eg an Id is zonked at its binding site and they
188 all occurrences of that Id point to the common zonked copy
190 It's all pretty boring stuff, because HsSyn is such a large type, and
191 the environment manipulation is tiresome.
194 data ZonkEnv = ZonkEnv (TcType -> TcM Type) -- How to zonk a type
195 (IdEnv Id) -- What variables are in scope
196 -- Maps an Id to its zonked version; both have the same Name
197 -- Is only consulted lazily; hence knot-tying
199 emptyZonkEnv :: ZonkEnv
200 emptyZonkEnv = ZonkEnv zonkTypeZapping emptyVarEnv
202 extendZonkEnv :: ZonkEnv -> [Id] -> ZonkEnv
203 extendZonkEnv (ZonkEnv zonk_ty env) ids
204 = ZonkEnv zonk_ty (extendVarEnvList env [(id,id) | id <- ids])
206 extendZonkEnv1 :: ZonkEnv -> Id -> ZonkEnv
207 extendZonkEnv1 (ZonkEnv zonk_ty env) id
208 = ZonkEnv zonk_ty (extendVarEnv env id id)
210 setZonkType :: ZonkEnv -> (TcType -> TcM Type) -> ZonkEnv
211 setZonkType (ZonkEnv _ env) zonk_ty = ZonkEnv zonk_ty env
213 zonkEnvIds :: ZonkEnv -> [Id]
214 zonkEnvIds (ZonkEnv _ env) = varEnvElts env
216 zonkIdOcc :: ZonkEnv -> TcId -> Id
217 -- Ids defined in this module should be in the envt;
218 -- ignore others. (Actually, data constructors are also
219 -- not LocalVars, even when locally defined, but that is fine.)
220 -- (Also foreign-imported things aren't currently in the ZonkEnv;
221 -- that's ok because they don't need zonking.)
223 -- Actually, Template Haskell works in 'chunks' of declarations, and
224 -- an earlier chunk won't be in the 'env' that the zonking phase
225 -- carries around. Instead it'll be in the tcg_gbl_env, already fully
226 -- zonked. There's no point in looking it up there (except for error
227 -- checking), and it's not conveniently to hand; hence the simple
228 -- 'orElse' case in the LocalVar branch.
230 -- Even without template splices, in module Main, the checking of
231 -- 'main' is done as a separate chunk.
232 zonkIdOcc (ZonkEnv _zonk_ty env) id
233 | isLocalVar id = lookupVarEnv env id `orElse` id
236 zonkIdOccs :: ZonkEnv -> [TcId] -> [Id]
237 zonkIdOccs env ids = map (zonkIdOcc env) ids
239 -- zonkIdBndr is used *after* typechecking to get the Id's type
240 -- to its final form. The TyVarEnv give
241 zonkIdBndr :: ZonkEnv -> TcId -> TcM Id
243 = zonkTcTypeToType env (idType id) `thenM` \ ty' ->
244 returnM (Id.setIdType id ty')
246 zonkIdBndrs :: ZonkEnv -> [TcId] -> TcM [Id]
247 zonkIdBndrs env ids = mappM (zonkIdBndr env) ids
249 zonkDictBndrs :: ZonkEnv -> [Var] -> TcM [Var]
250 -- "Dictionary" binders can be coercion variables or dictionary variables
251 zonkDictBndrs env ids = mappM (zonkDictBndr env) ids
253 zonkDictBndr :: ZonkEnv -> Var -> TcM Var
254 zonkDictBndr env var | isTyVar var = zonkTyVarBndr env var
255 | otherwise = zonkIdBndr env var
257 zonkTopBndrs :: [TcId] -> TcM [Id]
258 zonkTopBndrs ids = zonkIdBndrs emptyZonkEnv ids
260 -- Zonk the kind of a non-TC tyvar in case it is a coercion variable (their
261 -- kind contains types).
263 zonkTyVarBndr :: ZonkEnv -> TyVar -> TcM TyVar
266 = do { kind <- zonkTcTypeToType env (tyVarKind tv)
267 ; return $ setTyVarKind tv kind
269 | otherwise = return tv
274 zonkTopExpr :: HsExpr TcId -> TcM (HsExpr Id)
275 zonkTopExpr e = zonkExpr emptyZonkEnv e
277 zonkTopLExpr :: LHsExpr TcId -> TcM (LHsExpr Id)
278 zonkTopLExpr e = zonkLExpr emptyZonkEnv e
280 zonkTopDecls :: LHsBinds TcId -> [LRuleDecl TcId] -> [LForeignDecl TcId]
285 zonkTopDecls binds rules fords
286 = do { (env, binds') <- zonkRecMonoBinds emptyZonkEnv binds
287 -- Top level is implicitly recursive
288 ; rules' <- zonkRules env rules
289 ; fords' <- zonkForeignExports env fords
290 ; return (zonkEnvIds env, binds', fords', rules') }
292 ---------------------------------------------
293 zonkLocalBinds :: ZonkEnv -> HsLocalBinds TcId -> TcM (ZonkEnv, HsLocalBinds Id)
294 zonkLocalBinds env EmptyLocalBinds
295 = return (env, EmptyLocalBinds)
297 zonkLocalBinds env (HsValBinds binds)
298 = do { (env1, new_binds) <- zonkValBinds env binds
299 ; return (env1, HsValBinds new_binds) }
301 zonkLocalBinds env (HsIPBinds (IPBinds binds dict_binds))
302 = mappM (wrapLocM zonk_ip_bind) binds `thenM` \ new_binds ->
304 env1 = extendZonkEnv env [ipNameName n | L _ (IPBind n _) <- new_binds]
306 zonkRecMonoBinds env1 dict_binds `thenM` \ (env2, new_dict_binds) ->
307 returnM (env2, HsIPBinds (IPBinds new_binds new_dict_binds))
309 zonk_ip_bind (IPBind n e)
310 = mapIPNameTc (zonkIdBndr env) n `thenM` \ n' ->
311 zonkLExpr env e `thenM` \ e' ->
312 returnM (IPBind n' e')
315 ---------------------------------------------
316 zonkValBinds :: ZonkEnv -> HsValBinds TcId -> TcM (ZonkEnv, HsValBinds Id)
317 zonkValBinds _ (ValBindsIn _ _)
318 = panic "zonkValBinds" -- Not in typechecker output
319 zonkValBinds env (ValBindsOut binds sigs)
320 = do { (env1, new_binds) <- go env binds
321 ; return (env1, ValBindsOut new_binds sigs) }
323 go env [] = return (env, [])
324 go env ((r,b):bs) = do { (env1, b') <- zonkRecMonoBinds env b
325 ; (env2, bs') <- go env1 bs
326 ; return (env2, (r,b'):bs') }
328 ---------------------------------------------
329 zonkRecMonoBinds :: ZonkEnv -> LHsBinds TcId -> TcM (ZonkEnv, LHsBinds Id)
330 zonkRecMonoBinds env binds
331 = fixM (\ ~(_, new_binds) -> do
332 { let env1 = extendZonkEnv env (collectHsBindBinders new_binds)
333 ; binds' <- zonkMonoBinds env1 binds
334 ; return (env1, binds') })
336 ---------------------------------------------
337 zonkMonoBinds :: ZonkEnv -> LHsBinds TcId -> TcM (LHsBinds Id)
338 zonkMonoBinds env binds = mapBagM (wrapLocM (zonk_bind env)) binds
340 zonk_bind :: ZonkEnv -> HsBind TcId -> TcM (HsBind Id)
341 zonk_bind env bind@(PatBind { pat_lhs = pat, pat_rhs = grhss, pat_rhs_ty = ty})
342 = do { (_env, new_pat) <- zonkPat env pat -- Env already extended
343 ; new_grhss <- zonkGRHSs env grhss
344 ; new_ty <- zonkTcTypeToType env ty
345 ; return (bind { pat_lhs = new_pat, pat_rhs = new_grhss, pat_rhs_ty = new_ty }) }
347 zonk_bind env (VarBind { var_id = var, var_rhs = expr, var_inline = inl })
348 = zonkIdBndr env var `thenM` \ new_var ->
349 zonkLExpr env expr `thenM` \ new_expr ->
350 returnM (VarBind { var_id = new_var, var_rhs = new_expr, var_inline = inl })
352 zonk_bind env bind@(FunBind { fun_id = var, fun_matches = ms, fun_co_fn = co_fn })
353 = wrapLocM (zonkIdBndr env) var `thenM` \ new_var ->
354 zonkCoFn env co_fn `thenM` \ (env1, new_co_fn) ->
355 zonkMatchGroup env1 ms `thenM` \ new_ms ->
356 returnM (bind { fun_id = new_var, fun_matches = new_ms, fun_co_fn = new_co_fn })
358 zonk_bind env (AbsBinds { abs_tvs = tyvars, abs_dicts = dicts,
359 abs_exports = exports, abs_binds = val_binds })
360 = ASSERT( all isImmutableTyVar tyvars )
361 zonkDictBndrs env dicts `thenM` \ new_dicts ->
362 fixM (\ ~(new_val_binds, _) ->
364 env1 = extendZonkEnv env new_dicts
365 env2 = extendZonkEnv env1 (collectHsBindBinders new_val_binds)
367 zonkMonoBinds env2 val_binds `thenM` \ new_val_binds ->
368 mappM (zonkExport env2) exports `thenM` \ new_exports ->
369 returnM (new_val_binds, new_exports)
370 ) `thenM` \ (new_val_bind, new_exports) ->
371 returnM (AbsBinds { abs_tvs = tyvars, abs_dicts = new_dicts,
372 abs_exports = new_exports, abs_binds = new_val_bind })
374 zonkExport env (tyvars, global, local, prags)
375 -- The tyvars are already zonked
376 = zonkIdBndr env global `thenM` \ new_global ->
377 mapM zonk_prag prags `thenM` \ new_prags ->
378 returnM (tyvars, new_global, zonkIdOcc env local, new_prags)
379 zonk_prag prag@(L _ (InlinePrag {})) = return prag
380 zonk_prag (L loc (SpecPrag expr ty inl))
381 = do { expr' <- zonkExpr env expr
382 ; ty' <- zonkTcTypeToType env ty
383 ; return (L loc (SpecPrag expr' ty' inl)) }
386 %************************************************************************
388 \subsection[BackSubst-Match-GRHSs]{Match and GRHSs}
390 %************************************************************************
393 zonkMatchGroup :: ZonkEnv -> MatchGroup TcId-> TcM (MatchGroup Id)
394 zonkMatchGroup env (MatchGroup ms ty)
395 = do { ms' <- mapM (zonkMatch env) ms
396 ; ty' <- zonkTcTypeToType env ty
397 ; return (MatchGroup ms' ty') }
399 zonkMatch :: ZonkEnv -> LMatch TcId-> TcM (LMatch Id)
400 zonkMatch env (L loc (Match pats _ grhss))
401 = do { (env1, new_pats) <- zonkPats env pats
402 ; new_grhss <- zonkGRHSs env1 grhss
403 ; return (L loc (Match new_pats Nothing new_grhss)) }
405 -------------------------------------------------------------------------
406 zonkGRHSs :: ZonkEnv -> GRHSs TcId -> TcM (GRHSs Id)
408 zonkGRHSs env (GRHSs grhss binds)
409 = zonkLocalBinds env binds `thenM` \ (new_env, new_binds) ->
411 zonk_grhs (GRHS guarded rhs)
412 = zonkStmts new_env guarded `thenM` \ (env2, new_guarded) ->
413 zonkLExpr env2 rhs `thenM` \ new_rhs ->
414 returnM (GRHS new_guarded new_rhs)
416 mappM (wrapLocM zonk_grhs) grhss `thenM` \ new_grhss ->
417 returnM (GRHSs new_grhss new_binds)
420 %************************************************************************
422 \subsection[BackSubst-HsExpr]{Running a zonkitution over a TypeCheckedExpr}
424 %************************************************************************
427 zonkLExprs :: ZonkEnv -> [LHsExpr TcId] -> TcM [LHsExpr Id]
428 zonkLExpr :: ZonkEnv -> LHsExpr TcId -> TcM (LHsExpr Id)
429 zonkExpr :: ZonkEnv -> HsExpr TcId -> TcM (HsExpr Id)
431 zonkLExprs env exprs = mappM (zonkLExpr env) exprs
432 zonkLExpr env expr = wrapLocM (zonkExpr env) expr
434 zonkExpr env (HsVar id)
435 = returnM (HsVar (zonkIdOcc env id))
437 zonkExpr env (HsIPVar id)
438 = returnM (HsIPVar (mapIPName (zonkIdOcc env) id))
440 zonkExpr env (HsLit (HsRat f ty))
441 = zonkTcTypeToType env ty `thenM` \ new_ty ->
442 returnM (HsLit (HsRat f new_ty))
444 zonkExpr _ (HsLit lit)
445 = returnM (HsLit lit)
447 zonkExpr env (HsOverLit lit)
448 = do { lit' <- zonkOverLit env lit
449 ; return (HsOverLit lit') }
451 zonkExpr env (HsLam matches)
452 = zonkMatchGroup env matches `thenM` \ new_matches ->
453 returnM (HsLam new_matches)
455 zonkExpr env (HsApp e1 e2)
456 = zonkLExpr env e1 `thenM` \ new_e1 ->
457 zonkLExpr env e2 `thenM` \ new_e2 ->
458 returnM (HsApp new_e1 new_e2)
460 zonkExpr env (HsBracketOut body bs)
461 = mappM zonk_b bs `thenM` \ bs' ->
462 returnM (HsBracketOut body bs')
464 zonk_b (n,e) = zonkLExpr env e `thenM` \ e' ->
467 zonkExpr _ (HsSpliceE s) = WARN( True, ppr s ) -- Should not happen
468 returnM (HsSpliceE s)
470 zonkExpr env (OpApp e1 op fixity e2)
471 = zonkLExpr env e1 `thenM` \ new_e1 ->
472 zonkLExpr env op `thenM` \ new_op ->
473 zonkLExpr env e2 `thenM` \ new_e2 ->
474 returnM (OpApp new_e1 new_op fixity new_e2)
476 zonkExpr env (NegApp expr op)
477 = zonkLExpr env expr `thenM` \ new_expr ->
478 zonkExpr env op `thenM` \ new_op ->
479 returnM (NegApp new_expr new_op)
481 zonkExpr env (HsPar e)
482 = zonkLExpr env e `thenM` \new_e ->
483 returnM (HsPar new_e)
485 zonkExpr env (SectionL expr op)
486 = zonkLExpr env expr `thenM` \ new_expr ->
487 zonkLExpr env op `thenM` \ new_op ->
488 returnM (SectionL new_expr new_op)
490 zonkExpr env (SectionR op expr)
491 = zonkLExpr env op `thenM` \ new_op ->
492 zonkLExpr env expr `thenM` \ new_expr ->
493 returnM (SectionR new_op new_expr)
495 zonkExpr env (HsCase expr ms)
496 = zonkLExpr env expr `thenM` \ new_expr ->
497 zonkMatchGroup env ms `thenM` \ new_ms ->
498 returnM (HsCase new_expr new_ms)
500 zonkExpr env (HsIf e1 e2 e3)
501 = zonkLExpr env e1 `thenM` \ new_e1 ->
502 zonkLExpr env e2 `thenM` \ new_e2 ->
503 zonkLExpr env e3 `thenM` \ new_e3 ->
504 returnM (HsIf new_e1 new_e2 new_e3)
506 zonkExpr env (HsLet binds expr)
507 = zonkLocalBinds env binds `thenM` \ (new_env, new_binds) ->
508 zonkLExpr new_env expr `thenM` \ new_expr ->
509 returnM (HsLet new_binds new_expr)
511 zonkExpr env (HsDo do_or_lc stmts body ty)
512 = zonkStmts env stmts `thenM` \ (new_env, new_stmts) ->
513 zonkLExpr new_env body `thenM` \ new_body ->
514 zonkTcTypeToType env ty `thenM` \ new_ty ->
515 returnM (HsDo (zonkDo env do_or_lc)
516 new_stmts new_body new_ty)
518 zonkExpr env (ExplicitList ty exprs)
519 = zonkTcTypeToType env ty `thenM` \ new_ty ->
520 zonkLExprs env exprs `thenM` \ new_exprs ->
521 returnM (ExplicitList new_ty new_exprs)
523 zonkExpr env (ExplicitPArr ty exprs)
524 = zonkTcTypeToType env ty `thenM` \ new_ty ->
525 zonkLExprs env exprs `thenM` \ new_exprs ->
526 returnM (ExplicitPArr new_ty new_exprs)
528 zonkExpr env (ExplicitTuple exprs boxed)
529 = zonkLExprs env exprs `thenM` \ new_exprs ->
530 returnM (ExplicitTuple new_exprs boxed)
532 zonkExpr env (RecordCon data_con con_expr rbinds)
533 = do { new_con_expr <- zonkExpr env con_expr
534 ; new_rbinds <- zonkRecFields env rbinds
535 ; return (RecordCon data_con new_con_expr new_rbinds) }
537 zonkExpr env (RecordUpd expr rbinds cons in_tys out_tys)
538 = do { new_expr <- zonkLExpr env expr
539 ; new_in_tys <- mapM (zonkTcTypeToType env) in_tys
540 ; new_out_tys <- mapM (zonkTcTypeToType env) out_tys
541 ; new_rbinds <- zonkRecFields env rbinds
542 ; return (RecordUpd new_expr new_rbinds cons new_in_tys new_out_tys) }
544 zonkExpr env (ExprWithTySigOut e ty)
545 = do { e' <- zonkLExpr env e
546 ; return (ExprWithTySigOut e' ty) }
548 zonkExpr _ (ExprWithTySig _ _) = panic "zonkExpr env:ExprWithTySig"
550 zonkExpr env (ArithSeq expr info)
551 = zonkExpr env expr `thenM` \ new_expr ->
552 zonkArithSeq env info `thenM` \ new_info ->
553 returnM (ArithSeq new_expr new_info)
555 zonkExpr env (PArrSeq expr info)
556 = zonkExpr env expr `thenM` \ new_expr ->
557 zonkArithSeq env info `thenM` \ new_info ->
558 returnM (PArrSeq new_expr new_info)
560 zonkExpr env (HsSCC lbl expr)
561 = zonkLExpr env expr `thenM` \ new_expr ->
562 returnM (HsSCC lbl new_expr)
564 zonkExpr env (HsTickPragma info expr)
565 = zonkLExpr env expr `thenM` \ new_expr ->
566 returnM (HsTickPragma info new_expr)
568 -- hdaume: core annotations
569 zonkExpr env (HsCoreAnn lbl expr)
570 = zonkLExpr env expr `thenM` \ new_expr ->
571 returnM (HsCoreAnn lbl new_expr)
573 -- arrow notation extensions
574 zonkExpr env (HsProc pat body)
575 = do { (env1, new_pat) <- zonkPat env pat
576 ; new_body <- zonkCmdTop env1 body
577 ; return (HsProc new_pat new_body) }
579 zonkExpr env (HsArrApp e1 e2 ty ho rl)
580 = zonkLExpr env e1 `thenM` \ new_e1 ->
581 zonkLExpr env e2 `thenM` \ new_e2 ->
582 zonkTcTypeToType env ty `thenM` \ new_ty ->
583 returnM (HsArrApp new_e1 new_e2 new_ty ho rl)
585 zonkExpr env (HsArrForm op fixity args)
586 = zonkLExpr env op `thenM` \ new_op ->
587 mappM (zonkCmdTop env) args `thenM` \ new_args ->
588 returnM (HsArrForm new_op fixity new_args)
590 zonkExpr env (HsWrap co_fn expr)
591 = zonkCoFn env co_fn `thenM` \ (env1, new_co_fn) ->
592 zonkExpr env1 expr `thenM` \ new_expr ->
593 return (HsWrap new_co_fn new_expr)
595 zonkExpr _ expr = pprPanic "zonkExpr" (ppr expr)
597 zonkCmdTop :: ZonkEnv -> LHsCmdTop TcId -> TcM (LHsCmdTop Id)
598 zonkCmdTop env cmd = wrapLocM (zonk_cmd_top env) cmd
600 zonk_cmd_top :: ZonkEnv -> HsCmdTop TcId -> TcM (HsCmdTop Id)
601 zonk_cmd_top env (HsCmdTop cmd stack_tys ty ids)
602 = zonkLExpr env cmd `thenM` \ new_cmd ->
603 zonkTcTypeToTypes env stack_tys `thenM` \ new_stack_tys ->
604 zonkTcTypeToType env ty `thenM` \ new_ty ->
605 mapSndM (zonkExpr env) ids `thenM` \ new_ids ->
606 returnM (HsCmdTop new_cmd new_stack_tys new_ty new_ids)
608 -------------------------------------------------------------------------
609 zonkCoFn :: ZonkEnv -> HsWrapper -> TcM (ZonkEnv, HsWrapper)
610 zonkCoFn env WpHole = return (env, WpHole)
611 zonkCoFn env (WpCompose c1 c2) = do { (env1, c1') <- zonkCoFn env c1
612 ; (env2, c2') <- zonkCoFn env1 c2
613 ; return (env2, WpCompose c1' c2') }
614 zonkCoFn env (WpCast co) = do { co' <- zonkTcTypeToType env co
615 ; return (env, WpCast co') }
616 zonkCoFn env (WpLam id) = do { id' <- zonkDictBndr env id
617 ; let env1 = extendZonkEnv1 env id'
618 ; return (env1, WpLam id') }
619 zonkCoFn env (WpTyLam tv) = ASSERT( isImmutableTyVar tv )
620 do { tv' <- zonkTyVarBndr env tv
621 ; return (env, WpTyLam tv') }
622 zonkCoFn env (WpApp v)
623 | isTcTyVar v = do { co <- zonkTcTyVar v
624 ; return (env, WpTyApp co) }
625 -- Yuk! A mutable coercion variable is a TcTyVar
626 -- not a CoVar, so don't use isCoVar!
627 -- Yuk! A WpApp can't hold the zonked type,
628 -- so we switch to WpTyApp
629 | otherwise = return (env, WpApp (zonkIdOcc env v))
630 zonkCoFn env (WpTyApp ty) = do { ty' <- zonkTcTypeToType env ty
631 ; return (env, WpTyApp ty') }
632 zonkCoFn env (WpLet bs) = do { (env1, bs') <- zonkRecMonoBinds env bs
633 ; return (env1, WpLet bs') }
636 -------------------------------------------------------------------------
637 zonkDo :: ZonkEnv -> HsStmtContext Name -> HsStmtContext Name
638 -- Only used for 'do', so the only Ids are in a MDoExpr table
639 zonkDo env (MDoExpr tbl) = MDoExpr (mapSnd (zonkIdOcc env) tbl)
640 zonkDo _ do_or_lc = do_or_lc
642 -------------------------------------------------------------------------
643 zonkOverLit :: ZonkEnv -> HsOverLit TcId -> TcM (HsOverLit Id)
644 zonkOverLit env lit@(OverLit { ol_witness = e, ol_type = ty })
645 = do { ty' <- zonkTcTypeToType env ty
646 ; e' <- zonkExpr env e
647 ; return (lit { ol_witness = e', ol_type = ty' }) }
649 -------------------------------------------------------------------------
650 zonkArithSeq :: ZonkEnv -> ArithSeqInfo TcId -> TcM (ArithSeqInfo Id)
652 zonkArithSeq env (From e)
653 = zonkLExpr env e `thenM` \ new_e ->
656 zonkArithSeq env (FromThen e1 e2)
657 = zonkLExpr env e1 `thenM` \ new_e1 ->
658 zonkLExpr env e2 `thenM` \ new_e2 ->
659 returnM (FromThen new_e1 new_e2)
661 zonkArithSeq env (FromTo e1 e2)
662 = zonkLExpr env e1 `thenM` \ new_e1 ->
663 zonkLExpr env e2 `thenM` \ new_e2 ->
664 returnM (FromTo new_e1 new_e2)
666 zonkArithSeq env (FromThenTo e1 e2 e3)
667 = zonkLExpr env e1 `thenM` \ new_e1 ->
668 zonkLExpr env e2 `thenM` \ new_e2 ->
669 zonkLExpr env e3 `thenM` \ new_e3 ->
670 returnM (FromThenTo new_e1 new_e2 new_e3)
673 -------------------------------------------------------------------------
674 zonkStmts :: ZonkEnv -> [LStmt TcId] -> TcM (ZonkEnv, [LStmt Id])
675 zonkStmts env [] = return (env, [])
676 zonkStmts env (s:ss) = do { (env1, s') <- wrapLocSndM (zonkStmt env) s
677 ; (env2, ss') <- zonkStmts env1 ss
678 ; return (env2, s' : ss') }
680 zonkStmt :: ZonkEnv -> Stmt TcId -> TcM (ZonkEnv, Stmt Id)
681 zonkStmt env (ParStmt stmts_w_bndrs)
682 = mappM zonk_branch stmts_w_bndrs `thenM` \ new_stmts_w_bndrs ->
684 new_binders = concat (map snd new_stmts_w_bndrs)
685 env1 = extendZonkEnv env new_binders
687 return (env1, ParStmt new_stmts_w_bndrs)
689 zonk_branch (stmts, bndrs) = zonkStmts env stmts `thenM` \ (env1, new_stmts) ->
690 returnM (new_stmts, zonkIdOccs env1 bndrs)
692 zonkStmt env (RecStmt segStmts lvs rvs rets binds)
693 = zonkIdBndrs env rvs `thenM` \ new_rvs ->
695 env1 = extendZonkEnv env new_rvs
697 zonkStmts env1 segStmts `thenM` \ (env2, new_segStmts) ->
698 -- Zonk the ret-expressions in an envt that
699 -- has the polymorphic bindings in the envt
700 mapM (zonkExpr env2) rets `thenM` \ new_rets ->
702 new_lvs = zonkIdOccs env2 lvs
703 env3 = extendZonkEnv env new_lvs -- Only the lvs are needed
705 zonkRecMonoBinds env3 binds `thenM` \ (env4, new_binds) ->
706 returnM (env4, RecStmt new_segStmts new_lvs new_rvs new_rets new_binds)
708 zonkStmt env (ExprStmt expr then_op ty)
709 = zonkLExpr env expr `thenM` \ new_expr ->
710 zonkExpr env then_op `thenM` \ new_then ->
711 zonkTcTypeToType env ty `thenM` \ new_ty ->
712 returnM (env, ExprStmt new_expr new_then new_ty)
714 zonkStmt env (TransformStmt (stmts, binders) usingExpr maybeByExpr)
715 = do { (env', stmts') <- zonkStmts env stmts
716 ; let binders' = zonkIdOccs env' binders
717 ; usingExpr' <- zonkLExpr env' usingExpr
718 ; maybeByExpr' <- zonkMaybeLExpr env' maybeByExpr
719 ; return (env', TransformStmt (stmts', binders') usingExpr' maybeByExpr') }
721 zonkStmt env (GroupStmt (stmts, binderMap) groupByClause)
722 = do { (env', stmts') <- zonkStmts env stmts
723 ; binderMap' <- mappM (zonkBinderMapEntry env') binderMap
725 case groupByClause of
726 GroupByNothing usingExpr -> (zonkLExpr env' usingExpr) >>= (return . GroupByNothing)
727 GroupBySomething eitherUsingExpr byExpr -> do
728 eitherUsingExpr' <- mapEitherM (zonkLExpr env') (zonkExpr env') eitherUsingExpr
729 byExpr' <- zonkLExpr env' byExpr
730 return $ GroupBySomething eitherUsingExpr' byExpr'
732 ; let env'' = extendZonkEnv env' (map snd binderMap')
733 ; return (env'', GroupStmt (stmts', binderMap') groupByClause') }
735 mapEitherM f g x = do
737 Left a -> f a >>= (return . Left)
738 Right b -> g b >>= (return . Right)
740 zonkBinderMapEntry env (oldBinder, newBinder) = do
741 let oldBinder' = zonkIdOcc env oldBinder
742 newBinder' <- zonkIdBndr env newBinder
743 return (oldBinder', newBinder')
745 zonkStmt env (LetStmt binds)
746 = zonkLocalBinds env binds `thenM` \ (env1, new_binds) ->
747 returnM (env1, LetStmt new_binds)
749 zonkStmt env (BindStmt pat expr bind_op fail_op)
750 = do { new_expr <- zonkLExpr env expr
751 ; (env1, new_pat) <- zonkPat env pat
752 ; new_bind <- zonkExpr env bind_op
753 ; new_fail <- zonkExpr env fail_op
754 ; return (env1, BindStmt new_pat new_expr new_bind new_fail) }
756 zonkMaybeLExpr :: ZonkEnv -> Maybe (LHsExpr TcId) -> TcM (Maybe (LHsExpr Id))
757 zonkMaybeLExpr _ Nothing = return Nothing
758 zonkMaybeLExpr env (Just e) = (zonkLExpr env e) >>= (return . Just)
761 -------------------------------------------------------------------------
762 zonkRecFields :: ZonkEnv -> HsRecordBinds TcId -> TcM (HsRecordBinds TcId)
763 zonkRecFields env (HsRecFields flds dd)
764 = do { flds' <- mappM zonk_rbind flds
765 ; return (HsRecFields flds' dd) }
768 = do { new_id <- wrapLocM (zonkIdBndr env) (hsRecFieldId fld)
769 ; new_expr <- zonkLExpr env (hsRecFieldArg fld)
770 ; return (fld { hsRecFieldId = new_id, hsRecFieldArg = new_expr }) }
772 -------------------------------------------------------------------------
773 mapIPNameTc :: (a -> TcM b) -> IPName a -> TcM (IPName b)
774 mapIPNameTc f (IPName n) = f n `thenM` \ r -> returnM (IPName r)
778 %************************************************************************
780 \subsection[BackSubst-Pats]{Patterns}
782 %************************************************************************
785 zonkPat :: ZonkEnv -> OutPat TcId -> TcM (ZonkEnv, OutPat Id)
786 -- Extend the environment as we go, because it's possible for one
787 -- pattern to bind something that is used in another (inside or
789 zonkPat env pat = wrapLocSndM (zonk_pat env) pat
791 zonk_pat :: ZonkEnv -> Pat TcId -> TcM (ZonkEnv, Pat Id)
792 zonk_pat env (ParPat p)
793 = do { (env', p') <- zonkPat env p
794 ; return (env', ParPat p') }
796 zonk_pat env (WildPat ty)
797 = do { ty' <- zonkTcTypeToType env ty
798 ; return (env, WildPat ty') }
800 zonk_pat env (VarPat v)
801 = do { v' <- zonkIdBndr env v
802 ; return (extendZonkEnv1 env v', VarPat v') }
804 zonk_pat env (VarPatOut v binds)
805 = do { v' <- zonkIdBndr env v
806 ; (env', binds') <- zonkRecMonoBinds (extendZonkEnv1 env v') binds
807 ; returnM (env', VarPatOut v' binds') }
809 zonk_pat env (LazyPat pat)
810 = do { (env', pat') <- zonkPat env pat
811 ; return (env', LazyPat pat') }
813 zonk_pat env (BangPat pat)
814 = do { (env', pat') <- zonkPat env pat
815 ; return (env', BangPat pat') }
817 zonk_pat env (AsPat (L loc v) pat)
818 = do { v' <- zonkIdBndr env v
819 ; (env', pat') <- zonkPat (extendZonkEnv1 env v') pat
820 ; return (env', AsPat (L loc v') pat') }
822 zonk_pat env (ViewPat expr pat ty)
823 = do { expr' <- zonkLExpr env expr
824 ; (env', pat') <- zonkPat env pat
825 ; return (env', ViewPat expr' pat' ty) }
827 zonk_pat env (ListPat pats ty)
828 = do { ty' <- zonkTcTypeToType env ty
829 ; (env', pats') <- zonkPats env pats
830 ; return (env', ListPat pats' ty') }
832 zonk_pat env (PArrPat pats ty)
833 = do { ty' <- zonkTcTypeToType env ty
834 ; (env', pats') <- zonkPats env pats
835 ; return (env', PArrPat pats' ty') }
837 zonk_pat env (TuplePat pats boxed ty)
838 = do { ty' <- zonkTcTypeToType env ty
839 ; (env', pats') <- zonkPats env pats
840 ; return (env', TuplePat pats' boxed ty') }
842 zonk_pat env p@(ConPatOut { pat_ty = ty, pat_dicts = dicts, pat_binds = binds, pat_args = args })
843 = ASSERT( all isImmutableTyVar (pat_tvs p) )
844 do { new_ty <- zonkTcTypeToType env ty
845 ; new_dicts <- zonkDictBndrs env dicts
846 ; let env1 = extendZonkEnv env new_dicts
847 ; (env2, new_binds) <- zonkRecMonoBinds env1 binds
848 ; (env', new_args) <- zonkConStuff env2 args
849 ; returnM (env', p { pat_ty = new_ty, pat_dicts = new_dicts,
850 pat_binds = new_binds, pat_args = new_args }) }
852 zonk_pat env (LitPat lit) = return (env, LitPat lit)
854 zonk_pat env (SigPatOut pat ty)
855 = do { ty' <- zonkTcTypeToType env ty
856 ; (env', pat') <- zonkPat env pat
857 ; return (env', SigPatOut pat' ty') }
859 zonk_pat env (NPat lit mb_neg eq_expr)
860 = do { lit' <- zonkOverLit env lit
861 ; mb_neg' <- case mb_neg of
862 Nothing -> return Nothing
863 Just neg -> do { neg' <- zonkExpr env neg
864 ; return (Just neg') }
865 ; eq_expr' <- zonkExpr env eq_expr
866 ; return (env, NPat lit' mb_neg' eq_expr') }
868 zonk_pat env (NPlusKPat (L loc n) lit e1 e2)
869 = do { n' <- zonkIdBndr env n
870 ; lit' <- zonkOverLit env lit
871 ; e1' <- zonkExpr env e1
872 ; e2' <- zonkExpr env e2
873 ; return (extendZonkEnv1 env n', NPlusKPat (L loc n') lit' e1' e2') }
875 zonk_pat env (CoPat co_fn pat ty)
876 = do { (env', co_fn') <- zonkCoFn env co_fn
877 ; (env'', pat') <- zonkPat env' (noLoc pat)
878 ; ty' <- zonkTcTypeToType env'' ty
879 ; return (env'', CoPat co_fn' (unLoc pat') ty') }
881 zonk_pat _ pat = pprPanic "zonk_pat" (ppr pat)
883 ---------------------------
884 zonkConStuff :: ZonkEnv
885 -> HsConDetails (OutPat TcId) (HsRecFields id (OutPat TcId))
887 HsConDetails (OutPat Id) (HsRecFields id (OutPat Id)))
888 zonkConStuff env (PrefixCon pats)
889 = do { (env', pats') <- zonkPats env pats
890 ; return (env', PrefixCon pats') }
892 zonkConStuff env (InfixCon p1 p2)
893 = do { (env1, p1') <- zonkPat env p1
894 ; (env', p2') <- zonkPat env1 p2
895 ; return (env', InfixCon p1' p2') }
897 zonkConStuff env (RecCon (HsRecFields rpats dd))
898 = do { (env', pats') <- zonkPats env (map hsRecFieldArg rpats)
899 ; let rpats' = zipWith (\rp p' -> rp { hsRecFieldArg = p' }) rpats pats'
900 ; returnM (env', RecCon (HsRecFields rpats' dd)) }
901 -- Field selectors have declared types; hence no zonking
903 ---------------------------
904 zonkPats :: ZonkEnv -> [OutPat TcId] -> TcM (ZonkEnv, [OutPat Id])
905 zonkPats env [] = return (env, [])
906 zonkPats env (pat:pats) = do { (env1, pat') <- zonkPat env pat
907 ; (env', pats') <- zonkPats env1 pats
908 ; return (env', pat':pats') }
911 %************************************************************************
913 \subsection[BackSubst-Foreign]{Foreign exports}
915 %************************************************************************
919 zonkForeignExports :: ZonkEnv -> [LForeignDecl TcId] -> TcM [LForeignDecl Id]
920 zonkForeignExports env ls = mappM (wrapLocM (zonkForeignExport env)) ls
922 zonkForeignExport :: ZonkEnv -> ForeignDecl TcId -> TcM (ForeignDecl Id)
923 zonkForeignExport env (ForeignExport i _hs_ty spec) =
924 returnM (ForeignExport (fmap (zonkIdOcc env) i) undefined spec)
925 zonkForeignExport _ for_imp
926 = returnM for_imp -- Foreign imports don't need zonking
930 zonkRules :: ZonkEnv -> [LRuleDecl TcId] -> TcM [LRuleDecl Id]
931 zonkRules env rs = mappM (wrapLocM (zonkRule env)) rs
933 zonkRule :: ZonkEnv -> RuleDecl TcId -> TcM (RuleDecl Id)
934 zonkRule env (HsRule name act (vars{-::[RuleBndr TcId]-}) lhs fv_lhs rhs fv_rhs)
935 = mappM zonk_bndr vars `thenM` \ new_bndrs ->
936 newMutVar emptyVarSet `thenM` \ unbound_tv_set ->
938 env_rhs = extendZonkEnv env [id | b <- new_bndrs, let id = unLoc b, isId id]
939 -- Type variables don't need an envt
940 -- They are bound through the mutable mechanism
942 env_lhs = setZonkType env_rhs (zonkTypeCollecting unbound_tv_set)
943 -- We need to gather the type variables mentioned on the LHS so we can
944 -- quantify over them. Example:
950 -- {-# RULES "myrule" foo C = 1 #-}
952 -- After type checking the LHS becomes (foo a (C a))
953 -- and we do not want to zap the unbound tyvar 'a' to (), because
954 -- that limits the applicability of the rule. Instead, we
955 -- want to quantify over it!
957 -- It's easiest to find the free tyvars here. Attempts to do so earlier
958 -- are tiresome, because (a) the data type is big and (b) finding the
959 -- free type vars of an expression is necessarily monadic operation.
960 -- (consider /\a -> f @ b, where b is side-effected to a)
962 zonkLExpr env_lhs lhs `thenM` \ new_lhs ->
963 zonkLExpr env_rhs rhs `thenM` \ new_rhs ->
965 readMutVar unbound_tv_set `thenM` \ unbound_tvs ->
967 final_bndrs :: [Located Var]
968 final_bndrs = map noLoc (varSetElems unbound_tvs) ++ new_bndrs
970 returnM (HsRule name act (map RuleBndr final_bndrs) new_lhs fv_lhs new_rhs fv_rhs)
971 -- I hate this map RuleBndr stuff
973 zonk_bndr (RuleBndr v)
974 | isId (unLoc v) = wrapLocM (zonkIdBndr env) v
975 | otherwise = ASSERT( isImmutableTyVar (unLoc v) )
977 zonk_bndr (RuleBndrSig {}) = panic "zonk_bndr RuleBndrSig"
981 %************************************************************************
983 \subsection[BackSubst-Foreign]{Foreign exports}
985 %************************************************************************
988 zonkTcTypeToType :: ZonkEnv -> TcType -> TcM Type
989 zonkTcTypeToType (ZonkEnv zonk_ty _) ty = zonk_ty ty
991 zonkTcTypeToTypes :: ZonkEnv -> [TcType] -> TcM [Type]
992 zonkTcTypeToTypes env tys = mapM (zonkTcTypeToType env) tys
994 zonkTypeCollecting :: TcRef TyVarSet -> TcType -> TcM Type
995 -- This variant collects unbound type variables in a mutable variable
996 zonkTypeCollecting unbound_tv_set
997 = zonkType zonk_unbound_tyvar
999 zonk_unbound_tyvar tv
1000 = zonkQuantifiedTyVar tv `thenM` \ tv' ->
1001 readMutVar unbound_tv_set `thenM` \ tv_set ->
1002 writeMutVar unbound_tv_set (extendVarSet tv_set tv') `thenM_`
1003 return (mkTyVarTy tv')
1005 zonkTypeZapping :: TcType -> TcM Type
1006 -- This variant is used for everything except the LHS of rules
1007 -- It zaps unbound type variables to (), or some other arbitrary type
1009 = zonkType zonk_unbound_tyvar ty
1011 -- Zonk a mutable but unbound type variable to an arbitrary type
1012 -- We know it's unbound even though we don't carry an environment,
1013 -- because at the binding site for a type variable we bind the
1014 -- mutable tyvar to a fresh immutable one. So the mutable store
1015 -- plays the role of an environment. If we come across a mutable
1016 -- type variable that isn't so bound, it must be completely free.
1017 zonk_unbound_tyvar tv = do { ty <- mkArbitraryType warn tv
1018 ; writeMetaTyVar tv ty
1021 warn span msg = setSrcSpan span (addWarnTc msg)
1024 {- Note [Strangely-kinded void TyCons]
1025 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1026 See Trac #959 for more examples
1028 When the type checker finds a type variable with no binding, which
1029 means it can be instantiated with an arbitrary type, it usually
1030 instantiates it to Void. Eg.
1034 length Void (Nil Void)
1036 But in really obscure programs, the type variable might have a kind
1037 other than *, so we need to invent a suitably-kinded type.
1042 Tuple for kind *->...*->*
1044 which deals with most cases. (Previously, it only dealt with
1047 In the other cases, it just makes up a TyCon with a suitable kind. If
1048 this gets into an interface file, anyone reading that file won't
1049 understand it. This is fixable (by making the client of the interface
1050 file make up a TyCon too) but it is tiresome and never happens, so I
1053 Meanwhile I have now fixed GHC to emit a civilized warning.
1056 mkArbitraryType :: (SrcSpan -> SDoc -> TcRnIf g l a) -- How to complain
1058 -> TcRnIf g l Type -- Used by desugarer too
1059 -- Make up an arbitrary type whose kind is the same as the tyvar.
1060 -- We'll use this to instantiate the (unbound) tyvar.
1062 -- Also used by the desugarer; hence the (tiresome) parameter
1063 -- to use when generating a warning
1064 mkArbitraryType warn tv
1065 | liftedTypeKind `isSubKind` kind -- The vastly common case
1067 | eqKind kind (tyConKind anyPrimTyCon1) -- @*->*@
1068 = return (mkTyConApp anyPrimTyCon1 []) -- No tuples this size
1069 | all isLiftedTypeKind args -- @*-> ... ->*->*@
1070 , isLiftedTypeKind res -- Horrible hack to make less use
1071 = return (mkTyConApp tup_tc []) -- of mkAnyPrimTyCon
1073 = do { warn (getSrcSpan tv) msg
1074 ; return (mkTyConApp (mkAnyPrimTyCon (getUnique tv) kind) []) }
1075 -- Same name as the tyvar, apart from making it start with a colon (sigh)
1076 -- I dread to think what will happen if this gets out into an
1077 -- interface file. Catastrophe likely. Major sigh.
1080 (args,res) = splitKindFunTys kind
1081 tup_tc = tupleTyCon Boxed (length args)
1083 msg = vcat [ hang (ptext (sLit "Inventing strangely-kinded Any TyCon"))
1084 2 (ptext (sLit "of kind") <+> quotes (ppr kind))
1085 , nest 2 (ptext (sLit "from an instantiation of type variable") <+> quotes (ppr tv))
1086 , ptext (sLit "This warning can be suppressed by a type signature fixing") <+> quotes (ppr tv)
1087 , nest 2 (ptext (sLit "but is harmless without -O (and usually harmless anyway)."))
1088 , ptext (sLit "See http://hackage.haskell.org/trac/ghc/ticket/959 for details") ]