compiler/typecheck/TcUnify.lhs

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