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