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, tcAddDeclCtxt ) where
   8
   9 #include "HsVersions.h"
  10
  11
  12 import CmdLineOpts      ( DynFlag(..) )
  13
  14 import HsSyn            ( HsDecl(..), InstDecl(..), TyClDecl(..), HsType(..),
  15                           MonoBinds(..), HsExpr(..),  HsLit(..), Sig(..), HsTyVarBndr(..),
  16                           andMonoBindList, collectMonoBinders, isClassDecl, toHsType
  17                         )
  18 import RnHsSyn          ( RenamedHsBinds, RenamedInstDecl, RenamedHsDecl,
  19                           RenamedMonoBinds, RenamedTyClDecl, RenamedHsType,
  20                           extractHsTyVars, maybeGenericMatch
  21                         )
  22 import TcHsSyn          ( TcMonoBinds, mkHsConApp )
  23 import TcBinds          ( tcSpecSigs )
  24 import TcClassDcl       ( tcMethodBind, badMethodErr )
  25 import TcMonad
  26 import TcMType          ( tcInstSigTyVars, checkValidTheta, checkValidInstHead, instTypeErr,
  27                           UserTypeCtxt(..), SourceTyCtxt(..) )
  28 import TcType           ( tcSplitDFunTy, mkClassPred, mkTyVarTy, mkTyVarTys,
  29                           tcSplitSigmaTy, tcSplitPredTy_maybe, getClassPredTys,
  30                           TyVarDetails(..)
  31                         )
  32 import Inst             ( InstOrigin(..),
  33                           newDicts, instToId,
  34                           LIE, mkLIE, emptyLIE, plusLIE, plusLIEs )
  35 import TcDeriv          ( tcDeriving )
  36 import TcEnv            ( TcEnv, tcExtendGlobalValEnv,
  37                           tcExtendTyVarEnvForMeths,
  38                           tcAddImportedIdInfo, tcLookupClass,
  39                           InstInfo(..), pprInstInfo, simpleInstInfoTyCon,
  40                           simpleInstInfoTy, newDFunName,
  41                           isLocalThing,
  42                         )
  43 import InstEnv          ( InstEnv, extendInstEnv )
  44 import PprType          ( pprClassPred )
  45 import TcMonoType       ( tcHsTyVars, kcHsSigType, tcHsType, tcHsSigType )
  46 import TcUnify          ( checkSigTyVars )
  47 import TcSimplify       ( tcSimplifyCheck )
  48 import HscTypes         ( HomeSymbolTable, DFunId,
  49                           ModDetails(..), PackageInstEnv, PersistentRenamerState
  50                         )
  51
  52 import Subst            ( substTy, substTheta )
  53 import DataCon          ( classDataCon )
  54 import Class            ( Class, classBigSig )
  55 import Var              ( idName, idType )
  56 import VarSet           ( emptyVarSet )
  57 import Id               ( setIdLocalExported )
  58 import MkId             ( mkDictFunId )
  59 import FunDeps          ( checkInstFDs )
  60 import Generics         ( validGenericInstanceType )
  61 import Module           ( Module, foldModuleEnv )
  62 import Name             ( getSrcLoc )
  63 import NameSet          ( unitNameSet, emptyNameSet, nameSetToList )
  64 import PrelInfo         ( eRROR_ID )
  65 import TyCon            ( TyCon )
  66 import Subst            ( mkTopTyVarSubst, substTheta )
  67 import TysWiredIn       ( genericTyCons )
  68 import Name             ( Name )
  69 import SrcLoc           ( SrcLoc )
  70 import Unique           ( Uniquable(..) )
  71 import Util             ( lengthExceeds )
  72 import BasicTypes       ( NewOrData(..), Fixity )
  73 import ErrUtils         ( dumpIfSet_dyn )
  74 import ListSetOps       ( Assoc, emptyAssoc, plusAssoc_C, mapAssoc,
  75                           assocElts, extendAssoc_C,
  76                           equivClassesByUniq, minusList
  77                         )
  78 import List             ( partition )
  79 import Outputable
  80 \end{code}
  81
  82 Typechecking instance declarations is done in two passes. The first
  83 pass, made by @tcInstDecls1@, collects information to be used in the
  84 second pass.
  85
  86 This pre-processed info includes the as-yet-unprocessed bindings
  87 inside the instance declaration.  These are type-checked in the second
  88 pass, when the class-instance envs and GVE contain all the info from
  89 all the instance and value decls.  Indeed that's the reason we need
  90 two passes over the instance decls.
  91
  92
  93 Here is the overall algorithm.
  94 Assume that we have an instance declaration
  95
  96     instance c => k (t tvs) where b
  97
  98 \begin{enumerate}
  99 \item
 100 $LIE_c$ is the LIE for the context of class $c$
 101 \item
 102 $betas_bar$ is the free variables in the class method type, excluding the
 103    class variable
 104 \item
 105 $LIE_cop$ is the LIE constraining a particular class method
 106 \item
 107 $tau_cop$ is the tau type of a class method
 108 \item
 109 $LIE_i$ is the LIE for the context of instance $i$
 110 \item
 111 $X$ is the instance constructor tycon
 112 \item
 113 $gammas_bar$ is the set of type variables of the instance
 114 \item
 115 $LIE_iop$ is the LIE for a particular class method instance
 116 \item
 117 $tau_iop$ is the tau type for this instance of a class method
 118 \item
 119 $alpha$ is the class variable
 120 \item
 121 $LIE_cop' = LIE_cop [X gammas_bar / alpha, fresh betas_bar]$
 122 \item
 123 $tau_cop' = tau_cop [X gammas_bar / alpha, fresh betas_bar]$
 124 \end{enumerate}
 125
 126 ToDo: Update the list above with names actually in the code.
 127
 128 \begin{enumerate}
 129 \item
 130 First, make the LIEs for the class and instance contexts, which means
 131 instantiate $thetaC [X inst_tyvars / alpha ]$, yielding LIElistC' and LIEC',
 132 and make LIElistI and LIEI.
 133 \item
 134 Then process each method in turn.
 135 \item
 136 order the instance methods according to the ordering of the class methods
 137 \item
 138 express LIEC' in terms of LIEI, yielding $dbinds_super$ or an error
 139 \item
 140 Create final dictionary function from bindings generated already
 141 \begin{pseudocode}
 142 df = lambda inst_tyvars
 143        lambda LIEI
 144          let Bop1
 145              Bop2
 146              ...
 147              Bopn
 148          and dbinds_super
 149               in <op1,op2,...,opn,sd1,...,sdm>
 150 \end{pseudocode}
 151 Here, Bop1 \ldots Bopn bind the methods op1 \ldots opn,
 152 and $dbinds_super$ bind the superclass dictionaries sd1 \ldots sdm.
 153 \end{enumerate}
 154
 155
 156 %************************************************************************
 157 %*                                                                      *
 158 \subsection{Extracting instance decls}
 159 %*                                                                      *
 160 %************************************************************************
 161
 162 Gather up the instance declarations from their various sources
 163
 164 \begin{code}
 165 tcInstDecls1 :: PackageInstEnv
 166              -> PersistentRenamerState
 167              -> HomeSymbolTable         -- Contains instances
 168              -> TcEnv                   -- Contains IdInfo for dfun ids
 169              -> (Name -> Maybe Fixity)  -- for deriving Show and Read
 170              -> Module                  -- Module for deriving
 171              -> [RenamedHsDecl]
 172              -> TcM (PackageInstEnv, InstEnv, [InstInfo], RenamedHsBinds)
 173
 174 tcInstDecls1 inst_env0 prs hst unf_env get_fixity this_mod decls
 175   = let
 176         inst_decls = [inst_decl | InstD inst_decl <- decls]
 177         tycl_decls = [decl      | TyClD decl <- decls]
 178         clas_decls = filter isClassDecl tycl_decls
 179     in
 180         -- (1) Do the ordinary instance declarations
 181     mapNF_Tc tcInstDecl1 inst_decls             `thenNF_Tc` \ inst_infos ->
 182
 183         -- (2) Instances from generic class declarations
 184     getGenericInstances clas_decls              `thenTc` \ generic_inst_info ->
 185
 186         -- Next, construct the instance environment so far, consisting of
 187         --      a) cached non-home-package InstEnv (gotten from pcs)    pcs_insts pcs
 188         --      b) imported instance decls (not in the home package)    inst_env1
 189         --      c) other modules in this package (gotten from hst)      inst_env2
 190         --      d) local instance decls                                 inst_env3
 191         --      e) generic instances                                    inst_env4
 192         -- The result of (b) replaces the cached InstEnv in the PCS
 193     let
 194         (local_inst_info, imported_inst_info)
 195                 = partition (isLocalThing this_mod . iDFunId) (concat inst_infos)
 196
 197         imported_dfuns   = map (tcAddImportedIdInfo unf_env . iDFunId)
 198                                imported_inst_info
 199         hst_dfuns        = foldModuleEnv ((++) . md_insts) [] hst
 200     in
 201
 202 --    pprTrace "tcInstDecls" (vcat [ppr imported_dfuns, ppr hst_dfuns]) $
 203
 204     addInstDFuns inst_env0 imported_dfuns       `thenNF_Tc` \ inst_env1 ->
 205     addInstDFuns inst_env1 hst_dfuns            `thenNF_Tc` \ inst_env2 ->
 206     addInstInfos inst_env2 local_inst_info      `thenNF_Tc` \ inst_env3 ->
 207     addInstInfos inst_env3 generic_inst_info    `thenNF_Tc` \ inst_env4 ->
 208
 209         -- (3) Compute instances from "deriving" clauses;
 210         --     note that we only do derivings for things in this module;
 211         --     we ignore deriving decls from interfaces!
 212         -- This stuff computes a context for the derived instance decl, so it
 213         -- needs to know about all the instances possible; hecne inst_env4
 214     tcDeriving prs this_mod inst_env4 get_fixity tycl_decls
 215                                         `thenTc` \ (deriv_inst_info, deriv_binds) ->
 216     addInstInfos inst_env4 deriv_inst_info              `thenNF_Tc` \ final_inst_env ->
 217
 218     returnTc (inst_env1,
 219               final_inst_env,
 220               generic_inst_info ++ deriv_inst_info ++ local_inst_info,
 221               deriv_binds)
 222
 223 addInstInfos :: InstEnv -> [InstInfo] -> NF_TcM InstEnv
 224 addInstInfos inst_env infos = addInstDFuns inst_env (map iDFunId infos)
 225
 226 addInstDFuns :: InstEnv -> [DFunId] -> NF_TcM InstEnv
 227 addInstDFuns inst_env dfuns
 228   = getDOptsTc                          `thenTc` \ dflags ->
 229     let
 230         (inst_env', errs) = extendInstEnv dflags inst_env dfuns
 231     in
 232     addErrsTc errs                      `thenNF_Tc_`
 233     traceTc (text "Adding instances:" <+> vcat (map pp dfuns))  `thenTc_`
 234     returnTc inst_env'
 235   where
 236     pp dfun = ppr dfun <+> dcolon <+> ppr (idType dfun)
 237 \end{code}
 238
 239 \begin{code}
 240 tcInstDecl1 :: RenamedInstDecl -> NF_TcM [InstInfo]
 241 -- Deal with a single instance declaration
 242 -- Type-check all the stuff before the "where"
 243 tcInstDecl1 decl@(InstDecl poly_ty binds uprags maybe_dfun_name src_loc)
 244   =     -- Prime error recovery, set source location
 245     recoverNF_Tc (returnNF_Tc [])       $
 246     tcAddSrcLoc src_loc                 $
 247     tcAddErrCtxt (instDeclCtxt poly_ty) $
 248
 249         -- Typecheck the instance type itself.  We can't use
 250         -- tcHsSigType, because it's not a valid user type.
 251     kcHsSigType poly_ty                 `thenTc_`
 252     tcHsType poly_ty                    `thenTc` \ poly_ty' ->
 253     let
 254         (tyvars, theta, tau) = tcSplitSigmaTy poly_ty'
 255         (clas,inst_tys)      = case tcSplitPredTy_maybe tau of { Just st -> getClassPredTys st }
 256                 -- The checkValidInstHead makes sure these splits succeed
 257     in
 258     (case maybe_dfun_name of
 259         Nothing ->      -- A source-file instance declaration
 260                 -- Check for respectable instance type, and context
 261                 -- but only do this for non-imported instance decls.
 262                 -- Imported ones should have been checked already, and may indeed
 263                 -- contain something illegal in normal Haskell, notably
 264                 --      instance CCallable [Char]
 265             checkValidTheta InstThetaCtxt theta         `thenTc_`
 266             checkValidInstHead tau                      `thenTc_`
 267             checkTc (checkInstFDs theta clas inst_tys)
 268                     (instTypeErr (pprClassPred clas inst_tys) msg)      `thenTc_`
 269             newDFunName clas inst_tys src_loc
 270
 271         Just dfun_name ->       -- An interface-file instance declaration
 272                             returnNF_Tc dfun_name
 273     )                                                           `thenNF_Tc` \ dfun_name ->
 274     let
 275         dfun_id = mkDictFunId dfun_name clas tyvars inst_tys theta
 276     in
 277     returnTc [InstInfo { iDFunId = dfun_id, iBinds = binds, iPrags = uprags }]
 278   where
 279     msg  = parens (ptext SLIT("the instance types do not agree with the functional dependencies of the class"))
 280 \end{code}
 281
 282
 283 %************************************************************************
 284 %*                                                                      *
 285 \subsection{Extracting generic instance declaration from class declarations}
 286 %*                                                                      *
 287 %************************************************************************
 288
 289 @getGenericInstances@ extracts the generic instance declarations from a class
 290 declaration.  For exmaple
 291
 292         class C a where
 293           op :: a -> a
 294
 295           op{ x+y } (Inl v)   = ...
 296           op{ x+y } (Inr v)   = ...
 297           op{ x*y } (v :*: w) = ...
 298           op{ 1   } Unit      = ...
 299
 300 gives rise to the instance declarations
 301
 302         instance C (x+y) where
 303           op (Inl v)   = ...
 304           op (Inr v)   = ...
 305
 306         instance C (x*y) where
 307           op (v :*: w) = ...
 308
 309         instance C 1 where
 310           op Unit      = ...
 311
 312
 313 \begin{code}
 314 getGenericInstances :: [RenamedTyClDecl] -> TcM [InstInfo]
 315 getGenericInstances class_decls
 316   = mapTc get_generics class_decls              `thenTc` \ gen_inst_infos ->
 317     let
 318         gen_inst_info = concat gen_inst_infos
 319     in
 320     if null gen_inst_info then
 321         returnTc []
 322     else
 323     getDOptsTc                                          `thenTc`  \ dflags ->
 324     ioToTc (dumpIfSet_dyn dflags Opt_D_dump_deriv "Generic instances"
 325                       (vcat (map pprInstInfo gen_inst_info)))
 326                                                         `thenNF_Tc_`
 327     returnTc gen_inst_info
 328
 329 get_generics decl@(ClassDecl {tcdMeths = Nothing})
 330   = returnTc [] -- Imported class decls
 331
 332 get_generics decl@(ClassDecl {tcdName = class_name, tcdMeths = Just def_methods, tcdLoc = loc})
 333   | null groups
 334   = returnTc [] -- The comon case: no generic default methods
 335
 336   | otherwise   -- A source class decl with generic default methods
 337   = recoverNF_Tc (returnNF_Tc [])                               $
 338     tcAddDeclCtxt decl                                          $
 339     tcLookupClass class_name                                    `thenTc` \ clas ->
 340
 341         -- Make an InstInfo out of each group
 342     mapTc (mkGenericInstance clas loc) groups           `thenTc` \ inst_infos ->
 343
 344         -- Check that there is only one InstInfo for each type constructor
 345         -- The main way this can fail is if you write
 346         --      f {| a+b |} ... = ...
 347         --      f {| x+y |} ... = ...
 348         -- Then at this point we'll have an InstInfo for each
 349     let
 350         tc_inst_infos :: [(TyCon, InstInfo)]
 351         tc_inst_infos = [(simpleInstInfoTyCon i, i) | i <- inst_infos]
 352
 353         bad_groups = [group | group <- equivClassesByUniq get_uniq tc_inst_infos,
 354                               group `lengthExceeds` 1]
 355         get_uniq (tc,_) = getUnique tc
 356     in
 357     mapTc (addErrTc . dupGenericInsts) bad_groups       `thenTc_`
 358
 359         -- Check that there is an InstInfo for each generic type constructor
 360     let
 361         missing = genericTyCons `minusList` [tc | (tc,_) <- tc_inst_infos]
 362     in
 363     checkTc (null missing) (missingGenericInstances missing)    `thenTc_`
 364
 365     returnTc inst_infos
 366
 367   where
 368         -- Group the declarations by type pattern
 369         groups :: [(RenamedHsType, RenamedMonoBinds)]
 370         groups = assocElts (getGenericBinds def_methods)
 371
 372
 373 ---------------------------------
 374 getGenericBinds :: RenamedMonoBinds -> Assoc RenamedHsType RenamedMonoBinds
 375   -- Takes a group of method bindings, finds the generic ones, and returns
 376   -- them in finite map indexed by the type parameter in the definition.
 377
 378 getGenericBinds EmptyMonoBinds    = emptyAssoc
 379 getGenericBinds (AndMonoBinds m1 m2)
 380   = plusAssoc_C AndMonoBinds (getGenericBinds m1) (getGenericBinds m2)
 381
 382 getGenericBinds (FunMonoBind id infixop matches loc)
 383   = mapAssoc wrap (foldl add emptyAssoc matches)
 384         -- Using foldl not foldr is vital, else
 385         -- we reverse the order of the bindings!
 386   where
 387     add env match = case maybeGenericMatch match of
 388                       Nothing           -> env
 389                       Just (ty, match') -> extendAssoc_C (++) env (ty, [match'])
 390
 391     wrap ms = FunMonoBind id infixop ms loc
 392
 393 ---------------------------------
 394 mkGenericInstance :: Class -> SrcLoc
 395                   -> (RenamedHsType, RenamedMonoBinds)
 396                   -> TcM InstInfo
 397
 398 mkGenericInstance clas loc (hs_ty, binds)
 399   -- Make a generic instance declaration
 400   -- For example:       instance (C a, C b) => C (a+b) where { binds }
 401
 402   =     -- Extract the universally quantified type variables
 403     let
 404         sig_tvs = map UserTyVar (nameSetToList (extractHsTyVars hs_ty))
 405     in
 406     tcHsTyVars sig_tvs (kcHsSigType hs_ty)      $ \ tyvars ->
 407
 408         -- Type-check the instance type, and check its form
 409     tcHsSigType GenPatCtxt hs_ty                `thenTc` \ inst_ty ->
 410     checkTc (validGenericInstanceType inst_ty)
 411             (badGenericInstanceType binds)      `thenTc_`
 412
 413         -- Make the dictionary function.
 414     newDFunName clas [inst_ty] loc              `thenNF_Tc` \ dfun_name ->
 415     let
 416         inst_theta = [mkClassPred clas [mkTyVarTy tv] | tv <- tyvars]
 417         inst_tys   = [inst_ty]
 418         dfun_id    = mkDictFunId dfun_name clas tyvars inst_tys inst_theta
 419     in
 420
 421     returnTc (InstInfo { iDFunId = dfun_id,
 422                          iBinds = binds, iPrags = [] })
 423 \end{code}
 424
 425
 426 %************************************************************************
 427 %*                                                                      *
 428 \subsection{Type-checking instance declarations, pass 2}
 429 %*                                                                      *
 430 %************************************************************************
 431
 432 \begin{code}
 433 tcInstDecls2 :: [InstInfo]
 434              -> NF_TcM (LIE, TcMonoBinds)
 435
 436 tcInstDecls2 inst_decls
 437 --  = foldBag combine tcInstDecl2 (returnNF_Tc (emptyLIE, EmptyMonoBinds)) inst_decls
 438   = foldr combine (returnNF_Tc (emptyLIE, EmptyMonoBinds))
 439           (map tcInstDecl2 inst_decls)
 440   where
 441     combine tc1 tc2 = tc1       `thenNF_Tc` \ (lie1, binds1) ->
 442                       tc2       `thenNF_Tc` \ (lie2, binds2) ->
 443                       returnNF_Tc (lie1 `plusLIE` lie2,
 444                                    binds1 `AndMonoBinds` binds2)
 445 \end{code}
 446
 447 ======= New documentation starts here (Sept 92)  ==============
 448
 449 The main purpose of @tcInstDecl2@ is to return a @HsBinds@ which defines
 450 the dictionary function for this instance declaration.  For example
 451 \begin{verbatim}
 452         instance Foo a => Foo [a] where
 453                 op1 x = ...
 454                 op2 y = ...
 455 \end{verbatim}
 456 might generate something like
 457 \begin{verbatim}
 458         dfun.Foo.List dFoo_a = let op1 x = ...
 459                                    op2 y = ...
 460                                in
 461                                    Dict [op1, op2]
 462 \end{verbatim}
 463
 464 HOWEVER, if the instance decl has no context, then it returns a
 465 bigger @HsBinds@ with declarations for each method.  For example
 466 \begin{verbatim}
 467         instance Foo [a] where
 468                 op1 x = ...
 469                 op2 y = ...
 470 \end{verbatim}
 471 might produce
 472 \begin{verbatim}
 473         dfun.Foo.List a = Dict [Foo.op1.List a, Foo.op2.List a]
 474         const.Foo.op1.List a x = ...
 475         const.Foo.op2.List a y = ...
 476 \end{verbatim}
 477 This group may be mutually recursive, because (for example) there may
 478 be no method supplied for op2 in which case we'll get
 479 \begin{verbatim}
 480         const.Foo.op2.List a = default.Foo.op2 (dfun.Foo.List a)
 481 \end{verbatim}
 482 that is, the default method applied to the dictionary at this type.
 483
 484 What we actually produce in either case is:
 485
 486         AbsBinds [a] [dfun_theta_dicts]
 487                  [(dfun.Foo.List, d)] ++ (maybe) [(const.Foo.op1.List, op1), ...]
 488                  { d = (sd1,sd2, ..., op1, op2, ...)
 489                    op1 = ...
 490                    op2 = ...
 491                  }
 492
 493 The "maybe" says that we only ask AbsBinds to make global constant methods
 494 if the dfun_theta is empty.
 495
 496
 497 For an instance declaration, say,
 498
 499         instance (C1 a, C2 b) => C (T a b) where
 500                 ...
 501
 502 where the {\em immediate} superclasses of C are D1, D2, we build a dictionary
 503 function whose type is
 504
 505         (C1 a, C2 b, D1 (T a b), D2 (T a b)) => C (T a b)
 506
 507 Notice that we pass it the superclass dictionaries at the instance type; this
 508 is the ``Mark Jones optimisation''.  The stuff before the "=>" here
 509 is the @dfun_theta@ below.
 510
 511 First comes the easy case of a non-local instance decl.
 512
 513
 514 \begin{code}
 515 tcInstDecl2 :: InstInfo -> NF_TcM (LIE, TcMonoBinds)
 516 -- tcInstDecl2 is called *only* on InstInfos
 517
 518 tcInstDecl2 (InstInfo { iDFunId = dfun_id,
 519                         iBinds = monobinds, iPrags = uprags })
 520   =      -- Prime error recovery
 521     recoverNF_Tc (returnNF_Tc (emptyLIE, EmptyMonoBinds))       $
 522     tcAddSrcLoc (getSrcLoc dfun_id)                             $
 523     tcAddErrCtxt (instDeclCtxt (toHsType (idType dfun_id)))     $
 524
 525         -- Instantiate the instance decl with tc-style type variables
 526     let
 527         (inst_tyvars, dfun_theta, clas, inst_tys) = tcSplitDFunTy (idType dfun_id)
 528     in
 529     tcInstSigTyVars InstTv inst_tyvars          `thenNF_Tc` \ inst_tyvars' ->
 530     let
 531         tenv        = mkTopTyVarSubst inst_tyvars (mkTyVarTys inst_tyvars')
 532         inst_tys'   = map (substTy tenv) inst_tys
 533         dfun_theta' = substTheta tenv dfun_theta
 534         origin      = InstanceDeclOrigin
 535
 536         (class_tyvars, sc_theta, _, op_items) = classBigSig clas
 537
 538         sel_names = [idName sel_id | (sel_id, _) <- op_items]
 539
 540         -- Instantiate the super-class context with inst_tys
 541         sc_theta' = substTheta (mkTopTyVarSubst class_tyvars inst_tys') sc_theta
 542
 543         -- Find any definitions in monobinds that aren't from the class
 544         bad_bndrs = collectMonoBinders monobinds `minusList` sel_names
 545     in
 546          -- Check that all the method bindings come from this class
 547     mapTc (addErrTc . badMethodErr clas) bad_bndrs              `thenNF_Tc_`
 548
 549          -- Create dictionary Ids from the specified instance contexts.
 550     newDicts origin sc_theta'                    `thenNF_Tc` \ sc_dicts ->
 551     newDicts origin dfun_theta'                  `thenNF_Tc` \ dfun_arg_dicts ->
 552     newDicts origin [mkClassPred clas inst_tys'] `thenNF_Tc` \ [this_dict] ->
 553
 554     tcExtendTyVarEnvForMeths inst_tyvars inst_tyvars' (
 555         -- The type variable from the dict fun actually scope
 556         -- over the bindings.  They were gotten from
 557         -- the original instance declaration
 558
 559                 -- Default-method Ids may be mentioned in synthesised RHSs,
 560                 -- but they'll already be in the environment.
 561
 562         mapAndUnzip3Tc (tcMethodBind clas origin inst_tyvars' inst_tys'
 563                                      dfun_theta'
 564                                      monobinds uprags True)
 565                        op_items
 566     )                   `thenTc` \ (method_binds_s, insts_needed_s, meth_insts) ->
 567
 568         -- Deal with SPECIALISE instance pragmas by making them
 569         -- look like SPECIALISE pragmas for the dfun
 570     let
 571         dfun_prags = [SpecSig (idName dfun_id) ty loc | SpecInstSig ty loc <- uprags]
 572     in
 573     tcExtendGlobalValEnv [dfun_id] (
 574         tcSpecSigs dfun_prags
 575     )                                   `thenTc` \ (prag_binds, prag_lie) ->
 576
 577         -- Check the overloading constraints of the methods and superclasses
 578     let
 579                  -- These insts are in scope; quite a few, eh?
 580         avail_insts = [this_dict] ++
 581                       dfun_arg_dicts ++
 582                       sc_dicts ++
 583                       meth_insts
 584
 585         methods_lie    = plusLIEs insts_needed_s
 586     in
 587
 588         -- Simplify the constraints from methods
 589     tcAddErrCtxt methodCtxt (
 590       tcSimplifyCheck
 591                  (ptext SLIT("instance declaration context"))
 592                  inst_tyvars'
 593                  avail_insts
 594                  methods_lie
 595     )                                            `thenTc` \ (const_lie1, lie_binds1) ->
 596
 597         -- Figure out bindings for the superclass context
 598     tcAddErrCtxt superClassCtxt (
 599       tcSimplifyCheck
 600                  (ptext SLIT("instance declaration context"))
 601                  inst_tyvars'
 602                  dfun_arg_dicts         -- NB! Don't include this_dict here, else the sc_dicts
 603                                         -- get bound by just selecting from this_dict!!
 604                  (mkLIE sc_dicts)
 605     )                                           `thenTc` \ (const_lie2, lie_binds2) ->
 606
 607     checkSigTyVars inst_tyvars' emptyVarSet     `thenNF_Tc` \ zonked_inst_tyvars ->
 608
 609         -- Create the result bindings
 610     let
 611         local_dfun_id = setIdLocalExported dfun_id
 612                 -- Reason for setIdLocalExported: see notes with MkId.mkDictFunId
 613
 614         dict_constr   = classDataCon clas
 615         scs_and_meths = map instToId (sc_dicts ++ meth_insts)
 616         this_dict_id  = instToId this_dict
 617         inlines       | null dfun_arg_dicts = emptyNameSet
 618                       | otherwise           = unitNameSet (idName dfun_id)
 619                 -- Always inline the dfun; this is an experimental decision
 620                 -- because it makes a big performance difference sometimes.
 621                 -- Often it means we can do the method selection, and then
 622                 -- inline the method as well.  Marcin's idea; see comments below.
 623                 --
 624                 -- BUT: don't inline it if it's a constant dictionary;
 625                 -- we'll get all the benefit without inlining, and we get
 626                 -- a **lot** of code duplication if we inline it
 627
 628         dict_rhs
 629           | null scs_and_meths
 630           =     -- Blatant special case for CCallable, CReturnable
 631                 -- If the dictionary is empty then we should never
 632                 -- select anything from it, so we make its RHS just
 633                 -- emit an error message.  This in turn means that we don't
 634                 -- mention the constructor, which doesn't exist for CCallable, CReturnable
 635                 -- Hardly beautiful, but only three extra lines.
 636             HsApp (TyApp (HsVar eRROR_ID) [idType this_dict_id])
 637                   (HsLit (HsString msg))
 638
 639           | otherwise   -- The common case
 640           = mkHsConApp dict_constr inst_tys' (map HsVar scs_and_meths)
 641                 -- We don't produce a binding for the dict_constr; instead we
 642                 -- rely on the simplifier to unfold this saturated application
 643                 -- We do this rather than generate an HsCon directly, because
 644                 -- it means that the special cases (e.g. dictionary with only one
 645                 -- member) are dealt with by the common MkId.mkDataConWrapId code rather
 646                 -- than needing to be repeated here.
 647
 648           where
 649             msg = _PK_ ("Compiler error: bad dictionary " ++ showSDoc (ppr clas))
 650
 651         dict_bind    = VarMonoBind this_dict_id dict_rhs
 652         method_binds = andMonoBindList method_binds_s
 653
 654         main_bind
 655           = AbsBinds
 656                  zonked_inst_tyvars
 657                  (map instToId dfun_arg_dicts)
 658                  [(inst_tyvars', local_dfun_id, this_dict_id)]
 659                  inlines
 660                  (lie_binds1    `AndMonoBinds`
 661                   lie_binds2    `AndMonoBinds`
 662                   method_binds  `AndMonoBinds`
 663                   dict_bind)
 664     in
 665     returnTc (const_lie1 `plusLIE` const_lie2 `plusLIE` prag_lie,
 666               main_bind `AndMonoBinds` prag_binds)
 667 \end{code}
 668
 669                 ------------------------------
 670                 Inlining dfuns unconditionally
 671                 ------------------------------
 672
 673 The code above unconditionally inlines dict funs.  Here's why.
 674 Consider this program:
 675
 676     test :: Int -> Int -> Bool
 677     test x y = (x,y) == (y,x) || test y x
 678     -- Recursive to avoid making it inline.
 679
 680 This needs the (Eq (Int,Int)) instance.  If we inline that dfun
 681 the code we end up with is good:
 682
 683     Test.$wtest =
 684         \r -> case ==# [ww ww1] of wild {
 685                 PrelBase.False -> Test.$wtest ww1 ww;
 686                 PrelBase.True ->
 687                   case ==# [ww1 ww] of wild1 {
 688                     PrelBase.False -> Test.$wtest ww1 ww;
 689                     PrelBase.True -> PrelBase.True [];
 690                   };
 691             };
 692     Test.test = \r [w w1]
 693             case w of w2 {
 694               PrelBase.I# ww ->
 695                   case w1 of w3 { PrelBase.I# ww1 -> Test.$wtest ww ww1; };
 696             };
 697
 698 If we don't inline the dfun, the code is not nearly as good:
 699
 700     (==) = case PrelTup.$fEq(,) PrelBase.$fEqInt PrelBase.$fEqInt of tpl {
 701               PrelBase.:DEq tpl1 tpl2 -> tpl2;
 702             };
 703
 704     Test.$wtest =
 705         \r [ww ww1]
 706             let { y = PrelBase.I#! [ww1]; } in
 707             let { x = PrelBase.I#! [ww]; } in
 708             let { sat_slx = PrelTup.(,)! [y x]; } in
 709             let { sat_sly = PrelTup.(,)! [x y];
 710             } in
 711               case == sat_sly sat_slx of wild {
 712                 PrelBase.False -> Test.$wtest ww1 ww;
 713                 PrelBase.True -> PrelBase.True [];
 714               };
 715
 716     Test.test =
 717         \r [w w1]
 718             case w of w2 {
 719               PrelBase.I# ww ->
 720                   case w1 of w3 { PrelBase.I# ww1 -> Test.$wtest ww ww1; };
 721             };
 722
 723 Why doesn't GHC inline $fEq?  Because it looks big:
 724
 725     PrelTup.zdfEqZ1T{-rcX-}
 726         = \ @ a{-reT-} :: * @ b{-reS-} :: *
 727             zddEq{-rf6-} _Ks :: {PrelBase.Eq{-23-} a{-reT-}}
 728             zddEq1{-rf7-} _Ks :: {PrelBase.Eq{-23-} b{-reS-}} ->
 729             let {
 730               zeze{-rf0-} _Kl :: (b{-reS-} -> b{-reS-} -> PrelBase.Bool{-3c-})
 731               zeze{-rf0-} = PrelBase.zeze{-01L-}@ b{-reS-} zddEq1{-rf7-} } in
 732             let {
 733               zeze1{-rf3-} _Kl :: (a{-reT-} -> a{-reT-} -> PrelBase.Bool{-3c-})
 734               zeze1{-rf3-} = PrelBase.zeze{-01L-} @ a{-reT-} zddEq{-rf6-} } in
 735             let {
 736               zeze2{-reN-} :: ((a{-reT-}, b{-reS-}) -> (a{-reT-}, b{-reS-})-> PrelBase.Bool{-3c-})
 737               zeze2{-reN-} = \ ds{-rf5-} _Ks :: (a{-reT-}, b{-reS-})
 738                                ds1{-rf4-} _Ks :: (a{-reT-}, b{-reS-}) ->
 739                              case ds{-rf5-}
 740                              of wild{-reW-} _Kd { (a1{-rf2-} _Ks, a2{-reZ-} _Ks) ->
 741                              case ds1{-rf4-}
 742                              of wild1{-reX-} _Kd { (b1{-rf1-} _Ks, b2{-reY-} _Ks) ->
 743                              PrelBase.zaza{-r4e-}
 744                                (zeze1{-rf3-} a1{-rf2-} b1{-rf1-})
 745                                (zeze{-rf0-} a2{-reZ-} b2{-reY-})
 746                              }
 747                              } } in
 748             let {
 749               a1{-reR-} :: ((a{-reT-}, b{-reS-})-> (a{-reT-}, b{-reS-})-> PrelBase.Bool{-3c-})
 750               a1{-reR-} = \ a2{-reV-} _Ks :: (a{-reT-}, b{-reS-})
 751                             b1{-reU-} _Ks :: (a{-reT-}, b{-reS-}) ->
 752                           PrelBase.not{-r6I-} (zeze2{-reN-} a2{-reV-} b1{-reU-})
 753             } in
 754               PrelBase.zdwZCDEq{-r8J-} @ (a{-reT-}, b{-reS-}) a1{-reR-} zeze2{-reN-})
 755
 756 and it's not as bad as it seems, because it's further dramatically
 757 simplified: only zeze2 is extracted and its body is simplified.
 758
 759
 760 %************************************************************************
 761 %*                                                                      *
 762 \subsection{Error messages}
 763 %*                                                                      *
 764 %************************************************************************
 765
 766 \begin{code}
 767 tcAddDeclCtxt decl thing_inside
 768   = tcAddSrcLoc (tcdLoc decl)   $
 769     tcAddErrCtxt ctxt   $
 770     thing_inside
 771   where
 772      thing = case decl of
 773                 ClassDecl {}              -> "class"
 774                 TySynonym {}              -> "type synonym"
 775                 TyData {tcdND = NewType}  -> "newtype"
 776                 TyData {tcdND = DataType} -> "data type"
 777
 778      ctxt = hsep [ptext SLIT("In the"), text thing,
 779                   ptext SLIT("declaration for"), quotes (ppr (tcdName decl))]
 780
 781 instDeclCtxt inst_ty = ptext SLIT("In the instance declaration for") <+> quotes doc
 782                      where
 783                         doc = case inst_ty of
 784                                 HsForAllTy _ _ (HsPredTy pred) -> ppr pred
 785                                 HsPredTy pred                  -> ppr pred
 786                                 other                          -> ppr inst_ty   -- Don't expect this
 787 \end{code}
 788
 789 \begin{code}
 790 badGenericInstanceType binds
 791   = vcat [ptext SLIT("Illegal type pattern in the generic bindings"),
 792           nest 4 (ppr binds)]
 793
 794 missingGenericInstances missing
 795   = ptext SLIT("Missing type patterns for") <+> pprQuotedList missing
 796
 797 dupGenericInsts tc_inst_infos
 798   = vcat [ptext SLIT("More than one type pattern for a single generic type constructor:"),
 799           nest 4 (vcat (map ppr_inst_ty tc_inst_infos)),
 800           ptext SLIT("All the type patterns for a generic type constructor must be identical")
 801     ]
 802   where
 803     ppr_inst_ty (tc,inst) = ppr (simpleInstInfoTy inst)
 804
 805 methodCtxt     = ptext SLIT("When checking the methods of an instance declaration")
 806 superClassCtxt = ptext SLIT("When checking the super-classes of an instance declaration")
 807 \end{code}