[project @ 2004-11-29 16:25:03 by simonpj]
[ghc-hetmet.git] / ghc / compiler / typecheck / TcDeriv.lhs
index 06b1c28..a2b84ca 100644 (file)
@@ -21,38 +21,35 @@ import TcEnv                ( newDFunName, pprInstInfoDetails,
                        )
 import TcGenDeriv      -- Deriv stuff
 import InstEnv         ( simpleDFunClassTyCon, extendInstEnv )
-import TcHsType                ( tcHsPred )
+import TcHsType                ( tcHsDeriv )
 import TcSimplify      ( tcSimplifyDeriv )
 
 import RnBinds         ( rnMethodBinds, rnTopBinds )
 import RnEnv           ( bindLocalNames )
-import TcRnMonad       ( thenM, returnM, mapAndUnzipM )
 import HscTypes                ( DFunId, FixityEnv )
 
 import Class           ( className, classArity, classKey, classTyVars, classSCTheta, Class )
-import Subst           ( mkTyVarSubst, substTheta )
+import Type            ( zipTvSubst, substTheta )
 import ErrUtils                ( dumpIfSet_dyn )
 import MkId            ( mkDictFunId )
-import DataCon         ( isNullaryDataCon, isExistentialDataCon, dataConOrigArgTys )
+import DataCon         ( isNullarySrcDataCon, isVanillaDataCon, dataConOrigArgTys )
 import Maybes          ( catMaybes )
 import RdrName         ( RdrName )
 import Name            ( Name, getSrcLoc )
 import NameSet         ( NameSet, emptyNameSet, duDefs )
-import Unique          ( Unique, getUnique )
 import Kind            ( splitKindFunTys )
 import TyCon           ( tyConTyVars, tyConDataCons, tyConArity, tyConHasGenerics,
-                         tyConTheta, isProductTyCon, isDataTyCon, newTyConRhs,
+                         tyConStupidTheta, isProductTyCon, isDataTyCon, newTyConRhs,
                          isEnumerationTyCon, isRecursiveTyCon, TyCon
                        )
-import TcType          ( TcType, ThetaType, mkTyVarTys, mkTyConApp, 
-                         getClassPredTys_maybe, tcTyConAppTyCon,
+import TcType          ( TcType, ThetaType, mkTyVarTys, mkTyConApp, tcTyConAppTyCon,
                          isUnLiftedType, mkClassPred, tyVarsOfTypes, isArgTypeKind,
                          tcEqTypes, tcSplitAppTys, mkAppTys, tcSplitDFunTy )
 import Var             ( TyVar, tyVarKind, idType, varName )
 import VarSet          ( mkVarSet, subVarSet )
 import PrelNames
 import SrcLoc          ( srcLocSpan, Located(..) )
-import Util            ( zipWithEqual, sortLt, notNull )
+import Util            ( zipWithEqual, sortLe, notNull )
 import ListSetOps      ( removeDups,  assocMaybe )
 import Outputable
 import Bag
@@ -208,11 +205,10 @@ And then translate it to:
 \begin{code}
 tcDeriving  :: [LTyClDecl Name]        -- All type constructors
            -> TcM ([InstInfo],         -- The generated "instance decls"
-                   [HsBindGroup Name], -- Extra generated top-level bindings
-                   NameSet)            -- Binders to keep alive
+                   [HsBindGroup Name]) -- Extra generated top-level bindings
 
 tcDeriving tycl_decls
-  = recoverM (returnM ([], [], emptyNameSet)) $
+  = recoverM (returnM ([], [])) $
     do {       -- Fish the "deriving"-related information out of the TcEnv
                -- and make the necessary "equations".
        ; (ordinary_eqns, newtype_inst_info) <- makeDerivEqns tycl_decls
@@ -230,18 +226,20 @@ tcDeriving tycl_decls
        -- Rename these extra bindings, discarding warnings about unused bindings etc
        -- Set -fglasgow exts so that we can have type signatures in patterns,
        -- which is used in the generic binds
-       ; (rn_binds, gen_bndrs) 
+       ; rn_binds
                <- discardWarnings $ setOptM Opt_GlasgowExts $ do
                        { (rn_deriv, _dus1) <- rnTopBinds deriv_binds []
                        ; (rn_gen, dus_gen) <- rnTopBinds gen_binds   []
-                       ; return (rn_deriv ++ rn_gen, duDefs dus_gen) }
+                       ; keepAliveSetTc (duDefs dus_gen)       -- Mark these guys to
+                                                               -- be kept alive
+                       ; return (rn_deriv ++ rn_gen) }
 
 
        ; dflags <- getDOpts
        ; ioToTcRn (dumpIfSet_dyn dflags Opt_D_dump_deriv "Derived instances" 
                   (ddump_deriving inst_info rn_binds))
 
-       ; returnM (inst_info, rn_binds, gen_bndrs)
+       ; returnM (inst_info, rn_binds)
        }
   where
     ddump_deriving :: [InstInfo] -> [HsBindGroup Name] -> SDoc
@@ -250,7 +248,7 @@ tcDeriving tycl_decls
 
 -----------------------------------------
 deriveOrdinaryStuff [] -- Short cut
-  = returnM ([], emptyBag)
+  = returnM ([], emptyLHsBinds)
 
 deriveOrdinaryStuff eqns
   = do {       -- Take the equation list and solve it, to deliver a list of
@@ -313,39 +311,40 @@ makeDerivEqns tycl_decls
     returnM (catMaybes maybe_ordinaries, catMaybes maybe_newtypes)
   where
     ------------------------------------------------------------------
-    derive_these :: [(NewOrData, Name, LHsPred Name)]
+    derive_these :: [(NewOrData, Name, LHsType Name)]
        -- Find the (nd, TyCon, Pred) pairs that must be `derived'
     derive_these = [ (nd, tycon, pred) 
                   | L _ (TyData { tcdND = nd, tcdLName = L _ tycon, 
-                                 tcdDerivs = Just (L _ preds) }) <- tycl_decls,
+                                 tcdDerivs = Just preds }) <- tycl_decls,
                     pred <- preds ]
 
     ------------------------------------------------------------------
-    mk_eqn :: (NewOrData, Name, LHsPred Name) -> TcM (Maybe DerivEqn, Maybe InstInfo)
+    mk_eqn :: (NewOrData, Name, LHsType Name) -> TcM (Maybe DerivEqn, Maybe InstInfo)
        -- We swizzle the tyvars and datacons out of the tycon
        -- to make the rest of the equation
+       --
+       -- The "deriv_ty" is a LHsType to take account of the fact that for newtype derivign
+       -- we allow deriving (forall a. C [a]).
 
-    mk_eqn (new_or_data, tycon_name, pred)
+    mk_eqn (new_or_data, tycon_name, hs_deriv_ty)
       = tcLookupTyCon tycon_name               `thenM` \ tycon ->
-       addSrcSpan (srcLocSpan (getSrcLoc tycon))               $
+       setSrcSpan (srcLocSpan (getSrcLoc tycon))               $
         addErrCtxt (derivCtxt Nothing tycon)   $
        tcExtendTyVarEnv (tyConTyVars tycon)    $       -- Deriving preds may (now) mention
                                                        -- the type variables for the type constructor
-        tcHsPred pred                          `thenM` \ pred' ->
-       case getClassPredTys_maybe pred' of
-          Nothing          -> bale_out (malformedPredErr tycon pred)
-          Just (clas, tys) -> doptM Opt_GlasgowExts                    `thenM` \ gla_exts ->
-                              mk_eqn_help gla_exts new_or_data tycon clas tys
+       tcHsDeriv hs_deriv_ty                   `thenM` \ (deriv_tvs, clas, tys) ->
+       doptM Opt_GlasgowExts                   `thenM` \ gla_exts ->
+        mk_eqn_help gla_exts new_or_data tycon deriv_tvs clas tys
 
     ------------------------------------------------------------------
-    mk_eqn_help gla_exts DataType tycon clas tys
-      | Just err <- checkSideConditions gla_exts clas tycon tys
+    mk_eqn_help gla_exts DataType tycon deriv_tvs clas tys
+      | Just err <- checkSideConditions gla_exts tycon deriv_tvs clas tys
       = bale_out (derivingThingErr clas tys tycon (tyConTyVars tycon) err)
       | otherwise 
       = do { eqn <- mkDataTypeEqn tycon clas
           ; returnM (Just eqn, Nothing) }
 
-    mk_eqn_help gla_exts NewType tycon clas tys
+    mk_eqn_help gla_exts NewType tycon deriv_tvs clas tys
       | can_derive_via_isomorphism && (gla_exts || std_class_via_iso clas)
       =                -- Go ahead and use the isomorphism
           traceTc (text "newtype deriving:" <+> ppr tycon <+> ppr rep_tys)     `thenM_`
@@ -353,7 +352,7 @@ makeDerivEqns tycl_decls
           returnM (Nothing, Just (InstInfo { iDFunId = mk_dfun dfun_name,
                                              iBinds = NewTypeDerived rep_tys }))
       | std_class gla_exts clas
-      = mk_eqn_help gla_exts DataType tycon clas tys   -- Go via bale-out route
+      = mk_eqn_help gla_exts DataType tycon deriv_tvs clas tys -- Go via bale-out route
 
       | otherwise                              -- Non-standard instance
       = bale_out (if gla_exts then     
@@ -390,20 +389,19 @@ makeDerivEqns tycl_decls
                -- to get       instance Monad (ST s) => Monad (T s)
 
        -- Note [newtype representation]
-       -- We must not use newTyConRep to get the representation 
-       -- type, because that looks through all intermediate newtypes
-       -- To get the RHS of *this* newtype, just look at the data
-       -- constructor.  For example
+       -- Need newTyConRhs *not* newTyConRep to get the representation 
+       -- type, because the latter looks through all intermediate newtypes
+       -- For example
        --      newtype B = MkB Int
        --      newtype A = MkA B deriving( Num )
        -- We want the Num instance of B, *not* the Num instance of Int,
        -- when making the Num instance of A!
-        (tyvars, rep_ty)      = newTyConRhs tycon
+        (tc_tvs, rep_ty)      = newTyConRhs tycon
        (rep_fn, rep_ty_args) = tcSplitAppTys rep_ty
 
        n_tyvars_to_keep = tyConArity tycon  - n_args_to_drop
-       tyvars_to_drop   = drop n_tyvars_to_keep tyvars
-       tyvars_to_keep   = take n_tyvars_to_keep tyvars
+       tyvars_to_drop   = drop n_tyvars_to_keep tc_tvs
+       tyvars_to_keep   = take n_tyvars_to_keep tc_tvs
 
        n_args_to_keep = length rep_ty_args - n_args_to_drop
        args_to_drop   = drop n_args_to_keep rep_ty_args
@@ -434,16 +432,17 @@ makeDerivEqns tycl_decls
                -- There's no 'corece' needed because after the type checker newtypes
                -- are transparent.
 
-       sc_theta = substTheta (mkTyVarSubst clas_tyvars inst_tys)
+       sc_theta = substTheta (zipTvSubst clas_tyvars inst_tys)
                              (classSCTheta clas)
 
                -- If there are no tyvars, there's no need
                -- to abstract over the dictionaries we need
-       dict_args | null tyvars = []
-                 | otherwise   = rep_pred : sc_theta
+       dict_tvs = deriv_tvs ++ tc_tvs
+       dict_args | null dict_tvs = []
+                 | otherwise     = rep_pred : sc_theta
 
                -- Finally! Here's where we build the dictionary Id
-       mk_dfun dfun_name = mkDictFunId dfun_name tyvars dict_args clas inst_tys
+       mk_dfun dfun_name = mkDictFunId dfun_name dict_tvs dict_args clas inst_tys
 
        -------------------------------------------------------------------
        --  Figuring out whether we can only do this newtype-deriving thing
@@ -531,9 +530,10 @@ mkDataTypeEqn tycon clas
        --        data T a b = ... deriving( Typeable )
        -- gives
        --        instance Typeable2 T where ...
+       -- Notice that:
        -- 1. There are no constraints in the instance
        -- 2. There are no type variables either
-       -- 2. The actual class we want to generate isn't necessarily
+       -- 3. The actual class we want to generate isn't necessarily
        --      Typeable; it depends on the arity of the type
     do { real_clas <- tcLookupClass (typeableClassNames !! tyConArity tycon)
        ; dfun_name <- new_dfun_name real_clas tycon
@@ -545,16 +545,13 @@ mkDataTypeEqn tycon clas
   where
     tyvars            = tyConTyVars tycon
     constraints       = extra_constraints ++ ordinary_constraints
-    extra_constraints = tyConTheta tycon
+    extra_constraints = tyConStupidTheta tycon
         -- "extra_constraints": see note [Data decl contexts] above
 
     ordinary_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?
         ]
 
@@ -563,9 +560,9 @@ mkDataTypeEqn tycon clas
 -- Check side conditions that dis-allow derivability for particular classes
 -- This is *apart* from the newtype-deriving mechanism
 
-checkSideConditions :: Bool -> Class -> TyCon -> [TcType] -> Maybe SDoc
-checkSideConditions gla_exts clas tycon tys
-  | notNull tys        
+checkSideConditions :: Bool -> TyCon -> [TyVar] -> Class -> [TcType] -> Maybe SDoc
+checkSideConditions gla_exts tycon deriv_tvs clas tys
+  | notNull deriv_tvs || notNull tys   
   = Just ty_args_why   -- e.g. deriving( Foo s )
   | otherwise
   = case [cond | (key,cond) <- sideConditions, key == getUnique clas] of
@@ -586,7 +583,7 @@ sideConditions
        (enumClassKey,     cond_std `andCond` cond_isEnumeration),
        (ixClassKey,       cond_std `andCond` (cond_isEnumeration `orCond` cond_isProduct)),
        (boundedClassKey,  cond_std `andCond` (cond_isEnumeration `orCond` cond_isProduct)),
-       (typeableClassKey, cond_glaExts `andCond` cond_allTypeKind),
+       (typeableClassKey, cond_glaExts `andCond` cond_typeableOK),
        (dataClassKey,     cond_glaExts `andCond` cond_std)
     ]
 
@@ -607,9 +604,9 @@ andCond c1 c2 tc = case c1 tc of
 
 cond_std :: Condition
 cond_std (gla_exts, tycon)
-  | any isExistentialDataCon data_cons         = Just existential_why     
-  | null data_cons                     = Just no_cons_why
-  | otherwise                          = Nothing
+  | any (not . isVanillaDataCon) data_cons = Just existential_why     
+  | null data_cons                        = Just no_cons_why
+  | otherwise                             = Nothing
   where
     data_cons       = tyConDataCons tycon
     no_cons_why            = quotes (ppr tycon) <+> ptext SLIT("has no data constructors")
@@ -629,12 +626,17 @@ cond_isProduct (gla_exts, tycon)
   where
     why = quotes (ppr tycon) <+> ptext SLIT("has more than one constructor")
 
-cond_allTypeKind :: Condition
-cond_allTypeKind (gla_exts, tycon)
-  | all (isArgTypeKind . tyVarKind) (tyConTyVars tycon) = Nothing
-  | otherwise                                       = Just why
+cond_typeableOK :: Condition
+-- OK for Typeable class
+-- Currently: (a) args all of kind *
+--           (b) 7 or fewer args
+cond_typeableOK (gla_exts, tycon)
+  | tyConArity tycon > 7                                     = Just too_many
+  | not (all (isArgTypeKind . tyVarKind) (tyConTyVars tycon)) = Just bad_kind
+  | otherwise                                                = Nothing
   where
-    why  = quotes (ppr tycon) <+> ptext SLIT("is parameterised over arguments of kind other than `*'")
+    too_many = quotes (ppr tycon) <+> ptext SLIT("has too many arguments")
+    bad_kind = quotes (ppr tycon) <+> ptext SLIT("has arguments of kind other than `*'")
 
 cond_glaExts :: Condition
 cond_glaExts (gla_exts, tycon) | gla_exts  = Nothing
@@ -707,10 +709,10 @@ solveDerivEqns orig_eqns
     ------------------------------------------------------------------
 
     gen_soln (_, clas, tc,tyvars,deriv_rhs)
-      = addSrcSpan (srcLocSpan (getSrcLoc tc))         $
+      = setSrcSpan (srcLocSpan (getSrcLoc tc))         $
        addErrCtxt (derivCtxt (Just clas) tc)   $
        tcSimplifyDeriv tyvars deriv_rhs        `thenM` \ theta ->
-       returnM (sortLt (<) theta)      -- Canonicalise before returning the soluction
+       returnM (sortLe (<=) theta)     -- Canonicalise before returning the soluction
 
 mk_deriv_dfun (dfun_name, clas, tycon, tyvars, _) theta
   = mkDictFunId dfun_name tyvars theta
@@ -811,7 +813,7 @@ genInst dfun
 
 genDerivBinds clas fix_env tycon
   | className clas `elem` typeableClassNames
-  = (gen_Typeable_binds tycon, emptyBag)
+  = (gen_Typeable_binds tycon, emptyLHsBinds)
 
   | otherwise
   = case assocMaybe gen_list (getUnique clas) of
@@ -832,7 +834,7 @@ genDerivBinds clas fix_env tycon
 
       -- no_aux_binds is used for generators that don't 
       -- need to produce any auxiliary bindings
-    no_aux_binds f fix_env tc = (f fix_env tc, emptyBag)
+    no_aux_binds f fix_env tc = (f fix_env tc, emptyLHsBinds)
     ignore_fix_env f fix_env tc = f tc
 \end{code}
 
@@ -883,7 +885,7 @@ genTaggeryBinds dfuns
     do_con2tag acc_Names tycon
       | isDataTyCon tycon &&
         ((we_are_deriving eqClassKey tycon
-           && any isNullaryDataCon (tyConDataCons tycon))
+           && any isNullarySrcDataCon (tyConDataCons tycon))
         || (we_are_deriving ordClassKey  tycon
            && not (isProductTyCon tycon))
         || (we_are_deriving enumClassKey tycon)
@@ -921,8 +923,6 @@ derivingThingErr clas tys tycon tyvars why
   where
     pred = mkClassPred clas (tys ++ [mkTyConApp tycon (mkTyVarTys tyvars)])
 
-malformedPredErr tycon pred = ptext SLIT("Illegal deriving item") <+> ppr pred
-
 derivCtxt :: Maybe Class -> TyCon -> SDoc
 derivCtxt maybe_cls tycon
   = ptext SLIT("When deriving") <+> cls <+> ptext SLIT("for type") <+> quotes (ppr tycon)