[project @ 2001-12-11 12:19:04 by simonpj]
[ghc-hetmet.git] / ghc / compiler / typecheck / TcDeriv.lhs
index 28a2e24..ee364ac 100644 (file)
@@ -10,52 +10,48 @@ module TcDeriv ( tcDeriving ) where
 
 #include "HsVersions.h"
 
-import HsSyn           ( HsBinds(..), MonoBinds(..), collectLocatedMonoBinders )
+import HsSyn           ( HsBinds(..), MonoBinds(..), TyClDecl(..),
+                         collectLocatedMonoBinders )
 import RdrHsSyn                ( RdrNameMonoBinds )
-import RnHsSyn         ( RenamedHsBinds, RenamedMonoBinds )
+import RnHsSyn         ( RenamedHsBinds, RenamedMonoBinds, RenamedTyClDecl )
 import CmdLineOpts     ( DynFlag(..), DynFlags )
 
 import TcMonad
-import TcEnv           ( TcEnv, tcSetInstEnv, getTcGST, newDFunName )
+import TcEnv           ( tcSetInstEnv, newDFunName, InstInfo(..), pprInstInfo,
+                         tcLookupClass, tcLookupTyCon
+                       )
 import TcGenDeriv      -- Deriv stuff
-import InstEnv ( InstInfo(..), InstEnv, 
-                         pprInstInfo, simpleDFunClassTyCon, extendInstEnv )
+import InstEnv         ( InstEnv, simpleDFunClassTyCon, extendInstEnv )
 import TcSimplify      ( tcSimplifyThetas )
 
 import RnBinds         ( rnMethodBinds, rnTopMonoBinds )
 import RnEnv           ( bindLocatedLocalsRn )
-import RnMonad         ( --RnNameSupply, 
-                         renameSourceCode, thenRn, mapRn, returnRn )
-import HscTypes                ( DFunId, GlobalSymbolTable, PersistentRenamerState )
+import RnMonad         ( renameDerivedCode, thenRn, mapRn, returnRn )
+import HscTypes                ( DFunId, PersistentRenamerState )
 
-import Bag             ( Bag, emptyBag, unionBags, listToBag )
-import Class           ( classKey, Class )
+import BasicTypes      ( Fixity )
+import Class           ( className, classKey, Class )
 import ErrUtils                ( dumpIfSet_dyn, Message )
 import MkId            ( mkDictFunId )
-import Id              ( mkVanillaId, idType )
 import DataCon         ( dataConArgTys, isNullaryDataCon, isExistentialDataCon )
 import PrelInfo                ( needsDataDeclCtxtClassKeys )
 import Maybes          ( maybeToBool, catMaybes )
 import Module          ( Module )
-import Name            ( Name, isLocallyDefined, getSrcLoc, NamedThing(..) )
+import Name            ( Name, getSrcLoc, nameUnique )
 import RdrName         ( RdrName )
---import RnMonad               ( FixityEnv )
 
-import TyCon           ( tyConTyVars, tyConDataCons, tyConDerivings,
+import TyCon           ( tyConTyVars, tyConDataCons,
                          tyConTheta, maybeTyConSingleCon, isDataTyCon,
-                         isEnumerationTyCon, isAlgTyCon, TyCon
-                       )
-import Type            ( TauType, PredType(..), mkTyVarTys, mkTyConApp,
-                         mkSigmaTy, splitSigmaTy, splitDictTy, mkDictTy, 
-                         isUnboxedType, splitAlgTyConApp, classesToPreds
+                         isEnumerationTyCon, TyCon
                        )
-import TysWiredIn      ( voidTy )
+import TcType          ( ThetaType, mkTyVarTys, mkTyConApp, 
+                         isUnLiftedType, mkClassPred )
 import Var             ( TyVar )
 import PrelNames
-import Bag             ( bagToList )
-import Util            ( zipWithEqual, sortLt, thenCmp )
+import Util            ( zipWithEqual, sortLt )
 import ListSetOps      ( removeDups,  assoc )
 import Outputable
+import List            ( nub )
 \end{code}
 
 %************************************************************************
@@ -147,9 +143,7 @@ type DerivEqn = (Name, Class, TyCon, [TyVar], DerivRhs)
                -- The Name is the name for the DFun we'll build
                -- The tyvars bind all the variables in the RHS
 
-type DerivRhs = [(Class, [TauType])]   -- Same as a ThetaType!
-               --[PredType]   -- ... | Class Class [Type==TauType]
-
+type DerivRhs  = ThetaType
 type DerivSoln = DerivRhs
 \end{code}
 
@@ -188,16 +182,17 @@ context to the instance decl.  The "offending classes" are
 tcDeriving  :: PersistentRenamerState
            -> Module                   -- name of module under scrutiny
            -> InstEnv                  -- What we already know about instances
-           -> [TyCon]                  -- "local_tycons" ???
+           -> (Name -> Maybe Fixity)   -- used in deriving Show and Read
+           -> [RenamedTyClDecl]        -- All type constructors
            -> TcM ([InstInfo],         -- The generated "instance decls".
                    RenamedHsBinds)     -- Extra generated bindings
 
-tcDeriving prs mod inst_env_in local_tycons
+tcDeriving prs mod inst_env_in get_fixity tycl_decls
   = recoverTc (returnTc ([], EmptyBinds)) $
 
        -- Fish the "deriving"-related information out of the TcEnv
        -- and make the necessary "equations".
-    makeDerivEqns mod local_tycons             `thenTc` \ eqns ->
+    makeDerivEqns tycl_decls           `thenTc` \ eqns ->
     if null eqns then
        returnTc ([], EmptyBinds)
     else
@@ -220,21 +215,21 @@ tcDeriving prs mod inst_env_in local_tycons
     let
        extra_mbind_list = map gen_tag_n_con_monobind nm_alist_etc
        extra_mbinds     = foldr AndMonoBinds EmptyMonoBinds extra_mbind_list
-       method_binds_s   = map (gen_bind (getTcGST env)) new_dfuns
+       method_binds_s   = map (gen_bind get_fixity) new_dfuns
        mbinders         = collectLocatedMonoBinders extra_mbinds
        
        -- Rename to get RenamedBinds.
        -- The only tricky bit is that the extra_binds must scope over the
        -- method bindings for the instances.
        (rn_method_binds_s, rn_extra_binds)
-               = renameSourceCode dflags mod prs (
+               = renameDerivedCode dflags mod prs (
                        bindLocatedLocalsRn (ptext (SLIT("deriving"))) mbinders $ \ _ ->
                        rnTopMonoBinds extra_mbinds []          `thenRn` \ (rn_extra_binds, _) ->
                        mapRn rn_meths method_binds_s           `thenRn` \ rn_method_binds_s ->
                        returnRn (rn_method_binds_s, rn_extra_binds)
                  )
 
-       new_inst_infos = map gen_inst_info (new_dfuns `zip` rn_method_binds_s)
+       new_inst_infos = zipWith gen_inst_info new_dfuns rn_method_binds_s
     in
 
     ioToTc (dumpIfSet_dyn dflags Opt_D_dump_deriv "Derived instances" 
@@ -248,20 +243,12 @@ tcDeriving prs mod inst_env_in local_tycons
       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 { iLocal = True,
-                  iClass = clas, iTyVars = tyvars, 
-                  iTys = tys, iTheta = theta, 
-                  iDFunId = dfun, 
-                  iBinds = binds,
-                  iLoc = getSrcLoc dfun, iPrags = [] }
-        where
-        (tyvars, theta, tau) = splitSigmaTy (idType dfun)
-        (clas, tys)          = splitDictTy tau
-
-    rn_meths meths = rnMethodBinds [] meths `thenRn` \ (meths', _) -> returnRn meths'
-       -- Ignore the free vars returned
+    gen_inst_info :: DFunId -> RenamedMonoBinds -> InstInfo
+    gen_inst_info dfun binds
+      = InstInfo { iDFunId = dfun, iBinds = binds, iPrags = [] }
+
+    rn_meths (cls, meths) = rnMethodBinds cls [] meths `thenRn` \ (meths', _) -> 
+                           returnRn meths'     -- Ignore the free vars returned
 \end{code}
 
 
@@ -287,83 +274,77 @@ or} has just one data constructor (e.g., tuples).
 all those.
 
 \begin{code}
-makeDerivEqns :: Module -> [TyCon] -> TcM [DerivEqn]
+makeDerivEqns :: [RenamedTyClDecl] -> TcM [DerivEqn]
 
-makeDerivEqns this_mod local_tycons
-  = let
-       think_about_deriving = need_deriving local_tycons
-       (derive_these, _)    = removeDups cmp_deriv think_about_deriving
-    in
-    if null local_tycons then
-       returnTc []     -- Bale out now
-    else
-    mapTc mk_eqn derive_these `thenTc` \ maybe_eqns ->
+makeDerivEqns tycl_decls
+  = mapTc mk_eqn derive_these          `thenTc` \ maybe_eqns ->
     returnTc (catMaybes maybe_eqns)
   where
     ------------------------------------------------------------------
-    need_deriving :: [TyCon] -> [(Class, TyCon)]
-       -- find the tycons that have `deriving' clauses;
-
-    need_deriving tycons_to_consider
-      = foldr (\ tycon acc -> [(clas,tycon) | clas <- tyConDerivings tycon] ++ acc)
-             []
-             tycons_to_consider
-
-    ------------------------------------------------------------------
-    cmp_deriv :: (Class, TyCon) -> (Class, TyCon) -> Ordering
-    cmp_deriv (c1, t1) (c2, t2)
-      = (c1 `compare` c2) `thenCmp` (t1 `compare` t2)
+    derive_these :: [(Name, Name)]
+       -- Find the (Class,TyCon) pairs that must be `derived'
+       -- NB: only source-language decls have deriving, no imported ones do
+    derive_these = [ (clas,tycon) 
+                  | TyData {tcdName = tycon, tcdDerivs = Just classes} <- tycl_decls,
+                    clas <- nub classes ]
 
     ------------------------------------------------------------------
-    mk_eqn :: (Class, TyCon) -> NF_TcM (Maybe DerivEqn)
+    mk_eqn :: (Name, Name) -> NF_TcM (Maybe DerivEqn)
        -- we swizzle the tyvars and datacons out of the tycon
        -- to make the rest of the equation
 
-    mk_eqn (clas, tycon)
-      = case chk_out clas tycon of
-          Just err ->  addErrTc err                            `thenNF_Tc_` 
+    mk_eqn (clas_name, tycon_name)
+      = tcLookupClass clas_name                                        `thenNF_Tc` \ clas ->
+       tcLookupTyCon tycon_name                                `thenNF_Tc` \ tycon ->
+       let
+           clas_key  = classKey clas
+           tyvars    = tyConTyVars tycon
+           tyvar_tys = mkTyVarTys tyvars
+           ty        = mkTyConApp tycon tyvar_tys
+           data_cons = tyConDataCons tycon
+           locn      = getSrcLoc tycon
+           constraints = extra_constraints ++ concat (map mk_constraints data_cons)
+
+           -- "extra_constraints": see notes above about contexts on data decls
+           extra_constraints
+             | offensive_class = tyConTheta tycon
+             | otherwise       = []
+
+           offensive_class = clas_key `elem` needsDataDeclCtxtClassKeys
+    
+           mk_constraints data_con
+              = [ mkClassPred clas [arg_ty]
+                | arg_ty <- dataConArgTys data_con tyvar_tys,
+                  not (isUnLiftedType arg_ty)  -- No constraints for unlifted types?
+                ]
+       in
+       case chk_out clas tycon of
+          Just err ->  tcAddSrcLoc (getSrcLoc tycon)   $
+                       addErrTc err                    `thenNF_Tc_` 
                        returnNF_Tc Nothing
-          Nothing  ->  newDFunName this_mod clas tyvar_tys locn `thenNF_Tc` \ dfun_name ->
+          Nothing  ->  newDFunName clas [ty] locn `thenNF_Tc` \ dfun_name ->
                        returnNF_Tc (Just (dfun_name, clas, tycon, tyvars, constraints))
-      where
-       clas_key  = classKey clas
-       tyvars    = tyConTyVars tycon   -- ToDo: Do we need new tyvars ???
-       tyvar_tys = mkTyVarTys tyvars
-       data_cons = tyConDataCons tycon
-       locn      = getSrcLoc tycon
-
-       constraints = extra_constraints ++ concat (map mk_constraints data_cons)
-
-       -- "extra_constraints": see notes above about contexts on data decls
-       extra_constraints
-         | offensive_class = tyConTheta tycon
-         | otherwise       = []
-          where
-           offensive_class = clas_key `elem` needsDataDeclCtxtClassKeys
 
-       mk_constraints data_con
-          = [ (clas, [arg_ty])
-            | arg_ty <- instd_arg_tys,
-              not (isUnboxedType arg_ty)       -- No constraints for unboxed types?
-            ]
-          where
-            instd_arg_tys  = dataConArgTys data_con tyvar_tys
+
 
     ------------------------------------------------------------------
     chk_out :: Class -> TyCon -> Maybe Message
     chk_out clas tycon
-       | clas `hasKey` enumClassKey    && not is_enumeration         = bog_out nullary_why
+       | clas `hasKey` enumClassKey    && not is_enumeration           = bog_out nullary_why
        | clas `hasKey` boundedClassKey && not is_enumeration_or_single = bog_out single_nullary_why
        | clas `hasKey` ixClassKey      && not is_enumeration_or_single = bog_out single_nullary_why
-       | any isExistentialDataCon (tyConDataCons tycon)              = Just (existentialErr clas tycon)
-       | otherwise                                                   = Nothing
+       | null data_cons                     = bog_out no_cons_why
+       | any isExistentialDataCon data_cons = Just (existentialErr clas tycon)
+       | otherwise                          = Nothing
        where
+           data_cons = tyConDataCons tycon
            is_enumeration = isEnumerationTyCon tycon
            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")
 
            bog_out why = Just (derivingThingErr clas tycon why)
 \end{code}
@@ -427,7 +408,8 @@ solveDerivEqns inst_env_in orig_eqns
         in
            -- Simplify each RHS
        tcSetInstEnv inst_env (
-         listTc [ tcAddErrCtxt (derivCtxt tc) $
+         listTc [ tcAddSrcLoc (getSrcLoc tc)   $
+                  tcAddErrCtxt (derivCtxt tc)  $
                   tcSimplifyThetas deriv_rhs
                 | (_, _,tc,_,deriv_rhs) <- orig_eqns ]  
        )                                       `thenTc` \ next_solns ->
@@ -456,10 +438,9 @@ add_solns dflags inst_env_in eqns solns
        -- 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)] 
-                     (map pair2PredType theta)
-
-      pair2PredType (clas, tautypes) = Class clas tautypes
+        = mkDictFunId dfun_name clas tyvars 
+                     [mkTyConApp tycon (mkTyVarTys tyvars)] 
+                     theta
 \end{code}
 
 %************************************************************************
@@ -526,25 +507,26 @@ 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 generating dict
---  names.)
-gen_bind :: GlobalSymbolTable -> DFunId -> RdrNameMonoBinds
-gen_bind fixities dfun
-  | not (isLocallyDefined tycon) = EmptyMonoBinds
-  | clas `hasKey` showClassKey   = gen_Show_binds fixities tycon
-  | clas `hasKey` readClassKey   = gen_Read_binds fixities tycon
-  | otherwise
-  = assoc "gen_bind:bad derived class"
-          [(eqClassKey,      gen_Eq_binds)
-          ,(ordClassKey,     gen_Ord_binds)
-          ,(enumClassKey,    gen_Enum_binds)
-          ,(boundedClassKey, gen_Bounded_binds)
-          ,(ixClassKey,      gen_Ix_binds)
-          ]
-          (classKey clas)
-          tycon
+-- (paired with class name, as we need that when renaming
+--  the method binds)
+gen_bind :: (Name -> Maybe Fixity) -> DFunId -> (Name, RdrNameMonoBinds)
+gen_bind get_fixity dfun
+  = (cls_nm, binds)
   where
+    cls_nm       = className clas
     (clas, tycon) = simpleDFunClassTyCon dfun
+
+    binds = assoc "gen_bind:bad derived class" gen_list 
+                 (nameUnique cls_nm) tycon
+
+    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 get_fixity)
+              ,(readClassKey,    gen_Read_binds get_fixity)
+              ]
 \end{code}
 
 
@@ -559,7 +541,7 @@ data Foo ... = ...
 
 con2tag_Foo :: Foo ... -> Int#
 tag2con_Foo :: Int -> Foo ...  -- easier if Int, not Int#
-maxtag_Foo  :: Int             -- ditto (NB: not unboxed)
+maxtag_Foo  :: Int             -- ditto (NB: not unlifted)
 
 
 We have a @con2tag@ function for a tycon if: