2 % (c) The University of Glasgow 2006
3 % (c) The GRASP/AQUA Project, Glasgow University, 1992-1998
5 \section[TcType]{Types used in the typechecker}
7 This module provides the Type interface for front-end parts of the
10 * treat "source types" as opaque:
11 newtypes, and predicates are meaningful.
12 * look through usage types
14 The "tc" prefix is for "TypeChecker", because the type checker
15 is the principal client.
19 --------------------------------
21 TcType, TcSigmaType, TcRhoType, TcTauType, TcPredType, TcThetaType,
22 TcTyVar, TcTyVarSet, TcKind, TcCoVar,
24 --------------------------------
26 UserTypeCtxt(..), pprUserTypeCtxt,
27 TcTyVarDetails(..), pprTcTyVarDetails,
28 MetaDetails(Flexi, Indirect), MetaInfo(..),
29 SkolemInfo(..), pprSkolTvBinding, pprSkolInfo,
30 isImmutableTyVar, isSkolemTyVar, isMetaTyVar, isMetaTyVarTy,
31 isSigTyVar, isExistentialTyVar, isTyConableTyVar,
33 isFlexi, isIndirect, isUnkSkol, isRuntimeUnkSkol,
35 --------------------------------
39 --------------------------------
41 -- These are important because they do not look through newtypes
43 tcSplitForAllTys, tcSplitPhiTy, tcSplitPredFunTy_maybe,
44 tcSplitFunTy_maybe, tcSplitFunTys, tcFunArgTy, tcFunResultTy, tcSplitFunTysN,
45 tcSplitTyConApp, tcSplitTyConApp_maybe, tcTyConAppTyCon, tcTyConAppArgs,
46 tcSplitAppTy_maybe, tcSplitAppTy, tcSplitAppTys, repSplitAppTy_maybe,
47 tcInstHeadTyNotSynonym, tcInstHeadTyAppAllTyVars,
48 tcGetTyVar_maybe, tcGetTyVar,
49 tcSplitSigmaTy, tcDeepSplitSigmaTy_maybe,
51 ---------------------------------
53 -- Again, newtypes are opaque
54 tcEqType, tcEqTypes, tcEqPred, tcCmpType, tcCmpTypes, tcCmpPred, tcEqTypeX,
56 isSigmaTy, isOverloadedTy, isRigidTy,
57 isDoubleTy, isFloatTy, isIntTy, isWordTy, isStringTy,
58 isIntegerTy, isBoolTy, isUnitTy, isCharTy,
59 isTauTy, isTauTyCon, tcIsTyVarTy, tcIsForAllTy,
62 ---------------------------------
63 -- Misc type manipulators
65 tyClsNamesOfType, tyClsNamesOfDFunHead,
68 ---------------------------------
70 getClassPredTys_maybe, getClassPredTys,
71 isClassPred, isTyVarClassPred, isEqPred,
72 mkClassPred, mkIPPred, tcSplitPredTy_maybe,
74 isPredTy, isDictTy, isDictLikeTy,
75 tcSplitDFunTy, tcSplitDFunHead, predTyUnique,
77 isRefineableTy, isRefineablePred,
79 -- * Tidying type related things up for printing
81 tidyOpenType, tidyOpenTypes,
82 tidyTyVarBndr, tidyFreeTyVars,
83 tidyOpenTyVar, tidyOpenTyVars,
84 tidyTopType, tidyPred,
85 tidyKind, tidySkolemTyVar,
87 ---------------------------------
88 -- Foreign import and export
89 isFFIArgumentTy, -- :: DynFlags -> Safety -> Type -> Bool
90 isFFIImportResultTy, -- :: DynFlags -> Type -> Bool
91 isFFIExportResultTy, -- :: Type -> Bool
92 isFFIExternalTy, -- :: Type -> Bool
93 isFFIDynArgumentTy, -- :: Type -> Bool
94 isFFIDynResultTy, -- :: Type -> Bool
95 isFFIPrimArgumentTy, -- :: DynFlags -> Type -> Bool
96 isFFIPrimResultTy, -- :: DynFlags -> Type -> Bool
97 isFFILabelTy, -- :: Type -> Bool
98 isFFIDotnetTy, -- :: DynFlags -> Type -> Bool
99 isFFIDotnetObjTy, -- :: Type -> Bool
100 isFFITy, -- :: Type -> Bool
101 isFunPtrTy, -- :: Type -> Bool
102 tcSplitIOType_maybe, -- :: Type -> Maybe Type
104 --------------------------------
105 -- Rexported from Coercion
108 --------------------------------
109 -- Rexported from Type
110 Kind, -- Stuff to do with kinds is insensitive to pre/post Tc
111 unliftedTypeKind, liftedTypeKind, argTypeKind,
112 openTypeKind, mkArrowKind, mkArrowKinds,
113 isLiftedTypeKind, isUnliftedTypeKind, isSubOpenTypeKind,
114 isSubArgTypeKind, isSubKind, splitKindFunTys, defaultKind,
115 kindVarRef, mkKindVar,
117 Type, PredType(..), ThetaType,
118 mkForAllTy, mkForAllTys,
119 mkFunTy, mkFunTys, zipFunTys,
120 mkTyConApp, mkAppTy, mkAppTys, applyTy, applyTys,
121 mkTyVarTy, mkTyVarTys, mkTyConTy, mkPredTy, mkPredTys,
123 -- Type substitutions
124 TvSubst(..), -- Representation visible to a few friends
125 TvSubstEnv, emptyTvSubst, substEqSpec,
126 mkOpenTvSubst, zipOpenTvSubst, zipTopTvSubst,
127 mkTopTvSubst, notElemTvSubst, unionTvSubst,
128 getTvSubstEnv, setTvSubstEnv, getTvInScope, extendTvInScope, lookupTyVar,
129 extendTvSubst, extendTvSubstList, isInScope, mkTvSubst, zipTyEnv,
130 substTy, substTys, substTyWith, substTheta, substTyVar, substTyVars, substTyVarBndr,
132 isUnLiftedType, -- Source types are always lifted
133 isUnboxedTupleType, -- Ditto
136 tyVarsOfType, tyVarsOfTypes, tyVarsOfPred, tyVarsOfTheta,
137 tcTyVarsOfType, tcTyVarsOfTypes, tcTyVarsOfPred, exactTyVarsOfType,
140 pprKind, pprParendKind,
141 pprType, pprParendType, pprTypeApp, pprTyThingCategory,
142 pprPred, pprTheta, pprThetaArrow, pprClassPred
146 #include "HsVersions.h"
158 import HsExpr( HsMatchContext )
174 import Data.List( mapAccumL )
178 %************************************************************************
182 %************************************************************************
184 The type checker divides the generic Type world into the
185 following more structured beasts:
187 sigma ::= forall tyvars. phi
188 -- A sigma type is a qualified type
190 -- Note that even if 'tyvars' is empty, theta
191 -- may not be: e.g. (?x::Int) => Int
193 -- Note that 'sigma' is in prenex form:
194 -- all the foralls are at the front.
195 -- A 'phi' type has no foralls to the right of
203 -- A 'tau' type has no quantification anywhere
204 -- Note that the args of a type constructor must be taus
206 | tycon tau_1 .. tau_n
210 -- In all cases, a (saturated) type synonym application is legal,
211 -- provided it expands to the required form.
214 type TcTyVar = TyVar -- Used only during type inference
215 type TcCoVar = CoVar -- Used only during type inference; mutable
216 type TcType = Type -- A TcType can have mutable type variables
217 -- Invariant on ForAllTy in TcTypes:
219 -- a cannot occur inside a MutTyVar in T; that is,
220 -- T is "flattened" before quantifying over a
222 -- These types do not have boxy type variables in them
223 type TcPredType = PredType
224 type TcThetaType = ThetaType
225 type TcSigmaType = TcType
226 type TcRhoType = TcType
227 type TcTauType = TcType
229 type TcTyVarSet = TyVarSet
233 %************************************************************************
235 \subsection{TyVarDetails}
237 %************************************************************************
239 TyVarDetails gives extra info about type variables, used during type
240 checking. It's attached to mutable type variables only.
241 It's knot-tied back to Var.lhs. There is no reason in principle
242 why Var.lhs shouldn't actually have the definition, but it "belongs" here.
245 Note [Signature skolems]
246 ~~~~~~~~~~~~~~~~~~~~~~~~
251 (x,y,z) = ([y,z], z, head x)
253 Here, x and y have type sigs, which go into the environment. We used to
254 instantiate their types with skolem constants, and push those types into
255 the RHS, so we'd typecheck the RHS with type
257 where a*, b* are skolem constants, and c is an ordinary meta type varible.
259 The trouble is that the occurrences of z in the RHS force a* and b* to
260 be the *same*, so we can't make them into skolem constants that don't unify
261 with each other. Alas.
263 One solution would be insist that in the above defn the programmer uses
264 the same type variable in both type signatures. But that takes explanation.
266 The alternative (currently implemented) is to have a special kind of skolem
267 constant, SigTv, which can unify with other SigTvs. These are *not* treated
268 as righd for the purposes of GADTs. And they are used *only* for pattern
269 bindings and mutually recursive function bindings. See the function
270 TcBinds.tcInstSig, and its use_skols parameter.
274 -- A TyVarDetails is inside a TyVar
276 = SkolemTv SkolemInfo -- A skolem constant
279 -- The "skolem" obtained by flattening during
280 -- constraint simplification
282 -- In comments we will use the notation alpha[flat = ty]
283 -- to represent a flattening skolem variable alpha
284 -- identified with type ty.
286 | MetaTv MetaInfo (IORef MetaDetails)
289 = Flexi -- Flexi type variables unify to become Indirects
293 = TauTv -- This MetaTv is an ordinary unification variable
294 -- A TauTv is always filled in with a tau-type, which
295 -- never contains any ForAlls
297 | SigTv Name -- A variant of TauTv, except that it should not be
298 -- unified with a type, only with a type variable
299 -- SigTvs are only distinguished to improve error messages
300 -- see Note [Signature skolems]
301 -- The MetaDetails, if filled in, will
302 -- always be another SigTv or a SkolemTv
303 -- The Name is the name of the function from whose
304 -- type signature we got this skolem
306 | TcsTv -- A MetaTv allocated by the constraint solver
307 -- Its particular property is that it is always "touchable"
308 -- Nevertheless, the constraint solver has to try to guess
309 -- what type to instantiate it to
311 ----------------------------------
312 -- SkolemInfo describes a site where
313 -- a) type variables are skolemised
314 -- b) an implication constraint is generated
316 = SigSkol UserTypeCtxt -- A skolem that is created by instantiating
317 -- a programmer-supplied type signature
318 -- Location of the binding site is on the TyVar
320 -- The rest are for non-scoped skolems
321 | ClsSkol Class -- Bound at a class decl
322 | InstSkol -- Bound at an instance decl
323 | FamInstSkol -- Bound at a family instance decl
324 | PatSkol -- An existential type variable bound by a pattern for
325 DataCon -- a data constructor with an existential type.
326 (HsMatchContext Name)
327 -- e.g. data T = forall a. Eq a => MkT a
329 -- The pattern MkT x will allocate an existential type
332 | ArrowSkol -- An arrow form (see TcArrows)
334 | IPSkol [IPName Name] -- Binding site of an implicit parameter
336 | RuleSkol RuleName -- The LHS of a RULE
337 | GenSkol TcType -- Bound when doing a subsumption check for ty
339 | RuntimeUnkSkol -- a type variable used to represent an unknown
340 -- runtime type (used in the GHCi debugger)
342 | NoScSkol -- Used for the "self" superclass when solving
343 -- superclasses; don't generate superclasses of me
345 | UnkSkol -- Unhelpful info (until I improve it)
347 -------------------------------------
348 -- UserTypeCtxt describes the places where a
349 -- programmer-written type signature can occur
350 -- Like SkolemInfo, no location info
352 = FunSigCtxt Name -- Function type signature
353 -- Also used for types in SPECIALISE pragmas
354 | ExprSigCtxt -- Expression type signature
355 | ConArgCtxt Name -- Data constructor argument
356 | TySynCtxt Name -- RHS of a type synonym decl
357 | GenPatCtxt -- Pattern in generic decl
358 -- f{| a+b |} (Inl x) = ...
359 | LamPatSigCtxt -- Type sig in lambda pattern
361 | BindPatSigCtxt -- Type sig in pattern binding pattern
363 | ResSigCtxt -- Result type sig
365 | ForSigCtxt Name -- Foreign inport or export signature
366 | DefaultDeclCtxt -- Types in a default declaration
367 | SpecInstCtxt -- SPECIALISE instance pragma
368 | ThBrackCtxt -- Template Haskell type brackets [t| ... |]
370 -- Notes re TySynCtxt
371 -- We allow type synonyms that aren't types; e.g. type List = []
373 -- If the RHS mentions tyvars that aren't in scope, we'll
374 -- quantify over them:
375 -- e.g. type T = a->a
376 -- will become type T = forall a. a->a
378 -- With gla-exts that's right, but for H98 we should complain.
380 ---------------------------------
383 mkKindName :: Unique -> Name
384 mkKindName unique = mkSystemName unique kind_var_occ
386 kindVarRef :: KindVar -> IORef MetaDetails
388 ASSERT ( isTcTyVar tc )
389 case tcTyVarDetails tc of
390 MetaTv TauTv ref -> ref
391 _ -> pprPanic "kindVarRef" (ppr tc)
393 mkKindVar :: Unique -> IORef MetaDetails -> KindVar
395 = mkTcTyVar (mkKindName u)
396 tySuperKind -- not sure this is right,
397 -- do we need kind vars for
401 kind_var_occ :: OccName -- Just one for all KindVars
402 -- They may be jiggled by tidying
403 kind_var_occ = mkOccName tvName "k"
406 %************************************************************************
410 %************************************************************************
413 pprTcTyVarDetails :: TcTyVarDetails -> SDoc
415 pprTcTyVarDetails (SkolemTv _) = ptext (sLit "sk")
416 pprTcTyVarDetails (FlatSkol {}) = ptext (sLit "fsk")
417 pprTcTyVarDetails (MetaTv TauTv _) = ptext (sLit "tau")
418 pprTcTyVarDetails (MetaTv TcsTv _) = ptext (sLit "tcs")
419 pprTcTyVarDetails (MetaTv (SigTv _) _) = ptext (sLit "sig")
421 pprUserTypeCtxt :: UserTypeCtxt -> SDoc
422 pprUserTypeCtxt (FunSigCtxt n) = ptext (sLit "the type signature for") <+> quotes (ppr n)
423 pprUserTypeCtxt ExprSigCtxt = ptext (sLit "an expression type signature")
424 pprUserTypeCtxt (ConArgCtxt c) = ptext (sLit "the type of the constructor") <+> quotes (ppr c)
425 pprUserTypeCtxt (TySynCtxt c) = ptext (sLit "the RHS of the type synonym") <+> quotes (ppr c)
426 pprUserTypeCtxt GenPatCtxt = ptext (sLit "the type pattern of a generic definition")
427 pprUserTypeCtxt ThBrackCtxt = ptext (sLit "a Template Haskell quotation [t|...|]")
428 pprUserTypeCtxt LamPatSigCtxt = ptext (sLit "a pattern type signature")
429 pprUserTypeCtxt BindPatSigCtxt = ptext (sLit "a pattern type signature")
430 pprUserTypeCtxt ResSigCtxt = ptext (sLit "a result type signature")
431 pprUserTypeCtxt (ForSigCtxt n) = ptext (sLit "the foreign declaration for") <+> quotes (ppr n)
432 pprUserTypeCtxt DefaultDeclCtxt = ptext (sLit "a type in a `default' declaration")
433 pprUserTypeCtxt SpecInstCtxt = ptext (sLit "a SPECIALISE instance pragma")
435 pprSkolTvBinding :: TcTyVar -> SDoc
436 -- Print info about the binding of a skolem tyvar,
437 -- or nothing if we don't have anything useful to say
439 = ASSERT ( isTcTyVar tv )
440 quotes (ppr tv) <+> ppr_details (tcTyVarDetails tv)
442 ppr_details (SkolemTv info) = ppr_skol info
443 ppr_details (FlatSkol {}) = ptext (sLit "is a flattening type variable")
444 ppr_details (MetaTv (SigTv n) _) = ptext (sLit "is bound by the type signature for")
446 ppr_details (MetaTv _ _) = ptext (sLit "is a meta type variable")
448 ppr_skol UnkSkol = ptext (sLit "is an unknown type variable") -- Unhelpful
449 ppr_skol RuntimeUnkSkol = ptext (sLit "is an unknown runtime type")
450 ppr_skol info = sep [ptext (sLit "is a rigid type variable bound by"),
451 sep [pprSkolInfo info,
452 nest 2 (ptext (sLit "at") <+> ppr (getSrcLoc tv))]]
454 instance Outputable SkolemInfo where
457 pprSkolInfo :: SkolemInfo -> SDoc
458 -- Complete the sentence "is a rigid type variable bound by..."
459 pprSkolInfo (SigSkol ctxt) = pprUserTypeCtxt ctxt
460 pprSkolInfo (IPSkol ips) = ptext (sLit "the implicit-parameter bindings for")
461 <+> pprWithCommas ppr ips
462 pprSkolInfo (ClsSkol cls) = ptext (sLit "the class declaration for") <+> quotes (ppr cls)
463 pprSkolInfo InstSkol = ptext (sLit "the instance declaration")
464 pprSkolInfo NoScSkol = ptext (sLit "the instance declaration (self)")
465 pprSkolInfo FamInstSkol = ptext (sLit "the family instance declaration")
466 pprSkolInfo (RuleSkol name) = ptext (sLit "the RULE") <+> doubleQuotes (ftext name)
467 pprSkolInfo ArrowSkol = ptext (sLit "the arrow form")
468 pprSkolInfo (PatSkol dc _) = sep [ ptext (sLit "a pattern with constructor")
469 , ppr dc <+> dcolon <+> ppr (dataConUserType dc) ]
470 pprSkolInfo (GenSkol ty) = sep [ ptext (sLit "the polymorphic type")
474 -- For type variables the others are dealt with by pprSkolTvBinding.
475 -- For Insts, these cases should not happen
476 pprSkolInfo UnkSkol = WARN( True, text "pprSkolInfo: UnkSkol" ) ptext (sLit "UnkSkol")
477 pprSkolInfo RuntimeUnkSkol = WARN( True, text "pprSkolInfo: RuntimeUnkSkol" ) ptext (sLit "RuntimeUnkSkol")
479 instance Outputable MetaDetails where
480 ppr Flexi = ptext (sLit "Flexi")
481 ppr (Indirect ty) = ptext (sLit "Indirect") <+> ppr ty
485 %************************************************************************
487 \subsection{TidyType}
489 %************************************************************************
492 -- | This tidies up a type for printing in an error message, or in
493 -- an interface file.
495 -- It doesn't change the uniques at all, just the print names.
496 tidyTyVarBndr :: TidyEnv -> TyVar -> (TidyEnv, TyVar)
497 tidyTyVarBndr env@(tidy_env, subst) tyvar
498 = case tidyOccName tidy_env (getOccName name) of
499 (tidy', occ') -> ((tidy', subst'), tyvar'')
501 subst' = extendVarEnv subst tyvar tyvar''
502 tyvar' = setTyVarName tyvar name'
503 name' = tidyNameOcc name occ'
504 -- Don't forget to tidy the kind for coercions!
505 tyvar'' | isCoVar tyvar = setTyVarKind tyvar' kind'
507 kind' = tidyType env (tyVarKind tyvar)
509 name = tyVarName tyvar
512 tidyFreeTyVars :: TidyEnv -> TyVarSet -> TidyEnv
513 -- ^ Add the free 'TyVar's to the env in tidy form,
514 -- so that we can tidy the type they are free in
515 tidyFreeTyVars env tyvars = fst (tidyOpenTyVars env (varSetElems tyvars))
518 tidyOpenTyVars :: TidyEnv -> [TyVar] -> (TidyEnv, [TyVar])
519 tidyOpenTyVars env tyvars = mapAccumL tidyOpenTyVar env tyvars
522 tidyOpenTyVar :: TidyEnv -> TyVar -> (TidyEnv, TyVar)
523 -- ^ Treat a new 'TyVar' as a binder, and give it a fresh tidy name
524 -- using the environment if one has not already been allocated. See
525 -- also 'tidyTyVarBndr'
526 tidyOpenTyVar env@(_, subst) tyvar
527 = case lookupVarEnv subst tyvar of
528 Just tyvar' -> (env, tyvar') -- Already substituted
529 Nothing -> tidyTyVarBndr env tyvar -- Treat it as a binder
532 tidyType :: TidyEnv -> Type -> Type
533 tidyType env@(_, subst) ty
536 go (TyVarTy tv) = case lookupVarEnv subst tv of
538 Just tv' -> expand tv'
539 go (TyConApp tycon tys) = let args = map go tys
540 in args `seqList` TyConApp tycon args
541 go (PredTy sty) = PredTy (tidyPred env sty)
542 go (AppTy fun arg) = (AppTy $! (go fun)) $! (go arg)
543 go (FunTy fun arg) = (FunTy $! (go fun)) $! (go arg)
544 go (ForAllTy tv ty) = ForAllTy tvp $! (tidyType envp ty)
546 (envp, tvp) = tidyTyVarBndr env tv
548 -- Expand FlatSkols, the skolems introduced by flattening process
549 -- We don't want to show them in type error messages
550 expand tv | isTcTyVar tv
551 , FlatSkol ty <- tcTyVarDetails tv
557 tidyTypes :: TidyEnv -> [Type] -> [Type]
558 tidyTypes env tys = map (tidyType env) tys
561 tidyPred :: TidyEnv -> PredType -> PredType
562 tidyPred env (IParam n ty) = IParam n (tidyType env ty)
563 tidyPred env (ClassP clas tys) = ClassP clas (tidyTypes env tys)
564 tidyPred env (EqPred ty1 ty2) = EqPred (tidyType env ty1) (tidyType env ty2)
567 -- | Grabs the free type variables, tidies them
568 -- and then uses 'tidyType' to work over the type itself
569 tidyOpenType :: TidyEnv -> Type -> (TidyEnv, Type)
571 = (env', tidyType env' ty)
573 env' = tidyFreeTyVars env (tyVarsOfType ty)
576 tidyOpenTypes :: TidyEnv -> [Type] -> (TidyEnv, [Type])
577 tidyOpenTypes env tys = mapAccumL tidyOpenType env tys
580 -- | Calls 'tidyType' on a top-level type (i.e. with an empty tidying environment)
581 tidyTopType :: Type -> Type
582 tidyTopType ty = tidyType emptyTidyEnv ty
585 tidySkolemTyVar :: TidyEnv -> TcTyVar -> (TidyEnv, TcTyVar)
586 -- Tidy the type inside a GenSkol, preparatory to printing it
587 tidySkolemTyVar env tv
588 = ASSERT( isTcTyVar tv && (isSkolemTyVar tv || isSigTyVar tv ) )
589 (env1, mkTcTyVar (tyVarName tv) (tyVarKind tv) info1)
591 (env1, info1) = case tcTyVarDetails tv of
592 SkolemTv info -> (env1, SkolemTv info')
594 (env1, info') = tidy_skol_info env info
597 tidy_skol_info env (GenSkol ty) = (env1, GenSkol ty1)
599 (env1, ty1) = tidyOpenType env ty
600 tidy_skol_info env info = (env, info)
603 tidyKind :: TidyEnv -> Kind -> (TidyEnv, Kind)
604 tidyKind env k = tidyOpenType env k
608 %************************************************************************
612 %************************************************************************
615 isImmutableTyVar :: TyVar -> Bool
618 | isTcTyVar tv = isSkolemTyVar tv
621 isTyConableTyVar, isSkolemTyVar, isExistentialTyVar,
622 isMetaTyVar :: TcTyVar -> Bool
625 -- True of a meta-type variable that can be filled in
626 -- with a type constructor application; in particular,
628 = ASSERT( isTcTyVar tv)
629 case tcTyVarDetails tv of
630 MetaTv (SigTv _) _ -> False
634 = ASSERT2( isTcTyVar tv, ppr tv )
635 case tcTyVarDetails tv of
640 isExistentialTyVar tv -- Existential type variable, bound by a pattern
641 = ASSERT( isTcTyVar tv )
642 case tcTyVarDetails tv of
643 SkolemTv (PatSkol {}) -> True
647 = ASSERT2( isTcTyVar tv, ppr tv )
648 case tcTyVarDetails tv of
652 isMetaTyVarTy :: TcType -> Bool
653 isMetaTyVarTy (TyVarTy tv) = isMetaTyVar tv
654 isMetaTyVarTy _ = False
656 isSigTyVar :: Var -> Bool
658 = ASSERT( isTcTyVar tv )
659 case tcTyVarDetails tv of
660 MetaTv (SigTv _) _ -> True
663 metaTvRef :: TyVar -> IORef MetaDetails
665 = ASSERT2( isTcTyVar tv, ppr tv )
666 case tcTyVarDetails tv of
668 _ -> pprPanic "metaTvRef" (ppr tv)
670 isFlexi, isIndirect :: MetaDetails -> Bool
674 isIndirect (Indirect _) = True
677 isRuntimeUnkSkol :: TyVar -> Bool
678 -- Called only in TcErrors; see Note [Runtime skolems] there
679 isRuntimeUnkSkol x | isTcTyVar x
680 , SkolemTv RuntimeUnkSkol <- tcTyVarDetails x
684 isUnkSkol :: TyVar -> Bool
685 isUnkSkol x | isTcTyVar x
686 , SkolemTv UnkSkol <- tcTyVarDetails x = True
691 %************************************************************************
693 \subsection{Tau, sigma and rho}
695 %************************************************************************
698 mkSigmaTy :: [TyVar] -> [PredType] -> Type -> Type
699 mkSigmaTy tyvars theta tau = mkForAllTys tyvars (mkPhiTy theta tau)
701 mkPhiTy :: [PredType] -> Type -> Type
702 mkPhiTy theta ty = foldr (\p r -> mkFunTy (mkPredTy p) r) ty theta
705 @isTauTy@ tests for nested for-alls. It should not be called on a boxy type.
708 isTauTy :: Type -> Bool
709 isTauTy ty | Just ty' <- tcView ty = isTauTy ty'
710 isTauTy (TyVarTy _) = True
711 isTauTy (TyConApp tc tys) = all isTauTy tys && isTauTyCon tc
712 isTauTy (AppTy a b) = isTauTy a && isTauTy b
713 isTauTy (FunTy a b) = isTauTy a && isTauTy b
714 isTauTy (PredTy _) = True -- Don't look through source types
718 isTauTyCon :: TyCon -> Bool
719 -- Returns False for type synonyms whose expansion is a polytype
721 | isClosedSynTyCon tc = isTauTy (snd (synTyConDefn tc))
725 isRigidTy :: TcType -> Bool
726 -- A type is rigid if it has no meta type variables in it
727 isRigidTy ty = all isImmutableTyVar (varSetElems (tcTyVarsOfType ty))
729 isRefineableTy :: TcType -> (Bool,Bool)
730 -- A type should have type refinements applied to it if it has
731 -- free type variables, and they are all rigid
732 isRefineableTy ty = (null tc_tvs, all isImmutableTyVar tc_tvs)
734 tc_tvs = varSetElems (tcTyVarsOfType ty)
736 isRefineablePred :: TcPredType -> Bool
737 isRefineablePred pred = not (null tc_tvs) && all isImmutableTyVar tc_tvs
739 tc_tvs = varSetElems (tcTyVarsOfPred pred)
742 getDFunTyKey :: Type -> OccName -- Get some string from a type, to be used to
743 -- construct a dictionary function name
744 getDFunTyKey ty | Just ty' <- tcView ty = getDFunTyKey ty'
745 getDFunTyKey (TyVarTy tv) = getOccName tv
746 getDFunTyKey (TyConApp tc _) = getOccName tc
747 getDFunTyKey (AppTy fun _) = getDFunTyKey fun
748 getDFunTyKey (FunTy _ _) = getOccName funTyCon
749 getDFunTyKey (ForAllTy _ t) = getDFunTyKey t
750 getDFunTyKey ty = pprPanic "getDFunTyKey" (pprType ty)
751 -- PredTy shouldn't happen
755 %************************************************************************
757 \subsection{Expanding and splitting}
759 %************************************************************************
761 These tcSplit functions are like their non-Tc analogues, but
762 a) they do not look through newtypes
763 b) they do not look through PredTys
765 However, they are non-monadic and do not follow through mutable type
766 variables. It's up to you to make sure this doesn't matter.
769 tcSplitForAllTys :: Type -> ([TyVar], Type)
770 tcSplitForAllTys ty = split ty ty []
772 split orig_ty ty tvs | Just ty' <- tcView ty = split orig_ty ty' tvs
773 split _ (ForAllTy tv ty) tvs
774 | not (isCoVar tv) = split ty ty (tv:tvs)
775 split orig_ty _ tvs = (reverse tvs, orig_ty)
777 tcIsForAllTy :: Type -> Bool
778 tcIsForAllTy ty | Just ty' <- tcView ty = tcIsForAllTy ty'
779 tcIsForAllTy (ForAllTy tv _) = not (isCoVar tv)
780 tcIsForAllTy _ = False
782 tcSplitPredFunTy_maybe :: Type -> Maybe (PredType, Type)
783 -- Split off the first predicate argument from a type
784 tcSplitPredFunTy_maybe ty | Just ty' <- tcView ty = tcSplitPredFunTy_maybe ty'
785 tcSplitPredFunTy_maybe (ForAllTy tv ty)
786 | isCoVar tv = Just (coVarPred tv, ty)
787 tcSplitPredFunTy_maybe (FunTy arg res)
788 | Just p <- tcSplitPredTy_maybe arg = Just (p, res)
789 tcSplitPredFunTy_maybe _
792 tcSplitPhiTy :: Type -> (ThetaType, Type)
797 = case tcSplitPredFunTy_maybe ty of
798 Just (pred, ty) -> split ty (pred:ts)
799 Nothing -> (reverse ts, ty)
801 tcSplitSigmaTy :: Type -> ([TyVar], ThetaType, Type)
802 tcSplitSigmaTy ty = case tcSplitForAllTys ty of
803 (tvs, rho) -> case tcSplitPhiTy rho of
804 (theta, tau) -> (tvs, theta, tau)
806 -----------------------
807 tcDeepSplitSigmaTy_maybe
808 :: TcSigmaType -> Maybe ([TcType], [TyVar], ThetaType, TcSigmaType)
809 -- Looks for a *non-trivial* quantified type, under zero or more function arrows
810 -- By "non-trivial" we mean either tyvars or constraints are non-empty
812 tcDeepSplitSigmaTy_maybe ty
813 | Just (arg_ty, res_ty) <- tcSplitFunTy_maybe ty
814 , Just (arg_tys, tvs, theta, rho) <- tcDeepSplitSigmaTy_maybe res_ty
815 = Just (arg_ty:arg_tys, tvs, theta, rho)
817 | (tvs, theta, rho) <- tcSplitSigmaTy ty
818 , not (null tvs && null theta)
819 = Just ([], tvs, theta, rho)
821 | otherwise = Nothing
823 -----------------------
824 tcTyConAppTyCon :: Type -> TyCon
825 tcTyConAppTyCon ty = case tcSplitTyConApp_maybe ty of
827 Nothing -> pprPanic "tcTyConAppTyCon" (pprType ty)
829 tcTyConAppArgs :: Type -> [Type]
830 tcTyConAppArgs ty = case tcSplitTyConApp_maybe ty of
831 Just (_, args) -> args
832 Nothing -> pprPanic "tcTyConAppArgs" (pprType ty)
834 tcSplitTyConApp :: Type -> (TyCon, [Type])
835 tcSplitTyConApp ty = case tcSplitTyConApp_maybe ty of
837 Nothing -> pprPanic "tcSplitTyConApp" (pprType ty)
839 tcSplitTyConApp_maybe :: Type -> Maybe (TyCon, [Type])
840 tcSplitTyConApp_maybe ty | Just ty' <- tcView ty = tcSplitTyConApp_maybe ty'
841 tcSplitTyConApp_maybe (TyConApp tc tys) = Just (tc, tys)
842 tcSplitTyConApp_maybe (FunTy arg res) = Just (funTyCon, [arg,res])
843 -- Newtypes are opaque, so they may be split
844 -- However, predicates are not treated
845 -- as tycon applications by the type checker
846 tcSplitTyConApp_maybe _ = Nothing
848 -----------------------
849 tcSplitFunTys :: Type -> ([Type], Type)
850 tcSplitFunTys ty = case tcSplitFunTy_maybe ty of
852 Just (arg,res) -> (arg:args, res')
854 (args,res') = tcSplitFunTys res
856 tcSplitFunTy_maybe :: Type -> Maybe (Type, Type)
857 tcSplitFunTy_maybe ty | Just ty' <- tcView ty = tcSplitFunTy_maybe ty'
858 tcSplitFunTy_maybe (FunTy arg res) | not (isPredTy arg) = Just (arg, res)
859 tcSplitFunTy_maybe _ = Nothing
860 -- Note the (not (isPredTy arg)) guard
861 -- Consider (?x::Int) => Bool
862 -- We don't want to treat this as a function type!
863 -- A concrete example is test tc230:
864 -- f :: () -> (?p :: ()) => () -> ()
870 -> Arity -- N: Number of desired args
871 -> ([TcSigmaType], -- Arg types (N or fewer)
872 TcSigmaType) -- The rest of the type
874 tcSplitFunTysN ty n_args
877 | Just (arg,res) <- tcSplitFunTy_maybe ty
878 = case tcSplitFunTysN res (n_args - 1) of
879 (args, res) -> (arg:args, res)
883 tcSplitFunTy :: Type -> (Type, Type)
884 tcSplitFunTy ty = expectJust "tcSplitFunTy" (tcSplitFunTy_maybe ty)
886 tcFunArgTy :: Type -> Type
887 tcFunArgTy ty = fst (tcSplitFunTy ty)
889 tcFunResultTy :: Type -> Type
890 tcFunResultTy ty = snd (tcSplitFunTy ty)
892 -----------------------
893 tcSplitAppTy_maybe :: Type -> Maybe (Type, Type)
894 tcSplitAppTy_maybe ty | Just ty' <- tcView ty = tcSplitAppTy_maybe ty'
895 tcSplitAppTy_maybe ty = repSplitAppTy_maybe ty
897 tcSplitAppTy :: Type -> (Type, Type)
898 tcSplitAppTy ty = case tcSplitAppTy_maybe ty of
900 Nothing -> pprPanic "tcSplitAppTy" (pprType ty)
902 tcSplitAppTys :: Type -> (Type, [Type])
906 go ty args = case tcSplitAppTy_maybe ty of
907 Just (ty', arg) -> go ty' (arg:args)
910 -----------------------
911 tcGetTyVar_maybe :: Type -> Maybe TyVar
912 tcGetTyVar_maybe ty | Just ty' <- tcView ty = tcGetTyVar_maybe ty'
913 tcGetTyVar_maybe (TyVarTy tv) = Just tv
914 tcGetTyVar_maybe _ = Nothing
916 tcGetTyVar :: String -> Type -> TyVar
917 tcGetTyVar msg ty = expectJust msg (tcGetTyVar_maybe ty)
919 tcIsTyVarTy :: Type -> Bool
920 tcIsTyVarTy ty = maybeToBool (tcGetTyVar_maybe ty)
922 -----------------------
923 tcSplitDFunTy :: Type -> ([TyVar], Class, [Type])
924 -- Split the type of a dictionary function
925 -- We don't use tcSplitSigmaTy, because a DFun may (with NDP)
926 -- have non-Pred arguments, such as
927 -- df :: forall m. (forall b. Eq b => Eq (m b)) -> C m
929 = case tcSplitForAllTys ty of { (tvs, rho) ->
930 case tcSplitDFunHead (drop_pred_tys rho) of { (clas, tys) ->
933 -- Discard the context of the dfun. This can be a mix of
934 -- coercion and class constraints; or (in the general NDP case)
935 -- some other function argument
936 drop_pred_tys ty | Just ty' <- tcView ty = drop_pred_tys ty'
937 drop_pred_tys (ForAllTy tv ty) = ASSERT( isCoVar tv ) drop_pred_tys ty
938 drop_pred_tys (FunTy _ ty) = drop_pred_tys ty
939 drop_pred_tys ty = ty
941 tcSplitDFunHead :: Type -> (Class, [Type])
943 = case tcSplitPredTy_maybe tau of
944 Just (ClassP clas tys) -> (clas, tys)
945 _ -> pprPanic "tcSplitDFunHead" (ppr tau)
947 tcInstHeadTyNotSynonym :: Type -> Bool
948 -- Used in Haskell-98 mode, for the argument types of an instance head
949 -- These must not be type synonyms, but everywhere else type synonyms
950 -- are transparent, so we need a special function here
951 tcInstHeadTyNotSynonym ty
953 TyConApp tc _ -> not (isSynTyCon tc)
956 tcInstHeadTyAppAllTyVars :: Type -> Bool
957 -- Used in Haskell-98 mode, for the argument types of an instance head
958 -- These must be a constructor applied to type variable arguments
959 tcInstHeadTyAppAllTyVars ty
961 TyConApp _ tys -> ok tys
962 FunTy arg res -> ok [arg, res]
965 -- Check that all the types are type variables,
966 -- and that each is distinct
967 ok tys = equalLength tvs tys && hasNoDups tvs
969 tvs = mapCatMaybes get_tv tys
971 get_tv (TyVarTy tv) = Just tv -- through synonyms
977 %************************************************************************
979 \subsection{Predicate types}
981 %************************************************************************
984 evVarPred :: EvVar -> PredType
986 = case tcSplitPredTy_maybe (varType var) of
988 Nothing -> pprPanic "evVarPred" (ppr var <+> ppr (varType var))
990 tcSplitPredTy_maybe :: Type -> Maybe PredType
991 -- Returns Just for predicates only
992 tcSplitPredTy_maybe ty | Just ty' <- tcView ty = tcSplitPredTy_maybe ty'
993 tcSplitPredTy_maybe (PredTy p) = Just p
994 tcSplitPredTy_maybe _ = Nothing
996 predTyUnique :: PredType -> Unique
997 predTyUnique (IParam n _) = getUnique (ipNameName n)
998 predTyUnique (ClassP clas _) = getUnique clas
999 predTyUnique (EqPred a b) = pprPanic "predTyUnique" (ppr (EqPred a b))
1003 --------------------- Dictionary types ---------------------------------
1006 mkClassPred :: Class -> [Type] -> PredType
1007 mkClassPred clas tys = ClassP clas tys
1009 isClassPred :: PredType -> Bool
1010 isClassPred (ClassP _ _) = True
1011 isClassPred _ = False
1013 isTyVarClassPred :: PredType -> Bool
1014 isTyVarClassPred (ClassP _ tys) = all tcIsTyVarTy tys
1015 isTyVarClassPred _ = False
1017 getClassPredTys_maybe :: PredType -> Maybe (Class, [Type])
1018 getClassPredTys_maybe (ClassP clas tys) = Just (clas, tys)
1019 getClassPredTys_maybe _ = Nothing
1021 getClassPredTys :: PredType -> (Class, [Type])
1022 getClassPredTys (ClassP clas tys) = (clas, tys)
1023 getClassPredTys _ = panic "getClassPredTys"
1025 mkDictTy :: Class -> [Type] -> Type
1026 mkDictTy clas tys = mkPredTy (ClassP clas tys)
1030 isDictLikeTy :: Type -> Bool
1031 -- Note [Dictionary-like types]
1032 isDictLikeTy ty | Just ty' <- tcView ty = isDictTy ty'
1033 isDictLikeTy (PredTy p) = isClassPred p
1034 isDictLikeTy (TyConApp tc tys)
1035 | isTupleTyCon tc = all isDictLikeTy tys
1036 isDictLikeTy _ = False
1039 Note [Dictionary-like types]
1040 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1041 Being "dictionary-like" means either a dictionary type or a tuple thereof.
1042 In GHC 6.10 we build implication constraints which construct such tuples,
1043 and if we land up with a binding
1044 t :: (C [a], Eq [a])
1046 then we want to treat t as cheap under "-fdicts-cheap" for example.
1047 (Implication constraints are normally inlined, but sadly not if the
1048 occurrence is itself inside an INLINE function! Until we revise the
1049 handling of implication constraints, that is.) This turned out to
1050 be important in getting good arities in DPH code. Example:
1053 class D a where { foo :: a -> a }
1054 instance C a => D (Maybe a) where { foo x = x }
1056 bar :: (C a, C b) => a -> b -> (Maybe a, Maybe b)
1058 bar x y = (foo (Just x), foo (Just y))
1060 Then 'bar' should jolly well have arity 4 (two dicts, two args), but
1061 we ended up with something like
1062 bar = __inline_me__ (\d1,d2. let t :: (D (Maybe a), D (Maybe b)) = ...
1065 This is all a bit ad-hoc; eg it relies on knowing that implication
1066 constraints build tuples.
1068 --------------------- Implicit parameters ---------------------------------
1071 mkIPPred :: IPName Name -> Type -> PredType
1072 mkIPPred ip ty = IParam ip ty
1074 isIPPred :: PredType -> Bool
1075 isIPPred (IParam _ _) = True
1079 --------------------- Equality predicates ---------------------------------
1081 substEqSpec :: TvSubst -> [(TyVar,Type)] -> [(TcType,TcType)]
1082 substEqSpec subst eq_spec = [ (substTyVar subst tv, substTy subst ty)
1083 | (tv,ty) <- eq_spec]
1087 %************************************************************************
1089 \subsection{Predicates}
1091 %************************************************************************
1093 isSigmaTy returns true of any qualified type. It doesn't *necessarily* have
1095 f :: (?x::Int) => Int -> Int
1098 isSigmaTy :: Type -> Bool
1099 isSigmaTy ty | Just ty' <- tcView ty = isSigmaTy ty'
1100 isSigmaTy (ForAllTy _ _) = True
1101 isSigmaTy (FunTy a _) = isPredTy a
1104 isOverloadedTy :: Type -> Bool
1105 -- Yes for a type of a function that might require evidence-passing
1106 -- Used only by bindLocalMethods
1107 -- NB: be sure to check for type with an equality predicate; hence isCoVar
1108 isOverloadedTy ty | Just ty' <- tcView ty = isOverloadedTy ty'
1109 isOverloadedTy (ForAllTy tv ty) = isCoVar tv || isOverloadedTy ty
1110 isOverloadedTy (FunTy a _) = isPredTy a
1111 isOverloadedTy _ = False
1113 isPredTy :: Type -> Bool -- Belongs in TcType because it does
1114 -- not look through newtypes, or predtypes (of course)
1115 isPredTy ty | Just ty' <- tcView ty = isPredTy ty'
1116 isPredTy (PredTy _) = True
1121 isFloatTy, isDoubleTy, isIntegerTy, isIntTy, isWordTy, isBoolTy,
1122 isUnitTy, isCharTy :: Type -> Bool
1123 isFloatTy = is_tc floatTyConKey
1124 isDoubleTy = is_tc doubleTyConKey
1125 isIntegerTy = is_tc integerTyConKey
1126 isIntTy = is_tc intTyConKey
1127 isWordTy = is_tc wordTyConKey
1128 isBoolTy = is_tc boolTyConKey
1129 isUnitTy = is_tc unitTyConKey
1130 isCharTy = is_tc charTyConKey
1132 isStringTy :: Type -> Bool
1134 = case tcSplitTyConApp_maybe ty of
1135 Just (tc, [arg_ty]) -> tc == listTyCon && isCharTy arg_ty
1138 is_tc :: Unique -> Type -> Bool
1139 -- Newtypes are opaque to this
1140 is_tc uniq ty = case tcSplitTyConApp_maybe ty of
1141 Just (tc, _) -> uniq == getUnique tc
1146 -- NB: Currently used in places where we have already expanded type synonyms;
1147 -- hence no 'coreView'. This could, however, be changed without breaking
1149 isSynFamilyTyConApp :: TcTauType -> Bool
1150 isSynFamilyTyConApp (TyConApp tc tys) = isSynFamilyTyCon tc &&
1151 length tys == tyConArity tc
1152 isSynFamilyTyConApp _other = False
1156 %************************************************************************
1160 %************************************************************************
1163 deNoteType :: Type -> Type
1164 -- Remove all *outermost* type synonyms and other notes
1165 deNoteType ty | Just ty' <- tcView ty = deNoteType ty'
1170 tcTyVarsOfType :: Type -> TcTyVarSet
1171 -- Just the *TcTyVars* free in the type
1172 -- (Types.tyVarsOfTypes finds all free TyVars)
1173 tcTyVarsOfType (TyVarTy tv) = if isTcTyVar tv then unitVarSet tv
1175 tcTyVarsOfType (TyConApp _ tys) = tcTyVarsOfTypes tys
1176 tcTyVarsOfType (PredTy sty) = tcTyVarsOfPred sty
1177 tcTyVarsOfType (FunTy arg res) = tcTyVarsOfType arg `unionVarSet` tcTyVarsOfType res
1178 tcTyVarsOfType (AppTy fun arg) = tcTyVarsOfType fun `unionVarSet` tcTyVarsOfType arg
1179 tcTyVarsOfType (ForAllTy tyvar ty) = (tcTyVarsOfType ty `delVarSet` tyvar)
1180 `unionVarSet` tcTyVarsOfTyVar tyvar
1181 -- We do sometimes quantify over skolem TcTyVars
1183 tcTyVarsOfTyVar :: TcTyVar -> TyVarSet
1184 tcTyVarsOfTyVar tv | isCoVar tv = tcTyVarsOfType (tyVarKind tv)
1185 | otherwise = emptyVarSet
1187 tcTyVarsOfTypes :: [Type] -> TyVarSet
1188 tcTyVarsOfTypes tys = foldr (unionVarSet.tcTyVarsOfType) emptyVarSet tys
1190 tcTyVarsOfPred :: PredType -> TyVarSet
1191 tcTyVarsOfPred (IParam _ ty) = tcTyVarsOfType ty
1192 tcTyVarsOfPred (ClassP _ tys) = tcTyVarsOfTypes tys
1193 tcTyVarsOfPred (EqPred ty1 ty2) = tcTyVarsOfType ty1 `unionVarSet` tcTyVarsOfType ty2
1196 Note [Silly type synonym]
1197 ~~~~~~~~~~~~~~~~~~~~~~~~~
1200 What are the free tyvars of (T x)? Empty, of course!
1201 Here's the example that Ralf Laemmel showed me:
1202 foo :: (forall a. C u a -> C u a) -> u
1203 mappend :: Monoid u => u -> u -> u
1205 bar :: Monoid u => u
1206 bar = foo (\t -> t `mappend` t)
1207 We have to generalise at the arg to f, and we don't
1208 want to capture the constraint (Monad (C u a)) because
1209 it appears to mention a. Pretty silly, but it was useful to him.
1211 exactTyVarsOfType is used by the type checker to figure out exactly
1212 which type variables are mentioned in a type. It's also used in the
1213 smart-app checking code --- see TcExpr.tcIdApp
1215 On the other hand, consider a *top-level* definition
1216 f = (\x -> x) :: T a -> T a
1217 If we don't abstract over 'a' it'll get fixed to GHC.Prim.Any, and then
1218 if we have an application like (f "x") we get a confusing error message
1219 involving Any. So the conclusion is this: when generalising
1220 - at top level use tyVarsOfType
1221 - in nested bindings use exactTyVarsOfType
1222 See Trac #1813 for example.
1225 exactTyVarsOfType :: TcType -> TyVarSet
1226 -- Find the free type variables (of any kind)
1227 -- but *expand* type synonyms. See Note [Silly type synonym] above.
1228 exactTyVarsOfType ty
1231 go ty | Just ty' <- tcView ty = go ty' -- This is the key line
1232 go (TyVarTy tv) = unitVarSet tv
1233 go (TyConApp _ tys) = exactTyVarsOfTypes tys
1234 go (PredTy ty) = go_pred ty
1235 go (FunTy arg res) = go arg `unionVarSet` go res
1236 go (AppTy fun arg) = go fun `unionVarSet` go arg
1237 go (ForAllTy tyvar ty) = delVarSet (go ty) tyvar
1238 `unionVarSet` go_tv tyvar
1240 go_pred (IParam _ ty) = go ty
1241 go_pred (ClassP _ tys) = exactTyVarsOfTypes tys
1242 go_pred (EqPred ty1 ty2) = go ty1 `unionVarSet` go ty2
1244 go_tv tyvar | isCoVar tyvar = go (tyVarKind tyvar)
1245 | otherwise = emptyVarSet
1247 exactTyVarsOfTypes :: [TcType] -> TyVarSet
1248 exactTyVarsOfTypes tys = foldr (unionVarSet . exactTyVarsOfType) emptyVarSet tys
1251 Find the free tycons and classes of a type. This is used in the front
1252 end of the compiler.
1255 tyClsNamesOfType :: Type -> NameSet
1256 tyClsNamesOfType (TyVarTy _) = emptyNameSet
1257 tyClsNamesOfType (TyConApp tycon tys) = unitNameSet (getName tycon) `unionNameSets` tyClsNamesOfTypes tys
1258 tyClsNamesOfType (PredTy (IParam _ ty)) = tyClsNamesOfType ty
1259 tyClsNamesOfType (PredTy (ClassP cl tys)) = unitNameSet (getName cl) `unionNameSets` tyClsNamesOfTypes tys
1260 tyClsNamesOfType (PredTy (EqPred ty1 ty2)) = tyClsNamesOfType ty1 `unionNameSets` tyClsNamesOfType ty2
1261 tyClsNamesOfType (FunTy arg res) = tyClsNamesOfType arg `unionNameSets` tyClsNamesOfType res
1262 tyClsNamesOfType (AppTy fun arg) = tyClsNamesOfType fun `unionNameSets` tyClsNamesOfType arg
1263 tyClsNamesOfType (ForAllTy _ ty) = tyClsNamesOfType ty
1265 tyClsNamesOfTypes :: [Type] -> NameSet
1266 tyClsNamesOfTypes tys = foldr (unionNameSets . tyClsNamesOfType) emptyNameSet tys
1268 tyClsNamesOfDFunHead :: Type -> NameSet
1269 -- Find the free type constructors and classes
1270 -- of the head of the dfun instance type
1271 -- The 'dfun_head_type' is because of
1272 -- instance Foo a => Baz T where ...
1273 -- The decl is an orphan if Baz and T are both not locally defined,
1274 -- even if Foo *is* locally defined
1275 tyClsNamesOfDFunHead dfun_ty
1276 = case tcSplitSigmaTy dfun_ty of
1277 (_, _, head_ty) -> tyClsNamesOfType head_ty
1281 %************************************************************************
1283 \subsection[TysWiredIn-ext-type]{External types}
1285 %************************************************************************
1287 The compiler's foreign function interface supports the passing of a
1288 restricted set of types as arguments and results (the restricting factor
1292 tcSplitIOType_maybe :: Type -> Maybe (TyCon, Type, CoercionI)
1293 -- (isIOType t) returns Just (IO,t',co)
1294 -- if co : t ~ IO t'
1295 -- returns Nothing otherwise
1296 tcSplitIOType_maybe ty
1297 = case tcSplitTyConApp_maybe ty of
1298 -- This split absolutely has to be a tcSplit, because we must
1299 -- see the IO type; and it's a newtype which is transparent to splitTyConApp.
1301 Just (io_tycon, [io_res_ty])
1302 | io_tycon `hasKey` ioTyConKey
1303 -> Just (io_tycon, io_res_ty, IdCo ty)
1306 | not (isRecursiveTyCon tc)
1307 , Just (ty, co1) <- instNewTyCon_maybe tc tys
1308 -- Newtypes that require a coercion are ok
1309 -> case tcSplitIOType_maybe ty of
1311 Just (tc, ty', co2) -> Just (tc, ty', co1 `mkTransCoI` co2)
1315 isFFITy :: Type -> Bool
1316 -- True for any TyCon that can possibly be an arg or result of an FFI call
1317 isFFITy ty = checkRepTyCon legalFFITyCon ty
1319 isFFIArgumentTy :: DynFlags -> Safety -> Type -> Bool
1320 -- Checks for valid argument type for a 'foreign import'
1321 isFFIArgumentTy dflags safety ty
1322 = checkRepTyCon (legalOutgoingTyCon dflags safety) ty
1324 isFFIExternalTy :: Type -> Bool
1325 -- Types that are allowed as arguments of a 'foreign export'
1326 isFFIExternalTy ty = checkRepTyCon legalFEArgTyCon ty
1328 isFFIImportResultTy :: DynFlags -> Type -> Bool
1329 isFFIImportResultTy dflags ty
1330 = checkRepTyCon (legalFIResultTyCon dflags) ty
1332 isFFIExportResultTy :: Type -> Bool
1333 isFFIExportResultTy ty = checkRepTyCon legalFEResultTyCon ty
1335 isFFIDynArgumentTy :: Type -> Bool
1336 -- The argument type of a foreign import dynamic must be Ptr, FunPtr, Addr,
1337 -- or a newtype of either.
1338 isFFIDynArgumentTy = checkRepTyConKey [ptrTyConKey, funPtrTyConKey]
1340 isFFIDynResultTy :: Type -> Bool
1341 -- The result type of a foreign export dynamic must be Ptr, FunPtr, Addr,
1342 -- or a newtype of either.
1343 isFFIDynResultTy = checkRepTyConKey [ptrTyConKey, funPtrTyConKey]
1345 isFFILabelTy :: Type -> Bool
1346 -- The type of a foreign label must be Ptr, FunPtr, Addr,
1347 -- or a newtype of either.
1348 isFFILabelTy = checkRepTyConKey [ptrTyConKey, funPtrTyConKey]
1350 isFFIPrimArgumentTy :: DynFlags -> Type -> Bool
1351 -- Checks for valid argument type for a 'foreign import prim'
1352 -- Currently they must all be simple unlifted types.
1353 isFFIPrimArgumentTy dflags ty
1354 = checkRepTyCon (legalFIPrimArgTyCon dflags) ty
1356 isFFIPrimResultTy :: DynFlags -> Type -> Bool
1357 -- Checks for valid result type for a 'foreign import prim'
1358 -- Currently it must be an unlifted type, including unboxed tuples.
1359 isFFIPrimResultTy dflags ty
1360 = checkRepTyCon (legalFIPrimResultTyCon dflags) ty
1362 isFFIDotnetTy :: DynFlags -> Type -> Bool
1363 isFFIDotnetTy dflags ty
1364 = checkRepTyCon (\ tc -> (legalFIResultTyCon dflags tc ||
1365 isFFIDotnetObjTy ty || isStringTy ty)) ty
1366 -- NB: isStringTy used to look through newtypes, but
1367 -- it no longer does so. May need to adjust isFFIDotNetTy
1368 -- if we do want to look through newtypes.
1370 isFFIDotnetObjTy :: Type -> Bool
1372 = checkRepTyCon check_tc t_ty
1374 (_, t_ty) = tcSplitForAllTys ty
1375 check_tc tc = getName tc == objectTyConName
1377 isFunPtrTy :: Type -> Bool
1378 isFunPtrTy = checkRepTyConKey [funPtrTyConKey]
1380 checkRepTyCon :: (TyCon -> Bool) -> Type -> Bool
1381 -- Look through newtypes, but *not* foralls
1382 -- Should work even for recursive newtypes
1383 -- eg Manuel had: newtype T = MkT (Ptr T)
1384 checkRepTyCon check_tc ty
1388 | Just (tc,tys) <- splitTyConApp_maybe ty
1389 = case carefullySplitNewType_maybe rec_nts tc tys of
1390 Just (rec_nts', ty') -> go rec_nts' ty'
1391 Nothing -> check_tc tc
1395 checkRepTyConKey :: [Unique] -> Type -> Bool
1396 -- Like checkRepTyCon, but just looks at the TyCon key
1397 checkRepTyConKey keys
1398 = checkRepTyCon (\tc -> tyConUnique tc `elem` keys)
1401 ----------------------------------------------
1402 These chaps do the work; they are not exported
1403 ----------------------------------------------
1406 legalFEArgTyCon :: TyCon -> Bool
1408 -- It's illegal to make foreign exports that take unboxed
1409 -- arguments. The RTS API currently can't invoke such things. --SDM 7/2000
1410 = boxedMarshalableTyCon tc
1412 legalFIResultTyCon :: DynFlags -> TyCon -> Bool
1413 legalFIResultTyCon dflags tc
1414 | tc == unitTyCon = True
1415 | otherwise = marshalableTyCon dflags tc
1417 legalFEResultTyCon :: TyCon -> Bool
1418 legalFEResultTyCon tc
1419 | tc == unitTyCon = True
1420 | otherwise = boxedMarshalableTyCon tc
1422 legalOutgoingTyCon :: DynFlags -> Safety -> TyCon -> Bool
1423 -- Checks validity of types going from Haskell -> external world
1424 legalOutgoingTyCon dflags _ tc
1425 = marshalableTyCon dflags tc
1427 legalFFITyCon :: TyCon -> Bool
1428 -- True for any TyCon that can possibly be an arg or result of an FFI call
1430 = isUnLiftedTyCon tc || boxedMarshalableTyCon tc || tc == unitTyCon
1432 marshalableTyCon :: DynFlags -> TyCon -> Bool
1433 marshalableTyCon dflags tc
1434 = (xopt Opt_UnliftedFFITypes dflags
1435 && isUnLiftedTyCon tc
1436 && not (isUnboxedTupleTyCon tc)
1437 && case tyConPrimRep tc of -- Note [Marshalling VoidRep]
1440 || boxedMarshalableTyCon tc
1442 boxedMarshalableTyCon :: TyCon -> Bool
1443 boxedMarshalableTyCon tc
1444 = getUnique tc `elem` [ intTyConKey, int8TyConKey, int16TyConKey
1445 , int32TyConKey, int64TyConKey
1446 , wordTyConKey, word8TyConKey, word16TyConKey
1447 , word32TyConKey, word64TyConKey
1448 , floatTyConKey, doubleTyConKey
1449 , ptrTyConKey, funPtrTyConKey
1455 legalFIPrimArgTyCon :: DynFlags -> TyCon -> Bool
1456 -- Check args of 'foreign import prim', only allow simple unlifted types.
1457 -- Strictly speaking it is unnecessary to ban unboxed tuples here since
1458 -- currently they're of the wrong kind to use in function args anyway.
1459 legalFIPrimArgTyCon dflags tc
1460 = xopt Opt_UnliftedFFITypes dflags
1461 && isUnLiftedTyCon tc
1462 && not (isUnboxedTupleTyCon tc)
1464 legalFIPrimResultTyCon :: DynFlags -> TyCon -> Bool
1465 -- Check result type of 'foreign import prim'. Allow simple unlifted
1466 -- types and also unboxed tuple result types '... -> (# , , #)'
1467 legalFIPrimResultTyCon dflags tc
1468 = xopt Opt_UnliftedFFITypes dflags
1469 && isUnLiftedTyCon tc
1470 && (isUnboxedTupleTyCon tc
1471 || case tyConPrimRep tc of -- Note [Marshalling VoidRep]
1476 Note [Marshalling VoidRep]
1477 ~~~~~~~~~~~~~~~~~~~~~~~~~~
1478 We don't treat State# (whose PrimRep is VoidRep) as marshalable.
1479 In turn that means you can't write
1480 foreign import foo :: Int -> State# RealWorld
1482 Reason: the back end falls over with panic "primRepHint:VoidRep";
1483 and there is no compelling reason to permit it