50640a37fd17a4c4a25da78886dbe2cce4bb5a0c
[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. (Show (T a), Foo Int (Tree [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         ; rep_dict <- newDict origin (head theta)
336         ; if isSingleton theta then
337               return (unitBag (VarBind dfun_id $
338                 case maybe_co_con of
339                   Nothing -> rep_dict
340                   Just co_con -> mkCoerce rep_dict $
341                                  mkAppCoercion (mkAppsCoercion tycon rep_tys) 
342                                                (mkTyConApp co_con tvs)))
343           else do
344           let rep_dict_id  = instToId rep_dict
345               coerced_dict = case maybe_co_con of
346                                Nothing -> rep_dict_id
347                                Just co_con -> mkCoerce rep_dict_id $
348                                  mkAppCoercion (mkAppsCoercion tycon rep_tys) 
349                                                (mkTyConApp co_con tvs)
350         ; return (unitBag (VarBind dfun_id 
351           co_fn = CoTyLams tvs <.> CoLams [rep_dict_id] <.> ExprCoFn cast
352
353         ; return (unitBag (VarBind dfun_id (HsCoerce co_fn (HsVar rep_dict_id))))
354
355 tcMethods origin clas inst_tyvars' dfun_theta' inst_tys' 
356           avail_insts op_items (NewTypeDerived rep_tys)
357   = getInstLoc origin                           `thenM` \ inst_loc ->
358     mapAndUnzip3M (do_one inst_loc) op_items    `thenM` \ (meth_ids, meth_binds, rhs_insts) ->
359     
360     tcSimplifyCheck
361          (ptext SLIT("newtype derived instance"))
362          inst_tyvars' avail_insts rhs_insts     `thenM` \ lie_binds ->
363
364         -- I don't think we have to do the checkSigTyVars thing
365
366     returnM (meth_ids, lie_binds `unionBags` listToBag meth_binds)
367
368   where
369     do_one inst_loc (sel_id, _)
370         = -- The binding is like "op @ NewTy = op @ RepTy"
371                 -- Make the *binder*, like in mkMethodBind
372           tcInstClassOp inst_loc sel_id inst_tys'       `thenM` \ meth_inst ->
373
374                 -- Make the *occurrence on the rhs*
375           tcInstClassOp inst_loc sel_id rep_tys'        `thenM` \ rhs_inst ->
376           let
377              meth_id = instToId meth_inst
378           in
379           return (meth_id, noLoc (VarBind meth_id (nlHsVar (instToId rhs_inst))), rhs_inst)
380
381         -- Instantiate rep_tys with the relevant type variables
382         -- This looks a bit odd, because inst_tyvars' are the skolemised version
383         -- of the type variables in the instance declaration; but rep_tys doesn't
384         -- have the skolemised version, so we substitute them in here
385     rep_tys' = substTys subst rep_tys
386     subst    = zipOpenTvSubst inst_tyvars' (mkTyVarTys inst_tyvars')
387
388
389
390 tcInstDecl2 (InstInfo { iSpec = ispec, iBinds = VanillaInst monobinds uprags })
391   = let 
392         dfun_id    = instanceDFunId ispec
393         rigid_info = InstSkol dfun_id
394         inst_ty    = idType dfun_id
395     in
396          -- Prime error recovery
397     recoverM (returnM emptyLHsBinds)            $
398     setSrcSpan (srcLocSpan (getSrcLoc dfun_id)) $
399     addErrCtxt (instDeclCtxt2 (idType dfun_id)) $
400
401         -- Instantiate the instance decl with skolem constants 
402     tcSkolSigType rigid_info inst_ty    `thenM` \ (inst_tyvars', dfun_theta', inst_head') ->
403                 -- These inst_tyvars' scope over the 'where' part
404                 -- Those tyvars are inside the dfun_id's type, which is a bit
405                 -- bizarre, but OK so long as you realise it!
406     let
407         (clas, inst_tys') = tcSplitDFunHead inst_head'
408         (class_tyvars, sc_theta, _, op_items) = classBigSig clas
409
410         -- Instantiate the super-class context with inst_tys
411         sc_theta' = substTheta (zipOpenTvSubst class_tyvars inst_tys') sc_theta
412         origin    = SigOrigin rigid_info
413     in
414          -- Create dictionary Ids from the specified instance contexts.
415     newDicts InstScOrigin sc_theta'                     `thenM` \ sc_dicts ->
416     newDicts origin dfun_theta'                         `thenM` \ dfun_arg_dicts ->
417     newDicts origin [mkClassPred clas inst_tys']        `thenM` \ [this_dict] ->
418                 -- Default-method Ids may be mentioned in synthesised RHSs,
419                 -- but they'll already be in the environment.
420
421         -- Typecheck the methods
422     let         -- These insts are in scope; quite a few, eh?
423         avail_insts = [this_dict] ++ dfun_arg_dicts ++ sc_dicts
424     in
425     tcMethods origin clas inst_tyvars' 
426               dfun_theta' inst_tys' avail_insts 
427               op_items monobinds uprags         `thenM` \ (meth_ids, meth_binds) ->
428
429         -- Figure out bindings for the superclass context
430         -- Don't include this_dict in the 'givens', else
431         -- sc_dicts get bound by just selecting  from this_dict!!
432     addErrCtxt superClassCtxt
433         (tcSimplifySuperClasses inst_tyvars'
434                          dfun_arg_dicts
435                          sc_dicts)      `thenM` \ sc_binds ->
436
437         -- It's possible that the superclass stuff might unified one
438         -- of the inst_tyavars' with something in the envt
439     checkSigTyVars inst_tyvars'         `thenM_`
440
441         -- Deal with 'SPECIALISE instance' pragmas 
442     tcPrags dfun_id (filter isSpecInstLSig prags)       `thenM` \ prags -> 
443     
444         -- Create the result bindings
445     let
446         dict_constr   = classDataCon clas
447         scs_and_meths = map instToId sc_dicts ++ meth_ids
448         this_dict_id  = instToId this_dict
449         inline_prag | null dfun_arg_dicts = []
450                     | otherwise = [InlinePrag (Inline AlwaysActive True)]
451                 -- Always inline the dfun; this is an experimental decision
452                 -- because it makes a big performance difference sometimes.
453                 -- Often it means we can do the method selection, and then
454                 -- inline the method as well.  Marcin's idea; see comments below.
455                 --
456                 -- BUT: don't inline it if it's a constant dictionary;
457                 -- we'll get all the benefit without inlining, and we get
458                 -- a **lot** of code duplication if we inline it
459                 --
460                 --      See Note [Inline dfuns] below
461
462         dict_rhs
463           = mkHsConApp dict_constr inst_tys' (map HsVar scs_and_meths)
464                 -- We don't produce a binding for the dict_constr; instead we
465                 -- rely on the simplifier to unfold this saturated application
466                 -- We do this rather than generate an HsCon directly, because
467                 -- it means that the special cases (e.g. dictionary with only one
468                 -- member) are dealt with by the common MkId.mkDataConWrapId code rather
469                 -- than needing to be repeated here.
470
471         dict_bind  = noLoc (VarBind this_dict_id dict_rhs)
472         all_binds  = dict_bind `consBag` (sc_binds `unionBags` meth_binds)
473
474         main_bind = noLoc $ AbsBinds
475                             inst_tyvars'
476                             (map instToId dfun_arg_dicts)
477                             [(inst_tyvars', dfun_id, this_dict_id, 
478                                             inline_prag ++ prags)] 
479                             all_binds
480     in
481     showLIE (text "instance")           `thenM_`
482     returnM (unitBag main_bind)
483
484
485 tcMethods origin clas inst_tyvars' dfun_theta' inst_tys' 
486           avail_insts op_items monobinds uprags
487   =     -- Check that all the method bindings come from this class
488     let
489         sel_names = [idName sel_id | (sel_id, _) <- op_items]
490         bad_bndrs = collectHsBindBinders monobinds `minusList` sel_names
491     in
492     mappM (addErrTc . badMethodErr clas) bad_bndrs      `thenM_`
493
494         -- Make the method bindings
495     let
496         mk_method_bind = mkMethodBind origin clas inst_tys' monobinds
497     in
498     mapAndUnzipM mk_method_bind op_items        `thenM` \ (meth_insts, meth_infos) ->
499
500         -- And type check them
501         -- It's really worth making meth_insts available to the tcMethodBind
502         -- Consider     instance Monad (ST s) where
503         --                {-# INLINE (>>) #-}
504         --                (>>) = ...(>>=)...
505         -- If we don't include meth_insts, we end up with bindings like this:
506         --      rec { dict = MkD then bind ...
507         --            then = inline_me (... (GHC.Base.>>= dict) ...)
508         --            bind = ... }
509         -- The trouble is that (a) 'then' and 'dict' are mutually recursive, 
510         -- and (b) the inline_me prevents us inlining the >>= selector, which
511         -- would unravel the loop.  Result: (>>) ends up as a loop breaker, and
512         -- is not inlined across modules. Rather ironic since this does not
513         -- happen without the INLINE pragma!  
514         --
515         -- Solution: make meth_insts available, so that 'then' refers directly
516         --           to the local 'bind' rather than going via the dictionary.
517         --
518         -- BUT WATCH OUT!  If the method type mentions the class variable, then
519         -- this optimisation is not right.  Consider
520         --      class C a where
521         --        op :: Eq a => a
522         --
523         --      instance C Int where
524         --        op = op
525         -- The occurrence of 'op' on the rhs gives rise to a constraint
526         --      op at Int
527         -- The trouble is that the 'meth_inst' for op, which is 'available', also
528         -- looks like 'op at Int'.  But they are not the same.
529     let
530         prag_fn        = mkPragFun uprags
531         all_insts      = avail_insts ++ catMaybes meth_insts
532         sig_fn n       = Just []        -- No scoped type variables, but every method has
533                                         -- a type signature, in effect, so that we check
534                                         -- the method has the right type
535         tc_method_bind = tcMethodBind inst_tyvars' dfun_theta' all_insts sig_fn prag_fn
536         meth_ids       = [meth_id | (_,meth_id,_) <- meth_infos]
537     in
538
539     mapM tc_method_bind meth_infos              `thenM` \ meth_binds_s ->
540    
541     returnM (meth_ids, unionManyBags meth_binds_s)
542 v v v v v v v
543 *************
544
545
546 -- Derived newtype instances
547 tcMethods origin clas inst_tyvars' dfun_theta' inst_tys' 
548           avail_insts op_items (NewTypeDerived maybe_co rep_tys)
549   = getInstLoc origin                           `thenM` \ inst_loc ->
550     mapAndUnzip3M (do_one inst_loc) op_items    `thenM` \ (meth_ids, meth_binds, rhs_insts) ->
551     
552     tcSimplifyCheck
553          (ptext SLIT("newtype derived instance"))
554          inst_tyvars' avail_insts rhs_insts     `thenM` \ lie_binds ->
555
556         -- I don't think we have to do the checkSigTyVars thing
557
558     returnM (meth_ids, lie_binds `unionBags` listToBag meth_binds)
559
560   where
561     do_one inst_loc (sel_id, _)
562         = -- The binding is like "op @ NewTy = op @ RepTy"
563                 -- Make the *binder*, like in mkMethodBind
564           tcInstClassOp inst_loc sel_id inst_tys'       `thenM` \ meth_inst ->
565
566                 -- Make the *occurrence on the rhs*
567           tcInstClassOp inst_loc sel_id rep_tys'        `thenM` \ rhs_inst ->
568           let
569              meth_id = instToId meth_inst
570           in
571           return (meth_id, noLoc (VarBind meth_id (nlHsVar (instToId rhs_inst))), rhs_inst)
572
573         -- Instantiate rep_tys with the relevant type variables
574         -- This looks a bit odd, because inst_tyvars' are the skolemised version
575         -- of the type variables in the instance declaration; but rep_tys doesn't
576         -- have the skolemised version, so we substitute them in here
577     rep_tys' = substTys subst rep_tys
578     subst    = zipOpenTvSubst inst_tyvars' (mkTyVarTys inst_tyvars')
579 ^ ^ ^ ^ ^ ^ ^
580 \end{code}
581
582
583                 ------------------------------
584         [Inline dfuns] Inlining dfuns unconditionally
585                 ------------------------------
586
587 The code above unconditionally inlines dict funs.  Here's why.
588 Consider this program:
589
590     test :: Int -> Int -> Bool
591     test x y = (x,y) == (y,x) || test y x
592     -- Recursive to avoid making it inline.
593
594 This needs the (Eq (Int,Int)) instance.  If we inline that dfun
595 the code we end up with is good:
596
597     Test.$wtest =
598         \r -> case ==# [ww ww1] of wild {
599                 PrelBase.False -> Test.$wtest ww1 ww;
600                 PrelBase.True ->
601                   case ==# [ww1 ww] of wild1 {
602                     PrelBase.False -> Test.$wtest ww1 ww;
603                     PrelBase.True -> PrelBase.True [];
604                   };
605             };
606     Test.test = \r [w w1]
607             case w of w2 {
608               PrelBase.I# ww ->
609                   case w1 of w3 { PrelBase.I# ww1 -> Test.$wtest ww ww1; };
610             };
611
612 If we don't inline the dfun, the code is not nearly as good:
613
614     (==) = case PrelTup.$fEq(,) PrelBase.$fEqInt PrelBase.$fEqInt of tpl {
615               PrelBase.:DEq tpl1 tpl2 -> tpl2;
616             };
617     
618     Test.$wtest =
619         \r [ww ww1]
620             let { y = PrelBase.I#! [ww1]; } in
621             let { x = PrelBase.I#! [ww]; } in
622             let { sat_slx = PrelTup.(,)! [y x]; } in
623             let { sat_sly = PrelTup.(,)! [x y];
624             } in
625               case == sat_sly sat_slx of wild {
626                 PrelBase.False -> Test.$wtest ww1 ww;
627                 PrelBase.True -> PrelBase.True [];
628               };
629     
630     Test.test =
631         \r [w w1]
632             case w of w2 {
633               PrelBase.I# ww ->
634                   case w1 of w3 { PrelBase.I# ww1 -> Test.$wtest ww ww1; };
635             };
636
637 Why doesn't GHC inline $fEq?  Because it looks big:
638
639     PrelTup.zdfEqZ1T{-rcX-}
640         = \ @ a{-reT-} :: * @ b{-reS-} :: *
641             zddEq{-rf6-} _Ks :: {PrelBase.Eq{-23-} a{-reT-}}
642             zddEq1{-rf7-} _Ks :: {PrelBase.Eq{-23-} b{-reS-}} ->
643             let {
644               zeze{-rf0-} _Kl :: (b{-reS-} -> b{-reS-} -> PrelBase.Bool{-3c-})
645               zeze{-rf0-} = PrelBase.zeze{-01L-}@ b{-reS-} zddEq1{-rf7-} } in
646             let {
647               zeze1{-rf3-} _Kl :: (a{-reT-} -> a{-reT-} -> PrelBase.Bool{-3c-})
648               zeze1{-rf3-} = PrelBase.zeze{-01L-} @ a{-reT-} zddEq{-rf6-} } in
649             let {
650               zeze2{-reN-} :: ((a{-reT-}, b{-reS-}) -> (a{-reT-}, b{-reS-})-> PrelBase.Bool{-3c-})
651               zeze2{-reN-} = \ ds{-rf5-} _Ks :: (a{-reT-}, b{-reS-})
652                                ds1{-rf4-} _Ks :: (a{-reT-}, b{-reS-}) ->
653                              case ds{-rf5-}
654                              of wild{-reW-} _Kd { (a1{-rf2-} _Ks, a2{-reZ-} _Ks) ->
655                              case ds1{-rf4-}
656                              of wild1{-reX-} _Kd { (b1{-rf1-} _Ks, b2{-reY-} _Ks) ->
657                              PrelBase.zaza{-r4e-}
658                                (zeze1{-rf3-} a1{-rf2-} b1{-rf1-})
659                                (zeze{-rf0-} a2{-reZ-} b2{-reY-})
660                              }
661                              } } in     
662             let {
663               a1{-reR-} :: ((a{-reT-}, b{-reS-})-> (a{-reT-}, b{-reS-})-> PrelBase.Bool{-3c-})
664               a1{-reR-} = \ a2{-reV-} _Ks :: (a{-reT-}, b{-reS-})
665                             b1{-reU-} _Ks :: (a{-reT-}, b{-reS-}) ->
666                           PrelBase.not{-r6I-} (zeze2{-reN-} a2{-reV-} b1{-reU-})
667             } in
668               PrelBase.zdwZCDEq{-r8J-} @ (a{-reT-}, b{-reS-}) a1{-reR-} zeze2{-reN-})
669
670 and it's not as bad as it seems, because it's further dramatically
671 simplified: only zeze2 is extracted and its body is simplified.
672
673
674 %************************************************************************
675 %*                                                                      *
676 \subsection{Error messages}
677 %*                                                                      *
678 %************************************************************************
679
680 \begin{code}
681 instDeclCtxt1 hs_inst_ty 
682   = inst_decl_ctxt (case unLoc hs_inst_ty of
683                         HsForAllTy _ _ _ (L _ (HsPredTy pred)) -> ppr pred
684                         HsPredTy pred                    -> ppr pred
685                         other                            -> ppr hs_inst_ty)     -- Don't expect this
686 instDeclCtxt2 dfun_ty
687   = inst_decl_ctxt (ppr (mkClassPred cls tys))
688   where
689     (_,_,cls,tys) = tcSplitDFunTy dfun_ty
690
691 inst_decl_ctxt doc = ptext SLIT("In the instance declaration for") <+> quotes doc
692
693 superClassCtxt = ptext SLIT("When checking the super-classes of an instance declaration")
694 \end{code}