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