compiler/typecheck/TcType.lhs

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