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, TcRhoType, TcTauType, TcPredType, TcThetaType,
  21   TcTyVar, TcTyVarSet, TcKind,
  22
  23   BoxyTyVar, BoxySigmaType, BoxyRhoType, BoxyThetaType, BoxyType,
  24
  25   --------------------------------
  26   -- MetaDetails
  27   UserTypeCtxt(..), pprUserTypeCtxt,
  28   TcTyVarDetails(..), BoxInfo(..), pprTcTyVarDetails,
  29   MetaDetails(Flexi, Indirect), SkolemInfo(..), pprSkolTvBinding, pprSkolInfo,
  30   isImmutableTyVar, isSkolemTyVar, isMetaTyVar, isBoxyTyVar, isSigTyVar, isExistentialTyVar,
  31   metaTvRef,
  32   isFlexi, isIndirect,
  33
  34   --------------------------------
  35   -- Builders
  36   mkPhiTy, mkSigmaTy,
  37
  38   --------------------------------
  39   -- Splitters
  40   -- These are important because they do not look through newtypes
  41   tcView,
  42   tcSplitForAllTys, tcSplitPhiTy,
  43   tcSplitFunTy_maybe, tcSplitFunTys, tcFunArgTy, tcFunResultTy, tcSplitFunTysN,
  44   tcSplitTyConApp, tcSplitTyConApp_maybe, tcTyConAppTyCon, tcTyConAppArgs,
  45   tcSplitAppTy_maybe, tcSplitAppTy, tcSplitAppTys, repSplitAppTy_maybe,
  46   tcValidInstHeadTy, tcGetTyVar_maybe, tcGetTyVar,
  47   tcSplitSigmaTy, tcMultiSplitSigmaTy,
  48
  49   ---------------------------------
  50   -- Predicates.
  51   -- Again, newtypes are opaque
  52   tcEqType, tcEqTypes, tcEqPred, tcCmpType, tcCmpTypes, tcCmpPred, tcEqTypeX,
  53   eqKind,
  54   isSigmaTy, isOverloadedTy, isRigidTy, isBoxyTy,
  55   isDoubleTy, isFloatTy, isIntTy, isStringTy,
  56   isIntegerTy, isBoolTy, isUnitTy,
  57   isTauTy, isTauTyCon, tcIsTyVarTy, tcIsForAllTy,
  58
  59   ---------------------------------
  60   -- Misc type manipulators
  61   deNoteType, classesOfTheta,
  62   tyClsNamesOfType, tyClsNamesOfDFunHead,
  63   getDFunTyKey,
  64
  65   ---------------------------------
  66   -- Predicate types
  67   getClassPredTys_maybe, getClassPredTys,
  68   isClassPred, isTyVarClassPred, isEqPred,
  69   mkDictTy, tcSplitPredTy_maybe,
  70   isPredTy, isDictTy, tcSplitDFunTy, tcSplitDFunHead, predTyUnique,
  71   mkClassPred, isInheritablePred, isLinearPred, isIPPred, mkPredName,
  72   dataConsStupidTheta, isRefineableTy,
  73
  74   ---------------------------------
  75   -- Foreign import and export
  76   isFFIArgumentTy,     -- :: DynFlags -> Safety -> Type -> Bool
  77   isFFIImportResultTy, -- :: DynFlags -> Type -> Bool
  78   isFFIExportResultTy, -- :: Type -> Bool
  79   isFFIExternalTy,     -- :: Type -> Bool
  80   isFFIDynArgumentTy,  -- :: Type -> Bool
  81   isFFIDynResultTy,    -- :: Type -> Bool
  82   isFFILabelTy,        -- :: Type -> Bool
  83   isFFIDotnetTy,       -- :: DynFlags -> Type -> Bool
  84   isFFIDotnetObjTy,    -- :: Type -> Bool
  85   isFFITy,             -- :: Type -> Bool
  86   tcSplitIOType_maybe, -- :: Type -> Maybe Type
  87   toDNType,            -- :: Type -> DNType
  88
  89   --------------------------------
  90   -- Rexported from Type
  91   Kind,         -- Stuff to do with kinds is insensitive to pre/post Tc
  92   unliftedTypeKind, liftedTypeKind, argTypeKind,
  93   openTypeKind, mkArrowKind, mkArrowKinds,
  94   isLiftedTypeKind, isUnliftedTypeKind, isSubOpenTypeKind,
  95   isSubArgTypeKind, isSubKind, defaultKind,
  96   kindVarRef, mkKindVar,
  97
  98   Type, PredType(..), ThetaType,
  99   mkForAllTy, mkForAllTys,
 100   mkFunTy, mkFunTys, zipFunTys,
 101   mkTyConApp, mkAppTy, mkAppTys, applyTy, applyTys,
 102   mkTyVarTy, mkTyVarTys, mkTyConTy, mkPredTy, mkPredTys,
 103
 104   -- Type substitutions
 105   TvSubst(..),  -- Representation visible to a few friends
 106   TvSubstEnv, emptyTvSubst, substEqSpec,
 107   mkOpenTvSubst, zipOpenTvSubst, zipTopTvSubst, mkTopTvSubst, notElemTvSubst,
 108   getTvSubstEnv, setTvSubstEnv, getTvInScope, extendTvInScope, lookupTyVar,
 109   extendTvSubst, extendTvSubstList, isInScope, mkTvSubst, zipTyEnv,
 110   substTy, substTys, substTyWith, substTheta, substTyVar, substTyVarBndr,
 111
 112   isUnLiftedType,       -- Source types are always lifted
 113   isUnboxedTupleType,   -- Ditto
 114   isPrimitiveType,
 115
 116   tidyTopType, tidyType, tidyPred, tidyTypes, tidyFreeTyVars, tidyOpenType, tidyOpenTypes,
 117   tidyTyVarBndr, tidyOpenTyVar, tidyOpenTyVars, tidySkolemTyVar,
 118   typeKind, tidyKind,
 119
 120   tyVarsOfType, tyVarsOfTypes, tyVarsOfPred, tyVarsOfTheta,
 121   tcTyVarsOfType, tcTyVarsOfTypes, exactTyVarsOfType, exactTyVarsOfTypes,
 122
 123   pprKind, pprParendKind,
 124   pprType, pprParendType, pprTyThingCategory,
 125   pprPred, pprTheta, pprThetaArrow, pprClassPred
 126
 127   ) where
 128
 129 #include "HsVersions.h"
 130
 131 -- friends:
 132 import TypeRep          ( Type(..), funTyCon, Kind )  -- friend
 133
 134 import Type             (       -- Re-exports
 135                           tyVarsOfType, tyVarsOfTypes, tyVarsOfPred,
 136                           tyVarsOfTheta, Kind, PredType(..), KindVar,
 137                           ThetaType, isUnliftedTypeKind, unliftedTypeKind,
 138                           argTypeKind,
 139                           liftedTypeKind, openTypeKind, mkArrowKind,
 140                           tySuperKind, isLiftedTypeKind,
 141                           mkArrowKinds, mkForAllTy, mkForAllTys,
 142                           defaultKind, isSubArgTypeKind, isSubOpenTypeKind,
 143                           mkFunTy, mkFunTys, zipFunTys,
 144                           mkTyConApp, mkAppTy,
 145                           mkAppTys, applyTy, applyTys,
 146                           mkTyVarTy, mkTyVarTys, mkTyConTy, mkPredTy,
 147                           mkPredTys, isUnLiftedType,
 148                           isUnboxedTupleType, isPrimitiveType,
 149                           splitTyConApp_maybe,
 150                           tidyTopType, tidyType, tidyPred, tidyTypes,
 151                           tidyFreeTyVars, tidyOpenType, tidyOpenTypes,
 152                           tidyTyVarBndr, tidyOpenTyVar,
 153                           tidyOpenTyVars, tidyKind,
 154                           isSubKind, tcView,
 155
 156                           tcEqType, tcEqTypes, tcCmpType, tcCmpTypes,
 157                           tcEqPred, tcCmpPred, tcEqTypeX, eqKind,
 158
 159                           TvSubst(..),
 160                           TvSubstEnv, emptyTvSubst, mkTvSubst, zipTyEnv,
 161                           mkOpenTvSubst, zipOpenTvSubst, zipTopTvSubst, mkTopTvSubst,
 162                           getTvSubstEnv, setTvSubstEnv, getTvInScope, extendTvInScope,
 163                           extendTvSubst, extendTvSubstList, isInScope, notElemTvSubst,
 164                           substTy, substTys, substTyWith, substTheta,
 165                           substTyVar, substTyVarBndr, substPred, lookupTyVar,
 166
 167                           typeKind, repType, coreView, repSplitAppTy_maybe,
 168                           pprKind, pprParendKind,
 169                           pprType, pprParendType, pprTyThingCategory,
 170                           pprPred, pprTheta, pprThetaArrow, pprClassPred
 171                         )
 172 import TyCon            ( TyCon, isUnLiftedTyCon, isSynTyCon, isOpenTyCon,
 173                           synTyConDefn, tyConUnique )
 174 import DataCon          ( DataCon, dataConStupidTheta, dataConResTys )
 175 import Class            ( Class )
 176 import Var              ( TyVar, Id, isCoVar, isTcTyVar, mkTcTyVar, tyVarName, tyVarKind, tcTyVarDetails )
 177 import ForeignCall      ( Safety, DNType(..) )
 178 import Unify            ( tcMatchTys )
 179 import VarSet
 180
 181 -- others:
 182 import DynFlags         ( DynFlags, DynFlag( Opt_GlasgowExts ), dopt )
 183 import Name             ( Name, NamedThing(..), mkInternalName, getSrcLoc, mkSystemName )
 184 import NameSet
 185 import VarEnv           ( TidyEnv )
 186 import OccName          ( OccName, mkDictOcc, mkOccName, tvName )
 187 import PrelNames        -- Lots (e.g. in isFFIArgumentTy)
 188 import TysWiredIn       ( unitTyCon, charTyCon, listTyCon )
 189 import BasicTypes       ( IPName(..), Arity, ipNameName )
 190 import SrcLoc           ( SrcLoc, SrcSpan )
 191 import Util             ( equalLength )
 192 import Maybes           ( maybeToBool, expectJust, mapCatMaybes )
 193 import ListSetOps       ( hasNoDups )
 194 import List             ( nubBy )
 195 import Outputable
 196 import DATA_IOREF
 197 \end{code}
 198
 199
 200 %************************************************************************
 201 %*                                                                      *
 202 \subsection{Types}
 203 %*                                                                      *
 204 %************************************************************************
 205
 206 The type checker divides the generic Type world into the
 207 following more structured beasts:
 208
 209 sigma ::= forall tyvars. phi
 210         -- A sigma type is a qualified type
 211         --
 212         -- Note that even if 'tyvars' is empty, theta
 213         -- may not be: e.g.   (?x::Int) => Int
 214
 215         -- Note that 'sigma' is in prenex form:
 216         -- all the foralls are at the front.
 217         -- A 'phi' type has no foralls to the right of
 218         -- an arrow
 219
 220 phi :: theta => rho
 221
 222 rho ::= sigma -> rho
 223      |  tau
 224
 225 -- A 'tau' type has no quantification anywhere
 226 -- Note that the args of a type constructor must be taus
 227 tau ::= tyvar
 228      |  tycon tau_1 .. tau_n
 229      |  tau_1 tau_2
 230      |  tau_1 -> tau_2
 231
 232 -- In all cases, a (saturated) type synonym application is legal,
 233 -- provided it expands to the required form.
 234
 235 \begin{code}
 236 type TcTyVar = TyVar    -- Used only during type inference
 237 type TcType = Type      -- A TcType can have mutable type variables
 238         -- Invariant on ForAllTy in TcTypes:
 239         --      forall a. T
 240         -- a cannot occur inside a MutTyVar in T; that is,
 241         -- T is "flattened" before quantifying over a
 242
 243 -- These types do not have boxy type variables in them
 244 type TcPredType     = PredType
 245 type TcThetaType    = ThetaType
 246 type TcSigmaType    = TcType
 247 type TcRhoType      = TcType
 248 type TcTauType      = TcType
 249 type TcKind         = Kind
 250 type TcTyVarSet     = TyVarSet
 251
 252 -- These types may have boxy type variables in them
 253 type BoxyTyVar      = TcTyVar
 254 type BoxyRhoType    = TcType
 255 type BoxyThetaType  = TcThetaType
 256 type BoxySigmaType  = TcType
 257 type BoxyType       = TcType
 258 \end{code}
 259
 260
 261 %************************************************************************
 262 %*                                                                      *
 263 \subsection{TyVarDetails}
 264 %*                                                                      *
 265 %************************************************************************
 266
 267 TyVarDetails gives extra info about type variables, used during type
 268 checking.  It's attached to mutable type variables only.
 269 It's knot-tied back to Var.lhs.  There is no reason in principle
 270 why Var.lhs shouldn't actually have the definition, but it "belongs" here.
 271
 272
 273 Note [Signature skolems]
 274 ~~~~~~~~~~~~~~~~~~~~~~~~
 275 Consider this
 276
 277   x :: [a]
 278   y :: b
 279   (x,y,z) = ([y,z], z, head x)
 280
 281 Here, x and y have type sigs, which go into the environment.  We used to
 282 instantiate their types with skolem constants, and push those types into
 283 the RHS, so we'd typecheck the RHS with type
 284         ( [a*], b*, c )
 285 where a*, b* are skolem constants, and c is an ordinary meta type varible.
 286
 287 The trouble is that the occurrences of z in the RHS force a* and b* to
 288 be the *same*, so we can't make them into skolem constants that don't unify
 289 with each other.  Alas.
 290
 291 One solution would be insist that in the above defn the programmer uses
 292 the same type variable in both type signatures.  But that takes explanation.
 293
 294 The alternative (currently implemented) is to have a special kind of skolem
 295 constant, SigTv, which can unify with other SigTvs.  These are *not* treated
 296 as righd for the purposes of GADTs.  And they are used *only* for pattern
 297 bindings and mutually recursive function bindings.  See the function
 298 TcBinds.tcInstSig, and its use_skols parameter.
 299
 300
 301 \begin{code}
 302 -- A TyVarDetails is inside a TyVar
 303 data TcTyVarDetails
 304   = SkolemTv SkolemInfo                 -- A skolem constant
 305
 306   | MetaTv BoxInfo (IORef MetaDetails)
 307
 308 data BoxInfo
 309    = BoxTv      -- The contents is a (non-boxy) sigma-type
 310                 -- That is, this MetaTv is a "box"
 311
 312    | TauTv      -- The contents is a (non-boxy) tau-type
 313                 -- That is, this MetaTv is an ordinary unification variable
 314
 315    | SigTv SkolemInfo   -- A variant of TauTv, except that it should not be
 316                         -- unified with a type, only with a type variable
 317                         -- SigTvs are only distinguished to improve error messages
 318                         --      see Note [Signature skolems]
 319                         --      The MetaDetails, if filled in, will
 320                         --      always be another SigTv or a SkolemTv
 321
 322 -- INVARIANTS:
 323 --      A TauTv is always filled in with a tau-type, which
 324 --      never contains any BoxTvs, nor any ForAlls
 325 --
 326 --      However, a BoxTv can contain a type that contains further BoxTvs
 327 --      Notably, when typechecking an explicit list, say [e1,e2], with
 328 --      expected type being a box b1, we fill in b1 with (List b2), where
 329 --      b2 is another (currently empty) box.
 330
 331 data MetaDetails
 332   = Flexi          -- Flexi type variables unify to become
 333                    -- Indirects.
 334
 335   | Indirect TcType  -- INVARIANT:
 336                      --   For a BoxTv, this type must be non-boxy
 337                      --   For a TauTv, this type must be a tau-type
 338
 339 data SkolemInfo
 340   = SigSkol UserTypeCtxt        -- A skolem that is created by instantiating
 341                                 -- a programmer-supplied type signature
 342                                 -- Location of the binding site is on the TyVar
 343
 344         -- The rest are for non-scoped skolems
 345   | ClsSkol Class       -- Bound at a class decl
 346   | InstSkol Id         -- Bound at an instance decl
 347   | FamInstSkol TyCon   -- Bound at a family instance decl
 348   | PatSkol DataCon     -- An existential type variable bound by a pattern for
 349             SrcSpan     -- a data constructor with an existential type. E.g.
 350                         --      data T = forall a. Eq a => MkT a
 351                         --      f (MkT x) = ...
 352                         -- The pattern MkT x will allocate an existential type
 353                         -- variable for 'a'.
 354   | ArrowSkol SrcSpan   -- An arrow form (see TcArrows)
 355
 356   | GenSkol [TcTyVar]   -- Bound when doing a subsumption check for
 357             TcType      --      (forall tvs. ty)
 358             SrcSpan
 359
 360   | UnkSkol             -- Unhelpful info (until I improve it)
 361
 362 -------------------------------------
 363 -- UserTypeCtxt describes the places where a
 364 -- programmer-written type signature can occur
 365 data UserTypeCtxt
 366   = FunSigCtxt Name     -- Function type signature
 367                         -- Also used for types in SPECIALISE pragmas
 368   | ExprSigCtxt         -- Expression type signature
 369   | ConArgCtxt Name     -- Data constructor argument
 370   | TySynCtxt Name      -- RHS of a type synonym decl
 371   | GenPatCtxt          -- Pattern in generic decl
 372                         --      f{| a+b |} (Inl x) = ...
 373   | LamPatSigCtxt               -- Type sig in lambda pattern
 374                         --      f (x::t) = ...
 375   | BindPatSigCtxt      -- Type sig in pattern binding pattern
 376                         --      (x::t, y) = e
 377   | ResSigCtxt          -- Result type sig
 378                         --      f x :: t = ....
 379   | ForSigCtxt Name     -- Foreign inport or export signature
 380   | RuleSigCtxt Name    -- Signature on a forall'd variable in a RULE
 381   | DefaultDeclCtxt     -- Types in a default declaration
 382   | SpecInstCtxt        -- SPECIALISE instance pragma
 383
 384 -- Notes re TySynCtxt
 385 -- We allow type synonyms that aren't types; e.g.  type List = []
 386 --
 387 -- If the RHS mentions tyvars that aren't in scope, we'll
 388 -- quantify over them:
 389 --      e.g.    type T = a->a
 390 -- will become  type T = forall a. a->a
 391 --
 392 -- With gla-exts that's right, but for H98 we should complain.
 393
 394 ---------------------------------
 395 -- Kind variables:
 396
 397 mkKindName :: Unique -> Name
 398 mkKindName unique = mkSystemName unique kind_var_occ
 399
 400 kindVarRef :: KindVar -> IORef MetaDetails
 401 kindVarRef tc =
 402   ASSERT ( isTcTyVar tc )
 403   case tcTyVarDetails tc of
 404     MetaTv TauTv ref -> ref
 405     other            -> pprPanic "kindVarRef" (ppr tc)
 406
 407 mkKindVar :: Unique -> IORef MetaDetails -> KindVar
 408 mkKindVar u r
 409   = mkTcTyVar (mkKindName u)
 410               tySuperKind  -- not sure this is right,
 411                             -- do we need kind vars for
 412                             -- coercions?
 413               (MetaTv TauTv r)
 414
 415 kind_var_occ :: OccName -- Just one for all KindVars
 416                         -- They may be jiggled by tidying
 417 kind_var_occ = mkOccName tvName "k"
 418 \end{code}
 419 \end{code}
 420
 421 %************************************************************************
 422 %*                                                                      *
 423                 Pretty-printing
 424 %*                                                                      *
 425 %************************************************************************
 426
 427 \begin{code}
 428 pprTcTyVarDetails :: TcTyVarDetails -> SDoc
 429 -- For debugging
 430 pprTcTyVarDetails (SkolemTv _)         = ptext SLIT("sk")
 431 pprTcTyVarDetails (MetaTv BoxTv _)     = ptext SLIT("box")
 432 pprTcTyVarDetails (MetaTv TauTv _)     = ptext SLIT("tau")
 433 pprTcTyVarDetails (MetaTv (SigTv _) _) = ptext SLIT("sig")
 434
 435 pprUserTypeCtxt :: UserTypeCtxt -> SDoc
 436 pprUserTypeCtxt (FunSigCtxt n)  = ptext SLIT("the type signature for") <+> quotes (ppr n)
 437 pprUserTypeCtxt ExprSigCtxt     = ptext SLIT("an expression type signature")
 438 pprUserTypeCtxt (ConArgCtxt c)  = ptext SLIT("the type of the constructor") <+> quotes (ppr c)
 439 pprUserTypeCtxt (TySynCtxt c)   = ptext SLIT("the RHS of the type synonym") <+> quotes (ppr c)
 440 pprUserTypeCtxt GenPatCtxt      = ptext SLIT("the type pattern of a generic definition")
 441 pprUserTypeCtxt LamPatSigCtxt   = ptext SLIT("a pattern type signature")
 442 pprUserTypeCtxt BindPatSigCtxt  = ptext SLIT("a pattern type signature")
 443 pprUserTypeCtxt ResSigCtxt      = ptext SLIT("a result type signature")
 444 pprUserTypeCtxt (ForSigCtxt n)  = ptext SLIT("the foreign declaration for") <+> quotes (ppr n)
 445 pprUserTypeCtxt (RuleSigCtxt n) = ptext SLIT("the type signature for") <+> quotes (ppr n)
 446 pprUserTypeCtxt DefaultDeclCtxt = ptext SLIT("a type in a `default' declaration")
 447 pprUserTypeCtxt SpecInstCtxt    = ptext SLIT("a SPECIALISE instance pragma")
 448
 449
 450 --------------------------------
 451 tidySkolemTyVar :: TidyEnv -> TcTyVar -> (TidyEnv, TcTyVar)
 452 -- Tidy the type inside a GenSkol, preparatory to printing it
 453 tidySkolemTyVar env tv
 454   = ASSERT( isSkolemTyVar tv || isSigTyVar tv )
 455     (env1, mkTcTyVar (tyVarName tv) (tyVarKind tv) info1)
 456   where
 457     (env1, info1) = case tcTyVarDetails tv of
 458                         SkolemTv info -> (env1, SkolemTv info')
 459                                 where
 460                                   (env1, info') = tidy_skol_info env info
 461                         MetaTv (SigTv info) box -> (env1, MetaTv (SigTv info') box)
 462                                 where
 463                                   (env1, info') = tidy_skol_info env info
 464                         info -> (env, info)
 465
 466     tidy_skol_info env (GenSkol tvs ty loc) = (env2, GenSkol tvs1 ty1 loc)
 467                             where
 468                               (env1, tvs1) = tidyOpenTyVars env tvs
 469                               (env2, ty1)  = tidyOpenType env1 ty
 470     tidy_skol_info env info = (env, info)
 471
 472 pprSkolTvBinding :: TcTyVar -> SDoc
 473 -- Print info about the binding of a skolem tyvar,
 474 -- or nothing if we don't have anything useful to say
 475 pprSkolTvBinding tv
 476   = ASSERT ( isTcTyVar tv )
 477     ppr_details (tcTyVarDetails tv)
 478   where
 479     ppr_details (MetaTv TauTv _)   = quotes (ppr tv) <+> ptext SLIT("is a meta type variable")
 480     ppr_details (MetaTv BoxTv _)   = quotes (ppr tv) <+> ptext SLIT("is a boxy type variable")
 481     ppr_details (MetaTv (SigTv info) _) = ppr_skol info
 482     ppr_details (SkolemTv info)         = ppr_skol info
 483
 484     ppr_skol UnkSkol         = empty    -- Unhelpful; omit
 485     ppr_skol (SigSkol ctxt)  = sep [quotes (ppr tv) <+> ptext SLIT("is bound by") <+> pprUserTypeCtxt ctxt,
 486                                     nest 2 (ptext SLIT("at") <+> ppr (getSrcLoc tv))]
 487     ppr_skol info            = quotes (ppr tv) <+> pprSkolInfo info
 488
 489 pprSkolInfo :: SkolemInfo -> SDoc
 490 pprSkolInfo (SigSkol ctxt)   = ptext SLIT("is bound by") <+> pprUserTypeCtxt ctxt
 491 pprSkolInfo (ClsSkol cls)    = ptext SLIT("is bound by the class declaration for") <+> quotes (ppr cls)
 492 pprSkolInfo (InstSkol df)    =
 493   ptext SLIT("is bound by the instance declaration at") <+> ppr (getSrcLoc df)
 494 pprSkolInfo (FamInstSkol tc) =
 495   ptext SLIT("is bound by the family instance declaration at") <+>
 496   ppr (getSrcLoc tc)
 497 pprSkolInfo (ArrowSkol loc)  =
 498   ptext SLIT("is bound by the arrow form at") <+> ppr loc
 499 pprSkolInfo (PatSkol dc loc) = sep [ptext SLIT("is bound by the pattern for") <+> quotes (ppr dc),
 500                                     nest 2 (ptext SLIT("at") <+> ppr loc)]
 501 pprSkolInfo (GenSkol tvs ty loc) = sep [sep [ptext SLIT("is bound by the polymorphic type"),
 502                                              nest 2 (quotes (ppr (mkForAllTys tvs ty)))],
 503                                         nest 2 (ptext SLIT("at") <+> ppr loc)]
 504 -- UnkSkol, SigSkol
 505 -- For type variables the others are dealt with by pprSkolTvBinding.
 506 -- For Insts, these cases should not happen
 507 pprSkolInfo UnkSkol = panic "UnkSkol"
 508
 509 instance Outputable MetaDetails where
 510   ppr Flexi         = ptext SLIT("Flexi")
 511   ppr (Indirect ty) = ptext SLIT("Indirect") <+> ppr ty
 512 \end{code}
 513
 514
 515 %************************************************************************
 516 %*                                                                      *
 517                 Predicates
 518 %*                                                                      *
 519 %************************************************************************
 520
 521 \begin{code}
 522 isImmutableTyVar, isSkolemTyVar, isExistentialTyVar, isBoxyTyVar, isMetaTyVar :: TyVar -> Bool
 523 isImmutableTyVar tv
 524   | isTcTyVar tv = isSkolemTyVar tv
 525   | otherwise    = True
 526
 527 isSkolemTyVar tv
 528   = ASSERT( isTcTyVar tv )
 529     case tcTyVarDetails tv of
 530         SkolemTv _         -> True
 531         MetaTv _ _         -> False
 532
 533 isExistentialTyVar tv   -- Existential type variable, bound by a pattern
 534   = ASSERT( isTcTyVar tv )
 535     case tcTyVarDetails tv of
 536         SkolemTv (PatSkol _ _) -> True
 537         other                  -> False
 538
 539 isMetaTyVar tv
 540   = ASSERT2( isTcTyVar tv, ppr tv )
 541     case tcTyVarDetails tv of
 542         MetaTv _ _ -> True
 543         other      -> False
 544
 545 isBoxyTyVar tv
 546   = ASSERT( isTcTyVar tv )
 547     case tcTyVarDetails tv of
 548         MetaTv BoxTv _ -> True
 549         other          -> False
 550
 551 isSigTyVar tv
 552   = ASSERT( isTcTyVar tv )
 553     case tcTyVarDetails tv of
 554         MetaTv (SigTv _) _ -> True
 555         other              -> False
 556
 557 metaTvRef :: TyVar -> IORef MetaDetails
 558 metaTvRef tv
 559   = ASSERT( isTcTyVar tv )
 560     case tcTyVarDetails tv of
 561         MetaTv _ ref -> ref
 562         other      -> pprPanic "metaTvRef" (ppr tv)
 563
 564 isFlexi, isIndirect :: MetaDetails -> Bool
 565 isFlexi Flexi = True
 566 isFlexi other = False
 567
 568 isIndirect (Indirect _) = True
 569 isIndirect other        = False
 570 \end{code}
 571
 572
 573 %************************************************************************
 574 %*                                                                      *
 575 \subsection{Tau, sigma and rho}
 576 %*                                                                      *
 577 %************************************************************************
 578
 579 \begin{code}
 580 mkSigmaTy :: [TyVar] -> [PredType] -> Type -> Type
 581 mkSigmaTy tyvars theta tau = mkForAllTys tyvars (mkPhiTy theta tau)
 582
 583 mkPhiTy :: [PredType] -> Type -> Type
 584 mkPhiTy theta ty = foldr (\p r -> FunTy (mkPredTy p) r) ty theta
 585 \end{code}
 586
 587 @isTauTy@ tests for nested for-alls.  It should not be called on a boxy type.
 588
 589 \begin{code}
 590 isTauTy :: Type -> Bool
 591 isTauTy ty | Just ty' <- tcView ty = isTauTy ty'
 592 isTauTy (TyVarTy tv)     = ASSERT( not (isTcTyVar tv && isBoxyTyVar tv) )
 593                            True
 594 isTauTy (TyConApp tc tys) = all isTauTy tys && isTauTyCon tc
 595 isTauTy (AppTy a b)       = isTauTy a && isTauTy b
 596 isTauTy (FunTy a b)       = isTauTy a && isTauTy b
 597 isTauTy (PredTy p)        = True                -- Don't look through source types
 598 isTauTy other             = False
 599
 600
 601 isTauTyCon :: TyCon -> Bool
 602 -- Returns False for type synonyms whose expansion is a polytype
 603 isTauTyCon tc
 604   | isSynTyCon tc && not (isOpenTyCon tc) = isTauTy (snd (synTyConDefn tc))
 605   | otherwise                             = True
 606
 607 ---------------
 608 isBoxyTy :: TcType -> Bool
 609 isBoxyTy ty = any isBoxyTyVar (varSetElems (tcTyVarsOfType ty))
 610
 611 isRigidTy :: TcType -> Bool
 612 -- A type is rigid if it has no meta type variables in it
 613 isRigidTy ty = all isSkolemTyVar (varSetElems (tcTyVarsOfType ty))
 614
 615 isRefineableTy :: TcType -> Bool
 616 -- A type should have type refinements applied to it if it has
 617 -- free type variables, and they are all rigid
 618 isRefineableTy ty = not (null tc_tvs) && all isSkolemTyVar tc_tvs
 619                     where
 620                       tc_tvs = varSetElems (tcTyVarsOfType ty)
 621
 622 ---------------
 623 getDFunTyKey :: Type -> OccName -- Get some string from a type, to be used to
 624                                 -- construct a dictionary function name
 625 getDFunTyKey ty | Just ty' <- tcView ty = getDFunTyKey ty'
 626 getDFunTyKey (TyVarTy tv)    = getOccName tv
 627 getDFunTyKey (TyConApp tc _) = getOccName tc
 628 getDFunTyKey (AppTy fun _)   = getDFunTyKey fun
 629 getDFunTyKey (FunTy arg _)   = getOccName funTyCon
 630 getDFunTyKey (ForAllTy _ t)  = getDFunTyKey t
 631 getDFunTyKey ty              = pprPanic "getDFunTyKey" (pprType ty)
 632 -- PredTy shouldn't happen
 633 \end{code}
 634
 635
 636 %************************************************************************
 637 %*                                                                      *
 638 \subsection{Expanding and splitting}
 639 %*                                                                      *
 640 %************************************************************************
 641
 642 These tcSplit functions are like their non-Tc analogues, but
 643         a) they do not look through newtypes
 644         b) they do not look through PredTys
 645         c) [future] they ignore usage-type annotations
 646
 647 However, they are non-monadic and do not follow through mutable type
 648 variables.  It's up to you to make sure this doesn't matter.
 649
 650 \begin{code}
 651 tcSplitForAllTys :: Type -> ([TyVar], Type)
 652 tcSplitForAllTys ty = split ty ty []
 653    where
 654      split orig_ty ty tvs | Just ty' <- tcView ty = split orig_ty ty' tvs
 655      split orig_ty (ForAllTy tv ty) tvs
 656        | not (isCoVar tv) = split ty ty (tv:tvs)
 657      split orig_ty t tvs = (reverse tvs, orig_ty)
 658
 659 tcIsForAllTy ty | Just ty' <- tcView ty = tcIsForAllTy ty'
 660 tcIsForAllTy (ForAllTy tv ty) = not (isCoVar tv)
 661 tcIsForAllTy t                = False
 662
 663 tcSplitPhiTy :: Type -> (ThetaType, Type)
 664 tcSplitPhiTy ty = split ty ty []
 665  where
 666   split orig_ty ty tvs | Just ty' <- tcView ty = split orig_ty ty' tvs
 667
 668   split orig_ty (ForAllTy tv ty) ts
 669         | isCoVar tv = split ty ty (eq_pred:ts)
 670         where
 671            PredTy eq_pred = tyVarKind tv
 672   split orig_ty (FunTy arg res) ts
 673         | Just p <- tcSplitPredTy_maybe arg = split res res (p:ts)
 674   split orig_ty ty              ts = (reverse ts, orig_ty)
 675
 676 tcSplitSigmaTy :: Type -> ([TyVar], ThetaType, Type)
 677 tcSplitSigmaTy ty = case tcSplitForAllTys ty of
 678                         (tvs, rho) -> case tcSplitPhiTy rho of
 679                                         (theta, tau) -> (tvs, theta, tau)
 680
 681 -----------------------
 682 tcMultiSplitSigmaTy
 683         :: TcSigmaType
 684         -> ( [([TyVar], ThetaType)],    -- forall as.C => forall bs.D
 685              TcSigmaType)               -- The rest of the type
 686
 687 -- We need a loop here because we are now prepared to entertain
 688 -- types like
 689 --      f:: forall a. Eq a => forall b. Baz b => tau
 690 -- We want to instantiate this to
 691 --      f2::tau         {f2 = f1 b (Baz b), f1 = f a (Eq a)}
 692
 693 tcMultiSplitSigmaTy sigma
 694   = case (tcSplitSigmaTy sigma) of
 695         ([],[],ty) -> ([], sigma)
 696         (tvs, theta, ty) -> case tcMultiSplitSigmaTy ty of
 697                                 (pairs, rest) -> ((tvs,theta):pairs, rest)
 698
 699 -----------------------
 700 tcTyConAppTyCon :: Type -> TyCon
 701 tcTyConAppTyCon ty = fst (tcSplitTyConApp ty)
 702
 703 tcTyConAppArgs :: Type -> [Type]
 704 tcTyConAppArgs ty = snd (tcSplitTyConApp ty)
 705
 706 tcSplitTyConApp :: Type -> (TyCon, [Type])
 707 tcSplitTyConApp ty = case tcSplitTyConApp_maybe ty of
 708                         Just stuff -> stuff
 709                         Nothing    -> pprPanic "tcSplitTyConApp" (pprType ty)
 710
 711 tcSplitTyConApp_maybe :: Type -> Maybe (TyCon, [Type])
 712 tcSplitTyConApp_maybe ty | Just ty' <- tcView ty = tcSplitTyConApp_maybe ty'
 713 tcSplitTyConApp_maybe (TyConApp tc tys) = Just (tc, tys)
 714 tcSplitTyConApp_maybe (FunTy arg res)   = Just (funTyCon, [arg,res])
 715 tcSplitTyConApp_maybe (AppTy arg res)   = Just (funTyCon, [arg,res])
 716 tcSplitTyConApp_maybe (PredTy (ClassP _ [ty']))   = tcSplitTyConApp_maybe ty'
 717         -- Newtypes are opaque, so they may be split
 718         -- However, predicates are not treated
 719         -- as tycon applications by the type checker
 720 tcSplitTyConApp_maybe other             = Nothing
 721
 722 -----------------------
 723 tcSplitFunTys :: Type -> ([Type], Type)
 724 tcSplitFunTys ty = case tcSplitFunTy_maybe ty of
 725                         Nothing        -> ([], ty)
 726                         Just (arg,res) -> (arg:args, res')
 727                                        where
 728                                           (args,res') = tcSplitFunTys res
 729
 730 tcSplitFunTy_maybe :: Type -> Maybe (Type, Type)
 731 tcSplitFunTy_maybe ty | Just ty' <- tcView ty = tcSplitFunTy_maybe ty'
 732 tcSplitFunTy_maybe (FunTy arg res)  = Just (arg, res)
 733 tcSplitFunTy_maybe other            = Nothing
 734
 735 tcSplitFunTysN
 736         :: TcRhoType
 737         -> Arity                -- N: Number of desired args
 738         -> ([TcSigmaType],      -- Arg types (N or fewer)
 739             TcSigmaType)        -- The rest of the type
 740
 741 tcSplitFunTysN ty n_args
 742   | n_args == 0
 743   = ([], ty)
 744   | Just (arg,res) <- tcSplitFunTy_maybe ty
 745   = case tcSplitFunTysN res (n_args - 1) of
 746         (args, res) -> (arg:args, res)
 747   | otherwise
 748   = ([], ty)
 749
 750 tcSplitFunTy  ty = expectJust "tcSplitFunTy" (tcSplitFunTy_maybe ty)
 751 tcFunArgTy    ty = fst (tcSplitFunTy ty)
 752 tcFunResultTy ty = snd (tcSplitFunTy ty)
 753
 754 -----------------------
 755 tcSplitAppTy_maybe :: Type -> Maybe (Type, Type)
 756 tcSplitAppTy_maybe ty | Just ty' <- tcView ty = tcSplitAppTy_maybe ty'
 757 tcSplitAppTy_maybe ty = repSplitAppTy_maybe ty
 758
 759 tcSplitAppTy :: Type -> (Type, Type)
 760 tcSplitAppTy ty = case tcSplitAppTy_maybe ty of
 761                     Just stuff -> stuff
 762                     Nothing    -> pprPanic "tcSplitAppTy" (pprType ty)
 763
 764 tcSplitAppTys :: Type -> (Type, [Type])
 765 tcSplitAppTys ty
 766   = go ty []
 767   where
 768     go ty args = case tcSplitAppTy_maybe ty of
 769                    Just (ty', arg) -> go ty' (arg:args)
 770                    Nothing         -> (ty,args)
 771
 772 -----------------------
 773 tcGetTyVar_maybe :: Type -> Maybe TyVar
 774 tcGetTyVar_maybe ty | Just ty' <- tcView ty = tcGetTyVar_maybe ty'
 775 tcGetTyVar_maybe (TyVarTy tv)   = Just tv
 776 tcGetTyVar_maybe other          = Nothing
 777
 778 tcGetTyVar :: String -> Type -> TyVar
 779 tcGetTyVar msg ty = expectJust msg (tcGetTyVar_maybe ty)
 780
 781 tcIsTyVarTy :: Type -> Bool
 782 tcIsTyVarTy ty = maybeToBool (tcGetTyVar_maybe ty)
 783
 784 -----------------------
 785 tcSplitDFunTy :: Type -> ([TyVar], [PredType], Class, [Type])
 786 -- Split the type of a dictionary function
 787 tcSplitDFunTy ty
 788   = case tcSplitSigmaTy ty   of { (tvs, theta, tau) ->
 789     case tcSplitDFunHead tau of { (clas, tys) ->
 790     (tvs, theta, clas, tys) }}
 791
 792 tcSplitDFunHead :: Type -> (Class, [Type])
 793 tcSplitDFunHead tau
 794   = case tcSplitPredTy_maybe tau of
 795         Just (ClassP clas tys) -> (clas, tys)
 796         other -> panic "tcSplitDFunHead"
 797
 798 tcValidInstHeadTy :: Type -> Bool
 799 -- Used in Haskell-98 mode, for the argument types of an instance head
 800 -- These must not be type synonyms, but everywhere else type synonyms
 801 -- are transparent, so we need a special function here
 802 tcValidInstHeadTy ty
 803   = case ty of
 804         NoteTy _ ty     -> tcValidInstHeadTy ty
 805         TyConApp tc tys -> not (isSynTyCon tc) && ok tys
 806         FunTy arg res   -> ok [arg, res]
 807         other           -> False
 808   where
 809         -- Check that all the types are type variables,
 810         -- and that each is distinct
 811     ok tys = equalLength tvs tys && hasNoDups tvs
 812            where
 813              tvs = mapCatMaybes get_tv tys
 814
 815     get_tv (NoteTy _ ty) = get_tv ty    -- Again, do not look
 816     get_tv (TyVarTy tv)  = Just tv      -- through synonyms
 817     get_tv other         = Nothing
 818 \end{code}
 819
 820
 821
 822 %************************************************************************
 823 %*                                                                      *
 824 \subsection{Predicate types}
 825 %*                                                                      *
 826 %************************************************************************
 827
 828 \begin{code}
 829 tcSplitPredTy_maybe :: Type -> Maybe PredType
 830    -- Returns Just for predicates only
 831 tcSplitPredTy_maybe ty | Just ty' <- tcView ty = tcSplitPredTy_maybe ty'
 832 tcSplitPredTy_maybe (PredTy p)    = Just p
 833 tcSplitPredTy_maybe other         = Nothing
 834
 835 predTyUnique :: PredType -> Unique
 836 predTyUnique (IParam n _)      = getUnique (ipNameName n)
 837 predTyUnique (ClassP clas tys) = getUnique clas
 838
 839 mkPredName :: Unique -> SrcLoc -> PredType -> Name
 840 mkPredName uniq loc (ClassP cls tys) = mkInternalName uniq (mkDictOcc (getOccName cls)) loc
 841 mkPredName uniq loc (IParam ip ty)   = mkInternalName uniq (getOccName (ipNameName ip)) loc
 842 \end{code}
 843
 844
 845 --------------------- Dictionary types ---------------------------------
 846
 847 \begin{code}
 848 mkClassPred clas tys = ClassP clas tys
 849
 850 isClassPred :: PredType -> Bool
 851 isClassPred (ClassP clas tys) = True
 852 isClassPred other             = False
 853
 854 isTyVarClassPred (ClassP clas tys) = all tcIsTyVarTy tys
 855 isTyVarClassPred other             = False
 856
 857 getClassPredTys_maybe :: PredType -> Maybe (Class, [Type])
 858 getClassPredTys_maybe (ClassP clas tys) = Just (clas, tys)
 859 getClassPredTys_maybe _                 = Nothing
 860
 861 getClassPredTys :: PredType -> (Class, [Type])
 862 getClassPredTys (ClassP clas tys) = (clas, tys)
 863 getClassPredTys other = panic "getClassPredTys"
 864
 865 isEqPred :: PredType -> Bool
 866 isEqPred (EqPred {}) = True
 867 isEqPred _           = False
 868
 869 mkDictTy :: Class -> [Type] -> Type
 870 mkDictTy clas tys = mkPredTy (ClassP clas tys)
 871
 872 isDictTy :: Type -> Bool
 873 isDictTy ty | Just ty' <- tcView ty = isDictTy ty'
 874 isDictTy (PredTy p) = isClassPred p
 875 isDictTy other      = False
 876 \end{code}
 877
 878 --------------------- Implicit parameters ---------------------------------
 879
 880 \begin{code}
 881 isIPPred :: PredType -> Bool
 882 isIPPred (IParam _ _) = True
 883 isIPPred other        = False
 884
 885 isInheritablePred :: PredType -> Bool
 886 -- Can be inherited by a context.  For example, consider
 887 --      f x = let g y = (?v, y+x)
 888 --            in (g 3 with ?v = 8,
 889 --                g 4 with ?v = 9)
 890 -- The point is that g's type must be quantifed over ?v:
 891 --      g :: (?v :: a) => a -> a
 892 -- but it doesn't need to be quantified over the Num a dictionary
 893 -- which can be free in g's rhs, and shared by both calls to g
 894 isInheritablePred (ClassP _ _) = True
 895 isInheritablePred other      = False
 896
 897 isLinearPred :: TcPredType -> Bool
 898 isLinearPred (IParam (Linear n) _) = True
 899 isLinearPred other                 = False
 900 \end{code}
 901
 902 --------------------- Equality predicates ---------------------------------
 903 \begin{code}
 904 substEqSpec :: TvSubst -> [(TyVar,Type)] -> [(TcType,TcType)]
 905 substEqSpec subst eq_spec = [ (substTyVar subst tv, substTy subst ty)
 906                             | (tv,ty) <- eq_spec]
 907 \end{code}
 908
 909 --------------------- The stupid theta (sigh) ---------------------------------
 910
 911 \begin{code}
 912 dataConsStupidTheta :: [DataCon] -> ThetaType
 913 -- Union the stupid thetas from all the specified constructors (non-empty)
 914 -- All the constructors should have the same result type, modulo alpha conversion
 915 -- The resulting ThetaType uses type variables from the *first* constructor in the list
 916 --
 917 -- It's here because it's used in MkId.mkRecordSelId, and in TcExpr
 918 dataConsStupidTheta (con1:cons)
 919   = nubBy tcEqPred all_preds
 920   where
 921     all_preds     = dataConStupidTheta con1 ++ other_stupids
 922     res_tys1      = dataConResTys con1
 923     tvs1          = tyVarsOfTypes res_tys1
 924     other_stupids = [ substPred subst pred
 925                     | con <- cons
 926                     , let Just subst = tcMatchTys tvs1 res_tys1 (dataConResTys con)
 927                     , pred <- dataConStupidTheta con ]
 928 dataConsStupidTheta [] = panic "dataConsStupidTheta"
 929 \end{code}
 930
 931
 932 %************************************************************************
 933 %*                                                                      *
 934 \subsection{Predicates}
 935 %*                                                                      *
 936 %************************************************************************
 937
 938 isSigmaTy returns true of any qualified type.  It doesn't *necessarily* have
 939 any foralls.  E.g.
 940         f :: (?x::Int) => Int -> Int
 941
 942 \begin{code}
 943 isSigmaTy :: Type -> Bool
 944 isSigmaTy ty | Just ty' <- tcView ty = isSigmaTy ty'
 945 isSigmaTy (ForAllTy tyvar ty) = True
 946 isSigmaTy (FunTy a b)         = isPredTy a
 947 isSigmaTy _                   = False
 948
 949 isOverloadedTy :: Type -> Bool
 950 isOverloadedTy ty | Just ty' <- tcView ty = isOverloadedTy ty'
 951 isOverloadedTy (ForAllTy tyvar ty) = isOverloadedTy ty
 952 isOverloadedTy (FunTy a b)         = isPredTy a
 953 isOverloadedTy _                   = False
 954
 955 isPredTy :: Type -> Bool        -- Belongs in TcType because it does
 956                                 -- not look through newtypes, or predtypes (of course)
 957 isPredTy ty | Just ty' <- tcView ty = isPredTy ty'
 958 isPredTy (PredTy sty)  = True
 959 isPredTy _             = False
 960 \end{code}
 961
 962 \begin{code}
 963 isFloatTy      = is_tc floatTyConKey
 964 isDoubleTy     = is_tc doubleTyConKey
 965 isIntegerTy    = is_tc integerTyConKey
 966 isIntTy        = is_tc intTyConKey
 967 isBoolTy       = is_tc boolTyConKey
 968 isUnitTy       = is_tc unitTyConKey
 969
 970 is_tc :: Unique -> Type -> Bool
 971 -- Newtypes are opaque to this
 972 is_tc uniq ty = case tcSplitTyConApp_maybe ty of
 973                         Just (tc, _) -> uniq == getUnique tc
 974                         Nothing      -> False
 975 \end{code}
 976
 977
 978 %************************************************************************
 979 %*                                                                      *
 980 \subsection{Misc}
 981 %*                                                                      *
 982 %************************************************************************
 983
 984 \begin{code}
 985 deNoteType :: Type -> Type
 986 -- Remove all *outermost* type synonyms and other notes
 987 deNoteType ty | Just ty' <- tcView ty = deNoteType ty'
 988 deNoteType ty = ty
 989 \end{code}
 990
 991 \begin{code}
 992 tcTyVarsOfType :: Type -> TcTyVarSet
 993 -- Just the *TcTyVars* free in the type
 994 -- (Types.tyVarsOfTypes finds all free TyVars)
 995 tcTyVarsOfType (TyVarTy tv)         = if isTcTyVar tv then unitVarSet tv
 996                                                       else emptyVarSet
 997 tcTyVarsOfType (TyConApp tycon tys) = tcTyVarsOfTypes tys
 998 tcTyVarsOfType (NoteTy _ ty)        = tcTyVarsOfType ty
 999 tcTyVarsOfType (PredTy sty)         = tcTyVarsOfPred sty
1000 tcTyVarsOfType (FunTy arg res)      = tcTyVarsOfType arg `unionVarSet` tcTyVarsOfType res
1001 tcTyVarsOfType (AppTy fun arg)      = tcTyVarsOfType fun `unionVarSet` tcTyVarsOfType arg
1002 tcTyVarsOfType (ForAllTy tyvar ty)  = (tcTyVarsOfType ty `delVarSet` tyvar)
1003                                       `unionVarSet` tcTyVarsOfTyVar tyvar
1004         -- We do sometimes quantify over skolem TcTyVars
1005
1006 tcTyVarsOfTyVar :: TcTyVar -> TyVarSet
1007 tcTyVarsOfTyVar tv | isCoVar tv = tcTyVarsOfType (tyVarKind tv)
1008                    | otherwise  = emptyVarSet
1009
1010 tcTyVarsOfTypes :: [Type] -> TyVarSet
1011 tcTyVarsOfTypes tys = foldr (unionVarSet.tcTyVarsOfType) emptyVarSet tys
1012
1013 tcTyVarsOfPred :: PredType -> TyVarSet
1014 tcTyVarsOfPred (IParam _ ty)    = tcTyVarsOfType ty
1015 tcTyVarsOfPred (ClassP _ tys)   = tcTyVarsOfTypes tys
1016 tcTyVarsOfPred (EqPred ty1 ty2) = tcTyVarsOfType ty1 `unionVarSet` tcTyVarsOfType ty2
1017 \end{code}
1018
1019 Note [Silly type synonym]
1020 ~~~~~~~~~~~~~~~~~~~~~~~~~
1021 Consider
1022         type T a = Int
1023 What are the free tyvars of (T x)?  Empty, of course!
1024 Here's the example that Ralf Laemmel showed me:
1025         foo :: (forall a. C u a -> C u a) -> u
1026         mappend :: Monoid u => u -> u -> u
1027
1028         bar :: Monoid u => u
1029         bar = foo (\t -> t `mappend` t)
1030 We have to generalise at the arg to f, and we don't
1031 want to capture the constraint (Monad (C u a)) because
1032 it appears to mention a.  Pretty silly, but it was useful to him.
1033
1034 exactTyVarsOfType is used by the type checker to figure out exactly
1035 which type variables are mentioned in a type.  It's also used in the
1036 smart-app checking code --- see TcExpr.tcIdApp
1037
1038 \begin{code}
1039 exactTyVarsOfType :: TcType -> TyVarSet
1040 -- Find the free type variables (of any kind)
1041 -- but *expand* type synonyms.  See Note [Silly type synonym] above.
1042 exactTyVarsOfType ty
1043   = go ty
1044   where
1045     go ty | Just ty' <- tcView ty = go ty'      -- This is the key line
1046     go (TyVarTy tv)               = unitVarSet tv
1047     go (TyConApp tycon tys)       = exactTyVarsOfTypes tys
1048     go (PredTy ty)                = go_pred ty
1049     go (FunTy arg res)            = go arg `unionVarSet` go res
1050     go (AppTy fun arg)            = go fun `unionVarSet` go arg
1051     go (ForAllTy tyvar ty)        = delVarSet (go ty) tyvar
1052                                     `unionVarSet` go_tv tyvar
1053
1054     go_pred (IParam _ ty)    = go ty
1055     go_pred (ClassP _ tys)   = exactTyVarsOfTypes tys
1056     go_pred (EqPred ty1 ty2) = go ty1 `unionVarSet` go ty2
1057
1058     go_tv tyvar | isCoVar tyvar = go (tyVarKind tyvar)
1059                 | otherwise     = emptyVarSet
1060
1061 exactTyVarsOfTypes :: [TcType] -> TyVarSet
1062 exactTyVarsOfTypes tys = foldr (unionVarSet . exactTyVarsOfType) emptyVarSet tys
1063 \end{code}
1064
1065 Find the free tycons and classes of a type.  This is used in the front
1066 end of the compiler.
1067
1068 \begin{code}
1069 tyClsNamesOfType :: Type -> NameSet
1070 tyClsNamesOfType (TyVarTy tv)               = emptyNameSet
1071 tyClsNamesOfType (TyConApp tycon tys)       = unitNameSet (getName tycon) `unionNameSets` tyClsNamesOfTypes tys
1072 tyClsNamesOfType (NoteTy _ ty2)             = tyClsNamesOfType ty2
1073 tyClsNamesOfType (PredTy (IParam n ty))     = tyClsNamesOfType ty
1074 tyClsNamesOfType (PredTy (ClassP cl tys))   = unitNameSet (getName cl) `unionNameSets` tyClsNamesOfTypes tys
1075 tyClsNamesOfType (PredTy (EqPred ty1 ty2))  = tyClsNamesOfType ty1 `unionNameSets` tyClsNamesOfType ty2
1076 tyClsNamesOfType (FunTy arg res)            = tyClsNamesOfType arg `unionNameSets` tyClsNamesOfType res
1077 tyClsNamesOfType (AppTy fun arg)            = tyClsNamesOfType fun `unionNameSets` tyClsNamesOfType arg
1078 tyClsNamesOfType (ForAllTy tyvar ty)        = tyClsNamesOfType ty
1079
1080 tyClsNamesOfTypes tys = foldr (unionNameSets . tyClsNamesOfType) emptyNameSet tys
1081
1082 tyClsNamesOfDFunHead :: Type -> NameSet
1083 -- Find the free type constructors and classes
1084 -- of the head of the dfun instance type
1085 -- The 'dfun_head_type' is because of
1086 --      instance Foo a => Baz T where ...
1087 -- The decl is an orphan if Baz and T are both not locally defined,
1088 --      even if Foo *is* locally defined
1089 tyClsNamesOfDFunHead dfun_ty
1090   = case tcSplitSigmaTy dfun_ty of
1091         (tvs,_,head_ty) -> tyClsNamesOfType head_ty
1092
1093 classesOfTheta :: ThetaType -> [Class]
1094 -- Looks just for ClassP things; maybe it should check
1095 classesOfTheta preds = [ c | ClassP c _ <- preds ]
1096 \end{code}
1097
1098
1099 %************************************************************************
1100 %*                                                                      *
1101 \subsection[TysWiredIn-ext-type]{External types}
1102 %*                                                                      *
1103 %************************************************************************
1104
1105 The compiler's foreign function interface supports the passing of a
1106 restricted set of types as arguments and results (the restricting factor
1107 being the )
1108
1109 \begin{code}
1110 tcSplitIOType_maybe :: Type -> Maybe (TyCon, Type)
1111 -- (isIOType t) returns (Just (IO,t')) if t is of the form (IO t'), or
1112 --                                     some newtype wrapping thereof
1113 --              returns Nothing otherwise
1114 tcSplitIOType_maybe ty
1115   | Just (io_tycon, [io_res_ty]) <- tcSplitTyConApp_maybe ty,
1116         -- This split absolutely has to be a tcSplit, because we must
1117         -- see the IO type; and it's a newtype which is transparent to splitTyConApp.
1118     io_tycon `hasKey` ioTyConKey
1119   = Just (io_tycon, io_res_ty)
1120
1121   | Just ty' <- coreView ty     -- Look through non-recursive newtypes
1122   = tcSplitIOType_maybe ty'
1123
1124   | otherwise
1125   = Nothing
1126
1127 isFFITy :: Type -> Bool
1128 -- True for any TyCon that can possibly be an arg or result of an FFI call
1129 isFFITy ty = checkRepTyCon legalFFITyCon ty
1130
1131 isFFIArgumentTy :: DynFlags -> Safety -> Type -> Bool
1132 -- Checks for valid argument type for a 'foreign import'
1133 isFFIArgumentTy dflags safety ty
1134    = checkRepTyCon (legalOutgoingTyCon dflags safety) ty
1135
1136 isFFIExternalTy :: Type -> Bool
1137 -- Types that are allowed as arguments of a 'foreign export'
1138 isFFIExternalTy ty = checkRepTyCon legalFEArgTyCon ty
1139
1140 isFFIImportResultTy :: DynFlags -> Type -> Bool
1141 isFFIImportResultTy dflags ty
1142   = checkRepTyCon (legalFIResultTyCon dflags) ty
1143
1144 isFFIExportResultTy :: Type -> Bool
1145 isFFIExportResultTy ty = checkRepTyCon legalFEResultTyCon ty
1146
1147 isFFIDynArgumentTy :: Type -> Bool
1148 -- The argument type of a foreign import dynamic must be Ptr, FunPtr, Addr,
1149 -- or a newtype of either.
1150 isFFIDynArgumentTy = checkRepTyConKey [ptrTyConKey, funPtrTyConKey]
1151
1152 isFFIDynResultTy :: Type -> Bool
1153 -- The result type of a foreign export dynamic must be Ptr, FunPtr, Addr,
1154 -- or a newtype of either.
1155 isFFIDynResultTy = checkRepTyConKey [ptrTyConKey, funPtrTyConKey]
1156
1157 isFFILabelTy :: Type -> Bool
1158 -- The type of a foreign label must be Ptr, FunPtr, Addr,
1159 -- or a newtype of either.
1160 isFFILabelTy = checkRepTyConKey [ptrTyConKey, funPtrTyConKey]
1161
1162 isFFIDotnetTy :: DynFlags -> Type -> Bool
1163 isFFIDotnetTy dflags ty
1164   = checkRepTyCon (\ tc -> (legalFIResultTyCon dflags tc ||
1165                            isFFIDotnetObjTy ty || isStringTy ty)) ty
1166
1167 -- Support String as an argument or result from a .NET FFI call.
1168 isStringTy ty =
1169   case tcSplitTyConApp_maybe (repType ty) of
1170     Just (tc, [arg_ty])
1171       | tc == listTyCon ->
1172         case tcSplitTyConApp_maybe (repType arg_ty) of
1173           Just (cc,[]) -> cc == charTyCon
1174           _ -> False
1175     _ -> False
1176
1177 -- Support String as an argument or result from a .NET FFI call.
1178 isFFIDotnetObjTy ty =
1179   let
1180    (_, t_ty) = tcSplitForAllTys ty
1181   in
1182   case tcSplitTyConApp_maybe (repType t_ty) of
1183     Just (tc, [arg_ty]) | getName tc == objectTyConName -> True
1184     _ -> False
1185
1186 toDNType :: Type -> DNType
1187 toDNType ty
1188   | isStringTy ty = DNString
1189   | isFFIDotnetObjTy ty = DNObject
1190   | Just (tc,argTys) <- tcSplitTyConApp_maybe ty
1191   =  case lookup (getUnique tc) dn_assoc of
1192        Just x  -> x
1193        Nothing
1194          | tc `hasKey` ioTyConKey -> toDNType (head argTys)
1195          | otherwise -> pprPanic ("toDNType: unsupported .NET type")
1196                           (pprType ty <+> parens (hcat (map pprType argTys)) <+> ppr tc)
1197   | otherwise = panic "toDNType"        -- Is this right?
1198     where
1199       dn_assoc :: [ (Unique, DNType) ]
1200       dn_assoc = [ (unitTyConKey,   DNUnit)
1201                  , (intTyConKey,    DNInt)
1202                  , (int8TyConKey,   DNInt8)
1203                  , (int16TyConKey,  DNInt16)
1204                  , (int32TyConKey,  DNInt32)
1205                  , (int64TyConKey,  DNInt64)
1206                  , (wordTyConKey,   DNInt)
1207                  , (word8TyConKey,  DNWord8)
1208                  , (word16TyConKey, DNWord16)
1209                  , (word32TyConKey, DNWord32)
1210                  , (word64TyConKey, DNWord64)
1211                  , (floatTyConKey,  DNFloat)
1212                  , (doubleTyConKey, DNDouble)
1213                  , (ptrTyConKey,    DNPtr)
1214                  , (funPtrTyConKey, DNPtr)
1215                  , (charTyConKey,   DNChar)
1216                  , (boolTyConKey,   DNBool)
1217                  ]
1218
1219 checkRepTyCon :: (TyCon -> Bool) -> Type -> Bool
1220         -- Look through newtypes
1221         -- Non-recursive ones are transparent to splitTyConApp,
1222         -- but recursive ones aren't.  Manuel had:
1223         --      newtype T = MkT (Ptr T)
1224         -- and wanted it to work...
1225 checkRepTyCon check_tc ty
1226   | Just (tc,_) <- splitTyConApp_maybe (repType ty) = check_tc tc
1227   | otherwise                                       = False
1228
1229 checkRepTyConKey :: [Unique] -> Type -> Bool
1230 -- Like checkRepTyCon, but just looks at the TyCon key
1231 checkRepTyConKey keys
1232   = checkRepTyCon (\tc -> tyConUnique tc `elem` keys)
1233 \end{code}
1234
1235 ----------------------------------------------
1236 These chaps do the work; they are not exported
1237 ----------------------------------------------
1238
1239 \begin{code}
1240 legalFEArgTyCon :: TyCon -> Bool
1241 legalFEArgTyCon tc
1242   -- It's illegal to make foreign exports that take unboxed
1243   -- arguments.  The RTS API currently can't invoke such things.  --SDM 7/2000
1244   = boxedMarshalableTyCon tc
1245
1246 legalFIResultTyCon :: DynFlags -> TyCon -> Bool
1247 legalFIResultTyCon dflags tc
1248   | tc == unitTyCon         = True
1249   | otherwise               = marshalableTyCon dflags tc
1250
1251 legalFEResultTyCon :: TyCon -> Bool
1252 legalFEResultTyCon tc
1253   | tc == unitTyCon         = True
1254   | otherwise               = boxedMarshalableTyCon tc
1255
1256 legalOutgoingTyCon :: DynFlags -> Safety -> TyCon -> Bool
1257 -- Checks validity of types going from Haskell -> external world
1258 legalOutgoingTyCon dflags safety tc
1259   = marshalableTyCon dflags tc
1260
1261 legalFFITyCon :: TyCon -> Bool
1262 -- True for any TyCon that can possibly be an arg or result of an FFI call
1263 legalFFITyCon tc
1264   = isUnLiftedTyCon tc || boxedMarshalableTyCon tc || tc == unitTyCon
1265
1266 marshalableTyCon dflags tc
1267   =  (dopt Opt_GlasgowExts dflags && isUnLiftedTyCon tc)
1268   || boxedMarshalableTyCon tc
1269
1270 boxedMarshalableTyCon tc
1271    = getUnique tc `elem` [ intTyConKey, int8TyConKey, int16TyConKey
1272                          , int32TyConKey, int64TyConKey
1273                          , wordTyConKey, word8TyConKey, word16TyConKey
1274                          , word32TyConKey, word64TyConKey
1275                          , floatTyConKey, doubleTyConKey
1276                          , ptrTyConKey, funPtrTyConKey
1277                          , charTyConKey
1278                          , stablePtrTyConKey
1279                          , boolTyConKey
1280                          ]
1281 \end{code}