ghc/compiler/typecheck/TcClassDcl.lhs

   1 %
   2 % (c) The GRASP/AQUA Project, Glasgow University, 1992-1998
   3 %
   4 \section[TcClassDcl]{Typechecking class declarations}
   5
   6 \begin{code}
   7 module TcClassDcl ( tcClassDecl1, checkValidClass, tcClassDecls2,
   8                     tcMethodBind, badMethodErr
   9                   ) where
  10
  11 #include "HsVersions.h"
  12
  13 import HsSyn            ( TyClDecl(..), Sig(..), MonoBinds(..),
  14                           HsExpr(..), HsLit(..),
  15                           mkSimpleMatch, andMonoBinds, andMonoBindList,
  16                           isClassOpSig, isPragSig,
  17                           getClassDeclSysNames, placeHolderType
  18                         )
  19 import BasicTypes       ( TopLevelFlag(..), RecFlag(..), StrictnessMark(..) )
  20 import RnHsSyn          ( RenamedTyClDecl,
  21                           RenamedClassOpSig, RenamedMonoBinds,
  22                           RenamedSig, maybeGenericMatch
  23                         )
  24 import TcHsSyn          ( TcMonoBinds )
  25
  26 import Inst             ( Inst, InstOrigin(..), LIE, emptyLIE, plusLIE, plusLIEs,
  27                           instToId, newDicts, newMethod )
  28 import TcEnv            ( TyThingDetails(..), tcExtendGlobalTyVars,
  29                           tcLookupClass, tcExtendTyVarEnvForMeths,
  30                           tcExtendLocalValEnv, tcExtendTyVarEnv
  31                         )
  32 import TcBinds          ( tcBindWithSigs, tcSpecSigs )
  33 import TcMonoType       ( tcHsType, tcHsTheta, mkTcSig )
  34 import TcSimplify       ( tcSimplifyCheck, bindInstsOfLocalFuns )
  35 import TcUnify          ( checkSigTyVars, sigCtxt )
  36 import TcMType          ( tcInstSigTyVars, checkValidTheta, checkValidType, SourceTyCtxt(..), UserTypeCtxt(..) )
  37 import TcType           ( Type, TyVarDetails(..), TcType, TcThetaType, TcTyVar,
  38                           mkTyVarTys, mkPredTys, mkClassPred,
  39                           tcIsTyVarTy, tcSplitTyConApp_maybe, tcSplitSigmaTy
  40                         )
  41 import TcMonad
  42 import Generics         ( mkGenericRhs, validGenericMethodType )
  43 import PrelInfo         ( nO_METHOD_BINDING_ERROR_ID )
  44 import Class            ( classTyVars, classBigSig, classTyCon, className,
  45                           Class, ClassOpItem, DefMeth (..) )
  46 import MkId             ( mkDictSelId, mkDataConId, mkDataConWrapId, mkDefaultMethodId )
  47 import DataCon          ( mkDataCon )
  48 import Id               ( Id, idType, idName, setIdLocalExported )
  49 import Module           ( Module )
  50 import Name             ( Name, NamedThing(..) )
  51 import NameEnv          ( NameEnv, lookupNameEnv, emptyNameEnv, unitNameEnv, plusNameEnv )
  52 import NameSet          ( emptyNameSet )
  53 import Outputable
  54 import Var              ( TyVar )
  55 import CmdLineOpts
  56 import ErrUtils         ( dumpIfSet )
  57 import Util             ( count, isSingleton, lengthIs, equalLength )
  58 import Maybes           ( seqMaybe, maybeToBool )
  59 \end{code}
  60
  61
  62
  63 Dictionary handling
  64 ~~~~~~~~~~~~~~~~~~~
  65 Every class implicitly declares a new data type, corresponding to dictionaries
  66 of that class. So, for example:
  67
  68         class (D a) => C a where
  69           op1 :: a -> a
  70           op2 :: forall b. Ord b => a -> b -> b
  71
  72 would implicitly declare
  73
  74         data CDict a = CDict (D a)
  75                              (a -> a)
  76                              (forall b. Ord b => a -> b -> b)
  77
  78 (We could use a record decl, but that means changing more of the existing apparatus.
  79 One step at at time!)
  80
  81 For classes with just one superclass+method, we use a newtype decl instead:
  82
  83         class C a where
  84           op :: forallb. a -> b -> b
  85
  86 generates
  87
  88         newtype CDict a = CDict (forall b. a -> b -> b)
  89
  90 Now DictTy in Type is just a form of type synomym:
  91         DictTy c t = TyConTy CDict `AppTy` t
  92
  93 Death to "ExpandingDicts".
  94
  95
  96 %************************************************************************
  97 %*                                                                      *
  98 \subsection{Type checking}
  99 %*                                                                      *
 100 %************************************************************************
 101
 102 \begin{code}
 103
 104 tcClassDecl1 :: RenamedTyClDecl -> TcM (Name, TyThingDetails)
 105 tcClassDecl1 (ClassDecl {tcdCtxt = context, tcdName = class_name,
 106                          tcdTyVars = tyvar_names, tcdFDs = fundeps,
 107                          tcdSigs = class_sigs, tcdMeths = def_methods,
 108                          tcdSysNames = sys_names, tcdLoc = src_loc})
 109   =     -- LOOK THINGS UP IN THE ENVIRONMENT
 110     tcLookupClass class_name                            `thenTc` \ clas ->
 111     let
 112         tyvars   = classTyVars clas
 113         op_sigs  = filter isClassOpSig class_sigs
 114         op_names = [n | ClassOpSig n _ _ _ <- op_sigs]
 115         (_, datacon_name, datacon_wkr_name, sc_sel_names) = getClassDeclSysNames sys_names
 116     in
 117     tcExtendTyVarEnv tyvars                             $
 118
 119     checkDefaultBinds clas op_names def_methods   `thenTc` \ mb_dm_env ->
 120
 121         -- CHECK THE CONTEXT
 122         -- The renamer has already checked that the context mentions
 123         -- only the type variable of the class decl.
 124         -- Context is already kind-checked
 125     ASSERT( equalLength context sc_sel_names )
 126     tcHsTheta context                                   `thenTc` \ sc_theta ->
 127
 128         -- CHECK THE CLASS SIGNATURES,
 129     mapTc (tcClassSig clas tyvars mb_dm_env) op_sigs    `thenTc` \ sig_stuff ->
 130
 131         -- MAKE THE CLASS DETAILS
 132     let
 133         (op_tys, op_items) = unzip sig_stuff
 134         sc_tys             = mkPredTys sc_theta
 135         dict_component_tys = sc_tys ++ op_tys
 136         sc_sel_ids         = [mkDictSelId sc_name clas | sc_name <- sc_sel_names]
 137
 138         dict_con = mkDataCon datacon_name
 139                              [NotMarkedStrict | _ <- dict_component_tys]
 140                              [{- No labelled fields -}]
 141                              tyvars
 142                              [{-No context-}]
 143                              [{-No existential tyvars-}] [{-Or context-}]
 144                              dict_component_tys
 145                              (classTyCon clas)
 146                              dict_con_id dict_wrap_id
 147
 148         dict_con_id  = mkDataConId datacon_wkr_name dict_con
 149         dict_wrap_id = mkDataConWrapId dict_con
 150     in
 151     returnTc (class_name, ClassDetails sc_theta sc_sel_ids op_items dict_con)
 152 \end{code}
 153
 154 \begin{code}
 155 checkDefaultBinds :: Class -> [Name] -> Maybe RenamedMonoBinds
 156                   -> TcM (Maybe (NameEnv Bool))
 157         -- The returned environment says
 158         --      x not in env => no default method
 159         --      x -> True    => generic default method
 160         --      x -> False   => polymorphic default method
 161
 162   -- Check default bindings
 163   --    a) must be for a class op for this class
 164   --    b) must be all generic or all non-generic
 165   -- and return a mapping from class-op to DefMeth info
 166
 167   -- But do all this only for source binds
 168
 169 checkDefaultBinds clas ops Nothing
 170   = returnTc Nothing
 171
 172 checkDefaultBinds clas ops (Just mbs)
 173   = go mbs      `thenTc` \ dm_env ->
 174     returnTc (Just dm_env)
 175   where
 176     go EmptyMonoBinds = returnTc emptyNameEnv
 177
 178     go (AndMonoBinds b1 b2)
 179       = go b1   `thenTc` \ dm_info1 ->
 180         go b2   `thenTc` \ dm_info2 ->
 181         returnTc (dm_info1 `plusNameEnv` dm_info2)
 182
 183     go (FunMonoBind op _ matches loc)
 184       = tcAddSrcLoc loc                                 $
 185
 186         -- Check that the op is from this class
 187         checkTc (op `elem` ops) (badMethodErr clas op)          `thenTc_`
 188
 189         -- Check that all the defns ar generic, or none are
 190         checkTc (all_generic || none_generic) (mixedGenericErr op)      `thenTc_`
 191
 192         returnTc (unitNameEnv op all_generic)
 193       where
 194         n_generic    = count (maybeToBool . maybeGenericMatch) matches
 195         none_generic = n_generic == 0
 196         all_generic  = matches `lengthIs` n_generic
 197 \end{code}
 198
 199
 200 \begin{code}
 201 tcClassSig :: Class                     -- ...ditto...
 202            -> [TyVar]                   -- The class type variable, used for error check only
 203            -> Maybe (NameEnv Bool)      -- Info about default methods;
 204                                         --      Nothing => imported class defn with no method binds
 205            -> RenamedClassOpSig
 206            -> TcM (Type,                -- Type of the method
 207                      ClassOpItem)       -- Selector Id, default-method Id, True if explicit default binding
 208
 209 -- This warrants an explanation: we need to separate generic
 210 -- default methods and default methods later on in the compiler
 211 -- so we distinguish them in checkDefaultBinds, and pass this knowledge in the
 212 -- Class.DefMeth data structure.
 213
 214 tcClassSig clas clas_tyvars maybe_dm_env
 215            (ClassOpSig op_name sig_dm op_ty src_loc)
 216   = tcAddSrcLoc src_loc $
 217
 218         -- Check the type signature.  NB that the envt *already has*
 219         -- bindings for the type variables; see comments in TcTyAndClassDcls.
 220     tcHsType op_ty                      `thenTc` \ local_ty ->
 221
 222     let
 223         theta = [mkClassPred clas (mkTyVarTys clas_tyvars)]
 224
 225         -- Build the selector id and default method id
 226         sel_id = mkDictSelId op_name clas
 227         DefMeth dm_name = sig_dm
 228
 229         dm_info = case maybe_dm_env of
 230                     Nothing     -> sig_dm
 231                     Just dm_env -> mk_src_dm_info dm_env
 232
 233         mk_src_dm_info dm_env = case lookupNameEnv dm_env op_name of
 234                                    Nothing    -> NoDefMeth
 235                                    Just True  -> GenDefMeth
 236                                    Just False -> DefMeth dm_name
 237     in
 238     returnTc (local_ty, (sel_id, dm_info))
 239 \end{code}
 240
 241 checkValidClass is called once the mutually-recursive knot has been
 242 tied, so we can look at things freely.
 243
 244 \begin{code}
 245 checkValidClass :: Class -> TcM ()
 246 checkValidClass cls
 247   =     -- CHECK ARITY 1 FOR HASKELL 1.4
 248     doptsTc Opt_GlasgowExts                             `thenTc` \ gla_exts ->
 249
 250         -- Check that the class is unary, unless GlaExs
 251     checkTc (not (null tyvars))         (nullaryClassErr cls)   `thenTc_`
 252     checkTc (gla_exts || unary) (classArityErr cls)     `thenTc_`
 253
 254         -- Check the super-classes
 255     checkValidTheta (ClassSCCtxt (className cls)) theta `thenTc_`
 256
 257         -- Check the class operations
 258     mapTc_ check_op op_stuff            `thenTc_`
 259
 260         -- Check that if the class has generic methods, then the
 261         -- class has only one parameter.  We can't do generic
 262         -- multi-parameter type classes!
 263     checkTc (unary || no_generics) (genericMultiParamErr cls)
 264
 265   where
 266     (tyvars, theta, _, op_stuff) = classBigSig cls
 267     unary       = isSingleton tyvars
 268     no_generics = null [() | (_, GenDefMeth) <- op_stuff]
 269
 270     check_op (sel_id, dm)
 271         = checkValidTheta SigmaCtxt (tail theta)        `thenTc_`
 272                 -- The 'tail' removes the initial (C a) from the
 273                 -- class itself, leaving just the method type
 274
 275           checkValidType (FunSigCtxt op_name) tau       `thenTc_`
 276
 277                 -- Check that for a generic method, the type of
 278                 -- the method is sufficiently simple
 279           checkTc (dm /= GenDefMeth || validGenericMethodType op_ty)
 280                   (badGenericMethodType op_name op_ty)
 281         where
 282           op_name = idName sel_id
 283           op_ty   = idType sel_id
 284           (_,theta,tau) = tcSplitSigmaTy op_ty
 285 \end{code}
 286
 287
 288 %************************************************************************
 289 %*                                                                      *
 290 \subsection[Default methods]{Default methods}
 291 %*                                                                      *
 292 %************************************************************************
 293
 294 The default methods for a class are each passed a dictionary for the
 295 class, so that they get access to the other methods at the same type.
 296 So, given the class decl
 297 \begin{verbatim}
 298 class Foo a where
 299         op1 :: a -> Bool
 300         op2 :: Ord b => a -> b -> b -> b
 301
 302         op1 x = True
 303         op2 x y z = if (op1 x) && (y < z) then y else z
 304 \end{verbatim}
 305 we get the default methods:
 306 \begin{verbatim}
 307 defm.Foo.op1 :: forall a. Foo a => a -> Bool
 308 defm.Foo.op1 = /\a -> \dfoo -> \x -> True
 309
 310 defm.Foo.op2 :: forall a. Foo a => forall b. Ord b => a -> b -> b -> b
 311 defm.Foo.op2 = /\ a -> \ dfoo -> /\ b -> \ dord -> \x y z ->
 312                   if (op1 a dfoo x) && (< b dord y z) then y else z
 313 \end{verbatim}
 314
 315 When we come across an instance decl, we may need to use the default
 316 methods:
 317 \begin{verbatim}
 318 instance Foo Int where {}
 319 \end{verbatim}
 320 gives
 321 \begin{verbatim}
 322 const.Foo.Int.op1 :: Int -> Bool
 323 const.Foo.Int.op1 = defm.Foo.op1 Int dfun.Foo.Int
 324
 325 const.Foo.Int.op2 :: forall b. Ord b => Int -> b -> b -> b
 326 const.Foo.Int.op2 = defm.Foo.op2 Int dfun.Foo.Int
 327
 328 dfun.Foo.Int :: Foo Int
 329 dfun.Foo.Int = (const.Foo.Int.op1, const.Foo.Int.op2)
 330 \end{verbatim}
 331 Notice that, as with method selectors above, we assume that dictionary
 332 application is curried, so there's no need to mention the Ord dictionary
 333 in const.Foo.Int.op2 (or the type variable).
 334
 335 \begin{verbatim}
 336 instance Foo a => Foo [a] where {}
 337
 338 dfun.Foo.List :: forall a. Foo a -> Foo [a]
 339 dfun.Foo.List
 340   = /\ a -> \ dfoo_a ->
 341     let rec
 342         op1 = defm.Foo.op1 [a] dfoo_list
 343         op2 = defm.Foo.op2 [a] dfoo_list
 344         dfoo_list = (op1, op2)
 345     in
 346         dfoo_list
 347 \end{verbatim}
 348
 349 The function @tcClassDecls2@ just arranges to apply @tcClassDecl2@ to
 350 each local class decl.
 351
 352 \begin{code}
 353 tcClassDecls2 :: Module -> [RenamedTyClDecl] -> NF_TcM (LIE, TcMonoBinds, [Id])
 354
 355 tcClassDecls2 this_mod decls
 356   = foldr combine
 357           (returnNF_Tc (emptyLIE, EmptyMonoBinds, []))
 358           [tcClassDecl2 cls_decl | cls_decl@(ClassDecl {tcdMeths = Just _}) <- decls]
 359                 -- The 'Just' picks out source ClassDecls
 360   where
 361     combine tc1 tc2 = tc1 `thenNF_Tc` \ (lie1, binds1, ids1) ->
 362                       tc2 `thenNF_Tc` \ (lie2, binds2, ids2) ->
 363                       returnNF_Tc (lie1 `plusLIE` lie2,
 364                                    binds1 `AndMonoBinds` binds2,
 365                                    ids1 ++ ids2)
 366 \end{code}
 367
 368 @tcClassDecl2@ generates bindings for polymorphic default methods
 369 (generic default methods have by now turned into instance declarations)
 370
 371 \begin{code}
 372 tcClassDecl2 :: RenamedTyClDecl         -- The class declaration
 373              -> NF_TcM (LIE, TcMonoBinds, [Id])
 374
 375 tcClassDecl2 (ClassDecl {tcdName = class_name, tcdSigs = sigs,
 376                          tcdMeths = Just default_binds, tcdLoc = src_loc})
 377   =     -- The 'Just' picks out source ClassDecls
 378     recoverNF_Tc (returnNF_Tc (emptyLIE, EmptyMonoBinds, [])) $
 379     tcAddSrcLoc src_loc                                   $
 380     tcLookupClass class_name                              `thenNF_Tc` \ clas ->
 381
 382         -- We make a separate binding for each default method.
 383         -- At one time I used a single AbsBinds for all of them, thus
 384         -- AbsBind [d] [dm1, dm2, dm3] { dm1 = ...; dm2 = ...; dm3 = ... }
 385         -- But that desugars into
 386         --      ds = \d -> (..., ..., ...)
 387         --      dm1 = \d -> case ds d of (a,b,c) -> a
 388         -- And since ds is big, it doesn't get inlined, so we don't get good
 389         -- default methods.  Better to make separate AbsBinds for each
 390     let
 391         (tyvars, _, _, op_items) = classBigSig clas
 392         prags                    = filter isPragSig sigs
 393         tc_dm                    = tcDefMeth clas tyvars default_binds prags
 394     in
 395     mapAndUnzip3Tc tc_dm op_items       `thenTc` \ (defm_binds, const_lies, dm_ids_s) ->
 396
 397     returnTc (plusLIEs const_lies, andMonoBindList defm_binds, concat dm_ids_s)
 398
 399
 400 tcDefMeth clas tyvars binds_in prags (_, NoDefMeth)  = returnTc (EmptyMonoBinds, emptyLIE, [])
 401 tcDefMeth clas tyvars binds_in prags (_, GenDefMeth) = returnTc (EmptyMonoBinds, emptyLIE, [])
 402         -- Generate code for polymorphic default methods only
 403         -- (Generic default methods have turned into instance decls by now.)
 404         -- This is incompatible with Hugs, which expects a polymorphic
 405         -- default method for every class op, regardless of whether or not
 406         -- the programmer supplied an explicit default decl for the class.
 407         -- (If necessary we can fix that, but we don't have a convenient Id to hand.)
 408
 409 tcDefMeth clas tyvars binds_in prags op_item@(sel_id, DefMeth dm_name)
 410   = tcInstSigTyVars ClsTv tyvars                        `thenNF_Tc` \ clas_tyvars ->
 411     let
 412         dm_ty = idType sel_id   -- Same as dict selector!
 413           -- The default method's type should really come from the
 414           -- iface file, since it could be usage-generalised, but this
 415           -- requires altering the mess of knots in TcModule and I'm
 416           -- too scared to do that.  Instead, I have disabled generalisation
 417           -- of types of default methods (and dict funs) by annotating them
 418           -- TyGenNever (in MkId).  Ugh!  KSW 1999-09.
 419
 420         inst_tys    = mkTyVarTys clas_tyvars
 421         theta       = [mkClassPred clas inst_tys]
 422         dm_id       = mkDefaultMethodId dm_name dm_ty
 423         local_dm_id = setIdLocalExported dm_id
 424                 -- Reason for setIdLocalExported: see notes with MkId.mkDictFunId
 425     in
 426     newDicts origin theta               `thenNF_Tc` \ [this_dict] ->
 427
 428     tcExtendTyVarEnvForMeths tyvars clas_tyvars (
 429         tcMethodBind clas origin clas_tyvars inst_tys theta
 430                      binds_in prags False op_item
 431     )                                   `thenTc` \ (defm_bind, insts_needed, local_dm_inst) ->
 432
 433     tcAddErrCtxt (defltMethCtxt clas) $
 434
 435         -- Check the context
 436     tcSimplifyCheck
 437         (ptext SLIT("class") <+> ppr clas)
 438         clas_tyvars
 439         [this_dict]
 440         insts_needed                    `thenTc` \ (const_lie, dict_binds) ->
 441
 442         -- Simplification can do unification
 443     checkSigTyVars clas_tyvars          `thenTc` \ clas_tyvars' ->
 444
 445     let
 446         full_bind = AbsBinds
 447                     clas_tyvars'
 448                     [instToId this_dict]
 449                     [(clas_tyvars', local_dm_id, instToId local_dm_inst)]
 450                     emptyNameSet        -- No inlines (yet)
 451                     (dict_binds `andMonoBinds` defm_bind)
 452     in
 453     returnTc (full_bind, const_lie, [dm_id])
 454   where
 455     origin = ClassDeclOrigin
 456 \end{code}
 457
 458
 459
 460 %************************************************************************
 461 %*                                                                      *
 462 \subsection{Typechecking a method}
 463 %*                                                                      *
 464 %************************************************************************
 465
 466 @tcMethodBind@ is used to type-check both default-method and
 467 instance-decl method declarations.  We must type-check methods one at a
 468 time, because their signatures may have different contexts and
 469 tyvar sets.
 470
 471 \begin{code}
 472 tcMethodBind
 473         :: Class
 474         -> InstOrigin
 475         -> [TcTyVar]            -- Instantiated type variables for the
 476                                 --  enclosing class/instance decl.
 477                                 --  They'll be signature tyvars, and we
 478                                 --  want to check that they don't get bound
 479         -> [TcType]             -- Instance types
 480         -> TcThetaType          -- Available theta; this could be used to check
 481                                 --  the method signature, but actually that's done by
 482                                 --  the caller;  here, it's just used for the error message
 483         -> RenamedMonoBinds     -- Method binding (pick the right one from in here)
 484         -> [RenamedSig]         -- Pramgas (just for this one)
 485         -> Bool                 -- True <=> This method is from an instance declaration
 486         -> ClassOpItem          -- The method selector and default-method Id
 487         -> TcM (TcMonoBinds, LIE, Inst)
 488
 489 tcMethodBind clas origin inst_tyvars inst_tys inst_theta
 490              meth_binds prags is_inst_decl (sel_id, dm_info)
 491   = tcGetSrcLoc                         `thenNF_Tc` \ loc ->
 492     newMethod origin sel_id inst_tys    `thenNF_Tc` \ meth ->
 493     let
 494         meth_id    = instToId meth
 495         meth_name  = idName meth_id
 496         meth_prags = find_prags (idName sel_id) meth_name prags
 497     in
 498     mkTcSig meth_id loc                 `thenNF_Tc` \ sig_info ->
 499
 500         -- Figure out what method binding to use
 501         -- If the user suppplied one, use it, else construct a default one
 502     (case find_bind (idName sel_id) meth_name meth_binds of
 503         Just user_bind -> returnTc user_bind
 504         Nothing        -> mkDefMethRhs is_inst_decl clas inst_tys sel_id loc dm_info    `thenTc` \ rhs ->
 505                           returnTc (FunMonoBind meth_name False -- Not infix decl
 506                                                 [mkSimpleMatch [] rhs placeHolderType loc] loc)
 507     )                                                           `thenTc` \ meth_bind ->
 508      -- Check the bindings; first add inst_tyvars to the envt
 509      -- so that we don't quantify over them in nested places
 510      -- The *caller* put the class/inst decl tyvars into the tyvar envt,
 511      -- but not into the global tyvars, so that the call to checkSigTyVars below works ok
 512      tcExtendGlobalTyVars inst_tyvars
 513                     (tcAddErrCtxt (methodCtxt sel_id)           $
 514                      tcBindWithSigs NotTopLevel meth_bind
 515                                     [sig_info] meth_prags NonRecursive
 516                     )                                           `thenTc` \ (binds, insts, _) ->
 517
 518      tcExtendLocalValEnv [(meth_name, meth_id)]
 519                          (tcSpecSigs meth_prags)                `thenTc` \ (prag_binds1, prag_lie) ->
 520
 521      -- The prag_lie for a SPECIALISE pragma will mention the function
 522      -- itself, so we have to simplify them away right now lest they float
 523      -- outwards!
 524      bindInstsOfLocalFuns prag_lie [meth_id]    `thenTc` \ (prag_lie', prag_binds2) ->
 525
 526      -- Now check that the instance type variables
 527      -- (or, in the case of a class decl, the class tyvars)
 528      -- have not been unified with anything in the environment
 529      --
 530      -- We do this for each method independently to localise error messages
 531      -- ...and this is why the call to tcExtendGlobalTyVars must be here
 532      --    rather than in the caller
 533      tcAddErrCtxt (ptext SLIT("When checking the type of class method")
 534                    <+> quotes (ppr sel_id))                             $
 535      tcAddErrCtxtM (sigCtxt inst_tyvars inst_theta (idType meth_id))    $
 536      checkSigTyVars inst_tyvars                                         `thenTc_`
 537
 538      returnTc (binds `AndMonoBinds` prag_binds1 `AndMonoBinds` prag_binds2,
 539                insts `plusLIE` prag_lie',
 540                meth)
 541
 542      -- The user didn't supply a method binding,
 543      -- so we have to make up a default binding
 544      -- The RHS of a default method depends on the default-method info
 545 mkDefMethRhs is_inst_decl clas inst_tys sel_id loc (DefMeth dm_name)
 546   =  -- An polymorphic default method
 547     returnTc (HsVar dm_name)
 548
 549 mkDefMethRhs is_inst_decl clas inst_tys sel_id loc NoDefMeth
 550   =     -- No default method
 551         -- Warn only if -fwarn-missing-methods
 552     doptsTc Opt_WarnMissingMethods              `thenNF_Tc` \ warn ->
 553     warnTc (is_inst_decl && warn)
 554            (omittedMethodWarn sel_id)           `thenNF_Tc_`
 555     returnTc error_rhs
 556   where
 557     error_rhs = HsApp (HsVar (getName nO_METHOD_BINDING_ERROR_ID))
 558                           (HsLit (HsString (_PK_ error_msg)))
 559     error_msg = showSDoc (hcat [ppr loc, text "|", ppr sel_id ])
 560
 561
 562 mkDefMethRhs is_inst_decl clas inst_tys sel_id loc GenDefMeth
 563   =     -- A generic default method
 564         -- If the method is defined generically, we can only do the job if the
 565         -- instance declaration is for a single-parameter type class with
 566         -- a type constructor applied to type arguments in the instance decl
 567         --      (checkTc, so False provokes the error)
 568      checkTc (not is_inst_decl || simple_inst)
 569              (badGenericInstance sel_id)                        `thenTc_`
 570
 571      ioToTc (dumpIfSet opt_PprStyle_Debug "Generic RHS" stuff)  `thenNF_Tc_`
 572      returnTc rhs
 573   where
 574     rhs = mkGenericRhs sel_id clas_tyvar tycon
 575
 576     stuff = vcat [ppr clas <+> ppr inst_tys,
 577                   nest 4 (ppr sel_id <+> equals <+> ppr rhs)]
 578
 579           -- The tycon is only used in the generic case, and in that
 580           -- case we require that the instance decl is for a single-parameter
 581           -- type class with type variable arguments:
 582           --    instance (...) => C (T a b)
 583     simple_inst   = maybeToBool maybe_tycon
 584     clas_tyvar    = head (classTyVars clas)
 585     Just tycon    = maybe_tycon
 586     maybe_tycon   = case inst_tys of
 587                         [ty] -> case tcSplitTyConApp_maybe ty of
 588                                   Just (tycon, arg_tys) | all tcIsTyVarTy arg_tys -> Just tycon
 589                                   other                                           -> Nothing
 590                         other -> Nothing
 591 \end{code}
 592
 593
 594 \begin{code}
 595 -- The renamer just puts the selector ID as the binder in the method binding
 596 -- but we must use the method name; so we substitute it here.  Crude but simple.
 597 find_bind sel_name meth_name (FunMonoBind op_name fix matches loc)
 598     | op_name == sel_name = Just (FunMonoBind meth_name fix matches loc)
 599 find_bind sel_name meth_name (AndMonoBinds b1 b2)
 600     = find_bind sel_name meth_name b1 `seqMaybe` find_bind sel_name meth_name b2
 601 find_bind sel_name meth_name other  = Nothing   -- Default case
 602
 603  -- Find the prags for this method, and replace the
 604  -- selector name with the method name
 605 find_prags sel_name meth_name [] = []
 606 find_prags sel_name meth_name (SpecSig name ty loc : prags)
 607      | name == sel_name = SpecSig meth_name ty loc : find_prags sel_name meth_name prags
 608 find_prags sel_name meth_name (InlineSig sense name phase loc : prags)
 609    | name == sel_name = InlineSig sense meth_name phase loc : find_prags sel_name meth_name prags
 610 find_prags sel_name meth_name (prag:prags) = find_prags sel_name meth_name prags
 611 \end{code}
 612
 613
 614 Contexts and errors
 615 ~~~~~~~~~~~~~~~~~~~
 616 \begin{code}
 617 nullaryClassErr cls
 618   = ptext SLIT("No parameters for class")  <+> quotes (ppr cls)
 619
 620 classArityErr cls
 621   = vcat [ptext SLIT("Too many parameters for class") <+> quotes (ppr cls),
 622           parens (ptext SLIT("Use -fglasgow-exts to allow multi-parameter classes"))]
 623
 624 defltMethCtxt clas
 625   = ptext SLIT("When checking the default methods for class") <+> quotes (ppr clas)
 626
 627 methodCtxt sel_id
 628   = ptext SLIT("In the definition for method") <+> quotes (ppr sel_id)
 629
 630 badMethodErr clas op
 631   = hsep [ptext SLIT("Class"), quotes (ppr clas),
 632           ptext SLIT("does not have a method"), quotes (ppr op)]
 633
 634 omittedMethodWarn sel_id
 635   = ptext SLIT("No explicit method nor default method for") <+> quotes (ppr sel_id)
 636
 637 badGenericMethodType op op_ty
 638   = hang (ptext SLIT("Generic method type is too complex"))
 639        4 (vcat [ppr op <+> dcolon <+> ppr op_ty,
 640                 ptext SLIT("You can only use type variables, arrows, and tuples")])
 641
 642 badGenericInstance sel_id
 643   = sep [ptext SLIT("Can't derive generic code for") <+> quotes (ppr sel_id),
 644          ptext SLIT("because the instance declaration is not for a simple type (T a b c)"),
 645          ptext SLIT("(where T is a derivable type constructor)")]
 646
 647 mixedGenericErr op
 648   = ptext SLIT("Can't mix generic and non-generic equations for class method") <+> quotes (ppr op)
 649
 650 genericMultiParamErr clas
 651   = ptext SLIT("The multi-parameter class") <+> quotes (ppr clas) <+>
 652     ptext SLIT("cannot have generic methods")
 653 \end{code}