2 % (c) The GRASP/AQUA Project, Glasgow University, 1998
4 \section[Type]{Type - public interface}
8 -- re-exports from TypeRep:
12 superKind, superBoxity, -- :: SuperKind
14 boxedKind, -- :: Kind :: BX
15 anyBoxKind, -- :: Kind :: BX
16 typeCon, -- :: KindCon :: BX -> KX
17 anyBoxCon, -- :: KindCon :: BX
19 boxedTypeKind, unboxedTypeKind, openTypeKind, -- Kind :: superKind
21 mkArrowKind, mkArrowKinds, -- mentioned below: hasMoreBoxityInfo,
25 -- exports from this module:
28 mkTyVarTy, mkTyVarTys, getTyVar, getTyVar_maybe, isTyVarTy,
30 mkAppTy, mkAppTys, splitAppTy, splitAppTys, splitAppTy_maybe,
32 mkFunTy, mkFunTys, splitFunTy, splitFunTy_maybe, splitFunTys, splitFunTysN,
33 funResultTy, funArgTy, zipFunTys,
35 mkTyConApp, mkTyConTy, splitTyConApp_maybe,
36 splitAlgTyConApp_maybe, splitAlgTyConApp,
37 mkDictTy, mkDictTys, mkPredTy, splitPredTy_maybe, splitDictTy_maybe, isDictTy,
39 mkSynTy, isSynTy, deNoteType,
41 repType, splitRepFunTys, splitNewType_maybe, typePrimRep,
43 UsageAnn(..), mkUsgTy, isUsgTy{- dont use -}, isNotUsgTy, splitUsgTy, unUsgTy, tyUsg,
44 mkUsForAllTy, mkUsForAllTys, splitUsForAllTys, substUsTy,
46 mkForAllTy, mkForAllTys, splitForAllTy_maybe, splitForAllTys,
47 applyTy, applyTys, hoistForAllTys,
49 TauType, RhoType, SigmaType, PredType(..), ThetaType,
50 ClassPred, ClassContext, mkClassPred,
51 getClassTys_maybe, ipName_maybe, classesToPreds, classesOfPreds,
52 isTauTy, mkRhoTy, splitRhoTy,
53 mkSigmaTy, isSigmaTy, splitSigmaTy,
56 isUnLiftedType, isUnboxedType, isUnboxedTupleType, isAlgType, isDataType, isNewType,
59 tyVarsOfType, tyVarsOfTypes, tyVarsOfPred, tyVarsOfTheta,
60 namesOfType, typeKind, addFreeTyVars,
62 -- Tidying up for printing
64 tidyOpenType, tidyOpenTypes,
65 tidyTyVar, tidyTyVars,
73 #include "HsVersions.h"
75 -- We import the representation and primitive functions from TypeRep.
76 -- Many things are reexported, but not the representation!
82 import {-# SOURCE #-} DataCon( DataCon, dataConRepType )
83 import {-# SOURCE #-} PprType( pprType, pprPred ) -- Only called in debug messages
84 import {-# SOURCE #-} Subst ( mkTyVarSubst, substTy )
87 import Var ( TyVar, Var, UVar,
88 tyVarKind, tyVarName, setTyVarName, isId, idType,
93 import Name ( Name, NamedThing(..), mkLocalName, tidyOccName
96 import Class ( classTyCon, Class, ClassPred, ClassContext )
98 isUnboxedTupleTyCon, isUnLiftedTyCon,
99 isFunTyCon, isDataTyCon, isNewTyCon, newTyConRep,
100 isAlgTyCon, isSynTyCon, tyConArity,
101 tyConKind, tyConDataCons, getSynTyConDefn,
102 tyConPrimRep, tyConClass_maybe
106 import SrcLoc ( noSrcLoc )
107 import Maybes ( maybeToBool )
108 import PrimRep ( PrimRep(..), isFollowableRep )
109 import Unique ( Uniquable(..) )
110 import Util ( mapAccumL, seqList )
112 import UniqSet ( sizeUniqSet ) -- Should come via VarSet
116 %************************************************************************
118 \subsection{Stuff to do with kinds.}
120 %************************************************************************
123 hasMoreBoxityInfo :: Kind -> Kind -> Bool
124 hasMoreBoxityInfo k1 k2
125 | k2 == openTypeKind = ASSERT( is_type_kind k1) True
126 | otherwise = k1 == k2
128 -- Returns true for things of form (Type x)
129 is_type_kind k = case splitTyConApp_maybe k of
130 Just (tc,[_]) -> tc == typeCon
135 %************************************************************************
137 \subsection{Constructor-specific functions}
139 %************************************************************************
142 ---------------------------------------------------------------------
146 mkTyVarTy :: TyVar -> Type
149 mkTyVarTys :: [TyVar] -> [Type]
150 mkTyVarTys = map mkTyVarTy -- a common use of mkTyVarTy
152 getTyVar :: String -> Type -> TyVar
153 getTyVar msg (TyVarTy tv) = tv
154 getTyVar msg (NoteTy _ t) = getTyVar msg t
155 getTyVar msg other = panic ("getTyVar: " ++ msg)
157 getTyVar_maybe :: Type -> Maybe TyVar
158 getTyVar_maybe (TyVarTy tv) = Just tv
159 getTyVar_maybe (NoteTy _ t) = getTyVar_maybe t
160 getTyVar_maybe other = Nothing
162 isTyVarTy :: Type -> Bool
163 isTyVarTy (TyVarTy tv) = True
164 isTyVarTy (NoteTy _ ty) = isTyVarTy ty
165 isTyVarTy other = False
169 ---------------------------------------------------------------------
172 We need to be pretty careful with AppTy to make sure we obey the
173 invariant that a TyConApp is always visibly so. mkAppTy maintains the
177 mkAppTy orig_ty1 orig_ty2 = ASSERT2( isNotUsgTy orig_ty1 && isNotUsgTy orig_ty2, pprType orig_ty1 <+> text "to" <+> pprType orig_ty2 )
180 mk_app (NoteTy _ ty1) = mk_app ty1
181 mk_app (TyConApp tc tys) = mkTyConApp tc (tys ++ [orig_ty2])
182 mk_app ty1 = AppTy orig_ty1 orig_ty2
184 mkAppTys :: Type -> [Type] -> Type
185 mkAppTys orig_ty1 [] = orig_ty1
186 -- This check for an empty list of type arguments
187 -- avoids the needless of a type synonym constructor.
188 -- For example: mkAppTys Rational []
189 -- returns to (Ratio Integer), which has needlessly lost
190 -- the Rational part.
191 mkAppTys orig_ty1 orig_tys2 = ASSERT2( isNotUsgTy orig_ty1, pprType orig_ty1 )
194 mk_app (NoteTy _ ty1) = mk_app ty1
195 mk_app (TyConApp tc tys) = mkTyConApp tc (tys ++ orig_tys2)
196 mk_app ty1 = ASSERT2( all isNotUsgTy orig_tys2, pprType orig_ty1 <+> text "to" <+> hsep (map pprType orig_tys2) )
197 foldl AppTy orig_ty1 orig_tys2
199 splitAppTy_maybe :: Type -> Maybe (Type, Type)
200 splitAppTy_maybe (FunTy ty1 ty2) = Just (TyConApp funTyCon [ty1], ty2)
201 splitAppTy_maybe (AppTy ty1 ty2) = Just (ty1, ty2)
202 splitAppTy_maybe (NoteTy _ ty) = splitAppTy_maybe ty
203 splitAppTy_maybe (TyConApp tc []) = Nothing
204 splitAppTy_maybe (TyConApp tc tys) = split tys []
206 split [ty2] acc = Just (TyConApp tc (reverse acc), ty2)
207 split (ty:tys) acc = split tys (ty:acc)
209 splitAppTy_maybe other = Nothing
211 splitAppTy :: Type -> (Type, Type)
212 splitAppTy ty = case splitAppTy_maybe ty of
214 Nothing -> panic "splitAppTy"
216 splitAppTys :: Type -> (Type, [Type])
217 splitAppTys ty = split ty ty []
219 split orig_ty (AppTy ty arg) args = split ty ty (arg:args)
220 split orig_ty (NoteTy _ ty) args = split orig_ty ty args
221 split orig_ty (FunTy ty1 ty2) args = ASSERT( null args )
222 (TyConApp funTyCon [], [ty1,ty2])
223 split orig_ty (TyConApp tc tc_args) args = (TyConApp tc [], tc_args ++ args)
224 split orig_ty ty args = (orig_ty, args)
228 ---------------------------------------------------------------------
233 mkFunTy :: Type -> Type -> Type
234 mkFunTy arg res = FunTy arg res
236 mkFunTys :: [Type] -> Type -> Type
237 mkFunTys tys ty = foldr FunTy ty tys
239 splitFunTy :: Type -> (Type, Type)
240 splitFunTy (FunTy arg res) = (arg, res)
241 splitFunTy (NoteTy _ ty) = splitFunTy ty
243 splitFunTy_maybe :: Type -> Maybe (Type, Type)
244 splitFunTy_maybe (FunTy arg res) = Just (arg, res)
245 splitFunTy_maybe (NoteTy (IPNote _) ty) = Nothing
246 splitFunTy_maybe (NoteTy _ ty) = splitFunTy_maybe ty
247 splitFunTy_maybe other = Nothing
249 splitFunTys :: Type -> ([Type], Type)
250 splitFunTys ty = split [] ty ty
252 split args orig_ty (FunTy arg res) = split (arg:args) res res
253 split args orig_ty (NoteTy (IPNote _) ty)
254 = (reverse args, orig_ty)
255 split args orig_ty (NoteTy _ ty) = split args orig_ty ty
256 split args orig_ty ty = (reverse args, orig_ty)
258 splitFunTysN :: String -> Int -> Type -> ([Type], Type)
259 splitFunTysN msg orig_n orig_ty = split orig_n [] orig_ty orig_ty
261 split 0 args syn_ty ty = (reverse args, syn_ty)
262 split n args syn_ty (FunTy arg res) = split (n-1) (arg:args) res res
263 split n args syn_ty (NoteTy _ ty) = split n args syn_ty ty
264 split n args syn_ty ty = pprPanic ("splitFunTysN: " ++ msg) (int orig_n <+> pprType orig_ty)
266 zipFunTys :: Outputable a => [a] -> Type -> ([(a,Type)], Type)
267 zipFunTys orig_xs orig_ty = split [] orig_xs orig_ty orig_ty
269 split acc [] nty ty = (reverse acc, nty)
270 split acc (x:xs) nty (FunTy arg res) = split ((x,arg):acc) xs res res
271 split acc xs nty (NoteTy _ ty) = split acc xs nty ty
272 split acc (x:xs) nty ty = pprPanic "zipFunTys" (ppr orig_xs <+> pprType orig_ty)
274 funResultTy :: Type -> Type
275 funResultTy (FunTy arg res) = res
276 funResultTy (NoteTy _ ty) = funResultTy ty
277 funResultTy ty = pprPanic "funResultTy" (pprType ty)
279 funArgTy :: Type -> Type
280 funArgTy (FunTy arg res) = arg
281 funArgTy (NoteTy _ ty) = funArgTy ty
282 funArgTy ty = pprPanic "funArgTy" (pprType ty)
286 ---------------------------------------------------------------------
291 mkTyConApp :: TyCon -> [Type] -> Type
293 | isFunTyCon tycon && length tys == 2
295 (ty1:ty2:_) -> FunTy ty1 ty2
298 = ASSERT(not (isSynTyCon tycon))
301 mkTyConTy :: TyCon -> Type
302 mkTyConTy tycon = ASSERT( not (isSynTyCon tycon) )
305 -- splitTyConApp "looks through" synonyms, because they don't
306 -- mean a distinct type, but all other type-constructor applications
307 -- including functions are returned as Just ..
309 splitTyConApp_maybe :: Type -> Maybe (TyCon, [Type])
310 splitTyConApp_maybe (TyConApp tc tys) = Just (tc, tys)
311 splitTyConApp_maybe (FunTy arg res) = Just (funTyCon, [arg,res])
312 splitTyConApp_maybe (NoteTy (IPNote _) ty) = Nothing
313 splitTyConApp_maybe (NoteTy _ ty) = splitTyConApp_maybe ty
314 splitTyConApp_maybe other = Nothing
316 -- splitAlgTyConApp_maybe looks for
317 -- *saturated* applications of *algebraic* data types
318 -- "Algebraic" => newtype, data type, or dictionary (not function types)
319 -- We return the constructors too, so there had better be some.
321 splitAlgTyConApp_maybe :: Type -> Maybe (TyCon, [Type], [DataCon])
322 splitAlgTyConApp_maybe (TyConApp tc tys)
324 tyConArity tc == length tys = Just (tc, tys, tyConDataCons tc)
325 splitAlgTyConApp_maybe (NoteTy (IPNote _) ty)
327 splitAlgTyConApp_maybe (NoteTy _ ty) = splitAlgTyConApp_maybe ty
328 splitAlgTyConApp_maybe other = Nothing
330 splitAlgTyConApp :: Type -> (TyCon, [Type], [DataCon])
331 -- Here the "algebraic" property is an *assertion*
332 splitAlgTyConApp (TyConApp tc tys) = ASSERT( isAlgTyCon tc && tyConArity tc == length tys )
333 (tc, tys, tyConDataCons tc)
334 splitAlgTyConApp (NoteTy _ ty) = splitAlgTyConApp ty
336 splitAlgTyConApp ty = pprPanic "splitAlgTyConApp" (pprType ty)
340 "Dictionary" types are just ordinary data types, but you can
341 tell from the type constructor whether it's a dictionary or not.
344 mkDictTy :: Class -> [Type] -> Type
345 mkDictTy clas tys = TyConApp (classTyCon clas) tys
347 mkDictTys :: ClassContext -> [Type]
348 mkDictTys cxt = [mkDictTy cls tys | (cls,tys) <- cxt]
350 mkPredTy :: PredType -> Type
351 mkPredTy (Class clas tys) = TyConApp (classTyCon clas) tys
352 mkPredTy (IParam n ty) = NoteTy (IPNote n) ty
354 splitPredTy_maybe :: Type -> Maybe PredType
355 splitPredTy_maybe (TyConApp tc tys)
356 | maybeToBool maybe_class
357 && tyConArity tc == length tys = Just (Class clas tys)
359 maybe_class = tyConClass_maybe tc
360 Just clas = maybe_class
362 splitPredTy_maybe (NoteTy (IPNote n) ty)
364 splitPredTy_maybe (NoteTy _ ty) = splitPredTy_maybe ty
365 splitPredTy_maybe other = Nothing
367 splitDictTy_maybe :: Type -> Maybe (Class, [Type])
369 = case splitPredTy_maybe ty of
370 Just p -> getClassTys_maybe p
373 isDictTy :: Type -> Bool
374 -- This version is slightly more efficient than (maybeToBool . splitDictTy)
375 isDictTy (TyConApp tc tys)
376 | maybeToBool (tyConClass_maybe tc)
377 && tyConArity tc == length tys
379 isDictTy (NoteTy _ ty) = isDictTy ty
380 isDictTy other = False
383 ---------------------------------------------------------------------
388 mkSynTy syn_tycon tys
389 = ASSERT( isSynTyCon syn_tycon )
390 ASSERT( isNotUsgTy body )
391 ASSERT( length tyvars == length tys )
392 NoteTy (SynNote (TyConApp syn_tycon tys))
393 (substTy (mkTyVarSubst tyvars tys) body)
395 (tyvars, body) = getSynTyConDefn syn_tycon
397 isSynTy (NoteTy (SynNote _) _) = True
398 isSynTy other = False
400 deNoteType :: Type -> Type
401 -- Sorry for the cute name
402 deNoteType ty@(TyVarTy tyvar) = ty
403 deNoteType (TyConApp tycon tys) = TyConApp tycon (map deNoteType tys)
404 deNoteType (NoteTy _ ty) = deNoteType ty
405 deNoteType (AppTy fun arg) = AppTy (deNoteType fun) (deNoteType arg)
406 deNoteType (FunTy fun arg) = FunTy (deNoteType fun) (deNoteType arg)
407 deNoteType (ForAllTy tv ty) = ForAllTy tv (deNoteType ty)
410 Notes on type synonyms
411 ~~~~~~~~~~~~~~~~~~~~~~
412 The various "split" functions (splitFunTy, splitRhoTy, splitForAllTy) try
413 to return type synonyms whereever possible. Thus
418 splitFunTys (a -> Foo a) = ([a], Foo a)
421 The reason is that we then get better (shorter) type signatures in
422 interfaces. Notably this plays a role in tcTySigs in TcBinds.lhs.
428 repType looks through
432 It's useful in the back end where we're not
433 interested in newtypes anymore.
436 repType :: Type -> Type
437 repType (ForAllTy _ ty) = repType ty
438 repType (NoteTy _ ty) = repType ty
439 repType ty = case splitNewType_maybe ty of
440 Just ty' -> repType ty' -- Still re-apply repType in case of for-all
443 splitRepFunTys :: Type -> ([Type], Type)
444 -- Like splitFunTys, but looks through newtypes and for-alls
445 splitRepFunTys ty = split [] (repType ty)
447 split args (FunTy arg res) = split (arg:args) (repType res)
448 split args ty = (reverse args, ty)
450 typePrimRep :: Type -> PrimRep
451 typePrimRep ty = case repType ty of
452 TyConApp tc _ -> tyConPrimRep tc
454 AppTy _ _ -> PtrRep -- ??
457 splitNewType_maybe :: Type -> Maybe Type
458 -- Find the representation of a newtype, if it is one
459 -- Looks through multiple levels of newtype, but does not look through for-alls
460 splitNewType_maybe (NoteTy (IPNote _) ty)
462 splitNewType_maybe (NoteTy _ ty) = splitNewType_maybe ty
463 splitNewType_maybe (TyConApp tc tys) = case newTyConRep tc of
464 Just rep_ty -> ASSERT( length tys == tyConArity tc )
465 -- The assert should hold because repType should
466 -- only be applied to *types* (of kind *)
467 Just (applyTys rep_ty tys)
469 splitNewType_maybe other = Nothing
474 ---------------------------------------------------------------------
478 NB: Invariant: if present, usage note is at the very top of the type.
479 This should be carefully preserved.
481 In some parts of the compiler, comments use the _Once Upon a
482 Polymorphic Type_ (POPL'99) usage of "rho = generalised
483 usage-annotated type; sigma = usage-annotated type; tau =
484 usage-annotated type except on top"; unfortunately this conflicts with
485 the rho/tau/theta/sigma usage in the rest of the compiler. (KSW
489 mkUsgTy :: UsageAnn -> Type -> Type
491 mkUsgTy UsMany ty = ASSERT2( isNotUsgTy ty, pprType ty )
494 mkUsgTy usg ty = ASSERT2( isNotUsgTy ty, pprType ty )
495 NoteTy (UsgNote usg) ty
497 -- The isUsgTy function is utterly useless if UsManys are omitted.
498 -- Be warned! KSW 1999-04.
499 isUsgTy :: Type -> Bool
503 isUsgTy (NoteTy (UsgForAll _) ty) = isUsgTy ty
504 isUsgTy (NoteTy (UsgNote _) _ ) = True
505 isUsgTy other = False
508 -- The isNotUsgTy function may return a false True if UsManys are omitted;
509 -- in other words, A SSERT( isNotUsgTy ty ) may be useful but
510 -- A SSERT( not (isNotUsg ty) ) is asking for trouble. KSW 1999-04.
511 isNotUsgTy :: Type -> Bool
512 isNotUsgTy (NoteTy (UsgForAll _) _) = False
513 isNotUsgTy (NoteTy (UsgNote _) _) = False
514 isNotUsgTy other = True
516 -- splitUsgTy_maybe is not exported, since it is meaningless if
517 -- UsManys are omitted. It is used in several places in this module,
518 -- however. KSW 1999-04.
519 splitUsgTy_maybe :: Type -> Maybe (UsageAnn,Type)
520 splitUsgTy_maybe (NoteTy (UsgNote usg) ty2) = ASSERT( isNotUsgTy ty2 )
522 splitUsgTy_maybe ty@(NoteTy (UsgForAll _) _) = pprPanic "splitUsgTy_maybe:" $ pprType ty
523 splitUsgTy_maybe ty = Nothing
525 splitUsgTy :: Type -> (UsageAnn,Type)
526 splitUsgTy ty = case splitUsgTy_maybe ty of
532 pprPanic "splitUsgTy: no usage annot:" $ pprType ty
535 tyUsg :: Type -> UsageAnn
536 tyUsg = fst . splitUsgTy
538 unUsgTy :: Type -> Type
539 -- strip outer usage annotation if present
540 unUsgTy ty = case splitUsgTy_maybe ty of
541 Just (_,ty1) -> ASSERT2( isNotUsgTy ty1, pprType ty )
545 mkUsForAllTy :: UVar -> Type -> Type
546 mkUsForAllTy uv ty = NoteTy (UsgForAll uv) ty
548 mkUsForAllTys :: [UVar] -> Type -> Type
549 mkUsForAllTys uvs ty = foldr (NoteTy . UsgForAll) ty uvs
551 splitUsForAllTys :: Type -> ([UVar],Type)
552 splitUsForAllTys ty = split ty []
553 where split (NoteTy (UsgForAll u) ty) uvs = split ty (u:uvs)
554 split other_ty uvs = (reverse uvs, other_ty)
556 substUsTy :: VarEnv UsageAnn -> Type -> Type
557 -- assumes range is fresh uvars, so no conflicts
558 substUsTy ve (NoteTy note@(UsgNote (UsVar u))
559 ty ) = NoteTy (case lookupVarEnv ve u of
560 Just ua -> UsgNote ua
563 substUsTy ve (NoteTy note@(UsgNote _) ty ) = NoteTy note (substUsTy ve ty)
564 substUsTy ve (NoteTy note@(UsgForAll _) ty ) = NoteTy note (substUsTy ve ty)
565 substUsTy ve (NoteTy (SynNote ty1) ty2) = NoteTy (SynNote (substUsTy ve ty1))
567 substUsTy ve (NoteTy note@(FTVNote _) ty ) = NoteTy note (substUsTy ve ty)
568 substUsTy ve ty@(TyVarTy _ ) = ty
569 substUsTy ve (AppTy ty1 ty2) = AppTy (substUsTy ve ty1)
571 substUsTy ve (FunTy ty1 ty2) = FunTy (substUsTy ve ty1)
573 substUsTy ve (TyConApp tyc tys) = TyConApp tyc (map (substUsTy ve) tys)
574 substUsTy ve (ForAllTy yv ty ) = ForAllTy yv (substUsTy ve ty)
578 ---------------------------------------------------------------------
582 We need to be clever here with usage annotations; they need to be
583 lifted or lowered through the forall as appropriate.
586 mkForAllTy :: TyVar -> Type -> Type
587 mkForAllTy tyvar ty = case splitUsgTy_maybe ty of
588 Just (usg,ty') -> NoteTy (UsgNote usg)
590 Nothing -> ForAllTy tyvar ty
592 mkForAllTys :: [TyVar] -> Type -> Type
593 mkForAllTys tyvars ty = case splitUsgTy_maybe ty of
594 Just (usg,ty') -> NoteTy (UsgNote usg)
595 (foldr ForAllTy ty' tyvars)
596 Nothing -> foldr ForAllTy ty tyvars
598 splitForAllTy_maybe :: Type -> Maybe (TyVar, Type)
599 splitForAllTy_maybe ty = case splitUsgTy_maybe ty of
600 Just (usg,ty') -> do (tyvar,ty'') <- splitFAT_m ty'
601 return (tyvar, NoteTy (UsgNote usg) ty'')
602 Nothing -> splitFAT_m ty
604 splitFAT_m (NoteTy (IPNote _) ty) = Nothing
605 splitFAT_m (NoteTy _ ty) = splitFAT_m ty
606 splitFAT_m (ForAllTy tyvar ty) = Just(tyvar, ty)
607 splitFAT_m _ = Nothing
609 splitForAllTys :: Type -> ([TyVar], Type)
610 splitForAllTys ty = case splitUsgTy_maybe ty of
611 Just (usg,ty') -> let (tvs,ty'') = split ty' ty' []
612 in (tvs, NoteTy (UsgNote usg) ty'')
613 Nothing -> split ty ty []
615 split orig_ty (ForAllTy tv ty) tvs = split ty ty (tv:tvs)
616 split orig_ty (NoteTy (IPNote _) ty) tvs = (reverse tvs, orig_ty)
617 split orig_ty (NoteTy _ ty) tvs = split orig_ty ty tvs
618 split orig_ty t tvs = (reverse tvs, orig_ty)
621 -- (mkPiType now in CoreUtils)
623 Applying a for-all to its arguments
626 applyTy :: Type -> Type -> Type
627 applyTy (NoteTy note@(UsgNote _) fun) arg = NoteTy note (applyTy fun arg)
628 applyTy (NoteTy note@(UsgForAll _) fun) arg = NoteTy note (applyTy fun arg)
629 applyTy (NoteTy _ fun) arg = applyTy fun arg
630 applyTy (ForAllTy tv ty) arg = ASSERT( isNotUsgTy arg )
631 substTy (mkTyVarSubst [tv] [arg]) ty
632 applyTy other arg = panic "applyTy"
634 applyTys :: Type -> [Type] -> Type
635 applyTys fun_ty arg_tys
636 = substTy (mkTyVarSubst tvs arg_tys) ty
638 (tvs, ty) = split fun_ty arg_tys
640 split fun_ty [] = ([], fun_ty)
641 split (NoteTy note@(UsgNote _) fun_ty)
642 args = case split fun_ty args of
643 (tvs, ty) -> (tvs, NoteTy note ty)
644 split (NoteTy note@(UsgForAll _) fun_ty)
645 args = case split fun_ty args of
646 (tvs, ty) -> (tvs, NoteTy note ty)
647 split (NoteTy _ fun_ty) args = split fun_ty args
648 split (ForAllTy tv fun_ty) (arg:args) = ASSERT2( isNotUsgTy arg, vcat (map pprType arg_tys) $$
649 text "in application of" <+> pprType fun_ty)
650 case split fun_ty args of
651 (tvs, ty) -> (tv:tvs, ty)
652 split other_ty args = panic "applyTys"
655 Note that we allow applications to be of usage-annotated- types, as an
656 extension: we handle them by lifting the annotation outside. The
657 argument, however, must still be unannotated.
660 hoistForAllTys :: Type -> Type
661 -- Move all the foralls to the top
662 -- e.g. T -> forall a. a ==> forall a. T -> a
664 = case hoist ty of { (tvs, body) -> mkForAllTys tvs body }
666 hoist :: Type -> ([TyVar], Type)
667 hoist ty = case splitFunTys ty of { (args, res) ->
668 case splitForAllTys res of {
669 ([], body) -> ([], ty) ;
670 (tvs1, body1) -> case hoist body1 of { (tvs2,body2) ->
671 (tvs1 ++ tvs2, mkFunTys args body2)
676 %************************************************************************
678 \subsection{Stuff to do with the source-language types}
680 PredType and ThetaType are used in types for expressions and bindings.
681 ClassPred and ClassContext are used in class and instance declarations.
683 %************************************************************************
686 data PredType = Class Class [Type]
690 type ThetaType = [PredType]
693 type SigmaType = Type
697 instance Outputable PredType where
702 mkClassPred clas tys = Class clas tys
704 getClassTys_maybe :: PredType -> Maybe ClassPred
705 getClassTys_maybe (Class clas tys) = Just (clas, tys)
706 getClassTys_maybe _ = Nothing
708 ipName_maybe :: PredType -> Maybe Name
709 ipName_maybe (IParam n _) = Just n
710 ipName_maybe _ = Nothing
712 classesToPreds cts = map (uncurry Class) cts
714 classesOfPreds theta = concatMap cvt theta
715 where cvt (Class clas tys) = [(clas, tys)]
716 cvt (IParam _ _ ) = []
719 @isTauTy@ tests for nested for-alls.
722 isTauTy :: Type -> Bool
723 isTauTy (TyVarTy v) = True
724 isTauTy (TyConApp _ tys) = all isTauTy tys
725 isTauTy (AppTy a b) = isTauTy a && isTauTy b
726 isTauTy (FunTy a b) = isTauTy a && isTauTy b
727 isTauTy (NoteTy (IPNote _) ty) = False
728 isTauTy (NoteTy _ ty) = isTauTy ty
729 isTauTy other = False
733 mkRhoTy :: [PredType] -> Type -> Type
734 mkRhoTy theta ty = foldr (\p r -> FunTy (mkPredTy p) r) ty theta
736 splitRhoTy :: Type -> ([PredType], Type)
737 splitRhoTy ty = split ty ty []
739 split orig_ty (FunTy arg res) ts = case splitPredTy_maybe arg of
740 Just p -> split res res (p:ts)
741 Nothing -> (reverse ts, orig_ty)
742 split orig_ty (NoteTy (IPNote _) ty) ts = (reverse ts, orig_ty)
743 split orig_ty (NoteTy _ ty) ts = split orig_ty ty ts
744 split orig_ty ty ts = (reverse ts, orig_ty)
750 mkSigmaTy tyvars theta tau = mkForAllTys tyvars (mkRhoTy theta tau)
752 isSigmaTy :: Type -> Bool
753 isSigmaTy (FunTy a b) = isPredTy a
754 where isPredTy (NoteTy (IPNote _) _) = True
755 -- JRL could be a dict ty, but that would be polymorphic,
756 -- and thus there would have been an outer ForAllTy
758 isSigmaTy (NoteTy (IPNote _) _) = False
759 isSigmaTy (NoteTy _ ty) = isSigmaTy ty
760 isSigmaTy (ForAllTy tyvar ty) = True
763 splitSigmaTy :: Type -> ([TyVar], [PredType], Type)
767 (tyvars,rho) = splitForAllTys ty
768 (theta,tau) = splitRhoTy rho
772 %************************************************************************
774 \subsection{Kinds and free variables}
776 %************************************************************************
778 ---------------------------------------------------------------------
779 Finding the kind of a type
780 ~~~~~~~~~~~~~~~~~~~~~~~~~~
782 typeKind :: Type -> Kind
784 typeKind (TyVarTy tyvar) = tyVarKind tyvar
785 typeKind (TyConApp tycon tys) = foldr (\_ k -> funResultTy k) (tyConKind tycon) tys
786 typeKind (NoteTy _ ty) = typeKind ty
787 typeKind (AppTy fun arg) = funResultTy (typeKind fun)
789 typeKind (FunTy arg res) = boxedTypeKind -- A function is boxed regardless of its result type
790 -- No functions at the type level, hence we don't need
791 -- to say (typeKind res).
793 typeKind (ForAllTy tv ty) = typeKind ty
797 ---------------------------------------------------------------------
798 Free variables of a type
799 ~~~~~~~~~~~~~~~~~~~~~~~~
801 tyVarsOfType :: Type -> TyVarSet
803 tyVarsOfType (TyVarTy tv) = unitVarSet tv
804 tyVarsOfType (TyConApp tycon tys) = tyVarsOfTypes tys
805 tyVarsOfType (NoteTy (FTVNote tvs) ty2) = tvs
806 tyVarsOfType (NoteTy (SynNote ty1) ty2) = tyVarsOfType ty1
807 tyVarsOfType (NoteTy (UsgNote _) ty) = tyVarsOfType ty
808 tyVarsOfType (NoteTy (UsgForAll _) ty) = tyVarsOfType ty
809 tyVarsOfType (NoteTy (IPNote _) ty) = tyVarsOfType ty
810 tyVarsOfType (FunTy arg res) = tyVarsOfType arg `unionVarSet` tyVarsOfType res
811 tyVarsOfType (AppTy fun arg) = tyVarsOfType fun `unionVarSet` tyVarsOfType arg
812 tyVarsOfType (ForAllTy tyvar ty) = tyVarsOfType ty `minusVarSet` unitVarSet tyvar
814 tyVarsOfTypes :: [Type] -> TyVarSet
815 tyVarsOfTypes tys = foldr (unionVarSet.tyVarsOfType) emptyVarSet tys
817 tyVarsOfPred :: PredType -> TyVarSet
818 tyVarsOfPred (Class clas tys) = tyVarsOfTypes tys
819 tyVarsOfPred (IParam n ty) = tyVarsOfType ty
821 tyVarsOfTheta :: ThetaType -> TyVarSet
822 tyVarsOfTheta = foldr (unionVarSet . tyVarsOfPred) emptyVarSet
824 -- Add a Note with the free tyvars to the top of the type
825 -- (but under a usage if there is one)
826 addFreeTyVars :: Type -> Type
827 addFreeTyVars (NoteTy note@(UsgNote _) ty) = NoteTy note (addFreeTyVars ty)
828 addFreeTyVars (NoteTy note@(UsgForAll _) ty) = NoteTy note (addFreeTyVars ty)
829 addFreeTyVars ty@(NoteTy (FTVNote _) _) = ty
830 addFreeTyVars ty = NoteTy (FTVNote (tyVarsOfType ty)) ty
832 -- Find the free names of a type, including the type constructors and classes it mentions
833 namesOfType :: Type -> NameSet
834 namesOfType (TyVarTy tv) = unitNameSet (getName tv)
835 namesOfType (TyConApp tycon tys) = unitNameSet (getName tycon) `unionNameSets`
837 namesOfType (NoteTy (SynNote ty1) ty2) = namesOfType ty1
838 namesOfType (NoteTy other_note ty2) = namesOfType ty2
839 namesOfType (FunTy arg res) = namesOfType arg `unionNameSets` namesOfType res
840 namesOfType (AppTy fun arg) = namesOfType fun `unionNameSets` namesOfType arg
841 namesOfType (ForAllTy tyvar ty) = namesOfType ty `minusNameSet` unitNameSet (getName tyvar)
843 namesOfTypes tys = foldr (unionNameSets . namesOfType) emptyNameSet tys
847 %************************************************************************
849 \subsection{TidyType}
851 %************************************************************************
853 tidyTy tidies up a type for printing in an error message, or in
856 It doesn't change the uniques at all, just the print names.
859 tidyTyVar :: TidyEnv -> TyVar -> (TidyEnv, TyVar)
860 tidyTyVar env@(tidy_env, subst) tyvar
861 = case lookupVarEnv subst tyvar of
863 Just tyvar' -> -- Already substituted
866 Nothing -> -- Make a new nice name for it
868 case tidyOccName tidy_env (getOccName name) of
869 (tidy', occ') -> -- New occname reqd
870 ((tidy', subst'), tyvar')
872 subst' = extendVarEnv subst tyvar tyvar'
873 tyvar' = setTyVarName tyvar name'
874 name' = mkLocalName (getUnique name) occ' noSrcLoc
875 -- Note: make a *user* tyvar, so it printes nicely
876 -- Could extract src loc, but no need.
878 name = tyVarName tyvar
880 tidyTyVars env tyvars = mapAccumL tidyTyVar env tyvars
882 tidyType :: TidyEnv -> Type -> Type
883 tidyType env@(tidy_env, subst) ty
886 go (TyVarTy tv) = case lookupVarEnv subst tv of
887 Nothing -> TyVarTy tv
888 Just tv' -> TyVarTy tv'
889 go (TyConApp tycon tys) = let args = map go tys
890 in args `seqList` TyConApp tycon args
891 go (NoteTy note ty) = (NoteTy SAPPLY (go_note note)) SAPPLY (go ty)
892 go (AppTy fun arg) = (AppTy SAPPLY (go fun)) SAPPLY (go arg)
893 go (FunTy fun arg) = (FunTy SAPPLY (go fun)) SAPPLY (go arg)
894 go (ForAllTy tv ty) = ForAllTy tvp SAPPLY (tidyType envp ty)
896 (envp, tvp) = tidyTyVar env tv
898 go_note (SynNote ty) = SynNote SAPPLY (go ty)
899 go_note note@(FTVNote ftvs) = note -- No need to tidy the free tyvars
900 go_note note@(UsgNote _) = note -- Usage annotation is already tidy
901 go_note note@(UsgForAll _) = note -- Uvar binder is already tidy
902 go_note (IPNote n) = IPNote (tidyIPName n)
904 tidyTypes env tys = map (tidyType env) tys
908 @tidyOpenType@ grabs the free type variables, tidies them
909 and then uses @tidyType@ to work over the type itself
912 tidyOpenType :: TidyEnv -> Type -> (TidyEnv, Type)
914 = (env', tidyType env' ty)
916 env' = foldl go env (varSetElems (tyVarsOfType ty))
917 go env tyvar = fst (tidyTyVar env tyvar)
919 tidyOpenTypes :: TidyEnv -> [Type] -> (TidyEnv, [Type])
920 tidyOpenTypes env tys = mapAccumL tidyOpenType env tys
922 tidyTopType :: Type -> Type
923 tidyTopType ty = tidyType emptyTidyEnv ty
927 tidyIPName :: Name -> Name
929 = mkLocalName (getUnique name) (getOccName name) noSrcLoc
933 %************************************************************************
935 \subsection{Boxedness and liftedness}
937 %************************************************************************
940 isUnboxedType :: Type -> Bool
941 isUnboxedType ty = not (isFollowableRep (typePrimRep ty))
943 isUnLiftedType :: Type -> Bool
944 -- isUnLiftedType returns True for forall'd unlifted types:
945 -- x :: forall a. Int#
946 -- I found bindings like these were getting floated to the top level.
947 -- They are pretty bogus types, mind you. It would be better never to
950 isUnLiftedType (ForAllTy tv ty) = isUnLiftedType ty
951 isUnLiftedType (NoteTy _ ty) = isUnLiftedType ty
952 isUnLiftedType (TyConApp tc _) = isUnLiftedTyCon tc
953 isUnLiftedType other = False
955 isUnboxedTupleType :: Type -> Bool
956 isUnboxedTupleType ty = case splitTyConApp_maybe ty of
957 Just (tc, ty_args) -> isUnboxedTupleTyCon tc
960 -- Should only be applied to *types*; hence the assert
961 isAlgType :: Type -> Bool
962 isAlgType ty = case splitTyConApp_maybe ty of
963 Just (tc, ty_args) -> ASSERT( length ty_args == tyConArity tc )
967 -- Should only be applied to *types*; hence the assert
968 isDataType :: Type -> Bool
969 isDataType ty = case splitTyConApp_maybe ty of
970 Just (tc, ty_args) -> ASSERT( length ty_args == tyConArity tc )
974 isNewType :: Type -> Bool
975 isNewType ty = case splitTyConApp_maybe ty of
976 Just (tc, ty_args) -> ASSERT( length ty_args == tyConArity tc )
982 %************************************************************************
984 \subsection{Sequencing on types
986 %************************************************************************
989 seqType :: Type -> ()
990 seqType (TyVarTy tv) = tv `seq` ()
991 seqType (AppTy t1 t2) = seqType t1 `seq` seqType t2
992 seqType (FunTy t1 t2) = seqType t1 `seq` seqType t2
993 seqType (NoteTy note t2) = seqNote note `seq` seqType t2
994 seqType (TyConApp tc tys) = tc `seq` seqTypes tys
995 seqType (ForAllTy tv ty) = tv `seq` seqType ty
997 seqTypes :: [Type] -> ()
999 seqTypes (ty:tys) = seqType ty `seq` seqTypes tys
1001 seqNote :: TyNote -> ()
1002 seqNote (SynNote ty) = seqType ty
1003 seqNote (FTVNote set) = sizeUniqSet set `seq` ()
1004 seqNote (UsgNote usg) = usg `seq` ()
1005 seqNote (IPNote nm) = nm `seq` ()