mkSymCoercion, mkTransCoercion,
mkLeftCoercion, mkRightCoercion, mkInstCoercion, mkAppCoercion,
mkForAllCoercion, mkFunCoercion, mkInstsCoercion, mkUnsafeCoercion,
- mkNewTypeCoercion, mkAppsCoercion,
+ mkNewTypeCoercion, mkDataInstCoercion, mkAppsCoercion,
splitNewTypeRepCo_maybe, decomposeCo,
import TypeRep
import Type ( Type, Kind, PredType, substTyWith, mkAppTy, mkForAllTy,
mkFunTy, splitAppTy_maybe, splitForAllTy_maybe, coreView,
- kindView, mkTyConApp, isCoercionKind, isEqPred, mkAppTys
+ kindView, mkTyConApp, isCoercionKind, isEqPred, mkAppTys,
+ coreEqType, splitAppTys, isTyVarTy, splitTyConApp_maybe
)
-import TyCon ( TyCon, tyConArity, mkCoercionTyCon, isNewTyCon,
- newTyConRhs, newTyConCo,
+import TyCon ( TyCon, tyConArity, mkCoercionTyCon, isClosedNewTyCon,
+ newTyConRhs, newTyConCo_maybe,
isCoercionTyCon, isCoercionTyCon_maybe )
import Var ( Var, TyVar, isTyVar, tyVarKind )
import Name ( BuiltInSyntax(..), Name, mkWiredInName, tcName )
------------------------------
decomposeCo :: Arity -> Coercion -> [Coercion]
-- (decomposeCo 3 c) = [right (left (left c)), right (left c), right c]
+-- So this breaks a coercion with kind T A B C :=: T D E F into
+-- a list of coercions of kinds A :=: D, B :=: E and E :=: F
decomposeCo n co
= go n co []
where
coercionKind :: Coercion -> (Type, Type)
-- c :: (t1 :=: t2)
-- Then (coercionKind c) = (t1,t2)
-
-coercionKind (TyVarTy a) | isCoVar a = splitCoercionKind (tyVarKind a)
- | otherwise = let t = (TyVarTy a) in (t, t)
+coercionKind ty@(TyVarTy a) | isCoVar a = splitCoercionKind (tyVarKind a)
+ | otherwise = (ty, ty)
coercionKind (AppTy ty1 ty2)
= let (t1, t2) = coercionKind ty1
(s1, s2) = coercionKind ty2 in
(mkAppTy t1 s1, mkAppTy t2 s2)
coercionKind (TyConApp tc args)
| Just (ar, rule) <- isCoercionTyCon_maybe tc
- = if length args >= ar
- then splitCoercionKind (rule args)
- else pprPanic ("arity/arguments mismatch in coercionKind:")
- (ppr ar $$ ppr tc <+> ppr args)
+ -- CoercionTyCons carry their kinding rule, so we use it here
+ = ASSERT( length args >= ar ) -- Always saturated
+ let (ty1,ty2) = rule (take ar args) -- Apply the rule to the right number of args
+ (tys1, tys2) = coercionKinds (drop ar args)
+ in (mkAppTys ty1 tys1, mkAppTys ty2 tys2)
+
| otherwise
= let (lArgs, rArgs) = coercionKinds args in
(TyConApp tc lArgs, TyConApp tc rArgs)
mkForAllCoercion tv co = ASSERT ( isTyVar tv ) mkForAllTy tv co
mkFunCoercion co1 co2 = mkFunTy co1 co2
+
+-- This smart constructor creates a sym'ed version its argument,
+-- but tries to push the sym's down to the leaves. If we come to
+-- sym tv or sym tycon then we can drop the sym because tv and tycon
+-- are reflexive coercions
mkSymCoercion co
| Just co2 <- splitSymCoercion_maybe co = co2
- | Just (co1, co2) <- splitAppCoercion_maybe co
- -- should make this case better
- = mkAppCoercion (mkSymCoercion co1) (mkSymCoercion co2)
+ -- sym (sym co) --> co
+ | Just (co1, arg_tys) <- splitTyConApp_maybe co
+ , not (isCoercionTyCon co1) = mkTyConApp co1 (map mkSymCoercion arg_tys)
+ -- we can drop the sym for a TyCon
+ -- sym (ty [t1, ..., tn]) --> ty [sym t1, ..., sym tn]
+ | (co1, arg_tys) <- splitAppTys co
+ , isTyVarTy co1 = mkAppTys (maybe_drop co1) (map mkSymCoercion arg_tys)
+ -- sym (tv [t1, ..., tn]) --> tv [sym t1, ..., sym tn]
+ -- if tv type variable
+ -- sym (cv [t1, ..., tn]) --> (sym cv) [sym t1, ..., sym tn]
+ -- if cv is a coercion variable
+ -- fall through if head is a CoercionTyCon
| Just (co1, co2) <- splitTransCoercion_maybe co
- = mkTransCoercion (mkSymCoercion co1) (mkSymCoercion co2)
+ -- sym (co1 `trans` co2) --> (sym co2) `trans (sym co2)
+ = mkTransCoercion (mkSymCoercion co2) (mkSymCoercion co1)
| Just (co, ty) <- splitInstCoercion_maybe co
+ -- sym (co @ ty) --> (sym co) @ ty
= mkInstCoercion (mkSymCoercion co) ty
| Just co <- splitLeftCoercion_maybe co
+ -- sym (left co) --> left (sym co)
= mkLeftCoercion (mkSymCoercion co)
| Just co <- splitRightCoercion_maybe co
+ -- sym (right co) --> right (sym co)
= mkRightCoercion (mkSymCoercion co)
+ where
+ maybe_drop (TyVarTy tv)
+ | isCoVar tv = mkCoercion symCoercionTyCon [TyVarTy tv]
+ | otherwise = TyVarTy tv
+ maybe_drop other = other
mkSymCoercion (ForAllTy tv ty) = ForAllTy tv (mkSymCoercion ty)
-- for atomic types and constructors, we can just ignore sym since these
-- are reflexive coercions
| isCoVar tv = mkCoercion symCoercionTyCon [TyVarTy tv]
| otherwise = TyVarTy tv
mkSymCoercion co = mkCoercion symCoercionTyCon [co]
- -- this should not happen but does
-- Smart constructors for left and right
mkLeftCoercion co
splitRightCoercion_maybe other = Nothing
-- Unsafe coercion is not safe, it is used when we know we are dealing with
--- bottom, which is the one case in which it is safe
+-- bottom, which is one case in which it is safe. It is also used to
+-- implement the unsafeCoerce# primitive.
mkUnsafeCoercion :: Type -> Type -> Coercion
mkUnsafeCoercion ty1 ty2
= mkCoercion unsafeCoercionTyCon [ty1, ty2]
--- make the coercion associated with a newtype
-mkNewTypeCoercion :: Name -> TyCon -> [TyVar] -> Type -> TyCon
-mkNewTypeCoercion name tycon tvs rhs_ty
- = ASSERT (length tvs == tyConArity tycon)
- mkCoercionTyCon name (tyConArity tycon) rule
+-- See note [Newtype coercions] in TyCon
+mkNewTypeCoercion :: Name -> TyCon -> ([TyVar], Type) -> TyCon
+mkNewTypeCoercion name tycon (tvs, rhs_ty)
+ = mkCoercionTyCon name co_con_arity rule
+ where
+ co_con_arity = length tvs
+
+ rule args = ASSERT( co_con_arity == length args )
+ (TyConApp tycon args, substTyWith tvs args rhs_ty)
+
+-- Coercion identifying a data/newtype representation type and its family
+-- instance. It has the form `Co tvs :: F ts :=: R tvs', where `Co' is the
+-- coercion tycon built here, `F' the family tycon and `R' the (derived)
+-- representation tycon.
+--
+mkDataInstCoercion :: Name -- unique name for the coercion tycon
+ -> [TyVar] -- type parameters of the coercion (`tvs')
+ -> TyCon -- family tycon (`F')
+ -> [Type] -- type instance (`ts')
+ -> TyCon -- representation tycon (`R')
+ -> TyCon -- => coercion tycon (`Co')
+mkDataInstCoercion name tvs family instTys rep_tycon
+ = mkCoercionTyCon name coArity rule
where
- rule args = mkCoKind (substTyWith tvs args rhs_ty) (TyConApp tycon args)
+ coArity = length tvs
+ rule args = (substTyWith tvs args $ -- with sigma = [tys/tvs],
+ TyConApp family instTys, -- sigma (F ts)
+ TyConApp rep_tycon args) -- :=: R tys
--------------------------------------
-- Coercion Type Constructors...
-- sym d :: p2=q2
-- sym e :: p3=q3
-- then ((sym c) (sym d) (sym e)) :: (p1 p2 p3)=(q1 q2 q3)
---
--- (mkKindingFun f) is given the args [c, sym d, sym e]
-mkKindingFun :: ([Type] -> (Type, Type, [Type])) -> [Type] -> Kind
-mkKindingFun f args =
- let (ty1, ty2, rest) = f args in
- let (argtys1, argtys2) = unzip (map coercionKind rest) in
- mkCoKind (mkAppTys ty1 argtys1) (mkAppTys ty2 argtys2)
-
symCoercionTyCon, transCoercionTyCon, leftCoercionTyCon, rightCoercionTyCon, instCoercionTyCon :: TyCon
-- Each coercion TyCon is built with the special CoercionTyCon record and
--- carries its won kinding rule. Such CoercionTyCons must be fully applied
+-- carries its own kinding rule. Such CoercionTyCons must be fully applied
-- by any TyConApp in which they are applied, however they may also be over
-- applied (see example above) and the kinding function must deal with this.
symCoercionTyCon =
- mkCoercionTyCon symCoercionTyConName 1 (mkKindingFun flipCoercionKindOf)
+ mkCoercionTyCon symCoercionTyConName 1 flipCoercionKindOf
where
- flipCoercionKindOf (co:rest) = (ty2, ty1, rest)
+ flipCoercionKindOf (co:rest) = ASSERT( null rest ) (ty2, ty1)
where
(ty1, ty2) = coercionKind co
transCoercionTyCon =
- mkCoercionTyCon transCoercionTyConName 2 (mkKindingFun composeCoercionKindsOf)
+ mkCoercionTyCon transCoercionTyConName 2 composeCoercionKindsOf
where
- composeCoercionKindsOf (co1:co2:rest) = (a1, r2, rest)
+ composeCoercionKindsOf (co1:co2:rest)
+ = ASSERT( null rest )
+ WARN( not (r1 `coreEqType` a2), text "Strange! Type mismatch in trans coercion, probably a bug")
+ (a1, r2)
where
(a1, r1) = coercionKind co1
(a2, r2) = coercionKind co2
leftCoercionTyCon =
- mkCoercionTyCon leftCoercionTyConName 1 (mkKindingFun leftProjectCoercionKindOf)
+ mkCoercionTyCon leftCoercionTyConName 1 leftProjectCoercionKindOf
where
- leftProjectCoercionKindOf (co:rest) = (ty1, ty2, rest)
+ leftProjectCoercionKindOf (co:rest) = ASSERT( null rest ) (ty1, ty2)
where
(ty1,ty2) = fst (splitCoercionKindOf co)
rightCoercionTyCon =
- mkCoercionTyCon rightCoercionTyConName 1 (mkKindingFun rightProjectCoercionKindOf)
+ mkCoercionTyCon rightCoercionTyConName 1 rightProjectCoercionKindOf
where
- rightProjectCoercionKindOf (co:rest) = (ty1, ty2, rest)
+ rightProjectCoercionKindOf (co:rest) = ASSERT( null rest ) (ty1, ty2)
where
(ty1,ty2) = snd (splitCoercionKindOf co)
= ((ty_fun1, ty_fun2),(ty_arg1, ty_arg2))
instCoercionTyCon
- = mkCoercionTyCon instCoercionTyConName 2 (mkKindingFun instCoercionKind)
+ = mkCoercionTyCon instCoercionTyConName 2 instCoercionKind
where
instantiateCo t s =
let Just (tv, ty) = splitForAllTy_maybe t in
substTyWith [tv] [s] ty
- instCoercionKind (co1:ty:rest) = (instantiateCo t1 ty, instantiateCo t2 ty, rest)
+ instCoercionKind (co1:ty:rest) = ASSERT( null rest )
+ (instantiateCo t1 ty, instantiateCo t2 ty)
where (t1, t2) = coercionKind co1
unsafeCoercionTyCon
- = mkCoercionTyCon unsafeCoercionTyConName 2 (mkKindingFun unsafeCoercionKind)
+ = mkCoercionTyCon unsafeCoercionTyConName 2 unsafeCoercionKind
where
- unsafeCoercionKind (ty1:ty2:rest) = (ty1,ty2,rest)
+ unsafeCoercionKind (ty1:ty2:rest) = ASSERT( null rest ) (ty1,ty2)
--------------------------------------
-- ...and their names
mkCoConName occ key coCon = mkWiredInName gHC_PRIM (mkOccNameFS tcName occ)
- key Nothing (ATyCon coCon) BuiltInSyntax
+ key (ATyCon coCon) BuiltInSyntax
transCoercionTyConName = mkCoConName FSLIT("trans") transCoercionTyConKey transCoercionTyCon
symCoercionTyConName = mkCoConName FSLIT("sym") symCoercionTyConKey symCoercionTyCon
-- this is here to avoid module loops
splitNewTypeRepCo_maybe :: Type -> Maybe (Type, Coercion)
--- Sometimes we want to look through a recursive newtype, and that's what happens here
+-- Sometimes we want to look through a newtype and get its associated coercion
-- It only strips *one layer* off, so the caller will usually call itself recursively
-- Only applied to types of kind *, hence the newtype is always saturated
splitNewTypeRepCo_maybe ty
| Just ty' <- coreView ty = splitNewTypeRepCo_maybe ty'
splitNewTypeRepCo_maybe (TyConApp tc tys)
- | isNewTyCon tc
+ | isClosedNewTyCon tc
= ASSERT( tys `lengthIs` tyConArity tc ) -- splitNewTypeRepCo_maybe only be applied
-- to *types* (of kind *)
case newTyConRhs tc of
ASSERT( length tvs == length tys )
Just (substTyWith tvs tys rep_ty, mkTyConApp co_con tys)
where
- co_con = maybe (pprPanic "splitNewTypeRepCo_maybe" (ppr tc)) id (newTyConCo tc)
-
+ co_con = maybe (pprPanic "splitNewTypeRepCo_maybe" (ppr tc)) id (newTyConCo_maybe tc)
splitNewTypeRepCo_maybe other = Nothing
\end{code}