Minor refactoring
[ghc-hetmet.git] / compiler / types / Coercion.lhs
index eda45a3..bec90db 100644 (file)
@@ -31,8 +31,8 @@ module Coercion (
        mkCoercion,
         mkSymCoercion, mkTransCoercion,
         mkLeftCoercion, mkRightCoercion, mkRightCoercions,
-       mkInstCoercion, mkAppCoercion,
-        mkForAllCoercion, mkFunCoercion, mkInstsCoercion, mkUnsafeCoercion,
+       mkInstCoercion, mkAppCoercion, mkTyConCoercion, mkFunCoercion,
+        mkForAllCoercion, mkInstsCoercion, mkUnsafeCoercion,
         mkNewTypeCoercion, mkFamInstCoercion, mkAppsCoercion,
 
         splitNewTypeRepCo_maybe, instNewTyCon_maybe, decomposeCo,
@@ -41,6 +41,9 @@ module Coercion (
         transCoercionTyCon, leftCoercionTyCon, 
         rightCoercionTyCon, instCoercionTyCon, -- needed by TysWiredIn
 
+        -- ** Optimisation
+       optCoercion,
+
         -- ** Comparison
         coreEqCoercion,
 
@@ -63,10 +66,8 @@ import TyCon
 import Class
 import Var
 import Name
-import OccName
 import PrelNames
 import Util
-import Unique
 import BasicTypes
 import Outputable
 import FastString
@@ -200,36 +201,40 @@ mkCoercion :: TyCon -> [Type] -> Coercion
 mkCoercion coCon args = ASSERT( tyConArity coCon == length args ) 
                         TyConApp coCon args
 
--- | Apply a 'Coercion' to another 'Coercion', which is presumably a 'Coercion' constructor of some
--- kind
+-- | Apply a 'Coercion' to another 'Coercion', which is presumably a
+-- 'Coercion' constructor of some kind
 mkAppCoercion :: Coercion -> Coercion -> Coercion
-mkAppCoercion    co1 co2 = mkAppTy co1 co2
+mkAppCoercion co1 co2 = mkAppTy co1 co2
 
 -- | Applies multiple 'Coercion's to another 'Coercion', from left to right.
 -- See also 'mkAppCoercion'
 mkAppsCoercion :: Coercion -> [Coercion] -> Coercion
-mkAppsCoercion   co1 tys = foldl mkAppTy co1 tys
+mkAppsCoercion co1 tys = foldl mkAppTy co1 tys
+
+-- | Apply a type constructor to a list of coercions.
+mkTyConCoercion :: TyCon -> [Coercion] -> Coercion
+mkTyConCoercion con cos = mkTyConApp con cos
+
+-- | Make a function 'Coercion' between two other 'Coercion's
+mkFunCoercion :: Coercion -> Coercion -> Coercion
+mkFunCoercion co1 co2 = mkFunTy co1 co2
 
 -- | Make a 'Coercion' which binds a variable within an inner 'Coercion'
 mkForAllCoercion :: Var -> Coercion -> Coercion
 -- note that a TyVar should be used here, not a CoVar (nor a TcTyVar)
 mkForAllCoercion tv  co  = ASSERT ( isTyVar tv ) mkForAllTy tv co
 
--- | Make a function 'Coercion' between two other 'Coercion's
-mkFunCoercion :: Coercion -> Coercion -> Coercion
-mkFunCoercion    co1 co2 = mkFunTy co1 co2
-
 
 -------------------------------
 
 mkSymCoercion :: Coercion -> Coercion
--- ^ Create a symmetric version of the given 'Coercion' that asserts equality between
--- the same types but in the other "direction", so a kind of @t1 ~ t2@ becomes the
--- kind @t2 ~ t1@.
+-- ^ Create a symmetric version of the given 'Coercion' that asserts equality
+-- between the same types but in the other "direction", so a kind of @t1 ~ t2@ 
+-- becomes the kind @t2 ~ t1@.
 --
--- This function attempts to simplify the generated 'Coercion' by removing redundant applications
--- of @sym@. This is done by pushing this new @sym@ down into the 'Coercion' and exploiting the fact that 
--- @sym (sym co) = co@.
+-- This function attempts to simplify the generated 'Coercion' by removing 
+-- redundant applications of @sym@. This is done by pushing this new @sym@ 
+-- down into the 'Coercion' and exploiting the fact that @sym (sym co) = co@.
 mkSymCoercion co      
   | Just co' <- coreView co = mkSymCoercion co'
 
@@ -665,3 +670,107 @@ mkEqPredCoI _    IdCo     _   IdCo      = IdCo
 mkEqPredCoI ty1  IdCo     _   (ACo co2) = ACo $ PredTy $ EqPred ty1 co2
 mkEqPredCoI _   (ACo co1) ty2 coi2      = ACo $ PredTy $ EqPred co1 (fromCoI coi2 ty2)
 \end{code}
+
+%************************************************************************
+%*                                                                      *
+                 Optimising coercions                                                                  
+%*                                                                      *
+%************************************************************************
+
+\begin{code}
+optCoercion :: Coercion -> Coercion
+optCoercion co
+  = ASSERT2( coercionKind co `eq` coercionKind result, 
+             ppr co $$ ppr result $$ ppr (coercionKind co) $$ ppr (coercionKind result) )
+    result
+  where
+        (s1,t1) `eq` (s2,t2) = s1 `coreEqType` s2 && t1 `coreEqType` t2
+
+        (result,_,_) = go co
+                         -- optimized, changed?, identity?
+        go :: Coercion -> ( Coercion, Bool, Bool )
+        -- traverse coercion term bottom up and return
+        --
+        --    1) equivalent coercion, in optimized form
+        --
+        --    2) whether the output coercion differs from
+        --       the input coercion
+        --
+        --    3) whether the coercion is an identity coercion
+        --
+        -- Performs the following optimizations:
+        --
+        --      sym id          >->     id
+        --      trans id co     >->     co
+        --      trans co id     >->     co
+        --
+        go ty@(TyVarTy a) | isCoVar a = let (ty1,ty2) = coercionKind ty
+                                        in (ty, False, ty1 `coreEqType` ty2)
+                          | otherwise = (ty, False, True)
+        go ty@(AppTy ty1 ty2)
+          = let (ty1', chan1, id1) = go ty1
+                (ty2', chan2, id2) = go ty2
+            in if chan1 || chan2
+                 then (AppTy ty1' ty2', True,  id1 && id2)
+                 else (ty             , False, id1 && id2)
+        go ty@(TyConApp tc args)
+          | tc == symCoercionTyCon, [ty1] <- args
+          = case go ty1 of
+              (ty1', _   ,    True) -> (ty1', True, True)
+              (ty1', True, _      ) -> (TyConApp tc [ty1'], True, False)
+              (_   , _   , _      ) -> (ty, False, False)
+          | tc == transCoercionTyCon, [ty1,ty2] <- args
+          = let (ty1', chan1, id1) = go ty1
+                (ty2', chan2, id2) = go ty2
+            in  if id1
+                  then (ty2', True, id2)
+                  else if id2
+                         then (ty1', True, False)
+                         else if chan1 || chan2
+                                then (TyConApp tc [ty1',ty2'], True , False)
+                                else (ty                     , False, False)
+          | tc == leftCoercionTyCon, [ty1] <- args
+          = let (ty1', chan1, id1) = go ty1
+            in  if chan1
+                  then (TyConApp tc [ty1'], True , id1)
+                  else (ty                , False, id1) 
+          | tc == rightCoercionTyCon, [ty1] <- args
+          = let (ty1', chan1, id1) = go ty1
+            in  if chan1
+                  then (TyConApp tc [ty1'], True , id1)
+                  else (ty                , False, id1) 
+         | not (isCoercionTyCon tc)
+          = let (args', chans, ids) = mapAndUnzip3 go args
+            in  if or chans
+                  then (TyConApp tc args', True , and ids)
+                  else (ty               , False, and ids) 
+          | otherwise
+          = (ty, False, False)
+        go ty@(FunTy ty1 ty2)
+          = let (ty1',chan1,id1) = go ty1
+                (ty2',chan2,id2) = go ty2
+            in  if chan1 || chan2
+                  then (FunTy ty1' ty2', True , id1 && id2)
+                  else (ty             , False, id1 && id2)
+        go ty@(ForAllTy tv ty1)
+          = let (ty1', chan1, id1) = go ty1
+            in if chan1
+                 then (ForAllTy tv ty1', True , id1)
+                 else (ty              , False, id1)
+        go ty@(PredTy (EqPred ty1 ty2))
+          = let (ty1', chan1, id1) = go ty1
+                (ty2', chan2, id2) = go ty2
+            in if chan1 || chan2
+                 then (PredTy (EqPred ty1' ty2'), True , id1 && id2)
+                 else (ty                       , False, id1 && id2)
+        go ty@(PredTy (ClassP cl args))
+          = let (args', chans, ids) = mapAndUnzip3 go args
+            in  if or chans
+                  then (PredTy (ClassP cl args'), True , and ids)
+                  else (ty                      , False, and ids)
+        go ty@(PredTy (IParam name ty1))
+          = let (ty1', chan1, id1) = go ty1
+            in  if chan1
+                  then (PredTy (IParam name ty1'), True , id1)
+                  else (ty                       , False, id1)
+\end{code}