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"
13 import HsSyn ( HsBinds(..), MonoBinds(..), collectMonoBinders )
14 import RdrHsSyn ( RdrNameMonoBinds )
15 import RnHsSyn ( RenamedHsBinds )
16 import CmdLineOpts ( opt_D_dump_deriv )
19 import TcEnv ( InstEnv, getEnvTyCons, tcSetInstEnv, newDFunName )
20 import TcGenDeriv -- Deriv stuff
21 import TcInstUtil ( InstInfo(..), buildInstanceEnv )
22 import TcSimplify ( tcSimplifyThetas )
24 import RnBinds ( rnMethodBinds, rnTopMonoBinds )
25 import RnEnv ( bindLocatedLocalsRn )
26 import RnMonad ( RnNameSupply,
27 renameSourceCode, thenRn, mapRn, returnRn )
29 import Bag ( Bag, emptyBag, unionBags, listToBag )
30 import Class ( classKey, Class )
31 import ErrUtils ( dumpIfSet, Message )
32 import MkId ( mkDictFunId )
33 import Id ( mkVanillaId )
34 import DataCon ( dataConArgTys, isNullaryDataCon, isExistentialDataCon )
35 import PrelInfo ( needsDataDeclCtxtClassKeys )
36 import Maybes ( maybeToBool, catMaybes )
37 import Module ( Module )
38 import Name ( isLocallyDefined, getSrcLoc, NamedThing(..) )
39 import RdrName ( RdrName )
40 import RnMonad ( FixityEnv )
42 import TyCon ( tyConTyVars, tyConDataCons, tyConDerivings,
43 tyConTheta, maybeTyConSingleCon, isDataTyCon,
44 isEnumerationTyCon, isAlgTyCon, TyCon
46 import Type ( TauType, mkTyVarTys, mkTyConApp,
47 mkSigmaTy, mkDictTy, isUnboxedType,
48 splitAlgTyConApp, classesToPreds
50 import TysWiredIn ( voidTy )
52 import Unique -- Keys stuff
53 import Bag ( bagToList )
54 import Util ( zipWithEqual, sortLt, removeDups, assoc, thenCmp )
58 %************************************************************************
60 \subsection[TcDeriv-intro]{Introduction to how we do deriving}
62 %************************************************************************
66 data T a b = C1 (Foo a) (Bar b)
71 [NOTE: See end of these comments for what to do with
72 data (C a, D b) => T a b = ...
75 We want to come up with an instance declaration of the form
77 instance (Ping a, Pong b, ...) => Eq (T a b) where
80 It is pretty easy, albeit tedious, to fill in the code "...". The
81 trick is to figure out what the context for the instance decl is,
82 namely @Ping@, @Pong@ and friends.
84 Let's call the context reqd for the T instance of class C at types
85 (a,b, ...) C (T a b). Thus:
87 Eq (T a b) = (Ping a, Pong b, ...)
89 Now we can get a (recursive) equation from the @data@ decl:
91 Eq (T a b) = Eq (Foo a) u Eq (Bar b) -- From C1
92 u Eq (T b a) u Eq Int -- From C2
93 u Eq (T a a) -- From C3
95 Foo and Bar may have explicit instances for @Eq@, in which case we can
96 just substitute for them. Alternatively, either or both may have
97 their @Eq@ instances given by @deriving@ clauses, in which case they
98 form part of the system of equations.
100 Now all we need do is simplify and solve the equations, iterating to
101 find the least fixpoint. Notice that the order of the arguments can
102 switch around, as here in the recursive calls to T.
104 Let's suppose Eq (Foo a) = Eq a, and Eq (Bar b) = Ping b.
108 Eq (T a b) = {} -- The empty set
111 Eq (T a b) = Eq (Foo a) u Eq (Bar b) -- From C1
112 u Eq (T b a) u Eq Int -- From C2
113 u Eq (T a a) -- From C3
115 After simplification:
116 = Eq a u Ping b u {} u {} u {}
121 Eq (T a b) = Eq (Foo a) u Eq (Bar b) -- From C1
122 u Eq (T b a) u Eq Int -- From C2
123 u Eq (T a a) -- From C3
125 After simplification:
130 = Eq a u Ping b u Eq b u Ping a
132 The next iteration gives the same result, so this is the fixpoint. We
133 need to make a canonical form of the RHS to ensure convergence. We do
134 this by simplifying the RHS to a form in which
136 - the classes constrain only tyvars
137 - the list is sorted by tyvar (major key) and then class (minor key)
138 - no duplicates, of course
140 So, here are the synonyms for the ``equation'' structures:
143 type DerivEqn = (Class, TyCon, [TyVar], DerivRhs)
144 -- The tyvars bind all the variables in the RHS
145 -- NEW: it's convenient to re-use InstInfo
146 -- We'll "panic" out some fields...
148 type DerivRhs = [(Class, [TauType])] -- Same as a ThetaType!
150 type DerivSoln = DerivRhs
154 A note about contexts on data decls
155 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
158 data (RealFloat a) => Complex a = !a :+ !a deriving( Read )
160 We will need an instance decl like:
162 instance (Read a, RealFloat a) => Read (Complex a) where
165 The RealFloat in the context is because the read method for Complex is bound
166 to construct a Complex, and doing that requires that the argument type is
169 But this ain't true for Show, Eq, Ord, etc, since they don't construct
170 a Complex; they only take them apart.
172 Our approach: identify the offending classes, and add the data type
173 context to the instance decl. The "offending classes" are
178 %************************************************************************
180 \subsection[TcDeriv-driver]{Top-level function for \tr{derivings}}
182 %************************************************************************
185 tcDeriving :: Module -- name of module under scrutiny
186 -> FixityEnv -- for the deriving code (Show/Read.)
187 -> RnNameSupply -- for "renaming" bits of generated code
188 -> Bag InstInfo -- What we already know about instances
189 -> TcM s (Bag InstInfo, -- The generated "instance decls".
190 RenamedHsBinds) -- Extra generated bindings
192 tcDeriving mod fixs rn_name_supply inst_decl_infos_in
193 = recoverTc (returnTc (emptyBag, EmptyBinds)) $
195 -- Fish the "deriving"-related information out of the TcEnv
196 -- and make the necessary "equations".
197 makeDerivEqns `thenTc` \ eqns ->
199 returnTc (emptyBag, EmptyBinds)
202 -- Take the equation list and solve it, to deliver a list of
203 -- solutions, a.k.a. the contexts for the instance decls
204 -- required for the corresponding equations.
205 solveDerivEqns inst_decl_infos_in eqns `thenTc` \ new_inst_infos ->
207 -- Now augment the InstInfos, adding in the rather boring
208 -- actual-code-to-do-the-methods binds. We may also need to
209 -- generate extra not-one-inst-decl-specific binds, notably
210 -- "con2tag" and/or "tag2con" functions. We do these
213 gen_taggery_Names new_inst_infos `thenTc` \ nm_alist_etc ->
217 extra_mbind_list = map gen_tag_n_con_monobind nm_alist_etc
218 extra_mbinds = foldr AndMonoBinds EmptyMonoBinds extra_mbind_list
219 method_binds_s = map (gen_bind fixs) new_inst_infos
220 mbinders = bagToList (collectMonoBinders extra_mbinds)
222 -- Rename to get RenamedBinds.
223 -- The only tricky bit is that the extra_binds must scope over the
224 -- method bindings for the instances.
225 (rn_method_binds_s, rn_extra_binds)
226 = renameSourceCode mod rn_name_supply (
227 bindLocatedLocalsRn (ptext (SLIT("deriving"))) mbinders $ \ _ ->
228 rnTopMonoBinds extra_mbinds [] `thenRn` \ (rn_extra_binds, _) ->
229 mapRn rn_meths method_binds_s `thenRn` \ rn_method_binds_s ->
230 returnRn (rn_method_binds_s, rn_extra_binds)
233 mapNF_Tc gen_inst_info (new_inst_infos `zip` rn_method_binds_s) `thenNF_Tc` \ really_new_inst_infos ->
235 ioToTc (dumpIfSet opt_D_dump_deriv "Derived instances"
236 (ddump_deriving really_new_inst_infos rn_extra_binds)) `thenTc_`
238 returnTc (listToBag really_new_inst_infos, rn_extra_binds)
240 ddump_deriving :: [InstInfo] -> RenamedHsBinds -> SDoc
241 ddump_deriving inst_infos extra_binds
242 = vcat (map pp_info inst_infos) $$ ppr extra_binds
244 pp_info (InstInfo clas tvs [ty] inst_decl_theta _ mbinds _ _)
245 = ppr (mkSigmaTy tvs inst_decl_theta' (mkDictTy clas [ty]))
248 where inst_decl_theta' = classesToPreds inst_decl_theta
250 -- Paste the dfun id and method binds into the InstInfo
251 gen_inst_info (InstInfo clas tyvars tys@(ty:_) inst_decl_theta _ _ locn _, meth_binds)
252 = newDFunName mod clas tys locn `thenNF_Tc` \ dfun_name ->
254 dfun_id = mkDictFunId dfun_name clas tyvars tys inst_decl_theta
256 returnNF_Tc (InstInfo clas tyvars tys inst_decl_theta
257 dfun_id meth_binds locn [])
259 rn_meths meths = rnMethodBinds meths `thenRn` \ (meths', _) -> returnRn meths'
260 -- Ignore the free vars returned
264 %************************************************************************
266 \subsection[TcDeriv-eqns]{Forming the equations}
268 %************************************************************************
270 @makeDerivEqns@ fishes around to find the info about needed derived
271 instances. Complicating factors:
274 We can only derive @Enum@ if the data type is an enumeration
275 type (all nullary data constructors).
278 We can only derive @Ix@ if the data type is an enumeration {\em
279 or} has just one data constructor (e.g., tuples).
282 [See Appendix~E in the Haskell~1.2 report.] This code here deals w/
286 makeDerivEqns :: TcM s [DerivEqn]
289 = tcGetEnv `thenNF_Tc` \ env ->
291 local_data_tycons = filter (\tc -> isLocallyDefined tc && isAlgTyCon tc)
294 think_about_deriving = need_deriving local_data_tycons
295 (derive_these, _) = removeDups cmp_deriv think_about_deriving
297 if null local_data_tycons then
298 returnTc [] -- Bale out now
300 mapTc mk_eqn derive_these `thenTc` \ maybe_eqns ->
301 returnTc (catMaybes maybe_eqns)
303 ------------------------------------------------------------------
304 need_deriving :: [TyCon] -> [(Class, TyCon)]
305 -- find the tycons that have `deriving' clauses;
307 need_deriving tycons_to_consider
308 = foldr (\ tycon acc -> [(clas,tycon) | clas <- tyConDerivings tycon] ++ acc)
312 ------------------------------------------------------------------
313 cmp_deriv :: (Class, TyCon) -> (Class, TyCon) -> Ordering
314 cmp_deriv (c1, t1) (c2, t2)
315 = (c1 `compare` c2) `thenCmp` (t1 `compare` t2)
317 ------------------------------------------------------------------
318 mk_eqn :: (Class, TyCon) -> NF_TcM s (Maybe DerivEqn)
319 -- we swizzle the tyvars and datacons out of the tycon
320 -- to make the rest of the equation
323 = case chk_out clas tycon of
324 Just err -> addErrTc err `thenNF_Tc_`
326 Nothing -> returnNF_Tc (Just (clas, tycon, tyvars, constraints))
328 clas_key = classKey clas
329 tyvars = tyConTyVars tycon -- ToDo: Do we need new tyvars ???
330 tyvar_tys = mkTyVarTys tyvars
331 data_cons = tyConDataCons tycon
333 constraints = extra_constraints ++ concat (map mk_constraints data_cons)
335 -- "extra_constraints": see notes above about contexts on data decls
337 | offensive_class = tyConTheta tycon
340 offensive_class = clas_key `elem` needsDataDeclCtxtClassKeys
342 mk_constraints data_con
344 | arg_ty <- instd_arg_tys,
345 not (isUnboxedType arg_ty) -- No constraints for unboxed types?
348 instd_arg_tys = dataConArgTys data_con tyvar_tys
350 ------------------------------------------------------------------
351 chk_out :: Class -> TyCon -> Maybe Message
353 | clas `hasKey` enumClassKey && not is_enumeration = bog_out nullary_why
354 | clas `hasKey` boundedClassKey && not is_enumeration_or_single = bog_out single_nullary_why
355 | clas `hasKey` ixClassKey && not is_enumeration_or_single = bog_out single_nullary_why
356 | any isExistentialDataCon (tyConDataCons tycon) = Just (existentialErr clas tycon)
357 | otherwise = Nothing
359 is_enumeration = isEnumerationTyCon tycon
360 is_single_con = maybeToBool (maybeTyConSingleCon tycon)
361 is_enumeration_or_single = is_enumeration || is_single_con
363 single_nullary_why = SLIT("one constructor data type or type with all nullary constructors expected")
364 nullary_why = SLIT("data type with all nullary constructors expected")
366 bog_out why = Just (derivingThingErr clas tycon why)
369 %************************************************************************
371 \subsection[TcDeriv-fixpoint]{Finding the fixed point of \tr{deriving} equations}
373 %************************************************************************
375 A ``solution'' (to one of the equations) is a list of (k,TyVarTy tv)
376 terms, which is the final correct RHS for the corresponding original
380 Each (k,TyVarTy tv) in a solution constrains only a type
384 The (k,TyVarTy tv) pairs in a solution are canonically
385 ordered by sorting on type varible, tv, (major key) and then class, k,
390 solveDerivEqns :: Bag InstInfo
392 -> TcM s [InstInfo] -- Solns in same order as eqns.
393 -- This bunch is Absolutely minimal...
395 solveDerivEqns inst_decl_infos_in orig_eqns
396 = iterateDeriv initial_solutions
398 -- The initial solutions for the equations claim that each
399 -- instance has an empty context; this solution is certainly
400 -- in canonical form.
401 initial_solutions :: [DerivSoln]
402 initial_solutions = [ [] | _ <- orig_eqns ]
404 ------------------------------------------------------------------
405 -- iterateDeriv calculates the next batch of solutions,
406 -- compares it with the current one; finishes if they are the
407 -- same, otherwise recurses with the new solutions.
408 -- It fails if any iteration fails
409 iterateDeriv :: [DerivSoln] ->TcM s [InstInfo]
410 iterateDeriv current_solns
411 = checkNoErrsTc (iterateOnce current_solns) `thenTc` \ (new_inst_infos, new_solns) ->
412 if (current_solns == new_solns) then
413 returnTc new_inst_infos
415 iterateDeriv new_solns
417 ------------------------------------------------------------------
418 iterateOnce current_solns
419 = -- Extend the inst info from the explicit instance decls
420 -- with the current set of solutions, giving a
422 add_solns inst_decl_infos_in orig_eqns current_solns
423 `thenNF_Tc` \ (new_inst_infos, inst_env) ->
427 tcSetInstEnv inst_env (
428 listTc [ tcAddErrCtxt (derivCtxt tc) $
429 tcSimplifyThetas deriv_rhs
430 | (_,tc,_,deriv_rhs) <- orig_eqns ]
431 ) `thenTc` \ next_solns ->
433 -- Canonicalise the solutions, so they compare nicely
434 let canonicalised_next_solns
435 = [ sortLt (<) next_soln | next_soln <- next_solns ]
437 returnTc (new_inst_infos, canonicalised_next_solns)
441 add_solns :: Bag InstInfo -- The global, non-derived ones
442 -> [DerivEqn] -> [DerivSoln]
443 -> NF_TcM s ([InstInfo], -- The new, derived ones
445 -- the eqns and solns move "in lockstep"; we have the eqns
446 -- because we need the LHS info for addClassInstance.
448 add_solns inst_infos_in eqns solns
450 = discardErrsTc (buildInstanceEnv all_inst_infos) `thenNF_Tc` \ inst_env ->
451 -- We do the discard-errs so that we don't get repeated error messages
452 -- about duplicate instances.
453 -- They'll appear later, when we do the top-level buildInstanceEnv.
455 returnNF_Tc (new_inst_infos, inst_env)
457 new_inst_infos = zipWithEqual "add_solns" mk_deriv_inst_info eqns solns
459 all_inst_infos = inst_infos_in `unionBags` listToBag new_inst_infos
461 mk_deriv_inst_info (clas, tycon, tyvars, _) theta
462 = InstInfo clas tyvars [mkTyConApp tycon (mkTyVarTys tyvars)]
465 (my_panic "binds") (getSrcLoc tycon)
466 (my_panic "upragmas")
469 = mkVanillaId (getName tycon) dummy_dfun_ty
470 -- The name is getSrcLoc'd in an error message
472 theta' = classesToPreds theta
473 dummy_dfun_ty = mkSigmaTy tyvars theta' voidTy
474 -- All we need from the dfun is its "theta" part, used during
475 -- equation simplification (tcSimplifyThetas). The final
476 -- dfun_id will have the superclass dictionaries as arguments too,
477 -- but that'll be added after the equations are solved. For now,
478 -- it's enough just to make a dummy dfun with the simple theta part.
480 -- The part after the theta is dummied here as voidTy; actually it's
481 -- (C (T a b)), but it doesn't seem worth constructing it.
482 -- We can't leave it as a panic because to get the theta part we
483 -- have to run down the type!
485 my_panic str = panic "add_soln" -- pprPanic ("add_soln:"++str) (hsep [char ':', ppr clas, ppr tycon])
488 %************************************************************************
490 \subsection[TcDeriv-normal-binds]{Bindings for the various classes}
492 %************************************************************************
494 After all the trouble to figure out the required context for the
495 derived instance declarations, all that's left is to chug along to
496 produce them. They will then be shoved into @tcInstDecls2@, which
497 will do all its usual business.
499 There are lots of possibilities for code to generate. Here are
500 various general remarks.
505 We want derived instances of @Eq@ and @Ord@ (both v common) to be
506 ``you-couldn't-do-better-by-hand'' efficient.
509 Deriving @Show@---also pretty common--- should also be reasonable good code.
512 Deriving for the other classes isn't that common or that big a deal.
519 Deriving @Ord@ is done mostly with the 1.3 @compare@ method.
522 Deriving @Eq@ also uses @compare@, if we're deriving @Ord@, too.
525 We {\em normally} generate code only for the non-defaulted methods;
526 there are some exceptions for @Eq@ and (especially) @Ord@...
529 Sometimes we use a @_con2tag_<tycon>@ function, which returns a data
530 constructor's numeric (@Int#@) tag. These are generated by
531 @gen_tag_n_con_binds@, and the heuristic for deciding if one of
532 these is around is given by @hasCon2TagFun@.
534 The examples under the different sections below will make this
538 Much less often (really just for deriving @Ix@), we use a
539 @_tag2con_<tycon>@ function. See the examples.
542 We use the renamer!!! Reason: we're supposed to be
543 producing @RenamedMonoBinds@ for the methods, but that means
544 producing correctly-uniquified code on the fly. This is entirely
545 possible (the @TcM@ monad has a @UniqueSupply@), but it is painful.
546 So, instead, we produce @RdrNameMonoBinds@ then heave 'em through
547 the renamer. What a great hack!
551 -- Generate the method bindings for the required instance
552 -- (paired with class name, as we need that when generating dict
554 gen_bind :: FixityEnv -> InstInfo -> RdrNameMonoBinds
555 gen_bind fixities (InstInfo clas _ [ty] _ _ _ _ _)
556 | not from_here = EmptyMonoBinds
557 | clas `hasKey` showClassKey = gen_Show_binds fixities tycon
558 | clas `hasKey` readClassKey = gen_Read_binds fixities tycon
560 = assoc "gen_bind:bad derived class"
561 [(eqClassKey, gen_Eq_binds)
562 ,(ordClassKey, gen_Ord_binds)
563 ,(enumClassKey, gen_Enum_binds)
564 ,(boundedClassKey, gen_Bounded_binds)
565 ,(ixClassKey, gen_Ix_binds)
570 from_here = isLocallyDefined tycon
571 (tycon,_,_) = splitAlgTyConApp ty
575 %************************************************************************
577 \subsection[TcDeriv-taggery-Names]{What con2tag/tag2con functions are available?}
579 %************************************************************************
584 con2tag_Foo :: Foo ... -> Int#
585 tag2con_Foo :: Int -> Foo ... -- easier if Int, not Int#
586 maxtag_Foo :: Int -- ditto (NB: not unboxed)
589 We have a @con2tag@ function for a tycon if:
592 We're deriving @Eq@ and the tycon has nullary data constructors.
595 Or: we're deriving @Ord@ (unless single-constructor), @Enum@, @Ix@
599 We have a @tag2con@ function for a tycon if:
602 We're deriving @Enum@, or @Ix@ (enum type only???)
605 If we have a @tag2con@ function, we also generate a @maxtag@ constant.
608 gen_taggery_Names :: [InstInfo]
609 -> TcM s [(RdrName, -- for an assoc list
610 TyCon, -- related tycon
613 gen_taggery_Names inst_infos
614 = --pprTrace "gen_taggery:\n" (vcat [hsep [ppr c, ppr t] | (c,t) <- all_CTs]) $
615 foldlTc do_con2tag [] tycons_of_interest `thenTc` \ names_so_far ->
616 foldlTc do_tag2con names_so_far tycons_of_interest
618 all_CTs = [ (c, get_tycon ty) | (InstInfo c _ [ty] _ _ _ _ _) <- inst_infos ]
620 get_tycon ty = case splitAlgTyConApp ty of { (tc, _, _) -> tc }
622 all_tycons = map snd all_CTs
623 (tycons_of_interest, _) = removeDups compare all_tycons
625 do_con2tag acc_Names tycon
626 | isDataTyCon tycon &&
627 ((we_are_deriving eqClassKey tycon
628 && any isNullaryDataCon (tyConDataCons tycon))
629 || (we_are_deriving ordClassKey tycon
630 && not (maybeToBool (maybeTyConSingleCon tycon)))
631 || (we_are_deriving enumClassKey tycon)
632 || (we_are_deriving ixClassKey tycon))
634 = returnTc ((con2tag_RDR tycon, tycon, GenCon2Tag)
639 do_tag2con acc_Names tycon
640 | isDataTyCon tycon &&
641 (we_are_deriving enumClassKey tycon ||
642 we_are_deriving ixClassKey tycon
643 && isEnumerationTyCon tycon)
644 = returnTc ( (tag2con_RDR tycon, tycon, GenTag2Con)
645 : (maxtag_RDR tycon, tycon, GenMaxTag)
650 we_are_deriving clas_key tycon
651 = is_in_eqns clas_key tycon all_CTs
653 is_in_eqns clas_key tycon [] = False
654 is_in_eqns clas_key tycon ((c,t):cts)
655 = (clas_key == classKey c && tycon == t)
656 || is_in_eqns clas_key tycon cts
661 derivingThingErr :: Class -> TyCon -> FAST_STRING -> Message
663 derivingThingErr clas tycon why
664 = sep [hsep [ptext SLIT("Can't make a derived instance of"), quotes (ppr clas)],
665 hsep [ptext SLIT("for the type"), quotes (ppr tycon)],
668 existentialErr clas tycon
669 = sep [ptext SLIT("Can't derive any instances for type") <+> quotes (ppr tycon),
670 ptext SLIT("because it has existentially-quantified constructor(s)")]
673 = ptext SLIT("When deriving classes for") <+> quotes (ppr tycon)