[project @ 2001-12-21 10:30:32 by simonpj]
[ghc-hetmet.git] / ghc / compiler / typecheck / TcDeriv.lhs
index 9bc4540..9e54586 100644 (file)
@@ -18,7 +18,7 @@ import CmdLineOpts    ( DynFlag(..), DynFlags )
 
 import TcMonad
 import TcEnv           ( tcSetInstEnv, newDFunName, InstInfo(..), pprInstInfo,
-                         tcLookupClass, tcLookupTyCon
+                         tcLookupClass, tcLookupTyCon, tcExtendTyVarEnv
                        )
 import TcGenDeriv      -- Deriv stuff
 import InstEnv         ( InstEnv, simpleDFunClassTyCon, extendInstEnv )
@@ -47,7 +47,7 @@ import TyCon          ( tyConTyVars, tyConDataCons, tyConArity, newTyConRep,
                        )
 import TcType          ( TcType, ThetaType, mkTyVarTys, mkTyConApp, getClassPredTys_maybe,
                          isUnLiftedType, mkClassPred, tyVarsOfTypes, tcSplitFunTys, 
-                         tcSplitTyConApp_maybe )
+                         tcSplitTyConApp_maybe, tcEqTypes )
 import Var             ( TyVar, tyVarKind )
 import VarSet          ( mkVarSet, subVarSet )
 import PrelNames
@@ -194,18 +194,23 @@ tcDeriving  :: PersistentRenamerState
 
 tcDeriving prs mod inst_env get_fixity tycl_decls
   = recoverTc (returnTc ([], EmptyBinds)) $
+    getDOptsTc                           `thenNF_Tc` \ dflags ->
 
        -- Fish the "deriving"-related information out of the TcEnv
        -- and make the necessary "equations".
-    makeDerivEqns tycl_decls                           `thenTc` \ (ordinary_eqns, inst_info2) ->
-    
-    deriveOrdinaryStuff mod prs inst_env get_fixity 
-                       ordinary_eqns                   `thenTc` \ (inst_info1, binds) ->
+    makeDerivEqns tycl_decls                           `thenTc` \ (ordinary_eqns, newtype_inst_info) ->
+    let
+       -- Add the newtype-derived instances to the inst env
+       -- before tacking the "ordinary" ones
+       inst_env1 = extend_inst_env dflags inst_env 
+                                   (map iDFunId newtype_inst_info)
+    in    
+    deriveOrdinaryStuff mod prs inst_env1 get_fixity 
+                       ordinary_eqns                   `thenTc` \ (ordinary_inst_info, binds) ->
     let
-       inst_info  = inst_info2 ++ inst_info1   -- info2 usually empty
+       inst_info  = newtype_inst_info ++ ordinary_inst_info
     in
 
-    getDOptsTc                         `thenNF_Tc` \ dflags ->
     ioToTc (dumpIfSet_dyn dflags Opt_D_dump_deriv "Derived instances" 
                          (ddump_deriving inst_info binds))     `thenTc_`
 
@@ -314,6 +319,8 @@ makeDerivEqns tycl_decls
       = tcLookupTyCon tycon_name               `thenNF_Tc` \ tycon ->
        tcAddSrcLoc (getSrcLoc tycon)           $
         tcAddErrCtxt (derivCtxt tycon)         $
+       tcExtendTyVarEnv (tyConTyVars tycon)    $       -- Deriving preds may (now) mention
+                                                       -- the type variables for the type constructor
         tcHsPred pred                          `thenTc` \ pred' ->
        case getClassPredTys_maybe pred' of
           Nothing          -> bale_out (malformedPredErr tycon pred)
@@ -347,19 +354,17 @@ makeDerivEqns tycl_decls
        offensive_class = classKey clas `elem` needsDataDeclCtxtClassKeys
 
 
-    mk_eqn_help NewType tycon clas []
-      | clas `hasKey` readClassKey || clas `hasKey` showClassKey
-      = mk_eqn_help DataType tycon clas []     -- Use the generate-full-code mechanism for Read and Show
-
     mk_eqn_help NewType tycon clas tys
-      = doptsTc Opt_GlasgowExts                        `thenTc` \ gla_exts ->
-       if not gla_exts then                    -- Not glasgow-exts?
-          mk_eqn_help DataType tycon clas tys  --   revert to ordinary mechanism
-        else if not can_derive then
-          bale_out cant_derive_err
-       else
-          new_dfun_name clas tycon             `thenNF_Tc` \ dfun_name ->
+      =        doptsTc Opt_GlasgowExts                 `thenTc` \ gla_exts ->
+        if can_derive_via_isomorphism && (gla_exts || standard_instance) then
+               -- Go ahead and use the isomorphism
+                  new_dfun_name clas tycon             `thenNF_Tc` \ dfun_name ->
           returnTc (Nothing, Just (NewTypeDerived (mk_dfun dfun_name)))
+       else
+          if standard_instance then
+               mk_eqn_help DataType tycon clas []      -- Go via bale-out route
+          else
+               bale_out cant_derive_err
       where
        -- Here is the plan for newtype derivings.  We see
        --        newtype T a1...an = T (t ak...an) deriving (C1...Cm)
@@ -386,12 +391,12 @@ makeDerivEqns tycl_decls
        Just (rep_tc, rep_ty_args) = maybe_rep_app
 
        n_tyvars_to_keep = tyConArity tycon  - n_args_to_drop
-       tyvars_to_keep = ASSERT( n_tyvars_to_keep >= 0 && n_tyvars_to_keep <= length tyvars )
-                        take n_tyvars_to_keep tyvars   -- Kind checking should ensure this
+       tyvars_to_drop   = drop n_tyvars_to_keep tyvars
+       tyvars_to_keep   = take n_tyvars_to_keep tyvars
 
        n_args_to_keep = tyConArity rep_tc - n_args_to_drop
-       args_to_keep   = ASSERT( n_args_to_keep >= 0 && n_args_to_keep <= length rep_ty_args )
-                        take n_args_to_keep rep_ty_args
+       args_to_drop   = drop n_args_to_keep rep_ty_args
+       args_to_keep   = take n_args_to_keep rep_ty_args
 
        ctxt_pred = mkClassPred clas (tys ++ [mkTyConApp rep_tc args_to_keep])
 
@@ -400,9 +405,24 @@ makeDerivEqns tycl_decls
                                                  [ctxt_pred]
 
        -- We can only do this newtype deriving thing if:
-       can_derive =  isJust maybe_rep_app      -- The rep type is a type constructor app
-                  && (tyVarsOfTypes args_to_keep `subVarSet` mkVarSet tyvars_to_keep) 
-                                               -- and the tyvars are all in scope
+       standard_instance = null tys && classKey clas `elem` derivableClassKeys
+
+       can_derive_via_isomorphism
+          =  not (clas `hasKey` readClassKey)  -- Never derive Read,Show this way
+          && not (clas `hasKey` showClassKey)
+          && n_tyvars_to_keep >= 0             -- Well kinded; 
+                                               -- eg not: newtype T = T Int deriving( Monad )
+          && isJust maybe_rep_app              -- The rep type is a type constructor app
+          && n_args_to_keep   >= 0             -- Well kinded: 
+                                               -- eg not: newtype T a = T Int deriving( Monad )
+          && eta_ok                            -- Eta reduction works
+
+       -- Check that eta reduction is OK
+       --      (a) the dropped-off args are identical
+       --      (b) the remaining type args mention 
+       --          only the remaining type variables
+       eta_ok = (args_to_drop `tcEqTypes` mkTyVarTys tyvars_to_drop)
+             && (tyVarsOfTypes args_to_keep `subVarSet` mkVarSet tyvars_to_keep) 
 
        cant_derive_err = derivingThingErr clas tys tycon tyvars_to_keep
                                           SLIT("too hard for cunning newtype deriving")
@@ -427,11 +447,11 @@ makeDerivEqns tycl_decls
            is_single_con  = maybeToBool (maybeTyConSingleCon tycon)
            is_enumeration_or_single = is_enumeration || is_single_con
 
-           single_nullary_why = SLIT("one constructor data type or type with all nullary constructors expected")
-           nullary_why        = SLIT("data type with all nullary constructors expected")
-           no_cons_why        = SLIT("type has no data constructors")
-           non_std_why        = SLIT("not a derivable class")
-           existential_why    = SLIT("it has existentially-quantified constructor(s)")
+    single_nullary_why = SLIT("one constructor data type or type with all nullary constructors expected")
+    nullary_why        = SLIT("data type with all nullary constructors expected")
+    no_cons_why               = SLIT("type has no data constructors")
+    non_std_why               = SLIT("not a derivable class")
+    existential_why    = SLIT("it has existentially-quantified constructor(s)")
 
 new_dfun_name clas tycon       -- Just a simple wrapper
   = newDFunName clas [mkTyConApp tycon []] (getSrcLoc tycon)
@@ -493,8 +513,11 @@ solveDerivEqns inst_env_in orig_eqns
       =            -- Extend the inst info from the explicit instance decls
            -- with the current set of solutions, giving a
        getDOptsTc                              `thenNF_Tc` \ dflags ->
-        let (new_dfuns, inst_env) =
-               add_solns dflags inst_env_in orig_eqns current_solns
+        let 
+           new_dfuns = zipWithEqual "add_solns" mk_deriv_dfun orig_eqns current_solns
+           inst_env  = extend_inst_env dflags inst_env_in new_dfuns
+           -- the eqns and solns move "in lockstep"; we have the eqns
+           -- because we need the LHS info for addClassInstance.
         in
            -- Simplify each RHS
        tcSetInstEnv inst_env (
@@ -511,26 +534,18 @@ solveDerivEqns inst_env_in orig_eqns
 \end{code}
 
 \begin{code}
-add_solns :: DynFlags
-         -> InstEnv                            -- The global, non-derived ones
-         -> [DerivEqn] -> [DerivSoln]
-         -> ([DFunId], InstEnv)
-    -- the eqns and solns move "in lockstep"; we have the eqns
-    -- because we need the LHS info for addClassInstance.
-
-add_solns dflags inst_env_in eqns solns
-  = (new_dfuns, inst_env)
-    where
-      new_dfuns     = zipWithEqual "add_solns" mk_deriv_dfun eqns solns
-      (inst_env, _) = extendInstEnv dflags inst_env_in new_dfuns
+extend_inst_env dflags inst_env new_dfuns
+  = new_inst_env
+  where
+    (new_inst_env, _errs) = extendInstEnv dflags inst_env new_dfuns
        -- Ignore the errors about duplicate instances.
        -- We don't want repeated error messages
        -- They'll appear later, when we do the top-level extendInstEnvs
 
-      mk_deriv_dfun (dfun_name, clas, tycon, tyvars, _) theta
-        = mkDictFunId dfun_name clas tyvars 
-                     [mkTyConApp tycon (mkTyVarTys tyvars)] 
-                     theta
+mk_deriv_dfun (dfun_name, clas, tycon, tyvars, _) theta
+  = mkDictFunId dfun_name clas tyvars 
+               [mkTyConApp tycon (mkTyVarTys tyvars)] 
+               theta
 \end{code}
 
 %************************************************************************