[project @ 2003-05-07 08:29:42 by simonpj]
[ghc-hetmet.git] / ghc / compiler / typecheck / TcDeriv.lhs
index 10a7ff7..3e02116 100644 (file)
@@ -11,7 +11,7 @@ module TcDeriv ( tcDeriving ) where
 #include "HsVersions.h"
 
 import HsSyn           ( HsBinds(..), MonoBinds(..), TyClDecl(..),
-                         collectMonoBinders )
+                         andMonoBindList, collectMonoBinders )
 import RdrHsSyn                ( RdrNameMonoBinds )
 import RnHsSyn         ( RenamedHsBinds, RenamedMonoBinds, RenamedTyClDecl, RenamedHsPred )
 import CmdLineOpts     ( DynFlag(..) )
@@ -27,7 +27,7 @@ import TcMonoType     ( tcHsPred )
 import TcSimplify      ( tcSimplifyDeriv )
 
 import RnBinds         ( rnMethodBinds, rnTopMonoBinds )
-import RnEnv           ( bindLocalsFV )
+import RnEnv           ( bindLocalsFV, extendTyVarEnvFVRn )
 import TcRnMonad       ( thenM, returnM, mapAndUnzipM )
 import HscTypes                ( DFunId )
 
@@ -39,6 +39,7 @@ import MkId           ( mkDictFunId )
 import DataCon         ( dataConOrigArgTys, isNullaryDataCon, isExistentialDataCon )
 import Maybes          ( maybeToBool, catMaybes )
 import Name            ( Name, getSrcLoc, nameUnique )
+import Unique          ( getUnique )
 import NameSet
 import RdrName         ( RdrName )
 
@@ -46,10 +47,11 @@ import TyCon                ( tyConTyVars, tyConDataCons, tyConArity,
                          tyConTheta, maybeTyConSingleCon, isDataTyCon,
                          isEnumerationTyCon, isRecursiveTyCon, TyCon
                        )
-import TcType          ( TcType, ThetaType, mkTyVarTys, mkTyConApp, getClassPredTys_maybe,
-                         isUnLiftedType, mkClassPred, tyVarsOfTypes, tcSplitFunTys, 
-                         tcEqTypes, tcSplitAppTys, mkAppTys )
-import Var             ( TyVar, tyVarKind )
+import TcType          ( TcType, ThetaType, mkTyVarTy, mkTyVarTys, mkTyConApp, 
+                         getClassPredTys_maybe,
+                         isUnLiftedType, mkClassPred, tyVarsOfTypes, tcSplitFunTys, isTypeKind,
+                         tcEqTypes, tcSplitAppTys, mkAppTys, tcSplitDFunTy )
+import Var             ( TyVar, tyVarKind, idType, varName )
 import VarSet          ( mkVarSet, subVarSet )
 import PrelNames
 import Util            ( zipWithEqual, sortLt, notNull )
@@ -245,35 +247,33 @@ deriveOrdinaryStuff eqns
 
     let
        extra_mbind_list = map gen_tag_n_con_monobind nm_alist_etc
-       extra_mbinds     = foldr AndMonoBinds EmptyMonoBinds extra_mbind_list
+       extra_mbinds     = andMonoBindList extra_mbind_list
        mbinders         = collectMonoBinders extra_mbinds
     in
-    mappM gen_bind new_dfuns           `thenM` \ method_binds_s ->
+    mappM gen_bind new_dfuns           `thenM` \ rdr_name_inst_infos ->
        
-    traceTc (text "tcDeriv" <+> ppr method_binds_s)    `thenM_`
-    getModule                                          `thenM` \ this_mod ->
+    traceTc (text "tcDeriv" <+> vcat (map ppr rdr_name_inst_infos))    `thenM_`
+    getModule                          `thenM` \ this_mod ->
     initRn (InterfaceMode this_mod) (
        -- Rename to get RenamedBinds.
        -- The only tricky bit is that the extra_binds must scope 
        -- over the method bindings for the instances.
        bindLocalsFV (ptext (SLIT("deriving"))) mbinders        $ \ _ ->
        rnTopMonoBinds extra_mbinds []                  `thenM` \ (rn_extra_binds, dus) ->
-       mapAndUnzipM rn_meths method_binds_s            `thenM` \ (rn_method_binds_s, fvs_s) ->
-       returnM ((rn_method_binds_s, rn_extra_binds), 
+       mapAndUnzipM rn_inst_info rdr_name_inst_infos   `thenM` \ (rn_inst_infos, fvs_s) ->
+       returnM ((rn_inst_infos, rn_extra_binds), 
                  duUses dus `plusFV` plusFVs fvs_s)
-    )                          `thenM` \ ((rn_method_binds_s, rn_extra_binds), fvs) ->
-    let
-       new_inst_infos = zipWith gen_inst_info new_dfuns rn_method_binds_s
-    in
-    returnM (new_inst_infos, rn_extra_binds, fvs)
+    )                          `thenM` \ ((rn_inst_infos, rn_extra_binds), fvs) ->
+   returnM (rn_inst_infos, rn_extra_binds, fvs)
 
   where
-       -- Make a Real dfun instead of the dummy one we have so far
-    gen_inst_info :: DFunId -> RenamedMonoBinds -> InstInfo
-    gen_inst_info dfun binds
-      = InstInfo { iDFunId = dfun, iBinds = VanillaInst binds [] }
-
-    rn_meths (cls, meths) = rnMethodBinds cls [] meths
+    rn_inst_info (dfun, binds) 
+       = extendTyVarEnvFVRn (map varName tyvars)       $
+               -- Bring the right type variables into scope
+         rnMethodBinds (className cls) [] binds        `thenM` \ (rn_binds, fvs) ->
+         return (InstInfo { iDFunId = dfun, iBinds = VanillaInst rn_binds [] }, fvs)
+       where
+         (tyvars, _, cls, _) = tcSplitDFunTy (idType dfun)
 \end{code}
 
 
@@ -329,11 +329,12 @@ makeDerivEqns tycl_decls
         tcHsPred pred                          `thenM` \ pred' ->
        case getClassPredTys_maybe pred' of
           Nothing          -> bale_out (malformedPredErr tycon pred)
-          Just (clas, tys) -> mk_eqn_help new_or_data tycon clas tys
+          Just (clas, tys) -> doptM Opt_GlasgowExts                    `thenM` \ gla_exts ->
+                              mk_eqn_help gla_exts new_or_data tycon clas tys
 
     ------------------------------------------------------------------
-    mk_eqn_help DataType tycon clas tys
-      | Just err <- chk_out clas tycon tys
+    mk_eqn_help gla_exts DataType tycon clas tys
+      | Just err <- chk_out gla_exts clas tycon tys
       = bale_out (derivingThingErr clas tys tycon tyvars err)
       | otherwise 
       = new_dfun_name clas tycon        `thenM` \ dfun_name ->
@@ -341,38 +342,44 @@ makeDerivEqns tycl_decls
       where
        tyvars    = tyConTyVars tycon
        data_cons = tyConDataCons tycon
-       constraints = extra_constraints ++ 
-                     [ mkClassPred clas [arg_ty] 
-                     | data_con <- tyConDataCons tycon,
-                       arg_ty   <- dataConOrigArgTys data_con,
-                               -- Use the same type variables
-                               -- as the type constructor,
-                               -- hence no need to instantiate
-                       not (isUnLiftedType arg_ty)     -- No constraints for unlifted types?
-                     ]
-
-        -- "extra_constraints": see note [Data decl contexts] above
+       constraints = extra_constraints ++ ordinary_constraints
+                -- "extra_constraints": see note [Data decl contexts] above
        extra_constraints = tyConTheta tycon
 
-    mk_eqn_help NewType tycon clas tys
-      =        doptM Opt_GlasgowExts                   `thenM` \ gla_exts ->
-        if can_derive_via_isomorphism && (gla_exts || standard_instance) then
-               -- Go ahead and use the isomorphism
+       ordinary_constraints
+         | clas `hasKey` typeableClassKey      -- For the Typeable class, the constraints
+                                               -- don't involve the constructor ags, only 
+                                               -- the tycon tyvars
+                                               -- e.g.   data T a b = ...
+                                               -- we want
+                                               --      instance (Typeable a, Typable b)
+                                               --               => Typeable (T a b) where
+         = [mkClassPred clas [mkTyVarTy tv] | tv <- tyvars]
+         | otherwise
+         = [ mkClassPred clas [arg_ty] 
+           | data_con <- tyConDataCons tycon,
+             arg_ty   <- dataConOrigArgTys data_con,
+                       -- Use the same type variables
+                       -- as the type constructor,
+                       -- hence no need to instantiate
+             not (isUnLiftedType arg_ty)       -- No constraints for unlifted types?
+           ]
+
+    mk_eqn_help gla_exts NewType tycon clas tys
+      | can_derive_via_isomorphism && (gla_exts || standard_class gla_exts clas)
+      =                -- Go ahead and use the isomorphism
           traceTc (text "newtype deriving:" <+> ppr tycon <+> ppr rep_tys)     `thenM_`
                   new_dfun_name clas tycon             `thenM` \ dfun_name ->
           returnM (Nothing, Just (InstInfo { iDFunId = mk_dfun dfun_name,
                                              iBinds = NewTypeDerived rep_tys }))
-       else
-       if standard_instance then
-               mk_eqn_help DataType tycon clas []      -- Go via bale-out route
-       else
-       -- Non-standard instance
-       if gla_exts then
-               -- Too hard
-               bale_out cant_derive_err
-       else
-               -- Just complain about being a non-std instance
-               bale_out non_std_err
+      | standard_class gla_exts clas
+      = mk_eqn_help gla_exts DataType tycon clas tys   -- Go via bale-out route
+
+      | otherwise                              -- Non-standard instance
+      = bale_out (if gla_exts then     
+                       cant_derive_err -- Too hard
+                 else
+                       non_std_err)    -- Just complain about being a non-std instance
       where
        -- Here is the plan for newtype derivings.  We see
        --        newtype T a1...an = T (t ak...an) deriving (.., C s1 .. sm, ...)
@@ -457,17 +464,18 @@ makeDerivEqns tycl_decls
        -------------------------------------------------------------------
        --  Figuring out whether we can only do this newtype-deriving thing
 
-       standard_instance = null tys && classKey clas `elem` derivableClassKeys
+       right_arity = length tys + 1 == classArity clas
 
+               -- Never derive Read,Show,Typeable,Data this way 
+       non_iso_classes = [readClassKey, showClassKey, typeableClassKey, dataClassKey]
        can_derive_via_isomorphism
-          =  not (clas `hasKey` readClassKey)  -- Never derive Read,Show this way
-          && not (clas `hasKey` showClassKey)
-          && length tys + 1 == classArity clas -- Well kinded;
+          =  not (getUnique clas `elem` non_iso_classes)
+          && right_arity                       -- Well kinded;
                                                -- eg not: newtype T ... deriving( ST )
                                                --      because ST needs *2* type params
-          && n_tyvars_to_keep >= 0             -- Well kinded; 
+          && n_tyvars_to_keep >= 0             -- Type constructor has right kind:
                                                -- eg not: newtype T = T Int deriving( Monad )
-          && n_args_to_keep   >= 0             -- Well kinded: 
+          && n_args_to_keep   >= 0             -- Rep type has right kind: 
                                                -- eg not: newtype T a = T Int deriving( Monad )
           && eta_ok                            -- Eta reduction works
           && not (isRecursiveTyCon tycon)      -- Does not work for recursive tycons:
@@ -483,10 +491,20 @@ makeDerivEqns tycl_decls
              && (tyVarsOfTypes args_to_keep `subVarSet` mkVarSet tyvars_to_keep) 
 
        cant_derive_err = derivingThingErr clas tys tycon tyvars_to_keep
-                               (vcat [ptext SLIT("too hard for cunning newtype deriving"),
-                                      ptext SLIT("debug info:") <+> ppr n_tyvars_to_keep <+>
-                                       ppr n_args_to_keep <+> ppr eta_ok <+>
-                                       ppr (isRecursiveTyCon tycon)
+                               (vcat [ptext SLIT("even with cunning newtype deriving:"),
+                                       if isRecursiveTyCon tycon then
+                                         ptext SLIT("the newtype is recursive")
+                                       else empty,
+                                       if not right_arity then 
+                                         quotes (ppr (mkClassPred clas tys)) <+> ptext SLIT("does not have arity 1")
+                                       else empty,
+                                       if not (n_tyvars_to_keep >= 0) then 
+                                         ptext SLIT("the type constructor has wrong kind")
+                                       else if not (n_args_to_keep >= 0) then
+                                         ptext SLIT("the representation type has wrong kind")
+                                       else if not eta_ok then 
+                                         ptext SLIT("the eta-reduction property does not hold")
+                                       else empty
                                      ])
 
        non_std_err = derivingThingErr clas tys tycon tyvars_to_keep
@@ -495,14 +513,19 @@ makeDerivEqns tycl_decls
 
     bale_out err = addErrTc err `thenM_` returnM (Nothing, Nothing) 
 
+    standard_class gla_exts clas =  key `elem` derivableClassKeys
+                                || (gla_exts && (key == typeableClassKey || key == dataClassKey))
+       where
+         key = classKey clas
     ------------------------------------------------------------------
-    chk_out :: Class -> TyCon -> [TcType] -> Maybe SDoc
-    chk_out clas tycon tys
+    chk_out :: Bool -> Class -> TyCon -> [TcType] -> Maybe SDoc
+    chk_out gla_exts clas tycon tys
        | notNull tys                                                   = Just ty_args_why
-       | not (getUnique clas `elem` derivableClassKeys)                = Just (non_std_why clas)
+       | not (standard_class gla_exts clas)                            = Just (non_std_why clas)
        | clas `hasKey` enumClassKey    && not is_enumeration           = Just nullary_why
        | clas `hasKey` boundedClassKey && not is_enumeration_or_single = Just single_nullary_why
        | clas `hasKey` ixClassKey      && not is_enumeration_or_single = Just single_nullary_why
+        | clas `hasKey` typeableClassKey && not all_type_kind          = Just not_type_kind_why
        | null data_cons                                                = Just no_cons_why
        | any isExistentialDataCon data_cons                            = Just existential_why     
        | otherwise                                                     = Nothing
@@ -511,12 +534,14 @@ makeDerivEqns tycl_decls
            is_enumeration = isEnumerationTyCon tycon
            is_single_con  = maybeToBool (maybeTyConSingleCon tycon)
            is_enumeration_or_single = is_enumeration || is_single_con
+           all_type_kind = all (isTypeKind . tyVarKind) (tyConTyVars tycon)
 
            single_nullary_why = ptext SLIT("one constructor data type or type with all nullary constructors expected")
            nullary_why        = quotes (ppr tycon) <+> ptext SLIT("has non-nullary constructors")
            no_cons_why        = quotes (ppr tycon) <+> ptext SLIT("has no data constructors")
            ty_args_why        = quotes (ppr pred) <+> ptext SLIT("is not a class")
            existential_why    = quotes (ppr tycon) <+> ptext SLIT("has existentially-quantified constructor(s)")
+           not_type_kind_why  = quotes (ppr tycon) <+> ptext SLIT("is parameterised over arguments of kind other than `*'")
 
            pred = mkClassPred clas tys
 
@@ -666,28 +691,28 @@ the renamer.  What a great hack!
 
 \begin{code}
 -- Generate the method bindings for the required instance
--- (paired with class name, as we need that when renaming
+-- (paired with DFunId, as we need that when renaming
 --  the method binds)
-gen_bind :: DFunId -> TcM (Name, RdrNameMonoBinds)
+gen_bind :: DFunId -> TcM (DFunId, RdrNameMonoBinds)
 gen_bind dfun
   = getFixityEnv               `thenM` \ fix_env -> 
-    returnM (cls_nm, gen_binds_fn fix_env cls_nm tycon)
-  where
-    cls_nm       = className clas
-    (clas, tycon) = simpleDFunClassTyCon dfun
-
-gen_binds_fn fix_env cls_nm
-  = assoc "gen_bind:bad derived class"
-         gen_list (nameUnique cls_nm)
-  where
-    gen_list = [(eqClassKey,      gen_Eq_binds)
-              ,(ordClassKey,     gen_Ord_binds)
-              ,(enumClassKey,    gen_Enum_binds)
-              ,(boundedClassKey, gen_Bounded_binds)
-              ,(ixClassKey,      gen_Ix_binds)
-              ,(showClassKey,    gen_Show_binds fix_env)
-              ,(readClassKey,    gen_Read_binds fix_env)
-              ]
+    let
+        (clas, tycon) = simpleDFunClassTyCon dfun
+       gen_binds_fn  = assoc "gen_bind:bad derived class"
+                             gen_list (getUnique clas)
+    
+       gen_list = [(eqClassKey,      gen_Eq_binds)
+                  ,(ordClassKey,     gen_Ord_binds)
+                  ,(enumClassKey,    gen_Enum_binds)
+                  ,(boundedClassKey, gen_Bounded_binds)
+                  ,(ixClassKey,      gen_Ix_binds)
+                  ,(showClassKey,    gen_Show_binds fix_env)
+                  ,(readClassKey,    gen_Read_binds fix_env)
+                  ,(typeableClassKey,gen_Typeable_binds)
+                  ,(dataClassKey,    gen_Data_binds)
+                  ]
+    in
+    returnM (dfun, gen_binds_fn tycon)
 \end{code}