2 % (c) The GRASP/AQUA Project, Glasgow University, 1992-1998
4 \section{Type subsumption and unification}
8 -- Full-blown subsumption
9 tcSubExp, tcFunResTy, tcGen,
10 checkSigTyVars, checkSigTyVarsWrt, bleatEscapedTvs, sigCtxt,
12 -- Various unifications
13 unifyType, unifyTypeList, unifyTheta,
14 unifyKind, unifyKinds, unifyFunKind,
16 preSubType, boxyMatchTypes,
18 --------------------------------
20 tcInfer, subFunTys, unBox, stripBoxyType, withBox,
21 boxyUnify, boxyUnifyList, zapToMonotype,
22 boxySplitListTy, boxySplitTyConApp, boxySplitAppTy,
26 #include "HsVersions.h"
28 import HsSyn ( ExprCoFn(..), idCoercion, isIdCoercion, (<.>),
29 mkCoLams, mkCoTyLams, mkCoApps )
30 import TypeRep ( Type(..), PredType(..) )
32 import TcMType ( lookupTcTyVar, LookupTyVarResult(..),
33 tcInstSkolType, tcInstBoxyTyVar, newKindVar, newMetaTyVar,
34 newBoxyTyVar, newBoxyTyVarTys, readFilledBox,
35 readMetaTyVar, writeMetaTyVar, newFlexiTyVarTy,
36 tcInstSkolTyVars, tcInstTyVar,
37 zonkTcKind, zonkType, zonkTcType, zonkTcTyVarsAndFV,
38 readKindVar, writeKindVar )
39 import TcSimplify ( tcSimplifyCheck )
40 import TcEnv ( tcGetGlobalTyVars, findGlobals )
41 import TcIface ( checkWiredInTyCon )
42 import TcRnMonad -- TcType, amongst others
43 import TcType ( TcKind, TcType, TcTyVar, BoxyTyVar, TcTauType,
44 BoxySigmaType, BoxyRhoType, BoxyType,
45 TcTyVarSet, TcThetaType, TcTyVarDetails(..), BoxInfo(..),
46 SkolemInfo( GenSkol, UnkSkol ), MetaDetails(..), isImmutableTyVar,
47 pprSkolTvBinding, isTauTy, isTauTyCon, isSigmaTy,
48 mkFunTy, mkFunTys, mkTyConApp, isMetaTyVar,
49 tcSplitForAllTys, tcSplitAppTy_maybe, tcSplitFunTys, mkTyVarTys,
50 tcSplitSigmaTy, tyVarsOfType, mkPhiTy, mkTyVarTy, mkPredTy,
51 typeKind, mkForAllTys, mkAppTy, isBoxyTyVar,
52 tcView, exactTyVarsOfType,
53 tidyOpenType, tidyOpenTyVar, tidyOpenTyVars,
54 pprType, tidyKind, tidySkolemTyVar, isSkolemTyVar, isSigTyVar,
55 TvSubst, mkTvSubst, zipTyEnv, zipOpenTvSubst, emptyTvSubst,
57 lookupTyVar, extendTvSubst )
58 import Type ( Kind, SimpleKind, KindVar,
59 openTypeKind, liftedTypeKind, unliftedTypeKind,
60 mkArrowKind, defaultKind,
61 argTypeKind, isLiftedTypeKind, isUnliftedTypeKind,
62 isSubKind, pprKind, splitKindFunTys, isSubKindCon,
63 isOpenTypeKind, isArgTypeKind )
64 import TysPrim ( alphaTy, betaTy )
65 import Inst ( newDictBndrsO, instCall, instToId )
66 import TyCon ( TyCon, tyConArity, tyConTyVars, isSynTyCon )
67 import TysWiredIn ( listTyCon )
69 import Var ( Var, varName, tyVarKind, isTcTyVar, tcTyVarDetails )
72 import Name ( Name, isSystemName )
73 import ErrUtils ( Message )
74 import Maybes ( expectJust, isNothing )
75 import BasicTypes ( Arity )
76 import Util ( notNull, equalLength )
81 import TcType ( isBoxyTy, isFlexi )
85 %************************************************************************
87 \subsection{'hole' type variables}
89 %************************************************************************
92 tcInfer :: (BoxyType -> TcM a) -> TcM (a, TcType)
94 = do { box <- newBoxyTyVar openTypeKind
95 ; res <- tc_infer (mkTyVarTy box)
96 ; res_ty <- readFilledBox box -- Guaranteed filled-in by now
97 ; return (res, res_ty) }
101 %************************************************************************
105 %************************************************************************
108 subFunTys :: SDoc -- Somthing like "The function f has 3 arguments"
109 -- or "The abstraction (\x.e) takes 1 argument"
110 -> Arity -- Expected # of args
111 -> BoxyRhoType -- res_ty
112 -> ([BoxySigmaType] -> BoxyRhoType -> TcM a)
114 -- Attempt to decompse res_ty to have enough top-level arrows to
115 -- match the number of patterns in the match group
117 -- If (subFunTys n_args res_ty thing_inside) = (co_fn, res)
118 -- and the inner call to thing_inside passes args: [a1,...,an], b
119 -- then co_fn :: (a1 -> ... -> an -> b) -> res_ty
121 -- Note that it takes a BoxyRho type, and guarantees to return a BoxyRhoType
124 {- Error messages from subFunTys
126 The abstraction `\Just 1 -> ...' has two arguments
127 but its type `Maybe a -> a' has only one
129 The equation(s) for `f' have two arguments
130 but its type `Maybe a -> a' has only one
132 The section `(f 3)' requires 'f' to take two arguments
133 but its type `Int -> Int' has only one
135 The function 'f' is applied to two arguments
136 but its type `Int -> Int' has only one
140 subFunTys error_herald n_pats res_ty thing_inside
141 = loop n_pats [] res_ty
143 -- In 'loop', the parameter 'arg_tys' accumulates
144 -- the arg types so far, in *reverse order*
145 loop n args_so_far res_ty
146 | Just res_ty' <- tcView res_ty = loop n args_so_far res_ty'
148 loop n args_so_far res_ty
149 | isSigmaTy res_ty -- Do this before checking n==0, because we
150 -- guarantee to return a BoxyRhoType, not a BoxySigmaType
151 = do { (gen_fn, (co_fn, res)) <- tcGen res_ty emptyVarSet $ \ res_ty' ->
152 loop n args_so_far res_ty'
153 ; return (gen_fn <.> co_fn, res) }
155 loop 0 args_so_far res_ty
156 = do { res <- thing_inside (reverse args_so_far) res_ty
157 ; return (idCoercion, res) }
159 loop n args_so_far (FunTy arg_ty res_ty)
160 = do { (co_fn, res) <- loop (n-1) (arg_ty:args_so_far) res_ty
161 ; co_fn' <- wrapFunResCoercion [arg_ty] co_fn
162 ; return (co_fn', res) }
164 -- res_ty might have a type variable at the head, such as (a b c),
165 -- in which case we must fill in with (->). Simplest thing to do
166 -- is to use boxyUnify, but we catch failure and generate our own
167 -- error message on failure
168 loop n args_so_far res_ty@(AppTy _ _)
169 = do { [arg_ty',res_ty'] <- newBoxyTyVarTys [argTypeKind, openTypeKind]
170 ; (_, mb_unit) <- tryTcErrs $ boxyUnify res_ty (FunTy arg_ty' res_ty')
171 ; if isNothing mb_unit then bale_out args_so_far
172 else loop n args_so_far (FunTy arg_ty' res_ty') }
174 loop n args_so_far (TyVarTy tv)
175 | not (isImmutableTyVar tv)
176 = do { cts <- readMetaTyVar tv
178 Indirect ty -> loop n args_so_far ty
179 Flexi -> do { (res_ty:arg_tys) <- withMetaTvs tv kinds mk_res_ty
180 ; res <- thing_inside (reverse args_so_far ++ arg_tys) res_ty
181 ; return (idCoercion, res) } }
183 mk_res_ty (res_ty' : arg_tys') = mkFunTys arg_tys' res_ty'
184 mk_res_ty [] = panic "TcUnify.mk_res_ty1"
185 kinds = openTypeKind : take n (repeat argTypeKind)
186 -- Note argTypeKind: the args can have an unboxed type,
187 -- but not an unboxed tuple.
189 loop n args_so_far res_ty = bale_out args_so_far
192 = do { env0 <- tcInitTidyEnv
193 ; res_ty' <- zonkTcType res_ty
194 ; let (env1, res_ty'') = tidyOpenType env0 res_ty'
195 ; failWithTcM (env1, mk_msg res_ty'' (length args_so_far)) }
197 mk_msg res_ty n_actual
198 = error_herald <> comma $$
199 sep [ptext SLIT("but its type") <+> quotes (pprType res_ty),
200 if n_actual == 0 then ptext SLIT("has none")
201 else ptext SLIT("has only") <+> speakN n_actual]
205 ----------------------
206 boxySplitTyConApp :: TyCon -- T :: k1 -> ... -> kn -> *
207 -> BoxyRhoType -- Expected type (T a b c)
208 -> TcM [BoxySigmaType] -- Element types, a b c
209 -- It's used for wired-in tycons, so we call checkWiredInTyCOn
210 -- Precondition: never called with FunTyCon
211 -- Precondition: input type :: *
213 boxySplitTyConApp tc orig_ty
214 = do { checkWiredInTyCon tc
215 ; loop (tyConArity tc) [] orig_ty }
217 loop n_req args_so_far ty
218 | Just ty' <- tcView ty = loop n_req args_so_far ty'
220 loop n_req args_so_far (TyConApp tycon args)
222 = ASSERT( n_req == length args) -- ty::*
223 return (args ++ args_so_far)
225 loop n_req args_so_far (AppTy fun arg)
226 = loop (n_req - 1) (arg:args_so_far) fun
228 loop n_req args_so_far (TyVarTy tv)
229 | not (isImmutableTyVar tv)
230 = do { cts <- readMetaTyVar tv
232 Indirect ty -> loop n_req args_so_far ty
233 Flexi -> do { arg_tys <- withMetaTvs tv arg_kinds mk_res_ty
234 ; return (arg_tys ++ args_so_far) }
237 mk_res_ty arg_tys' = mkTyConApp tc arg_tys'
238 arg_kinds = map tyVarKind (take n_req (tyConTyVars tc))
240 loop _ _ _ = boxySplitFailure (mkTyConApp tc (mkTyVarTys (tyConTyVars tc))) orig_ty
242 ----------------------
243 boxySplitListTy :: BoxyRhoType -> TcM BoxySigmaType -- Special case for lists
244 boxySplitListTy exp_ty = do { [elt_ty] <- boxySplitTyConApp listTyCon exp_ty
248 ----------------------
249 boxySplitAppTy :: BoxyRhoType -- Type to split: m a
250 -> TcM (BoxySigmaType, BoxySigmaType) -- Returns m, a
251 -- Assumes (m: * -> k), where k is the kind of the incoming type
252 -- If the incoming type is boxy, then so are the result types; and vice versa
254 boxySplitAppTy orig_ty
258 | Just ty' <- tcView ty = loop ty'
261 | Just (fun_ty, arg_ty) <- tcSplitAppTy_maybe ty
262 = return (fun_ty, arg_ty)
265 | not (isImmutableTyVar tv)
266 = do { cts <- readMetaTyVar tv
268 Indirect ty -> loop ty
269 Flexi -> do { [fun_ty,arg_ty] <- withMetaTvs tv kinds mk_res_ty
270 ; return (fun_ty, arg_ty) } }
272 mk_res_ty [fun_ty', arg_ty'] = mkAppTy fun_ty' arg_ty'
273 mk_res_ty other = panic "TcUnify.mk_res_ty2"
274 tv_kind = tyVarKind tv
275 kinds = [mkArrowKind liftedTypeKind (defaultKind tv_kind),
277 liftedTypeKind] -- arg type :: *
278 -- The defaultKind is a bit smelly. If you remove it,
279 -- try compiling f x = do { x }
280 -- and you'll get a kind mis-match. It smells, but
281 -- not enough to lose sleep over.
283 loop _ = boxySplitFailure (mkAppTy alphaTy betaTy) orig_ty
286 boxySplitFailure actual_ty expected_ty
287 = unifyMisMatch False False actual_ty expected_ty
288 -- "outer" is False, so we don't pop the context
289 -- which is what we want since we have not pushed one!
293 --------------------------------
294 -- withBoxes: the key utility function
295 --------------------------------
298 withMetaTvs :: TcTyVar -- An unfilled-in, non-skolem, meta type variable
299 -> [Kind] -- Make fresh boxes (with the same BoxTv/TauTv setting as tv)
300 -> ([BoxySigmaType] -> BoxySigmaType)
301 -- Constructs the type to assign
302 -- to the original var
303 -> TcM [BoxySigmaType] -- Return the fresh boxes
305 -- It's entirely possible for the [kind] to be empty.
306 -- For example, when pattern-matching on True,
307 -- we call boxySplitTyConApp passing a boolTyCon
309 -- Invariant: tv is still Flexi
311 withMetaTvs tv kinds mk_res_ty
313 = do { box_tvs <- mapM (newMetaTyVar BoxTv) kinds
314 ; let box_tys = mkTyVarTys box_tvs
315 ; writeMetaTyVar tv (mk_res_ty box_tys)
318 | otherwise -- Non-boxy meta type variable
319 = do { tau_tys <- mapM newFlexiTyVarTy kinds
320 ; writeMetaTyVar tv (mk_res_ty tau_tys) -- Write it *first*
321 -- Sure to be a tau-type
324 withBox :: Kind -> (BoxySigmaType -> TcM a) -> TcM (a, TcType)
325 -- Allocate a *boxy* tyvar
326 withBox kind thing_inside
327 = do { box_tv <- newMetaTyVar BoxTv kind
328 ; res <- thing_inside (mkTyVarTy box_tv)
329 ; ty <- readFilledBox box_tv
334 %************************************************************************
336 Approximate boxy matching
338 %************************************************************************
341 preSubType :: [TcTyVar] -- Quantified type variables
342 -> TcTyVarSet -- Subset of quantified type variables
343 -- see Note [Pre-sub boxy]
344 -> TcType -- The rho-type part; quantified tyvars scopes over this
345 -> BoxySigmaType -- Matching type from the context
346 -> TcM [TcType] -- Types to instantiate the tyvars
347 -- Perform pre-subsumption, and return suitable types
348 -- to instantiate the quantified type varibles:
349 -- info from the pre-subsumption, if there is any
350 -- a boxy type variable otherwise
352 -- Note [Pre-sub boxy]
353 -- The 'btvs' are a subset of 'qtvs'. They are the ones we can
354 -- instantiate to a boxy type variable, because they'll definitely be
355 -- filled in later. This isn't always the case; sometimes we have type
356 -- variables mentioned in the context of the type, but not the body;
357 -- f :: forall a b. C a b => a -> a
358 -- Then we may land up with an unconstrained 'b', so we want to
359 -- instantiate it to a monotype (non-boxy) type variable
361 -- The 'qtvs' that are *neither* fixed by the pre-subsumption, *nor* are in 'btvs',
362 -- are instantiated to TauTv meta variables.
364 preSubType qtvs btvs qty expected_ty
365 = do { tys <- mapM inst_tv qtvs
366 ; traceTc (text "preSubType" <+> (ppr qtvs $$ ppr btvs $$ ppr qty $$ ppr expected_ty $$ ppr pre_subst $$ ppr tys))
369 pre_subst = boxySubMatchType (mkVarSet qtvs) qty expected_ty
371 | Just boxy_ty <- lookupTyVar pre_subst tv = return boxy_ty
372 | tv `elemVarSet` btvs = do { tv' <- tcInstBoxyTyVar tv
373 ; return (mkTyVarTy tv') }
374 | otherwise = do { tv' <- tcInstTyVar tv
375 ; return (mkTyVarTy tv') }
378 :: TcTyVarSet -> TcType -- The "template"; the tyvars are skolems
379 -> BoxyRhoType -- Type to match (note a *Rho* type)
380 -> TvSubst -- Substitution of the [TcTyVar] to BoxySigmaTypes
382 -- boxySubMatchType implements the Pre-subsumption judgement, in Fig 5 of the paper
383 -- "Boxy types: inference for higher rank types and impredicativity"
385 boxySubMatchType tmpl_tvs tmpl_ty boxy_ty
386 = go tmpl_tvs tmpl_ty emptyVarSet boxy_ty
388 go t_tvs t_ty b_tvs b_ty
389 | Just t_ty' <- tcView t_ty = go t_tvs t_ty' b_tvs b_ty
390 | Just b_ty' <- tcView b_ty = go t_tvs t_ty b_tvs b_ty'
392 go t_tvs (TyVarTy _) b_tvs b_ty = emptyTvSubst -- Rule S-ANY; no bindings
393 -- Rule S-ANY covers (a) type variables and (b) boxy types
394 -- in the template. Both look like a TyVarTy.
395 -- See Note [Sub-match] below
397 go t_tvs t_ty b_tvs b_ty
398 | isSigmaTy t_ty, (tvs, _, t_tau) <- tcSplitSigmaTy t_ty
399 = go (t_tvs `delVarSetList` tvs) t_tau b_tvs b_ty -- Rule S-SPEC
400 -- Under a forall on the left, if there is shadowing,
401 -- do not bind! Hence the delVarSetList.
402 | isSigmaTy b_ty, (tvs, _, b_tau) <- tcSplitSigmaTy b_ty
403 = go t_tvs t_ty (extendVarSetList b_tvs tvs) b_tau -- Rule S-SKOL
404 -- Add to the variables we must not bind to
405 -- NB: it's *important* to discard the theta part. Otherwise
406 -- consider (forall a. Eq a => a -> b) ~<~ (Int -> Int -> Bool)
407 -- and end up with a completely bogus binding (b |-> Bool), by lining
408 -- up the (Eq a) with the Int, whereas it should be (b |-> (Int->Bool)).
409 -- This pre-subsumption stuff can return too few bindings, but it
410 -- must *never* return bogus info.
412 go t_tvs (FunTy arg1 res1) b_tvs (FunTy arg2 res2) -- Rule S-FUN
413 = boxy_match t_tvs arg1 b_tvs arg2 (go t_tvs res1 b_tvs res2)
414 -- Match the args, and sub-match the results
416 go t_tvs t_ty b_tvs b_ty = boxy_match t_tvs t_ty b_tvs b_ty emptyTvSubst
417 -- Otherwise defer to boxy matching
418 -- This covers TyConApp, AppTy, PredTy
425 |- head xs : <rhobox>
426 We will do a boxySubMatchType between a ~ <rhobox>
427 But we *don't* want to match [a |-> <rhobox>] because
428 (a) The box should be filled in with a rho-type, but
429 but the returned substitution maps TyVars to boxy
431 (b) In any case, the right final answer might be *either*
432 instantiate 'a' with a rho-type or a sigma type
433 head xs : Int vs head xs : forall b. b->b
434 So the matcher MUST NOT make a choice here. In general, we only
435 bind a template type variable in boxyMatchType, not in boxySubMatchType.
440 :: TcTyVarSet -> [TcType] -- The "template"; the tyvars are skolems
441 -> [BoxySigmaType] -- Type to match
442 -> TvSubst -- Substitution of the [TcTyVar] to BoxySigmaTypes
444 -- boxyMatchTypes implements the Pre-matching judgement, in Fig 5 of the paper
445 -- "Boxy types: inference for higher rank types and impredicativity"
447 -- Find a *boxy* substitution that makes the template look as much
448 -- like the BoxySigmaType as possible.
449 -- It's always ok to return an empty substitution;
450 -- anything more is jam on the pudding
452 -- NB1: This is a pure, non-monadic function.
453 -- It does no unification, and cannot fail
455 -- Precondition: the arg lengths are equal
456 -- Precondition: none of the template type variables appear anywhere in the [BoxySigmaType]
460 boxyMatchTypes tmpl_tvs tmpl_tys boxy_tys
461 = ASSERT( length tmpl_tys == length boxy_tys )
462 boxy_match_s tmpl_tvs tmpl_tys emptyVarSet boxy_tys emptyTvSubst
463 -- ToDo: add error context?
465 boxy_match_s tmpl_tvs [] boxy_tvs [] subst
467 boxy_match_s tmpl_tvs (t_ty:t_tys) boxy_tvs (b_ty:b_tys) subst
468 = boxy_match tmpl_tvs t_ty boxy_tvs b_ty $
469 boxy_match_s tmpl_tvs t_tys boxy_tvs b_tys subst
470 boxy_match_s tmpl_tvs _ boxy_tvs _ subst
471 = panic "boxy_match_s" -- Lengths do not match
475 boxy_match :: TcTyVarSet -> TcType -- Template
476 -> TcTyVarSet -- boxy_tvs: do not bind template tyvars to any of these
477 -> BoxySigmaType -- Match against this type
481 -- The boxy_tvs argument prevents this match:
482 -- [a] forall b. a ~ forall b. b
483 -- We don't want to bind the template variable 'a'
484 -- to the quantified type variable 'b'!
486 boxy_match tmpl_tvs orig_tmpl_ty boxy_tvs orig_boxy_ty subst
487 = go orig_tmpl_ty orig_boxy_ty
490 | Just t_ty' <- tcView t_ty = go t_ty' b_ty
491 | Just b_ty' <- tcView b_ty = go t_ty b_ty'
493 go ty1 ty2 -- C.f. the isSigmaTy case for boxySubMatchType
495 , (tvs1, _, tau1) <- tcSplitSigmaTy ty1
496 , (tvs2, _, tau2) <- tcSplitSigmaTy ty2
497 , equalLength tvs1 tvs2
498 = boxy_match (tmpl_tvs `delVarSetList` tvs1) tau1
499 (boxy_tvs `extendVarSetList` tvs2) tau2 subst
501 go (TyConApp tc1 tys1) (TyConApp tc2 tys2)
502 | tc1 == tc2 = go_s tys1 tys2
504 go (FunTy arg1 res1) (FunTy arg2 res2)
505 = go_s [arg1,res1] [arg2,res2]
508 | Just (s1,t1) <- tcSplitAppTy_maybe t_ty,
509 Just (s2,t2) <- tcSplitAppTy_maybe b_ty,
510 typeKind t2 `isSubKind` typeKind t1 -- Maintain invariant
511 = go_s [s1,t1] [s2,t2]
514 | tv `elemVarSet` tmpl_tvs -- Template type variable in the template
515 , boxy_tvs `disjointVarSet` tyVarsOfType orig_boxy_ty
516 , typeKind b_ty `isSubKind` tyVarKind tv -- See Note [Matching kinds]
517 = extendTvSubst subst tv boxy_ty'
519 = subst -- Ignore others
521 boxy_ty' = case lookupTyVar subst tv of
522 Nothing -> orig_boxy_ty
523 Just ty -> ty `boxyLub` orig_boxy_ty
525 go _ _ = emptyTvSubst -- It's important to *fail* by returning the empty substitution
526 -- Example: Tree a ~ Maybe Int
527 -- We do not want to bind (a |-> Int) in pre-matching, because that can give very
528 -- misleading error messages. An even more confusing case is
529 -- a -> b ~ Maybe Int
530 -- Then we do not want to bind (b |-> Int)! It's always safe to discard bindings
531 -- from this pre-matching phase.
534 go_s tys1 tys2 = boxy_match_s tmpl_tvs tys1 boxy_tvs tys2 subst
537 boxyLub :: BoxySigmaType -> BoxySigmaType -> BoxySigmaType
538 -- Combine boxy information from the two types
539 -- If there is a conflict, return the first
540 boxyLub orig_ty1 orig_ty2
541 = go orig_ty1 orig_ty2
543 go (AppTy f1 a1) (AppTy f2 a2) = AppTy (boxyLub f1 f2) (boxyLub a1 a2)
544 go (FunTy f1 a1) (FunTy f2 a2) = FunTy (boxyLub f1 f2) (boxyLub a1 a2)
545 go (TyConApp tc1 ts1) (TyConApp tc2 ts2)
546 | tc1 == tc2, length ts1 == length ts2
547 = TyConApp tc1 (zipWith boxyLub ts1 ts2)
549 go (TyVarTy tv1) ty2 -- This is the whole point;
550 | isTcTyVar tv1, isBoxyTyVar tv1 -- choose ty2 if ty2 is a box
553 -- Look inside type synonyms, but only if the naive version fails
554 go ty1 ty2 | Just ty1' <- tcView ty1 = go ty1' ty2
555 | Just ty2' <- tcView ty1 = go ty1 ty2'
557 -- For now, we don't look inside ForAlls, PredTys
558 go ty1 ty2 = orig_ty1 -- Default
561 Note [Matching kinds]
562 ~~~~~~~~~~~~~~~~~~~~~
563 The target type might legitimately not be a sub-kind of template.
564 For example, suppose the target is simply a box with an OpenTypeKind,
565 and the template is a type variable with LiftedTypeKind.
566 Then it's ok (because the target type will later be refined).
567 We simply don't bind the template type variable.
569 It might also be that the kind mis-match is an error. For example,
570 suppose we match the template (a -> Int) against (Int# -> Int),
571 where the template type variable 'a' has LiftedTypeKind. This
572 matching function does not fail; it simply doesn't bind the template.
573 Later stuff will fail.
575 %************************************************************************
579 %************************************************************************
581 All the tcSub calls have the form
583 tcSub expected_ty offered_ty
585 offered_ty <= expected_ty
587 That is, that a value of type offered_ty is acceptable in
588 a place expecting a value of type expected_ty.
590 It returns a coercion function
591 co_fn :: offered_ty -> expected_ty
592 which takes an HsExpr of type offered_ty into one of type
597 tcSubExp :: BoxySigmaType -> BoxySigmaType -> TcM ExprCoFn -- Locally used only
598 -- (tcSub act exp) checks that
600 tcSubExp actual_ty expected_ty
601 = -- addErrCtxtM (unifyCtxt actual_ty expected_ty) $
602 -- Adding the error context here leads to some very confusing error
603 -- messages, such as "can't match forall a. a->a with forall a. a->a"
604 -- Example is tcfail165:
605 -- do var <- newEmptyMVar :: IO (MVar (forall a. Show a => a -> String))
606 -- putMVar var (show :: forall a. Show a => a -> String)
607 -- Here the info does not flow from the 'var' arg of putMVar to its 'show' arg
608 -- but after zonking it looks as if it does!
610 -- So instead I'm adding the error context when moving from tc_sub to u_tys
612 traceTc (text "tcSubExp" <+> ppr actual_ty <+> ppr expected_ty) >>
613 tc_sub SubOther actual_ty actual_ty False expected_ty expected_ty
615 tcFunResTy :: Name -> BoxySigmaType -> BoxySigmaType -> TcM ExprCoFn -- Locally used only
616 tcFunResTy fun actual_ty expected_ty
617 = traceTc (text "tcFunResTy" <+> ppr actual_ty <+> ppr expected_ty) >>
618 tc_sub (SubFun fun) actual_ty actual_ty False expected_ty expected_ty
621 data SubCtxt = SubDone -- Error-context already pushed
622 | SubFun Name -- Context is tcFunResTy
623 | SubOther -- Context is something else
625 tc_sub :: SubCtxt -- How to add an error-context
626 -> BoxySigmaType -- actual_ty, before expanding synonyms
627 -> BoxySigmaType -- ..and after
628 -> InBox -- True <=> expected_ty is inside a box
629 -> BoxySigmaType -- expected_ty, before
630 -> BoxySigmaType -- ..and after
632 -- The acual_ty is never inside a box
633 -- IMPORTANT pre-condition: if the args contain foralls, the bound type
634 -- variables are visible non-monadically
635 -- (i.e. tha args are sufficiently zonked)
636 -- This invariant is needed so that we can "see" the foralls, ad
637 -- e.g. in the SPEC rule where we just use splitSigmaTy
639 tc_sub sub_ctxt act_sty act_ty exp_ib exp_sty exp_ty
640 = tc_sub1 sub_ctxt act_sty act_ty exp_ib exp_sty exp_ty
641 -- This indirection is just here to make
642 -- it easy to insert a debug trace!
644 tc_sub1 sub_ctxt act_sty act_ty exp_ib exp_sty exp_ty
645 | Just exp_ty' <- tcView exp_ty = tc_sub sub_ctxt act_sty act_ty exp_ib exp_sty exp_ty'
646 tc_sub1 sub_ctxt act_sty act_ty exp_ib exp_sty exp_ty
647 | Just act_ty' <- tcView act_ty = tc_sub sub_ctxt act_sty act_ty' exp_ib exp_sty exp_ty
649 -----------------------------------
650 -- Rule SBOXY, plus other cases when act_ty is a type variable
651 -- Just defer to boxy matching
652 -- This rule takes precedence over SKOL!
653 tc_sub1 sub_ctxt act_sty (TyVarTy tv) exp_ib exp_sty exp_ty
654 = do { addSubCtxt sub_ctxt act_sty exp_sty $
655 uVar True False tv exp_ib exp_sty exp_ty
656 ; return idCoercion }
658 -----------------------------------
659 -- Skolemisation case (rule SKOL)
660 -- actual_ty: d:Eq b => b->b
661 -- expected_ty: forall a. Ord a => a->a
662 -- co_fn e /\a. \d2:Ord a. let d = eqFromOrd d2 in e
664 -- It is essential to do this *before* the specialisation case
665 -- Example: f :: (Eq a => a->a) -> ...
666 -- g :: Ord b => b->b
669 tc_sub1 sub_ctxt act_sty act_ty exp_ib exp_sty exp_ty
670 | not exp_ib, -- SKOL does not apply if exp_ty is inside a box
672 = do { (gen_fn, co_fn) <- tcGen exp_ty act_tvs $ \ body_exp_ty ->
673 tc_sub sub_ctxt act_sty act_ty False body_exp_ty body_exp_ty
674 ; return (gen_fn <.> co_fn) }
676 act_tvs = tyVarsOfType act_ty
677 -- It's really important to check for escape wrt
678 -- the free vars of both expected_ty *and* actual_ty
680 -----------------------------------
681 -- Specialisation case (rule ASPEC):
682 -- actual_ty: forall a. Ord a => a->a
683 -- expected_ty: Int -> Int
684 -- co_fn e = e Int dOrdInt
686 tc_sub1 sub_ctxt act_sty actual_ty exp_ib exp_sty expected_ty
687 -- Implements the new SPEC rule in the Appendix of the paper
688 -- "Boxy types: inference for higher rank types and impredicativity"
689 -- (This appendix isn't in the published version.)
690 -- The idea is to *first* do pre-subsumption, and then full subsumption
691 -- Example: forall a. a->a <= Int -> (forall b. Int)
692 -- Pre-subsumpion finds a|->Int, and that works fine, whereas
693 -- just running full subsumption would fail.
694 | isSigmaTy actual_ty
695 = do { -- Perform pre-subsumption, and instantiate
696 -- the type with info from the pre-subsumption;
697 -- boxy tyvars if pre-subsumption gives no info
698 let (tyvars, theta, tau) = tcSplitSigmaTy actual_ty
699 tau_tvs = exactTyVarsOfType tau
700 ; inst_tys <- if exp_ib then -- Inside a box, do not do clever stuff
701 do { tyvars' <- mapM tcInstBoxyTyVar tyvars
702 ; return (mkTyVarTys tyvars') }
703 else -- Outside, do clever stuff
704 preSubType tyvars tau_tvs tau expected_ty
705 ; let subst' = zipOpenTvSubst tyvars inst_tys
706 tau' = substTy subst' tau
708 -- Perform a full subsumption check
709 ; traceTc (text "tc_sub_spec" <+> vcat [ppr actual_ty,
710 ppr tyvars <+> ppr theta <+> ppr tau,
712 ; co_fn2 <- tc_sub sub_ctxt tau' tau' exp_ib exp_sty expected_ty
714 -- Deal with the dictionaries
715 ; co_fn1 <- instCall InstSigOrigin inst_tys (substTheta subst' theta)
716 ; return (co_fn2 <.> co_fn1) }
718 -----------------------------------
719 -- Function case (rule F1)
720 tc_sub1 sub_ctxt act_sty (FunTy act_arg act_res) exp_ib exp_sty (FunTy exp_arg exp_res)
721 = addSubCtxt sub_ctxt act_sty exp_sty $
722 tc_sub_funs act_arg act_res exp_ib exp_arg exp_res
724 -- Function case (rule F2)
725 tc_sub1 sub_ctxt act_sty act_ty@(FunTy act_arg act_res) _ exp_sty (TyVarTy exp_tv)
727 = addSubCtxt sub_ctxt act_sty exp_sty $
728 do { cts <- readMetaTyVar exp_tv
730 Indirect ty -> tc_sub SubDone act_sty act_ty True exp_sty ty
731 Flexi -> do { [arg_ty,res_ty] <- withMetaTvs exp_tv fun_kinds mk_res_ty
732 ; tc_sub_funs act_arg act_res True arg_ty res_ty } }
734 mk_res_ty [arg_ty', res_ty'] = mkFunTy arg_ty' res_ty'
735 mk_res_ty other = panic "TcUnify.mk_res_ty3"
736 fun_kinds = [argTypeKind, openTypeKind]
738 -- Everything else: defer to boxy matching
739 tc_sub1 sub_ctxt act_sty actual_ty exp_ib exp_sty expected_ty
740 = do { addSubCtxt sub_ctxt act_sty exp_sty $
741 u_tys True False act_sty actual_ty exp_ib exp_sty expected_ty
742 ; return idCoercion }
745 -----------------------------------
746 tc_sub_funs act_arg act_res exp_ib exp_arg exp_res
747 = do { uTys False act_arg exp_ib exp_arg
748 ; co_fn_res <- tc_sub SubDone act_res act_res exp_ib exp_res exp_res
749 ; wrapFunResCoercion [exp_arg] co_fn_res }
751 -----------------------------------
753 :: [TcType] -- Type of args
754 -> ExprCoFn -- HsExpr a -> HsExpr b
755 -> TcM ExprCoFn -- HsExpr (arg_tys -> a) -> HsExpr (arg_tys -> b)
756 wrapFunResCoercion arg_tys co_fn_res
757 | isIdCoercion co_fn_res = return idCoercion
758 | null arg_tys = return co_fn_res
760 = do { arg_ids <- newSysLocalIds FSLIT("sub") arg_tys
761 ; return (mkCoLams arg_ids <.> co_fn_res <.> mkCoApps arg_ids) }
766 %************************************************************************
768 \subsection{Generalisation}
770 %************************************************************************
773 tcGen :: BoxySigmaType -- expected_ty
774 -> TcTyVarSet -- Extra tyvars that the universally
775 -- quantified tyvars of expected_ty
776 -- must not be unified
777 -> (BoxyRhoType -> TcM result) -- spec_ty
778 -> TcM (ExprCoFn, result)
779 -- The expression has type: spec_ty -> expected_ty
781 tcGen expected_ty extra_tvs thing_inside -- We expect expected_ty to be a forall-type
782 -- If not, the call is a no-op
783 = do { -- We want the GenSkol info in the skolemised type variables to
784 -- mention the *instantiated* tyvar names, so that we get a
785 -- good error message "Rigid variable 'a' is bound by (forall a. a->a)"
786 -- Hence the tiresome but innocuous fixM
787 ((forall_tvs, theta, rho_ty), skol_info) <- fixM (\ ~(_, skol_info) ->
788 do { (forall_tvs, theta, rho_ty) <- tcInstSkolType skol_info expected_ty
789 ; span <- getSrcSpanM
790 ; let skol_info = GenSkol forall_tvs (mkPhiTy theta rho_ty) span
791 ; return ((forall_tvs, theta, rho_ty), skol_info) })
794 ; traceTc (text "tcGen" <+> vcat [text "extra_tvs" <+> ppr extra_tvs,
795 text "expected_ty" <+> ppr expected_ty,
796 text "inst ty" <+> ppr forall_tvs <+> ppr theta <+> ppr rho_ty,
797 text "free_tvs" <+> ppr free_tvs,
798 text "forall_tvs" <+> ppr forall_tvs])
801 -- Type-check the arg and unify with poly type
802 ; (result, lie) <- getLIE (thing_inside rho_ty)
804 -- Check that the "forall_tvs" havn't been constrained
805 -- The interesting bit here is that we must include the free variables
806 -- of the expected_ty. Here's an example:
807 -- runST (newVar True)
808 -- Here, if we don't make a check, we'll get a type (ST s (MutVar s Bool))
809 -- for (newVar True), with s fresh. Then we unify with the runST's arg type
810 -- forall s'. ST s' a. That unifies s' with s, and a with MutVar s Bool.
811 -- So now s' isn't unconstrained because it's linked to a.
812 -- Conclusion: include the free vars of the expected_ty in the
813 -- list of "free vars" for the signature check.
815 ; dicts <- newDictBndrsO (SigOrigin skol_info) theta
816 ; inst_binds <- tcSimplifyCheck sig_msg forall_tvs dicts lie
818 ; checkSigTyVarsWrt free_tvs forall_tvs
819 ; traceTc (text "tcGen:done")
822 -- The CoLet binds any Insts which came out of the simplification.
823 dict_ids = map instToId dicts
824 co_fn = mkCoTyLams forall_tvs <.> mkCoLams dict_ids <.> CoLet inst_binds
825 ; returnM (co_fn, result) }
827 free_tvs = tyVarsOfType expected_ty `unionVarSet` extra_tvs
828 sig_msg = ptext SLIT("expected type of an expression")
833 %************************************************************************
837 %************************************************************************
839 The exported functions are all defined as versions of some
840 non-exported generic functions.
843 boxyUnify :: BoxyType -> BoxyType -> TcM ()
844 -- Acutal and expected, respectively
846 = addErrCtxtM (unifyCtxt ty1 ty2) $
847 uTysOuter False ty1 False ty2
850 boxyUnifyList :: [BoxyType] -> [BoxyType] -> TcM ()
851 -- Arguments should have equal length
852 -- Acutal and expected types
853 boxyUnifyList tys1 tys2 = uList boxyUnify tys1 tys2
856 unifyType :: TcTauType -> TcTauType -> TcM ()
857 -- No boxes expected inside these types
858 -- Acutal and expected types
859 unifyType ty1 ty2 -- ty1 expected, ty2 inferred
860 = ASSERT2( not (isBoxyTy ty1), ppr ty1 )
861 ASSERT2( not (isBoxyTy ty2), ppr ty2 )
862 addErrCtxtM (unifyCtxt ty1 ty2) $
863 uTysOuter True ty1 True ty2
866 unifyPred :: PredType -> PredType -> TcM ()
867 -- Acutal and expected types
868 unifyPred p1 p2 = addErrCtxtM (unifyCtxt (mkPredTy p1) (mkPredTy p2)) $
869 uPred True True p1 True p2
871 unifyTheta :: TcThetaType -> TcThetaType -> TcM ()
872 -- Acutal and expected types
873 unifyTheta theta1 theta2
874 = do { checkTc (equalLength theta1 theta2)
875 (ptext SLIT("Contexts differ in length"))
876 ; uList unifyPred theta1 theta2 }
879 uList :: (a -> a -> TcM ())
880 -> [a] -> [a] -> TcM ()
881 -- Unify corresponding elements of two lists of types, which
882 -- should be f equal length. We charge down the list explicitly so that
883 -- we can complain if their lengths differ.
884 uList unify [] [] = return ()
885 uList unify (ty1:tys1) (ty2:tys2) = do { unify ty1 ty2; uList unify tys1 tys2 }
886 uList unify ty1s ty2s = panic "Unify.uList: mismatched type lists!"
889 @unifyTypeList@ takes a single list of @TauType@s and unifies them
890 all together. It is used, for example, when typechecking explicit
891 lists, when all the elts should be of the same type.
894 unifyTypeList :: [TcTauType] -> TcM ()
895 unifyTypeList [] = returnM ()
896 unifyTypeList [ty] = returnM ()
897 unifyTypeList (ty1:tys@(ty2:_)) = do { unifyType ty1 ty2
898 ; unifyTypeList tys }
901 %************************************************************************
903 \subsection[Unify-uTys]{@uTys@: getting down to business}
905 %************************************************************************
907 @uTys@ is the heart of the unifier. Each arg happens twice, because
908 we want to report errors in terms of synomyms if poss. The first of
909 the pair is used in error messages only; it is always the same as the
910 second, except that if the first is a synonym then the second may be a
911 de-synonym'd version. This way we get better error messages.
913 We call the first one \tr{ps_ty1}, \tr{ps_ty2} for ``possible synomym''.
916 type InBox = Bool -- True <=> we are inside a box
917 -- False <=> we are outside a box
918 -- The importance of this is that if we get "filled-box meets
919 -- filled-box", we'll look into the boxes and unify... but
920 -- we must not allow polytypes. But if we are in a box on
921 -- just one side, then we can allow polytypes
923 type Outer = Bool -- True <=> this is the outer level of a unification
924 -- so that the types being unified are the
925 -- very ones we began with, not some sub
926 -- component or synonym expansion
927 -- The idea is that if Outer is true then unifyMisMatch should
928 -- pop the context to remove the "Expected/Acutal" context
931 :: InBox -> TcType -- ty1 is the *expected* type
932 -> InBox -> TcType -- ty2 is the *actual* type
934 uTysOuter nb1 ty1 nb2 ty2 = do { traceTc (text "uTysOuter" <+> ppr ty1 <+> ppr ty2)
935 ; u_tys True nb1 ty1 ty1 nb2 ty2 ty2 }
936 uTys nb1 ty1 nb2 ty2 = do { traceTc (text "uTys" <+> ppr ty1 <+> ppr ty2)
937 ; u_tys False nb1 ty1 ty1 nb2 ty2 ty2 }
941 uTys_s :: InBox -> [TcType] -- ty1 is the *actual* types
942 -> InBox -> [TcType] -- ty2 is the *expected* types
944 uTys_s nb1 [] nb2 [] = returnM ()
945 uTys_s nb1 (ty1:tys1) nb2 (ty2:tys2) = do { uTys nb1 ty1 nb2 ty2
946 ; uTys_s nb1 tys1 nb2 tys2 }
947 uTys_s nb1 ty1s nb2 ty2s = panic "Unify.uTys_s: mismatched type lists!"
951 -> InBox -> TcType -> TcType -- ty1 is the *actual* type
952 -> InBox -> TcType -> TcType -- ty2 is the *expected* type
955 u_tys outer nb1 orig_ty1 ty1 nb2 orig_ty2 ty2
959 -- Always expand synonyms (see notes at end)
960 -- (this also throws away FTVs)
962 | Just ty1' <- tcView ty1 = go False ty1' ty2
963 | Just ty2' <- tcView ty2 = go False ty1 ty2'
965 -- Variables; go for uVar
966 go outer (TyVarTy tyvar1) ty2 = uVar outer False tyvar1 nb2 orig_ty2 ty2
967 go outer ty1 (TyVarTy tyvar2) = uVar outer True tyvar2 nb1 orig_ty1 ty1
968 -- "True" means args swapped
970 go outer (PredTy p1) (PredTy p2) = uPred outer nb1 p1 nb2 p2
972 -- Type constructors must match
973 go _ (TyConApp con1 tys1) (TyConApp con2 tys2)
974 | con1 == con2 = uTys_s nb1 tys1 nb2 tys2
975 -- See Note [TyCon app]
977 -- Functions; just check the two parts
978 go _ (FunTy fun1 arg1) (FunTy fun2 arg2)
979 = do { uTys nb1 fun1 nb2 fun2
980 ; uTys nb1 arg1 nb2 arg2 }
982 -- Applications need a bit of care!
983 -- They can match FunTy and TyConApp, so use splitAppTy_maybe
984 -- NB: we've already dealt with type variables and Notes,
985 -- so if one type is an App the other one jolly well better be too
986 go outer (AppTy s1 t1) ty2
987 | Just (s2,t2) <- tcSplitAppTy_maybe ty2
988 = do { uTys nb1 s1 nb2 s2; uTys nb1 t1 nb2 t2 }
990 -- Now the same, but the other way round
991 -- Don't swap the types, because the error messages get worse
992 go outer ty1 (AppTy s2 t2)
993 | Just (s1,t1) <- tcSplitAppTy_maybe ty1
994 = do { uTys nb1 s1 nb2 s2; uTys nb1 t1 nb2 t2 }
996 go _ ty1@(ForAllTy _ _) ty2@(ForAllTy _ _)
997 | length tvs1 == length tvs2
998 = do { tvs <- tcInstSkolTyVars UnkSkol tvs1 -- Not a helpful SkolemInfo
999 ; let tys = mkTyVarTys tvs
1000 in_scope = mkInScopeSet (mkVarSet tvs)
1001 subst1 = mkTvSubst in_scope (zipTyEnv tvs1 tys)
1002 subst2 = mkTvSubst in_scope (zipTyEnv tvs2 tys)
1003 ; uTys nb1 (substTy subst1 body1) nb2 (substTy subst2 body2)
1005 -- If both sides are inside a box, we are in a "box-meets-box"
1006 -- situation, and we should not have a polytype at all.
1007 -- If we get here we have two boxes, already filled with
1008 -- the same polytype... but it should be a monotype.
1009 -- This check comes last, because the error message is
1010 -- extremely unhelpful.
1011 ; ifM (nb1 && nb2) (notMonoType ty1)
1014 (tvs1, body1) = tcSplitForAllTys ty1
1015 (tvs2, body2) = tcSplitForAllTys ty2
1017 -- Anything else fails
1018 go outer _ _ = unifyMisMatch outer False orig_ty1 orig_ty2
1021 uPred outer nb1 (IParam n1 t1) nb2 (IParam n2 t2)
1022 | n1 == n2 = uTys nb1 t1 nb2 t2
1023 uPred outer nb1 (ClassP c1 tys1) nb2 (ClassP c2 tys2)
1024 | c1 == c2 = uTys_s nb1 tys1 nb2 tys2 -- Guaranteed equal lengths because the kinds check
1025 uPred outer _ p1 _ p2 = unifyMisMatch outer False (mkPredTy p1) (mkPredTy p2)
1030 When we find two TyConApps, the argument lists are guaranteed equal
1031 length. Reason: intially the kinds of the two types to be unified is
1032 the same. The only way it can become not the same is when unifying two
1033 AppTys (f1 a1):=:(f2 a2). In that case there can't be a TyConApp in
1034 the f1,f2 (because it'd absorb the app). If we unify f1:=:f2 first,
1035 which we do, that ensures that f1,f2 have the same kind; and that
1036 means a1,a2 have the same kind. And now the argument repeats.
1041 If you are tempted to make a short cut on synonyms, as in this
1045 -- NO uTys (SynTy con1 args1 ty1) (SynTy con2 args2 ty2)
1046 -- NO = if (con1 == con2) then
1047 -- NO -- Good news! Same synonym constructors, so we can shortcut
1048 -- NO -- by unifying their arguments and ignoring their expansions.
1049 -- NO unifyTypepeLists args1 args2
1051 -- NO -- Never mind. Just expand them and try again
1055 then THINK AGAIN. Here is the whole story, as detected and reported
1056 by Chris Okasaki \tr{<Chris_Okasaki@loch.mess.cs.cmu.edu>}:
1058 Here's a test program that should detect the problem:
1062 x = (1 :: Bogus Char) :: Bogus Bool
1065 The problem with [the attempted shortcut code] is that
1069 is not a sufficient condition to be able to use the shortcut!
1070 You also need to know that the type synonym actually USES all
1071 its arguments. For example, consider the following type synonym
1072 which does not use all its arguments.
1077 If you ever tried unifying, say, \tr{Bogus Char} with \tr{Bogus Bool},
1078 the unifier would blithely try to unify \tr{Char} with \tr{Bool} and
1079 would fail, even though the expanded forms (both \tr{Int}) should
1082 Similarly, unifying \tr{Bogus Char} with \tr{Bogus t} would
1083 unnecessarily bind \tr{t} to \tr{Char}.
1085 ... You could explicitly test for the problem synonyms and mark them
1086 somehow as needing expansion, perhaps also issuing a warning to the
1091 %************************************************************************
1093 \subsection[Unify-uVar]{@uVar@: unifying with a type variable}
1095 %************************************************************************
1097 @uVar@ is called when at least one of the types being unified is a
1098 variable. It does {\em not} assume that the variable is a fixed point
1099 of the substitution; rather, notice that @uVar@ (defined below) nips
1100 back into @uTys@ if it turns out that the variable is already bound.
1104 -> Bool -- False => tyvar is the "expected"
1105 -- True => ty is the "expected" thing
1107 -> InBox -- True <=> definitely no boxes in t2
1108 -> TcTauType -> TcTauType -- printing and real versions
1111 uVar outer swapped tv1 nb2 ps_ty2 ty2
1112 = do { let expansion | showSDoc (ppr ty2) == showSDoc (ppr ps_ty2) = empty
1113 | otherwise = brackets (equals <+> ppr ty2)
1114 ; traceTc (text "uVar" <+> ppr swapped <+>
1115 sep [ppr tv1 <+> dcolon <+> ppr (tyVarKind tv1 ),
1116 nest 2 (ptext SLIT(" <-> ")),
1117 ppr ps_ty2 <+> dcolon <+> ppr (typeKind ty2) <+> expansion])
1118 ; details <- lookupTcTyVar tv1
1121 | swapped -> u_tys outer nb2 ps_ty2 ty2 True ty1 ty1 -- Swap back
1122 | otherwise -> u_tys outer True ty1 ty1 nb2 ps_ty2 ty2 -- Same order
1123 -- The 'True' here says that ty1 is now inside a box
1124 DoneTv details1 -> uUnfilledVar outer swapped tv1 details1 ps_ty2 ty2
1128 uUnfilledVar :: Outer
1129 -> Bool -- Args are swapped
1130 -> TcTyVar -> TcTyVarDetails -- Tyvar 1
1131 -> TcTauType -> TcTauType -- Type 2
1133 -- Invariant: tyvar 1 is not unified with anything
1135 uUnfilledVar outer swapped tv1 details1 ps_ty2 ty2
1136 | Just ty2' <- tcView ty2
1137 = -- Expand synonyms; ignore FTVs
1138 uUnfilledVar False swapped tv1 details1 ps_ty2 ty2'
1140 uUnfilledVar outer swapped tv1 details1 ps_ty2 (TyVarTy tv2)
1141 | tv1 == tv2 -- Same type variable => no-op (but watch out for the boxy case)
1143 MetaTv BoxTv ref1 -- A boxy type variable meets itself;
1144 -- this is box-meets-box, so fill in with a tau-type
1145 -> do { tau_tv <- tcInstTyVar tv1
1146 ; updateMeta tv1 ref1 (mkTyVarTy tau_tv) }
1147 other -> returnM () -- No-op
1149 -- Distinct type variables
1151 = do { lookup2 <- lookupTcTyVar tv2
1153 IndirectTv ty2' -> uUnfilledVar outer swapped tv1 details1 ty2' ty2'
1154 DoneTv details2 -> uUnfilledVars outer swapped tv1 details1 tv2 details2
1157 uUnfilledVar outer swapped tv1 details1 ps_ty2 non_var_ty2 -- ty2 is not a type variable
1159 MetaTv (SigTv _) ref1 -> mis_match -- Can't update a skolem with a non-type-variable
1160 MetaTv info ref1 -> uMetaVar swapped tv1 info ref1 ps_ty2 non_var_ty2
1161 skolem_details -> mis_match
1163 mis_match = unifyMisMatch outer swapped (TyVarTy tv1) ps_ty2
1167 -> TcTyVar -> BoxInfo -> IORef MetaDetails
1170 -- tv1 is an un-filled-in meta type variable (maybe boxy, maybe tau)
1171 -- ty2 is not a type variable
1173 uMetaVar swapped tv1 BoxTv ref1 ps_ty2 non_var_ty2
1174 = -- tv1 is a BoxTv. So we must unbox ty2, to ensure
1175 -- that any boxes in ty2 are filled with monotypes
1177 -- It should not be the case that tv1 occurs in ty2
1178 -- (i.e. no occurs check should be needed), but if perchance
1179 -- it does, the unbox operation will fill it, and the DEBUG
1181 do { final_ty <- unBox ps_ty2
1183 ; meta_details <- readMutVar ref1
1184 ; case meta_details of
1185 Indirect ty -> WARN( True, ppr tv1 <+> ppr ty )
1186 return () -- This really should *not* happen
1189 ; checkUpdateMeta swapped tv1 ref1 final_ty }
1191 uMetaVar swapped tv1 info1 ref1 ps_ty2 non_var_ty2
1192 = do { final_ty <- checkTauTvUpdate tv1 ps_ty2 -- Occurs check + monotype check
1193 ; checkUpdateMeta swapped tv1 ref1 final_ty }
1196 uUnfilledVars :: Outer
1197 -> Bool -- Args are swapped
1198 -> TcTyVar -> TcTyVarDetails -- Tyvar 1
1199 -> TcTyVar -> TcTyVarDetails -- Tyvar 2
1201 -- Invarant: The type variables are distinct,
1202 -- Neither is filled in yet
1203 -- They might be boxy or not
1205 uUnfilledVars outer swapped tv1 (SkolemTv _) tv2 (SkolemTv _)
1206 = unifyMisMatch outer swapped (mkTyVarTy tv1) (mkTyVarTy tv2)
1208 uUnfilledVars outer swapped tv1 (MetaTv info1 ref1) tv2 (SkolemTv _)
1209 = checkUpdateMeta swapped tv1 ref1 (mkTyVarTy tv2)
1210 uUnfilledVars outer swapped tv1 (SkolemTv _) tv2 (MetaTv info2 ref2)
1211 = checkUpdateMeta (not swapped) tv2 ref2 (mkTyVarTy tv1)
1213 -- ToDo: this function seems too long for what it acutally does!
1214 uUnfilledVars outer swapped tv1 (MetaTv info1 ref1) tv2 (MetaTv info2 ref2)
1215 = case (info1, info2) of
1216 (BoxTv, BoxTv) -> box_meets_box
1218 -- If a box meets a TauTv, but the fomer has the smaller kind
1219 -- then we must create a fresh TauTv with the smaller kind
1220 (_, BoxTv) | k1_sub_k2 -> update_tv2
1221 | otherwise -> box_meets_box
1222 (BoxTv, _ ) | k2_sub_k1 -> update_tv1
1223 | otherwise -> box_meets_box
1225 -- Avoid SigTvs if poss
1226 (SigTv _, _ ) | k1_sub_k2 -> update_tv2
1227 (_, SigTv _) | k2_sub_k1 -> update_tv1
1229 (_, _) | k1_sub_k2 -> if k2_sub_k1 && nicer_to_update_tv1
1230 then update_tv1 -- Same kinds
1232 | k2_sub_k1 -> update_tv1
1233 | otherwise -> kind_err
1235 -- Update the variable with least kind info
1236 -- See notes on type inference in Kind.lhs
1237 -- The "nicer to" part only applies if the two kinds are the same,
1238 -- so we can choose which to do.
1240 -- Kinds should be guaranteed ok at this point
1241 update_tv1 = updateMeta tv1 ref1 (mkTyVarTy tv2)
1242 update_tv2 = updateMeta tv2 ref2 (mkTyVarTy tv1)
1244 box_meets_box | k1_sub_k2 = if k2_sub_k1 && nicer_to_update_tv1
1247 | k2_sub_k1 = fill_from tv2
1248 | otherwise = kind_err
1250 -- Update *both* tyvars with a TauTv whose name and kind
1251 -- are gotten from tv (avoid losing nice names is poss)
1252 fill_from tv = do { tv' <- tcInstTyVar tv
1253 ; let tau_ty = mkTyVarTy tv'
1254 ; updateMeta tv1 ref1 tau_ty
1255 ; updateMeta tv2 ref2 tau_ty }
1257 kind_err = addErrCtxtM (unifyKindCtxt swapped tv1 (mkTyVarTy tv2)) $
1258 unifyKindMisMatch k1 k2
1262 k1_sub_k2 = k1 `isSubKind` k2
1263 k2_sub_k1 = k2 `isSubKind` k1
1265 nicer_to_update_tv1 = isSystemName (varName tv1)
1266 -- Try to update sys-y type variables in preference to ones
1267 -- gotten (say) by instantiating a polymorphic function with
1268 -- a user-written type sig
1271 checkUpdateMeta :: Bool -> TcTyVar -> IORef MetaDetails -> TcType -> TcM ()
1272 -- Update tv1, which is flexi; occurs check is alrady done
1273 -- The 'check' version does a kind check too
1274 -- We do a sub-kind check here: we might unify (a b) with (c d)
1275 -- where b::*->* and d::*; this should fail
1277 checkUpdateMeta swapped tv1 ref1 ty2
1278 = do { checkKinds swapped tv1 ty2
1279 ; updateMeta tv1 ref1 ty2 }
1281 updateMeta :: TcTyVar -> IORef MetaDetails -> TcType -> TcM ()
1282 updateMeta tv1 ref1 ty2
1283 = ASSERT( isMetaTyVar tv1 )
1284 ASSERT( isBoxyTyVar tv1 || isTauTy ty2 )
1285 do { ASSERTM2( do { details <- readMetaTyVar tv1; return (isFlexi details) }, ppr tv1 )
1286 ; traceTc (text "updateMeta" <+> ppr tv1 <+> text ":=" <+> ppr ty2)
1287 ; writeMutVar ref1 (Indirect ty2) }
1290 checkKinds swapped tv1 ty2
1291 -- We're about to unify a type variable tv1 with a non-tyvar-type ty2.
1292 -- ty2 has been zonked at this stage, which ensures that
1293 -- its kind has as much boxity information visible as possible.
1294 | tk2 `isSubKind` tk1 = returnM ()
1297 -- Either the kinds aren't compatible
1298 -- (can happen if we unify (a b) with (c d))
1299 -- or we are unifying a lifted type variable with an
1300 -- unlifted type: e.g. (id 3#) is illegal
1301 = addErrCtxtM (unifyKindCtxt swapped tv1 ty2) $
1302 unifyKindMisMatch k1 k2
1304 (k1,k2) | swapped = (tk2,tk1)
1305 | otherwise = (tk1,tk2)
1310 checkTauTvUpdate :: TcTyVar -> TcType -> TcM TcType
1311 -- (checkTauTvUpdate tv ty)
1312 -- We are about to update the TauTv tv with ty.
1313 -- Check (a) that tv doesn't occur in ty (occurs check)
1314 -- (b) that ty is a monotype
1315 -- Furthermore, in the interest of (b), if you find an
1316 -- empty box (BoxTv that is Flexi), fill it in with a TauTv
1318 -- Returns the (non-boxy) type to update the type variable with, or fails
1320 checkTauTvUpdate orig_tv orig_ty
1323 go (TyConApp tc tys)
1324 | isSynTyCon tc = go_syn tc tys
1325 | otherwise = do { tys' <- mappM go tys; return (TyConApp tc tys') }
1326 go (NoteTy _ ty2) = go ty2 -- Discard free-tyvar annotations
1327 go (PredTy p) = do { p' <- go_pred p; return (PredTy p') }
1328 go (FunTy arg res) = do { arg' <- go arg; res' <- go res; return (FunTy arg' res') }
1329 go (AppTy fun arg) = do { fun' <- go fun; arg' <- go arg; return (mkAppTy fun' arg') }
1330 -- NB the mkAppTy; we might have instantiated a
1331 -- type variable to a type constructor, so we need
1332 -- to pull the TyConApp to the top.
1333 go (ForAllTy tv ty) = notMonoType orig_ty -- (b)
1336 | orig_tv == tv = occurCheck tv orig_ty -- (a)
1337 | isTcTyVar tv = go_tyvar tv (tcTyVarDetails tv)
1338 | otherwise = return (TyVarTy tv)
1339 -- Ordinary (non Tc) tyvars
1340 -- occur inside quantified types
1342 go_pred (ClassP c tys) = do { tys' <- mapM go tys; return (ClassP c tys') }
1343 go_pred (IParam n ty) = do { ty' <- go ty; return (IParam n ty') }
1344 go_pred (EqPred t1 t2) = do { t1' <- go t1; t2' <- go t2; return (EqPred t1' t2') }
1346 go_tyvar tv (SkolemTv _) = return (TyVarTy tv)
1347 go_tyvar tv (MetaTv box ref)
1348 = do { cts <- readMutVar ref
1350 Indirect ty -> go ty
1351 Flexi -> case box of
1352 BoxTv -> fillBoxWithTau tv ref
1353 other -> return (TyVarTy tv)
1356 -- go_syn is called for synonyms only
1357 -- See Note [Type synonyms and the occur check]
1359 | not (isTauTyCon tc)
1360 = notMonoType orig_ty -- (b) again
1362 = do { (msgs, mb_tys') <- tryTc (mapM go tys)
1364 Just tys' -> return (TyConApp tc tys')
1365 -- Retain the synonym (the common case)
1366 Nothing -> go (expectJust "checkTauTvUpdate"
1367 (tcView (TyConApp tc tys)))
1368 -- Try again, expanding the synonym
1371 fillBoxWithTau :: BoxyTyVar -> IORef MetaDetails -> TcM TcType
1372 -- (fillBoxWithTau tv ref) fills ref with a freshly allocated
1373 -- tau-type meta-variable, whose print-name is the same as tv
1374 -- Choosing the same name is good: when we instantiate a function
1375 -- we allocate boxy tyvars with the same print-name as the quantified
1376 -- tyvar; and then we often fill the box with a tau-tyvar, and again
1377 -- we want to choose the same name.
1378 fillBoxWithTau tv ref
1379 = do { tv' <- tcInstTyVar tv -- Do not gratuitously forget
1380 ; let tau = mkTyVarTy tv' -- name of the type variable
1381 ; writeMutVar ref (Indirect tau)
1385 Note [Type synonyms and the occur check]
1386 ~~~~~~~~~~~~~~~~~~~~
1387 Basically we want to update tv1 := ps_ty2
1388 because ps_ty2 has type-synonym info, which improves later error messages
1393 f :: (A a -> a -> ()) -> ()
1397 x = f (\ x p -> p x)
1399 In the application (p x), we try to match "t" with "A t". If we go
1400 ahead and bind t to A t (= ps_ty2), we'll lead the type checker into
1401 an infinite loop later.
1402 But we should not reject the program, because A t = ().
1403 Rather, we should bind t to () (= non_var_ty2).
1406 stripBoxyType :: BoxyType -> TcM TcType
1407 -- Strip all boxes from the input type, returning a non-boxy type.
1408 -- It's fine for there to be a polytype inside a box (c.f. unBox)
1409 -- All of the boxes should have been filled in by now;
1410 -- hence we return a TcType
1411 stripBoxyType ty = zonkType strip_tv ty
1413 strip_tv tv = ASSERT( not (isBoxyTyVar tv) ) return (TyVarTy tv)
1414 -- strip_tv will be called for *Flexi* meta-tyvars
1415 -- There should not be any Boxy ones; hence the ASSERT
1417 zapToMonotype :: BoxySigmaType -> TcM TcTauType
1418 -- Subtle... we must zap the boxy res_ty
1419 -- to kind * before using it to instantiate a LitInst
1420 -- Calling unBox instead doesn't do the job, because the box
1421 -- often has an openTypeKind, and we don't want to instantiate
1423 zapToMonotype res_ty
1424 = do { res_tau <- newFlexiTyVarTy liftedTypeKind
1425 ; boxyUnify res_tau res_ty
1428 unBox :: BoxyType -> TcM TcType
1429 -- unBox implements the judgement
1431 -- with input s', and result s
1433 -- It removes all boxes from the input type, returning a non-boxy type.
1434 -- A filled box in the type can only contain a monotype; unBox fails if not
1435 -- The type can have empty boxes, which unBox fills with a monotype
1437 -- Compare this wth checkTauTvUpdate
1439 -- For once, it's safe to treat synonyms as opaque!
1441 unBox (NoteTy n ty) = do { ty' <- unBox ty; return (NoteTy n ty') }
1442 unBox (TyConApp tc tys) = do { tys' <- mapM unBox tys; return (TyConApp tc tys') }
1443 unBox (AppTy f a) = do { f' <- unBox f; a' <- unBox a; return (mkAppTy f' a') }
1444 unBox (FunTy f a) = do { f' <- unBox f; a' <- unBox a; return (FunTy f' a') }
1445 unBox (PredTy p) = do { p' <- unBoxPred p; return (PredTy p') }
1446 unBox (ForAllTy tv ty) = ASSERT( isImmutableTyVar tv )
1447 do { ty' <- unBox ty; return (ForAllTy tv ty') }
1449 | isTcTyVar tv -- It's a boxy type variable
1450 , MetaTv BoxTv ref <- tcTyVarDetails tv -- NB: non-TcTyVars are possible
1451 = do { cts <- readMutVar ref -- under nested quantifiers
1453 Flexi -> fillBoxWithTau tv ref
1454 Indirect ty -> do { non_boxy_ty <- unBox ty
1455 ; if isTauTy non_boxy_ty
1456 then return non_boxy_ty
1457 else notMonoType non_boxy_ty }
1459 | otherwise -- Skolems, and meta-tau-variables
1460 = return (TyVarTy tv)
1462 unBoxPred (ClassP cls tys) = do { tys' <- mapM unBox tys; return (ClassP cls tys') }
1463 unBoxPred (IParam ip ty) = do { ty' <- unBox ty; return (IParam ip ty') }
1468 %************************************************************************
1470 \subsection[Unify-context]{Errors and contexts}
1472 %************************************************************************
1478 unifyCtxt act_ty exp_ty tidy_env
1479 = do { act_ty' <- zonkTcType act_ty
1480 ; exp_ty' <- zonkTcType exp_ty
1481 ; let (env1, exp_ty'') = tidyOpenType tidy_env exp_ty'
1482 (env2, act_ty'') = tidyOpenType env1 act_ty'
1483 ; return (env2, mkExpectedActualMsg act_ty'' exp_ty'') }
1486 mkExpectedActualMsg act_ty exp_ty
1487 = nest 2 (vcat [ text "Expected type" <> colon <+> ppr exp_ty,
1488 text "Inferred type" <> colon <+> ppr act_ty ])
1491 -- If an error happens we try to figure out whether the function
1492 -- function has been given too many or too few arguments, and say so.
1493 addSubCtxt SubDone actual_res_ty expected_res_ty thing_inside
1495 addSubCtxt sub_ctxt actual_res_ty expected_res_ty thing_inside
1496 = addErrCtxtM mk_err thing_inside
1499 = do { exp_ty' <- zonkTcType expected_res_ty
1500 ; act_ty' <- zonkTcType actual_res_ty
1501 ; let (env1, exp_ty'') = tidyOpenType tidy_env exp_ty'
1502 (env2, act_ty'') = tidyOpenType env1 act_ty'
1503 (exp_args, _) = tcSplitFunTys exp_ty''
1504 (act_args, _) = tcSplitFunTys act_ty''
1506 len_act_args = length act_args
1507 len_exp_args = length exp_args
1509 message = case sub_ctxt of
1510 SubFun fun | len_exp_args < len_act_args -> wrongArgsCtxt "too few" fun
1511 | len_exp_args > len_act_args -> wrongArgsCtxt "too many" fun
1512 other -> mkExpectedActualMsg act_ty'' exp_ty''
1513 ; return (env2, message) }
1515 wrongArgsCtxt too_many_or_few fun
1516 = ptext SLIT("Probable cause:") <+> quotes (ppr fun)
1517 <+> ptext SLIT("is applied to") <+> text too_many_or_few
1518 <+> ptext SLIT("arguments")
1521 unifyKindCtxt swapped tv1 ty2 tidy_env -- not swapped => tv1 expected, ty2 inferred
1522 -- tv1 and ty2 are zonked already
1525 msg = (env2, ptext SLIT("When matching the kinds of") <+>
1526 sep [quotes pp_expected <+> ptext SLIT("and"), quotes pp_actual])
1528 (pp_expected, pp_actual) | swapped = (pp2, pp1)
1529 | otherwise = (pp1, pp2)
1530 (env1, tv1') = tidyOpenTyVar tidy_env tv1
1531 (env2, ty2') = tidyOpenType env1 ty2
1532 pp1 = ppr tv1' <+> dcolon <+> ppr (tyVarKind tv1)
1533 pp2 = ppr ty2' <+> dcolon <+> ppr (typeKind ty2)
1535 unifyMisMatch outer swapped ty1 ty2
1536 = do { (env, msg) <- if swapped then misMatchMsg ty1 ty2
1537 else misMatchMsg ty2 ty1
1539 -- This is the whole point of the 'outer' stuff
1540 ; if outer then popErrCtxt (failWithTcM (env, msg))
1541 else failWithTcM (env, msg)
1545 = do { env0 <- tcInitTidyEnv
1546 ; (env1, pp1, extra1) <- ppr_ty env0 ty1
1547 ; (env2, pp2, extra2) <- ppr_ty env1 ty2
1548 ; return (env2, sep [sep [ptext SLIT("Couldn't match expected type") <+> pp1,
1549 nest 7 (ptext SLIT("against inferred type") <+> pp2)],
1550 nest 2 extra1, nest 2 extra2]) }
1552 ppr_ty :: TidyEnv -> TcType -> TcM (TidyEnv, SDoc, SDoc)
1554 = do { ty' <- zonkTcType ty
1555 ; let (env1,tidy_ty) = tidyOpenType env ty'
1556 simple_result = (env1, quotes (ppr tidy_ty), empty)
1559 | isSkolemTyVar tv || isSigTyVar tv
1560 -> return (env2, pp_rigid tv', pprSkolTvBinding tv')
1561 | otherwise -> return simple_result
1563 (env2, tv') = tidySkolemTyVar env1 tv
1564 other -> return simple_result }
1566 pp_rigid tv = quotes (ppr tv) <+> parens (ptext SLIT("a rigid variable"))
1570 = do { ty' <- zonkTcType ty
1571 ; env0 <- tcInitTidyEnv
1572 ; let (env1, tidy_ty) = tidyOpenType env0 ty'
1573 msg = ptext SLIT("Cannot match a monotype with") <+> quotes (ppr tidy_ty)
1574 ; failWithTcM (env1, msg) }
1577 = do { env0 <- tcInitTidyEnv
1578 ; ty' <- zonkTcType ty
1579 ; let (env1, tidy_tyvar) = tidyOpenTyVar env0 tyvar
1580 (env2, tidy_ty) = tidyOpenType env1 ty'
1581 extra = sep [ppr tidy_tyvar, char '=', ppr tidy_ty]
1582 ; failWithTcM (env2, hang msg 2 extra) }
1584 msg = ptext SLIT("Occurs check: cannot construct the infinite type:")
1588 %************************************************************************
1592 %************************************************************************
1594 Unifying kinds is much, much simpler than unifying types.
1597 unifyKind :: TcKind -- Expected
1600 unifyKind (TyConApp kc1 []) (TyConApp kc2 [])
1601 | isSubKindCon kc2 kc1 = returnM ()
1603 unifyKind (FunTy a1 r1) (FunTy a2 r2)
1604 = do { unifyKind a2 a1; unifyKind r1 r2 }
1605 -- Notice the flip in the argument,
1606 -- so that the sub-kinding works right
1607 unifyKind (TyVarTy kv1) k2 = uKVar False kv1 k2
1608 unifyKind k1 (TyVarTy kv2) = uKVar True kv2 k1
1609 unifyKind k1 k2 = unifyKindMisMatch k1 k2
1611 unifyKinds :: [TcKind] -> [TcKind] -> TcM ()
1612 unifyKinds [] [] = returnM ()
1613 unifyKinds (k1:ks1) (k2:ks2) = unifyKind k1 k2 `thenM_`
1615 unifyKinds _ _ = panic "unifyKinds: length mis-match"
1618 uKVar :: Bool -> KindVar -> TcKind -> TcM ()
1619 uKVar swapped kv1 k2
1620 = do { mb_k1 <- readKindVar kv1
1622 Flexi -> uUnboundKVar swapped kv1 k2
1623 Indirect k1 | swapped -> unifyKind k2 k1
1624 | otherwise -> unifyKind k1 k2 }
1627 uUnboundKVar :: Bool -> KindVar -> TcKind -> TcM ()
1628 uUnboundKVar swapped kv1 k2@(TyVarTy kv2)
1629 | kv1 == kv2 = returnM ()
1630 | otherwise -- Distinct kind variables
1631 = do { mb_k2 <- readKindVar kv2
1633 Indirect k2 -> uUnboundKVar swapped kv1 k2
1634 Flexi -> writeKindVar kv1 k2 }
1636 uUnboundKVar swapped kv1 non_var_k2
1637 = do { k2' <- zonkTcKind non_var_k2
1638 ; kindOccurCheck kv1 k2'
1639 ; k2'' <- kindSimpleKind swapped k2'
1640 -- KindVars must be bound only to simple kinds
1641 -- Polarities: (kindSimpleKind True ?) succeeds
1642 -- returning *, corresponding to unifying
1645 ; writeKindVar kv1 k2'' }
1648 kindOccurCheck kv1 k2 -- k2 is zonked
1649 = checkTc (not_in k2) (kindOccurCheckErr kv1 k2)
1651 not_in (TyVarTy kv2) = kv1 /= kv2
1652 not_in (FunTy a2 r2) = not_in a2 && not_in r2
1655 kindSimpleKind :: Bool -> Kind -> TcM SimpleKind
1656 -- (kindSimpleKind True k) returns a simple kind sk such that sk <: k
1657 -- If the flag is False, it requires k <: sk
1658 -- E.g. kindSimpleKind False ?? = *
1659 -- What about (kv -> *) :=: ?? -> *
1660 kindSimpleKind orig_swapped orig_kind
1661 = go orig_swapped orig_kind
1663 go sw (FunTy k1 k2) = do { k1' <- go (not sw) k1
1665 ; return (mkArrowKind k1' k2') }
1667 | isOpenTypeKind k = return liftedTypeKind
1668 | isArgTypeKind k = return liftedTypeKind
1670 | isLiftedTypeKind k = return liftedTypeKind
1671 | isUnliftedTypeKind k = return unliftedTypeKind
1672 go sw k@(TyVarTy _) = return k -- KindVars are always simple
1673 go swapped kind = failWithTc (ptext SLIT("Unexpected kind unification failure:")
1674 <+> ppr orig_swapped <+> ppr orig_kind)
1675 -- I think this can't actually happen
1677 -- T v = MkT v v must be a type
1678 -- T v w = MkT (v -> w) v must not be an umboxed tuple
1681 kindOccurCheckErr tyvar ty
1682 = hang (ptext SLIT("Occurs check: cannot construct the infinite kind:"))
1683 2 (sep [ppr tyvar, char '=', ppr ty])
1685 unifyKindMisMatch ty1 ty2
1686 = zonkTcKind ty1 `thenM` \ ty1' ->
1687 zonkTcKind ty2 `thenM` \ ty2' ->
1689 msg = hang (ptext SLIT("Couldn't match kind"))
1690 2 (sep [quotes (ppr ty1'),
1691 ptext SLIT("against"),
1698 unifyFunKind :: TcKind -> TcM (Maybe (TcKind, TcKind))
1699 -- Like unifyFunTy, but does not fail; instead just returns Nothing
1701 unifyFunKind (TyVarTy kvar)
1702 = readKindVar kvar `thenM` \ maybe_kind ->
1704 Indirect fun_kind -> unifyFunKind fun_kind
1706 do { arg_kind <- newKindVar
1707 ; res_kind <- newKindVar
1708 ; writeKindVar kvar (mkArrowKind arg_kind res_kind)
1709 ; returnM (Just (arg_kind,res_kind)) }
1711 unifyFunKind (FunTy arg_kind res_kind) = returnM (Just (arg_kind,res_kind))
1712 unifyFunKind other = returnM Nothing
1715 %************************************************************************
1719 %************************************************************************
1721 ---------------------------
1722 -- We would like to get a decent error message from
1723 -- (a) Under-applied type constructors
1724 -- f :: (Maybe, Maybe)
1725 -- (b) Over-applied type constructors
1726 -- f :: Int x -> Int x
1730 checkExpectedKind :: Outputable a => a -> TcKind -> TcKind -> TcM ()
1731 -- A fancy wrapper for 'unifyKind', which tries
1732 -- to give decent error messages.
1733 checkExpectedKind ty act_kind exp_kind
1734 | act_kind `isSubKind` exp_kind -- Short cut for a very common case
1737 = tryTc (unifyKind exp_kind act_kind) `thenM` \ (_errs, mb_r) ->
1739 Just r -> returnM () ; -- Unification succeeded
1742 -- So there's definitely an error
1743 -- Now to find out what sort
1744 zonkTcKind exp_kind `thenM` \ exp_kind ->
1745 zonkTcKind act_kind `thenM` \ act_kind ->
1747 tcInitTidyEnv `thenM` \ env0 ->
1748 let (exp_as, _) = splitKindFunTys exp_kind
1749 (act_as, _) = splitKindFunTys act_kind
1750 n_exp_as = length exp_as
1751 n_act_as = length act_as
1753 (env1, tidy_exp_kind) = tidyKind env0 exp_kind
1754 (env2, tidy_act_kind) = tidyKind env1 act_kind
1756 err | n_exp_as < n_act_as -- E.g. [Maybe]
1757 = quotes (ppr ty) <+> ptext SLIT("is not applied to enough type arguments")
1759 -- Now n_exp_as >= n_act_as. In the next two cases,
1760 -- n_exp_as == 0, and hence so is n_act_as
1761 | isLiftedTypeKind exp_kind && isUnliftedTypeKind act_kind
1762 = ptext SLIT("Expecting a lifted type, but") <+> quotes (ppr ty)
1763 <+> ptext SLIT("is unlifted")
1765 | isUnliftedTypeKind exp_kind && isLiftedTypeKind act_kind
1766 = ptext SLIT("Expecting an unlifted type, but") <+> quotes (ppr ty)
1767 <+> ptext SLIT("is lifted")
1769 | otherwise -- E.g. Monad [Int]
1770 = ptext SLIT("Kind mis-match")
1772 more_info = sep [ ptext SLIT("Expected kind") <+>
1773 quotes (pprKind tidy_exp_kind) <> comma,
1774 ptext SLIT("but") <+> quotes (ppr ty) <+>
1775 ptext SLIT("has kind") <+> quotes (pprKind tidy_act_kind)]
1777 failWithTcM (env2, err $$ more_info)
1781 %************************************************************************
1783 \subsection{Checking signature type variables}
1785 %************************************************************************
1787 @checkSigTyVars@ checks that a set of universally quantified type varaibles
1788 are not mentioned in the environment. In particular:
1790 (a) Not mentioned in the type of a variable in the envt
1791 eg the signature for f in this:
1797 Here, f is forced to be monorphic by the free occurence of x.
1799 (d) Not (unified with another type variable that is) in scope.
1800 eg f x :: (r->r) = (\y->y) :: forall a. a->r
1801 when checking the expression type signature, we find that
1802 even though there is nothing in scope whose type mentions r,
1803 nevertheless the type signature for the expression isn't right.
1805 Another example is in a class or instance declaration:
1807 op :: forall b. a -> b
1809 Here, b gets unified with a
1811 Before doing this, the substitution is applied to the signature type variable.
1814 checkSigTyVars :: [TcTyVar] -> TcM ()
1815 checkSigTyVars sig_tvs = check_sig_tyvars emptyVarSet sig_tvs
1817 checkSigTyVarsWrt :: TcTyVarSet -> [TcTyVar] -> TcM ()
1818 -- The extra_tvs can include boxy type variables;
1819 -- e.g. TcMatches.tcCheckExistentialPat
1820 checkSigTyVarsWrt extra_tvs sig_tvs
1821 = do { extra_tvs' <- zonkTcTyVarsAndFV (varSetElems extra_tvs)
1822 ; check_sig_tyvars extra_tvs' sig_tvs }
1825 :: TcTyVarSet -- Global type variables. The universally quantified
1826 -- tyvars should not mention any of these
1827 -- Guaranteed already zonked.
1828 -> [TcTyVar] -- Universally-quantified type variables in the signature
1829 -- Guaranteed to be skolems
1831 check_sig_tyvars extra_tvs []
1833 check_sig_tyvars extra_tvs sig_tvs
1834 = ASSERT( all isSkolemTyVar sig_tvs )
1835 do { gbl_tvs <- tcGetGlobalTyVars
1836 ; traceTc (text "check_sig_tyvars" <+> (vcat [text "sig_tys" <+> ppr sig_tvs,
1837 text "gbl_tvs" <+> ppr gbl_tvs,
1838 text "extra_tvs" <+> ppr extra_tvs]))
1840 ; let env_tvs = gbl_tvs `unionVarSet` extra_tvs
1841 ; ifM (any (`elemVarSet` env_tvs) sig_tvs)
1842 (bleatEscapedTvs env_tvs sig_tvs sig_tvs)
1845 bleatEscapedTvs :: TcTyVarSet -- The global tvs
1846 -> [TcTyVar] -- The possibly-escaping type variables
1847 -> [TcTyVar] -- The zonked versions thereof
1849 -- Complain about escaping type variables
1850 -- We pass a list of type variables, at least one of which
1851 -- escapes. The first list contains the original signature type variable,
1852 -- while the second contains the type variable it is unified to (usually itself)
1853 bleatEscapedTvs globals sig_tvs zonked_tvs
1854 = do { env0 <- tcInitTidyEnv
1855 ; let (env1, tidy_tvs) = tidyOpenTyVars env0 sig_tvs
1856 (env2, tidy_zonked_tvs) = tidyOpenTyVars env1 zonked_tvs
1858 ; (env3, msgs) <- foldlM check (env2, []) (tidy_tvs `zip` tidy_zonked_tvs)
1859 ; failWithTcM (env3, main_msg $$ nest 2 (vcat msgs)) }
1861 main_msg = ptext SLIT("Inferred type is less polymorphic than expected")
1863 check (tidy_env, msgs) (sig_tv, zonked_tv)
1864 | not (zonked_tv `elemVarSet` globals) = return (tidy_env, msgs)
1866 = do { (tidy_env1, globs) <- findGlobals (unitVarSet zonked_tv) tidy_env
1867 ; returnM (tidy_env1, escape_msg sig_tv zonked_tv globs : msgs) }
1869 -----------------------
1870 escape_msg sig_tv zonked_tv globs
1872 = vcat [sep [msg, ptext SLIT("is mentioned in the environment:")],
1873 nest 2 (vcat globs)]
1875 = msg <+> ptext SLIT("escapes")
1876 -- Sigh. It's really hard to give a good error message
1877 -- all the time. One bad case is an existential pattern match.
1878 -- We rely on the "When..." context to help.
1880 msg = ptext SLIT("Quantified type variable") <+> quotes (ppr sig_tv) <+> is_bound_to
1882 | sig_tv == zonked_tv = empty
1883 | otherwise = ptext SLIT("is unified with") <+> quotes (ppr zonked_tv) <+> ptext SLIT("which")
1886 These two context are used with checkSigTyVars
1889 sigCtxt :: Id -> [TcTyVar] -> TcThetaType -> TcTauType
1890 -> TidyEnv -> TcM (TidyEnv, Message)
1891 sigCtxt id sig_tvs sig_theta sig_tau tidy_env
1892 = zonkTcType sig_tau `thenM` \ actual_tau ->
1894 (env1, tidy_sig_tvs) = tidyOpenTyVars tidy_env sig_tvs
1895 (env2, tidy_sig_rho) = tidyOpenType env1 (mkPhiTy sig_theta sig_tau)
1896 (env3, tidy_actual_tau) = tidyOpenType env2 actual_tau
1897 sub_msg = vcat [ptext SLIT("Signature type: ") <+> pprType (mkForAllTys tidy_sig_tvs tidy_sig_rho),
1898 ptext SLIT("Type to generalise:") <+> pprType tidy_actual_tau
1900 msg = vcat [ptext SLIT("When trying to generalise the type inferred for") <+> quotes (ppr id),