ghc/compiler/typecheck/TcType.lhs

   1 %
   2 % (c) The GRASP/AQUA Project, Glasgow University, 1992-1998
   3 %
   4 \section[TcType]{Types used in the typechecker}
   5
   6 This module provides the Type interface for front-end parts of the
   7 compiler.  These parts
   8
   9         * treat "source types" as opaque:
  10                 newtypes, and predicates are meaningful.
  11         * look through usage types
  12
  13 The "tc" prefix is for "typechechecker", because the type checker
  14 is the principal client.
  15
  16 \begin{code}
  17 module TcType (
  18   --------------------------------
  19   -- Types
  20   TcType, TcSigmaType, TcPhiType, TcTauType, TcPredType, TcThetaType,
  21   TcTyVar, TcTyVarSet, TcKind,
  22
  23   --------------------------------
  24   -- TyVarDetails
  25   TyVarDetails(..), isUserTyVar, isSkolemTyVar, isHoleTyVar,
  26   tyVarBindingInfo,
  27
  28   --------------------------------
  29   -- Builders
  30   mkRhoTy, mkSigmaTy,
  31
  32   --------------------------------
  33   -- Splitters
  34   -- These are important because they do not look through newtypes
  35   tcSplitForAllTys, tcSplitRhoTy,
  36   tcSplitFunTy_maybe, tcSplitFunTys, tcFunArgTy, tcFunResultTy,
  37   tcSplitTyConApp, tcSplitTyConApp_maybe, tcTyConAppTyCon, tcTyConAppArgs,
  38   tcSplitAppTy_maybe, tcSplitAppTy, tcSplitSigmaTy,
  39   tcSplitMethodTy, tcGetTyVar_maybe, tcGetTyVar,
  40
  41   ---------------------------------
  42   -- Predicates.
  43   -- Again, newtypes are opaque
  44   tcEqType, tcEqTypes, tcEqPred, tcCmpType, tcCmpTypes, tcCmpPred,
  45   isSigmaTy, isOverloadedTy,
  46   isDoubleTy, isFloatTy, isIntTy,
  47   isIntegerTy, isAddrTy, isBoolTy, isUnitTy, isForeignPtrTy,
  48   isTauTy, tcIsTyVarTy, tcIsForAllTy,
  49
  50   ---------------------------------
  51   -- Misc type manipulators
  52   hoistForAllTys, deNoteType,
  53   namesOfType, namesOfDFunHead,
  54   getDFunTyKey,
  55
  56   ---------------------------------
  57   -- Predicate types
  58   PredType, getClassPredTys_maybe, getClassPredTys,
  59   isPredTy, isClassPred, isTyVarClassPred, predHasFDs,
  60   mkDictTy, tcSplitPredTy_maybe, predTyUnique,
  61   isDictTy, tcSplitDFunTy, predTyUnique,
  62   mkClassPred, inheritablePred, isIPPred, mkPredName,
  63
  64   ---------------------------------
  65   -- Foreign import and export
  66   isFFIArgumentTy,     -- :: DynFlags -> Safety -> Type -> Bool
  67   isFFIImportResultTy, -- :: DynFlags -> Type -> Bool
  68   isFFIExportResultTy, -- :: Type -> Bool
  69   isFFIExternalTy,     -- :: Type -> Bool
  70   isFFIDynArgumentTy,  -- :: Type -> Bool
  71   isFFIDynResultTy,    -- :: Type -> Bool
  72   isFFILabelTy,        -- :: Type -> Bool
  73
  74   ---------------------------------
  75   -- Unifier and matcher
  76   unifyTysX, unifyTyListsX, unifyExtendTysX,
  77   allDistinctTyVars,
  78   matchTy, matchTys, match,
  79
  80   --------------------------------
  81   -- Rexported from Type
  82   Kind,         -- Stuff to do with kinds is insensitive to pre/post Tc
  83   unliftedTypeKind, liftedTypeKind, openTypeKind, mkArrowKind, mkArrowKinds,
  84   superBoxity, liftedBoxity, hasMoreBoxityInfo, defaultKind, superKind,
  85   isTypeKind, isAnyTypeKind,
  86
  87   Type, SourceType(..), PredType, ThetaType,
  88   mkForAllTy, mkForAllTys,
  89   mkFunTy, mkFunTys, zipFunTys,
  90   mkTyConApp, mkAppTy, mkAppTys, mkSynTy, applyTy, applyTys,
  91   mkTyVarTy, mkTyVarTys, mkTyConTy, mkPredTy, mkPredTys,
  92
  93   isUnLiftedType,       -- Source types are always lifted
  94   isUnboxedTupleType,   -- Ditto
  95   isPrimitiveType,
  96
  97   tidyTopType, tidyType, tidyPred, tidyTypes, tidyFreeTyVars, tidyOpenType, tidyOpenTypes,
  98   tidyTyVarBndr, tidyOpenTyVar, tidyOpenTyVars,
  99   typeKind, eqKind, eqUsage,
 100
 101   tyVarsOfType, tyVarsOfTypes, tyVarsOfPred, tyVarsOfTheta
 102   ) where
 103
 104 #include "HsVersions.h"
 105
 106
 107 import {-# SOURCE #-} PprType( pprType )
 108
 109 -- friends:
 110 import TypeRep          ( Type(..), TyNote(..), funTyCon )  -- friend
 111
 112 import Type             (       -- Re-exports
 113                           tyVarsOfType, tyVarsOfTypes, tyVarsOfPred, tyVarsOfTheta,
 114                           Kind, Type, SourceType(..), PredType, ThetaType,
 115                           unliftedTypeKind, liftedTypeKind, openTypeKind, mkArrowKind, mkArrowKinds,
 116                           mkForAllTy, mkForAllTys, defaultKind, isTypeKind, isAnyTypeKind,
 117                           mkFunTy, mkFunTys, zipFunTys,
 118                           mkTyConApp, mkAppTy, mkAppTys, mkSynTy, applyTy, applyTys,
 119                           mkTyVarTy, mkTyVarTys, mkTyConTy, mkPredTy, mkPredTys,
 120                           isUnLiftedType, isUnboxedTupleType, isPrimitiveType,
 121                           splitNewType_maybe, splitTyConApp_maybe,
 122                           tidyTopType, tidyType, tidyPred, tidyTypes, tidyFreeTyVars, tidyOpenType, tidyOpenTypes,
 123                           tidyTyVarBndr, tidyOpenTyVar, tidyOpenTyVars, eqKind, eqUsage,
 124                           hasMoreBoxityInfo, liftedBoxity, superBoxity, typeKind, superKind
 125                         )
 126 import TyCon            ( TyCon, isUnLiftedTyCon )
 127 import Class            ( classHasFDs, Class )
 128 import Var              ( TyVar, tyVarKind, isMutTyVar, mutTyVarDetails )
 129 import ForeignCall      ( Safety, playSafe )
 130 import VarEnv
 131 import VarSet
 132
 133 -- others:
 134 import CmdLineOpts      ( DynFlags, DynFlag( Opt_GlasgowExts ), dopt )
 135 import Name             ( Name, NamedThing(..), mkLocalName, getSrcLoc )
 136 import OccName          ( OccName, mkDictOcc )
 137 import NameSet
 138 import PrelNames        -- Lots (e.g. in isFFIArgumentTy)
 139 import TysWiredIn       ( ptrTyCon, funPtrTyCon, addrTyCon, unitTyCon )
 140 import BasicTypes       ( ipNameName )
 141 import Unique           ( Unique, Uniquable(..) )
 142 import SrcLoc           ( SrcLoc )
 143 import Util             ( cmpList, thenCmp, equalLength )
 144 import Maybes           ( maybeToBool, expectJust )
 145 import Outputable
 146 \end{code}
 147
 148
 149 %************************************************************************
 150 %*                                                                      *
 151 \subsection{Types}
 152 %*                                                                      *
 153 %************************************************************************
 154
 155 The type checker divides the generic Type world into the
 156 following more structured beasts:
 157
 158 sigma ::= forall tyvars. theta => phi
 159         -- A sigma type is a qualified type
 160         --
 161         -- Note that even if 'tyvars' is empty, theta
 162         -- may not be: e.g.   (?x::Int) => Int
 163
 164         -- Note that 'sigma' is in prenex form:
 165         -- all the foralls are at the front.
 166         -- A 'phi' type has no foralls to the right of
 167         -- an arrow
 168
 169 phi ::= sigma -> phi
 170      |  tau
 171
 172 -- A 'tau' type has no quantification anywhere
 173 -- Note that the args of a type constructor must be taus
 174 tau ::= tyvar
 175      |  tycon tau_1 .. tau_n
 176      |  tau_1 tau_2
 177      |  tau_1 -> tau_2
 178
 179 -- In all cases, a (saturated) type synonym application is legal,
 180 -- provided it expands to the required form.
 181
 182
 183 \begin{code}
 184 type SigmaType = Type
 185 type PhiType   = Type
 186 type TauType   = Type
 187 \end{code}
 188
 189 \begin{code}
 190 type TcTyVar    = TyVar         -- Might be a mutable tyvar
 191 type TcTyVarSet = TyVarSet
 192
 193 type TcType = Type              -- A TcType can have mutable type variables
 194         -- Invariant on ForAllTy in TcTypes:
 195         --      forall a. T
 196         -- a cannot occur inside a MutTyVar in T; that is,
 197         -- T is "flattened" before quantifying over a
 198
 199 type TcPredType     = PredType
 200 type TcThetaType    = ThetaType
 201 type TcSigmaType    = TcType
 202 type TcPhiType      = TcType
 203 type TcTauType      = TcType
 204 type TcKind         = TcType
 205 \end{code}
 206
 207
 208 %************************************************************************
 209 %*                                                                      *
 210 \subsection{TyVarDetails}
 211 %*                                                                      *
 212 %************************************************************************
 213
 214 TyVarDetails gives extra info about type variables, used during type
 215 checking.  It's attached to mutable type variables only.
 216 It's knot-tied back to Var.lhs.  There is no reason in principle
 217 why Var.lhs shouldn't actually have the definition, but it "belongs" here.
 218
 219 \begin{code}
 220 data TyVarDetails
 221   = HoleTv      -- Used *only* by the type checker when passing in a type
 222                 -- variable that should be side-effected to the result type.
 223                 -- Always has kind openTypeKind.
 224                 -- Never appears in types
 225
 226   | SigTv       -- Introduced when instantiating a type signature,
 227                 -- prior to checking that the defn of a fn does
 228                 -- have the expected type.  Should not be instantiated.
 229                 --
 230                 --      f :: forall a. a -> a
 231                 --      f = e
 232                 -- When checking e, with expected type (a->a), we
 233                 -- should not instantiate a
 234
 235    | ClsTv      -- Scoped type variable introduced by a class decl
 236                 --      class C a where ...
 237
 238    | InstTv     -- Ditto, but instance decl
 239
 240    | PatSigTv   -- Scoped type variable, introduced by a pattern
 241                 -- type signature
 242                 --      \ x::a -> e
 243
 244    | VanillaTv  -- Everything else
 245
 246 isUserTyVar :: TcTyVar -> Bool  -- Avoid unifying these if possible
 247 isUserTyVar tv = case mutTyVarDetails tv of
 248                    VanillaTv -> False
 249                    other     -> True
 250
 251 isSkolemTyVar :: TcTyVar -> Bool
 252 isSkolemTyVar tv = case mutTyVarDetails tv of
 253                       SigTv -> True
 254                       oteher -> False
 255
 256 isHoleTyVar :: TcTyVar -> Bool
 257 -- NB:  the hole might be filled in by now, and this
 258 --      function does not check for that
 259 isHoleTyVar tv = ASSERT( isMutTyVar tv )
 260                  case mutTyVarDetails tv of
 261                         HoleTv -> True
 262                         other  -> False
 263
 264 tyVarBindingInfo :: TyVar -> SDoc       -- Used in checkSigTyVars
 265 tyVarBindingInfo tv
 266   | isMutTyVar tv
 267   = sep [ptext SLIT("is bound by the") <+> details (mutTyVarDetails tv),
 268          ptext SLIT("at") <+> ppr (getSrcLoc tv)]
 269   | otherwise
 270   = empty
 271   where
 272     details SigTv     = ptext SLIT("type signature")
 273     details ClsTv     = ptext SLIT("class declaration")
 274     details InstTv    = ptext SLIT("instance declaration")
 275     details PatSigTv  = ptext SLIT("pattern type signature")
 276     details HoleTv    = ptext SLIT("//hole//")          -- Should not happen
 277     details VanillaTv = ptext SLIT("//vanilla//")       -- Ditto
 278 \end{code}
 279
 280
 281 %************************************************************************
 282 %*                                                                      *
 283 \subsection{Tau, sigma and rho}
 284 %*                                                                      *
 285 %************************************************************************
 286
 287 \begin{code}
 288 mkSigmaTy tyvars theta tau = mkForAllTys tyvars (mkRhoTy theta tau)
 289
 290 mkRhoTy :: [SourceType] -> Type -> Type
 291 mkRhoTy theta ty = foldr (\p r -> FunTy (mkPredTy p) r) ty theta
 292 \end{code}
 293
 294
 295 @isTauTy@ tests for nested for-alls.
 296
 297 \begin{code}
 298 isTauTy :: Type -> Bool
 299 isTauTy (TyVarTy v)      = True
 300 isTauTy (TyConApp _ tys) = all isTauTy tys
 301 isTauTy (AppTy a b)      = isTauTy a && isTauTy b
 302 isTauTy (FunTy a b)      = isTauTy a && isTauTy b
 303 isTauTy (SourceTy p)     = True         -- Don't look through source types
 304 isTauTy (NoteTy _ ty)    = isTauTy ty
 305 isTauTy other            = False
 306 \end{code}
 307
 308 \begin{code}
 309 getDFunTyKey :: Type -> OccName -- Get some string from a type, to be used to
 310                                 -- construct a dictionary function name
 311 getDFunTyKey (TyVarTy tv)            = getOccName tv
 312 getDFunTyKey (TyConApp tc _)         = getOccName tc
 313 getDFunTyKey (AppTy fun _)           = getDFunTyKey fun
 314 getDFunTyKey (NoteTy _ t)            = getDFunTyKey t
 315 getDFunTyKey (FunTy arg _)           = getOccName funTyCon
 316 getDFunTyKey (ForAllTy _ t)          = getDFunTyKey t
 317 getDFunTyKey (SourceTy (NType tc _)) = getOccName tc    -- Newtypes are quite reasonable
 318 getDFunTyKey ty                      = pprPanic "getDFunTyKey" (pprType ty)
 319 -- SourceTy shouldn't happen
 320 \end{code}
 321
 322
 323 %************************************************************************
 324 %*                                                                      *
 325 \subsection{Expanding and splitting}
 326 %*                                                                      *
 327 %************************************************************************
 328
 329 These tcSplit functions are like their non-Tc analogues, but
 330         a) they do not look through newtypes
 331         b) they do not look through PredTys
 332         c) [future] they ignore usage-type annotations
 333
 334 However, they are non-monadic and do not follow through mutable type
 335 variables.  It's up to you to make sure this doesn't matter.
 336
 337 \begin{code}
 338 tcSplitForAllTys :: Type -> ([TyVar], Type)
 339 tcSplitForAllTys ty = split ty ty []
 340    where
 341      split orig_ty (ForAllTy tv ty) tvs = split ty ty (tv:tvs)
 342      split orig_ty (NoteTy n  ty)   tvs = split orig_ty ty tvs
 343      split orig_ty t                tvs = (reverse tvs, orig_ty)
 344
 345 tcIsForAllTy (ForAllTy tv ty) = True
 346 tcIsForAllTy (NoteTy n ty)    = tcIsForAllTy ty
 347 tcIsForAllTy t                = False
 348
 349 tcSplitRhoTy :: Type -> ([PredType], Type)
 350 tcSplitRhoTy ty = split ty ty []
 351  where
 352   split orig_ty (FunTy arg res) ts = case tcSplitPredTy_maybe arg of
 353                                         Just p  -> split res res (p:ts)
 354                                         Nothing -> (reverse ts, orig_ty)
 355   split orig_ty (NoteTy n ty)   ts = split orig_ty ty ts
 356   split orig_ty ty              ts = (reverse ts, orig_ty)
 357
 358 tcSplitSigmaTy ty = case tcSplitForAllTys ty of
 359                         (tvs, rho) -> case tcSplitRhoTy rho of
 360                                         (theta, tau) -> (tvs, theta, tau)
 361
 362 tcTyConAppTyCon :: Type -> TyCon
 363 tcTyConAppTyCon ty = fst (tcSplitTyConApp ty)
 364
 365 tcTyConAppArgs :: Type -> [Type]
 366 tcTyConAppArgs ty = snd (tcSplitTyConApp ty)
 367
 368 tcSplitTyConApp :: Type -> (TyCon, [Type])
 369 tcSplitTyConApp ty = case tcSplitTyConApp_maybe ty of
 370                         Just stuff -> stuff
 371                         Nothing    -> pprPanic "tcSplitTyConApp" (pprType ty)
 372
 373 tcSplitTyConApp_maybe :: Type -> Maybe (TyCon, [Type])
 374 -- Newtypes are opaque, so they may be split
 375 tcSplitTyConApp_maybe (TyConApp tc tys)         = Just (tc, tys)
 376 tcSplitTyConApp_maybe (FunTy arg res)           = Just (funTyCon, [arg,res])
 377 tcSplitTyConApp_maybe (NoteTy n ty)             = tcSplitTyConApp_maybe ty
 378 tcSplitTyConApp_maybe (SourceTy (NType tc tys)) = Just (tc,tys)
 379         -- However, predicates are not treated
 380         -- as tycon applications by the type checker
 381 tcSplitTyConApp_maybe other                     = Nothing
 382
 383 tcSplitFunTys :: Type -> ([Type], Type)
 384 tcSplitFunTys ty = case tcSplitFunTy_maybe ty of
 385                         Nothing        -> ([], ty)
 386                         Just (arg,res) -> (arg:args, res')
 387                                        where
 388                                           (args,res') = tcSplitFunTys res
 389
 390 tcSplitFunTy_maybe :: Type -> Maybe (Type, Type)
 391 tcSplitFunTy_maybe (FunTy arg res)  = Just (arg, res)
 392 tcSplitFunTy_maybe (NoteTy n ty)    = tcSplitFunTy_maybe ty
 393 tcSplitFunTy_maybe other            = Nothing
 394
 395 tcFunArgTy    ty = case tcSplitFunTy_maybe ty of { Just (arg,res) -> arg }
 396 tcFunResultTy ty = case tcSplitFunTy_maybe ty of { Just (arg,res) -> res }
 397
 398
 399 tcSplitAppTy_maybe :: Type -> Maybe (Type, Type)
 400 tcSplitAppTy_maybe (FunTy ty1 ty2)           = Just (TyConApp funTyCon [ty1], ty2)
 401 tcSplitAppTy_maybe (AppTy ty1 ty2)           = Just (ty1, ty2)
 402 tcSplitAppTy_maybe (NoteTy n ty)             = tcSplitAppTy_maybe ty
 403 tcSplitAppTy_maybe (SourceTy (NType tc tys)) = tc_split_app tc tys
 404         --- Don't forget that newtype!
 405 tcSplitAppTy_maybe (TyConApp tc tys)         = tc_split_app tc tys
 406 tcSplitAppTy_maybe other                     = Nothing
 407
 408 tc_split_app tc []  = Nothing
 409 tc_split_app tc tys = split tys []
 410                     where
 411                       split [ty2]    acc = Just (TyConApp tc (reverse acc), ty2)
 412                       split (ty:tys) acc = split tys (ty:acc)
 413
 414 tcSplitAppTy ty = case tcSplitAppTy_maybe ty of
 415                     Just stuff -> stuff
 416                     Nothing    -> pprPanic "tcSplitAppTy" (pprType ty)
 417
 418 tcGetTyVar_maybe :: Type -> Maybe TyVar
 419 tcGetTyVar_maybe (TyVarTy tv)   = Just tv
 420 tcGetTyVar_maybe (NoteTy _ t)   = tcGetTyVar_maybe t
 421 tcGetTyVar_maybe other          = Nothing
 422
 423 tcGetTyVar :: String -> Type -> TyVar
 424 tcGetTyVar msg ty = expectJust msg (tcGetTyVar_maybe ty)
 425
 426 tcIsTyVarTy :: Type -> Bool
 427 tcIsTyVarTy ty = maybeToBool (tcGetTyVar_maybe ty)
 428 \end{code}
 429
 430 The type of a method for class C is always of the form:
 431         Forall a1..an. C a1..an => sig_ty
 432 where sig_ty is the type given by the method's signature, and thus in general
 433 is a ForallTy.  At the point that splitMethodTy is called, it is expected
 434 that the outer Forall has already been stripped off.  splitMethodTy then
 435 returns (C a1..an, sig_ty') where sig_ty' is sig_ty with any Notes or
 436 Usages stripped off.
 437
 438 \begin{code}
 439 tcSplitMethodTy :: Type -> (PredType, Type)
 440 tcSplitMethodTy ty = split ty
 441  where
 442   split (FunTy arg res) = case tcSplitPredTy_maybe arg of
 443                             Just p  -> (p, res)
 444                             Nothing -> panic "splitMethodTy"
 445   split (NoteTy n ty)   = split ty
 446   split _               = panic "splitMethodTy"
 447
 448 tcSplitDFunTy :: Type -> ([TyVar], [SourceType], Class, [Type])
 449 -- Split the type of a dictionary function
 450 tcSplitDFunTy ty
 451   = case tcSplitSigmaTy ty       of { (tvs, theta, tau) ->
 452     case tcSplitPredTy_maybe tau of { Just (ClassP clas tys) ->
 453     (tvs, theta, clas, tys) }}
 454 \end{code}
 455
 456
 457 %************************************************************************
 458 %*                                                                      *
 459 \subsection{Predicate types}
 460 %*                                                                      *
 461 %************************************************************************
 462
 463 "Predicates" are particular source types, namelyClassP or IParams
 464
 465 \begin{code}
 466 isPred :: SourceType -> Bool
 467 isPred (ClassP _ _) = True
 468 isPred (IParam _ _) = True
 469 isPred (NType _ _)  = False
 470
 471 isPredTy :: Type -> Bool
 472 isPredTy (NoteTy _ ty)  = isPredTy ty
 473 isPredTy (SourceTy sty) = isPred sty
 474 isPredTy _              = False
 475
 476 tcSplitPredTy_maybe :: Type -> Maybe PredType
 477    -- Returns Just for predicates only
 478 tcSplitPredTy_maybe (NoteTy _ ty)           = tcSplitPredTy_maybe ty
 479 tcSplitPredTy_maybe (SourceTy p) | isPred p = Just p
 480 tcSplitPredTy_maybe other                   = Nothing
 481
 482 predTyUnique :: PredType -> Unique
 483 predTyUnique (IParam n _)      = getUnique (ipNameName n)
 484 predTyUnique (ClassP clas tys) = getUnique clas
 485
 486 predHasFDs :: PredType -> Bool
 487 -- True if the predicate has functional depenencies;
 488 -- I.e. should participate in improvement
 489 predHasFDs (IParam _ _)   = True
 490 predHasFDs (ClassP cls _) = classHasFDs cls
 491
 492 mkPredName :: Unique -> SrcLoc -> SourceType -> Name
 493 mkPredName uniq loc (ClassP cls tys) = mkLocalName uniq (mkDictOcc (getOccName cls)) loc
 494 mkPredName uniq loc (IParam ip ty)   = mkLocalName uniq (getOccName (ipNameName ip)) loc
 495 \end{code}
 496
 497
 498 --------------------- Dictionary types ---------------------------------
 499
 500 \begin{code}
 501 mkClassPred clas tys = ClassP clas tys
 502
 503 isClassPred :: SourceType -> Bool
 504 isClassPred (ClassP clas tys) = True
 505 isClassPred other             = False
 506
 507 isTyVarClassPred (ClassP clas tys) = all tcIsTyVarTy tys
 508 isTyVarClassPred other             = False
 509
 510 getClassPredTys_maybe :: SourceType -> Maybe (Class, [Type])
 511 getClassPredTys_maybe (ClassP clas tys) = Just (clas, tys)
 512 getClassPredTys_maybe _                 = Nothing
 513
 514 getClassPredTys :: PredType -> (Class, [Type])
 515 getClassPredTys (ClassP clas tys) = (clas, tys)
 516
 517 mkDictTy :: Class -> [Type] -> Type
 518 mkDictTy clas tys = mkPredTy (ClassP clas tys)
 519
 520 isDictTy :: Type -> Bool
 521 isDictTy (SourceTy p)   = isClassPred p
 522 isDictTy (NoteTy _ ty)  = isDictTy ty
 523 isDictTy other          = False
 524 \end{code}
 525
 526 --------------------- Implicit parameters ---------------------------------
 527
 528 \begin{code}
 529 isIPPred :: SourceType -> Bool
 530 isIPPred (IParam _ _) = True
 531 isIPPred other        = False
 532
 533 inheritablePred :: PredType -> Bool
 534 -- Can be inherited by a context.  For example, consider
 535 --      f x = let g y = (?v, y+x)
 536 --            in (g 3 with ?v = 8,
 537 --                g 4 with ?v = 9)
 538 -- The point is that g's type must be quantifed over ?v:
 539 --      g :: (?v :: a) => a -> a
 540 -- but it doesn't need to be quantified over the Num a dictionary
 541 -- which can be free in g's rhs, and shared by both calls to g
 542 inheritablePred (ClassP _ _) = True
 543 inheritablePred other        = False
 544 \end{code}
 545
 546
 547 %************************************************************************
 548 %*                                                                      *
 549 \subsection{Comparison}
 550 %*                                                                      *
 551 %************************************************************************
 552
 553 Comparison, taking note of newtypes, predicates, etc,
 554 But ignoring usage types
 555
 556 \begin{code}
 557 tcEqType :: Type -> Type -> Bool
 558 tcEqType ty1 ty2 = case ty1 `tcCmpType` ty2 of { EQ -> True; other -> False }
 559
 560 tcEqTypes :: [Type] -> [Type] -> Bool
 561 tcEqTypes ty1 ty2 = case ty1 `tcCmpTypes` ty2 of { EQ -> True; other -> False }
 562
 563 tcEqPred :: PredType -> PredType -> Bool
 564 tcEqPred p1 p2 = case p1 `tcCmpPred` p2 of { EQ -> True; other -> False }
 565
 566 -------------
 567 tcCmpType :: Type -> Type -> Ordering
 568 tcCmpType ty1 ty2 = cmpTy emptyVarEnv ty1 ty2
 569
 570 tcCmpTypes tys1 tys2 = cmpTys emptyVarEnv tys1 tys2
 571
 572 tcCmpPred p1 p2 = cmpSourceTy emptyVarEnv p1 p2
 573 -------------
 574 cmpTys env tys1 tys2 = cmpList (cmpTy env) tys1 tys2
 575
 576 -------------
 577 cmpTy :: TyVarEnv TyVar -> Type -> Type -> Ordering
 578   -- The "env" maps type variables in ty1 to type variables in ty2
 579   -- So when comparing for-alls.. (forall tv1 . t1) (forall tv2 . t2)
 580   -- we in effect substitute tv2 for tv1 in t1 before continuing
 581
 582     -- Look through NoteTy
 583 cmpTy env (NoteTy _ ty1) ty2 = cmpTy env ty1 ty2
 584 cmpTy env ty1 (NoteTy _ ty2) = cmpTy env ty1 ty2
 585
 586     -- Deal with equal constructors
 587 cmpTy env (TyVarTy tv1) (TyVarTy tv2) = case lookupVarEnv env tv1 of
 588                                           Just tv1a -> tv1a `compare` tv2
 589                                           Nothing   -> tv1  `compare` tv2
 590
 591 cmpTy env (SourceTy p1) (SourceTy p2) = cmpSourceTy env p1 p2
 592 cmpTy env (AppTy f1 a1) (AppTy f2 a2) = cmpTy env f1 f2 `thenCmp` cmpTy env a1 a2
 593 cmpTy env (FunTy f1 a1) (FunTy f2 a2) = cmpTy env f1 f2 `thenCmp` cmpTy env a1 a2
 594 cmpTy env (TyConApp tc1 tys1) (TyConApp tc2 tys2) = (tc1 `compare` tc2) `thenCmp` (cmpTys env tys1 tys2)
 595 cmpTy env (ForAllTy tv1 t1)   (ForAllTy tv2 t2)   = cmpTy (extendVarEnv env tv1 tv2) t1 t2
 596
 597     -- Deal with the rest: TyVarTy < AppTy < FunTy < TyConApp < ForAllTy < SourceTy
 598 cmpTy env (AppTy _ _) (TyVarTy _) = GT
 599
 600 cmpTy env (FunTy _ _) (TyVarTy _) = GT
 601 cmpTy env (FunTy _ _) (AppTy _ _) = GT
 602
 603 cmpTy env (TyConApp _ _) (TyVarTy _) = GT
 604 cmpTy env (TyConApp _ _) (AppTy _ _) = GT
 605 cmpTy env (TyConApp _ _) (FunTy _ _) = GT
 606
 607 cmpTy env (ForAllTy _ _) (TyVarTy _)    = GT
 608 cmpTy env (ForAllTy _ _) (AppTy _ _)    = GT
 609 cmpTy env (ForAllTy _ _) (FunTy _ _)    = GT
 610 cmpTy env (ForAllTy _ _) (TyConApp _ _) = GT
 611
 612 cmpTy env (SourceTy _)   t2             = GT
 613
 614 cmpTy env _ _ = LT
 615 \end{code}
 616
 617 \begin{code}
 618 cmpSourceTy :: TyVarEnv TyVar -> SourceType -> SourceType -> Ordering
 619 cmpSourceTy env (IParam n1 ty1) (IParam n2 ty2) = (n1 `compare` n2) `thenCmp` (cmpTy env ty1 ty2)
 620         -- Compare types as well as names for implicit parameters
 621         -- This comparison is used exclusively (I think) for the
 622         -- finite map built in TcSimplify
 623 cmpSourceTy env (IParam _ _)     sty              = LT
 624
 625 cmpSourceTy env (ClassP _ _)     (IParam _ _)     = GT
 626 cmpSourceTy env (ClassP c1 tys1) (ClassP c2 tys2) = (c1 `compare` c2) `thenCmp` (cmpTys env tys1 tys2)
 627 cmpSourceTy env (ClassP _ _)     (NType _ _)      = LT
 628
 629 cmpSourceTy env (NType tc1 tys1) (NType tc2 tys2) = (tc1 `compare` tc2) `thenCmp` (cmpTys env tys1 tys2)
 630 cmpSourceTy env (NType _ _)      sty              = GT
 631 \end{code}
 632
 633 PredTypes are used as a FM key in TcSimplify,
 634 so we take the easy path and make them an instance of Ord
 635
 636 \begin{code}
 637 instance Eq  SourceType where { (==)    = tcEqPred }
 638 instance Ord SourceType where { compare = tcCmpPred }
 639 \end{code}
 640
 641
 642 %************************************************************************
 643 %*                                                                      *
 644 \subsection{Predicates}
 645 %*                                                                      *
 646 %************************************************************************
 647
 648 isSigmaTy returns true of any qualified type.  It doesn't *necessarily* have
 649 any foralls.  E.g.
 650         f :: (?x::Int) => Int -> Int
 651
 652 \begin{code}
 653 isSigmaTy :: Type -> Bool
 654 isSigmaTy (ForAllTy tyvar ty) = True
 655 isSigmaTy (FunTy a b)         = isPredTy a
 656 isSigmaTy (NoteTy n ty)       = isSigmaTy ty
 657 isSigmaTy _                   = False
 658
 659 isOverloadedTy :: Type -> Bool
 660 isOverloadedTy (ForAllTy tyvar ty) = isOverloadedTy ty
 661 isOverloadedTy (FunTy a b)         = isPredTy a
 662 isOverloadedTy (NoteTy n ty)       = isOverloadedTy ty
 663 isOverloadedTy _                   = False
 664 \end{code}
 665
 666 \begin{code}
 667 isFloatTy      = is_tc floatTyConKey
 668 isDoubleTy     = is_tc doubleTyConKey
 669 isForeignPtrTy = is_tc foreignPtrTyConKey
 670 isIntegerTy    = is_tc integerTyConKey
 671 isIntTy        = is_tc intTyConKey
 672 isAddrTy       = is_tc addrTyConKey
 673 isBoolTy       = is_tc boolTyConKey
 674 isUnitTy       = is_tc unitTyConKey
 675
 676 is_tc :: Unique -> Type -> Bool
 677 -- Newtypes are opaque to this
 678 is_tc uniq ty = case tcSplitTyConApp_maybe ty of
 679                         Just (tc, _) -> uniq == getUnique tc
 680                         Nothing      -> False
 681 \end{code}
 682
 683
 684 %************************************************************************
 685 %*                                                                      *
 686 \subsection{Misc}
 687 %*                                                                      *
 688 %************************************************************************
 689
 690 \begin{code}
 691 hoistForAllTys :: Type -> Type
 692 -- Used for user-written type signatures only
 693 -- Move all the foralls and constraints to the top
 694 -- e.g.  T -> forall a. a        ==>   forall a. T -> a
 695 --       T -> (?x::Int) -> Int   ==>   (?x::Int) -> T -> Int
 696 --
 697 -- We want to 'look through' type synonyms when doing this
 698 -- so it's better done on the Type than the HsType
 699
 700 hoistForAllTys ty
 701   = case hoist ty ty of
 702         (tvs, theta, body) -> mkForAllTys tvs (mkFunTys theta body)
 703   where
 704     hoist orig_ty (ForAllTy tv ty) = case hoist ty ty of
 705                                         (tvs,theta,tau) -> (tv:tvs,theta,tau)
 706     hoist orig_ty (FunTy arg res)
 707         | isPredTy arg             = case hoist res res of
 708                                         (tvs,theta,tau) -> (tvs,arg:theta,tau)
 709         | otherwise                = case hoist res res of
 710                                         (tvs,theta,tau) -> (tvs,theta,mkFunTy arg tau)
 711
 712     hoist orig_ty (NoteTy _ ty)    = hoist orig_ty ty
 713     hoist orig_ty ty               = ([], [], orig_ty)
 714 \end{code}
 715
 716
 717 \begin{code}
 718 deNoteType :: Type -> Type
 719         -- Remove synonyms, but not source types
 720 deNoteType ty@(TyVarTy tyvar)   = ty
 721 deNoteType (TyConApp tycon tys) = TyConApp tycon (map deNoteType tys)
 722 deNoteType (SourceTy p)         = SourceTy (deNoteSourceType p)
 723 deNoteType (NoteTy _ ty)        = deNoteType ty
 724 deNoteType (AppTy fun arg)      = AppTy (deNoteType fun) (deNoteType arg)
 725 deNoteType (FunTy fun arg)      = FunTy (deNoteType fun) (deNoteType arg)
 726 deNoteType (ForAllTy tv ty)     = ForAllTy tv (deNoteType ty)
 727
 728 deNoteSourceType :: SourceType -> SourceType
 729 deNoteSourceType (ClassP c tys)   = ClassP c (map deNoteType tys)
 730 deNoteSourceType (IParam n ty)    = IParam n (deNoteType ty)
 731 deNoteSourceType (NType tc tys)   = NType tc (map deNoteType tys)
 732 \end{code}
 733
 734 Find the free names of a type, including the type constructors and classes it mentions
 735 This is used in the front end of the compiler
 736
 737 \begin{code}
 738 namesOfType :: Type -> NameSet
 739 namesOfType (TyVarTy tv)                = unitNameSet (getName tv)
 740 namesOfType (TyConApp tycon tys)        = unitNameSet (getName tycon) `unionNameSets` namesOfTypes tys
 741 namesOfType (NoteTy (SynNote ty1) ty2)  = namesOfType ty1
 742 namesOfType (NoteTy other_note    ty2)  = namesOfType ty2
 743 namesOfType (SourceTy (IParam n ty))    = namesOfType ty
 744 namesOfType (SourceTy (ClassP cl tys))  = unitNameSet (getName cl) `unionNameSets` namesOfTypes tys
 745 namesOfType (SourceTy (NType tc tys))   = unitNameSet (getName tc) `unionNameSets` namesOfTypes tys
 746 namesOfType (FunTy arg res)             = namesOfType arg `unionNameSets` namesOfType res
 747 namesOfType (AppTy fun arg)             = namesOfType fun `unionNameSets` namesOfType arg
 748 namesOfType (ForAllTy tyvar ty)         = namesOfType ty `delFromNameSet` getName tyvar
 749
 750 namesOfTypes tys = foldr (unionNameSets . namesOfType) emptyNameSet tys
 751
 752 namesOfDFunHead :: Type -> NameSet
 753 -- Find the free type constructors and classes
 754 -- of the head of the dfun instance type
 755 -- The 'dfun_head_type' is because of
 756 --      instance Foo a => Baz T where ...
 757 -- The decl is an orphan if Baz and T are both not locally defined,
 758 --      even if Foo *is* locally defined
 759 namesOfDFunHead dfun_ty = case tcSplitSigmaTy dfun_ty of
 760                                 (tvs,_,head_ty) -> delListFromNameSet (namesOfType head_ty)
 761                                                                       (map getName tvs)
 762 \end{code}
 763
 764
 765 %************************************************************************
 766 %*                                                                      *
 767 \subsection[TysWiredIn-ext-type]{External types}
 768 %*                                                                      *
 769 %************************************************************************
 770
 771 The compiler's foreign function interface supports the passing of a
 772 restricted set of types as arguments and results (the restricting factor
 773 being the )
 774
 775 \begin{code}
 776 isFFIArgumentTy :: DynFlags -> Safety -> Type -> Bool
 777 -- Checks for valid argument type for a 'foreign import'
 778 isFFIArgumentTy dflags safety ty
 779    = checkRepTyCon (legalOutgoingTyCon dflags safety) ty
 780
 781 isFFIExternalTy :: Type -> Bool
 782 -- Types that are allowed as arguments of a 'foreign export'
 783 isFFIExternalTy ty = checkRepTyCon legalFEArgTyCon ty
 784
 785 isFFIImportResultTy :: DynFlags -> Type -> Bool
 786 isFFIImportResultTy dflags ty
 787   = checkRepTyCon (legalFIResultTyCon dflags) ty
 788
 789 isFFIExportResultTy :: Type -> Bool
 790 isFFIExportResultTy ty = checkRepTyCon legalFEResultTyCon ty
 791
 792 isFFIDynArgumentTy :: Type -> Bool
 793 -- The argument type of a foreign import dynamic must be Ptr, FunPtr, Addr,
 794 -- or a newtype of either.
 795 isFFIDynArgumentTy = checkRepTyCon (\tc -> tc == ptrTyCon || tc == funPtrTyCon || tc == addrTyCon)
 796
 797 isFFIDynResultTy :: Type -> Bool
 798 -- The result type of a foreign export dynamic must be Ptr, FunPtr, Addr,
 799 -- or a newtype of either.
 800 isFFIDynResultTy = checkRepTyCon (\tc -> tc == ptrTyCon || tc == funPtrTyCon || tc == addrTyCon)
 801
 802 isFFILabelTy :: Type -> Bool
 803 -- The type of a foreign label must be Ptr, FunPtr, Addr,
 804 -- or a newtype of either.
 805 isFFILabelTy = checkRepTyCon (\tc -> tc == ptrTyCon || tc == funPtrTyCon || tc == addrTyCon)
 806
 807 checkRepTyCon :: (TyCon -> Bool) -> Type -> Bool
 808         -- Look through newtypes
 809         -- Non-recursive ones are transparent to splitTyConApp,
 810         -- but recursive ones aren't; hence the splitNewType_maybe
 811 checkRepTyCon check_tc ty
 812   | Just ty'    <- splitNewType_maybe ty  = checkRepTyCon check_tc ty'
 813   | Just (tc,_) <- splitTyConApp_maybe ty = check_tc tc
 814   | otherwise                             = False
 815 \end{code}
 816
 817 ----------------------------------------------
 818 These chaps do the work; they are not exported
 819 ----------------------------------------------
 820
 821 \begin{code}
 822 legalFEArgTyCon :: TyCon -> Bool
 823 -- It's illegal to return foreign objects and (mutable)
 824 -- bytearrays from a _ccall_ / foreign declaration
 825 -- (or be passed them as arguments in foreign exported functions).
 826 legalFEArgTyCon tc
 827   | getUnique tc `elem` [ foreignObjTyConKey, foreignPtrTyConKey,
 828                           byteArrayTyConKey, mutableByteArrayTyConKey ]
 829   = False
 830   -- It's also illegal to make foreign exports that take unboxed
 831   -- arguments.  The RTS API currently can't invoke such things.  --SDM 7/2000
 832   | otherwise
 833   = boxedMarshalableTyCon tc
 834
 835 legalFIResultTyCon :: DynFlags -> TyCon -> Bool
 836 legalFIResultTyCon dflags tc
 837   | getUnique tc `elem`
 838         [ foreignObjTyConKey, foreignPtrTyConKey,
 839           byteArrayTyConKey, mutableByteArrayTyConKey ]  = False
 840   | tc == unitTyCon = True
 841   | otherwise       = marshalableTyCon dflags tc
 842
 843 legalFEResultTyCon :: TyCon -> Bool
 844 legalFEResultTyCon tc
 845   | getUnique tc `elem`
 846         [ foreignObjTyConKey, foreignPtrTyConKey,
 847           byteArrayTyConKey, mutableByteArrayTyConKey ]  = False
 848   | tc == unitTyCon = True
 849   | otherwise       = boxedMarshalableTyCon tc
 850
 851 legalOutgoingTyCon :: DynFlags -> Safety -> TyCon -> Bool
 852 -- Checks validity of types going from Haskell -> external world
 853 legalOutgoingTyCon dflags safety tc
 854   | playSafe safety && getUnique tc `elem` [byteArrayTyConKey, mutableByteArrayTyConKey]
 855   = False
 856   | otherwise
 857   = marshalableTyCon dflags tc
 858
 859 marshalableTyCon dflags tc
 860   =  (dopt Opt_GlasgowExts dflags && isUnLiftedTyCon tc)
 861   || boxedMarshalableTyCon tc
 862
 863 boxedMarshalableTyCon tc
 864    = getUnique tc `elem` [ intTyConKey, int8TyConKey, int16TyConKey
 865                          , int32TyConKey, int64TyConKey
 866                          , wordTyConKey, word8TyConKey, word16TyConKey
 867                          , word32TyConKey, word64TyConKey
 868                          , floatTyConKey, doubleTyConKey
 869                          , addrTyConKey, ptrTyConKey, funPtrTyConKey
 870                          , charTyConKey, foreignObjTyConKey
 871                          , foreignPtrTyConKey
 872                          , stablePtrTyConKey
 873                          , byteArrayTyConKey, mutableByteArrayTyConKey
 874                          , boolTyConKey
 875                          ]
 876 \end{code}
 877
 878
 879 %************************************************************************
 880 %*                                                                      *
 881 \subsection{Unification with an explicit substitution}
 882 %*                                                                      *
 883 %************************************************************************
 884
 885 (allDistinctTyVars tys tvs) = True
 886         iff
 887 all the types tys are type variables,
 888 distinct from each other and from tvs.
 889
 890 This is useful when checking that unification hasn't unified signature
 891 type variables.  For example, if the type sig is
 892         f :: forall a b. a -> b -> b
 893 we want to check that 'a' and 'b' havn't
 894         (a) been unified with a non-tyvar type
 895         (b) been unified with each other (all distinct)
 896         (c) been unified with a variable free in the environment
 897
 898 \begin{code}
 899 allDistinctTyVars :: [Type] -> TyVarSet -> Bool
 900
 901 allDistinctTyVars []       acc
 902   = True
 903 allDistinctTyVars (ty:tys) acc
 904   = case tcGetTyVar_maybe ty of
 905         Nothing                       -> False  -- (a)
 906         Just tv | tv `elemVarSet` acc -> False  -- (b) or (c)
 907                 | otherwise           -> allDistinctTyVars tys (acc `extendVarSet` tv)
 908 \end{code}
 909
 910
 911 %************************************************************************
 912 %*                                                                      *
 913 \subsection{Unification with an explicit substitution}
 914 %*                                                                      *
 915 %************************************************************************
 916
 917 Unify types with an explicit substitution and no monad.
 918 Ignore usage annotations.
 919
 920 \begin{code}
 921 type MySubst
 922    = (TyVarSet,         -- Set of template tyvars
 923       TyVarSubstEnv)    -- Not necessarily idempotent
 924
 925 unifyTysX :: TyVarSet           -- Template tyvars
 926           -> Type
 927           -> Type
 928           -> Maybe TyVarSubstEnv
 929 unifyTysX tmpl_tyvars ty1 ty2
 930   = uTysX ty1 ty2 (\(_,s) -> Just s) (tmpl_tyvars, emptySubstEnv)
 931
 932 unifyExtendTysX :: TyVarSet             -- Template tyvars
 933                 -> TyVarSubstEnv        -- Substitution to start with
 934                 -> Type
 935                 -> Type
 936                 -> Maybe TyVarSubstEnv  -- Extended substitution
 937 unifyExtendTysX tmpl_tyvars subst ty1 ty2
 938   = uTysX ty1 ty2 (\(_,s) -> Just s) (tmpl_tyvars, subst)
 939
 940 unifyTyListsX :: TyVarSet -> [Type] -> [Type]
 941               -> Maybe TyVarSubstEnv
 942 unifyTyListsX tmpl_tyvars tys1 tys2
 943   = uTyListsX tys1 tys2 (\(_,s) -> Just s) (tmpl_tyvars, emptySubstEnv)
 944
 945
 946 uTysX :: Type
 947       -> Type
 948       -> (MySubst -> Maybe result)
 949       -> MySubst
 950       -> Maybe result
 951
 952 uTysX (NoteTy _ ty1) ty2 k subst = uTysX ty1 ty2 k subst
 953 uTysX ty1 (NoteTy _ ty2) k subst = uTysX ty1 ty2 k subst
 954
 955         -- Variables; go for uVar
 956 uTysX (TyVarTy tyvar1) (TyVarTy tyvar2) k subst
 957   | tyvar1 == tyvar2
 958   = k subst
 959 uTysX (TyVarTy tyvar1) ty2 k subst@(tmpls,_)
 960   | tyvar1 `elemVarSet` tmpls
 961   = uVarX tyvar1 ty2 k subst
 962 uTysX ty1 (TyVarTy tyvar2) k subst@(tmpls,_)
 963   | tyvar2 `elemVarSet` tmpls
 964   = uVarX tyvar2 ty1 k subst
 965
 966         -- Predicates
 967 uTysX (SourceTy (IParam n1 t1)) (SourceTy (IParam n2 t2)) k subst
 968   | n1 == n2 = uTysX t1 t2 k subst
 969 uTysX (SourceTy (ClassP c1 tys1)) (SourceTy (ClassP c2 tys2)) k subst
 970   | c1 == c2 = uTyListsX tys1 tys2 k subst
 971 uTysX (SourceTy (NType tc1 tys1)) (SourceTy (NType tc2 tys2)) k subst
 972   | tc1 == tc2 = uTyListsX tys1 tys2 k subst
 973
 974         -- Functions; just check the two parts
 975 uTysX (FunTy fun1 arg1) (FunTy fun2 arg2) k subst
 976   = uTysX fun1 fun2 (uTysX arg1 arg2 k) subst
 977
 978         -- Type constructors must match
 979 uTysX (TyConApp con1 tys1) (TyConApp con2 tys2) k subst
 980   | (con1 == con2 && equalLength tys1 tys2)
 981   = uTyListsX tys1 tys2 k subst
 982
 983         -- Applications need a bit of care!
 984         -- They can match FunTy and TyConApp, so use splitAppTy_maybe
 985         -- NB: we've already dealt with type variables and Notes,
 986         -- so if one type is an App the other one jolly well better be too
 987 uTysX (AppTy s1 t1) ty2 k subst
 988   = case tcSplitAppTy_maybe ty2 of
 989       Just (s2, t2) -> uTysX s1 s2 (uTysX t1 t2 k) subst
 990       Nothing       -> Nothing    -- Fail
 991
 992 uTysX ty1 (AppTy s2 t2) k subst
 993   = case tcSplitAppTy_maybe ty1 of
 994       Just (s1, t1) -> uTysX s1 s2 (uTysX t1 t2 k) subst
 995       Nothing       -> Nothing    -- Fail
 996
 997         -- Not expecting for-alls in unification
 998 #ifdef DEBUG
 999 uTysX (ForAllTy _ _) ty2 k subst = panic "Unify.uTysX subst:ForAllTy (1st arg)"
1000 uTysX ty1 (ForAllTy _ _) k subst = panic "Unify.uTysX subst:ForAllTy (2nd arg)"
1001 #endif
1002
1003         -- Anything else fails
1004 uTysX ty1 ty2 k subst = Nothing
1005
1006
1007 uTyListsX []         []         k subst = k subst
1008 uTyListsX (ty1:tys1) (ty2:tys2) k subst = uTysX ty1 ty2 (uTyListsX tys1 tys2 k) subst
1009 uTyListsX tys1       tys2       k subst = Nothing   -- Fail if the lists are different lengths
1010 \end{code}
1011
1012 \begin{code}
1013 -- Invariant: tv1 is a unifiable variable
1014 uVarX tv1 ty2 k subst@(tmpls, env)
1015   = case lookupSubstEnv env tv1 of
1016       Just (DoneTy ty1) ->    -- Already bound
1017                      uTysX ty1 ty2 k subst
1018
1019       Nothing        -- Not already bound
1020                |  typeKind ty2 `eqKind` tyVarKind tv1
1021                && occur_check_ok ty2
1022                ->     -- No kind mismatch nor occur check
1023                   k (tmpls, extendSubstEnv env tv1 (DoneTy ty2))
1024
1025                | otherwise -> Nothing   -- Fail if kind mis-match or occur check
1026   where
1027     occur_check_ok ty = all occur_check_ok_tv (varSetElems (tyVarsOfType ty))
1028     occur_check_ok_tv tv | tv1 == tv = False
1029                          | otherwise = case lookupSubstEnv env tv of
1030                                          Nothing           -> True
1031                                          Just (DoneTy ty)  -> occur_check_ok ty
1032 \end{code}
1033
1034
1035
1036 %************************************************************************
1037 %*                                                                      *
1038 \subsection{Matching on types}
1039 %*                                                                      *
1040 %************************************************************************
1041
1042 Matching is a {\em unidirectional} process, matching a type against a
1043 template (which is just a type with type variables in it).  The
1044 matcher assumes that there are no repeated type variables in the
1045 template, so that it simply returns a mapping of type variables to
1046 types.  It also fails on nested foralls.
1047
1048 @matchTys@ matches corresponding elements of a list of templates and
1049 types.  It and @matchTy@ both ignore usage annotations, unlike the
1050 main function @match@.
1051
1052 \begin{code}
1053 matchTy :: TyVarSet                     -- Template tyvars
1054         -> Type                         -- Template
1055         -> Type                         -- Proposed instance of template
1056         -> Maybe TyVarSubstEnv          -- Matching substitution
1057
1058
1059 matchTys :: TyVarSet                    -- Template tyvars
1060          -> [Type]                      -- Templates
1061          -> [Type]                      -- Proposed instance of template
1062          -> Maybe (TyVarSubstEnv,               -- Matching substitution
1063                    [Type])              -- Left over instance types
1064
1065 matchTy tmpls ty1 ty2 = match ty1 ty2 tmpls (\ senv -> Just senv) emptySubstEnv
1066
1067 matchTys tmpls tys1 tys2 = match_list tys1 tys2 tmpls
1068                                       (\ (senv,tys) -> Just (senv,tys))
1069                                       emptySubstEnv
1070 \end{code}
1071
1072 @match@ is the main function.  It takes a flag indicating whether
1073 usage annotations are to be respected.
1074
1075 \begin{code}
1076 match :: Type -> Type                           -- Current match pair
1077       -> TyVarSet                               -- Template vars
1078       -> (TyVarSubstEnv -> Maybe result)        -- Continuation
1079       -> TyVarSubstEnv                          -- Current subst
1080       -> Maybe result
1081
1082 -- When matching against a type variable, see if the variable
1083 -- has already been bound.  If so, check that what it's bound to
1084 -- is the same as ty; if not, bind it and carry on.
1085
1086 match (TyVarTy v) ty tmpls k senv
1087   | v `elemVarSet` tmpls
1088   =     -- v is a template variable
1089     case lookupSubstEnv senv v of
1090         Nothing | typeKind ty `eqKind` tyVarKind v
1091                         -- We do a kind check, just as in the uVarX above
1092                         -- The kind check is needed to avoid bogus matches
1093                         -- of   (a b) with (c d), where the kinds don't match
1094                         -- An occur check isn't needed when matching.
1095                 -> k (extendSubstEnv senv v (DoneTy ty))
1096
1097                 | otherwise  -> Nothing -- Fails
1098
1099         Just (DoneTy ty')  | ty' `tcEqType` ty   -> k senv   -- Succeeds
1100                            | otherwise           -> Nothing  -- Fails
1101
1102   | otherwise
1103   =     -- v is not a template variable; ty had better match
1104         -- Can't use (==) because types differ
1105     case tcGetTyVar_maybe ty of
1106         Just v' | v == v' -> k senv    -- Success
1107         other             -> Nothing   -- Failure
1108     -- This tcGetTyVar_maybe is *required* because it must strip Notes.
1109     -- I guess the reason the Note-stripping case is *last* rather than first
1110     -- is to preserve type synonyms etc., so I'm not moving it to the
1111     -- top; but this means that (without the deNotetype) a type
1112     -- variable may not match the pattern (TyVarTy v') as one would
1113     -- expect, due to an intervening Note.  KSW 2000-06.
1114
1115         -- Predicates
1116 match (SourceTy (IParam n1 t1)) (SourceTy (IParam n2 t2)) tmpls k senv
1117   | n1 == n2 = match t1 t2 tmpls k senv
1118 match (SourceTy (ClassP c1 tys1)) (SourceTy (ClassP c2 tys2)) tmpls k senv
1119   | c1 == c2 = match_list_exactly tys1 tys2 tmpls k senv
1120 match (SourceTy (NType tc1 tys1)) (SourceTy (NType tc2 tys2)) tmpls k senv
1121   | tc1 == tc2 = match_list_exactly tys1 tys2 tmpls k senv
1122
1123         -- Functions; just check the two parts
1124 match (FunTy arg1 res1) (FunTy arg2 res2) tmpls k senv
1125   = match arg1 arg2 tmpls (match res1 res2 tmpls k) senv
1126
1127 match (AppTy fun1 arg1) ty2 tmpls k senv
1128   = case tcSplitAppTy_maybe ty2 of
1129         Just (fun2,arg2) -> match fun1 fun2 tmpls (match arg1 arg2 tmpls k) senv
1130         Nothing          -> Nothing     -- Fail
1131
1132 match (TyConApp tc1 tys1) (TyConApp tc2 tys2) tmpls k senv
1133   | tc1 == tc2 = match_list_exactly tys1 tys2 tmpls k senv
1134
1135 -- Newtypes are opaque; other source types should not happen
1136 match (SourceTy (NType tc1 tys1)) (SourceTy (NType tc2 tys2)) tmpls k senv
1137   | tc1 == tc2 = match_list_exactly tys1 tys2 tmpls k senv
1138
1139         -- With type synonyms, we have to be careful for the exact
1140         -- same reasons as in the unifier.  Please see the
1141         -- considerable commentary there before changing anything
1142         -- here! (WDP 95/05)
1143 match (NoteTy n1 ty1) ty2      tmpls k senv = match ty1 ty2 tmpls k senv
1144 match ty1      (NoteTy n2 ty2) tmpls k senv = match ty1 ty2 tmpls k senv
1145
1146 -- Catch-all fails
1147 match _ _ _ _ _ = Nothing
1148
1149 match_list_exactly tys1 tys2 tmpls k senv
1150   = match_list tys1 tys2 tmpls k' senv
1151   where
1152     k' (senv', tys2') | null tys2' = k senv'    -- Succeed
1153                       | otherwise  = Nothing    -- Fail
1154
1155 match_list []         tys2       tmpls k senv = k (senv, tys2)
1156 match_list (ty1:tys1) []         tmpls k senv = Nothing -- Not enough arg tys => failure
1157 match_list (ty1:tys1) (ty2:tys2) tmpls k senv
1158   = match ty1 ty2 tmpls (match_list tys1 tys2 tmpls k) senv
1159 \end{code}