..and a bit more
[ghc-hetmet.git] / compiler / typecheck / TcInstDcls.lhs
1 %
2 % (c) The GRASP/AQUA Project, Glasgow University, 1992-1998
3 %
4 \section[TcInstDecls]{Typechecking instance declarations}
5
6 \begin{code}
7 module TcInstDcls ( tcInstDecls1, tcInstDecls2 ) where
8
9 #include "HsVersions.h"
10
11 import HsSyn
12 import TcBinds          ( mkPragFun, tcPrags, badBootDeclErr )
13 import TcClassDcl       ( tcMethodBind, mkMethodBind, badMethodErr, 
14                           tcClassDecl2, getGenericInstances )
15 import TcRnMonad       
16 import TcMType          ( tcSkolSigType, checkValidInstance, checkValidInstHead )
17 import TcType           ( mkClassPred, tcSplitSigmaTy, tcSplitDFunHead, mkTyVarTys,
18                           SkolemInfo(InstSkol), tcSplitDFunTy )
19 import Inst             ( tcInstClassOp, newDicts, instToId, showLIE, 
20                           getOverlapFlag, tcExtendLocalInstEnv )
21 import InstEnv          ( mkLocalInstance, instanceDFunId )
22 import TcDeriv          ( tcDeriving )
23 import TcEnv            ( InstInfo(..), InstBindings(..), 
24                           newDFunName, tcExtendIdEnv
25                         )
26 import TcHsType         ( kcHsSigType, tcHsKindedType )
27 import TcUnify          ( checkSigTyVars )
28 import TcSimplify       ( tcSimplifyCheck, tcSimplifySuperClasses )
29 import Type             ( zipOpenTvSubst, substTheta, substTys )
30 import DataCon          ( classDataCon )
31 import Class            ( classBigSig )
32 import Var              ( Id, idName, idType )
33 import MkId             ( mkDictFunId )
34 import Name             ( Name, getSrcLoc )
35 import Maybe            ( catMaybes )
36 import SrcLoc           ( srcLocSpan, unLoc, noLoc, Located(..), srcSpanStart )
37 import ListSetOps       ( minusList )
38 import Outputable
39 import Bag
40 import BasicTypes       ( Activation( AlwaysActive ), InlineSpec(..) )
41 import FastString
42 \end{code}
43
44 Typechecking instance declarations is done in two passes. The first
45 pass, made by @tcInstDecls1@, collects information to be used in the
46 second pass.
47
48 This pre-processed info includes the as-yet-unprocessed bindings
49 inside the instance declaration.  These are type-checked in the second
50 pass, when the class-instance envs and GVE contain all the info from
51 all the instance and value decls.  Indeed that's the reason we need
52 two passes over the instance decls.
53
54 Here is the overall algorithm.
55 Assume that we have an instance declaration
56
57     instance c => k (t tvs) where b
58
59 \begin{enumerate}
60 \item
61 $LIE_c$ is the LIE for the context of class $c$
62 \item
63 $betas_bar$ is the free variables in the class method type, excluding the
64    class variable
65 \item
66 $LIE_cop$ is the LIE constraining a particular class method
67 \item
68 $tau_cop$ is the tau type of a class method
69 \item
70 $LIE_i$ is the LIE for the context of instance $i$
71 \item
72 $X$ is the instance constructor tycon
73 \item
74 $gammas_bar$ is the set of type variables of the instance
75 \item
76 $LIE_iop$ is the LIE for a particular class method instance
77 \item
78 $tau_iop$ is the tau type for this instance of a class method
79 \item
80 $alpha$ is the class variable
81 \item
82 $LIE_cop' = LIE_cop [X gammas_bar / alpha, fresh betas_bar]$
83 \item
84 $tau_cop' = tau_cop [X gammas_bar / alpha, fresh betas_bar]$
85 \end{enumerate}
86
87 ToDo: Update the list above with names actually in the code.
88
89 \begin{enumerate}
90 \item
91 First, make the LIEs for the class and instance contexts, which means
92 instantiate $thetaC [X inst_tyvars / alpha ]$, yielding LIElistC' and LIEC',
93 and make LIElistI and LIEI.
94 \item
95 Then process each method in turn.
96 \item
97 order the instance methods according to the ordering of the class methods
98 \item
99 express LIEC' in terms of LIEI, yielding $dbinds_super$ or an error
100 \item
101 Create final dictionary function from bindings generated already
102 \begin{pseudocode}
103 df = lambda inst_tyvars
104        lambda LIEI
105          let Bop1
106              Bop2
107              ...
108              Bopn
109          and dbinds_super
110               in <op1,op2,...,opn,sd1,...,sdm>
111 \end{pseudocode}
112 Here, Bop1 \ldots Bopn bind the methods op1 \ldots opn,
113 and $dbinds_super$ bind the superclass dictionaries sd1 \ldots sdm.
114 \end{enumerate}
115
116
117 %************************************************************************
118 %*                                                                      *
119 \subsection{Extracting instance decls}
120 %*                                                                      *
121 %************************************************************************
122
123 Gather up the instance declarations from their various sources
124
125 \begin{code}
126 tcInstDecls1    -- Deal with both source-code and imported instance decls
127    :: [LTyClDecl Name]          -- For deriving stuff
128    -> [LInstDecl Name]          -- Source code instance decls
129    -> TcM (TcGblEnv,            -- The full inst env
130            [InstInfo],          -- Source-code instance decls to process; 
131                                 -- contains all dfuns for this module
132            HsValBinds Name)     -- Supporting bindings for derived instances
133
134 tcInstDecls1 tycl_decls inst_decls
135   = checkNoErrs $
136         -- Stop if addInstInfos etc discovers any errors
137         -- (they recover, so that we get more than one error each round)
138
139         -- (1) Do the ordinary instance declarations
140     mappM tcLocalInstDecl1 inst_decls    `thenM` \ local_inst_infos ->
141
142     let
143         local_inst_info = catMaybes local_inst_infos
144         clas_decls      = filter (isClassDecl.unLoc) tycl_decls
145     in
146         -- (2) Instances from generic class declarations
147     getGenericInstances clas_decls      `thenM` \ generic_inst_info -> 
148
149         -- Next, construct the instance environment so far, consisting of
150         --      a) local instance decls
151         --      b) generic instances
152     addInsts local_inst_info    $
153     addInsts generic_inst_info  $
154
155         -- (3) Compute instances from "deriving" clauses; 
156         -- This stuff computes a context for the derived instance decl, so it
157         -- needs to know about all the instances possible; hence inst_env4
158     tcDeriving tycl_decls       `thenM` \ (deriv_inst_info, deriv_binds) ->
159     addInsts deriv_inst_info    $
160
161     getGblEnv                   `thenM` \ gbl_env ->
162     returnM (gbl_env, 
163              generic_inst_info ++ deriv_inst_info ++ local_inst_info,
164              deriv_binds)
165
166 addInsts :: [InstInfo] -> TcM a -> TcM a
167 addInsts infos thing_inside
168   = tcExtendLocalInstEnv (map iSpec infos) thing_inside
169 \end{code} 
170
171 \begin{code}
172 tcLocalInstDecl1 :: LInstDecl Name 
173                  -> TcM (Maybe InstInfo)        -- Nothing if there was an error
174         -- A source-file instance declaration
175         -- Type-check all the stuff before the "where"
176         --
177         -- We check for respectable instance type, and context
178 tcLocalInstDecl1 decl@(L loc (InstDecl poly_ty binds uprags ats))
179   -- !!!TODO: Handle the `ats' parameter!!! -=chak
180   =     -- Prime error recovery, set source location
181     recoverM (returnM Nothing)          $
182     setSrcSpan loc                      $
183     addErrCtxt (instDeclCtxt1 poly_ty)  $
184
185     do  { is_boot <- tcIsHsBoot
186         ; checkTc (not is_boot || (isEmptyLHsBinds binds && null uprags))
187                   badBootDeclErr
188
189         -- Typecheck the instance type itself.  We can't use 
190         -- tcHsSigType, because it's not a valid user type.
191         ; kinded_ty <- kcHsSigType poly_ty
192         ; poly_ty'  <- tcHsKindedType kinded_ty
193         ; let (tyvars, theta, tau) = tcSplitSigmaTy poly_ty'
194         
195         ; (clas, inst_tys) <- checkValidInstHead tau
196         ; checkValidInstance tyvars theta clas inst_tys
197
198         ; dfun_name <- newDFunName clas inst_tys (srcSpanStart loc)
199         ; overlap_flag <- getOverlapFlag
200         ; let dfun  = mkDictFunId dfun_name tyvars theta clas inst_tys
201               ispec = mkLocalInstance dfun overlap_flag
202
203         ; return (Just (InstInfo { iSpec = ispec, iBinds = VanillaInst binds uprags })) }
204 \end{code}
205
206
207 %************************************************************************
208 %*                                                                      *
209 \subsection{Type-checking instance declarations, pass 2}
210 %*                                                                      *
211 %************************************************************************
212
213 \begin{code}
214 tcInstDecls2 :: [LTyClDecl Name] -> [InstInfo] 
215              -> TcM (LHsBinds Id, TcLclEnv)
216 -- (a) From each class declaration, 
217 --      generate any default-method bindings
218 -- (b) From each instance decl
219 --      generate the dfun binding
220
221 tcInstDecls2 tycl_decls inst_decls
222   = do  {       -- (a) Default methods from class decls
223           (dm_binds_s, dm_ids_s) <- mapAndUnzipM tcClassDecl2 $
224                                     filter (isClassDecl.unLoc) tycl_decls
225         ; tcExtendIdEnv (concat dm_ids_s)       $ do 
226     
227                 -- (b) instance declarations
228         ; inst_binds_s <- mappM tcInstDecl2 inst_decls
229
230                 -- Done
231         ; let binds = unionManyBags dm_binds_s `unionBags` 
232                       unionManyBags inst_binds_s
233         ; tcl_env <- getLclEnv          -- Default method Ids in here
234         ; returnM (binds, tcl_env) }
235 \end{code}
236
237 ======= New documentation starts here (Sept 92)  ==============
238
239 The main purpose of @tcInstDecl2@ is to return a @HsBinds@ which defines
240 the dictionary function for this instance declaration.  For example
241 \begin{verbatim}
242         instance Foo a => Foo [a] where
243                 op1 x = ...
244                 op2 y = ...
245 \end{verbatim}
246 might generate something like
247 \begin{verbatim}
248         dfun.Foo.List dFoo_a = let op1 x = ...
249                                    op2 y = ...
250                                in
251                                    Dict [op1, op2]
252 \end{verbatim}
253
254 HOWEVER, if the instance decl has no context, then it returns a
255 bigger @HsBinds@ with declarations for each method.  For example
256 \begin{verbatim}
257         instance Foo [a] where
258                 op1 x = ...
259                 op2 y = ...
260 \end{verbatim}
261 might produce
262 \begin{verbatim}
263         dfun.Foo.List a = Dict [Foo.op1.List a, Foo.op2.List a]
264         const.Foo.op1.List a x = ...
265         const.Foo.op2.List a y = ...
266 \end{verbatim}
267 This group may be mutually recursive, because (for example) there may
268 be no method supplied for op2 in which case we'll get
269 \begin{verbatim}
270         const.Foo.op2.List a = default.Foo.op2 (dfun.Foo.List a)
271 \end{verbatim}
272 that is, the default method applied to the dictionary at this type.
273
274 What we actually produce in either case is:
275
276         AbsBinds [a] [dfun_theta_dicts]
277                  [(dfun.Foo.List, d)] ++ (maybe) [(const.Foo.op1.List, op1), ...]
278                  { d = (sd1,sd2, ..., op1, op2, ...)
279                    op1 = ...
280                    op2 = ...
281                  }
282
283 The "maybe" says that we only ask AbsBinds to make global constant methods
284 if the dfun_theta is empty.
285
286                 
287 For an instance declaration, say,
288
289         instance (C1 a, C2 b) => C (T a b) where
290                 ...
291
292 where the {\em immediate} superclasses of C are D1, D2, we build a dictionary
293 function whose type is
294
295         (C1 a, C2 b, D1 (T a b), D2 (T a b)) => C (T a b)
296
297 Notice that we pass it the superclass dictionaries at the instance type; this
298 is the ``Mark Jones optimisation''.  The stuff before the "=>" here
299 is the @dfun_theta@ below.
300
301 First comes the easy case of a non-local instance decl.
302
303
304 \begin{code}
305 tcInstDecl2 :: InstInfo -> TcM (LHsBinds Id)
306 -- Returns a binding for the dfun
307
308 --
309 -- Derived newtype instances
310 --
311 -- We need to make a copy of the dictionary we are deriving from
312 -- because we may need to change some of the superclass dictionaries
313 -- see Note [Newtype deriving superclasses] in TcDeriv.lhs
314 --
315 -- In the case of a newtype, things are rather easy
316 --      class Show a => Foo a b where ...
317 --      newtype T a = MkT (Tree [a]) deriving( Foo Int )
318 -- The newtype gives an FC axiom looking like
319 --      axiom CoT a :: Tree [a] = T a
320 --
321 -- So all need is to generate a binding looking like
322 --      dfunFooT :: forall a. (Foo Int (Tree [a], Show (T a)) => Foo Int (T a)
323 --      dfunFooT = /\a. \(ds:Show (T a)) (df:Foo (Tree [a])).
324 --                case df `cast` (Foo Int (CoT a)) of
325 --                   Foo _ op1 .. opn -> Foo ds op1 .. opn
326
327 tcInstDecl2 (InstInfo { iSpec = ispec, 
328                         iBinds = NewTypeDerived tycon rep_tys })
329   = do  { let dfun_id      = instanceDFunId ispec 
330               rigid_info   = InstSkol dfun_id
331               origin       = SigOrigin rigid_info
332               inst_ty      = idType dfun_id
333               maybe_co_con = newTyConCo tycon
334         ; (tvs, theta, inst_head) <- tcSkolSigType rigid_info inst_ty
335         ; dicts <- newDicts origin theta
336         ; uniqs <- newUniqueSupply
337         ; let (rep_dict_id:sc_dict_ids) = map instToId dicts
338                 -- (Here, wee are relying on the order of dictionary 
339                 -- arguments built by NewTypeDerived in TcDeriv.)
340
341               wrap_fn = CoTyLams tvs <.> CoLams dict_ids
342          
343               coerced_rep_dict = mkHsCoerce co_fn (HsVar rep_dict_id)
344
345               body | null sc_dicts = coerced_rep_dict
346                    | otherwise = HsCase coerced_rep_dict $
347                                  MatchGroup [the_match] inst_head
348               the_match = mkSimpleMatch [the_pat] the_rhs
349               op_ids = zipWith (mkSysLocal FSLIT("op"))
350                                (uniqsFromSupply uniqs) op_tys
351               the_pat = ConPatOut { pat_con = cls_data_con, pat_tvs = [],
352                                     pat_dicts = map (WildPat . idType) sc_dict_ids,
353                                     pat_binds = emptyDictBinds,
354                                     pat_args = PrefixCon (map VarPat op_ids), 
355                                     pat_ty = <type of pattern> }
356               the_rhs = mkHsApps (dataConWrapId cls_data_con) types sc_dict_ids (map HsVar op_ids)
357
358         ; return (unitBag (VarBind dfun_id (mkHsCoerce wrap_fn body))) }
359   where
360     co_fn :: ExprCoFn
361     co_fn | Just co_con <- newTyConCo tycon
362           = ExprCoFn (mkAppCoercion (mkAppsCoercion tycon rep_tys) 
363                                     (mkTyConApp co_con tvs))
364           | otherwise
365           = idCoerecion
366
367 tcMethods origin clas inst_tyvars' dfun_theta' inst_tys' 
368           avail_insts op_items (NewTypeDerived rep_tys)
369   = getInstLoc origin                           `thenM` \ inst_loc ->
370     mapAndUnzip3M (do_one inst_loc) op_items    `thenM` \ (meth_ids, meth_binds, rhs_insts) ->
371     
372     tcSimplifyCheck
373          (ptext SLIT("newtype derived instance"))
374          inst_tyvars' avail_insts rhs_insts     `thenM` \ lie_binds ->
375
376         -- I don't think we have to do the checkSigTyVars thing
377
378     returnM (meth_ids, lie_binds `unionBags` listToBag meth_binds)
379
380   where
381     do_one inst_loc (sel_id, _)
382         = -- The binding is like "op @ NewTy = op @ RepTy"
383                 -- Make the *binder*, like in mkMethodBind
384           tcInstClassOp inst_loc sel_id inst_tys'       `thenM` \ meth_inst ->
385
386                 -- Make the *occurrence on the rhs*
387           tcInstClassOp inst_loc sel_id rep_tys'        `thenM` \ rhs_inst ->
388           let
389              meth_id = instToId meth_inst
390           in
391           return (meth_id, noLoc (VarBind meth_id (nlHsVar (instToId rhs_inst))), rhs_inst)
392
393         -- Instantiate rep_tys with the relevant type variables
394         -- This looks a bit odd, because inst_tyvars' are the skolemised version
395         -- of the type variables in the instance declaration; but rep_tys doesn't
396         -- have the skolemised version, so we substitute them in here
397     rep_tys' = substTys subst rep_tys
398     subst    = zipOpenTvSubst inst_tyvars' (mkTyVarTys inst_tyvars')
399
400
401
402 tcInstDecl2 (InstInfo { iSpec = ispec, iBinds = VanillaInst monobinds uprags })
403   = let 
404         dfun_id    = instanceDFunId ispec
405         rigid_info = InstSkol dfun_id
406         inst_ty    = idType dfun_id
407     in
408          -- Prime error recovery
409     recoverM (returnM emptyLHsBinds)            $
410     setSrcSpan (srcLocSpan (getSrcLoc dfun_id)) $
411     addErrCtxt (instDeclCtxt2 (idType dfun_id)) $
412
413         -- Instantiate the instance decl with skolem constants 
414     tcSkolSigType rigid_info inst_ty    `thenM` \ (inst_tyvars', dfun_theta', inst_head') ->
415                 -- These inst_tyvars' scope over the 'where' part
416                 -- Those tyvars are inside the dfun_id's type, which is a bit
417                 -- bizarre, but OK so long as you realise it!
418     let
419         (clas, inst_tys') = tcSplitDFunHead inst_head'
420         (class_tyvars, sc_theta, _, op_items) = classBigSig clas
421
422         -- Instantiate the super-class context with inst_tys
423         sc_theta' = substTheta (zipOpenTvSubst class_tyvars inst_tys') sc_theta
424         origin    = SigOrigin rigid_info
425     in
426          -- Create dictionary Ids from the specified instance contexts.
427     newDicts InstScOrigin sc_theta'                     `thenM` \ sc_dicts ->
428     newDicts origin dfun_theta'                         `thenM` \ dfun_arg_dicts ->
429     newDicts origin [mkClassPred clas inst_tys']        `thenM` \ [this_dict] ->
430                 -- Default-method Ids may be mentioned in synthesised RHSs,
431                 -- but they'll already be in the environment.
432
433         -- Typecheck the methods
434     let         -- These insts are in scope; quite a few, eh?
435         avail_insts = [this_dict] ++ dfun_arg_dicts ++ sc_dicts
436     in
437     tcMethods origin clas inst_tyvars' 
438               dfun_theta' inst_tys' avail_insts 
439               op_items monobinds uprags         `thenM` \ (meth_ids, meth_binds) ->
440
441         -- Figure out bindings for the superclass context
442         -- Don't include this_dict in the 'givens', else
443         -- sc_dicts get bound by just selecting  from this_dict!!
444     addErrCtxt superClassCtxt
445         (tcSimplifySuperClasses inst_tyvars'
446                          dfun_arg_dicts
447                          sc_dicts)      `thenM` \ sc_binds ->
448
449         -- It's possible that the superclass stuff might unified one
450         -- of the inst_tyavars' with something in the envt
451     checkSigTyVars inst_tyvars'         `thenM_`
452
453         -- Deal with 'SPECIALISE instance' pragmas 
454     tcPrags dfun_id (filter isSpecInstLSig prags)       `thenM` \ prags -> 
455     
456         -- Create the result bindings
457     let
458         dict_constr   = classDataCon clas
459         scs_and_meths = map instToId sc_dicts ++ meth_ids
460         this_dict_id  = instToId this_dict
461         inline_prag | null dfun_arg_dicts = []
462                     | otherwise = [InlinePrag (Inline AlwaysActive True)]
463                 -- Always inline the dfun; this is an experimental decision
464                 -- because it makes a big performance difference sometimes.
465                 -- Often it means we can do the method selection, and then
466                 -- inline the method as well.  Marcin's idea; see comments below.
467                 --
468                 -- BUT: don't inline it if it's a constant dictionary;
469                 -- we'll get all the benefit without inlining, and we get
470                 -- a **lot** of code duplication if we inline it
471                 --
472                 --      See Note [Inline dfuns] below
473
474         dict_rhs
475           = mkHsConApp dict_constr inst_tys' (map HsVar scs_and_meths)
476                 -- We don't produce a binding for the dict_constr; instead we
477                 -- rely on the simplifier to unfold this saturated application
478                 -- We do this rather than generate an HsCon directly, because
479                 -- it means that the special cases (e.g. dictionary with only one
480                 -- member) are dealt with by the common MkId.mkDataConWrapId code rather
481                 -- than needing to be repeated here.
482
483         dict_bind  = noLoc (VarBind this_dict_id dict_rhs)
484         all_binds  = dict_bind `consBag` (sc_binds `unionBags` meth_binds)
485
486         main_bind = noLoc $ AbsBinds
487                             inst_tyvars'
488                             (map instToId dfun_arg_dicts)
489                             [(inst_tyvars', dfun_id, this_dict_id, 
490                                             inline_prag ++ prags)] 
491                             all_binds
492     in
493     showLIE (text "instance")           `thenM_`
494     returnM (unitBag main_bind)
495
496
497 tcMethods origin clas inst_tyvars' dfun_theta' inst_tys' 
498           avail_insts op_items monobinds uprags
499   =     -- Check that all the method bindings come from this class
500     let
501         sel_names = [idName sel_id | (sel_id, _) <- op_items]
502         bad_bndrs = collectHsBindBinders monobinds `minusList` sel_names
503     in
504     mappM (addErrTc . badMethodErr clas) bad_bndrs      `thenM_`
505
506         -- Make the method bindings
507     let
508         mk_method_bind = mkMethodBind origin clas inst_tys' monobinds
509     in
510     mapAndUnzipM mk_method_bind op_items        `thenM` \ (meth_insts, meth_infos) ->
511
512         -- And type check them
513         -- It's really worth making meth_insts available to the tcMethodBind
514         -- Consider     instance Monad (ST s) where
515         --                {-# INLINE (>>) #-}
516         --                (>>) = ...(>>=)...
517         -- If we don't include meth_insts, we end up with bindings like this:
518         --      rec { dict = MkD then bind ...
519         --            then = inline_me (... (GHC.Base.>>= dict) ...)
520         --            bind = ... }
521         -- The trouble is that (a) 'then' and 'dict' are mutually recursive, 
522         -- and (b) the inline_me prevents us inlining the >>= selector, which
523         -- would unravel the loop.  Result: (>>) ends up as a loop breaker, and
524         -- is not inlined across modules. Rather ironic since this does not
525         -- happen without the INLINE pragma!  
526         --
527         -- Solution: make meth_insts available, so that 'then' refers directly
528         --           to the local 'bind' rather than going via the dictionary.
529         --
530         -- BUT WATCH OUT!  If the method type mentions the class variable, then
531         -- this optimisation is not right.  Consider
532         --      class C a where
533         --        op :: Eq a => a
534         --
535         --      instance C Int where
536         --        op = op
537         -- The occurrence of 'op' on the rhs gives rise to a constraint
538         --      op at Int
539         -- The trouble is that the 'meth_inst' for op, which is 'available', also
540         -- looks like 'op at Int'.  But they are not the same.
541     let
542         prag_fn        = mkPragFun uprags
543         all_insts      = avail_insts ++ catMaybes meth_insts
544         sig_fn n       = Just []        -- No scoped type variables, but every method has
545                                         -- a type signature, in effect, so that we check
546                                         -- the method has the right type
547         tc_method_bind = tcMethodBind inst_tyvars' dfun_theta' all_insts sig_fn prag_fn
548         meth_ids       = [meth_id | (_,meth_id,_) <- meth_infos]
549     in
550
551     mapM tc_method_bind meth_infos              `thenM` \ meth_binds_s ->
552    
553     returnM (meth_ids, unionManyBags meth_binds_s)
554 \end{code}
555
556
557                 ------------------------------
558         [Inline dfuns] Inlining dfuns unconditionally
559                 ------------------------------
560
561 The code above unconditionally inlines dict funs.  Here's why.
562 Consider this program:
563
564     test :: Int -> Int -> Bool
565     test x y = (x,y) == (y,x) || test y x
566     -- Recursive to avoid making it inline.
567
568 This needs the (Eq (Int,Int)) instance.  If we inline that dfun
569 the code we end up with is good:
570
571     Test.$wtest =
572         \r -> case ==# [ww ww1] of wild {
573                 PrelBase.False -> Test.$wtest ww1 ww;
574                 PrelBase.True ->
575                   case ==# [ww1 ww] of wild1 {
576                     PrelBase.False -> Test.$wtest ww1 ww;
577                     PrelBase.True -> PrelBase.True [];
578                   };
579             };
580     Test.test = \r [w w1]
581             case w of w2 {
582               PrelBase.I# ww ->
583                   case w1 of w3 { PrelBase.I# ww1 -> Test.$wtest ww ww1; };
584             };
585
586 If we don't inline the dfun, the code is not nearly as good:
587
588     (==) = case PrelTup.$fEq(,) PrelBase.$fEqInt PrelBase.$fEqInt of tpl {
589               PrelBase.:DEq tpl1 tpl2 -> tpl2;
590             };
591     
592     Test.$wtest =
593         \r [ww ww1]
594             let { y = PrelBase.I#! [ww1]; } in
595             let { x = PrelBase.I#! [ww]; } in
596             let { sat_slx = PrelTup.(,)! [y x]; } in
597             let { sat_sly = PrelTup.(,)! [x y];
598             } in
599               case == sat_sly sat_slx of wild {
600                 PrelBase.False -> Test.$wtest ww1 ww;
601                 PrelBase.True -> PrelBase.True [];
602               };
603     
604     Test.test =
605         \r [w w1]
606             case w of w2 {
607               PrelBase.I# ww ->
608                   case w1 of w3 { PrelBase.I# ww1 -> Test.$wtest ww ww1; };
609             };
610
611 Why doesn't GHC inline $fEq?  Because it looks big:
612
613     PrelTup.zdfEqZ1T{-rcX-}
614         = \ @ a{-reT-} :: * @ b{-reS-} :: *
615             zddEq{-rf6-} _Ks :: {PrelBase.Eq{-23-} a{-reT-}}
616             zddEq1{-rf7-} _Ks :: {PrelBase.Eq{-23-} b{-reS-}} ->
617             let {
618               zeze{-rf0-} _Kl :: (b{-reS-} -> b{-reS-} -> PrelBase.Bool{-3c-})
619               zeze{-rf0-} = PrelBase.zeze{-01L-}@ b{-reS-} zddEq1{-rf7-} } in
620             let {
621               zeze1{-rf3-} _Kl :: (a{-reT-} -> a{-reT-} -> PrelBase.Bool{-3c-})
622               zeze1{-rf3-} = PrelBase.zeze{-01L-} @ a{-reT-} zddEq{-rf6-} } in
623             let {
624               zeze2{-reN-} :: ((a{-reT-}, b{-reS-}) -> (a{-reT-}, b{-reS-})-> PrelBase.Bool{-3c-})
625               zeze2{-reN-} = \ ds{-rf5-} _Ks :: (a{-reT-}, b{-reS-})
626                                ds1{-rf4-} _Ks :: (a{-reT-}, b{-reS-}) ->
627                              case ds{-rf5-}
628                              of wild{-reW-} _Kd { (a1{-rf2-} _Ks, a2{-reZ-} _Ks) ->
629                              case ds1{-rf4-}
630                              of wild1{-reX-} _Kd { (b1{-rf1-} _Ks, b2{-reY-} _Ks) ->
631                              PrelBase.zaza{-r4e-}
632                                (zeze1{-rf3-} a1{-rf2-} b1{-rf1-})
633                                (zeze{-rf0-} a2{-reZ-} b2{-reY-})
634                              }
635                              } } in     
636             let {
637               a1{-reR-} :: ((a{-reT-}, b{-reS-})-> (a{-reT-}, b{-reS-})-> PrelBase.Bool{-3c-})
638               a1{-reR-} = \ a2{-reV-} _Ks :: (a{-reT-}, b{-reS-})
639                             b1{-reU-} _Ks :: (a{-reT-}, b{-reS-}) ->
640                           PrelBase.not{-r6I-} (zeze2{-reN-} a2{-reV-} b1{-reU-})
641             } in
642               PrelBase.zdwZCDEq{-r8J-} @ (a{-reT-}, b{-reS-}) a1{-reR-} zeze2{-reN-})
643
644 and it's not as bad as it seems, because it's further dramatically
645 simplified: only zeze2 is extracted and its body is simplified.
646
647
648 %************************************************************************
649 %*                                                                      *
650 \subsection{Error messages}
651 %*                                                                      *
652 %************************************************************************
653
654 \begin{code}
655 instDeclCtxt1 hs_inst_ty 
656   = inst_decl_ctxt (case unLoc hs_inst_ty of
657                         HsForAllTy _ _ _ (L _ (HsPredTy pred)) -> ppr pred
658                         HsPredTy pred                    -> ppr pred
659                         other                            -> ppr hs_inst_ty)     -- Don't expect this
660 instDeclCtxt2 dfun_ty
661   = inst_decl_ctxt (ppr (mkClassPred cls tys))
662   where
663     (_,_,cls,tys) = tcSplitDFunTy dfun_ty
664
665 inst_decl_ctxt doc = ptext SLIT("In the instance declaration for") <+> quotes doc
666
667 superClassCtxt = ptext SLIT("When checking the super-classes of an instance declaration")
668 \end{code}