compiler/types/Type.lhs

   1 %
   2 % (c) The University of Glasgow 2006
   3 % (c) The GRASP/AQUA Project, Glasgow University, 1998
   4 %
   5
   6 Type - public interface
   7
   8 \begin{code}
   9 module Type (
  10         -- re-exports from TypeRep
  11         TyThing(..), Type, PredType(..), ThetaType,
  12         funTyCon,
  13
  14         -- Kinds
  15         Kind, SimpleKind, KindVar,
  16         kindFunResult, splitKindFunTys, splitKindFunTysN,
  17
  18         liftedTypeKindTyCon, openTypeKindTyCon, unliftedTypeKindTyCon,
  19         argTypeKindTyCon, ubxTupleKindTyCon,
  20
  21         liftedTypeKind, unliftedTypeKind, openTypeKind,
  22         argTypeKind, ubxTupleKind,
  23
  24         tySuperKind, coSuperKind,
  25
  26         isLiftedTypeKind, isUnliftedTypeKind, isOpenTypeKind,
  27         isUbxTupleKind, isArgTypeKind, isKind, isTySuperKind,
  28         isCoSuperKind, isSuperKind, isCoercionKind, isEqPred,
  29         mkArrowKind, mkArrowKinds,
  30
  31         isSubArgTypeKind, isSubOpenTypeKind, isSubKind, defaultKind, eqKind,
  32         isSubKindCon,
  33
  34         -- Re-exports from TyCon
  35         PrimRep(..),
  36
  37         mkTyVarTy, mkTyVarTys, getTyVar, getTyVar_maybe, isTyVarTy,
  38
  39         mkAppTy, mkAppTys, splitAppTy, splitAppTys,
  40         splitAppTy_maybe, repSplitAppTy_maybe,
  41
  42         mkFunTy, mkFunTys, splitFunTy, splitFunTy_maybe,
  43         splitFunTys, splitFunTysN,
  44         funResultTy, funArgTy, zipFunTys, isFunTy,
  45
  46         mkTyConApp, mkTyConTy,
  47         tyConAppTyCon, tyConAppArgs,
  48         splitTyConApp_maybe, splitTyConApp,
  49         splitNewTyConApp_maybe, splitNewTyConApp,
  50
  51         repType, typePrimRep, coreView, tcView, kindView,
  52
  53         mkForAllTy, mkForAllTys, splitForAllTy_maybe, splitForAllTys,
  54         applyTy, applyTys, isForAllTy, dropForAlls,
  55
  56         -- Source types
  57         predTypeRep, mkPredTy, mkPredTys,
  58
  59         -- Newtypes
  60         splitRecNewType_maybe, newTyConInstRhs,
  61
  62         -- Lifting and boxity
  63         isUnLiftedType, isUnboxedTupleType, isAlgType, isPrimitiveType,
  64         isStrictType, isStrictPred,
  65
  66         -- Free variables
  67         tyVarsOfType, tyVarsOfTypes, tyVarsOfPred, tyVarsOfTheta,
  68         typeKind, addFreeTyVars,
  69
  70         -- Tidying up for printing
  71         tidyType,      tidyTypes,
  72         tidyOpenType,  tidyOpenTypes,
  73         tidyTyVarBndr, tidyFreeTyVars,
  74         tidyOpenTyVar, tidyOpenTyVars,
  75         tidyTopType,   tidyPred,
  76         tidyKind,
  77
  78         -- Comparison
  79         coreEqType, tcEqType, tcEqTypes, tcCmpType, tcCmpTypes,
  80         tcEqPred, tcCmpPred, tcEqTypeX,
  81
  82         -- Seq
  83         seqType, seqTypes,
  84
  85         -- Type substitutions
  86         TvSubstEnv, emptyTvSubstEnv,    -- Representation widely visible
  87         TvSubst(..), emptyTvSubst,      -- Representation visible to a few friends
  88         mkTvSubst, mkOpenTvSubst, zipOpenTvSubst, zipTopTvSubst, mkTopTvSubst, notElemTvSubst,
  89         getTvSubstEnv, setTvSubstEnv, getTvInScope, extendTvInScope,
  90         extendTvSubst, extendTvSubstList, isInScope, composeTvSubst, zipTyEnv,
  91
  92         -- Performing substitution on types
  93         substTy, substTys, substTyWith, substTheta,
  94         substPred, substTyVar, substTyVarBndr, deShadowTy, lookupTyVar,
  95
  96         -- Pretty-printing
  97         pprType, pprParendType, pprTyThingCategory,
  98         pprPred, pprTheta, pprThetaArrow, pprClassPred, pprKind, pprParendKind
  99     ) where
 100
 101 #include "HsVersions.h"
 102
 103 -- We import the representation and primitive functions from TypeRep.
 104 -- Many things are reexported, but not the representation!
 105
 106 import TypeRep
 107
 108 -- friends:
 109 import Var
 110 import VarEnv
 111 import VarSet
 112
 113 import Name
 114 import Class
 115 import PrelNames
 116 import TyCon
 117
 118 -- others
 119 import StaticFlags
 120 import Util
 121 import Outputable
 122 import UniqSet
 123
 124 import Data.Maybe       ( isJust )
 125 \end{code}
 126
 127
 128 %************************************************************************
 129 %*                                                                      *
 130                 Type representation
 131 %*                                                                      *
 132 %************************************************************************
 133
 134 In Core, we "look through" non-recursive newtypes and PredTypes.
 135
 136 \begin{code}
 137 {-# INLINE coreView #-}
 138 coreView :: Type -> Maybe Type
 139 -- Strips off the *top layer only* of a type to give
 140 -- its underlying representation type.
 141 -- Returns Nothing if there is nothing to look through.
 142 --
 143 -- In the case of newtypes, it returns
 144 --      *either* a vanilla TyConApp (recursive newtype, or non-saturated)
 145 --      *or*     the newtype representation (otherwise), meaning the
 146 --                      type written in the RHS of the newtype decl,
 147 --                      which may itself be a newtype
 148 --
 149 -- Example: newtype R = MkR S
 150 --          newtype S = MkS T
 151 --          newtype T = MkT (T -> T)
 152 --   expandNewTcApp on R gives Just S
 153 --                  on S gives Just T
 154 --                  on T gives Nothing   (no expansion)
 155
 156 -- By being non-recursive and inlined, this case analysis gets efficiently
 157 -- joined onto the case analysis that the caller is already doing
 158 coreView (NoteTy _ ty)     = Just ty
 159 coreView (PredTy p)
 160   | isEqPred p             = Nothing
 161   | otherwise              = Just (predTypeRep p)
 162 coreView (TyConApp tc tys) | Just (tenv, rhs, tys') <- coreExpandTyCon_maybe tc tys
 163                            = Just (mkAppTys (substTy (mkTopTvSubst tenv) rhs) tys')
 164                                 -- Its important to use mkAppTys, rather than (foldl AppTy),
 165                                 -- because the function part might well return a
 166                                 -- partially-applied type constructor; indeed, usually will!
 167 coreView ty                = Nothing
 168
 169
 170
 171 -----------------------------------------------
 172 {-# INLINE tcView #-}
 173 tcView :: Type -> Maybe Type
 174 -- Same, but for the type checker, which just looks through synonyms
 175 tcView (NoteTy _ ty)     = Just ty
 176 tcView (TyConApp tc tys) | Just (tenv, rhs, tys') <- tcExpandTyCon_maybe tc tys
 177                          = Just (mkAppTys (substTy (mkTopTvSubst tenv) rhs) tys')
 178 tcView ty                = Nothing
 179
 180 -----------------------------------------------
 181 {-# INLINE kindView #-}
 182 kindView :: Kind -> Maybe Kind
 183 -- C.f. coreView, tcView
 184 -- For the moment, we don't even handle synonyms in kinds
 185 kindView (NoteTy _ k) = Just k
 186 kindView other        = Nothing
 187 \end{code}
 188
 189
 190 %************************************************************************
 191 %*                                                                      *
 192 \subsection{Constructor-specific functions}
 193 %*                                                                      *
 194 %************************************************************************
 195
 196
 197 ---------------------------------------------------------------------
 198                                 TyVarTy
 199                                 ~~~~~~~
 200 \begin{code}
 201 mkTyVarTy  :: TyVar   -> Type
 202 mkTyVarTy  = TyVarTy
 203
 204 mkTyVarTys :: [TyVar] -> [Type]
 205 mkTyVarTys = map mkTyVarTy -- a common use of mkTyVarTy
 206
 207 getTyVar :: String -> Type -> TyVar
 208 getTyVar msg ty = case getTyVar_maybe ty of
 209                     Just tv -> tv
 210                     Nothing -> panic ("getTyVar: " ++ msg)
 211
 212 isTyVarTy :: Type -> Bool
 213 isTyVarTy ty = isJust (getTyVar_maybe ty)
 214
 215 getTyVar_maybe :: Type -> Maybe TyVar
 216 getTyVar_maybe ty | Just ty' <- coreView ty = getTyVar_maybe ty'
 217 getTyVar_maybe (TyVarTy tv)                 = Just tv
 218 getTyVar_maybe other                        = Nothing
 219
 220 \end{code}
 221
 222
 223 ---------------------------------------------------------------------
 224                                 AppTy
 225                                 ~~~~~
 226 We need to be pretty careful with AppTy to make sure we obey the
 227 invariant that a TyConApp is always visibly so.  mkAppTy maintains the
 228 invariant: use it.
 229
 230 \begin{code}
 231 mkAppTy orig_ty1 orig_ty2
 232   = mk_app orig_ty1
 233   where
 234     mk_app (NoteTy _ ty1)    = mk_app ty1
 235     mk_app (TyConApp tc tys) = mkTyConApp tc (tys ++ [orig_ty2])
 236     mk_app ty1               = AppTy orig_ty1 orig_ty2
 237         -- Note that the TyConApp could be an
 238         -- under-saturated type synonym.  GHC allows that; e.g.
 239         --      type Foo k = k a -> k a
 240         --      type Id x = x
 241         --      foo :: Foo Id -> Foo Id
 242         --
 243         -- Here Id is partially applied in the type sig for Foo,
 244         -- but once the type synonyms are expanded all is well
 245
 246 mkAppTys :: Type -> [Type] -> Type
 247 mkAppTys orig_ty1 []        = orig_ty1
 248         -- This check for an empty list of type arguments
 249         -- avoids the needless loss of a type synonym constructor.
 250         -- For example: mkAppTys Rational []
 251         --   returns to (Ratio Integer), which has needlessly lost
 252         --   the Rational part.
 253 mkAppTys orig_ty1 orig_tys2
 254   = mk_app orig_ty1
 255   where
 256     mk_app (NoteTy _ ty1)    = mk_app ty1
 257     mk_app (TyConApp tc tys) = mkTyConApp tc (tys ++ orig_tys2)
 258                                 -- mkTyConApp: see notes with mkAppTy
 259     mk_app ty1               = foldl AppTy orig_ty1 orig_tys2
 260
 261 -------------
 262 splitAppTy_maybe :: Type -> Maybe (Type, Type)
 263 splitAppTy_maybe ty | Just ty' <- coreView ty
 264                     = splitAppTy_maybe ty'
 265 splitAppTy_maybe ty = repSplitAppTy_maybe ty
 266
 267 -------------
 268 repSplitAppTy_maybe :: Type -> Maybe (Type,Type)
 269 -- Does the AppTy split, but assumes that any view stuff is already done
 270 repSplitAppTy_maybe (FunTy ty1 ty2)   = Just (TyConApp funTyCon [ty1], ty2)
 271 repSplitAppTy_maybe (AppTy ty1 ty2)   = Just (ty1, ty2)
 272 repSplitAppTy_maybe (TyConApp tc tys) = case snocView tys of
 273                                                 Just (tys', ty') -> Just (TyConApp tc tys', ty')
 274                                                 Nothing          -> Nothing
 275 repSplitAppTy_maybe other = Nothing
 276 -------------
 277 splitAppTy :: Type -> (Type, Type)
 278 splitAppTy ty = case splitAppTy_maybe ty of
 279                         Just pr -> pr
 280                         Nothing -> panic "splitAppTy"
 281
 282 -------------
 283 splitAppTys :: Type -> (Type, [Type])
 284 splitAppTys ty = split ty ty []
 285   where
 286     split orig_ty ty args | Just ty' <- coreView ty = split orig_ty ty' args
 287     split orig_ty (AppTy ty arg)        args = split ty ty (arg:args)
 288     split orig_ty (TyConApp tc tc_args) args = (TyConApp tc [], tc_args ++ args)
 289     split orig_ty (FunTy ty1 ty2)       args = ASSERT( null args )
 290                                                (TyConApp funTyCon [], [ty1,ty2])
 291     split orig_ty ty                    args = (orig_ty, args)
 292
 293 \end{code}
 294
 295
 296 ---------------------------------------------------------------------
 297                                 FunTy
 298                                 ~~~~~
 299
 300 \begin{code}
 301 mkFunTy :: Type -> Type -> Type
 302 mkFunTy (PredTy (EqPred ty1 ty2)) res = mkForAllTy (mkWildCoVar (PredTy (EqPred ty1 ty2))) res
 303 mkFunTy arg res = FunTy arg res
 304
 305 mkFunTys :: [Type] -> Type -> Type
 306 mkFunTys tys ty = foldr mkFunTy ty tys
 307
 308 isFunTy :: Type -> Bool
 309 isFunTy ty = isJust (splitFunTy_maybe ty)
 310
 311 splitFunTy :: Type -> (Type, Type)
 312 splitFunTy ty | Just ty' <- coreView ty = splitFunTy ty'
 313 splitFunTy (FunTy arg res)   = (arg, res)
 314 splitFunTy other             = pprPanic "splitFunTy" (ppr other)
 315
 316 splitFunTy_maybe :: Type -> Maybe (Type, Type)
 317 splitFunTy_maybe ty | Just ty' <- coreView ty = splitFunTy_maybe ty'
 318 splitFunTy_maybe (FunTy arg res)   = Just (arg, res)
 319 splitFunTy_maybe other             = Nothing
 320
 321 splitFunTys :: Type -> ([Type], Type)
 322 splitFunTys ty = split [] ty ty
 323   where
 324     split args orig_ty ty | Just ty' <- coreView ty = split args orig_ty ty'
 325     split args orig_ty (FunTy arg res)   = split (arg:args) res res
 326     split args orig_ty ty                = (reverse args, orig_ty)
 327
 328 splitFunTysN :: Int -> Type -> ([Type], Type)
 329 -- Split off exactly n arg tys
 330 splitFunTysN 0 ty = ([], ty)
 331 splitFunTysN n ty = case splitFunTy ty of { (arg, res) ->
 332                     case splitFunTysN (n-1) res of { (args, res) ->
 333                     (arg:args, res) }}
 334
 335 zipFunTys :: Outputable a => [a] -> Type -> ([(a,Type)], Type)
 336 zipFunTys orig_xs orig_ty = split [] orig_xs orig_ty orig_ty
 337   where
 338     split acc []     nty ty                = (reverse acc, nty)
 339     split acc xs     nty ty
 340           | Just ty' <- coreView ty        = split acc xs nty ty'
 341     split acc (x:xs) nty (FunTy arg res)   = split ((x,arg):acc) xs res res
 342     split acc (x:xs) nty ty                = pprPanic "zipFunTys" (ppr orig_xs <+> ppr orig_ty)
 343
 344 funResultTy :: Type -> Type
 345 funResultTy ty | Just ty' <- coreView ty = funResultTy ty'
 346 funResultTy (FunTy arg res)   = res
 347 funResultTy ty                = pprPanic "funResultTy" (ppr ty)
 348
 349 funArgTy :: Type -> Type
 350 funArgTy ty | Just ty' <- coreView ty = funArgTy ty'
 351 funArgTy (FunTy arg res)   = arg
 352 funArgTy ty                = pprPanic "funArgTy" (ppr ty)
 353 \end{code}
 354
 355
 356 ---------------------------------------------------------------------
 357                                 TyConApp
 358                                 ~~~~~~~~
 359 @mkTyConApp@ is a key function, because it builds a TyConApp, FunTy or PredTy,
 360 as apppropriate.
 361
 362 \begin{code}
 363 mkTyConApp :: TyCon -> [Type] -> Type
 364 mkTyConApp tycon tys
 365   | isFunTyCon tycon, [ty1,ty2] <- tys
 366   = FunTy ty1 ty2
 367
 368   | otherwise
 369   = TyConApp tycon tys
 370
 371 mkTyConTy :: TyCon -> Type
 372 mkTyConTy tycon = mkTyConApp tycon []
 373
 374 -- splitTyConApp "looks through" synonyms, because they don't
 375 -- mean a distinct type, but all other type-constructor applications
 376 -- including functions are returned as Just ..
 377
 378 tyConAppTyCon :: Type -> TyCon
 379 tyConAppTyCon ty = fst (splitTyConApp ty)
 380
 381 tyConAppArgs :: Type -> [Type]
 382 tyConAppArgs ty = snd (splitTyConApp ty)
 383
 384 splitTyConApp :: Type -> (TyCon, [Type])
 385 splitTyConApp ty = case splitTyConApp_maybe ty of
 386                         Just stuff -> stuff
 387                         Nothing    -> pprPanic "splitTyConApp" (ppr ty)
 388
 389 splitTyConApp_maybe :: Type -> Maybe (TyCon, [Type])
 390 splitTyConApp_maybe ty | Just ty' <- coreView ty = splitTyConApp_maybe ty'
 391 splitTyConApp_maybe (TyConApp tc tys) = Just (tc, tys)
 392 splitTyConApp_maybe (FunTy arg res)   = Just (funTyCon, [arg,res])
 393 splitTyConApp_maybe other             = Nothing
 394
 395 -- Sometimes we do NOT want to look throught a newtype.  When case matching
 396 -- on a newtype we want a convenient way to access the arguments of a newty
 397 -- constructor so as to properly form a coercion.
 398 splitNewTyConApp :: Type -> (TyCon, [Type])
 399 splitNewTyConApp ty = case splitNewTyConApp_maybe ty of
 400                         Just stuff -> stuff
 401                         Nothing    -> pprPanic "splitNewTyConApp" (ppr ty)
 402 splitNewTyConApp_maybe :: Type -> Maybe (TyCon, [Type])
 403 splitNewTyConApp_maybe ty | Just ty' <- tcView ty = splitNewTyConApp_maybe ty'
 404 splitNewTyConApp_maybe (TyConApp tc tys) = Just (tc, tys)
 405 splitNewTyConApp_maybe (FunTy arg res)   = Just (funTyCon, [arg,res])
 406 splitNewTyConApp_maybe other          = Nothing
 407
 408 -- get instantiated newtype rhs, the arguments had better saturate
 409 -- the constructor
 410 newTyConInstRhs :: TyCon -> [Type] -> Type
 411 newTyConInstRhs tycon tys =
 412     let (tvs, ty) = newTyConRhs tycon in substTyWith tvs tys ty
 413
 414 \end{code}
 415
 416
 417 ---------------------------------------------------------------------
 418                                 SynTy
 419                                 ~~~~~
 420
 421 Notes on type synonyms
 422 ~~~~~~~~~~~~~~~~~~~~~~
 423 The various "split" functions (splitFunTy, splitRhoTy, splitForAllTy) try
 424 to return type synonyms whereever possible. Thus
 425
 426         type Foo a = a -> a
 427
 428 we want
 429         splitFunTys (a -> Foo a) = ([a], Foo a)
 430 not                                ([a], a -> a)
 431
 432 The reason is that we then get better (shorter) type signatures in
 433 interfaces.  Notably this plays a role in tcTySigs in TcBinds.lhs.
 434
 435
 436                 Representation types
 437                 ~~~~~~~~~~~~~~~~~~~~
 438 repType looks through
 439         (a) for-alls, and
 440         (b) synonyms
 441         (c) predicates
 442         (d) usage annotations
 443         (e) all newtypes, including recursive ones, but not newtype families
 444 It's useful in the back end.
 445
 446 \begin{code}
 447 repType :: Type -> Type
 448 -- Only applied to types of kind *; hence tycons are saturated
 449 repType ty | Just ty' <- coreView ty = repType ty'
 450 repType (ForAllTy _ ty)  = repType ty
 451 repType (TyConApp tc tys)
 452   | isClosedNewTyCon tc  = -- Recursive newtypes are opaque to coreView
 453                            -- but we must expand them here.  Sure to
 454                            -- be saturated because repType is only applied
 455                            -- to types of kind *
 456                            ASSERT( {- isRecursiveTyCon tc && -} tys `lengthIs` tyConArity tc )
 457                            repType (new_type_rep tc tys)
 458 repType ty = ty
 459
 460 -- new_type_rep doesn't ask any questions:
 461 -- it just expands newtype, whether recursive or not
 462 new_type_rep new_tycon tys = ASSERT( tys `lengthIs` tyConArity new_tycon )
 463                              case newTyConRep new_tycon of
 464                                  (tvs, rep_ty) -> substTyWith tvs tys rep_ty
 465
 466 -- ToDo: this could be moved to the code generator, using splitTyConApp instead
 467 -- of inspecting the type directly.
 468 typePrimRep :: Type -> PrimRep
 469 typePrimRep ty = case repType ty of
 470                    TyConApp tc _ -> tyConPrimRep tc
 471                    FunTy _ _     -> PtrRep
 472                    AppTy _ _     -> PtrRep      -- See note below
 473                    TyVarTy _     -> PtrRep
 474                    other         -> pprPanic "typePrimRep" (ppr ty)
 475         -- Types of the form 'f a' must be of kind *, not *#, so
 476         -- we are guaranteed that they are represented by pointers.
 477         -- The reason is that f must have kind *->*, not *->*#, because
 478         -- (we claim) there is no way to constrain f's kind any other
 479         -- way.
 480
 481 \end{code}
 482
 483
 484 ---------------------------------------------------------------------
 485                                 ForAllTy
 486                                 ~~~~~~~~
 487
 488 \begin{code}
 489 mkForAllTy :: TyVar -> Type -> Type
 490 mkForAllTy tyvar ty
 491   = mkForAllTys [tyvar] ty
 492
 493 mkForAllTys :: [TyVar] -> Type -> Type
 494 mkForAllTys tyvars ty = foldr ForAllTy ty tyvars
 495
 496 isForAllTy :: Type -> Bool
 497 isForAllTy (NoteTy _ ty)  = isForAllTy ty
 498 isForAllTy (ForAllTy _ _) = True
 499 isForAllTy other_ty       = False
 500
 501 splitForAllTy_maybe :: Type -> Maybe (TyVar, Type)
 502 splitForAllTy_maybe ty = splitFAT_m ty
 503   where
 504     splitFAT_m ty | Just ty' <- coreView ty = splitFAT_m ty'
 505     splitFAT_m (ForAllTy tyvar ty)          = Just(tyvar, ty)
 506     splitFAT_m _                            = Nothing
 507
 508 splitForAllTys :: Type -> ([TyVar], Type)
 509 splitForAllTys ty = split ty ty []
 510    where
 511      split orig_ty ty tvs | Just ty' <- coreView ty = split orig_ty ty' tvs
 512      split orig_ty (ForAllTy tv ty)  tvs = split ty ty (tv:tvs)
 513      split orig_ty t                 tvs = (reverse tvs, orig_ty)
 514
 515 dropForAlls :: Type -> Type
 516 dropForAlls ty = snd (splitForAllTys ty)
 517 \end{code}
 518
 519 -- (mkPiType now in CoreUtils)
 520
 521 applyTy, applyTys
 522 ~~~~~~~~~~~~~~~~~
 523 Instantiate a for-all type with one or more type arguments.
 524 Used when we have a polymorphic function applied to type args:
 525         f t1 t2
 526 Then we use (applyTys type-of-f [t1,t2]) to compute the type of
 527 the expression.
 528
 529 \begin{code}
 530 applyTy :: Type -> Type -> Type
 531 applyTy ty arg | Just ty' <- coreView ty = applyTy ty' arg
 532 applyTy (ForAllTy tv ty) arg = substTyWith [tv] [arg] ty
 533 applyTy other            arg = panic "applyTy"
 534
 535 applyTys :: Type -> [Type] -> Type
 536 -- This function is interesting because
 537 --      a) the function may have more for-alls than there are args
 538 --      b) less obviously, it may have fewer for-alls
 539 -- For case (b) think of
 540 --      applyTys (forall a.a) [forall b.b, Int]
 541 -- This really can happen, via dressing up polymorphic types with newtype
 542 -- clothing.  Here's an example:
 543 --      newtype R = R (forall a. a->a)
 544 --      foo = case undefined :: R of
 545 --              R f -> f ()
 546
 547 applyTys orig_fun_ty []      = orig_fun_ty
 548 applyTys orig_fun_ty arg_tys
 549   | n_tvs == n_args     -- The vastly common case
 550   = substTyWith tvs arg_tys rho_ty
 551   | n_tvs > n_args      -- Too many for-alls
 552   = substTyWith (take n_args tvs) arg_tys
 553                 (mkForAllTys (drop n_args tvs) rho_ty)
 554   | otherwise           -- Too many type args
 555   = ASSERT2( n_tvs > 0, ppr orig_fun_ty )       -- Zero case gives infnite loop!
 556     applyTys (substTyWith tvs (take n_tvs arg_tys) rho_ty)
 557              (drop n_tvs arg_tys)
 558   where
 559     (tvs, rho_ty) = splitForAllTys orig_fun_ty
 560     n_tvs = length tvs
 561     n_args = length arg_tys
 562 \end{code}
 563
 564
 565 %************************************************************************
 566 %*                                                                      *
 567 \subsection{Source types}
 568 %*                                                                      *
 569 %************************************************************************
 570
 571 A "source type" is a type that is a separate type as far as the type checker is
 572 concerned, but which has low-level representation as far as the back end is concerned.
 573
 574 Source types are always lifted.
 575
 576 The key function is predTypeRep which gives the representation of a source type:
 577
 578 \begin{code}
 579 mkPredTy :: PredType -> Type
 580 mkPredTy pred = PredTy pred
 581
 582 mkPredTys :: ThetaType -> [Type]
 583 mkPredTys preds = map PredTy preds
 584
 585 predTypeRep :: PredType -> Type
 586 -- Convert a PredType to its "representation type";
 587 -- the post-type-checking type used by all the Core passes of GHC.
 588 -- Unwraps only the outermost level; for example, the result might
 589 -- be a newtype application
 590 predTypeRep (IParam _ ty)     = ty
 591 predTypeRep (ClassP clas tys) = mkTyConApp (classTyCon clas) tys
 592         -- Result might be a newtype application, but the consumer will
 593         -- look through that too if necessary
 594 predTypeRep (EqPred ty1 ty2) = pprPanic "predTypeRep" (ppr (EqPred ty1 ty2))
 595 \end{code}
 596
 597
 598 %************************************************************************
 599 %*                                                                      *
 600                 NewTypes
 601 %*                                                                      *
 602 %************************************************************************
 603
 604 \begin{code}
 605 splitRecNewType_maybe :: Type -> Maybe Type
 606 -- Sometimes we want to look through a recursive newtype, and that's what happens here
 607 -- It only strips *one layer* off, so the caller will usually call itself recursively
 608 -- Only applied to types of kind *, hence the newtype is always saturated
 609 splitRecNewType_maybe ty | Just ty' <- coreView ty = splitRecNewType_maybe ty'
 610 splitRecNewType_maybe (TyConApp tc tys)
 611   | isClosedNewTyCon tc
 612   = ASSERT( tys `lengthIs` tyConArity tc )      -- splitRecNewType_maybe only be applied
 613                                                 --      to *types* (of kind *)
 614     ASSERT( isRecursiveTyCon tc )               -- Guaranteed by coreView
 615     case newTyConRhs tc of
 616         (tvs, rep_ty) -> ASSERT( length tvs == length tys )
 617                          Just (substTyWith tvs tys rep_ty)
 618
 619 splitRecNewType_maybe other = Nothing
 620
 621
 622
 623 \end{code}
 624
 625
 626 %************************************************************************
 627 %*                                                                      *
 628 \subsection{Kinds and free variables}
 629 %*                                                                      *
 630 %************************************************************************
 631
 632 ---------------------------------------------------------------------
 633                 Finding the kind of a type
 634                 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 635 \begin{code}
 636 typeKind :: Type -> Kind
 637 typeKind (TyConApp tycon tys) = ASSERT( not (isCoercionTyCon tycon) )
 638                                    -- We should be looking for the coercion kind,
 639                                    -- not the type kind
 640                                 foldr (\_ k -> kindFunResult k) (tyConKind tycon) tys
 641 typeKind (NoteTy _ ty)        = typeKind ty
 642 typeKind (PredTy pred)        = predKind pred
 643 typeKind (AppTy fun arg)      = kindFunResult (typeKind fun)
 644 typeKind (ForAllTy tv ty)     = typeKind ty
 645 typeKind (TyVarTy tyvar)      = tyVarKind tyvar
 646 typeKind (FunTy arg res)
 647     -- Hack alert.  The kind of (Int -> Int#) is liftedTypeKind (*),
 648     --              not unliftedTypKind (#)
 649     -- The only things that can be after a function arrow are
 650     --   (a) types (of kind openTypeKind or its sub-kinds)
 651     --   (b) kinds (of super-kind TY) (e.g. * -> (* -> *))
 652     | isTySuperKind k         = k
 653     | otherwise               = ASSERT( isSubOpenTypeKind k) liftedTypeKind
 654     where
 655       k = typeKind res
 656
 657 predKind :: PredType -> Kind
 658 predKind (EqPred {}) = coSuperKind      -- A coercion kind!
 659 predKind (ClassP {}) = liftedTypeKind   -- Class and implicitPredicates are
 660 predKind (IParam {}) = liftedTypeKind   -- always represented by lifted types
 661 \end{code}
 662
 663
 664 ---------------------------------------------------------------------
 665                 Free variables of a type
 666                 ~~~~~~~~~~~~~~~~~~~~~~~~
 667 \begin{code}
 668 tyVarsOfType :: Type -> TyVarSet
 669 -- NB: for type synonyms tyVarsOfType does *not* expand the synonym
 670 tyVarsOfType (TyVarTy tv)               = unitVarSet tv
 671 tyVarsOfType (TyConApp tycon tys)       = tyVarsOfTypes tys
 672 tyVarsOfType (NoteTy (FTVNote tvs) ty2) = tvs
 673 tyVarsOfType (PredTy sty)               = tyVarsOfPred sty
 674 tyVarsOfType (FunTy arg res)            = tyVarsOfType arg `unionVarSet` tyVarsOfType res
 675 tyVarsOfType (AppTy fun arg)            = tyVarsOfType fun `unionVarSet` tyVarsOfType arg
 676 tyVarsOfType (ForAllTy tyvar ty)        = delVarSet (tyVarsOfType ty) tyvar
 677
 678 tyVarsOfTypes :: [Type] -> TyVarSet
 679 tyVarsOfTypes tys = foldr (unionVarSet.tyVarsOfType) emptyVarSet tys
 680
 681 tyVarsOfPred :: PredType -> TyVarSet
 682 tyVarsOfPred (IParam _ ty)    = tyVarsOfType ty
 683 tyVarsOfPred (ClassP _ tys)   = tyVarsOfTypes tys
 684 tyVarsOfPred (EqPred ty1 ty2) = tyVarsOfType ty1 `unionVarSet` tyVarsOfType ty2
 685
 686 tyVarsOfTheta :: ThetaType -> TyVarSet
 687 tyVarsOfTheta = foldr (unionVarSet . tyVarsOfPred) emptyVarSet
 688
 689 -- Add a Note with the free tyvars to the top of the type
 690 addFreeTyVars :: Type -> Type
 691 addFreeTyVars ty@(NoteTy (FTVNote _) _)      = ty
 692 addFreeTyVars ty                             = NoteTy (FTVNote (tyVarsOfType ty)) ty
 693 \end{code}
 694
 695
 696 %************************************************************************
 697 %*                                                                      *
 698 \subsection{TidyType}
 699 %*                                                                      *
 700 %************************************************************************
 701
 702 tidyTy tidies up a type for printing in an error message, or in
 703 an interface file.
 704
 705 It doesn't change the uniques at all, just the print names.
 706
 707 \begin{code}
 708 tidyTyVarBndr :: TidyEnv -> TyVar -> (TidyEnv, TyVar)
 709 tidyTyVarBndr (tidy_env, subst) tyvar
 710   = case tidyOccName tidy_env (getOccName name) of
 711       (tidy', occ') ->  ((tidy', subst'), tyvar')
 712                     where
 713                         subst' = extendVarEnv subst tyvar tyvar'
 714                         tyvar' = setTyVarName tyvar name'
 715                         name'  = tidyNameOcc name occ'
 716   where
 717     name = tyVarName tyvar
 718
 719 tidyFreeTyVars :: TidyEnv -> TyVarSet -> TidyEnv
 720 -- Add the free tyvars to the env in tidy form,
 721 -- so that we can tidy the type they are free in
 722 tidyFreeTyVars env tyvars = fst (tidyOpenTyVars env (varSetElems tyvars))
 723
 724 tidyOpenTyVars :: TidyEnv -> [TyVar] -> (TidyEnv, [TyVar])
 725 tidyOpenTyVars env tyvars = mapAccumL tidyOpenTyVar env tyvars
 726
 727 tidyOpenTyVar :: TidyEnv -> TyVar -> (TidyEnv, TyVar)
 728 -- Treat a new tyvar as a binder, and give it a fresh tidy name
 729 tidyOpenTyVar env@(tidy_env, subst) tyvar
 730   = case lookupVarEnv subst tyvar of
 731         Just tyvar' -> (env, tyvar')            -- Already substituted
 732         Nothing     -> tidyTyVarBndr env tyvar  -- Treat it as a binder
 733
 734 tidyType :: TidyEnv -> Type -> Type
 735 tidyType env@(tidy_env, subst) ty
 736   = go ty
 737   where
 738     go (TyVarTy tv)         = case lookupVarEnv subst tv of
 739                                 Nothing  -> TyVarTy tv
 740                                 Just tv' -> TyVarTy tv'
 741     go (TyConApp tycon tys) = let args = map go tys
 742                               in args `seqList` TyConApp tycon args
 743     go (NoteTy note ty)     = (NoteTy $! (go_note note)) $! (go ty)
 744     go (PredTy sty)         = PredTy (tidyPred env sty)
 745     go (AppTy fun arg)      = (AppTy $! (go fun)) $! (go arg)
 746     go (FunTy fun arg)      = (FunTy $! (go fun)) $! (go arg)
 747     go (ForAllTy tv ty)     = ForAllTy tvp $! (tidyType envp ty)
 748                               where
 749                                 (envp, tvp) = tidyTyVarBndr env tv
 750
 751     go_note note@(FTVNote ftvs) = note  -- No need to tidy the free tyvars
 752
 753 tidyTypes env tys = map (tidyType env) tys
 754
 755 tidyPred :: TidyEnv -> PredType -> PredType
 756 tidyPred env (IParam n ty)     = IParam n (tidyType env ty)
 757 tidyPred env (ClassP clas tys) = ClassP clas (tidyTypes env tys)
 758 tidyPred env (EqPred ty1 ty2)  = EqPred (tidyType env ty1) (tidyType env ty2)
 759 \end{code}
 760
 761
 762 @tidyOpenType@ grabs the free type variables, tidies them
 763 and then uses @tidyType@ to work over the type itself
 764
 765 \begin{code}
 766 tidyOpenType :: TidyEnv -> Type -> (TidyEnv, Type)
 767 tidyOpenType env ty
 768   = (env', tidyType env' ty)
 769   where
 770     env' = tidyFreeTyVars env (tyVarsOfType ty)
 771
 772 tidyOpenTypes :: TidyEnv -> [Type] -> (TidyEnv, [Type])
 773 tidyOpenTypes env tys = mapAccumL tidyOpenType env tys
 774
 775 tidyTopType :: Type -> Type
 776 tidyTopType ty = tidyType emptyTidyEnv ty
 777 \end{code}
 778
 779 \begin{code}
 780
 781 tidyKind :: TidyEnv -> Kind -> (TidyEnv, Kind)
 782 tidyKind env k = tidyOpenType env k
 783
 784 \end{code}
 785
 786
 787 %************************************************************************
 788 %*                                                                      *
 789 \subsection{Liftedness}
 790 %*                                                                      *
 791 %************************************************************************
 792
 793 \begin{code}
 794 isUnLiftedType :: Type -> Bool
 795         -- isUnLiftedType returns True for forall'd unlifted types:
 796         --      x :: forall a. Int#
 797         -- I found bindings like these were getting floated to the top level.
 798         -- They are pretty bogus types, mind you.  It would be better never to
 799         -- construct them
 800
 801 isUnLiftedType ty | Just ty' <- coreView ty = isUnLiftedType ty'
 802 isUnLiftedType (ForAllTy tv ty)  = isUnLiftedType ty
 803 isUnLiftedType (TyConApp tc _)   = isUnLiftedTyCon tc
 804 isUnLiftedType other             = False
 805
 806 isUnboxedTupleType :: Type -> Bool
 807 isUnboxedTupleType ty = case splitTyConApp_maybe ty of
 808                            Just (tc, ty_args) -> isUnboxedTupleTyCon tc
 809                            other              -> False
 810
 811 -- Should only be applied to *types*; hence the assert
 812 isAlgType :: Type -> Bool
 813 isAlgType ty = case splitTyConApp_maybe ty of
 814                         Just (tc, ty_args) -> ASSERT( ty_args `lengthIs` tyConArity tc )
 815                                               isAlgTyCon tc
 816                         other              -> False
 817 \end{code}
 818
 819 @isStrictType@ computes whether an argument (or let RHS) should
 820 be computed strictly or lazily, based only on its type.
 821 Works just like isUnLiftedType, except that it has a special case
 822 for dictionaries.  Since it takes account of ClassP, you might think
 823 this function should be in TcType, but isStrictType is used by DataCon,
 824 which is below TcType in the hierarchy, so it's convenient to put it here.
 825
 826 \begin{code}
 827 isStrictType (PredTy pred)     = isStrictPred pred
 828 isStrictType ty | Just ty' <- coreView ty = isStrictType ty'
 829 isStrictType (ForAllTy tv ty)  = isStrictType ty
 830 isStrictType (TyConApp tc _)   = isUnLiftedTyCon tc
 831 isStrictType other             = False
 832
 833 isStrictPred (ClassP clas _) = opt_DictsStrict && not (isNewTyCon (classTyCon clas))
 834 isStrictPred other           = False
 835         -- We may be strict in dictionary types, but only if it
 836         -- has more than one component.
 837         -- [Being strict in a single-component dictionary risks
 838         --  poking the dictionary component, which is wrong.]
 839 \end{code}
 840
 841 \begin{code}
 842 isPrimitiveType :: Type -> Bool
 843 -- Returns types that are opaque to Haskell.
 844 -- Most of these are unlifted, but now that we interact with .NET, we
 845 -- may have primtive (foreign-imported) types that are lifted
 846 isPrimitiveType ty = case splitTyConApp_maybe ty of
 847                         Just (tc, ty_args) -> ASSERT( ty_args `lengthIs` tyConArity tc )
 848                                               isPrimTyCon tc
 849                         other              -> False
 850 \end{code}
 851
 852
 853 %************************************************************************
 854 %*                                                                      *
 855 \subsection{Sequencing on types
 856 %*                                                                      *
 857 %************************************************************************
 858
 859 \begin{code}
 860 seqType :: Type -> ()
 861 seqType (TyVarTy tv)      = tv `seq` ()
 862 seqType (AppTy t1 t2)     = seqType t1 `seq` seqType t2
 863 seqType (FunTy t1 t2)     = seqType t1 `seq` seqType t2
 864 seqType (NoteTy note t2)  = seqNote note `seq` seqType t2
 865 seqType (PredTy p)        = seqPred p
 866 seqType (TyConApp tc tys) = tc `seq` seqTypes tys
 867 seqType (ForAllTy tv ty)  = tv `seq` seqType ty
 868
 869 seqTypes :: [Type] -> ()
 870 seqTypes []       = ()
 871 seqTypes (ty:tys) = seqType ty `seq` seqTypes tys
 872
 873 seqNote :: TyNote -> ()
 874 seqNote (FTVNote set) = sizeUniqSet set `seq` ()
 875
 876 seqPred :: PredType -> ()
 877 seqPred (ClassP c tys)   = c `seq` seqTypes tys
 878 seqPred (IParam n ty)    = n `seq` seqType ty
 879 seqPred (EqPred ty1 ty2) = seqType ty1 `seq` seqType ty2
 880 \end{code}
 881
 882
 883 %************************************************************************
 884 %*                                                                      *
 885                 Equality for Core types
 886         (We don't use instances so that we know where it happens)
 887 %*                                                                      *
 888 %************************************************************************
 889
 890 Note that eqType works right even for partial applications of newtypes.
 891 See Note [Newtype eta] in TyCon.lhs
 892
 893 \begin{code}
 894 coreEqType :: Type -> Type -> Bool
 895 coreEqType t1 t2
 896   = eq rn_env t1 t2
 897   where
 898     rn_env = mkRnEnv2 (mkInScopeSet (tyVarsOfType t1 `unionVarSet` tyVarsOfType t2))
 899
 900     eq env (TyVarTy tv1)       (TyVarTy tv2)     = rnOccL env tv1 == rnOccR env tv2
 901     eq env (ForAllTy tv1 t1)   (ForAllTy tv2 t2) = eq (rnBndr2 env tv1 tv2) t1 t2
 902     eq env (AppTy s1 t1)       (AppTy s2 t2)     = eq env s1 s2 && eq env t1 t2
 903     eq env (FunTy s1 t1)       (FunTy s2 t2)     = eq env s1 s2 && eq env t1 t2
 904     eq env (TyConApp tc1 tys1) (TyConApp tc2 tys2)
 905         | tc1 == tc2, all2 (eq env) tys1 tys2 = True
 906                         -- The lengths should be equal because
 907                         -- the two types have the same kind
 908         -- NB: if the type constructors differ that does not
 909         --     necessarily mean that the types aren't equal
 910         --     (synonyms, newtypes)
 911         -- Even if the type constructors are the same, but the arguments
 912         -- differ, the two types could be the same (e.g. if the arg is just
 913         -- ignored in the RHS).  In both these cases we fall through to an
 914         -- attempt to expand one side or the other.
 915
 916         -- Now deal with newtypes, synonyms, pred-tys
 917     eq env t1 t2 | Just t1' <- coreView t1 = eq env t1' t2
 918                  | Just t2' <- coreView t2 = eq env t1 t2'
 919
 920         -- Fall through case; not equal!
 921     eq env t1 t2 = False
 922 \end{code}
 923
 924
 925 %************************************************************************
 926 %*                                                                      *
 927                 Comparision for source types
 928         (We don't use instances so that we know where it happens)
 929 %*                                                                      *
 930 %************************************************************************
 931
 932 Note that
 933         tcEqType, tcCmpType
 934 do *not* look through newtypes, PredTypes
 935
 936 \begin{code}
 937 tcEqType :: Type -> Type -> Bool
 938 tcEqType t1 t2 = isEqual $ cmpType t1 t2
 939
 940 tcEqTypes :: [Type] -> [Type] -> Bool
 941 tcEqTypes tys1 tys2 = isEqual $ cmpTypes tys1 tys2
 942
 943 tcCmpType :: Type -> Type -> Ordering
 944 tcCmpType t1 t2 = cmpType t1 t2
 945
 946 tcCmpTypes :: [Type] -> [Type] -> Ordering
 947 tcCmpTypes tys1 tys2 = cmpTypes tys1 tys2
 948
 949 tcEqPred :: PredType -> PredType -> Bool
 950 tcEqPred p1 p2 = isEqual $ cmpPred p1 p2
 951
 952 tcCmpPred :: PredType -> PredType -> Ordering
 953 tcCmpPred p1 p2 = cmpPred p1 p2
 954
 955 tcEqTypeX :: RnEnv2 -> Type -> Type -> Bool
 956 tcEqTypeX env t1 t2 = isEqual $ cmpTypeX env t1 t2
 957 \end{code}
 958
 959 Now here comes the real worker
 960
 961 \begin{code}
 962 cmpType :: Type -> Type -> Ordering
 963 cmpType t1 t2 = cmpTypeX rn_env t1 t2
 964   where
 965     rn_env = mkRnEnv2 (mkInScopeSet (tyVarsOfType t1 `unionVarSet` tyVarsOfType t2))
 966
 967 cmpTypes :: [Type] -> [Type] -> Ordering
 968 cmpTypes ts1 ts2 = cmpTypesX rn_env ts1 ts2
 969   where
 970     rn_env = mkRnEnv2 (mkInScopeSet (tyVarsOfTypes ts1 `unionVarSet` tyVarsOfTypes ts2))
 971
 972 cmpPred :: PredType -> PredType -> Ordering
 973 cmpPred p1 p2 = cmpPredX rn_env p1 p2
 974   where
 975     rn_env = mkRnEnv2 (mkInScopeSet (tyVarsOfPred p1 `unionVarSet` tyVarsOfPred p2))
 976
 977 cmpTypeX :: RnEnv2 -> Type -> Type -> Ordering  -- Main workhorse
 978 cmpTypeX env t1 t2 | Just t1' <- tcView t1 = cmpTypeX env t1' t2
 979                    | Just t2' <- tcView t2 = cmpTypeX env t1 t2'
 980
 981 cmpTypeX env (TyVarTy tv1)       (TyVarTy tv2)       = rnOccL env tv1 `compare` rnOccR env tv2
 982 cmpTypeX env (ForAllTy tv1 t1)   (ForAllTy tv2 t2)   = cmpTypeX (rnBndr2 env tv1 tv2) t1 t2
 983 cmpTypeX env (AppTy s1 t1)       (AppTy s2 t2)       = cmpTypeX env s1 s2 `thenCmp` cmpTypeX env t1 t2
 984 cmpTypeX env (FunTy s1 t1)       (FunTy s2 t2)       = cmpTypeX env s1 s2 `thenCmp` cmpTypeX env t1 t2
 985 cmpTypeX env (PredTy p1)         (PredTy p2)         = cmpPredX env p1 p2
 986 cmpTypeX env (TyConApp tc1 tys1) (TyConApp tc2 tys2) = (tc1 `compare` tc2) `thenCmp` cmpTypesX env tys1 tys2
 987 cmpTypeX env t1                 (NoteTy _ t2)        = cmpTypeX env t1 t2
 988
 989     -- Deal with the rest: TyVarTy < AppTy < FunTy < TyConApp < ForAllTy < PredTy
 990 cmpTypeX env (AppTy _ _) (TyVarTy _) = GT
 991
 992 cmpTypeX env (FunTy _ _) (TyVarTy _) = GT
 993 cmpTypeX env (FunTy _ _) (AppTy _ _) = GT
 994
 995 cmpTypeX env (TyConApp _ _) (TyVarTy _) = GT
 996 cmpTypeX env (TyConApp _ _) (AppTy _ _) = GT
 997 cmpTypeX env (TyConApp _ _) (FunTy _ _) = GT
 998
 999 cmpTypeX env (ForAllTy _ _) (TyVarTy _)    = GT
1000 cmpTypeX env (ForAllTy _ _) (AppTy _ _)    = GT
1001 cmpTypeX env (ForAllTy _ _) (FunTy _ _)    = GT
1002 cmpTypeX env (ForAllTy _ _) (TyConApp _ _) = GT
1003
1004 cmpTypeX env (PredTy _)   t2            = GT
1005
1006 cmpTypeX env _ _ = LT
1007
1008 -------------
1009 cmpTypesX :: RnEnv2 -> [Type] -> [Type] -> Ordering
1010 cmpTypesX env []        []        = EQ
1011 cmpTypesX env (t1:tys1) (t2:tys2) = cmpTypeX env t1 t2 `thenCmp` cmpTypesX env tys1 tys2
1012 cmpTypesX env []        tys       = LT
1013 cmpTypesX env ty        []        = GT
1014
1015 -------------
1016 cmpPredX :: RnEnv2 -> PredType -> PredType -> Ordering
1017 cmpPredX env (IParam n1 ty1) (IParam n2 ty2) = (n1 `compare` n2) `thenCmp` cmpTypeX env ty1 ty2
1018         -- Compare types as well as names for implicit parameters
1019         -- This comparison is used exclusively (I think) for the
1020         -- finite map built in TcSimplify
1021 cmpPredX env (ClassP c1 tys1) (ClassP c2 tys2) = (c1 `compare` c2) `thenCmp` cmpTypesX env tys1 tys2
1022 cmpPredX env (EqPred ty1 ty2) (EqPred ty1' ty2') = (cmpTypeX env ty1 ty1') `thenCmp` (cmpTypeX env ty2 ty2')
1023
1024 -- Constructor order: IParam < ClassP < EqPred
1025 cmpPredX env (IParam {})     _              = LT
1026 cmpPredX env (ClassP {})    (IParam {})     = GT
1027 cmpPredX env (ClassP {})    (EqPred {})     = LT
1028 cmpPredX env (EqPred {})    _               = GT
1029 \end{code}
1030
1031 PredTypes are used as a FM key in TcSimplify,
1032 so we take the easy path and make them an instance of Ord
1033
1034 \begin{code}
1035 instance Eq  PredType where { (==)    = tcEqPred }
1036 instance Ord PredType where { compare = tcCmpPred }
1037 \end{code}
1038
1039
1040 %************************************************************************
1041 %*                                                                      *
1042                 Type substitutions
1043 %*                                                                      *
1044 %************************************************************************
1045
1046 \begin{code}
1047 data TvSubst
1048   = TvSubst InScopeSet  -- The in-scope type variables
1049             TvSubstEnv  -- The substitution itself
1050         -- See Note [Apply Once]
1051         -- and Note [Extending the TvSubstEnv]
1052
1053 {- ----------------------------------------------------------
1054
1055 Note [Apply Once]
1056 ~~~~~~~~~~~~~~~~~
1057 We use TvSubsts to instantiate things, and we might instantiate
1058         forall a b. ty
1059 \with the types
1060         [a, b], or [b, a].
1061 So the substition might go [a->b, b->a].  A similar situation arises in Core
1062 when we find a beta redex like
1063         (/\ a /\ b -> e) b a
1064 Then we also end up with a substition that permutes type variables. Other
1065 variations happen to; for example [a -> (a, b)].
1066
1067         ***************************************************
1068         *** So a TvSubst must be applied precisely once ***
1069         ***************************************************
1070
1071 A TvSubst is not idempotent, but, unlike the non-idempotent substitution
1072 we use during unifications, it must not be repeatedly applied.
1073
1074 Note [Extending the TvSubst]
1075 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1076 The following invariant should hold of a TvSubst
1077
1078         The in-scope set is needed *only* to
1079         guide the generation of fresh uniques
1080
1081         In particular, the *kind* of the type variables in
1082         the in-scope set is not relevant
1083
1084 This invariant allows a short-cut when the TvSubstEnv is empty:
1085 if the TvSubstEnv is empty --- i.e. (isEmptyTvSubt subst) holds ---
1086 then (substTy subst ty) does nothing.
1087
1088 For example, consider:
1089         (/\a. /\b:(a~Int). ...b..) Int
1090 We substitute Int for 'a'.  The Unique of 'b' does not change, but
1091 nevertheless we add 'b' to the TvSubstEnv, because b's type does change
1092
1093 This invariant has several crucial consequences:
1094
1095 * In substTyVarBndr, we need extend the TvSubstEnv
1096         - if the unique has changed
1097         - or if the kind has changed
1098
1099 * In substTyVar, we do not need to consult the in-scope set;
1100   the TvSubstEnv is enough
1101
1102 * In substTy, substTheta, we can short-circuit when the TvSubstEnv is empty
1103
1104
1105 -------------------------------------------------------------- -}
1106
1107
1108 type TvSubstEnv = TyVarEnv Type
1109         -- A TvSubstEnv is used both inside a TvSubst (with the apply-once
1110         -- invariant discussed in Note [Apply Once]), and also independently
1111         -- in the middle of matching, and unification (see Types.Unify)
1112         -- So you have to look at the context to know if it's idempotent or
1113         -- apply-once or whatever
1114 emptyTvSubstEnv :: TvSubstEnv
1115 emptyTvSubstEnv = emptyVarEnv
1116
1117 composeTvSubst :: InScopeSet -> TvSubstEnv -> TvSubstEnv -> TvSubstEnv
1118 -- (compose env1 env2)(x) is env1(env2(x)); i.e. apply env2 then env1
1119 -- It assumes that both are idempotent
1120 -- Typically, env1 is the refinement to a base substitution env2
1121 composeTvSubst in_scope env1 env2
1122   = env1 `plusVarEnv` mapVarEnv (substTy subst1) env2
1123         -- First apply env1 to the range of env2
1124         -- Then combine the two, making sure that env1 loses if
1125         -- both bind the same variable; that's why env1 is the
1126         --  *left* argument to plusVarEnv, because the right arg wins
1127   where
1128     subst1 = TvSubst in_scope env1
1129
1130 emptyTvSubst = TvSubst emptyInScopeSet emptyVarEnv
1131
1132 isEmptyTvSubst :: TvSubst -> Bool
1133          -- See Note [Extending the TvSubstEnv]
1134 isEmptyTvSubst (TvSubst _ env) = isEmptyVarEnv env
1135
1136 mkTvSubst :: InScopeSet -> TvSubstEnv -> TvSubst
1137 mkTvSubst = TvSubst
1138
1139 getTvSubstEnv :: TvSubst -> TvSubstEnv
1140 getTvSubstEnv (TvSubst _ env) = env
1141
1142 getTvInScope :: TvSubst -> InScopeSet
1143 getTvInScope (TvSubst in_scope _) = in_scope
1144
1145 isInScope :: Var -> TvSubst -> Bool
1146 isInScope v (TvSubst in_scope _) = v `elemInScopeSet` in_scope
1147
1148 notElemTvSubst :: TyVar -> TvSubst -> Bool
1149 notElemTvSubst tv (TvSubst _ env) = not (tv `elemVarEnv` env)
1150
1151 setTvSubstEnv :: TvSubst -> TvSubstEnv -> TvSubst
1152 setTvSubstEnv (TvSubst in_scope _) env = TvSubst in_scope env
1153
1154 extendTvInScope :: TvSubst -> [Var] -> TvSubst
1155 extendTvInScope (TvSubst in_scope env) vars = TvSubst (extendInScopeSetList in_scope vars) env
1156
1157 extendTvSubst :: TvSubst -> TyVar -> Type -> TvSubst
1158 extendTvSubst (TvSubst in_scope env) tv ty = TvSubst in_scope (extendVarEnv env tv ty)
1159
1160 extendTvSubstList :: TvSubst -> [TyVar] -> [Type] -> TvSubst
1161 extendTvSubstList (TvSubst in_scope env) tvs tys
1162   = TvSubst in_scope (extendVarEnvList env (tvs `zip` tys))
1163
1164 -- mkOpenTvSubst and zipOpenTvSubst generate the in-scope set from
1165 -- the types given; but it's just a thunk so with a bit of luck
1166 -- it'll never be evaluated
1167
1168 mkOpenTvSubst :: TvSubstEnv -> TvSubst
1169 mkOpenTvSubst env = TvSubst (mkInScopeSet (tyVarsOfTypes (varEnvElts env))) env
1170
1171 zipOpenTvSubst :: [TyVar] -> [Type] -> TvSubst
1172 zipOpenTvSubst tyvars tys
1173 #ifdef DEBUG
1174   | length tyvars /= length tys
1175   = pprTrace "zipOpenTvSubst" (ppr tyvars $$ ppr tys) emptyTvSubst
1176   | otherwise
1177 #endif
1178   = TvSubst (mkInScopeSet (tyVarsOfTypes tys)) (zipTyEnv tyvars tys)
1179
1180 -- mkTopTvSubst is called when doing top-level substitutions.
1181 -- Here we expect that the free vars of the range of the
1182 -- substitution will be empty.
1183 mkTopTvSubst :: [(TyVar, Type)] -> TvSubst
1184 mkTopTvSubst prs = TvSubst emptyInScopeSet (mkVarEnv prs)
1185
1186 zipTopTvSubst :: [TyVar] -> [Type] -> TvSubst
1187 zipTopTvSubst tyvars tys
1188 #ifdef DEBUG
1189   | length tyvars /= length tys
1190   = pprTrace "zipOpenTvSubst" (ppr tyvars $$ ppr tys) emptyTvSubst
1191   | otherwise
1192 #endif
1193   = TvSubst emptyInScopeSet (zipTyEnv tyvars tys)
1194
1195 zipTyEnv :: [TyVar] -> [Type] -> TvSubstEnv
1196 zipTyEnv tyvars tys
1197 #ifdef DEBUG
1198   | length tyvars /= length tys
1199   = pprTrace "mkTopTvSubst" (ppr tyvars $$ ppr tys) emptyVarEnv
1200   | otherwise
1201 #endif
1202   = zip_ty_env tyvars tys emptyVarEnv
1203
1204 -- Later substitutions in the list over-ride earlier ones,
1205 -- but there should be no loops
1206 zip_ty_env []       []       env = env
1207 zip_ty_env (tv:tvs) (ty:tys) env = zip_ty_env tvs tys (extendVarEnv env tv ty)
1208         -- There used to be a special case for when
1209         --      ty == TyVarTy tv
1210         -- (a not-uncommon case) in which case the substitution was dropped.
1211         -- But the type-tidier changes the print-name of a type variable without
1212         -- changing the unique, and that led to a bug.   Why?  Pre-tidying, we had
1213         -- a type {Foo t}, where Foo is a one-method class.  So Foo is really a newtype.
1214         -- And it happened that t was the type variable of the class.  Post-tiding,
1215         -- it got turned into {Foo t2}.  The ext-core printer expanded this using
1216         -- sourceTypeRep, but that said "Oh, t == t2" because they have the same unique,
1217         -- and so generated a rep type mentioning t not t2.
1218         --
1219         -- Simplest fix is to nuke the "optimisation"
1220 zip_ty_env tvs      tys      env   = pprTrace "Var/Type length mismatch: " (ppr tvs $$ ppr tys) env
1221 -- zip_ty_env _ _ env = env
1222
1223 instance Outputable TvSubst where
1224   ppr (TvSubst ins env)
1225     = brackets $ sep[ ptext SLIT("TvSubst"),
1226                       nest 2 (ptext SLIT("In scope:") <+> ppr ins),
1227                       nest 2 (ptext SLIT("Env:") <+> ppr env) ]
1228 \end{code}
1229
1230 %************************************************************************
1231 %*                                                                      *
1232                 Performing type substitutions
1233 %*                                                                      *
1234 %************************************************************************
1235
1236 \begin{code}
1237 substTyWith :: [TyVar] -> [Type] -> Type -> Type
1238 substTyWith tvs tys = ASSERT( length tvs == length tys )
1239                       substTy (zipOpenTvSubst tvs tys)
1240
1241 substTy :: TvSubst -> Type  -> Type
1242 substTy subst ty | isEmptyTvSubst subst = ty
1243                  | otherwise            = subst_ty subst ty
1244
1245 substTys :: TvSubst -> [Type] -> [Type]
1246 substTys subst tys | isEmptyTvSubst subst = tys
1247                    | otherwise            = map (subst_ty subst) tys
1248
1249 substTheta :: TvSubst -> ThetaType -> ThetaType
1250 substTheta subst theta
1251   | isEmptyTvSubst subst = theta
1252   | otherwise            = map (substPred subst) theta
1253
1254 substPred :: TvSubst -> PredType -> PredType
1255 substPred subst (IParam n ty)     = IParam n (subst_ty subst ty)
1256 substPred subst (ClassP clas tys) = ClassP clas (map (subst_ty subst) tys)
1257 substPred subst (EqPred ty1 ty2)  = EqPred (subst_ty subst ty1) (subst_ty subst ty2)
1258
1259 deShadowTy :: TyVarSet -> Type -> Type  -- Remove any nested binders mentioning tvs
1260 deShadowTy tvs ty
1261   = subst_ty (mkTvSubst in_scope emptyTvSubstEnv) ty
1262   where
1263     in_scope = mkInScopeSet tvs
1264
1265 subst_ty :: TvSubst -> Type -> Type
1266 -- subst_ty is the main workhorse for type substitution
1267 --
1268 -- Note that the in_scope set is poked only if we hit a forall
1269 -- so it may often never be fully computed
1270 subst_ty subst ty
1271    = go ty
1272   where
1273     go (TyVarTy tv)                = substTyVar subst tv
1274     go (TyConApp tc tys)           = let args = map go tys
1275                                      in  args `seqList` TyConApp tc args
1276
1277     go (PredTy p)                  = PredTy $! (substPred subst p)
1278
1279     go (NoteTy (FTVNote _) ty2)    = go ty2             -- Discard the free tyvar note
1280
1281     go (FunTy arg res)             = (FunTy $! (go arg)) $! (go res)
1282     go (AppTy fun arg)             = mkAppTy (go fun) $! (go arg)
1283                 -- The mkAppTy smart constructor is important
1284                 -- we might be replacing (a Int), represented with App
1285                 -- by [Int], represented with TyConApp
1286     go (ForAllTy tv ty)            = case substTyVarBndr subst tv of
1287                                         (subst', tv') -> ForAllTy tv' $! (subst_ty subst' ty)
1288
1289 substTyVar :: TvSubst -> TyVar  -> Type
1290 substTyVar subst@(TvSubst in_scope env) tv
1291   = case lookupTyVar subst tv of {
1292         Nothing -> TyVarTy tv;
1293         Just ty -> ty   -- See Note [Apply Once]
1294     }
1295
1296 lookupTyVar :: TvSubst -> TyVar  -> Maybe Type
1297         -- See Note [Extending the TvSubst]
1298 lookupTyVar (TvSubst in_scope env) tv = lookupVarEnv env tv
1299
1300 substTyVarBndr :: TvSubst -> TyVar -> (TvSubst, TyVar)
1301 substTyVarBndr subst@(TvSubst in_scope env) old_var
1302   = (TvSubst (in_scope `extendInScopeSet` new_var) new_env, new_var)
1303   where
1304     is_co_var = isCoVar old_var
1305
1306     new_env | no_change = delVarEnv env old_var
1307             | otherwise = extendVarEnv env old_var (TyVarTy new_var)
1308
1309     no_change = new_var == old_var && not is_co_var
1310         -- no_change means that the new_var is identical in
1311         -- all respects to the old_var (same unique, same kind)
1312         -- See Note [Extending the TvSubst]
1313         --
1314         -- In that case we don't need to extend the substitution
1315         -- to map old to new.  But instead we must zap any
1316         -- current substitution for the variable. For example:
1317         --      (\x.e) with id_subst = [x |-> e']
1318         -- Here we must simply zap the substitution for x
1319
1320     new_var = uniqAway in_scope subst_old_var
1321         -- The uniqAway part makes sure the new variable is not already in scope
1322
1323     subst_old_var -- subst_old_var is old_var with the substitution applied to its kind
1324                   -- It's only worth doing the substitution for coercions,
1325                   -- becuase only they can have free type variables
1326         | is_co_var = setTyVarKind old_var (substTy subst (tyVarKind old_var))
1327         | otherwise = old_var
1328 \end{code}
1329
1330 ----------------------------------------------------
1331 -- Kind Stuff
1332
1333 Kinds
1334 ~~~~~
1335 There's a little subtyping at the kind level:
1336
1337                  ?
1338                 / \
1339                /   \
1340               ??   (#)
1341              /  \
1342             *   #
1343
1344 where   *    [LiftedTypeKind]   means boxed type
1345         #    [UnliftedTypeKind] means unboxed type
1346         (#)  [UbxTupleKind]     means unboxed tuple
1347         ??   [ArgTypeKind]      is the lub of *,#
1348         ?    [OpenTypeKind]     means any type at all
1349
1350 In particular:
1351
1352         error :: forall a:?. String -> a
1353         (->)  :: ?? -> ? -> *
1354         (\(x::t) -> ...)        Here t::?? (i.e. not unboxed tuple)
1355
1356 \begin{code}
1357 type KindVar = TyVar  -- invariant: KindVar will always be a
1358                       -- TcTyVar with details MetaTv TauTv ...
1359 -- kind var constructors and functions are in TcType
1360
1361 type SimpleKind = Kind
1362 \end{code}
1363
1364 Kind inference
1365 ~~~~~~~~~~~~~~
1366 During kind inference, a kind variable unifies only with
1367 a "simple kind", sk
1368         sk ::= * | sk1 -> sk2
1369 For example
1370         data T a = MkT a (T Int#)
1371 fails.  We give T the kind (k -> *), and the kind variable k won't unify
1372 with # (the kind of Int#).
1373
1374 Type inference
1375 ~~~~~~~~~~~~~~
1376 When creating a fresh internal type variable, we give it a kind to express
1377 constraints on it.  E.g. in (\x->e) we make up a fresh type variable for x,
1378 with kind ??.
1379
1380 During unification we only bind an internal type variable to a type
1381 whose kind is lower in the sub-kind hierarchy than the kind of the tyvar.
1382
1383 When unifying two internal type variables, we collect their kind constraints by
1384 finding the GLB of the two.  Since the partial order is a tree, they only
1385 have a glb if one is a sub-kind of the other.  In that case, we bind the
1386 less-informative one to the more informative one.  Neat, eh?
1387
1388
1389 \begin{code}
1390
1391 \end{code}
1392
1393 %************************************************************************
1394 %*                                                                      *
1395         Functions over Kinds
1396 %*                                                                      *
1397 %************************************************************************
1398
1399 \begin{code}
1400 kindFunResult :: Kind -> Kind
1401 kindFunResult k = funResultTy k
1402
1403 splitKindFunTys :: Kind -> ([Kind],Kind)
1404 splitKindFunTys k = splitFunTys k
1405
1406 splitKindFunTysN :: Int -> Kind -> ([Kind],Kind)
1407 splitKindFunTysN k = splitFunTysN k
1408
1409 isUbxTupleKind, isOpenTypeKind, isArgTypeKind, isUnliftedTypeKind :: Kind -> Bool
1410
1411 isOpenTypeKindCon tc    = tyConUnique tc == openTypeKindTyConKey
1412
1413 isOpenTypeKind (TyConApp tc _) = isOpenTypeKindCon tc
1414 isOpenTypeKind other           = False
1415
1416 isUbxTupleKindCon tc = tyConUnique tc == ubxTupleKindTyConKey
1417
1418 isUbxTupleKind (TyConApp tc _) = isUbxTupleKindCon tc
1419 isUbxTupleKind other           = False
1420
1421 isArgTypeKindCon tc = tyConUnique tc == argTypeKindTyConKey
1422
1423 isArgTypeKind (TyConApp tc _) = isArgTypeKindCon tc
1424 isArgTypeKind other = False
1425
1426 isUnliftedTypeKindCon tc = tyConUnique tc == unliftedTypeKindTyConKey
1427
1428 isUnliftedTypeKind (TyConApp tc _) = isUnliftedTypeKindCon tc
1429 isUnliftedTypeKind other           = False
1430
1431 isSubOpenTypeKind :: Kind -> Bool
1432 -- True of any sub-kind of OpenTypeKind (i.e. anything except arrow)
1433 isSubOpenTypeKind (FunTy k1 k2)    = ASSERT2 ( isKind k1, text "isSubOpenTypeKind" <+> ppr k1 <+> text "::" <+> ppr (typeKind k1) )
1434                                      ASSERT2 ( isKind k2, text "isSubOpenTypeKind" <+> ppr k2 <+> text "::" <+> ppr (typeKind k2) )
1435                                      False
1436 isSubOpenTypeKind (TyConApp kc []) = ASSERT( isKind (TyConApp kc []) ) True
1437 isSubOpenTypeKind other            = ASSERT( isKind other ) False
1438          -- This is a conservative answer
1439          -- It matters in the call to isSubKind in
1440          -- checkExpectedKind.
1441
1442 isSubArgTypeKindCon kc
1443   | isUnliftedTypeKindCon kc = True
1444   | isLiftedTypeKindCon kc   = True
1445   | isArgTypeKindCon kc      = True
1446   | otherwise                = False
1447
1448 isSubArgTypeKind :: Kind -> Bool
1449 -- True of any sub-kind of ArgTypeKind
1450 isSubArgTypeKind (TyConApp kc []) = isSubArgTypeKindCon kc
1451 isSubArgTypeKind other            = False
1452
1453 isSuperKind :: Type -> Bool
1454 isSuperKind (TyConApp (skc) []) = isSuperKindTyCon skc
1455 isSuperKind other = False
1456
1457 isKind :: Kind -> Bool
1458 isKind k = isSuperKind (typeKind k)
1459
1460
1461
1462 isSubKind :: Kind -> Kind -> Bool
1463 -- (k1 `isSubKind` k2) checks that k1 <: k2
1464 isSubKind (TyConApp kc1 []) (TyConApp kc2 []) = kc1 `isSubKindCon` kc2
1465 isSubKind (FunTy a1 r1) (FunTy a2 r2)         = (a2 `isSubKind` a1) && (r1 `isSubKind` r2)
1466 isSubKind (PredTy (EqPred ty1 ty2)) (PredTy (EqPred ty1' ty2'))
1467   = ty1 `tcEqType` ty1' && ty2 `tcEqType` ty2'
1468 isSubKind k1            k2                    = False
1469
1470 eqKind :: Kind -> Kind -> Bool
1471 eqKind = tcEqType
1472
1473 isSubKindCon :: TyCon -> TyCon -> Bool
1474 -- (kc1 `isSubKindCon` kc2) checks that kc1 <: kc2
1475 isSubKindCon kc1 kc2
1476   | isLiftedTypeKindCon kc1   && isLiftedTypeKindCon kc2   = True
1477   | isUnliftedTypeKindCon kc1 && isUnliftedTypeKindCon kc2 = True
1478   | isUbxTupleKindCon kc1     && isUbxTupleKindCon kc2     = True
1479   | isOpenTypeKindCon kc2                                  = True
1480                            -- we already know kc1 is not a fun, its a TyCon
1481   | isArgTypeKindCon kc2      && isSubArgTypeKindCon kc1   = True
1482   | otherwise                                              = False
1483
1484 defaultKind :: Kind -> Kind
1485 -- Used when generalising: default kind '?' and '??' to '*'
1486 --
1487 -- When we generalise, we make generic type variables whose kind is
1488 -- simple (* or *->* etc).  So generic type variables (other than
1489 -- built-in constants like 'error') always have simple kinds.  This is important;
1490 -- consider
1491 --      f x = True
1492 -- We want f to get type
1493 --      f :: forall (a::*). a -> Bool
1494 -- Not
1495 --      f :: forall (a::??). a -> Bool
1496 -- because that would allow a call like (f 3#) as well as (f True),
1497 --and the calling conventions differ.  This defaulting is done in TcMType.zonkTcTyVarBndr.
1498 defaultKind k
1499   | isSubOpenTypeKind k = liftedTypeKind
1500   | isSubArgTypeKind k  = liftedTypeKind
1501   | otherwise        = k
1502
1503 isEqPred :: PredType -> Bool
1504 isEqPred (EqPred _ _) = True
1505 isEqPred other        = False
1506 \end{code}