%
-% (c) The GRASP/AQUA Project, Glasgow University, 1992-1996
+% (c) The GRASP/AQUA Project, Glasgow University, 1992-1998
%
\section[TcDeriv]{Deriving}
Handles @deriving@ clauses on @data@ declarations.
\begin{code}
-#include "HsVersions.h"
-
module TcDeriv ( tcDeriving ) where
-IMP_Ubiq()
+#include "HsVersions.h"
-import HsSyn ( FixityDecl, Sig, HsBinds(..), Bind(..), MonoBinds(..),
- GRHSsAndBinds, Match, HsExpr, HsLit, InPat,
- ArithSeqInfo, Fake, MonoType )
-import HsPragmas ( InstancePragmas(..) )
-import RnHsSyn ( mkRnName, RnName(..), RenamedHsBinds(..), RenamedFixityDecl(..) )
-import TcHsSyn ( TcIdOcc )
+import HsSyn ( HsBinds(..), MonoBinds(..), collectMonoBinders )
+import RdrHsSyn ( RdrNameMonoBinds )
+import RnHsSyn ( RenamedHsBinds, RenamedMonoBinds )
+import CmdLineOpts ( opt_D_dump_deriv )
import TcMonad
-import Inst ( InstanceMapper(..) )
-import TcEnv ( getEnv_TyCons, tcLookupClassByKey )
-import TcKind ( TcKind )
+import Inst ( InstanceMapper )
+import TcEnv ( getEnvTyCons )
import TcGenDeriv -- Deriv stuff
-import TcInstUtil ( InstInfo(..), mkInstanceRelatedIds, buildInstanceEnvs )
+import TcInstUtil ( InstInfo(..), buildInstanceEnvs )
import TcSimplify ( tcSimplifyThetas )
-import RnMonad
-import RnUtils ( RnEnv(..), extendGlobalRnEnv )
-import RnBinds ( rnMethodBinds, rnTopBinds )
-
-import Bag ( emptyBag{-ToDo:rm-}, Bag, isEmptyBag, unionBags, listToBag )
-import Class ( classKey, needsDataDeclCtxtClassKeys, GenClass )
-import CmdLineOpts ( opt_CompilingPrelude )
-import ErrUtils ( pprBagOfErrors, addErrLoc, Error(..) )
-import Id ( dataConArgTys, isNullaryDataCon, mkDictFunId )
-import Maybes ( maybeToBool, Maybe(..) )
-import Name ( moduleNamePair, isLocallyDefined, getSrcLoc,
- mkTopLevName, origName, mkImplicitName, ExportFlag(..),
- RdrName{-instance Outputable-}, Name{--O only-}
+import RnBinds ( rnMethodBinds, rnTopMonoBinds )
+import RnEnv ( newDFunName, bindLocatedLocalsRn )
+import RnMonad ( RnNameSupply,
+ renameSourceCode, thenRn, mapRn, returnRn )
+
+import Bag ( Bag, emptyBag, unionBags, listToBag )
+import Class ( classKey, Class )
+import ErrUtils ( dumpIfSet, Message, pprBagOfErrors )
+import MkId ( mkDictFunId )
+import Id ( mkVanillaId )
+import DataCon ( dataConArgTys, isNullaryDataCon, isExistentialDataCon )
+import PrelInfo ( needsDataDeclCtxtClassKeys )
+import Maybes ( maybeToBool, catMaybes )
+import Module ( ModuleName )
+import Name ( isLocallyDefined, getSrcLoc,
+ Name, NamedThing(..),
+ OccName, nameOccName
)
-import Outputable ( Outputable(..){-instances e.g., (,)-} )
-import PprType ( GenType, GenTyVar, GenClass, TyCon )
-import PprStyle ( PprStyle(..) )
-import Pretty ( ppAbove, ppAboves, ppCat, ppBesides, ppStr, ppHang, Pretty(..) )
-import Pretty--ToDo:rm
-import FiniteMap--ToDo:rm
+import RdrName ( RdrName )
+import RnMonad ( FixityEnv )
import SrcLoc ( mkGeneratedSrcLoc, SrcLoc )
import TyCon ( tyConTyVars, tyConDataCons, tyConDerivings,
- tyConTheta, maybeTyConSingleCon,
- isEnumerationTyCon, isDataTyCon, TyCon
+ tyConTheta, maybeTyConSingleCon, isDataTyCon,
+ isEnumerationTyCon, isAlgTyCon, TyCon
)
-import Type ( GenType(..), TauType(..), mkTyVarTys, applyTyCon,
- mkSigmaTy, mkDictTy, isPrimType, instantiateTy,
- getAppDataTyCon, getAppTyCon
+import Type ( TauType, mkTyVarTys, mkTyConApp,
+ mkSigmaTy, mkDictTy, isUnboxedType,
+ splitAlgTyConApp, classesToPreds
)
+import PprType ( {- instance Outputable Type -} )
import TysWiredIn ( voidTy )
-import TyVar ( GenTyVar )
-import UniqFM ( emptyUFM )
+import Var ( TyVar )
import Unique -- Keys stuff
-import Util ( zipWithEqual, zipEqual, sortLt, removeDups, assoc,
- thenCmp, cmpList, panic, pprPanic, pprPanic#,
- assertPanic, pprTrace{-ToDo:rm-}
- )
+import Bag ( bagToList )
+import Util ( zipWithEqual, sortLt, removeDups, assoc, thenCmp )
+import Outputable
\end{code}
%************************************************************************
-- NEW: it's convenient to re-use InstInfo
-- We'll "panic" out some fields...
-type DerivRhs = [(Class, TauType)] -- Same as a ThetaType!
+type DerivRhs = [(Class, [TauType])] -- Same as a ThetaType!
type DerivSoln = DerivRhs
\end{code}
%************************************************************************
\begin{code}
-tcDeriving :: Module -- name of module under scrutiny
- -> RnEnv -- for "renaming" bits of generated code
+tcDeriving :: ModuleName -- name of module under scrutiny
+ -> FixityEnv -- for the deriving code (Show/Read.)
+ -> RnNameSupply -- for "renaming" bits of generated code
-> Bag InstInfo -- What we already know about instances
- -> [RenamedFixityDecl] -- Fixity info; used by Read and Show
-> TcM s (Bag InstInfo, -- The generated "instance decls".
- RenamedHsBinds, -- Extra generated bindings
- PprStyle -> Pretty) -- Printable derived instance decls;
- -- for debugging via -ddump-derivings.
+ RenamedHsBinds) -- Extra generated bindings
+
+tcDeriving modname fixs rn_name_supply inst_decl_infos_in
+ = recoverTc (returnTc (emptyBag, EmptyBinds)) $
-tcDeriving modname rn_env inst_decl_infos_in fixities
- = -- Fish the "deriving"-related information out of the TcEnv
+ -- Fish the "deriving"-related information out of the TcEnv
-- and make the necessary "equations".
- makeDerivEqns `thenTc` \ eqns ->
+ makeDerivEqns `thenTc` \ eqns ->
+ if null eqns then
+ returnTc (emptyBag, EmptyBinds)
+ else
-- Take the equation list and solve it, to deliver a list of
-- solutions, a.k.a. the contexts for the instance decls
-- required for the corresponding equations.
- solveDerivEqns inst_decl_infos_in eqns
- `thenTc` \ new_inst_infos ->
+ solveDerivEqns inst_decl_infos_in eqns `thenTc` \ new_inst_infos ->
-- Now augment the InstInfos, adding in the rather boring
-- actual-code-to-do-the-methods binds. We may also need to
-- "con2tag" and/or "tag2con" functions. We do these
-- separately.
- gen_taggery_Names new_inst_infos `thenTc` \ nm_alist_etc ->
- gen_tag_n_con_binds rn_env nm_alist_etc
- `thenTc` \ (extra_binds, deriver_rn_env) ->
+ gen_taggery_Names new_inst_infos `thenTc` \ nm_alist_etc ->
+
- mapTc (gen_inst_info maybe_mod fixities deriver_rn_env) new_inst_infos
- `thenTc` \ really_new_inst_infos ->
let
- ddump_deriv = ddump_deriving really_new_inst_infos extra_binds
+ 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 fixs) new_inst_infos
+ mbinders = bagToList (collectMonoBinders extra_mbinds)
+
+ -- Rename to get RenamedBinds.
+ -- The only tricky bit is that the extra_binds must scope over the
+ -- method bindings for the instances.
+ (dfun_names_w_method_binds, rn_extra_binds)
+ = renameSourceCode modname rn_name_supply (
+ bindLocatedLocalsRn (ptext (SLIT("deriving"))) mbinders $ \ _ ->
+ rnTopMonoBinds extra_mbinds [] `thenRn` \ (rn_extra_binds, _) ->
+ mapRn rn_one method_binds_s `thenRn` \ dfun_names_w_method_binds ->
+ returnRn (dfun_names_w_method_binds, rn_extra_binds)
+ )
+ rn_one (cl_nm, tycon_nm, meth_binds)
+ = newDFunName (cl_nm, tycon_nm)
+ mkGeneratedSrcLoc `thenRn` \ dfun_name ->
+ rnMethodBinds meth_binds `thenRn` \ (rn_meth_binds, _) ->
+ returnRn (dfun_name, rn_meth_binds)
+
+ really_new_inst_infos = zipWith gen_inst_info
+ new_inst_infos
+ dfun_names_w_method_binds
+
+ ddump_deriv = ddump_deriving really_new_inst_infos rn_extra_binds
in
- --pprTrace "derived:\n" (ddump_deriv PprDebug) $
+ ioToTc (dumpIfSet opt_D_dump_deriv "Derived instances" ddump_deriv) `thenTc_`
- returnTc (listToBag really_new_inst_infos,
- extra_binds,
- ddump_deriv)
+ returnTc (listToBag really_new_inst_infos, rn_extra_binds)
where
- maybe_mod = if opt_CompilingPrelude then Nothing else Just modname
-
- ddump_deriving :: [InstInfo] -> RenamedHsBinds -> (PprStyle -> Pretty)
-
- ddump_deriving inst_infos extra_binds sty
- = ppAboves ((map pp_info inst_infos) ++ [ppr sty extra_binds])
+ ddump_deriving :: [InstInfo] -> RenamedHsBinds -> SDoc
+ ddump_deriving inst_infos extra_binds
+ = vcat (map pp_info inst_infos) $$ ppr extra_binds
where
- pp_info (InstInfo clas tvs ty inst_decl_theta _ _ _ mbinds _ _ _ _)
- = ppAbove (ppr sty (mkSigmaTy tvs inst_decl_theta (mkDictTy clas ty)))
- (ppr sty mbinds)
+ pp_info (InstInfo clas tvs [ty] inst_decl_theta _ mbinds _ _)
+ = ppr (mkSigmaTy tvs inst_decl_theta' (mkDictTy clas [ty]))
+ $$
+ ppr mbinds
+ where inst_decl_theta' = classesToPreds inst_decl_theta
\end{code}
makeDerivEqns
= tcGetEnv `thenNF_Tc` \ env ->
- tcLookupClassByKey evalClassKey `thenNF_Tc` \ eval_clas ->
- let
- tycons = filter isDataTyCon (getEnv_TyCons env)
- -- ToDo: what about newtypes???
- think_about_deriving = need_deriving eval_clas tycons
- in
- mapTc chk_out think_about_deriving `thenTc_`
let
- (derive_these, _) = removeDups cmp_deriv think_about_deriving
- eqns = map mk_eqn derive_these
+ local_data_tycons = filter (\tc -> isLocallyDefined tc && isAlgTyCon tc)
+ (getEnvTyCons env)
+
+ think_about_deriving = need_deriving local_data_tycons
+ (derive_these, _) = removeDups cmp_deriv think_about_deriving
+ eqns = map mk_eqn derive_these
in
- returnTc eqns
+ if null local_data_tycons then
+ returnTc [] -- Bale out now
+ else
+ mapTc mk_eqn derive_these `thenTc` \ maybe_eqns ->
+ returnTc (catMaybes maybe_eqns)
where
------------------------------------------------------------------
- need_deriving :: Class -> [TyCon] -> [(Class, TyCon)]
+ need_deriving :: [TyCon] -> [(Class, TyCon)]
-- find the tycons that have `deriving' clauses;
- -- we handle the "every datatype in Eval" by
- -- doing a dummy "deriving" for it.
-
- need_deriving eval_clas tycons_to_consider
- = foldr ( \ tycon acc ->
- let
- acc_plus = if isLocallyDefined tycon
- then (eval_clas, tycon) : acc
- else acc
- in
- case (tyConDerivings tycon) of
- [] -> acc_plus
- cs -> [ (clas,tycon) | clas <- cs ] ++ acc_plus
- )
+
+ need_deriving tycons_to_consider
+ = foldr (\ tycon acc -> [(clas,tycon) | clas <- tyConDerivings tycon] ++ acc)
[]
tycons_to_consider
------------------------------------------------------------------
- chk_out :: (Class, TyCon) -> TcM s ()
- chk_out this_one@(clas, tycon)
- = let
- clas_key = classKey clas
-
- is_enumeration = isEnumerationTyCon tycon
- is_single_con = maybeToBool (maybeTyConSingleCon tycon)
-
- chk_clas clas_uniq clas_str cond
- = if (clas_uniq == clas_key)
- then checkTc cond (derivingThingErr clas_str tycon)
- else returnTc ()
- in
- -- Are things OK for deriving Enum (if appropriate)?
- chk_clas enumClassKey "Enum" is_enumeration `thenTc_`
-
- -- Are things OK for deriving Bounded (if appropriate)?
- chk_clas boundedClassKey "Bounded"
- (is_enumeration || is_single_con) `thenTc_`
-
- -- Are things OK for deriving Ix (if appropriate)?
- chk_clas ixClassKey "Ix.Ix" (is_enumeration || is_single_con)
-
- ------------------------------------------------------------------
- cmp_deriv :: (Class, TyCon) -> (Class, TyCon) -> TAG_
+ cmp_deriv :: (Class, TyCon) -> (Class, TyCon) -> Ordering
cmp_deriv (c1, t1) (c2, t2)
- = (c1 `cmp` c2) `thenCmp` (t1 `cmp` t2)
+ = (c1 `compare` c2) `thenCmp` (t1 `compare` t2)
------------------------------------------------------------------
- mk_eqn :: (Class, TyCon) -> DerivEqn
+ mk_eqn :: (Class, TyCon) -> NF_TcM s (Maybe DerivEqn)
-- we swizzle the tyvars and datacons out of the tycon
-- to make the rest of the equation
mk_eqn (clas, tycon)
- = (clas, tycon, tyvars, if_not_Eval constraints)
+ = case chk_out clas tycon of
+ Just err -> addErrTc err `thenNF_Tc_`
+ returnNF_Tc Nothing
+ Nothing -> returnNF_Tc (Just (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
- if_not_Eval cs = if clas_key == evalClassKey then [] else cs
-
constraints = extra_constraints ++ concat (map mk_constraints data_cons)
-- "extra_constraints": see notes above about contexts on data decls
offensive_class = clas_key `elem` needsDataDeclCtxtClassKeys
mk_constraints data_con
- = [ (clas, arg_ty)
+ = [ (clas, [arg_ty])
| arg_ty <- instd_arg_tys,
- not (isPrimType arg_ty) -- No constraints for primitive types
+ 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` 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
+ where
+ 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")
+
+ bog_out why = Just (derivingThingErr clas tycon why)
\end{code}
%************************************************************************
initial_solutions :: [DerivSoln]
initial_solutions = [ [] | _ <- orig_eqns ]
+ ------------------------------------------------------------------
-- iterateDeriv calculates the next batch of solutions,
-- compares it with the current one; finishes if they are the
-- same, otherwise recurses with the new solutions.
-
+ -- It fails if any iteration fails
iterateDeriv :: [DerivSoln] ->TcM s [InstInfo]
-
iterateDeriv current_solns
+ = checkNoErrsTc (iterateOnce current_solns) `thenTc` \ (new_inst_infos, new_solns) ->
+ if (current_solns == new_solns) then
+ returnTc new_inst_infos
+ else
+ iterateDeriv new_solns
+
+ ------------------------------------------------------------------
+ iterateOnce current_solns
= -- Extend the inst info from the explicit instance decls
-- with the current set of solutions, giving a
add_solns inst_decl_infos_in orig_eqns current_solns
- `thenTc` \ (new_inst_infos, inst_mapper) ->
+ `thenNF_Tc` \ (new_inst_infos, inst_mapper) ->
let
- class_to_inst_env cls = fst (inst_mapper cls)
+ class_to_inst_env cls = inst_mapper cls
in
-- Simplify each RHS
- listTc [ tcSimplifyThetas class_to_inst_env [{-Nothing "given"-}] deriv_rhs
- | (_,_,_,deriv_rhs) <- orig_eqns ] `thenTc` \ next_solns ->
+ listTc [ tcAddErrCtxt (derivCtxt tc) $
+ tcSimplifyThetas class_to_inst_env deriv_rhs
+ | (_,tc,_,deriv_rhs) <- orig_eqns ] `thenTc` \ next_solns ->
-- Canonicalise the solutions, so they compare nicely
let canonicalised_next_solns
- = [ sortLt lt_rhs next_soln | next_soln <- next_solns ] in
-
- if (current_solns `eq_solns` canonicalised_next_solns) then
- returnTc new_inst_infos
- else
- iterateDeriv canonicalised_next_solns
-
- where
- ------------------------------------------------------------------
- lt_rhs r1 r2 = case cmp_rhs r1 r2 of { LT_ -> True; _ -> False }
- eq_solns s1 s2 = case cmp_solns s1 s2 of { EQ_ -> True; _ -> False }
- cmp_solns s1 s2 = cmpList (cmpList cmp_rhs) s1 s2
- cmp_rhs (c1, TyVarTy tv1) (c2, TyVarTy tv2)
- = (tv1 `cmp` tv2) `thenCmp` (c1 `cmp` c2)
-#ifdef DEBUG
- cmp_rhs other_1 other_2
- = pprPanic# "tcDeriv:cmp_rhs:" (ppCat [ppr PprDebug other_1, ppr PprDebug other_2])
-#endif
-
+ = [ sortLt (<) next_soln | next_soln <- next_solns ]
+ in
+ returnTc (new_inst_infos, canonicalised_next_solns)
\end{code}
\begin{code}
add_solns :: Bag InstInfo -- The global, non-derived ones
-> [DerivEqn] -> [DerivSoln]
- -> TcM s ([InstInfo], -- The new, derived ones
- InstanceMapper)
+ -> NF_TcM s ([InstInfo], -- The new, derived ones
+ InstanceMapper)
-- the eqns and solns move "in lockstep"; we have the eqns
-- because we need the LHS info for addClassInstance.
add_solns inst_infos_in eqns solns
- = buildInstanceEnvs all_inst_infos `thenTc` \ inst_mapper ->
- returnTc (new_inst_infos, inst_mapper)
+
+ = discardErrsTc (buildInstanceEnvs all_inst_infos) `thenNF_Tc` \ inst_mapper ->
+ -- We do the discard-errs so that we don't get repeated error messages
+ -- about duplicate instances.
+ -- They'll appear later, when we do the top-level buildInstanceEnvs.
+
+ returnNF_Tc (new_inst_infos, inst_mapper)
where
new_inst_infos = zipWithEqual "add_solns" mk_deriv_inst_info eqns solns
all_inst_infos = inst_infos_in `unionBags` listToBag new_inst_infos
mk_deriv_inst_info (clas, tycon, tyvars, _) theta
- = InstInfo clas tyvars (applyTyCon tycon (mkTyVarTys tyvars))
+ = InstInfo clas tyvars [mkTyConApp tycon (mkTyVarTys tyvars)]
theta
- (my_panic "dfun_theta")
-
dummy_dfun_id
-
- (my_panic "const_meth_ids")
- (my_panic "binds") (my_panic "from_here")
- (my_panic "modname") mkGeneratedSrcLoc
+ (my_panic "binds") (getSrcLoc tycon)
(my_panic "upragmas")
where
dummy_dfun_id
- = mkDictFunId bottom bottom bottom dummy_dfun_ty
- bottom bottom bottom bottom
- where
- bottom = panic "dummy_dfun_id"
+ = mkVanillaId (getName tycon) dummy_dfun_ty
+ -- The name is getSrcLoc'd in an error message
- dummy_dfun_ty = mkSigmaTy tyvars theta voidTy
+ theta' = classesToPreds theta
+ dummy_dfun_ty = mkSigmaTy tyvars theta' voidTy
-- All we need from the dfun is its "theta" part, used during
-- equation simplification (tcSimplifyThetas). The final
-- dfun_id will have the superclass dictionaries as arguments too,
-- We can't leave it as a panic because to get the theta part we
-- have to run down the type!
- my_panic str = pprPanic ("add_soln:"++str) (ppCat [ppChar ':', ppr PprDebug clas, ppr PprDebug tycon])
+ my_panic str = panic "add_soln" -- pprPanic ("add_soln:"++str) (hsep [char ':', ppr clas, ppr tycon])
\end{code}
%************************************************************************
\end{itemize}
\begin{code}
-gen_inst_info :: Maybe Module -- Module name; Nothing => Prelude
- -> [RenamedFixityDecl] -- all known fixities;
- -- may be needed for Text
- -> RnEnv -- lookup stuff for names we may use
- -> InstInfo -- the main stuff to work on
- -> TcM s InstInfo -- the gen'd (filled-in) "instance decl"
-
-gen_inst_info modname fixities deriver_rn_env
- (InstInfo clas tyvars ty inst_decl_theta _ _ _ _ _ _ locn _)
+-- Generate the method bindings for the required instance
+-- (paired with class name, as we need that when generating dict
+-- names.)
+gen_bind :: FixityEnv -> InstInfo -> ({-class-}OccName, {-tyCon-}OccName, RdrNameMonoBinds)
+gen_bind fixities (InstInfo clas _ [ty] _ _ _ _ _)
+ | not from_here
+ = (clas_nm, tycon_nm, EmptyMonoBinds)
+ | clas `hasKey` showClassKey
+ = (clas_nm, tycon_nm, gen_Show_binds fixities tycon)
+ | clas `hasKey` readClassKey
+ = (clas_nm, tycon_nm, gen_Read_binds fixities tycon)
+ | otherwise
+ = (clas_nm, tycon_nm,
+ 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)
+ where
+ clas_nm = nameOccName (getName clas)
+ tycon_nm = nameOccName (getName tycon)
+ from_here = isLocallyDefined tycon
+ (tycon,_,_) = splitAlgTyConApp ty
+
+gen_inst_info :: InstInfo
+ -> (Name, RenamedMonoBinds)
+ -> InstInfo -- the gen'd (filled-in) "instance decl"
+
+gen_inst_info (InstInfo clas tyvars tys@(ty:_) inst_decl_theta _ _ locn _)
+ (dfun_name, meth_binds)
=
-- Generate the various instance-related Ids
- mkInstanceRelatedIds
- True {-from_here-} locn modname
- NoInstancePragmas
- clas tyvars ty
- inst_decl_theta
- [{-no user pragmas-}]
- `thenTc` \ (dfun_id, dfun_theta, const_meth_ids) ->
-
- -- Generate the bindings for the new instance declaration,
- -- rename it, and check for errors
- let
- (tycon,_,_) = --pprTrace "gen_inst_info:ty" (ppCat[ppr PprDebug clas, ppr PprDebug ty]) $
- getAppDataTyCon ty
-
- proto_mbinds
- = assoc "gen_inst_info:bad derived class"
- [(eqClassKey, gen_Eq_binds)
- ,(ordClassKey, gen_Ord_binds)
- ,(enumClassKey, gen_Enum_binds)
- ,(evalClassKey, gen_Eval_binds)
- ,(boundedClassKey, gen_Bounded_binds)
- ,(showClassKey, gen_Show_binds fixities)
- ,(readClassKey, gen_Read_binds fixities)
- ,(ixClassKey, gen_Ix_binds)
- ]
- clas_key $ tycon
- in
-{-
- let
- ((qual, unqual, tc_qual, tc_unqual), stack) = deriver_rn_env
- in
- pprTrace "gen_inst:qual:" (ppCat [ppBesides[ppPStr m,ppChar '.',ppPStr n] | (n,m) <- keysFM qual]) $
- pprTrace "gen_inst:unqual:" (ppCat (map ppPStr (keysFM unqual))) $
- pprTrace "gen_inst:tc_qual:" (ppCat [ppBesides[ppPStr m,ppChar '.',ppPStr n] | (n,m) <- keysFM tc_qual]) $
- pprTrace "gen_inst:tc_unqual:" (ppCat (map ppPStr (keysFM tc_unqual))) $
--}
- -- pprTrace "derived binds:" (ppr PprDebug proto_mbinds) $
-
- rnMtoTcM deriver_rn_env (
- setExtraRn emptyUFM{-no fixities-} $
- rnMethodBinds clas_Name proto_mbinds
- ) `thenNF_Tc` \ (mbinds, errs) ->
-
- if not (isEmptyBag errs) then
- pprPanic "gen_inst_info:renamer errs!\n"
- (ppAbove (pprBagOfErrors PprDebug errs) (ppr PprDebug proto_mbinds))
- else
- -- All done
- let
- from_here = isLocallyDefined tycon -- If so, then from here
- in
- returnTc (InstInfo clas tyvars ty inst_decl_theta
- dfun_theta dfun_id const_meth_ids
- (if from_here then mbinds else EmptyMonoBinds)
- from_here modname locn [])
+ InstInfo clas tyvars tys inst_decl_theta
+ dfun_id
+ meth_binds
+ locn []
where
- clas_key = classKey clas
- clas_Name = RnImplicitClass (mkImplicitName clas_key (origName clas))
+ dfun_id = mkDictFunId dfun_name clas tyvars tys inst_decl_theta
+
+ from_here = isLocallyDefined tycon
+ (tycon,_,_) = splitAlgTyConApp ty
\end{code}
+
%************************************************************************
%* *
-\subsection[TcGenDeriv-con2tag-tag2con]{Generating extra binds (@con2tag@ and @tag2con@)}
+\subsection[TcDeriv-taggery-Names]{What con2tag/tag2con functions are available?}
%* *
%************************************************************************
+
data Foo ... = ...
con2tag_Foo :: Foo ... -> Int#
tag2con_Foo :: Int -> Foo ... -- easier if Int, not Int#
maxtag_Foo :: Int -- ditto (NB: not unboxed)
-\begin{code}
-gen_tag_n_con_binds :: RnEnv
- -> [(RdrName, TyCon, TagThingWanted)]
- -> TcM s (RenamedHsBinds,
- RnEnv) -- input one with any new names added
-
-gen_tag_n_con_binds rn_env nm_alist_etc
- =
- let
- -- We have the renamer's final "name funs" in our hands
- -- (they were passed in). So we can handle ProtoNames
- -- that refer to anything "out there". But our generated
- -- code may also mention "con2tag" (etc.). So we need
- -- to augment to "name funs" to include those.
-
- names_to_add = [ pn | (pn,_,_) <- nm_alist_etc ]
- in
- tcGetUniques (length names_to_add) `thenNF_Tc` \ uniqs ->
- let
- pairs_to_add = [ (pn, mkRnName (mkTopLevName u pn mkGeneratedSrcLoc ExportAll []))
- | (pn,u) <- zipEqual "gen_tag..." names_to_add uniqs ]
-
- deriver_rn_env
- = if null names_to_add
- then rn_env else added_rn_env
-
- (added_rn_env, errs_bag)
- = extendGlobalRnEnv rn_env pairs_to_add [{-no tycons-}]
-
- ----------------
- proto_mbind_list = map gen_tag_n_con_monobind nm_alist_etc
- proto_mbinds = foldr AndMonoBinds EmptyMonoBinds proto_mbind_list
- in
- ASSERT(isEmptyBag errs_bag)
-
- rnMtoTcM deriver_rn_env (
- setExtraRn emptyUFM{-no fixities-} $
- rnTopBinds (SingleBind (RecBind proto_mbinds))
- ) `thenNF_Tc` \ (binds, errs) ->
-
- if not (isEmptyBag errs) then
- pprPanic "gen_tag_n_con_binds:renamer errs!\n"
- (ppAbove (pprBagOfErrors PprDebug errs) (ppr PprDebug binds))
- else
- returnTc (binds, deriver_rn_env)
-\end{code}
-
-%************************************************************************
-%* *
-\subsection[TcDeriv-taggery-Names]{What con2tag/tag2con functions are available?}
-%* *
-%************************************************************************
We have a @con2tag@ function for a tycon if:
\begin{itemize}
TagThingWanted)]
gen_taggery_Names inst_infos
- = --pprTrace "gen_taggery:\n" (ppAboves [ppCat [ppr PprDebug c, ppr PprDebug t] | (c,t) <- all_CTs]) $
+ = --pprTrace "gen_taggery:\n" (vcat [hsep [ppr c, ppr t] | (c,t) <- all_CTs]) $
foldlTc do_con2tag [] tycons_of_interest `thenTc` \ names_so_far ->
foldlTc do_tag2con names_so_far tycons_of_interest
where
- all_CTs = [ mk_CT c ty | (InstInfo c _ ty _ _ _ _ _ _ _ _ _) <- inst_infos ]
+ all_CTs = [ (c, get_tycon ty) | (InstInfo c _ [ty] _ _ _ _ _) <- inst_infos ]
- mk_CT c ty = (c, fst (getAppTyCon ty))
+ get_tycon ty = case splitAlgTyConApp ty of { (tc, _, _) -> tc }
all_tycons = map snd all_CTs
- (tycons_of_interest, _) = removeDups cmp all_tycons
+ (tycons_of_interest, _) = removeDups compare all_tycons
do_con2tag acc_Names tycon
- = if (we_are_deriving eqClassKey tycon
+ | isDataTyCon tycon &&
+ ((we_are_deriving eqClassKey tycon
&& any isNullaryDataCon (tyConDataCons tycon))
- || (we_are_deriving ordClassKey tycon
+ || (we_are_deriving ordClassKey tycon
&& not (maybeToBool (maybeTyConSingleCon tycon)))
- || (we_are_deriving enumClassKey tycon)
- || (we_are_deriving ixClassKey tycon)
- then
- returnTc ((con2tag_PN tycon, tycon, GenCon2Tag)
+ || (we_are_deriving enumClassKey tycon)
+ || (we_are_deriving ixClassKey tycon))
+
+ = returnTc ((con2tag_RDR tycon, tycon, GenCon2Tag)
: acc_Names)
- else
- returnTc acc_Names
+ | otherwise
+ = returnTc acc_Names
do_tag2con acc_Names tycon
- = if (we_are_deriving enumClassKey tycon)
- || (we_are_deriving ixClassKey tycon)
- then
- returnTc ( (tag2con_PN tycon, tycon, GenTag2Con)
- : (maxtag_PN tycon, tycon, GenMaxTag)
- : acc_Names)
- else
- returnTc acc_Names
+ | isDataTyCon tycon &&
+ (we_are_deriving enumClassKey tycon ||
+ we_are_deriving ixClassKey tycon
+ && isEnumerationTyCon tycon)
+ = returnTc ( (tag2con_RDR tycon, tycon, GenTag2Con)
+ : (maxtag_RDR tycon, tycon, GenMaxTag)
+ : acc_Names)
+ | otherwise
+ = returnTc acc_Names
we_are_deriving clas_key tycon
= is_in_eqns clas_key tycon all_CTs
\end{code}
\begin{code}
-derivingThingErr :: String -> TyCon -> Error
+derivingThingErr :: Class -> TyCon -> FAST_STRING -> Message
+
+derivingThingErr clas tycon why
+ = sep [hsep [ptext SLIT("Can't make a derived instance of"), quotes (ppr clas)],
+ hsep [ptext SLIT("for the type"), quotes (ppr tycon)],
+ parens (ptext why)]
+
+existentialErr clas tycon
+ = sep [ptext SLIT("Can't derive any instances for type") <+> quotes (ppr tycon),
+ ptext SLIT("because it has existentially-quantified constructor(s)")]
-derivingThingErr thing tycon sty
- = ppHang (ppCat [ppStr "Can't make a derived instance of", ppStr thing])
- 4 (ppBesides [ppStr "for the type `", ppr sty tycon, ppStr "'"])
+derivCtxt tycon
+ = ptext SLIT("When deriving classes for") <+> quotes (ppr tycon)
\end{code}
projects / ghc-hetmet.git / blobdiff