Global renamings in HsSyn
[ghc-hetmet.git] / compiler / typecheck / TcGadt.lhs
index deac1eb..87f2c8d 100644 (file)
@@ -16,25 +16,27 @@ module TcGadt (
        tcUnifyTys, BindFlag(..)
   ) where
 
-import HsSyn   ( ExprCoFn(..), idCoercion, isIdCoercion )
+import HsSyn   ( HsWrapper(..), idHsWrapper, isIdHsWrapper )
 import Coercion        ( Coercion, mkSymCoercion, mkTransCoercion, mkUnsafeCoercion,
-                 mkLeftCoercion, mkRightCoercion,
-                 splitCoercionKind, decomposeCo )
+                 mkLeftCoercion, mkRightCoercion, mkCoKind, coercionKindPredTy,
+                 splitCoercionKind, decomposeCo, coercionKind )
 import TcType  ( TvSubst(..), TvSubstEnv, substTy, mkTvSubst, 
                  substTyVar, zipTopTvSubst, typeKind,
                  eqKind, isSubKind, repSplitAppTy_maybe,
-                 tcView
+                 tcView, tcGetTyVar_maybe
                )
-import Type    ( Type, tyVarsOfType, tyVarsOfTypes )
+import Type    ( Type, tyVarsOfType, tyVarsOfTypes, tcEqType, mkTyVarTy )
 import TypeRep ( Type(..), PredType(..) )
 import DataCon ( DataCon, dataConUnivTyVars, dataConEqSpec )
-import Var     ( CoVar, TyVar, tyVarKind )
+import Var     ( CoVar, TyVar, tyVarKind, varUnique )
 import VarEnv
 import VarSet
 import ErrUtils                ( Message )
 import Maybes          ( MaybeErr(..), isJust )
 import Control.Monad   ( foldM )
 import Outputable
+import Unique          ( Unique )
+import UniqFM          ( ufmToList )
 
 #include "HsVersions.h"
 \end{code}
@@ -59,29 +61,30 @@ instance Outputable Refinement where
 emptyRefinement :: Refinement
 emptyRefinement = (Reft emptyInScopeSet emptyVarEnv)
 
-refineType :: Refinement -> Type -> (ExprCoFn, Type)
+
+refineType :: Refinement -> Type -> (HsWrapper, Type)
 -- Apply the refinement to the type.
 -- If (refineType r ty) = (co, ty')
 -- Then co :: ty:=:ty'
 refineType (Reft in_scope env) ty
   | not (isEmptyVarEnv env),           -- Common case
     any (`elemVarEnv` env) (varSetElems (tyVarsOfType ty))
-  = (ExprCoFn (substTy co_subst ty), substTy tv_subst ty)
+  = (WpCo (substTy co_subst ty), substTy tv_subst ty)
   | otherwise
-  = (idCoercion, ty)   -- The type doesn't mention any refined type variables
+  = (idHsWrapper, ty)  -- The type doesn't mention any refined type variables
   where
     tv_subst = mkTvSubst in_scope (mapVarEnv snd env)
     co_subst = mkTvSubst in_scope (mapVarEnv fst env)
  
-refineResType :: Refinement -> Type -> (ExprCoFn, Type)
+refineResType :: Refinement -> Type -> (HsWrapper, Type)
 -- Like refineType, but returns the 'sym' coercion
 -- If (refineResType r ty) = (co, ty')
 -- Then co :: ty':=:ty
 refineResType reft ty
   = case refineType reft ty of
-       (ExprCoFn co, ty1) -> (ExprCoFn (mkSymCoercion co), ty1)
-       (id_co,       ty1) -> ASSERT( isIdCoercion id_co )
-                             (idCoercion, ty1)
+       (WpCo co, ty1) -> (WpCo (mkSymCoercion co), ty1)
+       (id_co,   ty1) -> ASSERT( isIdHsWrapper id_co )
+                         (idHsWrapper, ty1)
 \end{code}
 
 
@@ -140,7 +143,9 @@ gadtRefine (Reft in_scope env1)
 -- That is, the kinds of the co_vars are a
 -- fixed point of the  incoming refinement
 
-  = initUM (tryToBind tv_set) $
+  = ASSERT2( not $ any (`elemVarEnv` env1) (varSetElems $ tyVarsOfTypes $ map tyVarKind co_vars),
+            ppr env1 $$ ppr co_vars $$ ppr (map tyVarKind co_vars) )
+    initUM (tryToBind tv_set) $
     do {       -- Run the unifier, starting with an empty env
        ; env2 <- foldM do_one emptyInternalReft co_vars
 
@@ -148,7 +153,9 @@ gadtRefine (Reft in_scope env1)
                -- non-idempotent substitution
        ; let tmp_env = env1 `plusVarEnv` env2
               out_env = fixTvCoEnv in_scope' tmp_env
-       ; return (Reft in_scope' out_env) }
+       ; WARN( not (null (badReftElts tmp_env)), ppr (badReftElts tmp_env) $$ ppr tmp_env )
+         WARN( not (null (badReftElts out_env)), ppr (badReftElts out_env) $$ ppr out_env )
+         return (Reft in_scope' out_env) }
   where
     tv_set = mkVarSet ex_tvs
     in_scope' = foldr extend in_scope co_vars
@@ -201,15 +208,15 @@ fixTvCoEnv in_scope env
   where
     fixpt         = mapVarEnv step env
 
-    step (co, ty) = (co', ty')
+    step (co, ty) = (co1, ty')
       -- Apply fixpt one step:
       -- Use refineType to get a substituted type, ty', and a coercion, co_fn,
       -- which justifies the substitution.  If the coercion is not the identity
       -- then use transitivity with the original coercion
       where
         (co_fn, ty') = refineType (Reft in_scope fixpt) ty
-        co' | ExprCoFn co'' <- co_fn = mkTransCoercion co co''
-            | otherwise              = ASSERT( isIdCoercion co_fn ) co 
+        co1 | WpCo co'' <- co_fn = mkTransCoercion co co''
+            | otherwise          = ASSERT( isIdHsWrapper co_fn ) co 
 
 -----------------------------
 fixTvSubstEnv :: InScopeSet -> TvSubstEnv -> TvSubstEnv
@@ -237,6 +244,8 @@ dataConCanMatch con tys
 tryToBind :: TyVarSet -> TyVar -> BindFlag
 tryToBind tv_set tv | tv `elemVarSet` tv_set = BindMe
                    | otherwise              = AvoidMe
+
+
 \end{code}
 
 
@@ -252,6 +261,19 @@ type InternalReft = TyVarEnv (Coercion, Type)
 -- INVARIANT:   a->(co,ty)   then   co :: (a:=:ty)
 -- Not necessarily idemopotent
 
+badReftElts :: InternalReft -> [(Unique, (Coercion,Type))]
+-- Return the BAD elements of the refinement
+-- Should be empty; used in asserions only
+badReftElts env
+  = filter (not . ok) (ufmToList env)
+  where
+    ok :: (Unique, (Coercion, Type)) -> Bool
+    ok (u, (co, ty)) | Just tv <- tcGetTyVar_maybe ty1
+                    = varUnique tv == u && ty `tcEqType` ty2 
+                    | otherwise = False
+       where
+         (ty1,ty2) = coercionKind co
+
 emptyInternalReft :: InternalReft
 emptyInternalReft = emptyVarEnv
 
@@ -352,11 +374,12 @@ uVar swap subst co tv1 ty
        -> unify subst (mkTransCoercion (mkSymCoercion co') co) ty' ty
 
      -- No, continue
-     Nothing -> uUnrefined subst (if swap then mkSymCoercion co else co)
+     Nothing -> uUnrefined swap subst co
                           tv1 ty ty
 
 
-uUnrefined :: InternalReft        -- An existing substitution to extend
+uUnrefined :: Bool                -- Whether the input is swapped
+           -> InternalReft        -- An existing substitution to extend
           -> Coercion
            -> TyVar               -- Type variable to be unified
            -> Type                -- with this type
@@ -364,62 +387,62 @@ uUnrefined :: InternalReft        -- An existing substitution to extend
            -> UM InternalReft
 
 -- We know that tv1 isn't refined
--- PRE-CONDITION: in the call (uUnrefined r co tv ty ty'), we know that
---     co :: tv:=:ty
+-- PRE-CONDITION: in the call (uUnrefined False r co tv1 ty2 ty2'), we know that
+--     co :: tv1:=:ty2
+-- and if the first argument is True instead, we know
+--      co :: ty2:=:tv1
 
-uUnrefined subst co tv1 ty2 ty2'
+uUnrefined swap subst co tv1 ty2 ty2'
   | Just ty2'' <- tcView ty2'
-  = uUnrefined subst co tv1 ty2 ty2''  -- Unwrap synonyms
+  = uUnrefined swap subst co tv1 ty2 ty2''     -- Unwrap synonyms
                -- This is essential, in case we have
                --      type Foo a = a
                -- and then unify a :=: Foo a
 
-uUnrefined subst co tv1 ty2 (TyVarTy tv2)
+uUnrefined swap subst co tv1 ty2 (TyVarTy tv2)
   | tv1 == tv2         -- Same type variable
   = return subst
 
     -- Check to see whether tv2 is refined
-  | Just (co',ty') <- lookupVarEnv subst tv2
-  = uUnrefined subst (mkTransCoercion co co') tv1 ty' ty'
+  | Just (co',ty') <- lookupVarEnv subst tv2   -- co' :: tv2:=:ty'
+  = uUnrefined False subst (mkTransCoercion (doSwap swap co) co') tv1 ty' ty'
 
   -- So both are unrefined; next, see if the kinds force the direction
   | eqKind k1 k2       -- Can update either; so check the bind-flags
   = do { b1 <- tvBindFlag tv1
        ; b2 <- tvBindFlag tv2
        ; case (b1,b2) of
-           (BindMe, _)          -> bind False tv1 ty2
+           (BindMe, _)          -> bind swap tv1 ty2
 
-           (AvoidMe, BindMe)    -> bind True tv2 ty1
-           (AvoidMe, _)         -> bind False tv1 ty2
+           (AvoidMe, BindMe)    -> bind (not swap) tv2 ty1
+           (AvoidMe, _)         -> bind swap tv1 ty2
 
            (WildCard, WildCard) -> return subst
            (WildCard, Skolem)   -> return subst
-           (WildCard, _)        -> bind True tv2 ty1
+           (WildCard, _)        -> bind (not swap) tv2 ty1
 
            (Skolem, WildCard)   -> return subst
            (Skolem, Skolem)     -> failWith (misMatch ty1 ty2)
-           (Skolem, _)          -> bind True tv2 ty1
+           (Skolem, _)          -> bind (not swap) tv2 ty1
        }
 
-  | k1 `isSubKind` k2 = bindTv subst (mkSymCoercion co) tv2 ty1        -- Must update tv2
-  | k2 `isSubKind` k1 = bindTv subst co tv1 ty2        -- Must update tv1
+  | k1 `isSubKind` k2 = bindTv (not swap) subst co tv2 ty1  -- Must update tv2
+  | k2 `isSubKind` k1 = bindTv swap subst co tv1 ty2       -- Must update tv1
 
   | otherwise = failWith (kindMisMatch tv1 ty2)
   where
     ty1 = TyVarTy tv1
     k1 = tyVarKind tv1
     k2 = tyVarKind tv2
-    bind swap tv ty = return (extendVarEnv subst tv (co',ty))
-      where
-        co' = if swap then mkSymCoercion co else co
+    bind swap tv ty = extendReft swap subst tv co ty
 
-uUnrefined subst co tv1 ty2 ty2'       -- ty2 is not a type variable
+uUnrefined swap subst co tv1 ty2 ty2'  -- ty2 is not a type variable
   | tv1 `elemVarSet` substTvSet subst (tyVarsOfType ty2')
   = failWith (occursCheck tv1 ty2)     -- Occurs check
   | not (k2 `isSubKind` k1)
   = failWith (kindMisMatch tv1 ty2)    -- Kind check
   | otherwise
-  = bindTv subst co tv1 ty2            -- Bind tyvar to the synonym if poss
+  = bindTv swap subst co tv1 ty2               -- Bind tyvar to the synonym if poss
   where
     k1 = tyVarKind tv1
     k2 = typeKind ty2'
@@ -434,13 +457,30 @@ substTvSet subst tvs
                Nothing     -> unitVarSet tv
                Just (_,ty) -> substTvSet subst (tyVarsOfType ty)
 
-bindTv subst co tv ty  -- ty is not a type variable
-  = do { b <- tvBindFlag tv
+bindTv swap subst co tv ty     -- ty is not a type variable
+  = do  { b <- tvBindFlag tv
        ; case b of
            Skolem   -> failWith (misMatch (TyVarTy tv) ty)
            WildCard -> return subst
-           other    -> return (extendVarEnv subst tv (co,ty))
+           other    -> extendReft swap subst tv co ty
        }
+
+doSwap :: Bool -> Coercion -> Coercion
+doSwap swap co = if swap then mkSymCoercion co else co
+
+extendReft :: Bool 
+           -> InternalReft 
+           -> TyVar 
+           -> Coercion 
+           -> Type 
+           -> UM InternalReft
+extendReft swap subst tv  co ty
+  = ASSERT2( (coercionKindPredTy co1 `tcEqType` mkCoKind (mkTyVarTy tv) ty), 
+          (text "Refinement invariant failure: co = " <+> ppr co1  <+> ppr (coercionKindPredTy co1) $$ text "subst = " <+> ppr tv <+> ppr (mkCoKind (mkTyVarTy tv) ty)) )
+    return (extendVarEnv subst tv (co1, ty))
+  where
+    co1 = doSwap swap co
+
 \end{code}
 
 %************************************************************************