8ffabd0bf9b6936701aa6c750b91762d3df2031b
[ghc-hetmet.git] / ghc / compiler / typecheck / TcDeriv.lhs
1 %
2 % (c) The GRASP/AQUA Project, Glasgow University, 1992-1998
3 %
4 \section[TcDeriv]{Deriving}
5
6 Handles @deriving@ clauses on @data@ declarations.
7
8 \begin{code}
9 module TcDeriv ( tcDeriving ) where
10
11 #include "HsVersions.h"
12
13 import HsSyn            ( HsBinds(..), MonoBinds(..), collectMonoBinders )
14 import RdrHsSyn         ( RdrNameMonoBinds )
15 import RnHsSyn          ( RenamedHsBinds )
16 import CmdLineOpts      ( opt_D_dump_deriv )
17
18 import TcMonad
19 import TcEnv            ( InstEnv, getEnvTyCons, tcSetInstEnv, newDFunName )
20 import TcGenDeriv       -- Deriv stuff
21 import TcInstUtil       ( InstInfo(..), buildInstanceEnv )
22 import TcSimplify       ( tcSimplifyThetas )
23
24 import RnBinds          ( rnMethodBinds, rnTopMonoBinds )
25 import RnEnv            ( bindLocatedLocalsRn )
26 import RnMonad          ( RnNameSupply, 
27                           renameSourceCode, thenRn, mapRn, returnRn )
28
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 )
41
42 import TyCon            ( tyConTyVars, tyConDataCons, tyConDerivings,
43                           tyConTheta, maybeTyConSingleCon, isDataTyCon,
44                           isEnumerationTyCon, isAlgTyCon, TyCon
45                         )
46 import Type             ( TauType, mkTyVarTys, mkTyConApp,
47                           mkSigmaTy, mkDictTy, isUnboxedType,
48                           splitAlgTyConApp, classesToPreds
49                         )
50 import TysWiredIn       ( voidTy )
51 import Var              ( TyVar )
52 import Unique           -- Keys stuff
53 import Bag              ( bagToList )
54 import Util             ( zipWithEqual, sortLt, removeDups,  assoc, thenCmp )
55 import Outputable
56 \end{code}
57
58 %************************************************************************
59 %*                                                                      *
60 \subsection[TcDeriv-intro]{Introduction to how we do deriving}
61 %*                                                                      *
62 %************************************************************************
63
64 Consider
65
66         data T a b = C1 (Foo a) (Bar b)
67                    | C2 Int (T b a)
68                    | C3 (T a a)
69                    deriving (Eq)
70
71 [NOTE: See end of these comments for what to do with 
72         data (C a, D b) => T a b = ...
73 ]
74
75 We want to come up with an instance declaration of the form
76
77         instance (Ping a, Pong b, ...) => Eq (T a b) where
78                 x == y = ...
79
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.
83
84 Let's call the context reqd for the T instance of class C at types
85 (a,b, ...)  C (T a b).  Thus:
86
87         Eq (T a b) = (Ping a, Pong b, ...)
88
89 Now we can get a (recursive) equation from the @data@ decl:
90
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
94
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.
99
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.
103
104 Let's suppose Eq (Foo a) = Eq a, and Eq (Bar b) = Ping b.
105
106 We start with:
107
108         Eq (T a b) = {}         -- The empty set
109
110 Next iteration:
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
114
115         After simplification:
116                    = Eq a u Ping b u {} u {} u {}
117                    = Eq a u Ping b
118
119 Next iteration:
120
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
124
125         After simplification:
126                    = Eq a u Ping b
127                    u (Eq b u Ping a)
128                    u (Eq a u Ping a)
129
130                    = Eq a u Ping b u Eq b u Ping a
131
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
135
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
139
140 So, here are the synonyms for the ``equation'' structures:
141
142 \begin{code}
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...
147
148 type DerivRhs = [(Class, [TauType])]    -- Same as a ThetaType!
149
150 type DerivSoln = DerivRhs
151 \end{code}
152
153
154 A note about contexts on data decls
155 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
156 Consider
157
158         data (RealFloat a) => Complex a = !a :+ !a deriving( Read )
159
160 We will need an instance decl like:
161
162         instance (Read a, RealFloat a) => Read (Complex a) where
163           ...
164
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
167 in RealFloat. 
168
169 But this ain't true for Show, Eq, Ord, etc, since they don't construct
170 a Complex; they only take them apart.
171
172 Our approach: identify the offending classes, and add the data type
173 context to the instance decl.  The "offending classes" are
174
175         Read, Enum?
176
177
178 %************************************************************************
179 %*                                                                      *
180 \subsection[TcDeriv-driver]{Top-level function for \tr{derivings}}
181 %*                                                                      *
182 %************************************************************************
183
184 \begin{code}
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
191
192 tcDeriving mod fixs rn_name_supply inst_decl_infos_in
193   = recoverTc (returnTc (emptyBag, EmptyBinds)) $
194
195         -- Fish the "deriving"-related information out of the TcEnv
196         -- and make the necessary "equations".
197     makeDerivEqns                               `thenTc` \ eqns ->
198     if null eqns then
199         returnTc (emptyBag, EmptyBinds)
200     else
201
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 ->
206
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
211         -- separately.
212
213     gen_taggery_Names new_inst_infos            `thenTc` \ nm_alist_etc ->
214
215
216     let
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)
221         
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)
231                   )
232     in
233     mapNF_Tc gen_inst_info (new_inst_infos `zip` rn_method_binds_s)     `thenNF_Tc` \ really_new_inst_infos ->
234
235     ioToTc (dumpIfSet opt_D_dump_deriv "Derived instances" 
236                       (ddump_deriving really_new_inst_infos rn_extra_binds))    `thenTc_`
237
238     returnTc (listToBag really_new_inst_infos, rn_extra_binds)
239   where
240     ddump_deriving :: [InstInfo] -> RenamedHsBinds -> SDoc
241     ddump_deriving inst_infos extra_binds
242       = vcat (map pp_info inst_infos) $$ ppr extra_binds
243       where
244         pp_info (InstInfo clas tvs [ty] inst_decl_theta _ mbinds _ _)
245           = ppr (mkSigmaTy tvs inst_decl_theta' (mkDictTy clas [ty]))
246             $$
247             ppr mbinds
248             where inst_decl_theta' = classesToPreds inst_decl_theta
249
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 ->
253         let
254             dfun_id = mkDictFunId dfun_name clas tyvars tys inst_decl_theta
255         in
256         returnNF_Tc (InstInfo clas tyvars tys inst_decl_theta
257                               dfun_id meth_binds locn [])
258
259     rn_meths meths = rnMethodBinds meths `thenRn` \ (meths', _) -> returnRn meths'
260         -- Ignore the free vars returned
261 \end{code}
262
263
264 %************************************************************************
265 %*                                                                      *
266 \subsection[TcDeriv-eqns]{Forming the equations}
267 %*                                                                      *
268 %************************************************************************
269
270 @makeDerivEqns@ fishes around to find the info about needed derived
271 instances.  Complicating factors:
272 \begin{itemize}
273 \item
274 We can only derive @Enum@ if the data type is an enumeration
275 type (all nullary data constructors).
276
277 \item
278 We can only derive @Ix@ if the data type is an enumeration {\em
279 or} has just one data constructor (e.g., tuples).
280 \end{itemize}
281
282 [See Appendix~E in the Haskell~1.2 report.] This code here deals w/
283 all those.
284
285 \begin{code}
286 makeDerivEqns :: TcM s [DerivEqn]
287
288 makeDerivEqns
289   = tcGetEnv                        `thenNF_Tc` \ env ->
290     let
291         local_data_tycons = filter (\tc -> isLocallyDefined tc && isAlgTyCon tc)
292                                    (getEnvTyCons env)
293
294         think_about_deriving = need_deriving local_data_tycons
295         (derive_these, _)    = removeDups cmp_deriv think_about_deriving
296     in
297     if null local_data_tycons then
298         returnTc []     -- Bale out now
299     else
300     mapTc mk_eqn derive_these `thenTc`  \ maybe_eqns ->
301     returnTc (catMaybes maybe_eqns)
302   where
303     ------------------------------------------------------------------
304     need_deriving :: [TyCon] -> [(Class, TyCon)]
305         -- find the tycons that have `deriving' clauses;
306
307     need_deriving tycons_to_consider
308       = foldr (\ tycon acc -> [(clas,tycon) | clas <- tyConDerivings tycon] ++ acc)
309               []
310               tycons_to_consider
311
312     ------------------------------------------------------------------
313     cmp_deriv :: (Class, TyCon) -> (Class, TyCon) -> Ordering
314     cmp_deriv (c1, t1) (c2, t2)
315       = (c1 `compare` c2) `thenCmp` (t1 `compare` t2)
316
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
321
322     mk_eqn (clas, tycon)
323       = case chk_out clas tycon of
324            Just err ->  addErrTc err    `thenNF_Tc_` 
325                         returnNF_Tc Nothing
326            Nothing  ->  returnNF_Tc (Just (clas, tycon, tyvars, constraints))
327       where
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
332
333         constraints = extra_constraints ++ concat (map mk_constraints data_cons)
334
335         -- "extra_constraints": see notes above about contexts on data decls
336         extra_constraints
337           | offensive_class = tyConTheta tycon
338           | otherwise       = []
339            where
340             offensive_class = clas_key `elem` needsDataDeclCtxtClassKeys
341
342         mk_constraints data_con
343            = [ (clas, [arg_ty])
344              | arg_ty <- instd_arg_tys,
345                not (isUnboxedType arg_ty)       -- No constraints for unboxed types?
346              ]
347            where
348              instd_arg_tys  = dataConArgTys data_con tyvar_tys
349
350     ------------------------------------------------------------------
351     chk_out :: Class -> TyCon -> Maybe Message
352     chk_out clas tycon
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
358         where
359             is_enumeration = isEnumerationTyCon tycon
360             is_single_con  = maybeToBool (maybeTyConSingleCon tycon)
361             is_enumeration_or_single = is_enumeration || is_single_con
362
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")
365
366             bog_out why = Just (derivingThingErr clas tycon why)
367 \end{code}
368
369 %************************************************************************
370 %*                                                                      *
371 \subsection[TcDeriv-fixpoint]{Finding the fixed point of \tr{deriving} equations}
372 %*                                                                      *
373 %************************************************************************
374
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
377 equation.
378 \begin{itemize}
379 \item
380 Each (k,TyVarTy tv) in a solution constrains only a type
381 variable, tv.
382
383 \item
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,
386 (minor key)
387 \end{itemize}
388
389 \begin{code}
390 solveDerivEqns :: Bag InstInfo
391                -> [DerivEqn]
392                -> TcM s [InstInfo]      -- Solns in same order as eqns.
393                                         -- This bunch is Absolutely minimal...
394
395 solveDerivEqns inst_decl_infos_in orig_eqns
396   = iterateDeriv initial_solutions
397   where
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 ]
403
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
414         else
415             iterateDeriv new_solns
416
417     ------------------------------------------------------------------
418     iterateOnce current_solns
419       =     -- Extend the inst info from the explicit instance decls
420             -- with the current set of solutions, giving a
421
422         add_solns inst_decl_infos_in orig_eqns current_solns
423                                 `thenNF_Tc` \ (new_inst_infos, inst_env) ->
424
425             -- Simplify each RHS
426
427         tcSetInstEnv inst_env (
428           listTc [ tcAddErrCtxt (derivCtxt tc) $
429                    tcSimplifyThetas deriv_rhs
430                  | (_,tc,_,deriv_rhs) <- orig_eqns ]  
431         )                                               `thenTc` \ next_solns ->
432
433             -- Canonicalise the solutions, so they compare nicely
434         let canonicalised_next_solns
435               = [ sortLt (<) next_soln | next_soln <- next_solns ]
436         in
437         returnTc (new_inst_infos, canonicalised_next_solns)
438 \end{code}
439
440 \begin{code}
441 add_solns :: Bag InstInfo                       -- The global, non-derived ones
442           -> [DerivEqn] -> [DerivSoln]
443           -> NF_TcM s ([InstInfo],              -- The new, derived ones
444                        InstEnv)
445     -- the eqns and solns move "in lockstep"; we have the eqns
446     -- because we need the LHS info for addClassInstance.
447
448 add_solns inst_infos_in eqns solns
449
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.
454
455     returnNF_Tc (new_inst_infos, inst_env)
456   where
457     new_inst_infos = zipWithEqual "add_solns" mk_deriv_inst_info eqns solns
458
459     all_inst_infos = inst_infos_in `unionBags` listToBag new_inst_infos
460
461     mk_deriv_inst_info (clas, tycon, tyvars, _) theta
462       = InstInfo clas tyvars [mkTyConApp tycon (mkTyVarTys tyvars)]
463                  theta
464                  dummy_dfun_id
465                  (my_panic "binds") (getSrcLoc tycon)
466                  (my_panic "upragmas")
467       where
468         dummy_dfun_id
469           = mkVanillaId (getName tycon) dummy_dfun_ty
470                 -- The name is getSrcLoc'd in an error message 
471
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.
479                 -- 
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!
484
485         my_panic str = panic "add_soln" -- pprPanic ("add_soln:"++str) (hsep [char ':', ppr clas, ppr tycon])
486 \end{code}
487
488 %************************************************************************
489 %*                                                                      *
490 \subsection[TcDeriv-normal-binds]{Bindings for the various classes}
491 %*                                                                      *
492 %************************************************************************
493
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.
498
499 There are lots of possibilities for code to generate.  Here are
500 various general remarks.
501
502 PRINCIPLES:
503 \begin{itemize}
504 \item
505 We want derived instances of @Eq@ and @Ord@ (both v common) to be
506 ``you-couldn't-do-better-by-hand'' efficient.
507
508 \item
509 Deriving @Show@---also pretty common--- should also be reasonable good code.
510
511 \item
512 Deriving for the other classes isn't that common or that big a deal.
513 \end{itemize}
514
515 PRAGMATICS:
516
517 \begin{itemize}
518 \item
519 Deriving @Ord@ is done mostly with the 1.3 @compare@ method.
520
521 \item
522 Deriving @Eq@ also uses @compare@, if we're deriving @Ord@, too.
523
524 \item
525 We {\em normally} generate code only for the non-defaulted methods;
526 there are some exceptions for @Eq@ and (especially) @Ord@...
527
528 \item
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@.
533
534 The examples under the different sections below will make this
535 clearer.
536
537 \item
538 Much less often (really just for deriving @Ix@), we use a
539 @_tag2con_<tycon>@ function.  See the examples.
540
541 \item
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!
548 \end{itemize}
549
550 \begin{code}
551 -- Generate the method bindings for the required instance
552 -- (paired with class name, as we need that when generating dict
553 --  names.)
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
559   | otherwise
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)
566            ]
567            (classKey clas)
568            tycon
569   where
570       from_here   = isLocallyDefined tycon
571       (tycon,_,_) = splitAlgTyConApp ty 
572 \end{code}
573
574
575 %************************************************************************
576 %*                                                                      *
577 \subsection[TcDeriv-taggery-Names]{What con2tag/tag2con functions are available?}
578 %*                                                                      *
579 %************************************************************************
580
581
582 data Foo ... = ...
583
584 con2tag_Foo :: Foo ... -> Int#
585 tag2con_Foo :: Int -> Foo ...   -- easier if Int, not Int#
586 maxtag_Foo  :: Int              -- ditto (NB: not unboxed)
587
588
589 We have a @con2tag@ function for a tycon if:
590 \begin{itemize}
591 \item
592 We're deriving @Eq@ and the tycon has nullary data constructors.
593
594 \item
595 Or: we're deriving @Ord@ (unless single-constructor), @Enum@, @Ix@
596 (enum type only????)
597 \end{itemize}
598
599 We have a @tag2con@ function for a tycon if:
600 \begin{itemize}
601 \item
602 We're deriving @Enum@, or @Ix@ (enum type only???)
603 \end{itemize}
604
605 If we have a @tag2con@ function, we also generate a @maxtag@ constant.
606
607 \begin{code}
608 gen_taggery_Names :: [InstInfo]
609                   -> TcM s [(RdrName,   -- for an assoc list
610                              TyCon,     -- related tycon
611                              TagThingWanted)]
612
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
617   where
618     all_CTs = [ (c, get_tycon ty) | (InstInfo c _ [ty] _ _ _ _ _) <- inst_infos ]
619                     
620     get_tycon ty = case splitAlgTyConApp ty of { (tc, _, _) -> tc }
621
622     all_tycons = map snd all_CTs
623     (tycons_of_interest, _) = removeDups compare all_tycons
624     
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))
633         
634       = returnTc ((con2tag_RDR tycon, tycon, GenCon2Tag)
635                    : acc_Names)
636       | otherwise
637       = returnTc acc_Names
638
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)
646                  : acc_Names)
647       | otherwise
648       = returnTc acc_Names
649
650     we_are_deriving clas_key tycon
651       = is_in_eqns clas_key tycon all_CTs
652       where
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
657
658 \end{code}
659
660 \begin{code}
661 derivingThingErr :: Class -> TyCon -> FAST_STRING -> Message
662
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)],
666          parens (ptext why)]
667
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)")]
671
672 derivCtxt tycon
673   = ptext SLIT("When deriving classes for") <+> quotes (ppr tycon)
674 \end{code}