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 {-# OPTIONS -fno-warn-incomplete-patterns #-}
  10 -- The above warning supression flag is a temporary kludge.
  11 -- While working on this module you are encouraged to remove it and fix
  12 -- any warnings in the module. See
  13 --     http://hackage.haskell.org/trac/ghc/wiki/Commentary/CodingStyle#Warnings
  14 -- for details
  15
  16 -- | Main functions for manipulating types and type-related things
  17 module Type (
  18         -- Note some of this is just re-exports from TyCon..
  19
  20         -- * Main data types representing Types
  21         -- $type_classification
  22
  23         -- $representation_types
  24         TyThing(..), Type, PredType(..), ThetaType,
  25
  26         -- ** Constructing and deconstructing types
  27         mkTyVarTy, mkTyVarTys, getTyVar, getTyVar_maybe,
  28
  29         mkAppTy, mkAppTys, splitAppTy, splitAppTys,
  30         splitAppTy_maybe, repSplitAppTy_maybe,
  31
  32         mkFunTy, mkFunTys, splitFunTy, splitFunTy_maybe,
  33         splitFunTys, splitFunTysN,
  34         funResultTy, funArgTy, zipFunTys,
  35
  36         mkTyConApp, mkTyConTy,
  37         tyConAppTyCon, tyConAppArgs,
  38         splitTyConApp_maybe, splitTyConApp,
  39
  40         mkForAllTy, mkForAllTys, splitForAllTy_maybe, splitForAllTys,
  41         applyTy, applyTys, applyTysD, isForAllTy, dropForAlls,
  42
  43         -- (Newtypes)
  44         newTyConInstRhs,
  45
  46         -- (Type families)
  47         tyFamInsts, predFamInsts,
  48
  49         -- (Source types)
  50         mkPredTy, mkPredTys, mkFamilyTyConApp,
  51
  52         -- ** Common type constructors
  53         funTyCon,
  54
  55         -- ** Predicates on types
  56         isTyVarTy, isFunTy,
  57
  58         -- (Lifting and boxity)
  59         isUnLiftedType, isUnboxedTupleType, isAlgType, isClosedAlgType,
  60         isPrimitiveType, isStrictType, isStrictPred,
  61
  62         -- * Main data types representing Kinds
  63         -- $kind_subtyping
  64         Kind, SimpleKind, KindVar,
  65
  66         -- ** Deconstructing Kinds
  67         kindFunResult, splitKindFunTys, splitKindFunTysN,
  68
  69         -- ** Common Kinds and SuperKinds
  70         liftedTypeKind, unliftedTypeKind, openTypeKind,
  71         argTypeKind, ubxTupleKind,
  72
  73         tySuperKind, coSuperKind,
  74
  75         -- ** Common Kind type constructors
  76         liftedTypeKindTyCon, openTypeKindTyCon, unliftedTypeKindTyCon,
  77         argTypeKindTyCon, ubxTupleKindTyCon,
  78
  79         -- ** Predicates on Kinds
  80         isLiftedTypeKind, isUnliftedTypeKind, isOpenTypeKind,
  81         isUbxTupleKind, isArgTypeKind, isKind, isTySuperKind,
  82         isCoSuperKind, isSuperKind, isCoercionKind, isEqPred,
  83         mkArrowKind, mkArrowKinds,
  84
  85         isSubArgTypeKind, isSubOpenTypeKind, isSubKind, defaultKind, eqKind,
  86         isSubKindCon,
  87
  88         -- * Type free variables
  89         tyVarsOfType, tyVarsOfTypes, tyVarsOfPred, tyVarsOfTheta,
  90         typeKind,
  91
  92         -- * Tidying type related things up for printing
  93         tidyType,      tidyTypes,
  94         tidyOpenType,  tidyOpenTypes,
  95         tidyTyVarBndr, tidyFreeTyVars,
  96         tidyOpenTyVar, tidyOpenTyVars,
  97         tidyTopType,   tidyPred,
  98         tidyKind,
  99
 100         -- * Type comparison
 101         coreEqType, tcEqType, tcEqTypes, tcCmpType, tcCmpTypes,
 102         tcEqPred, tcEqPredX, tcCmpPred, tcEqTypeX, tcPartOfType, tcPartOfPred,
 103
 104         -- * Forcing evaluation of types
 105         seqType, seqTypes,
 106
 107         -- * Other views onto Types
 108         coreView, tcView, kindView,
 109
 110         repType,
 111
 112         -- * Type representation for the code generator
 113         PrimRep(..),
 114
 115         typePrimRep, predTypeRep,
 116
 117         -- * Main type substitution data types
 118         TvSubstEnv,     -- Representation widely visible
 119         TvSubst(..),    -- Representation visible to a few friends
 120
 121         -- ** Manipulating type substitutions
 122         emptyTvSubstEnv, emptyTvSubst,
 123
 124         mkTvSubst, mkOpenTvSubst, zipOpenTvSubst, zipTopTvSubst, mkTopTvSubst, notElemTvSubst,
 125         getTvSubstEnv, setTvSubstEnv, getTvInScope, extendTvInScope,
 126         extendTvSubst, extendTvSubstList, isInScope, composeTvSubst, zipTyEnv,
 127         isEmptyTvSubst,
 128
 129         -- ** Performing substitution on types
 130         substTy, substTys, substTyWith, substTysWith, substTheta,
 131         substPred, substTyVar, substTyVars, substTyVarBndr, deShadowTy, lookupTyVar,
 132
 133         -- * Pretty-printing
 134         pprType, pprParendType, pprTypeApp, pprTyThingCategory, pprTyThing, pprForAll,
 135         pprPred, pprTheta, pprThetaArrow, pprClassPred, pprKind, pprParendKind,
 136
 137         pprSourceTyCon
 138     ) where
 139
 140 #include "HsVersions.h"
 141
 142 -- We import the representation and primitive functions from TypeRep.
 143 -- Many things are reexported, but not the representation!
 144
 145 import TypeRep
 146
 147 -- friends:
 148 import Var
 149 import VarEnv
 150 import VarSet
 151
 152 import Name
 153 import Class
 154 import PrelNames
 155 import TyCon
 156
 157 -- others
 158 import StaticFlags
 159 import Util
 160 import Outputable
 161 import FastString
 162
 163 import Data.List
 164 import Data.Maybe       ( isJust )
 165 \end{code}
 166
 167 \begin{code}
 168 -- $type_classification
 169 -- #type_classification#
 170 --
 171 -- Types are one of:
 172 --
 173 -- [Unboxed]            Iff its representation is other than a pointer
 174 --                      Unboxed types are also unlifted.
 175 --
 176 -- [Lifted]             Iff it has bottom as an element.
 177 --                      Closures always have lifted types: i.e. any
 178 --                      let-bound identifier in Core must have a lifted
 179 --                      type. Operationally, a lifted object is one that
 180 --                      can be entered.
 181 --                      Only lifted types may be unified with a type variable.
 182 --
 183 -- [Algebraic]          Iff it is a type with one or more constructors, whether
 184 --                      declared with @data@ or @newtype@.
 185 --                      An algebraic type is one that can be deconstructed
 186 --                      with a case expression. This is /not/ the same as
 187 --                      lifted types, because we also include unboxed
 188 --                      tuples in this classification.
 189 --
 190 -- [Data]               Iff it is a type declared with @data@, or a boxed tuple.
 191 --
 192 -- [Primitive]          Iff it is a built-in type that can't be expressed in Haskell.
 193 --
 194 -- Currently, all primitive types are unlifted, but that's not necessarily
 195 -- the case: for example, @Int@ could be primitive.
 196 --
 197 -- Some primitive types are unboxed, such as @Int#@, whereas some are boxed
 198 -- but unlifted (such as @ByteArray#@).  The only primitive types that we
 199 -- classify as algebraic are the unboxed tuples.
 200 --
 201 -- Some examples of type classifications that may make this a bit clearer are:
 202 --
 203 -- @
 204 -- Type         primitive       boxed           lifted          algebraic
 205 -- -----------------------------------------------------------------------------
 206 -- Int#         Yes             No              No              No
 207 -- ByteArray#   Yes             Yes             No              No
 208 -- (\# a, b \#)   Yes             No              No              Yes
 209 -- (  a, b  )   No              Yes             Yes             Yes
 210 -- [a]          No              Yes             Yes             Yes
 211 -- @
 212
 213 -- $representation_types
 214 -- A /source type/ is a type that is a separate type as far as the type checker is
 215 -- concerned, but which has a more low-level representation as far as Core-to-Core
 216 -- passes and the rest of the back end is concerned. Notably, 'PredTy's are removed
 217 -- from the representation type while they do exist in the source types.
 218 --
 219 -- You don't normally have to worry about this, as the utility functions in
 220 -- this module will automatically convert a source into a representation type
 221 -- if they are spotted, to the best of it's abilities. If you don't want this
 222 -- to happen, use the equivalent functions from the "TcType" module.
 223 \end{code}
 224
 225 %************************************************************************
 226 %*                                                                      *
 227                 Type representation
 228 %*                                                                      *
 229 %************************************************************************
 230
 231 \begin{code}
 232 {-# INLINE coreView #-}
 233 coreView :: Type -> Maybe Type
 234 -- ^ In Core, we \"look through\" non-recursive newtypes and 'PredTypes': this
 235 -- function tries to obtain a different view of the supplied type given this
 236 --
 237 -- Strips off the /top layer only/ of a type to give
 238 -- its underlying representation type.
 239 -- Returns Nothing if there is nothing to look through.
 240 --
 241 -- In the case of @newtype@s, it returns one of:
 242 --
 243 -- 1) A vanilla 'TyConApp' (recursive newtype, or non-saturated)
 244 --
 245 -- 2) The newtype representation (otherwise), meaning the
 246 --    type written in the RHS of the newtype declaration,
 247 --    which may itself be a newtype
 248 --
 249 -- For example, with:
 250 --
 251 -- > newtype R = MkR S
 252 -- > newtype S = MkS T
 253 -- > newtype T = MkT (T -> T)
 254 --
 255 -- 'expandNewTcApp' on:
 256 --
 257 --  * @R@ gives @Just S@
 258 --  * @S@ gives @Just T@
 259 --  * @T@ gives @Nothing@ (no expansion)
 260
 261 -- By being non-recursive and inlined, this case analysis gets efficiently
 262 -- joined onto the case analysis that the caller is already doing
 263 coreView (PredTy p)
 264   | isEqPred p             = Nothing
 265   | otherwise              = Just (predTypeRep p)
 266 coreView (TyConApp tc tys) | Just (tenv, rhs, tys') <- coreExpandTyCon_maybe tc tys
 267                            = Just (mkAppTys (substTy (mkTopTvSubst tenv) rhs) tys')
 268                                 -- Its important to use mkAppTys, rather than (foldl AppTy),
 269                                 -- because the function part might well return a
 270                                 -- partially-applied type constructor; indeed, usually will!
 271 coreView _                 = Nothing
 272
 273
 274
 275 -----------------------------------------------
 276 {-# INLINE tcView #-}
 277 tcView :: Type -> Maybe Type
 278 -- ^ Similar to 'coreView', but for the type checker, which just looks through synonyms
 279 tcView (TyConApp tc tys) | Just (tenv, rhs, tys') <- tcExpandTyCon_maybe tc tys
 280                          = Just (mkAppTys (substTy (mkTopTvSubst tenv) rhs) tys')
 281 tcView _                 = Nothing
 282
 283 -----------------------------------------------
 284 {-# INLINE kindView #-}
 285 kindView :: Kind -> Maybe Kind
 286 -- ^ Similar to 'coreView' or 'tcView', but works on 'Kind's
 287
 288 -- For the moment, we don't even handle synonyms in kinds
 289 kindView _            = Nothing
 290 \end{code}
 291
 292
 293 %************************************************************************
 294 %*                                                                      *
 295 \subsection{Constructor-specific functions}
 296 %*                                                                      *
 297 %************************************************************************
 298
 299
 300 ---------------------------------------------------------------------
 301                                 TyVarTy
 302                                 ~~~~~~~
 303 \begin{code}
 304 mkTyVarTy  :: TyVar   -> Type
 305 mkTyVarTy  = TyVarTy
 306
 307 mkTyVarTys :: [TyVar] -> [Type]
 308 mkTyVarTys = map mkTyVarTy -- a common use of mkTyVarTy
 309
 310 -- | Attempts to obtain the type variable underlying a 'Type', and panics with the
 311 -- given message if this is not a type variable type. See also 'getTyVar_maybe'
 312 getTyVar :: String -> Type -> TyVar
 313 getTyVar msg ty = case getTyVar_maybe ty of
 314                     Just tv -> tv
 315                     Nothing -> panic ("getTyVar: " ++ msg)
 316
 317 isTyVarTy :: Type -> Bool
 318 isTyVarTy ty = isJust (getTyVar_maybe ty)
 319
 320 -- | Attempts to obtain the type variable underlying a 'Type'
 321 getTyVar_maybe :: Type -> Maybe TyVar
 322 getTyVar_maybe ty | Just ty' <- coreView ty = getTyVar_maybe ty'
 323 getTyVar_maybe (TyVarTy tv)                 = Just tv
 324 getTyVar_maybe _                            = Nothing
 325
 326 \end{code}
 327
 328
 329 ---------------------------------------------------------------------
 330                                 AppTy
 331                                 ~~~~~
 332 We need to be pretty careful with AppTy to make sure we obey the
 333 invariant that a TyConApp is always visibly so.  mkAppTy maintains the
 334 invariant: use it.
 335
 336 \begin{code}
 337 -- | Applies a type to another, as in e.g. @k a@
 338 mkAppTy :: Type -> Type -> Type
 339 mkAppTy orig_ty1 orig_ty2
 340   = mk_app orig_ty1
 341   where
 342     mk_app (TyConApp tc tys) = mkTyConApp tc (tys ++ [orig_ty2])
 343     mk_app _                 = AppTy orig_ty1 orig_ty2
 344         -- Note that the TyConApp could be an
 345         -- under-saturated type synonym.  GHC allows that; e.g.
 346         --      type Foo k = k a -> k a
 347         --      type Id x = x
 348         --      foo :: Foo Id -> Foo Id
 349         --
 350         -- Here Id is partially applied in the type sig for Foo,
 351         -- but once the type synonyms are expanded all is well
 352
 353 mkAppTys :: Type -> [Type] -> Type
 354 mkAppTys orig_ty1 []        = orig_ty1
 355         -- This check for an empty list of type arguments
 356         -- avoids the needless loss of a type synonym constructor.
 357         -- For example: mkAppTys Rational []
 358         --   returns to (Ratio Integer), which has needlessly lost
 359         --   the Rational part.
 360 mkAppTys orig_ty1 orig_tys2
 361   = mk_app orig_ty1
 362   where
 363     mk_app (TyConApp tc tys) = mkTyConApp tc (tys ++ orig_tys2)
 364                                 -- mkTyConApp: see notes with mkAppTy
 365     mk_app _                 = foldl AppTy orig_ty1 orig_tys2
 366
 367 -------------
 368 splitAppTy_maybe :: Type -> Maybe (Type, Type)
 369 -- ^ Attempt to take a type application apart, whether it is a
 370 -- function, type constructor, or plain type application. Note
 371 -- that type family applications are NEVER unsaturated by this!
 372 splitAppTy_maybe ty | Just ty' <- coreView ty
 373                     = splitAppTy_maybe ty'
 374 splitAppTy_maybe ty = repSplitAppTy_maybe ty
 375
 376 -------------
 377 repSplitAppTy_maybe :: Type -> Maybe (Type,Type)
 378 -- ^ Does the AppTy split as in 'splitAppTy_maybe', but assumes that
 379 -- any Core view stuff is already done
 380 repSplitAppTy_maybe (FunTy ty1 ty2)   = Just (TyConApp funTyCon [ty1], ty2)
 381 repSplitAppTy_maybe (AppTy ty1 ty2)   = Just (ty1, ty2)
 382 repSplitAppTy_maybe (TyConApp tc tys)
 383   | not (isOpenSynTyCon tc) || length tys > tyConArity tc
 384   = case snocView tys of       -- never create unsaturated type family apps
 385       Just (tys', ty') -> Just (TyConApp tc tys', ty')
 386       Nothing          -> Nothing
 387 repSplitAppTy_maybe _other = Nothing
 388 -------------
 389 splitAppTy :: Type -> (Type, Type)
 390 -- ^ Attempts to take a type application apart, as in 'splitAppTy_maybe',
 391 -- and panics if this is not possible
 392 splitAppTy ty = case splitAppTy_maybe ty of
 393                         Just pr -> pr
 394                         Nothing -> panic "splitAppTy"
 395
 396 -------------
 397 splitAppTys :: Type -> (Type, [Type])
 398 -- ^ Recursively splits a type as far as is possible, leaving a residual
 399 -- type being applied to and the type arguments applied to it. Never fails,
 400 -- even if that means returning an empty list of type applications.
 401 splitAppTys ty = split ty ty []
 402   where
 403     split orig_ty ty args | Just ty' <- coreView ty = split orig_ty ty' args
 404     split _       (AppTy ty arg)        args = split ty ty (arg:args)
 405     split _       (TyConApp tc tc_args) args
 406       = let -- keep type families saturated
 407             n | isOpenSynTyCon tc = tyConArity tc
 408               | otherwise         = 0
 409             (tc_args1, tc_args2)  = splitAt n tc_args
 410         in
 411         (TyConApp tc tc_args1, tc_args2 ++ args)
 412     split _       (FunTy ty1 ty2)       args = ASSERT( null args )
 413                                                (TyConApp funTyCon [], [ty1,ty2])
 414     split orig_ty _                     args = (orig_ty, args)
 415
 416 \end{code}
 417
 418
 419 ---------------------------------------------------------------------
 420                                 FunTy
 421                                 ~~~~~
 422
 423 \begin{code}
 424 mkFunTy :: Type -> Type -> Type
 425 -- ^ Creates a function type from the given argument and result type
 426 mkFunTy (PredTy (EqPred ty1 ty2)) res = mkForAllTy (mkWildCoVar (PredTy (EqPred ty1 ty2))) res
 427 mkFunTy arg res = FunTy arg res
 428
 429 mkFunTys :: [Type] -> Type -> Type
 430 mkFunTys tys ty = foldr mkFunTy ty tys
 431
 432 isFunTy :: Type -> Bool
 433 isFunTy ty = isJust (splitFunTy_maybe ty)
 434
 435 splitFunTy :: Type -> (Type, Type)
 436 -- ^ Attempts to extract the argument and result types from a type, and
 437 -- panics if that is not possible. See also 'splitFunTy_maybe'
 438 splitFunTy ty | Just ty' <- coreView ty = splitFunTy ty'
 439 splitFunTy (FunTy arg res)   = (arg, res)
 440 splitFunTy other             = pprPanic "splitFunTy" (ppr other)
 441
 442 splitFunTy_maybe :: Type -> Maybe (Type, Type)
 443 -- ^ Attempts to extract the argument and result types from a type
 444 splitFunTy_maybe ty | Just ty' <- coreView ty = splitFunTy_maybe ty'
 445 splitFunTy_maybe (FunTy arg res)   = Just (arg, res)
 446 splitFunTy_maybe _                 = Nothing
 447
 448 splitFunTys :: Type -> ([Type], Type)
 449 splitFunTys ty = split [] ty ty
 450   where
 451     split args orig_ty ty | Just ty' <- coreView ty = split args orig_ty ty'
 452     split args _       (FunTy arg res)   = split (arg:args) res res
 453     split args orig_ty _                 = (reverse args, orig_ty)
 454
 455 splitFunTysN :: Int -> Type -> ([Type], Type)
 456 -- ^ Split off exactly the given number argument types, and panics if that is not possible
 457 splitFunTysN 0 ty = ([], ty)
 458 splitFunTysN n ty = case splitFunTy ty of { (arg, res) ->
 459                     case splitFunTysN (n-1) res of { (args, res) ->
 460                     (arg:args, res) }}
 461
 462 -- | Splits off argument types from the given type and associating
 463 -- them with the things in the input list from left to right. The
 464 -- final result type is returned, along with the resulting pairs of
 465 -- objects and types, albeit with the list of pairs in reverse order.
 466 -- Panics if there are not enough argument types for the input list.
 467 zipFunTys :: Outputable a => [a] -> Type -> ([(a, Type)], Type)
 468 zipFunTys orig_xs orig_ty = split [] orig_xs orig_ty orig_ty
 469   where
 470     split acc []     nty _                 = (reverse acc, nty)
 471     split acc xs     nty ty
 472           | Just ty' <- coreView ty        = split acc xs nty ty'
 473     split acc (x:xs) _   (FunTy arg res)   = split ((x,arg):acc) xs res res
 474     split _   _      _   _                 = pprPanic "zipFunTys" (ppr orig_xs <+> ppr orig_ty)
 475
 476 funResultTy :: Type -> Type
 477 -- ^ Extract the function result type and panic if that is not possible
 478 funResultTy ty | Just ty' <- coreView ty = funResultTy ty'
 479 funResultTy (FunTy _arg res)  = res
 480 funResultTy ty                = pprPanic "funResultTy" (ppr ty)
 481
 482 funArgTy :: Type -> Type
 483 -- ^ Extract the function argument type and panic if that is not possible
 484 funArgTy ty | Just ty' <- coreView ty = funArgTy ty'
 485 funArgTy (FunTy arg _res)  = arg
 486 funArgTy ty                = pprPanic "funArgTy" (ppr ty)
 487 \end{code}
 488
 489 ---------------------------------------------------------------------
 490                                 TyConApp
 491                                 ~~~~~~~~
 492
 493 \begin{code}
 494 -- | A key function: builds a 'TyConApp' or 'FunTy' as apppropriate to its arguments.
 495 -- Applies its arguments to the constructor from left to right
 496 mkTyConApp :: TyCon -> [Type] -> Type
 497 mkTyConApp tycon tys
 498   | isFunTyCon tycon, [ty1,ty2] <- tys
 499   = FunTy ty1 ty2
 500
 501   | otherwise
 502   = TyConApp tycon tys
 503
 504 -- | Create the plain type constructor type which has been applied to no type arguments at all.
 505 mkTyConTy :: TyCon -> Type
 506 mkTyConTy tycon = mkTyConApp tycon []
 507
 508 -- splitTyConApp "looks through" synonyms, because they don't
 509 -- mean a distinct type, but all other type-constructor applications
 510 -- including functions are returned as Just ..
 511
 512 -- | The same as @fst . splitTyConApp@
 513 tyConAppTyCon :: Type -> TyCon
 514 tyConAppTyCon ty = fst (splitTyConApp ty)
 515
 516 -- | The same as @snd . splitTyConApp@
 517 tyConAppArgs :: Type -> [Type]
 518 tyConAppArgs ty = snd (splitTyConApp ty)
 519
 520 -- | Attempts to tease a type apart into a type constructor and the application
 521 -- of a number of arguments to that constructor. Panics if that is not possible.
 522 -- See also 'splitTyConApp_maybe'
 523 splitTyConApp :: Type -> (TyCon, [Type])
 524 splitTyConApp ty = case splitTyConApp_maybe ty of
 525                         Just stuff -> stuff
 526                         Nothing    -> pprPanic "splitTyConApp" (ppr ty)
 527
 528 -- | Attempts to tease a type apart into a type constructor and the application
 529 -- of a number of arguments to that constructor
 530 splitTyConApp_maybe :: Type -> Maybe (TyCon, [Type])
 531 splitTyConApp_maybe ty | Just ty' <- coreView ty = splitTyConApp_maybe ty'
 532 splitTyConApp_maybe (TyConApp tc tys) = Just (tc, tys)
 533 splitTyConApp_maybe (FunTy arg res)   = Just (funTyCon, [arg,res])
 534 splitTyConApp_maybe _                 = Nothing
 535
 536 newTyConInstRhs :: TyCon -> [Type] -> Type
 537 -- ^ Unwrap one 'layer' of newtype on a type constructor and its arguments, using an
 538 -- eta-reduced version of the @newtype@ if possible
 539 newTyConInstRhs tycon tys
 540     = ASSERT2( equalLength tvs tys1, ppr tycon $$ ppr tys $$ ppr tvs )
 541       mkAppTys (substTyWith tvs tys1 ty) tys2
 542   where
 543     (tvs, ty)    = newTyConEtadRhs tycon
 544     (tys1, tys2) = splitAtList tvs tys
 545 \end{code}
 546
 547
 548 ---------------------------------------------------------------------
 549                                 SynTy
 550                                 ~~~~~
 551
 552 Notes on type synonyms
 553 ~~~~~~~~~~~~~~~~~~~~~~
 554 The various "split" functions (splitFunTy, splitRhoTy, splitForAllTy) try
 555 to return type synonyms whereever possible. Thus
 556
 557         type Foo a = a -> a
 558
 559 we want
 560         splitFunTys (a -> Foo a) = ([a], Foo a)
 561 not                                ([a], a -> a)
 562
 563 The reason is that we then get better (shorter) type signatures in
 564 interfaces.  Notably this plays a role in tcTySigs in TcBinds.lhs.
 565
 566
 567 Note [Expanding newtypes]
 568 ~~~~~~~~~~~~~~~~~~~~~~~~~
 569 When expanding a type to expose a data-type constructor, we need to be
 570 careful about newtypes, lest we fall into an infinite loop. Here are
 571 the key examples:
 572
 573   newtype Id  x = MkId x
 574   newtype Fix f = MkFix (f (Fix f))
 575   newtype T     = MkT (T -> T)
 576
 577   Type           Expansion
 578  --------------------------
 579   T              T -> T
 580   Fix Maybe      Maybe (Fix Maybe)
 581   Id (Id Int)    Int
 582   Fix Id         NO NO NO
 583
 584 Notice that we can expand T, even though it's recursive.
 585 And we can expand Id (Id Int), even though the Id shows up
 586 twice at the outer level.
 587
 588 So, when expanding, we keep track of when we've seen a recursive
 589 newtype at outermost level; and bale out if we see it again.
 590
 591
 592                 Representation types
 593                 ~~~~~~~~~~~~~~~~~~~~
 594
 595 \begin{code}
 596 -- | Looks through:
 597 --
 598 --      1. For-alls
 599 --
 600 --      2. Synonyms
 601 --
 602 --      3. Predicates
 603 --
 604 --      4. Usage annotations
 605 --
 606 --      5. All newtypes, including recursive ones, but not newtype families
 607 --
 608 -- It's useful in the back end of the compiler.
 609 repType :: Type -> Type
 610 -- Only applied to types of kind *; hence tycons are saturated
 611 repType ty
 612   = go [] ty
 613   where
 614     go :: [TyCon] -> Type -> Type
 615     go rec_nts ty | Just ty' <- coreView ty     -- Expand synonyms
 616         = go rec_nts ty'
 617
 618     go rec_nts (ForAllTy _ ty)                  -- Look through foralls
 619         = go rec_nts ty
 620
 621     go rec_nts ty@(TyConApp tc tys)             -- Expand newtypes
 622         | Just _co_con <- newTyConCo_maybe tc   -- See Note [Expanding newtypes]
 623         = if tc `elem` rec_nts                  --  in Type.lhs
 624           then ty
 625           else go rec_nts' nt_rhs
 626         where
 627           nt_rhs = newTyConInstRhs tc tys
 628           rec_nts' | isRecursiveTyCon tc = tc:rec_nts
 629                    | otherwise           = rec_nts
 630
 631     go _ ty = ty
 632
 633
 634 -- ToDo: this could be moved to the code generator, using splitTyConApp instead
 635 -- of inspecting the type directly.
 636
 637 -- | Discovers the primitive representation of a more abstract 'Type'
 638 typePrimRep :: Type -> PrimRep
 639 typePrimRep ty = case repType ty of
 640                    TyConApp tc _ -> tyConPrimRep tc
 641                    FunTy _ _     -> PtrRep
 642                    AppTy _ _     -> PtrRep      -- See note below
 643                    TyVarTy _     -> PtrRep
 644                    _             -> pprPanic "typePrimRep" (ppr ty)
 645         -- Types of the form 'f a' must be of kind *, not *#, so
 646         -- we are guaranteed that they are represented by pointers.
 647         -- The reason is that f must have kind *->*, not *->*#, because
 648         -- (we claim) there is no way to constrain f's kind any other
 649         -- way.
 650 \end{code}
 651
 652
 653 ---------------------------------------------------------------------
 654                                 ForAllTy
 655                                 ~~~~~~~~
 656
 657 \begin{code}
 658 mkForAllTy :: TyVar -> Type -> Type
 659 mkForAllTy tyvar ty
 660   = mkForAllTys [tyvar] ty
 661
 662 -- | Wraps foralls over the type using the provided 'TyVar's from left to right
 663 mkForAllTys :: [TyVar] -> Type -> Type
 664 mkForAllTys tyvars ty = foldr ForAllTy ty tyvars
 665
 666 isForAllTy :: Type -> Bool
 667 isForAllTy (ForAllTy _ _) = True
 668 isForAllTy _              = False
 669
 670 -- | Attempts to take a forall type apart, returning the bound type variable
 671 -- and the remainder of the type
 672 splitForAllTy_maybe :: Type -> Maybe (TyVar, Type)
 673 splitForAllTy_maybe ty = splitFAT_m ty
 674   where
 675     splitFAT_m ty | Just ty' <- coreView ty = splitFAT_m ty'
 676     splitFAT_m (ForAllTy tyvar ty)          = Just(tyvar, ty)
 677     splitFAT_m _                            = Nothing
 678
 679 -- | Attempts to take a forall type apart, returning all the immediate such bound
 680 -- type variables and the remainder of the type. Always suceeds, even if that means
 681 -- returning an empty list of 'TyVar's
 682 splitForAllTys :: Type -> ([TyVar], Type)
 683 splitForAllTys ty = split ty ty []
 684    where
 685      split orig_ty ty tvs | Just ty' <- coreView ty = split orig_ty ty' tvs
 686      split _       (ForAllTy tv ty)  tvs = split ty ty (tv:tvs)
 687      split orig_ty _                 tvs = (reverse tvs, orig_ty)
 688
 689 -- | Equivalent to @snd . splitForAllTys@
 690 dropForAlls :: Type -> Type
 691 dropForAlls ty = snd (splitForAllTys ty)
 692 \end{code}
 693
 694 -- (mkPiType now in CoreUtils)
 695
 696 applyTy, applyTys
 697 ~~~~~~~~~~~~~~~~~
 698
 699 \begin{code}
 700 -- | Instantiate a forall type with one or more type arguments.
 701 -- Used when we have a polymorphic function applied to type args:
 702 --
 703 -- > f t1 t2
 704 --
 705 -- We use @applyTys type-of-f [t1,t2]@ to compute the type of the expression.
 706 -- Panics if no application is possible.
 707 applyTy :: Type -> Type -> Type
 708 applyTy ty arg | Just ty' <- coreView ty = applyTy ty' arg
 709 applyTy (ForAllTy tv ty) arg = substTyWith [tv] [arg] ty
 710 applyTy _                _   = panic "applyTy"
 711
 712 applyTys :: Type -> [Type] -> Type
 713 -- ^ This function is interesting because:
 714 --
 715 --      1. The function may have more for-alls than there are args
 716 --
 717 --      2. Less obviously, it may have fewer for-alls
 718 --
 719 -- For case 2. think of:
 720 --
 721 -- > applyTys (forall a.a) [forall b.b, Int]
 722 --
 723 -- This really can happen, via dressing up polymorphic types with newtype
 724 -- clothing.  Here's an example:
 725 --
 726 -- > newtype R = R (forall a. a->a)
 727 -- > foo = case undefined :: R of
 728 -- >            R f -> f ()
 729
 730 applyTys ty args = applyTysD empty ty args
 731
 732 applyTysD :: SDoc -> Type -> [Type] -> Type     -- Debug version
 733 applyTysD _   orig_fun_ty []      = orig_fun_ty
 734 applyTysD doc orig_fun_ty arg_tys
 735   | n_tvs == n_args     -- The vastly common case
 736   = substTyWith tvs arg_tys rho_ty
 737   | n_tvs > n_args      -- Too many for-alls
 738   = substTyWith (take n_args tvs) arg_tys
 739                 (mkForAllTys (drop n_args tvs) rho_ty)
 740   | otherwise           -- Too many type args
 741   = ASSERT2( n_tvs > 0, doc $$ ppr orig_fun_ty )        -- Zero case gives infnite loop!
 742     applyTysD doc (substTyWith tvs (take n_tvs arg_tys) rho_ty)
 743                   (drop n_tvs arg_tys)
 744   where
 745     (tvs, rho_ty) = splitForAllTys orig_fun_ty
 746     n_tvs = length tvs
 747     n_args = length arg_tys
 748 \end{code}
 749
 750
 751 %************************************************************************
 752 %*                                                                      *
 753 \subsection{Source types}
 754 %*                                                                      *
 755 %************************************************************************
 756
 757 Source types are always lifted.
 758
 759 The key function is predTypeRep which gives the representation of a source type:
 760
 761 \begin{code}
 762 mkPredTy :: PredType -> Type
 763 mkPredTy pred = PredTy pred
 764
 765 mkPredTys :: ThetaType -> [Type]
 766 mkPredTys preds = map PredTy preds
 767
 768 predTypeRep :: PredType -> Type
 769 -- ^ Convert a 'PredType' to its representation type. However, it unwraps
 770 -- only the outermost level; for example, the result might be a newtype application
 771 predTypeRep (IParam _ ty)     = ty
 772 predTypeRep (ClassP clas tys) = mkTyConApp (classTyCon clas) tys
 773         -- Result might be a newtype application, but the consumer will
 774         -- look through that too if necessary
 775 predTypeRep (EqPred ty1 ty2) = pprPanic "predTypeRep" (ppr (EqPred ty1 ty2))
 776
 777 mkFamilyTyConApp :: TyCon -> [Type] -> Type
 778 -- ^ Given a family instance TyCon and its arg types, return the
 779 -- corresponding family type.  E.g:
 780 --
 781 -- > data family T a
 782 -- > data instance T (Maybe b) = MkT b
 783 --
 784 -- Where the instance tycon is :RTL, so:
 785 --
 786 -- > mkFamilyTyConApp :RTL Int  =  T (Maybe Int)
 787 mkFamilyTyConApp tc tys
 788   | Just (fam_tc, fam_tys) <- tyConFamInst_maybe tc
 789   , let fam_subst = zipTopTvSubst (tyConTyVars tc) tys
 790   = mkTyConApp fam_tc (substTys fam_subst fam_tys)
 791   | otherwise
 792   = mkTyConApp tc tys
 793
 794 -- | Pretty prints a 'TyCon', using the family instance in case of a
 795 -- representation tycon.  For example:
 796 --
 797 -- > data T [a] = ...
 798 --
 799 -- In that case we want to print @T [a]@, where @T@ is the family 'TyCon'
 800 pprSourceTyCon :: TyCon -> SDoc
 801 pprSourceTyCon tycon
 802   | Just (fam_tc, tys) <- tyConFamInst_maybe tycon
 803   = ppr $ fam_tc `TyConApp` tys        -- can't be FunTyCon
 804   | otherwise
 805   = ppr tycon
 806 \end{code}
 807
 808
 809 %************************************************************************
 810 %*                                                                      *
 811 \subsection{Kinds and free variables}
 812 %*                                                                      *
 813 %************************************************************************
 814
 815 ---------------------------------------------------------------------
 816                 Finding the kind of a type
 817                 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 818 \begin{code}
 819 typeKind :: Type -> Kind
 820 typeKind (TyConApp tycon tys) = ASSERT( not (isCoercionTyCon tycon) )
 821                                    -- We should be looking for the coercion kind,
 822                                    -- not the type kind
 823                                 foldr (\_ k -> kindFunResult k) (tyConKind tycon) tys
 824 typeKind (PredTy pred)        = predKind pred
 825 typeKind (AppTy fun _)        = kindFunResult (typeKind fun)
 826 typeKind (ForAllTy _ ty)      = typeKind ty
 827 typeKind (TyVarTy tyvar)      = tyVarKind tyvar
 828 typeKind (FunTy _arg res)
 829     -- Hack alert.  The kind of (Int -> Int#) is liftedTypeKind (*),
 830     --              not unliftedTypKind (#)
 831     -- The only things that can be after a function arrow are
 832     --   (a) types (of kind openTypeKind or its sub-kinds)
 833     --   (b) kinds (of super-kind TY) (e.g. * -> (* -> *))
 834     | isTySuperKind k         = k
 835     | otherwise               = ASSERT( isSubOpenTypeKind k) liftedTypeKind
 836     where
 837       k = typeKind res
 838
 839 predKind :: PredType -> Kind
 840 predKind (EqPred {}) = coSuperKind      -- A coercion kind!
 841 predKind (ClassP {}) = liftedTypeKind   -- Class and implicitPredicates are
 842 predKind (IParam {}) = liftedTypeKind   -- always represented by lifted types
 843 \end{code}
 844
 845
 846 ---------------------------------------------------------------------
 847                 Free variables of a type
 848                 ~~~~~~~~~~~~~~~~~~~~~~~~
 849 \begin{code}
 850 tyVarsOfType :: Type -> TyVarSet
 851 -- ^ NB: for type synonyms tyVarsOfType does /not/ expand the synonym
 852 tyVarsOfType (TyVarTy tv)               = unitVarSet tv
 853 tyVarsOfType (TyConApp _ tys)           = tyVarsOfTypes tys
 854 tyVarsOfType (PredTy sty)               = tyVarsOfPred sty
 855 tyVarsOfType (FunTy arg res)            = tyVarsOfType arg `unionVarSet` tyVarsOfType res
 856 tyVarsOfType (AppTy fun arg)            = tyVarsOfType fun `unionVarSet` tyVarsOfType arg
 857 tyVarsOfType (ForAllTy tyvar ty)        = delVarSet (tyVarsOfType ty) tyvar
 858
 859 tyVarsOfTypes :: [Type] -> TyVarSet
 860 tyVarsOfTypes tys = foldr (unionVarSet.tyVarsOfType) emptyVarSet tys
 861
 862 tyVarsOfPred :: PredType -> TyVarSet
 863 tyVarsOfPred (IParam _ ty)    = tyVarsOfType ty
 864 tyVarsOfPred (ClassP _ tys)   = tyVarsOfTypes tys
 865 tyVarsOfPred (EqPred ty1 ty2) = tyVarsOfType ty1 `unionVarSet` tyVarsOfType ty2
 866
 867 tyVarsOfTheta :: ThetaType -> TyVarSet
 868 tyVarsOfTheta = foldr (unionVarSet . tyVarsOfPred) emptyVarSet
 869 \end{code}
 870
 871
 872 %************************************************************************
 873 %*                                                                      *
 874 \subsection{Type families}
 875 %*                                                                      *
 876 %************************************************************************
 877
 878 \begin{code}
 879 -- | Finds type family instances occuring in a type after expanding synonyms.
 880 tyFamInsts :: Type -> [(TyCon, [Type])]
 881 tyFamInsts ty
 882   | Just exp_ty <- tcView ty    = tyFamInsts exp_ty
 883 tyFamInsts (TyVarTy _)          = []
 884 tyFamInsts (TyConApp tc tys)
 885   | isOpenSynTyCon tc           = [(tc, tys)]
 886   | otherwise                   = concat (map tyFamInsts tys)
 887 tyFamInsts (FunTy ty1 ty2)      = tyFamInsts ty1 ++ tyFamInsts ty2
 888 tyFamInsts (AppTy ty1 ty2)      = tyFamInsts ty1 ++ tyFamInsts ty2
 889 tyFamInsts (ForAllTy _ ty)      = tyFamInsts ty
 890 tyFamInsts (PredTy pty)         = predFamInsts pty
 891
 892 -- | Finds type family instances occuring in a predicate type after expanding
 893 -- synonyms.
 894 predFamInsts :: PredType -> [(TyCon, [Type])]
 895 predFamInsts (ClassP _cla tys) = concat (map tyFamInsts tys)
 896 predFamInsts (IParam _ ty)     = tyFamInsts ty
 897 predFamInsts (EqPred ty1 ty2)  = tyFamInsts ty1 ++ tyFamInsts ty2
 898 \end{code}
 899
 900
 901 %************************************************************************
 902 %*                                                                      *
 903 \subsection{TidyType}
 904 %*                                                                      *
 905 %************************************************************************
 906
 907 \begin{code}
 908 -- | This tidies up a type for printing in an error message, or in
 909 -- an interface file.
 910 --
 911 -- It doesn't change the uniques at all, just the print names.
 912 tidyTyVarBndr :: TidyEnv -> TyVar -> (TidyEnv, TyVar)
 913 tidyTyVarBndr env@(tidy_env, subst) tyvar
 914   = case tidyOccName tidy_env (getOccName name) of
 915       (tidy', occ') -> ((tidy', subst'), tyvar'')
 916         where
 917           subst' = extendVarEnv subst tyvar tyvar''
 918           tyvar' = setTyVarName tyvar name'
 919           name'  = tidyNameOcc name occ'
 920                 -- Don't forget to tidy the kind for coercions!
 921           tyvar'' | isCoVar tyvar = setTyVarKind tyvar' kind'
 922                   | otherwise     = tyvar'
 923           kind'  = tidyType env (tyVarKind tyvar)
 924   where
 925     name = tyVarName tyvar
 926
 927 tidyFreeTyVars :: TidyEnv -> TyVarSet -> TidyEnv
 928 -- ^ Add the free 'TyVar's to the env in tidy form,
 929 -- so that we can tidy the type they are free in
 930 tidyFreeTyVars env tyvars = fst (tidyOpenTyVars env (varSetElems tyvars))
 931
 932 tidyOpenTyVars :: TidyEnv -> [TyVar] -> (TidyEnv, [TyVar])
 933 tidyOpenTyVars env tyvars = mapAccumL tidyOpenTyVar env tyvars
 934
 935 tidyOpenTyVar :: TidyEnv -> TyVar -> (TidyEnv, TyVar)
 936 -- ^ Treat a new 'TyVar' as a binder, and give it a fresh tidy name
 937 -- using the environment if one has not already been allocated. See
 938 -- also 'tidyTyVarBndr'
 939 tidyOpenTyVar env@(_, subst) tyvar
 940   = case lookupVarEnv subst tyvar of
 941         Just tyvar' -> (env, tyvar')            -- Already substituted
 942         Nothing     -> tidyTyVarBndr env tyvar  -- Treat it as a binder
 943
 944 tidyType :: TidyEnv -> Type -> Type
 945 tidyType env@(_, subst) ty
 946   = go ty
 947   where
 948     go (TyVarTy tv)         = case lookupVarEnv subst tv of
 949                                 Nothing  -> TyVarTy tv
 950                                 Just tv' -> TyVarTy tv'
 951     go (TyConApp tycon tys) = let args = map go tys
 952                               in args `seqList` TyConApp tycon args
 953     go (PredTy sty)         = PredTy (tidyPred env sty)
 954     go (AppTy fun arg)      = (AppTy $! (go fun)) $! (go arg)
 955     go (FunTy fun arg)      = (FunTy $! (go fun)) $! (go arg)
 956     go (ForAllTy tv ty)     = ForAllTy tvp $! (tidyType envp ty)
 957                               where
 958                                 (envp, tvp) = tidyTyVarBndr env tv
 959
 960 tidyTypes :: TidyEnv -> [Type] -> [Type]
 961 tidyTypes env tys = map (tidyType env) tys
 962
 963 tidyPred :: TidyEnv -> PredType -> PredType
 964 tidyPred env (IParam n ty)     = IParam n (tidyType env ty)
 965 tidyPred env (ClassP clas tys) = ClassP clas (tidyTypes env tys)
 966 tidyPred env (EqPred ty1 ty2)  = EqPred (tidyType env ty1) (tidyType env ty2)
 967 \end{code}
 968
 969
 970 \begin{code}
 971 -- | Grabs the free type variables, tidies them
 972 -- and then uses 'tidyType' to work over the type itself
 973 tidyOpenType :: TidyEnv -> Type -> (TidyEnv, Type)
 974 tidyOpenType env ty
 975   = (env', tidyType env' ty)
 976   where
 977     env' = tidyFreeTyVars env (tyVarsOfType ty)
 978
 979 tidyOpenTypes :: TidyEnv -> [Type] -> (TidyEnv, [Type])
 980 tidyOpenTypes env tys = mapAccumL tidyOpenType env tys
 981
 982 -- | Calls 'tidyType' on a top-level type (i.e. with an empty tidying environment)
 983 tidyTopType :: Type -> Type
 984 tidyTopType ty = tidyType emptyTidyEnv ty
 985 \end{code}
 986
 987 \begin{code}
 988
 989 tidyKind :: TidyEnv -> Kind -> (TidyEnv, Kind)
 990 tidyKind env k = tidyOpenType env k
 991
 992 \end{code}
 993
 994
 995 %************************************************************************
 996 %*                                                                      *
 997 \subsection{Liftedness}
 998 %*                                                                      *
 999 %************************************************************************
1000
1001 \begin{code}
1002 -- | See "Type#type_classification" for what an unlifted type is
1003 isUnLiftedType :: Type -> Bool
1004         -- isUnLiftedType returns True for forall'd unlifted types:
1005         --      x :: forall a. Int#
1006         -- I found bindings like these were getting floated to the top level.
1007         -- They are pretty bogus types, mind you.  It would be better never to
1008         -- construct them
1009
1010 isUnLiftedType ty | Just ty' <- coreView ty = isUnLiftedType ty'
1011 isUnLiftedType (ForAllTy _ ty)   = isUnLiftedType ty
1012 isUnLiftedType (TyConApp tc _)   = isUnLiftedTyCon tc
1013 isUnLiftedType _                 = False
1014
1015 isUnboxedTupleType :: Type -> Bool
1016 isUnboxedTupleType ty = case splitTyConApp_maybe ty of
1017                            Just (tc, _ty_args) -> isUnboxedTupleTyCon tc
1018                            _                   -> False
1019
1020 -- | See "Type#type_classification" for what an algebraic type is.
1021 -- Should only be applied to /types/, as opposed to e.g. partially
1022 -- saturated type constructors
1023 isAlgType :: Type -> Bool
1024 isAlgType ty
1025   = case splitTyConApp_maybe ty of
1026       Just (tc, ty_args) -> ASSERT( ty_args `lengthIs` tyConArity tc )
1027                             isAlgTyCon tc
1028       _other             -> False
1029
1030 -- | See "Type#type_classification" for what an algebraic type is.
1031 -- Should only be applied to /types/, as opposed to e.g. partially
1032 -- saturated type constructors. Closed type constructors are those
1033 -- with a fixed right hand side, as opposed to e.g. associated types
1034 isClosedAlgType :: Type -> Bool
1035 isClosedAlgType ty
1036   = case splitTyConApp_maybe ty of
1037       Just (tc, ty_args) -> ASSERT( ty_args `lengthIs` tyConArity tc )
1038                             isAlgTyCon tc && not (isOpenTyCon tc)
1039       _other             -> False
1040 \end{code}
1041
1042 \begin{code}
1043 -- | Computes whether an argument (or let right hand side) should
1044 -- be computed strictly or lazily, based only on its type.
1045 -- Works just like 'isUnLiftedType', except that it has a special case
1046 -- for dictionaries (i.e. does not work purely on representation types)
1047
1048 -- Since it takes account of class 'PredType's, you might think
1049 -- this function should be in 'TcType', but 'isStrictType' is used by 'DataCon',
1050 -- which is below 'TcType' in the hierarchy, so it's convenient to put it here.
1051 isStrictType :: Type -> Bool
1052 isStrictType (PredTy pred)     = isStrictPred pred
1053 isStrictType ty | Just ty' <- coreView ty = isStrictType ty'
1054 isStrictType (ForAllTy _ ty)   = isStrictType ty
1055 isStrictType (TyConApp tc _)   = isUnLiftedTyCon tc
1056 isStrictType _                 = False
1057
1058 -- | We may be strict in dictionary types, but only if it
1059 -- has more than one component.
1060 --
1061 -- (Being strict in a single-component dictionary risks
1062 --  poking the dictionary component, which is wrong.)
1063 isStrictPred :: PredType -> Bool
1064 isStrictPred (ClassP clas _) = opt_DictsStrict && not (isNewTyCon (classTyCon clas))
1065 isStrictPred _               = False
1066 \end{code}
1067
1068 \begin{code}
1069 isPrimitiveType :: Type -> Bool
1070 -- ^ Returns true of types that are opaque to Haskell.
1071 -- Most of these are unlifted, but now that we interact with .NET, we
1072 -- may have primtive (foreign-imported) types that are lifted
1073 isPrimitiveType ty = case splitTyConApp_maybe ty of
1074                         Just (tc, ty_args) -> ASSERT( ty_args `lengthIs` tyConArity tc )
1075                                               isPrimTyCon tc
1076                         _                  -> False
1077 \end{code}
1078
1079
1080 %************************************************************************
1081 %*                                                                      *
1082 \subsection{Sequencing on types}
1083 %*                                                                      *
1084 %************************************************************************
1085
1086 \begin{code}
1087 seqType :: Type -> ()
1088 seqType (TyVarTy tv)      = tv `seq` ()
1089 seqType (AppTy t1 t2)     = seqType t1 `seq` seqType t2
1090 seqType (FunTy t1 t2)     = seqType t1 `seq` seqType t2
1091 seqType (PredTy p)        = seqPred p
1092 seqType (TyConApp tc tys) = tc `seq` seqTypes tys
1093 seqType (ForAllTy tv ty)  = tv `seq` seqType ty
1094
1095 seqTypes :: [Type] -> ()
1096 seqTypes []       = ()
1097 seqTypes (ty:tys) = seqType ty `seq` seqTypes tys
1098
1099 seqPred :: PredType -> ()
1100 seqPred (ClassP c tys)   = c `seq` seqTypes tys
1101 seqPred (IParam n ty)    = n `seq` seqType ty
1102 seqPred (EqPred ty1 ty2) = seqType ty1 `seq` seqType ty2
1103 \end{code}
1104
1105
1106 %************************************************************************
1107 %*                                                                      *
1108                 Equality for Core types
1109         (We don't use instances so that we know where it happens)
1110 %*                                                                      *
1111 %************************************************************************
1112
1113 Note that eqType works right even for partial applications of newtypes.
1114 See Note [Newtype eta] in TyCon.lhs
1115
1116 \begin{code}
1117 -- | Type equality test for Core types (i.e. ignores predicate-types, synonyms etc.)
1118 coreEqType :: Type -> Type -> Bool
1119 coreEqType t1 t2
1120   = eq rn_env t1 t2
1121   where
1122     rn_env = mkRnEnv2 (mkInScopeSet (tyVarsOfType t1 `unionVarSet` tyVarsOfType t2))
1123
1124     eq env (TyVarTy tv1)       (TyVarTy tv2)     = rnOccL env tv1 == rnOccR env tv2
1125     eq env (ForAllTy tv1 t1)   (ForAllTy tv2 t2) = eq (rnBndr2 env tv1 tv2) t1 t2
1126     eq env (AppTy s1 t1)       (AppTy s2 t2)     = eq env s1 s2 && eq env t1 t2
1127     eq env (FunTy s1 t1)       (FunTy s2 t2)     = eq env s1 s2 && eq env t1 t2
1128     eq env (TyConApp tc1 tys1) (TyConApp tc2 tys2)
1129         | tc1 == tc2, all2 (eq env) tys1 tys2 = True
1130                         -- The lengths should be equal because
1131                         -- the two types have the same kind
1132         -- NB: if the type constructors differ that does not
1133         --     necessarily mean that the types aren't equal
1134         --     (synonyms, newtypes)
1135         -- Even if the type constructors are the same, but the arguments
1136         -- differ, the two types could be the same (e.g. if the arg is just
1137         -- ignored in the RHS).  In both these cases we fall through to an
1138         -- attempt to expand one side or the other.
1139
1140         -- Now deal with newtypes, synonyms, pred-tys
1141     eq env t1 t2 | Just t1' <- coreView t1 = eq env t1' t2
1142                  | Just t2' <- coreView t2 = eq env t1 t2'
1143
1144         -- Fall through case; not equal!
1145     eq _ _ _ = False
1146 \end{code}
1147
1148
1149 %************************************************************************
1150 %*                                                                      *
1151                 Comparision for source types
1152         (We don't use instances so that we know where it happens)
1153 %*                                                                      *
1154 %************************************************************************
1155
1156 \begin{code}
1157 tcEqType :: Type -> Type -> Bool
1158 -- ^ Type equality on source types. Does not look through @newtypes@ or
1159 -- 'PredType's, but it does look through type synonyms.
1160 tcEqType t1 t2 = isEqual $ cmpType t1 t2
1161
1162 tcEqTypes :: [Type] -> [Type] -> Bool
1163 tcEqTypes tys1 tys2 = isEqual $ cmpTypes tys1 tys2
1164
1165 tcCmpType :: Type -> Type -> Ordering
1166 -- ^ Type ordering on source types. Does not look through @newtypes@ or
1167 -- 'PredType's, but it does look through type synonyms.
1168 tcCmpType t1 t2 = cmpType t1 t2
1169
1170 tcCmpTypes :: [Type] -> [Type] -> Ordering
1171 tcCmpTypes tys1 tys2 = cmpTypes tys1 tys2
1172
1173 tcEqPred :: PredType -> PredType -> Bool
1174 tcEqPred p1 p2 = isEqual $ cmpPred p1 p2
1175
1176 tcEqPredX :: RnEnv2 -> PredType -> PredType -> Bool
1177 tcEqPredX env p1 p2 = isEqual $ cmpPredX env p1 p2
1178
1179 tcCmpPred :: PredType -> PredType -> Ordering
1180 tcCmpPred p1 p2 = cmpPred p1 p2
1181
1182 tcEqTypeX :: RnEnv2 -> Type -> Type -> Bool
1183 tcEqTypeX env t1 t2 = isEqual $ cmpTypeX env t1 t2
1184 \end{code}
1185
1186 \begin{code}
1187 -- | Checks whether the second argument is a subterm of the first.  (We don't care
1188 -- about binders, as we are only interested in syntactic subterms.)
1189 tcPartOfType :: Type -> Type -> Bool
1190 tcPartOfType t1              t2
1191   | tcEqType t1 t2              = True
1192 tcPartOfType t1              t2
1193   | Just t2' <- tcView t2       = tcPartOfType t1 t2'
1194 tcPartOfType _  (TyVarTy _)     = False
1195 tcPartOfType t1 (ForAllTy _ t2) = tcPartOfType t1 t2
1196 tcPartOfType t1 (AppTy s2 t2)   = tcPartOfType t1 s2 || tcPartOfType t1 t2
1197 tcPartOfType t1 (FunTy s2 t2)   = tcPartOfType t1 s2 || tcPartOfType t1 t2
1198 tcPartOfType t1 (PredTy p2)     = tcPartOfPred t1 p2
1199 tcPartOfType t1 (TyConApp _ ts) = any (tcPartOfType t1) ts
1200
1201 tcPartOfPred :: Type -> PredType -> Bool
1202 tcPartOfPred t1 (IParam _ t2)  = tcPartOfType t1 t2
1203 tcPartOfPred t1 (ClassP _ ts)  = any (tcPartOfType t1) ts
1204 tcPartOfPred t1 (EqPred s2 t2) = tcPartOfType t1 s2 || tcPartOfType t1 t2
1205 \end{code}
1206
1207 Now here comes the real worker
1208
1209 \begin{code}
1210 cmpType :: Type -> Type -> Ordering
1211 cmpType t1 t2 = cmpTypeX rn_env t1 t2
1212   where
1213     rn_env = mkRnEnv2 (mkInScopeSet (tyVarsOfType t1 `unionVarSet` tyVarsOfType t2))
1214
1215 cmpTypes :: [Type] -> [Type] -> Ordering
1216 cmpTypes ts1 ts2 = cmpTypesX rn_env ts1 ts2
1217   where
1218     rn_env = mkRnEnv2 (mkInScopeSet (tyVarsOfTypes ts1 `unionVarSet` tyVarsOfTypes ts2))
1219
1220 cmpPred :: PredType -> PredType -> Ordering
1221 cmpPred p1 p2 = cmpPredX rn_env p1 p2
1222   where
1223     rn_env = mkRnEnv2 (mkInScopeSet (tyVarsOfPred p1 `unionVarSet` tyVarsOfPred p2))
1224
1225 cmpTypeX :: RnEnv2 -> Type -> Type -> Ordering  -- Main workhorse
1226 cmpTypeX env t1 t2 | Just t1' <- tcView t1 = cmpTypeX env t1' t2
1227                    | Just t2' <- tcView t2 = cmpTypeX env t1 t2'
1228
1229 cmpTypeX env (TyVarTy tv1)       (TyVarTy tv2)       = rnOccL env tv1 `compare` rnOccR env tv2
1230 cmpTypeX env (ForAllTy tv1 t1)   (ForAllTy tv2 t2)   = cmpTypeX (rnBndr2 env tv1 tv2) t1 t2
1231 cmpTypeX env (AppTy s1 t1)       (AppTy s2 t2)       = cmpTypeX env s1 s2 `thenCmp` cmpTypeX env t1 t2
1232 cmpTypeX env (FunTy s1 t1)       (FunTy s2 t2)       = cmpTypeX env s1 s2 `thenCmp` cmpTypeX env t1 t2
1233 cmpTypeX env (PredTy p1)         (PredTy p2)         = cmpPredX env p1 p2
1234 cmpTypeX env (TyConApp tc1 tys1) (TyConApp tc2 tys2) = (tc1 `compare` tc2) `thenCmp` cmpTypesX env tys1 tys2
1235
1236     -- Deal with the rest: TyVarTy < AppTy < FunTy < TyConApp < ForAllTy < PredTy
1237 cmpTypeX _ (AppTy _ _)    (TyVarTy _)    = GT
1238
1239 cmpTypeX _ (FunTy _ _)    (TyVarTy _)    = GT
1240 cmpTypeX _ (FunTy _ _)    (AppTy _ _)    = GT
1241
1242 cmpTypeX _ (TyConApp _ _) (TyVarTy _)    = GT
1243 cmpTypeX _ (TyConApp _ _) (AppTy _ _)    = GT
1244 cmpTypeX _ (TyConApp _ _) (FunTy _ _)    = GT
1245
1246 cmpTypeX _ (ForAllTy _ _) (TyVarTy _)    = GT
1247 cmpTypeX _ (ForAllTy _ _) (AppTy _ _)    = GT
1248 cmpTypeX _ (ForAllTy _ _) (FunTy _ _)    = GT
1249 cmpTypeX _ (ForAllTy _ _) (TyConApp _ _) = GT
1250
1251 cmpTypeX _ (PredTy _)     _              = GT
1252
1253 cmpTypeX _ _              _              = LT
1254
1255 -------------
1256 cmpTypesX :: RnEnv2 -> [Type] -> [Type] -> Ordering
1257 cmpTypesX _   []        []        = EQ
1258 cmpTypesX env (t1:tys1) (t2:tys2) = cmpTypeX env t1 t2 `thenCmp` cmpTypesX env tys1 tys2
1259 cmpTypesX _   []        _         = LT
1260 cmpTypesX _   _         []        = GT
1261
1262 -------------
1263 cmpPredX :: RnEnv2 -> PredType -> PredType -> Ordering
1264 cmpPredX env (IParam n1 ty1) (IParam n2 ty2) = (n1 `compare` n2) `thenCmp` cmpTypeX env ty1 ty2
1265         -- Compare names only for implicit parameters
1266         -- This comparison is used exclusively (I believe)
1267         -- for the Avails finite map built in TcSimplify
1268         -- If the types differ we keep them distinct so that we see
1269         -- a distinct pair to run improvement on
1270 cmpPredX env (ClassP c1 tys1) (ClassP c2 tys2) = (c1 `compare` c2) `thenCmp` (cmpTypesX env tys1 tys2)
1271 cmpPredX env (EqPred ty1 ty2) (EqPred ty1' ty2') = (cmpTypeX env ty1 ty1') `thenCmp` (cmpTypeX env ty2 ty2')
1272
1273 -- Constructor order: IParam < ClassP < EqPred
1274 cmpPredX _   (IParam {})     _              = LT
1275 cmpPredX _   (ClassP {})    (IParam {})     = GT
1276 cmpPredX _   (ClassP {})    (EqPred {})     = LT
1277 cmpPredX _   (EqPred {})    _               = GT
1278 \end{code}
1279
1280 PredTypes are used as a FM key in TcSimplify,
1281 so we take the easy path and make them an instance of Ord
1282
1283 \begin{code}
1284 instance Eq  PredType where { (==)    = tcEqPred }
1285 instance Ord PredType where { compare = tcCmpPred }
1286 \end{code}
1287
1288
1289 %************************************************************************
1290 %*                                                                      *
1291                 Type substitutions
1292 %*                                                                      *
1293 %************************************************************************
1294
1295 \begin{code}
1296 -- | Type substitution
1297 --
1298 -- #tvsubst_invariant#
1299 -- The following invariants must hold of a 'TvSubst':
1300 --
1301 -- 1. The in-scope set is needed /only/ to
1302 -- guide the generation of fresh uniques
1303 --
1304 -- 2. In particular, the /kind/ of the type variables in
1305 -- the in-scope set is not relevant
1306 --
1307 -- 3. The substition is only applied ONCE! This is because
1308 -- in general such application will not reached a fixed point.
1309 data TvSubst
1310   = TvSubst InScopeSet  -- The in-scope type variables
1311             TvSubstEnv  -- The substitution itself
1312         -- See Note [Apply Once]
1313         -- and Note [Extending the TvSubstEnv]
1314
1315 {- ----------------------------------------------------------
1316
1317 Note [Apply Once]
1318 ~~~~~~~~~~~~~~~~~
1319 We use TvSubsts to instantiate things, and we might instantiate
1320         forall a b. ty
1321 \with the types
1322         [a, b], or [b, a].
1323 So the substition might go [a->b, b->a].  A similar situation arises in Core
1324 when we find a beta redex like
1325         (/\ a /\ b -> e) b a
1326 Then we also end up with a substition that permutes type variables. Other
1327 variations happen to; for example [a -> (a, b)].
1328
1329         ***************************************************
1330         *** So a TvSubst must be applied precisely once ***
1331         ***************************************************
1332
1333 A TvSubst is not idempotent, but, unlike the non-idempotent substitution
1334 we use during unifications, it must not be repeatedly applied.
1335
1336 Note [Extending the TvSubst]
1337 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1338 See #tvsubst_invariant# for the invariants that must hold.
1339
1340 This invariant allows a short-cut when the TvSubstEnv is empty:
1341 if the TvSubstEnv is empty --- i.e. (isEmptyTvSubt subst) holds ---
1342 then (substTy subst ty) does nothing.
1343
1344 For example, consider:
1345         (/\a. /\b:(a~Int). ...b..) Int
1346 We substitute Int for 'a'.  The Unique of 'b' does not change, but
1347 nevertheless we add 'b' to the TvSubstEnv, because b's type does change
1348
1349 This invariant has several crucial consequences:
1350
1351 * In substTyVarBndr, we need extend the TvSubstEnv
1352         - if the unique has changed
1353         - or if the kind has changed
1354
1355 * In substTyVar, we do not need to consult the in-scope set;
1356   the TvSubstEnv is enough
1357
1358 * In substTy, substTheta, we can short-circuit when the TvSubstEnv is empty
1359
1360
1361 -------------------------------------------------------------- -}
1362
1363 -- | A substitition of 'Type's for 'TyVar's
1364 type TvSubstEnv = TyVarEnv Type
1365         -- A TvSubstEnv is used both inside a TvSubst (with the apply-once
1366         -- invariant discussed in Note [Apply Once]), and also independently
1367         -- in the middle of matching, and unification (see Types.Unify)
1368         -- So you have to look at the context to know if it's idempotent or
1369         -- apply-once or whatever
1370
1371 emptyTvSubstEnv :: TvSubstEnv
1372 emptyTvSubstEnv = emptyVarEnv
1373
1374 composeTvSubst :: InScopeSet -> TvSubstEnv -> TvSubstEnv -> TvSubstEnv
1375 -- ^ @(compose env1 env2)(x)@ is @env1(env2(x))@; i.e. apply @env2@ then @env1@.
1376 -- It assumes that both are idempotent.
1377 -- Typically, @env1@ is the refinement to a base substitution @env2@
1378 composeTvSubst in_scope env1 env2
1379   = env1 `plusVarEnv` mapVarEnv (substTy subst1) env2
1380         -- First apply env1 to the range of env2
1381         -- Then combine the two, making sure that env1 loses if
1382         -- both bind the same variable; that's why env1 is the
1383         --  *left* argument to plusVarEnv, because the right arg wins
1384   where
1385     subst1 = TvSubst in_scope env1
1386
1387 emptyTvSubst :: TvSubst
1388 emptyTvSubst = TvSubst emptyInScopeSet emptyVarEnv
1389
1390 isEmptyTvSubst :: TvSubst -> Bool
1391          -- See Note [Extending the TvSubstEnv]
1392 isEmptyTvSubst (TvSubst _ env) = isEmptyVarEnv env
1393
1394 mkTvSubst :: InScopeSet -> TvSubstEnv -> TvSubst
1395 mkTvSubst = TvSubst
1396
1397 getTvSubstEnv :: TvSubst -> TvSubstEnv
1398 getTvSubstEnv (TvSubst _ env) = env
1399
1400 getTvInScope :: TvSubst -> InScopeSet
1401 getTvInScope (TvSubst in_scope _) = in_scope
1402
1403 isInScope :: Var -> TvSubst -> Bool
1404 isInScope v (TvSubst in_scope _) = v `elemInScopeSet` in_scope
1405
1406 notElemTvSubst :: TyVar -> TvSubst -> Bool
1407 notElemTvSubst tv (TvSubst _ env) = not (tv `elemVarEnv` env)
1408
1409 setTvSubstEnv :: TvSubst -> TvSubstEnv -> TvSubst
1410 setTvSubstEnv (TvSubst in_scope _) env = TvSubst in_scope env
1411
1412 extendTvInScope :: TvSubst -> [Var] -> TvSubst
1413 extendTvInScope (TvSubst in_scope env) vars = TvSubst (extendInScopeSetList in_scope vars) env
1414
1415 extendTvSubst :: TvSubst -> TyVar -> Type -> TvSubst
1416 extendTvSubst (TvSubst in_scope env) tv ty = TvSubst in_scope (extendVarEnv env tv ty)
1417
1418 extendTvSubstList :: TvSubst -> [TyVar] -> [Type] -> TvSubst
1419 extendTvSubstList (TvSubst in_scope env) tvs tys
1420   = TvSubst in_scope (extendVarEnvList env (tvs `zip` tys))
1421
1422 -- mkOpenTvSubst and zipOpenTvSubst generate the in-scope set from
1423 -- the types given; but it's just a thunk so with a bit of luck
1424 -- it'll never be evaluated
1425
1426 -- Note [Generating the in-scope set for a substitution]
1427 -- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1428 -- If we want to substitute [a -> ty1, b -> ty2] I used to
1429 -- think it was enough to generate an in-scope set that includes
1430 -- fv(ty1,ty2).  But that's not enough; we really should also take the
1431 -- free vars of the type we are substituting into!  Example:
1432 --      (forall b. (a,b,x)) [a -> List b]
1433 -- Then if we use the in-scope set {b}, there is a danger we will rename
1434 -- the forall'd variable to 'x' by mistake, getting this:
1435 --      (forall x. (List b, x, x)
1436 -- Urk!  This means looking at all the calls to mkOpenTvSubst....
1437
1438
1439 -- | Generates the in-scope set for the 'TvSubst' from the types in the incoming
1440 -- environment, hence "open"
1441 mkOpenTvSubst :: TvSubstEnv -> TvSubst
1442 mkOpenTvSubst env = TvSubst (mkInScopeSet (tyVarsOfTypes (varEnvElts env))) env
1443
1444 -- | Generates the in-scope set for the 'TvSubst' from the types in the incoming
1445 -- environment, hence "open"
1446 zipOpenTvSubst :: [TyVar] -> [Type] -> TvSubst
1447 zipOpenTvSubst tyvars tys
1448   | debugIsOn && (length tyvars /= length tys)
1449   = pprTrace "zipOpenTvSubst" (ppr tyvars $$ ppr tys) emptyTvSubst
1450   | otherwise
1451   = TvSubst (mkInScopeSet (tyVarsOfTypes tys)) (zipTyEnv tyvars tys)
1452
1453 -- | Called when doing top-level substitutions. Here we expect that the
1454 -- free vars of the range of the substitution will be empty.
1455 mkTopTvSubst :: [(TyVar, Type)] -> TvSubst
1456 mkTopTvSubst prs = TvSubst emptyInScopeSet (mkVarEnv prs)
1457
1458 zipTopTvSubst :: [TyVar] -> [Type] -> TvSubst
1459 zipTopTvSubst tyvars tys
1460   | debugIsOn && (length tyvars /= length tys)
1461   = pprTrace "zipTopTvSubst" (ppr tyvars $$ ppr tys) emptyTvSubst
1462   | otherwise
1463   = TvSubst emptyInScopeSet (zipTyEnv tyvars tys)
1464
1465 zipTyEnv :: [TyVar] -> [Type] -> TvSubstEnv
1466 zipTyEnv tyvars tys
1467   | debugIsOn && (length tyvars /= length tys)
1468   = pprTrace "mkTopTvSubst" (ppr tyvars $$ ppr tys) emptyVarEnv
1469   | otherwise
1470   = zip_ty_env tyvars tys emptyVarEnv
1471
1472 -- Later substitutions in the list over-ride earlier ones,
1473 -- but there should be no loops
1474 zip_ty_env :: [TyVar] -> [Type] -> TvSubstEnv -> TvSubstEnv
1475 zip_ty_env []       []       env = env
1476 zip_ty_env (tv:tvs) (ty:tys) env = zip_ty_env tvs tys (extendVarEnv env tv ty)
1477         -- There used to be a special case for when
1478         --      ty == TyVarTy tv
1479         -- (a not-uncommon case) in which case the substitution was dropped.
1480         -- But the type-tidier changes the print-name of a type variable without
1481         -- changing the unique, and that led to a bug.   Why?  Pre-tidying, we had
1482         -- a type {Foo t}, where Foo is a one-method class.  So Foo is really a newtype.
1483         -- And it happened that t was the type variable of the class.  Post-tiding,
1484         -- it got turned into {Foo t2}.  The ext-core printer expanded this using
1485         -- sourceTypeRep, but that said "Oh, t == t2" because they have the same unique,
1486         -- and so generated a rep type mentioning t not t2.
1487         --
1488         -- Simplest fix is to nuke the "optimisation"
1489 zip_ty_env tvs      tys      env   = pprTrace "Var/Type length mismatch: " (ppr tvs $$ ppr tys) env
1490 -- zip_ty_env _ _ env = env
1491
1492 instance Outputable TvSubst where
1493   ppr (TvSubst ins env)
1494     = brackets $ sep[ ptext (sLit "TvSubst"),
1495                       nest 2 (ptext (sLit "In scope:") <+> ppr ins),
1496                       nest 2 (ptext (sLit "Env:") <+> ppr env) ]
1497 \end{code}
1498
1499 %************************************************************************
1500 %*                                                                      *
1501                 Performing type substitutions
1502 %*                                                                      *
1503 %************************************************************************
1504
1505 \begin{code}
1506 -- | Type substitution making use of an 'TvSubst' that
1507 -- is assumed to be open, see 'zipOpenTvSubst'
1508 substTyWith :: [TyVar] -> [Type] -> Type -> Type
1509 substTyWith tvs tys = ASSERT( length tvs == length tys )
1510                       substTy (zipOpenTvSubst tvs tys)
1511
1512 -- | Type substitution making use of an 'TvSubst' that
1513 -- is assumed to be open, see 'zipOpenTvSubst'
1514 substTysWith :: [TyVar] -> [Type] -> [Type] -> [Type]
1515 substTysWith tvs tys = ASSERT( length tvs == length tys )
1516                        substTys (zipOpenTvSubst tvs tys)
1517
1518 -- | Substitute within a 'Type'
1519 substTy :: TvSubst -> Type  -> Type
1520 substTy subst ty | isEmptyTvSubst subst = ty
1521                  | otherwise            = subst_ty subst ty
1522
1523 -- | Substitute within several 'Type's
1524 substTys :: TvSubst -> [Type] -> [Type]
1525 substTys subst tys | isEmptyTvSubst subst = tys
1526                    | otherwise            = map (subst_ty subst) tys
1527
1528 -- | Substitute within a 'ThetaType'
1529 substTheta :: TvSubst -> ThetaType -> ThetaType
1530 substTheta subst theta
1531   | isEmptyTvSubst subst = theta
1532   | otherwise            = map (substPred subst) theta
1533
1534 -- | Substitute within a 'PredType'
1535 substPred :: TvSubst -> PredType -> PredType
1536 substPred subst (IParam n ty)     = IParam n (subst_ty subst ty)
1537 substPred subst (ClassP clas tys) = ClassP clas (map (subst_ty subst) tys)
1538 substPred subst (EqPred ty1 ty2)  = EqPred (subst_ty subst ty1) (subst_ty subst ty2)
1539
1540 -- | Remove any nested binders mentioning the 'TyVar's in the 'TyVarSet'
1541 deShadowTy :: TyVarSet -> Type -> Type
1542 deShadowTy tvs ty
1543   = subst_ty (mkTvSubst in_scope emptyTvSubstEnv) ty
1544   where
1545     in_scope = mkInScopeSet tvs
1546
1547 subst_ty :: TvSubst -> Type -> Type
1548 -- subst_ty is the main workhorse for type substitution
1549 --
1550 -- Note that the in_scope set is poked only if we hit a forall
1551 -- so it may often never be fully computed
1552 subst_ty subst ty
1553    = go ty
1554   where
1555     go (TyVarTy tv)                = substTyVar subst tv
1556     go (TyConApp tc tys)           = let args = map go tys
1557                                      in  args `seqList` TyConApp tc args
1558
1559     go (PredTy p)                  = PredTy $! (substPred subst p)
1560
1561     go (FunTy arg res)             = (FunTy $! (go arg)) $! (go res)
1562     go (AppTy fun arg)             = mkAppTy (go fun) $! (go arg)
1563                 -- The mkAppTy smart constructor is important
1564                 -- we might be replacing (a Int), represented with App
1565                 -- by [Int], represented with TyConApp
1566     go (ForAllTy tv ty)            = case substTyVarBndr subst tv of
1567                                      (subst', tv') ->
1568                                          ForAllTy tv' $! (subst_ty subst' ty)
1569
1570 substTyVar :: TvSubst -> TyVar  -> Type
1571 substTyVar subst@(TvSubst _ _) tv
1572   = case lookupTyVar subst tv of {
1573         Nothing -> TyVarTy tv;
1574         Just ty -> ty   -- See Note [Apply Once]
1575     }
1576
1577 substTyVars :: TvSubst -> [TyVar] -> [Type]
1578 substTyVars subst tvs = map (substTyVar subst) tvs
1579
1580 lookupTyVar :: TvSubst -> TyVar  -> Maybe Type
1581         -- See Note [Extending the TvSubst]
1582 lookupTyVar (TvSubst _ env) tv = lookupVarEnv env tv
1583
1584 substTyVarBndr :: TvSubst -> TyVar -> (TvSubst, TyVar)
1585 substTyVarBndr subst@(TvSubst in_scope env) old_var
1586   = (TvSubst (in_scope `extendInScopeSet` new_var) new_env, new_var)
1587   where
1588     is_co_var = isCoVar old_var
1589
1590     new_env | no_change = delVarEnv env old_var
1591             | otherwise = extendVarEnv env old_var (TyVarTy new_var)
1592
1593     no_change = new_var == old_var && not is_co_var
1594         -- no_change means that the new_var is identical in
1595         -- all respects to the old_var (same unique, same kind)
1596         -- See Note [Extending the TvSubst]
1597         --
1598         -- In that case we don't need to extend the substitution
1599         -- to map old to new.  But instead we must zap any
1600         -- current substitution for the variable. For example:
1601         --      (\x.e) with id_subst = [x |-> e']
1602         -- Here we must simply zap the substitution for x
1603
1604     new_var = uniqAway in_scope subst_old_var
1605         -- The uniqAway part makes sure the new variable is not already in scope
1606
1607     subst_old_var -- subst_old_var is old_var with the substitution applied to its kind
1608                   -- It's only worth doing the substitution for coercions,
1609                   -- becuase only they can have free type variables
1610         | is_co_var = setTyVarKind old_var (substTy subst (tyVarKind old_var))
1611         | otherwise = old_var
1612 \end{code}
1613
1614 ----------------------------------------------------
1615 -- Kind Stuff
1616
1617 Kinds
1618 ~~~~~
1619
1620 \begin{code}
1621 -- $kind_subtyping
1622 -- #kind_subtyping#
1623 -- There's a little subtyping at the kind level:
1624 --
1625 -- @
1626 --               ?
1627 --              \/ &#92;
1628 --             \/   &#92;
1629 --            ??   (\#)
1630 --           \/  &#92;
1631 --          \*    \#
1632 -- .
1633 -- Where:        \*    [LiftedTypeKind]   means boxed type
1634 --              \#    [UnliftedTypeKind] means unboxed type
1635 --              (\#)  [UbxTupleKind]     means unboxed tuple
1636 --              ??   [ArgTypeKind]      is the lub of {\*, \#}
1637 --              ?    [OpenTypeKind]     means any type at all
1638 -- @
1639 --
1640 -- In particular:
1641 --
1642 -- > error :: forall a:?. String -> a
1643 -- > (->)  :: ?? -> ? -> \*
1644 -- > (\\(x::t) -> ...)
1645 --
1646 -- Where in the last example @t :: ??@ (i.e. is not an unboxed tuple)
1647
1648 type KindVar = TyVar  -- invariant: KindVar will always be a
1649                       -- TcTyVar with details MetaTv TauTv ...
1650 -- kind var constructors and functions are in TcType
1651
1652 type SimpleKind = Kind
1653 \end{code}
1654
1655 Kind inference
1656 ~~~~~~~~~~~~~~
1657 During kind inference, a kind variable unifies only with
1658 a "simple kind", sk
1659         sk ::= * | sk1 -> sk2
1660 For example
1661         data T a = MkT a (T Int#)
1662 fails.  We give T the kind (k -> *), and the kind variable k won't unify
1663 with # (the kind of Int#).
1664
1665 Type inference
1666 ~~~~~~~~~~~~~~
1667 When creating a fresh internal type variable, we give it a kind to express
1668 constraints on it.  E.g. in (\x->e) we make up a fresh type variable for x,
1669 with kind ??.
1670
1671 During unification we only bind an internal type variable to a type
1672 whose kind is lower in the sub-kind hierarchy than the kind of the tyvar.
1673
1674 When unifying two internal type variables, we collect their kind constraints by
1675 finding the GLB of the two.  Since the partial order is a tree, they only
1676 have a glb if one is a sub-kind of the other.  In that case, we bind the
1677 less-informative one to the more informative one.  Neat, eh?
1678
1679
1680 \begin{code}
1681
1682 \end{code}
1683
1684 %************************************************************************
1685 %*                                                                      *
1686         Functions over Kinds
1687 %*                                                                      *
1688 %************************************************************************
1689
1690 \begin{code}
1691 -- | Essentially 'funResultTy' on kinds
1692 kindFunResult :: Kind -> Kind
1693 kindFunResult k = funResultTy k
1694
1695 -- | Essentially 'splitFunTys' on kinds
1696 splitKindFunTys :: Kind -> ([Kind],Kind)
1697 splitKindFunTys k = splitFunTys k
1698
1699 -- | Essentially 'splitFunTysN' on kinds
1700 splitKindFunTysN :: Int -> Kind -> ([Kind],Kind)
1701 splitKindFunTysN k = splitFunTysN k
1702
1703 -- | See "Type#kind_subtyping" for details of the distinction between these 'Kind's
1704 isUbxTupleKind, isOpenTypeKind, isArgTypeKind, isUnliftedTypeKind :: Kind -> Bool
1705 isOpenTypeKindCon, isUbxTupleKindCon, isArgTypeKindCon,
1706         isUnliftedTypeKindCon, isSubArgTypeKindCon      :: TyCon -> Bool
1707
1708 isOpenTypeKindCon tc    = tyConUnique tc == openTypeKindTyConKey
1709
1710 isOpenTypeKind (TyConApp tc _) = isOpenTypeKindCon tc
1711 isOpenTypeKind _               = False
1712
1713 isUbxTupleKindCon tc = tyConUnique tc == ubxTupleKindTyConKey
1714
1715 isUbxTupleKind (TyConApp tc _) = isUbxTupleKindCon tc
1716 isUbxTupleKind _               = False
1717
1718 isArgTypeKindCon tc = tyConUnique tc == argTypeKindTyConKey
1719
1720 isArgTypeKind (TyConApp tc _) = isArgTypeKindCon tc
1721 isArgTypeKind _               = False
1722
1723 isUnliftedTypeKindCon tc = tyConUnique tc == unliftedTypeKindTyConKey
1724
1725 isUnliftedTypeKind (TyConApp tc _) = isUnliftedTypeKindCon tc
1726 isUnliftedTypeKind _               = False
1727
1728 isSubOpenTypeKind :: Kind -> Bool
1729 -- ^ True of any sub-kind of OpenTypeKind (i.e. anything except arrow)
1730 isSubOpenTypeKind (FunTy k1 k2)    = ASSERT2 ( isKind k1, text "isSubOpenTypeKind" <+> ppr k1 <+> text "::" <+> ppr (typeKind k1) )
1731                                      ASSERT2 ( isKind k2, text "isSubOpenTypeKind" <+> ppr k2 <+> text "::" <+> ppr (typeKind k2) )
1732                                      False
1733 isSubOpenTypeKind (TyConApp kc []) = ASSERT( isKind (TyConApp kc []) ) True
1734 isSubOpenTypeKind other            = ASSERT( isKind other ) False
1735          -- This is a conservative answer
1736          -- It matters in the call to isSubKind in
1737          -- checkExpectedKind.
1738
1739 isSubArgTypeKindCon kc
1740   | isUnliftedTypeKindCon kc = True
1741   | isLiftedTypeKindCon kc   = True
1742   | isArgTypeKindCon kc      = True
1743   | otherwise                = False
1744
1745 isSubArgTypeKind :: Kind -> Bool
1746 -- ^ True of any sub-kind of ArgTypeKind
1747 isSubArgTypeKind (TyConApp kc []) = isSubArgTypeKindCon kc
1748 isSubArgTypeKind _                = False
1749
1750 -- | Is this a super-kind (i.e. a type-of-kinds)?
1751 isSuperKind :: Type -> Bool
1752 isSuperKind (TyConApp (skc) []) = isSuperKindTyCon skc
1753 isSuperKind _                   = False
1754
1755 -- | Is this a kind (i.e. a type-of-types)?
1756 isKind :: Kind -> Bool
1757 isKind k = isSuperKind (typeKind k)
1758
1759 isSubKind :: Kind -> Kind -> Bool
1760 -- ^ @k1 \`isSubKind\` k2@ checks that @k1@ <: @k2@
1761 isSubKind (TyConApp kc1 []) (TyConApp kc2 []) = kc1 `isSubKindCon` kc2
1762 isSubKind (FunTy a1 r1) (FunTy a2 r2)         = (a2 `isSubKind` a1) && (r1 `isSubKind` r2)
1763 isSubKind (PredTy (EqPred ty1 ty2)) (PredTy (EqPred ty1' ty2'))
1764   = ty1 `tcEqType` ty1' && ty2 `tcEqType` ty2'
1765 isSubKind _             _                     = False
1766
1767 eqKind :: Kind -> Kind -> Bool
1768 eqKind = tcEqType
1769
1770 isSubKindCon :: TyCon -> TyCon -> Bool
1771 -- ^ @kc1 \`isSubKindCon\` kc2@ checks that @kc1@ <: @kc2@
1772 isSubKindCon kc1 kc2
1773   | isLiftedTypeKindCon kc1   && isLiftedTypeKindCon kc2   = True
1774   | isUnliftedTypeKindCon kc1 && isUnliftedTypeKindCon kc2 = True
1775   | isUbxTupleKindCon kc1     && isUbxTupleKindCon kc2     = True
1776   | isOpenTypeKindCon kc2                                  = True
1777                            -- we already know kc1 is not a fun, its a TyCon
1778   | isArgTypeKindCon kc2      && isSubArgTypeKindCon kc1   = True
1779   | otherwise                                              = False
1780
1781 defaultKind :: Kind -> Kind
1782 -- ^ Used when generalising: default kind ? and ?? to *. See "Type#kind_subtyping" for more
1783 -- information on what that means
1784
1785 -- When we generalise, we make generic type variables whose kind is
1786 -- simple (* or *->* etc).  So generic type variables (other than
1787 -- built-in constants like 'error') always have simple kinds.  This is important;
1788 -- consider
1789 --      f x = True
1790 -- We want f to get type
1791 --      f :: forall (a::*). a -> Bool
1792 -- Not
1793 --      f :: forall (a::??). a -> Bool
1794 -- because that would allow a call like (f 3#) as well as (f True),
1795 --and the calling conventions differ.  This defaulting is done in TcMType.zonkTcTyVarBndr.
1796 defaultKind k
1797   | isSubOpenTypeKind k = liftedTypeKind
1798   | isSubArgTypeKind k  = liftedTypeKind
1799   | otherwise        = k
1800
1801 isEqPred :: PredType -> Bool
1802 isEqPred (EqPred _ _) = True
1803 isEqPred _            = False
1804 \end{code}