[project @ 2004-04-21 12:45:05 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          ( tcInstType, checkValidTheta, checkValidInstHead, instTypeErr, 
17                           checkAmbiguity, SourceTyCtxt(..) )
18 import TcType           ( mkClassPred, tcSplitForAllTys, tyVarsOfType,
19                           tcSplitSigmaTy, getClassPredTys, tcSplitPredTy_maybe, mkTyVarTys,
20                           TyVarDetails(..), tcSplitDFunTy, pprClassPred )
21 import Inst             ( tcInstClassOp, newDicts, instToId, showLIE, tcExtendLocalInstEnv )
22 import TcDeriv          ( tcDeriving )
23 import TcEnv            ( tcExtendGlobalValEnv, tcExtendTyVarEnv2,
24                           InstInfo(..), InstBindings(..), 
25                           newDFunName, tcExtendLocalValEnv
26                         )
27 import TcHsType         ( kcHsSigType, tcHsKindedType )
28 import TcUnify          ( checkSigTyVars )
29 import TcSimplify       ( tcSimplifyCheck, tcSimplifyTop )
30 import Subst            ( mkTyVarSubst, substTheta, substTy )
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, nameSetToList, unionNameSets )
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, keep_alive) ->
163     addInsts deriv_inst_info    $
164
165     getGblEnv                   `thenM` \ gbl_env ->
166     returnM (gbl_env { tcg_keep = tcg_keep gbl_env `unionNameSets` keep_alive }, 
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     addSrcSpan 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         ; tcExtendLocalValEnv (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 emptyBag)                 $
314     addSrcSpan (srcLocSpan (getSrcLoc dfun_id)) $
315     addErrCtxt (instDeclCtxt2 (idType dfun_id)) $
316     let
317         inst_ty          = idType dfun_id
318         (inst_tyvars, _) = tcSplitForAllTys inst_ty
319                 -- The tyvars of the instance decl scope over the 'where' part
320                 -- Those tyvars are inside the dfun_id's type, which is a bit
321                 -- bizarre, but OK so long as you realise it!
322     in
323
324         -- Instantiate the instance decl with tc-style type variables
325     tcInstType InstTv inst_ty           `thenM` \ (inst_tyvars', dfun_theta', inst_head') ->
326     let
327         Just pred         = tcSplitPredTy_maybe inst_head'
328         (clas, inst_tys') = getClassPredTys pred
329         (class_tyvars, sc_theta, _, op_items) = classBigSig clas
330
331         -- Instantiate the super-class context with inst_tys
332         sc_theta' = substTheta (mkTyVarSubst class_tyvars inst_tys') sc_theta
333         origin    = InstanceDeclOrigin
334     in
335          -- Create dictionary Ids from the specified instance contexts.
336     newDicts origin sc_theta'           `thenM` \ sc_dicts ->
337     newDicts origin dfun_theta'         `thenM` \ dfun_arg_dicts ->
338     newDicts origin [pred]              `thenM` \ [this_dict] ->
339                 -- Default-method Ids may be mentioned in synthesised RHSs,
340                 -- but they'll already be in the environment.
341
342         ------------------
343         -- Typecheck the methods
344     let         -- These insts are in scope; quite a few, eh?
345         avail_insts = [this_dict] ++ dfun_arg_dicts ++ sc_dicts
346     in
347     tcMethods clas inst_tyvars inst_tyvars' 
348               dfun_theta' inst_tys' avail_insts 
349               op_items binds            `thenM` \ (meth_ids, meth_binds) ->
350
351         -- Figure out bindings for the superclass context
352     tcSuperClasses inst_tyvars' dfun_arg_dicts sc_dicts 
353                 `thenM` \ (zonked_inst_tyvars, sc_binds_inner, sc_binds_outer) ->
354
355         -- Deal with 'SPECIALISE instance' pragmas by making them
356         -- look like SPECIALISE pragmas for the dfun
357     let
358         uprags = case binds of
359                        VanillaInst _ uprags -> uprags
360                        other                -> []
361         spec_prags = [ L loc (SpecSig (L loc (idName dfun_id)) ty)
362                      | L loc (SpecInstSig ty) <- uprags ]
363         xtve = inst_tyvars `zip` inst_tyvars'
364     in
365     tcExtendGlobalValEnv [dfun_id] (
366         tcExtendTyVarEnv2 xtve          $
367         tcSpecSigs spec_prags
368     )                                   `thenM` \ prag_binds ->
369
370         -- Create the result bindings
371     let
372         dict_constr   = classDataCon clas
373         scs_and_meths = map instToId sc_dicts ++ meth_ids
374         this_dict_id  = instToId this_dict
375         inlines       | null dfun_arg_dicts = emptyNameSet
376                       | otherwise           = unitNameSet (idName dfun_id)
377                 -- Always inline the dfun; this is an experimental decision
378                 -- because it makes a big performance difference sometimes.
379                 -- Often it means we can do the method selection, and then
380                 -- inline the method as well.  Marcin's idea; see comments below.
381                 --
382                 -- BUT: don't inline it if it's a constant dictionary;
383                 -- we'll get all the benefit without inlining, and we get
384                 -- a **lot** of code duplication if we inline it
385                 --
386                 --      See Note [Inline dfuns] below
387
388         dict_rhs
389           | null scs_and_meths
390           =     -- Blatant special case for CCallable, CReturnable
391                 -- If the dictionary is empty then we should never
392                 -- select anything from it, so we make its RHS just
393                 -- emit an error message.  This in turn means that we don't
394                 -- mention the constructor, which doesn't exist for CCallable, CReturnable
395                 -- Hardly beautiful, but only three extra lines.
396             nlHsApp (noLoc $ TyApp (nlHsVar rUNTIME_ERROR_ID) 
397                                    [idType this_dict_id])
398                   (nlHsLit (HsStringPrim (mkFastString (stringToUtf8 msg))))
399
400           | otherwise   -- The common case
401           = mkHsConApp dict_constr inst_tys' (map HsVar scs_and_meths)
402                 -- We don't produce a binding for the dict_constr; instead we
403                 -- rely on the simplifier to unfold this saturated application
404                 -- We do this rather than generate an HsCon directly, because
405                 -- it means that the special cases (e.g. dictionary with only one
406                 -- member) are dealt with by the common MkId.mkDataConWrapId code rather
407                 -- than needing to be repeated here.
408
409           where
410             msg = "Compiler error: bad dictionary " ++ showSDoc (ppr clas)
411
412         dict_bind  = noLoc (VarBind this_dict_id dict_rhs)
413         all_binds  = dict_bind `consBag` (sc_binds_inner `unionBags` meth_binds)
414
415         main_bind = noLoc $ AbsBinds
416                          zonked_inst_tyvars
417                          (map instToId dfun_arg_dicts)
418                          [(inst_tyvars', dfun_id, this_dict_id)] 
419                          inlines all_binds
420     in
421     showLIE (text "instance")           `thenM_`
422     returnM (unitBag main_bind `unionBags` 
423              prag_binds `unionBags`
424              sc_binds_outer)
425
426
427 tcMethods clas inst_tyvars inst_tyvars' dfun_theta' inst_tys' 
428           avail_insts op_items (VanillaInst monobinds uprags)
429   =     -- Check that all the method bindings come from this class
430     let
431         sel_names = [idName sel_id | (sel_id, _) <- op_items]
432         bad_bndrs = collectHsBindBinders monobinds `minusList` sel_names
433     in
434     mappM (addErrTc . badMethodErr clas) bad_bndrs      `thenM_`
435
436         -- Make the method bindings
437     let
438         mk_method_bind = mkMethodBind InstanceDeclOrigin clas inst_tys' monobinds
439     in
440     mapAndUnzipM mk_method_bind op_items        `thenM` \ (meth_insts, meth_infos) ->
441
442         -- And type check them
443         -- It's really worth making meth_insts available to the tcMethodBind
444         -- Consider     instance Monad (ST s) where
445         --                {-# INLINE (>>) #-}
446         --                (>>) = ...(>>=)...
447         -- If we don't include meth_insts, we end up with bindings like this:
448         --      rec { dict = MkD then bind ...
449         --            then = inline_me (... (GHC.Base.>>= dict) ...)
450         --            bind = ... }
451         -- The trouble is that (a) 'then' and 'dict' are mutually recursive, 
452         -- and (b) the inline_me prevents us inlining the >>= selector, which
453         -- would unravel the loop.  Result: (>>) ends up as a loop breaker, and
454         -- is not inlined across modules. Rather ironic since this does not
455         -- happen without the INLINE pragma!  
456         --
457         -- Solution: make meth_insts available, so that 'then' refers directly
458         --           to the local 'bind' rather than going via the dictionary.
459         --
460         -- BUT WATCH OUT!  If the method type mentions the class variable, then
461         -- this optimisation is not right.  Consider
462         --      class C a where
463         --        op :: Eq a => a
464         --
465         --      instance C Int where
466         --        op = op
467         -- The occurrence of 'op' on the rhs gives rise to a constraint
468         --      op at Int
469         -- The trouble is that the 'meth_inst' for op, which is 'available', also
470         -- looks like 'op at Int'.  But they are not the same.
471     let
472         all_insts      = avail_insts ++ catMaybes meth_insts
473         xtve           = inst_tyvars `zip` inst_tyvars'
474         tc_method_bind = tcMethodBind xtve inst_tyvars' dfun_theta' all_insts uprags 
475     in
476     mapM tc_method_bind meth_infos              `thenM` \ meth_binds_s ->
477    
478     returnM ([meth_id | (_,meth_id,_) <- meth_infos], 
479              unionManyBags meth_binds_s)
480
481
482 -- Derived newtype instances
483 tcMethods clas inst_tyvars inst_tyvars' dfun_theta' inst_tys' 
484           avail_insts op_items (NewTypeDerived rep_tys)
485   = getInstLoc InstanceDeclOrigin               `thenM` \ inst_loc ->
486     mapAndUnzip3M (do_one inst_loc) op_items    `thenM` \ (meth_ids, meth_binds, rhs_insts) ->
487     
488     tcSimplifyCheck
489          (ptext SLIT("newtype derived instance"))
490          inst_tyvars' avail_insts rhs_insts     `thenM` \ lie_binds ->
491
492         -- I don't think we have to do the checkSigTyVars thing
493
494     returnM (meth_ids, lie_binds `unionBags` listToBag meth_binds)
495
496   where
497     do_one inst_loc (sel_id, _)
498         = -- The binding is like "op @ NewTy = op @ RepTy"
499                 -- Make the *binder*, like in mkMethodBind
500           tcInstClassOp inst_loc sel_id inst_tys'       `thenM` \ meth_inst ->
501
502                 -- Make the *occurrence on the rhs*
503           tcInstClassOp inst_loc sel_id rep_tys'        `thenM` \ rhs_inst ->
504           let
505              meth_id = instToId meth_inst
506           in
507           return (meth_id, noLoc (VarBind meth_id (nlHsVar (instToId rhs_inst))), rhs_inst)
508
509         -- Instantiate rep_tys with the relevant type variables
510     rep_tys' = map (substTy subst) rep_tys
511     subst    = mkTyVarSubst inst_tyvars (mkTyVarTys inst_tyvars')
512 \end{code}
513
514 Note: [Superclass loops]
515 ~~~~~~~~~~~~~~~~~~~~~~~~~
516 We have to be very, very careful when generating superclasses, lest we
517 accidentally build a loop. Here's an example:
518
519   class S a
520
521   class S a => C a where { opc :: a -> a }
522   class S b => D b where { opd :: b -> b }
523   
524   instance C Int where
525      opc = opd
526   
527   instance D Int where
528      opd = opc
529
530 From (instance C Int) we get the constraint set {ds1:S Int, dd:D Int}
531 Simplifying, we may well get:
532         $dfCInt = :C ds1 (opd dd)
533         dd  = $dfDInt
534         ds1 = $p1 dd
535 Notice that we spot that we can extract ds1 from dd.  
536
537 Alas!  Alack! We can do the same for (instance D Int):
538
539         $dfDInt = :D ds2 (opc dc)
540         dc  = $dfCInt
541         ds2 = $p1 dc
542
543 And now we've defined the superclass in terms of itself.
544
545
546 Solution: treat the superclass context separately, and simplify it
547 all the way down to nothing on its own.  Don't toss any 'free' parts
548 out to be simplified together with other bits of context.
549 Hence the tcSimplifyTop below.
550
551 At a more basic level, don't include this_dict in the context wrt
552 which we simplify sc_dicts, else sc_dicts get bound by just selecting
553 from this_dict!!
554
555 \begin{code}
556 tcSuperClasses inst_tyvars' dfun_arg_dicts sc_dicts
557   = addErrCtxt superClassCtxt   $
558     getLIE (tcSimplifyCheck doc inst_tyvars'
559                             dfun_arg_dicts
560                             sc_dicts)           `thenM` \ (sc_binds1, sc_lie) ->
561
562         -- It's possible that the superclass stuff might have done unification
563     checkSigTyVars inst_tyvars'         `thenM` \ zonked_inst_tyvars ->
564
565         -- We must simplify this all the way down 
566         -- lest we build superclass loops
567         -- See Note [Superclass loops] above
568     tcSimplifyTop sc_lie                `thenM` \ sc_binds2 ->
569
570     returnM (zonked_inst_tyvars, sc_binds1, sc_binds2)
571
572   where
573     doc = ptext SLIT("instance declaration superclass context")
574 \end{code}
575
576
577                 ------------------------------
578         [Inline dfuns] Inlining dfuns unconditionally
579                 ------------------------------
580
581 The code above unconditionally inlines dict funs.  Here's why.
582 Consider this program:
583
584     test :: Int -> Int -> Bool
585     test x y = (x,y) == (y,x) || test y x
586     -- Recursive to avoid making it inline.
587
588 This needs the (Eq (Int,Int)) instance.  If we inline that dfun
589 the code we end up with is good:
590
591     Test.$wtest =
592         \r -> case ==# [ww ww1] of wild {
593                 PrelBase.False -> Test.$wtest ww1 ww;
594                 PrelBase.True ->
595                   case ==# [ww1 ww] of wild1 {
596                     PrelBase.False -> Test.$wtest ww1 ww;
597                     PrelBase.True -> PrelBase.True [];
598                   };
599             };
600     Test.test = \r [w w1]
601             case w of w2 {
602               PrelBase.I# ww ->
603                   case w1 of w3 { PrelBase.I# ww1 -> Test.$wtest ww ww1; };
604             };
605
606 If we don't inline the dfun, the code is not nearly as good:
607
608     (==) = case PrelTup.$fEq(,) PrelBase.$fEqInt PrelBase.$fEqInt of tpl {
609               PrelBase.:DEq tpl1 tpl2 -> tpl2;
610             };
611     
612     Test.$wtest =
613         \r [ww ww1]
614             let { y = PrelBase.I#! [ww1]; } in
615             let { x = PrelBase.I#! [ww]; } in
616             let { sat_slx = PrelTup.(,)! [y x]; } in
617             let { sat_sly = PrelTup.(,)! [x y];
618             } in
619               case == sat_sly sat_slx of wild {
620                 PrelBase.False -> Test.$wtest ww1 ww;
621                 PrelBase.True -> PrelBase.True [];
622               };
623     
624     Test.test =
625         \r [w w1]
626             case w of w2 {
627               PrelBase.I# ww ->
628                   case w1 of w3 { PrelBase.I# ww1 -> Test.$wtest ww ww1; };
629             };
630
631 Why doesn't GHC inline $fEq?  Because it looks big:
632
633     PrelTup.zdfEqZ1T{-rcX-}
634         = \ @ a{-reT-} :: * @ b{-reS-} :: *
635             zddEq{-rf6-} _Ks :: {PrelBase.Eq{-23-} a{-reT-}}
636             zddEq1{-rf7-} _Ks :: {PrelBase.Eq{-23-} b{-reS-}} ->
637             let {
638               zeze{-rf0-} _Kl :: (b{-reS-} -> b{-reS-} -> PrelBase.Bool{-3c-})
639               zeze{-rf0-} = PrelBase.zeze{-01L-}@ b{-reS-} zddEq1{-rf7-} } in
640             let {
641               zeze1{-rf3-} _Kl :: (a{-reT-} -> a{-reT-} -> PrelBase.Bool{-3c-})
642               zeze1{-rf3-} = PrelBase.zeze{-01L-} @ a{-reT-} zddEq{-rf6-} } in
643             let {
644               zeze2{-reN-} :: ((a{-reT-}, b{-reS-}) -> (a{-reT-}, b{-reS-})-> PrelBase.Bool{-3c-})
645               zeze2{-reN-} = \ ds{-rf5-} _Ks :: (a{-reT-}, b{-reS-})
646                                ds1{-rf4-} _Ks :: (a{-reT-}, b{-reS-}) ->
647                              case ds{-rf5-}
648                              of wild{-reW-} _Kd { (a1{-rf2-} _Ks, a2{-reZ-} _Ks) ->
649                              case ds1{-rf4-}
650                              of wild1{-reX-} _Kd { (b1{-rf1-} _Ks, b2{-reY-} _Ks) ->
651                              PrelBase.zaza{-r4e-}
652                                (zeze1{-rf3-} a1{-rf2-} b1{-rf1-})
653                                (zeze{-rf0-} a2{-reZ-} b2{-reY-})
654                              }
655                              } } in     
656             let {
657               a1{-reR-} :: ((a{-reT-}, b{-reS-})-> (a{-reT-}, b{-reS-})-> PrelBase.Bool{-3c-})
658               a1{-reR-} = \ a2{-reV-} _Ks :: (a{-reT-}, b{-reS-})
659                             b1{-reU-} _Ks :: (a{-reT-}, b{-reS-}) ->
660                           PrelBase.not{-r6I-} (zeze2{-reN-} a2{-reV-} b1{-reU-})
661             } in
662               PrelBase.zdwZCDEq{-r8J-} @ (a{-reT-}, b{-reS-}) a1{-reR-} zeze2{-reN-})
663
664 and it's not as bad as it seems, because it's further dramatically
665 simplified: only zeze2 is extracted and its body is simplified.
666
667
668 %************************************************************************
669 %*                                                                      *
670 \subsection{Error messages}
671 %*                                                                      *
672 %************************************************************************
673
674 \begin{code}
675 instDeclCtxt1 hs_inst_ty 
676   = inst_decl_ctxt (case unLoc hs_inst_ty of
677                         HsForAllTy _ _ _ (L _ (HsPredTy pred)) -> ppr pred
678                         HsPredTy pred                    -> ppr pred
679                         other                            -> ppr hs_inst_ty)     -- Don't expect this
680 instDeclCtxt2 dfun_ty
681   = inst_decl_ctxt (ppr (mkClassPred cls tys))
682   where
683     (_,_,cls,tys) = tcSplitDFunTy dfun_ty
684
685 inst_decl_ctxt doc = ptext SLIT("In the instance declaration for") <+> quotes doc
686
687 superClassCtxt = ptext SLIT("When checking the super-classes of an instance declaration")
688 \end{code}