2 % (c) The GRASP/AQUA Project, Glasgow University, 1992-1998
4 \section[TcDeriv]{Deriving}
6 Handles @deriving@ clauses on @data@ declarations.
9 module TcDeriv ( tcDeriving ) where
11 #include "HsVersions.h"
14 import CmdLineOpts ( DynFlag(..) )
16 import Generics ( mkTyConGenericBinds )
18 import TcEnv ( newDFunName, pprInstInfoDetails,
19 InstInfo(..), InstBindings(..),
20 tcLookupClass, tcLookupTyCon, tcExtendTyVarEnv
22 import TcGenDeriv -- Deriv stuff
23 import InstEnv ( simpleDFunClassTyCon, extendInstEnv )
24 import TcHsType ( tcHsPred )
25 import TcSimplify ( tcSimplifyDeriv )
27 import RnBinds ( rnMethodBinds, rnTopBinds )
28 import RnEnv ( bindLocalNames )
29 import TcRnMonad ( thenM, returnM, mapAndUnzipM )
30 import HscTypes ( DFunId, FixityEnv )
32 import Class ( className, classArity, classKey, classTyVars, classSCTheta, Class )
33 import Subst ( mkTyVarSubst, substTheta )
34 import ErrUtils ( dumpIfSet_dyn )
35 import MkId ( mkDictFunId )
36 import DataCon ( dataConOrigArgTys, isNullaryDataCon, isExistentialDataCon )
37 import Maybes ( catMaybes )
38 import RdrName ( RdrName )
39 import Name ( Name, getSrcLoc )
40 import NameSet ( NameSet, emptyNameSet, duDefs )
41 import Unique ( Unique, getUnique )
42 import Kind ( splitKindFunTys )
43 import TyCon ( tyConTyVars, tyConDataCons, tyConArity, tyConHasGenerics,
44 tyConTheta, isProductTyCon, isDataTyCon,
45 isEnumerationTyCon, isRecursiveTyCon, TyCon
47 import TcType ( TcType, ThetaType, mkTyVarTy, mkTyVarTys, mkTyConApp,
48 getClassPredTys_maybe, tcTyConAppTyCon,
49 isUnLiftedType, mkClassPred, tyVarsOfTypes, isArgTypeKind,
50 tcEqTypes, tcSplitAppTys, mkAppTys, tcSplitDFunTy )
51 import Var ( TyVar, tyVarKind, idType, varName )
52 import VarSet ( mkVarSet, subVarSet )
54 import SrcLoc ( srcLocSpan, Located(..) )
55 import Util ( zipWithEqual, sortLt, notNull )
56 import ListSetOps ( removeDups, assocMaybe )
61 %************************************************************************
63 \subsection[TcDeriv-intro]{Introduction to how we do deriving}
65 %************************************************************************
69 data T a b = C1 (Foo a) (Bar b)
74 [NOTE: See end of these comments for what to do with
75 data (C a, D b) => T a b = ...
78 We want to come up with an instance declaration of the form
80 instance (Ping a, Pong b, ...) => Eq (T a b) where
83 It is pretty easy, albeit tedious, to fill in the code "...". The
84 trick is to figure out what the context for the instance decl is,
85 namely @Ping@, @Pong@ and friends.
87 Let's call the context reqd for the T instance of class C at types
88 (a,b, ...) C (T a b). Thus:
90 Eq (T a b) = (Ping a, Pong b, ...)
92 Now we can get a (recursive) equation from the @data@ decl:
94 Eq (T a b) = Eq (Foo a) u Eq (Bar b) -- From C1
95 u Eq (T b a) u Eq Int -- From C2
96 u Eq (T a a) -- From C3
98 Foo and Bar may have explicit instances for @Eq@, in which case we can
99 just substitute for them. Alternatively, either or both may have
100 their @Eq@ instances given by @deriving@ clauses, in which case they
101 form part of the system of equations.
103 Now all we need do is simplify and solve the equations, iterating to
104 find the least fixpoint. Notice that the order of the arguments can
105 switch around, as here in the recursive calls to T.
107 Let's suppose Eq (Foo a) = Eq a, and Eq (Bar b) = Ping b.
111 Eq (T a b) = {} -- The empty set
114 Eq (T a b) = Eq (Foo a) u Eq (Bar b) -- From C1
115 u Eq (T b a) u Eq Int -- From C2
116 u Eq (T a a) -- From C3
118 After simplification:
119 = Eq a u Ping b u {} u {} u {}
124 Eq (T a b) = Eq (Foo a) u Eq (Bar b) -- From C1
125 u Eq (T b a) u Eq Int -- From C2
126 u Eq (T a a) -- From C3
128 After simplification:
133 = Eq a u Ping b u Eq b u Ping a
135 The next iteration gives the same result, so this is the fixpoint. We
136 need to make a canonical form of the RHS to ensure convergence. We do
137 this by simplifying the RHS to a form in which
139 - the classes constrain only tyvars
140 - the list is sorted by tyvar (major key) and then class (minor key)
141 - no duplicates, of course
143 So, here are the synonyms for the ``equation'' structures:
146 type DerivEqn = (Name, Class, TyCon, [TyVar], DerivRhs)
147 -- The Name is the name for the DFun we'll build
148 -- The tyvars bind all the variables in the RHS
150 pprDerivEqn (n,c,tc,tvs,rhs)
151 = parens (hsep [ppr n, ppr c, ppr tc, ppr tvs] <+> equals <+> ppr rhs)
153 type DerivRhs = ThetaType
154 type DerivSoln = DerivRhs
158 [Data decl contexts] A note about contexts on data decls
159 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
162 data (RealFloat a) => Complex a = !a :+ !a deriving( Read )
164 We will need an instance decl like:
166 instance (Read a, RealFloat a) => Read (Complex a) where
169 The RealFloat in the context is because the read method for Complex is bound
170 to construct a Complex, and doing that requires that the argument type is
173 But this ain't true for Show, Eq, Ord, etc, since they don't construct
174 a Complex; they only take them apart.
176 Our approach: identify the offending classes, and add the data type
177 context to the instance decl. The "offending classes" are
181 FURTHER NOTE ADDED March 2002. In fact, Haskell98 now requires that
182 pattern matching against a constructor from a data type with a context
183 gives rise to the constraints for that context -- or at least the thinned
184 version. So now all classes are "offending".
188 %************************************************************************
190 \subsection[TcDeriv-driver]{Top-level function for \tr{derivings}}
192 %************************************************************************
195 tcDeriving :: [LTyClDecl Name] -- All type constructors
196 -> TcM ([InstInfo], -- The generated "instance decls"
197 [HsBindGroup Name], -- Extra generated top-level bindings
198 NameSet) -- Binders to keep alive
200 tcDeriving tycl_decls
201 = recoverM (returnM ([], [], emptyNameSet)) $
202 do { -- Fish the "deriving"-related information out of the TcEnv
203 -- and make the necessary "equations".
204 ; (ordinary_eqns, newtype_inst_info) <- makeDerivEqns tycl_decls
206 ; (ordinary_inst_info, deriv_binds)
207 <- extendLocalInstEnv (map iDFunId newtype_inst_info) $
208 deriveOrdinaryStuff ordinary_eqns
209 -- Add the newtype-derived instances to the inst env
210 -- before tacking the "ordinary" ones
212 -- Generate the generic to/from functions from each type declaration
213 ; gen_binds <- mkGenericBinds tycl_decls
214 ; let inst_info = newtype_inst_info ++ ordinary_inst_info
216 -- Rename these extra bindings, discarding warnings about unused bindings etc
217 -- Set -fglasgow exts so that we can have type signatures in patterns,
218 -- which is used in the generic binds
219 ; (rn_binds, gen_bndrs)
220 <- discardWarnings $ setOptM Opt_GlasgowExts $ do
221 { (rn_deriv, _dus1) <- rnTopBinds deriv_binds []
222 ; (rn_gen, dus_gen) <- rnTopBinds gen_binds []
223 ; return (rn_deriv ++ rn_gen, duDefs dus_gen) }
227 ; ioToTcRn (dumpIfSet_dyn dflags Opt_D_dump_deriv "Derived instances"
228 (ddump_deriving inst_info rn_binds))
230 ; returnM (inst_info, rn_binds, gen_bndrs)
233 ddump_deriving :: [InstInfo] -> [HsBindGroup Name] -> SDoc
234 ddump_deriving inst_infos extra_binds
235 = vcat (map pprInstInfoDetails inst_infos) $$ vcat (map ppr extra_binds)
237 -----------------------------------------
238 deriveOrdinaryStuff [] -- Short cut
239 = returnM ([], emptyBag)
241 deriveOrdinaryStuff eqns
242 = do { -- Take the equation list and solve it, to deliver a list of
243 -- solutions, a.k.a. the contexts for the instance decls
244 -- required for the corresponding equations.
245 ; new_dfuns <- solveDerivEqns eqns
247 -- Generate the InstInfo for each dfun,
248 -- plus any auxiliary bindings it needs
249 ; (inst_infos, aux_binds_s) <- mapAndUnzipM genInst new_dfuns
251 -- Generate any extra not-one-inst-decl-specific binds,
252 -- notably "con2tag" and/or "tag2con" functions.
253 ; extra_binds <- genTaggeryBinds new_dfuns
256 ; returnM (inst_infos, unionManyBags (extra_binds : aux_binds_s))
259 -----------------------------------------
260 mkGenericBinds tycl_decls
261 = do { tcs <- mapM tcLookupTyCon
263 L _ (TyData { tcdLName = L _ tc_name }) <- tycl_decls]
264 -- We are only interested in the data type declarations
265 ; return (unionManyBags [ mkTyConGenericBinds tc |
266 tc <- tcs, tyConHasGenerics tc ]) }
267 -- And then only in the ones whose 'has-generics' flag is on
271 %************************************************************************
273 \subsection[TcDeriv-eqns]{Forming the equations}
275 %************************************************************************
277 @makeDerivEqns@ fishes around to find the info about needed derived
278 instances. Complicating factors:
281 We can only derive @Enum@ if the data type is an enumeration
282 type (all nullary data constructors).
285 We can only derive @Ix@ if the data type is an enumeration {\em
286 or} has just one data constructor (e.g., tuples).
289 [See Appendix~E in the Haskell~1.2 report.] This code here deals w/
293 makeDerivEqns :: [LTyClDecl Name]
294 -> TcM ([DerivEqn], -- Ordinary derivings
295 [InstInfo]) -- Special newtype derivings
297 makeDerivEqns tycl_decls
298 = mapAndUnzipM mk_eqn derive_these `thenM` \ (maybe_ordinaries, maybe_newtypes) ->
299 returnM (catMaybes maybe_ordinaries, catMaybes maybe_newtypes)
301 ------------------------------------------------------------------
302 derive_these :: [(NewOrData, Name, LHsPred Name)]
303 -- Find the (nd, TyCon, Pred) pairs that must be `derived'
304 derive_these = [ (nd, tycon, pred)
305 | L _ (TyData { tcdND = nd, tcdLName = L _ tycon,
306 tcdDerivs = Just (L _ preds) }) <- tycl_decls,
309 ------------------------------------------------------------------
310 mk_eqn :: (NewOrData, Name, LHsPred Name) -> TcM (Maybe DerivEqn, Maybe InstInfo)
311 -- We swizzle the tyvars and datacons out of the tycon
312 -- to make the rest of the equation
314 mk_eqn (new_or_data, tycon_name, pred)
315 = tcLookupTyCon tycon_name `thenM` \ tycon ->
316 addSrcSpan (srcLocSpan (getSrcLoc tycon)) $
317 addErrCtxt (derivCtxt Nothing tycon) $
318 tcExtendTyVarEnv (tyConTyVars tycon) $ -- Deriving preds may (now) mention
319 -- the type variables for the type constructor
320 tcHsPred pred `thenM` \ pred' ->
321 case getClassPredTys_maybe pred' of
322 Nothing -> bale_out (malformedPredErr tycon pred)
323 Just (clas, tys) -> doptM Opt_GlasgowExts `thenM` \ gla_exts ->
324 mk_eqn_help gla_exts new_or_data tycon clas tys
326 ------------------------------------------------------------------
327 mk_eqn_help gla_exts DataType tycon clas tys
328 | Just err <- checkSideConditions gla_exts clas tycon tys
329 = bale_out (derivingThingErr clas tys tycon (tyConTyVars tycon) err)
331 = do { eqn <- mkDataTypeEqn tycon clas
332 ; returnM (Just eqn, Nothing) }
334 mk_eqn_help gla_exts NewType tycon clas tys
335 | can_derive_via_isomorphism && (gla_exts || std_class_via_iso clas)
336 = -- Go ahead and use the isomorphism
337 traceTc (text "newtype deriving:" <+> ppr tycon <+> ppr rep_tys) `thenM_`
338 new_dfun_name clas tycon `thenM` \ dfun_name ->
339 returnM (Nothing, Just (InstInfo { iDFunId = mk_dfun dfun_name,
340 iBinds = NewTypeDerived rep_tys }))
341 | std_class gla_exts clas
342 = mk_eqn_help gla_exts DataType tycon clas tys -- Go via bale-out route
344 | otherwise -- Non-standard instance
345 = bale_out (if gla_exts then
346 cant_derive_err -- Too hard
348 non_std_err) -- Just complain about being a non-std instance
350 -- Here is the plan for newtype derivings. We see
351 -- newtype T a1...an = T (t ak...an) deriving (.., C s1 .. sm, ...)
352 -- where aj...an do not occur free in t, and the (C s1 ... sm) is a
353 -- *partial applications* of class C with the last parameter missing
355 -- We generate the instances
356 -- instance C s1 .. sm (t ak...aj) => C s1 .. sm (T a1...aj)
357 -- where T a1...aj is the partial application of the LHS of the correct kind
359 -- Running example: newtype T s a = MkT (ST s a) deriving( Monad )
360 -- instance Monad (ST s) => Monad (T s) where
361 -- fail = coerce ... (fail @ ST s)
363 clas_tyvars = classTyVars clas
364 kind = tyVarKind (last clas_tyvars)
365 -- Kind of the thing we want to instance
366 -- e.g. argument kind of Monad, *->*
368 (arg_kinds, _) = splitKindFunTys kind
369 n_args_to_drop = length arg_kinds
370 -- Want to drop 1 arg from (T s a) and (ST s a)
371 -- to get instance Monad (ST s) => Monad (T s)
373 -- Note [newtype representation]
374 -- We must not use newTyConRep to get the representation
375 -- type, because that looks through all intermediate newtypes
376 -- To get the RHS of *this* newtype, just look at the data
377 -- constructor. For example
378 -- newtype B = MkB Int
379 -- newtype A = MkA B deriving( Num )
380 -- We want the Num instance of B, *not* the Num instance of Int,
381 -- when making the Num instance of A!
382 tyvars = tyConTyVars tycon
383 rep_ty = head (dataConOrigArgTys (head (tyConDataCons tycon)))
384 (rep_fn, rep_ty_args) = tcSplitAppTys rep_ty
386 n_tyvars_to_keep = tyConArity tycon - n_args_to_drop
387 tyvars_to_drop = drop n_tyvars_to_keep tyvars
388 tyvars_to_keep = take n_tyvars_to_keep tyvars
390 n_args_to_keep = length rep_ty_args - n_args_to_drop
391 args_to_drop = drop n_args_to_keep rep_ty_args
392 args_to_keep = take n_args_to_keep rep_ty_args
394 rep_tys = tys ++ [mkAppTys rep_fn args_to_keep]
395 rep_pred = mkClassPred clas rep_tys
396 -- rep_pred is the representation dictionary, from where
397 -- we are gong to get all the methods for the newtype dictionary
399 inst_tys = (tys ++ [mkTyConApp tycon (mkTyVarTys tyvars_to_keep)])
400 -- The 'tys' here come from the partial application
401 -- in the deriving clause. The last arg is the new
404 -- We must pass the superclasses; the newtype might be an instance
405 -- of them in a different way than the representation type
406 -- E.g. newtype Foo a = Foo a deriving( Show, Num, Eq )
407 -- Then the Show instance is not done via isomprphism; it shows
409 -- The Num instance is derived via isomorphism, but the Show superclass
410 -- dictionary must the Show instance for Foo, *not* the Show dictionary
411 -- gotten from the Num dictionary. So we must build a whole new dictionary
412 -- not just use the Num one. The instance we want is something like:
413 -- instance (Num a, Show (Foo a), Eq (Foo a)) => Num (Foo a) where
416 -- There's no 'corece' needed because after the type checker newtypes
419 sc_theta = substTheta (mkTyVarSubst clas_tyvars inst_tys)
422 -- If there are no tyvars, there's no need
423 -- to abstract over the dictionaries we need
424 dict_args | null tyvars = []
425 | otherwise = rep_pred : sc_theta
427 -- Finally! Here's where we build the dictionary Id
428 mk_dfun dfun_name = mkDictFunId dfun_name tyvars dict_args clas inst_tys
430 -------------------------------------------------------------------
431 -- Figuring out whether we can only do this newtype-deriving thing
433 right_arity = length tys + 1 == classArity clas
435 -- Never derive Read,Show,Typeable,Data this way
436 non_iso_classes = [readClassKey, showClassKey, typeableClassKey, dataClassKey]
437 can_derive_via_isomorphism
438 = not (getUnique clas `elem` non_iso_classes)
439 && right_arity -- Well kinded;
440 -- eg not: newtype T ... deriving( ST )
441 -- because ST needs *2* type params
442 && n_tyvars_to_keep >= 0 -- Type constructor has right kind:
443 -- eg not: newtype T = T Int deriving( Monad )
444 && n_args_to_keep >= 0 -- Rep type has right kind:
445 -- eg not: newtype T a = T Int deriving( Monad )
446 && eta_ok -- Eta reduction works
447 && not (isRecursiveTyCon tycon) -- Does not work for recursive tycons:
448 -- newtype A = MkA [A]
450 -- instance Eq [A] => Eq A !!
452 -- Here's a recursive newtype that's actually OK
453 -- newtype S1 = S1 [T1 ()]
454 -- newtype T1 a = T1 (StateT S1 IO a ) deriving( Monad )
455 -- It's currently rejected. Oh well.
457 -- Check that eta reduction is OK
458 -- (a) the dropped-off args are identical
459 -- (b) the remaining type args mention
460 -- only the remaining type variables
461 eta_ok = (args_to_drop `tcEqTypes` mkTyVarTys tyvars_to_drop)
462 && (tyVarsOfTypes args_to_keep `subVarSet` mkVarSet tyvars_to_keep)
464 cant_derive_err = derivingThingErr clas tys tycon tyvars_to_keep
465 (vcat [ptext SLIT("even with cunning newtype deriving:"),
466 if isRecursiveTyCon tycon then
467 ptext SLIT("the newtype is recursive")
469 if not right_arity then
470 quotes (ppr (mkClassPred clas tys)) <+> ptext SLIT("does not have arity 1")
472 if not (n_tyvars_to_keep >= 0) then
473 ptext SLIT("the type constructor has wrong kind")
474 else if not (n_args_to_keep >= 0) then
475 ptext SLIT("the representation type has wrong kind")
476 else if not eta_ok then
477 ptext SLIT("the eta-reduction property does not hold")
481 non_std_err = derivingThingErr clas tys tycon tyvars_to_keep
482 (vcat [non_std_why clas,
483 ptext SLIT("Try -fglasgow-exts for GHC's newtype-deriving extension")])
485 bale_out err = addErrTc err `thenM_` returnM (Nothing, Nothing)
487 std_class gla_exts clas
488 = key `elem` derivableClassKeys
489 || (gla_exts && (key == typeableClassKey || key == dataClassKey))
493 std_class_via_iso clas -- These standard classes can be derived for a newtype
494 -- using the isomorphism trick *even if no -fglasgow-exts*
495 = classKey clas `elem` [eqClassKey, ordClassKey, ixClassKey, boundedClassKey]
496 -- Not Read/Show because they respect the type
497 -- Not Enum, becuase newtypes are never in Enum
500 new_dfun_name clas tycon -- Just a simple wrapper
501 = newDFunName clas [mkTyConApp tycon []] (getSrcLoc tycon)
502 -- The type passed to newDFunName is only used to generate
503 -- a suitable string; hence the empty type arg list
505 ------------------------------------------------------------------
506 mkDataTypeEqn :: TyCon -> Class -> TcM DerivEqn
507 mkDataTypeEqn tycon clas
508 | clas `hasKey` typeableClassKey
509 = -- The Typeable class is special in several ways
510 -- data T a b = ... deriving( Typeable )
512 -- instance Typeable2 T where ...
513 -- 1. There are no constraints in the instance
514 -- 2. There are no type variables either
515 -- 2. The actual class we want to generate isn't necessarily
516 -- Typeable; it depends on the arity of the type
517 do { real_clas <- tcLookupClass (typeableClassNames !! tyConArity tycon)
518 ; dfun_name <- new_dfun_name real_clas tycon
519 ; return (dfun_name, real_clas, tycon, [], []) }
522 = do { dfun_name <- new_dfun_name clas tycon
523 ; return (dfun_name, clas, tycon, tyvars, constraints) }
525 tyvars = tyConTyVars tycon
526 constraints = extra_constraints ++ ordinary_constraints
527 extra_constraints = tyConTheta tycon
528 -- "extra_constraints": see note [Data decl contexts] above
531 = [ mkClassPred clas [arg_ty]
532 | data_con <- tyConDataCons tycon,
533 arg_ty <- dataConOrigArgTys data_con,
534 -- Use the same type variables
535 -- as the type constructor,
536 -- hence no need to instantiate
537 not (isUnLiftedType arg_ty) -- No constraints for unlifted types?
541 ------------------------------------------------------------------
542 -- Check side conditions that dis-allow derivability for particular classes
543 -- This is *apart* from the newtype-deriving mechanism
545 checkSideConditions :: Bool -> Class -> TyCon -> [TcType] -> Maybe SDoc
546 checkSideConditions gla_exts clas tycon tys
548 = Just ty_args_why -- e.g. deriving( Foo s )
550 = case [cond | (key,cond) <- sideConditions, key == getUnique clas] of
551 [] -> Just (non_std_why clas)
552 [cond] -> cond (gla_exts, tycon)
553 other -> pprPanic "checkSideConditions" (ppr clas)
555 ty_args_why = quotes (ppr (mkClassPred clas tys)) <+> ptext SLIT("is not a class")
557 non_std_why clas = quotes (ppr clas) <+> ptext SLIT("is not a derivable class")
559 sideConditions :: [(Unique, Condition)]
561 = [ (eqClassKey, cond_std),
562 (ordClassKey, cond_std),
563 (readClassKey, cond_std),
564 (showClassKey, cond_std),
565 (enumClassKey, cond_std `andCond` cond_isEnumeration),
566 (ixClassKey, cond_std `andCond` (cond_isEnumeration `orCond` cond_isProduct)),
567 (boundedClassKey, cond_std `andCond` (cond_isEnumeration `orCond` cond_isProduct)),
568 (typeableClassKey, cond_glaExts `andCond` cond_allTypeKind),
569 (dataClassKey, cond_glaExts `andCond` cond_std)
572 type Condition = (Bool, TyCon) -> Maybe SDoc -- Nothing => OK
574 orCond :: Condition -> Condition -> Condition
577 Nothing -> Nothing -- c1 succeeds
578 Just x -> case c2 tc of -- c1 fails
580 Just y -> Just (x $$ ptext SLIT(" and") $$ y)
583 andCond c1 c2 tc = case c1 tc of
584 Nothing -> c2 tc -- c1 succeeds
585 Just x -> Just x -- c1 fails
587 cond_std :: Condition
588 cond_std (gla_exts, tycon)
589 | any isExistentialDataCon data_cons = Just existential_why
590 | null data_cons = Just no_cons_why
591 | otherwise = Nothing
593 data_cons = tyConDataCons tycon
594 no_cons_why = quotes (ppr tycon) <+> ptext SLIT("has no data constructors")
595 existential_why = quotes (ppr tycon) <+> ptext SLIT("has existentially-quantified constructor(s)")
597 cond_isEnumeration :: Condition
598 cond_isEnumeration (gla_exts, tycon)
599 | isEnumerationTyCon tycon = Nothing
600 | otherwise = Just why
602 why = quotes (ppr tycon) <+> ptext SLIT("has non-nullary constructors")
604 cond_isProduct :: Condition
605 cond_isProduct (gla_exts, tycon)
606 | isProductTyCon tycon = Nothing
607 | otherwise = Just why
609 why = quotes (ppr tycon) <+> ptext SLIT("has more than one constructor")
611 cond_allTypeKind :: Condition
612 cond_allTypeKind (gla_exts, tycon)
613 | all (isArgTypeKind . tyVarKind) (tyConTyVars tycon) = Nothing
614 | otherwise = Just why
616 why = quotes (ppr tycon) <+> ptext SLIT("is parameterised over arguments of kind other than `*'")
618 cond_glaExts :: Condition
619 cond_glaExts (gla_exts, tycon) | gla_exts = Nothing
620 | otherwise = Just why
622 why = ptext SLIT("You need -fglasgow-exts to derive an instance for this class")
625 %************************************************************************
627 \subsection[TcDeriv-fixpoint]{Finding the fixed point of \tr{deriving} equations}
629 %************************************************************************
631 A ``solution'' (to one of the equations) is a list of (k,TyVarTy tv)
632 terms, which is the final correct RHS for the corresponding original
636 Each (k,TyVarTy tv) in a solution constrains only a type
640 The (k,TyVarTy tv) pairs in a solution are canonically
641 ordered by sorting on type varible, tv, (major key) and then class, k,
646 solveDerivEqns :: [DerivEqn]
647 -> TcM [DFunId] -- Solns in same order as eqns.
648 -- This bunch is Absolutely minimal...
650 solveDerivEqns orig_eqns
651 = iterateDeriv 1 initial_solutions
653 -- The initial solutions for the equations claim that each
654 -- instance has an empty context; this solution is certainly
655 -- in canonical form.
656 initial_solutions :: [DerivSoln]
657 initial_solutions = [ [] | _ <- orig_eqns ]
659 ------------------------------------------------------------------
660 -- iterateDeriv calculates the next batch of solutions,
661 -- compares it with the current one; finishes if they are the
662 -- same, otherwise recurses with the new solutions.
663 -- It fails if any iteration fails
664 iterateDeriv :: Int -> [DerivSoln] ->TcM [DFunId]
665 iterateDeriv n current_solns
666 | n > 20 -- Looks as if we are in an infinite loop
667 -- This can happen if we have -fallow-undecidable-instances
668 -- (See TcSimplify.tcSimplifyDeriv.)
669 = pprPanic "solveDerivEqns: probable loop"
670 (vcat (map pprDerivEqn orig_eqns) $$ ppr current_solns)
673 dfuns = zipWithEqual "add_solns" mk_deriv_dfun orig_eqns current_solns
676 -- Extend the inst info from the explicit instance decls
677 -- with the current set of solutions, and simplify each RHS
678 extendLocalInstEnv dfuns $
679 mappM gen_soln orig_eqns
680 ) `thenM` \ new_solns ->
681 if (current_solns == new_solns) then
684 iterateDeriv (n+1) new_solns
686 ------------------------------------------------------------------
688 gen_soln (_, clas, tc,tyvars,deriv_rhs)
689 = addSrcSpan (srcLocSpan (getSrcLoc tc)) $
690 addErrCtxt (derivCtxt (Just clas) tc) $
691 tcSimplifyDeriv tyvars deriv_rhs `thenM` \ theta ->
692 returnM (sortLt (<) theta) -- Canonicalise before returning the soluction
694 mk_deriv_dfun (dfun_name, clas, tycon, tyvars, _) theta
695 = mkDictFunId dfun_name tyvars theta
696 clas [mkTyConApp tycon (mkTyVarTys tyvars)]
698 extendLocalInstEnv :: [DFunId] -> TcM a -> TcM a
699 -- Add new locall-defined instances; don't bother to check
700 -- for functional dependency errors -- that'll happen in TcInstDcls
701 extendLocalInstEnv dfuns thing_inside
702 = do { env <- getGblEnv
703 ; let inst_env' = foldl extendInstEnv (tcg_inst_env env) dfuns
704 env' = env { tcg_inst_env = inst_env' }
705 ; setGblEnv env' thing_inside }
708 %************************************************************************
710 \subsection[TcDeriv-normal-binds]{Bindings for the various classes}
712 %************************************************************************
714 After all the trouble to figure out the required context for the
715 derived instance declarations, all that's left is to chug along to
716 produce them. They will then be shoved into @tcInstDecls2@, which
717 will do all its usual business.
719 There are lots of possibilities for code to generate. Here are
720 various general remarks.
725 We want derived instances of @Eq@ and @Ord@ (both v common) to be
726 ``you-couldn't-do-better-by-hand'' efficient.
729 Deriving @Show@---also pretty common--- should also be reasonable good code.
732 Deriving for the other classes isn't that common or that big a deal.
739 Deriving @Ord@ is done mostly with the 1.3 @compare@ method.
742 Deriving @Eq@ also uses @compare@, if we're deriving @Ord@, too.
745 We {\em normally} generate code only for the non-defaulted methods;
746 there are some exceptions for @Eq@ and (especially) @Ord@...
749 Sometimes we use a @_con2tag_<tycon>@ function, which returns a data
750 constructor's numeric (@Int#@) tag. These are generated by
751 @gen_tag_n_con_binds@, and the heuristic for deciding if one of
752 these is around is given by @hasCon2TagFun@.
754 The examples under the different sections below will make this
758 Much less often (really just for deriving @Ix@), we use a
759 @_tag2con_<tycon>@ function. See the examples.
762 We use the renamer!!! Reason: we're supposed to be
763 producing @LHsBinds Name@ for the methods, but that means
764 producing correctly-uniquified code on the fly. This is entirely
765 possible (the @TcM@ monad has a @UniqueSupply@), but it is painful.
766 So, instead, we produce @MonoBinds RdrName@ then heave 'em through
767 the renamer. What a great hack!
771 -- Generate the InstInfo for the required instance,
772 -- plus any auxiliary bindings required
773 genInst :: DFunId -> TcM (InstInfo, LHsBinds RdrName)
775 = getFixityEnv `thenM` \ fix_env ->
777 (tyvars,_,clas,[ty]) = tcSplitDFunTy (idType dfun)
778 clas_nm = className clas
779 tycon = tcTyConAppTyCon ty
780 (meth_binds, aux_binds) = genDerivBinds clas fix_env tycon
782 -- Bring the right type variables into
783 -- scope, and rename the method binds
784 bindLocalNames (map varName tyvars) $
785 rnMethodBinds clas_nm [] meth_binds `thenM` \ (rn_meth_binds, _fvs) ->
787 -- Build the InstInfo
788 returnM (InstInfo { iDFunId = dfun, iBinds = VanillaInst rn_meth_binds [] },
791 genDerivBinds clas fix_env tycon
792 | className clas `elem` typeableClassNames
793 = (gen_Typeable_binds tycon, emptyBag)
796 = case assocMaybe gen_list (getUnique clas) of
797 Just gen_fn -> gen_fn fix_env tycon
798 Nothing -> pprPanic "genDerivBinds: bad derived class" (ppr clas)
800 gen_list :: [(Unique, FixityEnv -> TyCon -> (LHsBinds RdrName, LHsBinds RdrName))]
801 gen_list = [(eqClassKey, no_aux_binds (ignore_fix_env gen_Eq_binds))
802 ,(ordClassKey, no_aux_binds (ignore_fix_env gen_Ord_binds))
803 ,(enumClassKey, no_aux_binds (ignore_fix_env gen_Enum_binds))
804 ,(boundedClassKey, no_aux_binds (ignore_fix_env gen_Bounded_binds))
805 ,(ixClassKey, no_aux_binds (ignore_fix_env gen_Ix_binds))
806 ,(typeableClassKey,no_aux_binds (ignore_fix_env gen_Typeable_binds))
807 ,(showClassKey, no_aux_binds gen_Show_binds)
808 ,(readClassKey, no_aux_binds gen_Read_binds)
809 ,(dataClassKey, gen_Data_binds)
812 -- no_aux_binds is used for generators that don't
813 -- need to produce any auxiliary bindings
814 no_aux_binds f fix_env tc = (f fix_env tc, emptyBag)
815 ignore_fix_env f fix_env tc = f tc
819 %************************************************************************
821 \subsection[TcDeriv-taggery-Names]{What con2tag/tag2con functions are available?}
823 %************************************************************************
828 con2tag_Foo :: Foo ... -> Int#
829 tag2con_Foo :: Int -> Foo ... -- easier if Int, not Int#
830 maxtag_Foo :: Int -- ditto (NB: not unlifted)
833 We have a @con2tag@ function for a tycon if:
836 We're deriving @Eq@ and the tycon has nullary data constructors.
839 Or: we're deriving @Ord@ (unless single-constructor), @Enum@, @Ix@
843 We have a @tag2con@ function for a tycon if:
846 We're deriving @Enum@, or @Ix@ (enum type only???)
849 If we have a @tag2con@ function, we also generate a @maxtag@ constant.
852 genTaggeryBinds :: [DFunId] -> TcM (LHsBinds RdrName)
853 genTaggeryBinds dfuns
854 = do { names_so_far <- foldlM do_con2tag [] tycons_of_interest
855 ; nm_alist_etc <- foldlM do_tag2con names_so_far tycons_of_interest
856 ; return (listToBag (map gen_tag_n_con_monobind nm_alist_etc)) }
858 all_CTs = map simpleDFunClassTyCon dfuns
859 all_tycons = map snd all_CTs
860 (tycons_of_interest, _) = removeDups compare all_tycons
862 do_con2tag acc_Names tycon
863 | isDataTyCon tycon &&
864 ((we_are_deriving eqClassKey tycon
865 && any isNullaryDataCon (tyConDataCons tycon))
866 || (we_are_deriving ordClassKey tycon
867 && not (isProductTyCon tycon))
868 || (we_are_deriving enumClassKey tycon)
869 || (we_are_deriving ixClassKey tycon))
871 = returnM ((con2tag_RDR tycon, tycon, GenCon2Tag)
876 do_tag2con acc_Names tycon
877 | isDataTyCon tycon &&
878 (we_are_deriving enumClassKey tycon ||
879 we_are_deriving ixClassKey tycon
880 && isEnumerationTyCon tycon)
881 = returnM ( (tag2con_RDR tycon, tycon, GenTag2Con)
882 : (maxtag_RDR tycon, tycon, GenMaxTag)
887 we_are_deriving clas_key tycon
888 = is_in_eqns clas_key tycon all_CTs
890 is_in_eqns clas_key tycon [] = False
891 is_in_eqns clas_key tycon ((c,t):cts)
892 = (clas_key == classKey c && tycon == t)
893 || is_in_eqns clas_key tycon cts
897 derivingThingErr clas tys tycon tyvars why
898 = sep [hsep [ptext SLIT("Can't make a derived instance of"), quotes (ppr pred)],
901 pred = mkClassPred clas (tys ++ [mkTyConApp tycon (mkTyVarTys tyvars)])
903 malformedPredErr tycon pred = ptext SLIT("Illegal deriving item") <+> ppr pred
905 derivCtxt :: Maybe Class -> TyCon -> SDoc
906 derivCtxt maybe_cls tycon
907 = ptext SLIT("When deriving") <+> cls <+> ptext SLIT("for type") <+> quotes (ppr tycon)
909 cls = case maybe_cls of
910 Nothing -> ptext SLIT("instances")
911 Just c -> ptext SLIT("the") <+> quotes (ppr c) <+> ptext SLIT("instance")