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, tcClassDecls2, mkImplicitClassBinds,
   8                     tcMethodBind, badMethodErr
   9                   ) where
  10
  11 #include "HsVersions.h"
  12
  13 import HsSyn            ( HsDecl(..), TyClDecl(..), Sig(..), MonoBinds(..),
  14                           HsExpr(..), HsLit(..), HsType(..), HsPred(..),
  15                           mkSimpleMatch, andMonoBinds, andMonoBindList,
  16                           isClassDecl, isClassOpSig, isPragSig,
  17                           getClassDeclSysNames, tyClDeclName
  18                         )
  19 import BasicTypes       ( TopLevelFlag(..), RecFlag(..) )
  20 import RnHsSyn          ( RenamedTyClDecl,
  21                           RenamedClassOpSig, RenamedMonoBinds,
  22                           RenamedContext, RenamedHsDecl, RenamedSig,
  23                           maybeGenericMatch
  24                         )
  25 import TcHsSyn          ( TcMonoBinds, idsToMonoBinds )
  26
  27 import Inst             ( InstOrigin(..), LIE, emptyLIE, plusLIE, plusLIEs,
  28                           newDicts, newMethod )
  29 import TcEnv            ( TcId, TcEnv, TyThingDetails(..), tcAddImportedIdInfo,
  30                           tcLookupClass, tcExtendTyVarEnvForMeths, tcExtendGlobalTyVars,
  31                           tcExtendLocalValEnv, tcExtendTyVarEnv, newDefaultMethodName
  32                         )
  33 import TcBinds          ( tcBindWithSigs, tcSpecSigs )
  34 import TcMonoType       ( tcHsSigType, tcClassContext, checkSigTyVars, checkAmbiguity, sigCtxt, mkTcSig )
  35 import TcSimplify       ( tcSimplifyAndCheck, bindInstsOfLocalFuns )
  36 import TcType           ( TcType, TcTyVar, tcInstTyVars, zonkTcSigTyVars )
  37 import TcMonad
  38 import Generics         ( mkGenericRhs, validGenericMethodType )
  39 import PrelInfo         ( nO_METHOD_BINDING_ERROR_ID )
  40 import Class            ( classTyVars, classBigSig, classSelIds, classTyCon,
  41                           Class, ClassOpItem, DefMeth (..) )
  42 import MkId             ( mkDictSelId, mkDataConId, mkDataConWrapId, mkDefaultMethodId )
  43 import DataCon          ( mkDataCon, notMarkedStrict )
  44 import Id               ( Id, idType, idName )
  45 import Name             ( Name, isLocallyDefined, NamedThing(..),
  46                           NameEnv, lookupNameEnv, emptyNameEnv, unitNameEnv,
  47                           plusNameEnv, nameEnvElts )
  48 import NameSet          ( emptyNameSet )
  49 import Outputable
  50 import Type             ( Type, ClassContext, mkTyVarTys, mkDictTys, mkSigmaTy, mkClassPred,
  51                           splitTyConApp_maybe, isTyVarTy
  52                         )
  53 import Var              ( TyVar )
  54 import VarSet           ( mkVarSet, emptyVarSet )
  55 import CmdLineOpts
  56 import ErrUtils         ( dumpIfSet )
  57 import Util             ( count )
  58 import Maybes           ( seqMaybe, maybeToBool, orElse )
  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 tcClassDecl1 :: TcEnv -> RenamedTyClDecl -> TcM (Name, TyThingDetails)
 104 tcClassDecl1 rec_env
 105              (ClassDecl context class_name
 106                         tyvar_names fundeps class_sigs def_methods
 107                         sys_names src_loc)
 108   =     -- CHECK ARITY 1 FOR HASKELL 1.4
 109     doptsTc Opt_GlasgowExts                             `thenTc` \ glaExts ->
 110     checkTc (glaExts || length tyvar_names == 1)
 111             (classArityErr class_name)                  `thenTc_`
 112
 113         -- LOOK THINGS UP IN THE ENVIRONMENT
 114     tcLookupClass class_name                            `thenTc` \ clas ->
 115     let
 116         (tyvars, fds) = classTvsFds clas
 117         op_sigs  = filter isClassOpSig class_sigs
 118         op_names = [n | ClassOpSig n _ _ _ <- op_sigs]
 119         (_, datacon_name, datacon_wkr_name, sc_sel_names) = getClassDeclSysNames sys_names
 120     in
 121     tcExtendTyVarEnv tyvars                             $
 122
 123         -- CHECK THAT THE DEFAULT BINDINGS ARE LEGAL
 124     checkDefaultBinds clas op_names def_methods         `thenTc` \ dm_info ->
 125     checkGenericClassIsUnary clas dm_info               `thenTc_`
 126
 127         -- CHECK THE CONTEXT
 128     tcSuperClasses clas context sc_sel_names    `thenTc` \ (sc_theta, sc_sel_ids) ->
 129
 130         -- CHECK THE CLASS SIGNATURES,
 131     mapTc (tcClassSig rec_env tyvar_names clas tyvars fds dm_info)
 132           op_sigs                               `thenTc` \ sig_stuff ->
 133
 134         -- MAKE THE CLASS DETAILS
 135     let
 136         (op_tys, op_items) = unzip sig_stuff
 137         sc_tys             = mkDictTys sc_theta
 138         dict_component_tys = sc_tys ++ op_tys
 139
 140         dict_con = mkDataCon datacon_name
 141                              [notMarkedStrict | _ <- dict_component_tys]
 142                              [{- No labelled fields -}]
 143                              tyvars
 144                              [{-No context-}]
 145                              [{-No existential tyvars-}] [{-Or context-}]
 146                              dict_component_tys
 147                              (classTyCon clas)
 148                              dict_con_id dict_wrap_id
 149
 150         dict_con_id  = mkDataConId datacon_wkr_name dict_con
 151         dict_wrap_id = mkDataConWrapId dict_con
 152     in
 153     returnTc (class_name, ClassDetails sc_theta sc_sel_ids op_items dict_con)
 154 \end{code}
 155
 156 \begin{code}
 157 checkDefaultBinds :: Class -> [Name] -> RenamedMonoBinds -> TcM (NameEnv (DefMeth Name))
 158   -- Check default bindings
 159   --    a) must be for a class op for this class
 160   --    b) must be all generic or all non-generic
 161   -- and return a mapping from class-op to DefMeth info
 162
 163 checkDefaultBinds clas ops EmptyMonoBinds = returnTc emptyNameEnv
 164
 165 checkDefaultBinds clas ops (AndMonoBinds b1 b2)
 166   = checkDefaultBinds clas ops b1       `thenTc` \ dm_info1 ->
 167     checkDefaultBinds clas ops b2       `thenTc` \ dm_info2 ->
 168     returnTc (dm_info1 `plusNameEnv` dm_info2)
 169
 170 checkDefaultBinds clas ops (FunMonoBind op _ matches loc)
 171   = tcAddSrcLoc loc                                     $
 172
 173         -- Check that the op is from this class
 174     checkTc (op `elem` ops) (badMethodErr clas op)              `thenTc_`
 175
 176         -- Check that all the defns ar generic, or none are
 177     checkTc (all_generic || none_generic) (mixedGenericErr op)  `thenTc_`
 178
 179         -- Make up the right dm_info
 180     if all_generic then
 181         returnTc (unitNameEnv op GenDefMeth)
 182     else
 183         -- An explicit non-generic default method
 184         newDefaultMethodName op loc     `thenNF_Tc` \ dm_name ->
 185         returnTc (unitNameEnv op (DefMeth dm_name))
 186
 187   where
 188     n_generic    = count (maybeToBool . maybeGenericMatch) matches
 189     none_generic = n_generic == 0
 190     all_generic  = n_generic == length matches
 191
 192 checkGenericClassIsUnary clas dm_info
 193   = -- Check that if the class has generic methods, then the
 194     -- class has only one parameter.  We can't do generic
 195     -- multi-parameter type classes!
 196     checkTc (unary || no_generics) (genericMultiParamErr clas)
 197   where
 198     unary       = length (classTyVars clas) == 1
 199     no_generics = null [() | GenDefMeth <- nameEnvElts dm_info]
 200 \end{code}
 201
 202
 203 \begin{code}
 204 tcSuperClasses :: Class
 205                -> RenamedContext        -- class context
 206                -> [Name]                -- Names for superclass selectors
 207                -> TcM (ClassContext,    -- the superclass context
 208                          [Id])          -- superclass selector Ids
 209
 210 tcSuperClasses clas context sc_sel_names
 211   =     -- Check the context.
 212         -- The renamer has already checked that the context mentions
 213         -- only the type variable of the class decl.
 214
 215         -- For std Haskell check that the context constrains only tyvars
 216     doptsTc Opt_GlasgowExts                     `thenTc` \ glaExts ->
 217     (if glaExts then
 218         returnTc ()
 219      else
 220         mapTc_ check_constraint context
 221     )                                           `thenTc_`
 222
 223         -- Context is already kind-checked
 224     tcClassContext context                      `thenTc` \ sc_theta ->
 225     let
 226        sc_sel_ids = [mkDictSelId sc_name clas | sc_name <- sc_sel_names]
 227     in
 228         -- Done
 229     returnTc (sc_theta, sc_sel_ids)
 230
 231   where
 232     check_constraint sc@(HsPClass c tys)
 233         = checkTc (all is_tyvar tys) (superClassErr clas sc)
 234
 235     is_tyvar (HsTyVar _) = True
 236     is_tyvar other       = False
 237
 238
 239 tcClassSig :: TcEnv                     -- Knot tying only!
 240            -> [HsTyVarBndr Name]        -- From the declaration, for error messages
 241            -> Class                     -- ...ditto...
 242            -> [TyVar]                   -- The class type variable, used for error check only
 243            -> [FunDep TyVar]
 244            -> NameEnv (DefMeth Name)    -- Info about default methods
 245            -> RenamedClassOpSig
 246            -> TcM (Type,                -- Type of the method
 247                      ClassOpItem)       -- Selector Id, default-method Id, True if explicit default binding
 248
 249 -- This warrants an explanation: we need to separate generic
 250 -- default methods and default methods later on in the compiler
 251 -- so we distinguish them in checkDefaultBinds, and pass this knowledge in the
 252 -- Class.DefMeth data structure.
 253
 254 tcClassSig rec_env tyvar_names clas clas_tyvars fds dm_info
 255            (ClassOpSig op_name maybe_dm op_ty src_loc)
 256   = tcAddSrcLoc src_loc $
 257
 258         -- Check the type signature.  NB that the envt *already has*
 259         -- bindings for the type variables; see comments in TcTyAndClassDcls.
 260
 261     tcHsSigType op_ty                           `thenTc` \ local_ty ->
 262     let
 263         theta       = [mkClassPred clas (mkTyVarTys clas_tyvars)]
 264         global_ty   = mkSigmaTy clas_tyvars theta local_ty
 265
 266         -- Build the selector id and default method id
 267         sel_id      = mkDictSelId op_name clas
 268
 269         dm_info_name = maybe_dm `orElse` lookupNameEnv dm_info op_name `orElse` NoDefMeth
 270
 271         dm_info_id = case dm_info_name of
 272                         NoDefMeth       -> NoDefMeth
 273                         GenDefMeth      -> GenDefMeth
 274                         DefMeth dm_name -> DefMeth (tcAddImportedIdInfo rec_env dm_id)
 275                                         where
 276                                            dm_id = mkDefaultMethodId dm_name clas global_ty
 277
 278         full_hs_ty = HsForAllTy (Just tyvar_names) op_ty
 279     in
 280         -- Check for ambiguous class op types
 281     checkAmbiguity full_ty clas_tyvars theta local_ty            `thenRn_`
 282
 283         -- Check that for a generic method, the type of
 284         -- the method is sufficiently simple
 285     checkTc (dm_info_name /= GenDefMeth || validGenericMethodType local_ty)
 286             (badGenericMethodType op_name op_ty)                `thenTc_`
 287
 288     returnTc (local_ty, (sel_id, dm_info_id))
 289 \end{code}
 290
 291
 292 %************************************************************************
 293 %*                                                                      *
 294 \subsection[ClassDcl-pass2]{Class decls pass 2: default methods}
 295 %*                                                                      *
 296 %************************************************************************
 297
 298 @mkImplicitClassBinds@ produces a binding for the selector function for each method
 299 and superclass dictionary.
 300
 301 \begin{code}
 302 mkImplicitClassBinds :: [Class] -> NF_TcM ([Id], TcMonoBinds)
 303 mkImplicitClassBinds classes
 304   = returnNF_Tc (concat cls_ids_s, andMonoBindList binds_s)
 305         -- The selector binds are already in the selector Id's unfoldings
 306         -- We don't return the data constructor etc from the class,
 307         -- because that's done via the class's TyCon
 308   where
 309     (cls_ids_s, binds_s) = unzip (map mk_implicit classes)
 310
 311     mk_implicit clas = (sel_ids, binds)
 312                      where
 313                         sel_ids = classSelIds clas
 314                         binds | isLocallyDefined clas = idsToMonoBinds sel_ids
 315                               | otherwise             = EmptyMonoBinds
 316 \end{code}
 317
 318
 319
 320 %************************************************************************
 321 %*                                                                      *
 322 \subsection[Default methods]{Default methods}
 323 %*                                                                      *
 324 %************************************************************************
 325
 326 The default methods for a class are each passed a dictionary for the
 327 class, so that they get access to the other methods at the same type.
 328 So, given the class decl
 329 \begin{verbatim}
 330 class Foo a where
 331         op1 :: a -> Bool
 332         op2 :: Ord b => a -> b -> b -> b
 333
 334         op1 x = True
 335         op2 x y z = if (op1 x) && (y < z) then y else z
 336 \end{verbatim}
 337 we get the default methods:
 338 \begin{verbatim}
 339 defm.Foo.op1 :: forall a. Foo a => a -> Bool
 340 defm.Foo.op1 = /\a -> \dfoo -> \x -> True
 341
 342 defm.Foo.op2 :: forall a. Foo a => forall b. Ord b => a -> b -> b -> b
 343 defm.Foo.op2 = /\ a -> \ dfoo -> /\ b -> \ dord -> \x y z ->
 344                   if (op1 a dfoo x) && (< b dord y z) then y else z
 345 \end{verbatim}
 346
 347 When we come across an instance decl, we may need to use the default
 348 methods:
 349 \begin{verbatim}
 350 instance Foo Int where {}
 351 \end{verbatim}
 352 gives
 353 \begin{verbatim}
 354 const.Foo.Int.op1 :: Int -> Bool
 355 const.Foo.Int.op1 = defm.Foo.op1 Int dfun.Foo.Int
 356
 357 const.Foo.Int.op2 :: forall b. Ord b => Int -> b -> b -> b
 358 const.Foo.Int.op2 = defm.Foo.op2 Int dfun.Foo.Int
 359
 360 dfun.Foo.Int :: Foo Int
 361 dfun.Foo.Int = (const.Foo.Int.op1, const.Foo.Int.op2)
 362 \end{verbatim}
 363 Notice that, as with method selectors above, we assume that dictionary
 364 application is curried, so there's no need to mention the Ord dictionary
 365 in const.Foo.Int.op2 (or the type variable).
 366
 367 \begin{verbatim}
 368 instance Foo a => Foo [a] where {}
 369
 370 dfun.Foo.List :: forall a. Foo a -> Foo [a]
 371 dfun.Foo.List
 372   = /\ a -> \ dfoo_a ->
 373     let rec
 374         op1 = defm.Foo.op1 [a] dfoo_list
 375         op2 = defm.Foo.op2 [a] dfoo_list
 376         dfoo_list = (op1, op2)
 377     in
 378         dfoo_list
 379 \end{verbatim}
 380
 381 The function @tcClassDecls2@ just arranges to apply @tcClassDecl2@ to
 382 each local class decl.
 383
 384 \begin{code}
 385 tcClassDecls2 :: [RenamedHsDecl] -> NF_TcM (LIE, TcMonoBinds)
 386
 387 tcClassDecls2 decls
 388   = foldr combine
 389           (returnNF_Tc (emptyLIE, EmptyMonoBinds))
 390           [tcClassDecl2 cls_decl | TyClD cls_decl <- decls,
 391                                    isClassDecl cls_decl,
 392                                    isLocallyDefined (tyClDeclName cls_decl)]
 393   where
 394     combine tc1 tc2 = tc1 `thenNF_Tc` \ (lie1, binds1) ->
 395                       tc2 `thenNF_Tc` \ (lie2, binds2) ->
 396                       returnNF_Tc (lie1 `plusLIE` lie2,
 397                                    binds1 `AndMonoBinds` binds2)
 398 \end{code}
 399
 400 @tcClassDecl2@ generates bindings for polymorphic default methods
 401 (generic default methods have by now turned into instance declarations)
 402
 403 \begin{code}
 404 tcClassDecl2 :: RenamedTyClDecl         -- The class declaration
 405              -> NF_TcM (LIE, TcMonoBinds)
 406
 407 tcClassDecl2 (ClassDecl context class_name
 408                         tyvar_names _ sigs default_binds _ src_loc)
 409   =     -- A locally defined class
 410     recoverNF_Tc (returnNF_Tc (emptyLIE, EmptyMonoBinds)) $
 411     tcAddSrcLoc src_loc                                   $
 412     tcLookupClass class_name                              `thenNF_Tc` \ clas ->
 413
 414         -- We make a separate binding for each default method.
 415         -- At one time I used a single AbsBinds for all of them, thus
 416         -- AbsBind [d] [dm1, dm2, dm3] { dm1 = ...; dm2 = ...; dm3 = ... }
 417         -- But that desugars into
 418         --      ds = \d -> (..., ..., ...)
 419         --      dm1 = \d -> case ds d of (a,b,c) -> a
 420         -- And since ds is big, it doesn't get inlined, so we don't get good
 421         -- default methods.  Better to make separate AbsBinds for each
 422     let
 423         (tyvars, _, _, op_items) = classBigSig clas
 424         prags                    = filter isPragSig sigs
 425         tc_dm                    = tcDefMeth clas tyvars default_binds prags
 426     in
 427     mapAndUnzipTc tc_dm op_items        `thenTc` \ (defm_binds, const_lies) ->
 428
 429     returnTc (plusLIEs const_lies, andMonoBindList defm_binds)
 430
 431
 432 tcDefMeth clas tyvars binds_in prags (_, NoDefMeth)  = returnTc (EmptyMonoBinds, emptyLIE)
 433 tcDefMeth clas tyvars binds_in prags (_, GenDefMeth) = returnTc (EmptyMonoBinds, emptyLIE)
 434         -- Generate code for polymorphic default methods only
 435         -- (Generic default methods have turned into instance decls by now.)
 436         -- This is incompatible with Hugs, which expects a polymorphic
 437         -- default method for every class op, regardless of whether or not
 438         -- the programmer supplied an explicit default decl for the class.
 439         -- (If necessary we can fix that, but we don't have a convenient Id to hand.)
 440
 441 tcDefMeth clas tyvars binds_in prags op_item@(_, DefMeth dm_id)
 442   = tcInstTyVars tyvars                 `thenNF_Tc` \ (clas_tyvars, inst_tys, _) ->
 443     let
 444         theta = [(mkClassPred clas inst_tys)]
 445     in
 446     newDicts origin theta               `thenNF_Tc` \ (this_dict, [this_dict_id]) ->
 447
 448     tcExtendTyVarEnvForMeths tyvars clas_tyvars (
 449         tcMethodBind clas origin clas_tyvars inst_tys theta
 450                      binds_in prags False op_item
 451     )                                   `thenTc` \ (defm_bind, insts_needed, (_, local_dm_id)) ->
 452
 453     tcAddErrCtxt (defltMethCtxt clas) $
 454
 455         -- tcMethodBind has checked that the class_tyvars havn't
 456         -- been unified with each other or another type, but we must
 457         -- still zonk them before passing them to tcSimplifyAndCheck
 458     zonkTcSigTyVars clas_tyvars         `thenNF_Tc` \ clas_tyvars' ->
 459
 460         -- Check the context
 461     tcSimplifyAndCheck
 462         (ptext SLIT("class") <+> ppr clas)
 463         (mkVarSet clas_tyvars')
 464         this_dict
 465         insts_needed                    `thenTc` \ (const_lie, dict_binds) ->
 466
 467     let
 468         full_bind = AbsBinds
 469                     clas_tyvars'
 470                     [this_dict_id]
 471                     [(clas_tyvars', dm_id, local_dm_id)]
 472                     emptyNameSet        -- No inlines (yet)
 473                     (dict_binds `andMonoBinds` defm_bind)
 474     in
 475     returnTc (full_bind, const_lie)
 476   where
 477     origin = ClassDeclOrigin
 478 \end{code}
 479
 480
 481
 482 %************************************************************************
 483 %*                                                                      *
 484 \subsection{Typechecking a method}
 485 %*                                                                      *
 486 %************************************************************************
 487
 488 @tcMethodBind@ is used to type-check both default-method and
 489 instance-decl method declarations.  We must type-check methods one at a
 490 time, because their signatures may have different contexts and
 491 tyvar sets.
 492
 493 \begin{code}
 494 tcMethodBind
 495         :: Class
 496         -> InstOrigin
 497         -> [TcTyVar]            -- Instantiated type variables for the
 498                                 --  enclosing class/instance decl.
 499                                 --  They'll be signature tyvars, and we
 500                                 --  want to check that they don't get bound
 501         -> [TcType]             -- Instance types
 502         -> TcThetaType          -- Available theta; this could be used to check
 503                                 --  the method signature, but actually that's done by
 504                                 --  the caller;  here, it's just used for the error message
 505         -> RenamedMonoBinds     -- Method binding (pick the right one from in here)
 506         -> [RenamedSig]         -- Pramgas (just for this one)
 507         -> Bool                 -- True <=> This method is from an instance declaration
 508         -> ClassOpItem          -- The method selector and default-method Id
 509         -> TcM (TcMonoBinds, LIE, (LIE, TcId))
 510
 511 tcMethodBind clas origin inst_tyvars inst_tys inst_theta
 512              meth_binds prags is_inst_decl (sel_id, dm_info)
 513   = tcGetSrcLoc                         `thenNF_Tc` \ loc ->
 514     newMethod origin sel_id inst_tys    `thenNF_Tc` \ meth@(_, meth_id) ->
 515     mkTcSig meth_id loc                 `thenNF_Tc` \ sig_info ->
 516     let
 517         meth_name  = idName meth_id
 518         sig_msg    = ptext SLIT("When checking the expected type for class method") <+> ppr sel_id
 519         meth_prags = find_prags (idName sel_id) meth_name prags
 520     in
 521         -- Figure out what method binding to use
 522         -- If the user suppplied one, use it, else construct a default one
 523     (case find_bind (idName sel_id) meth_name meth_binds of
 524         Just user_bind -> returnTc user_bind
 525         Nothing        -> mkDefMethRhs is_inst_decl clas inst_tys sel_id loc dm_info    `thenTc` \ rhs ->
 526                           returnTc (FunMonoBind meth_name False -- Not infix decl
 527                                                 [mkSimpleMatch [] rhs Nothing loc] loc)
 528     )                                                           `thenTc` \ meth_bind ->
 529      -- Check the bindings; first add inst_tyvars to the envt
 530      -- so that we don't quantify over them in nested places
 531      -- The *caller* put the class/inst decl tyvars into the envt
 532      tcExtendGlobalTyVars (mkVarSet inst_tyvars)
 533                     (tcAddErrCtxt (methodCtxt sel_id)           $
 534                      tcBindWithSigs NotTopLevel meth_bind
 535                      [sig_info] meth_prags NonRecursive
 536                     )                                           `thenTc` \ (binds, insts, _) ->
 537
 538      tcExtendLocalValEnv [(meth_name, meth_id)]
 539                          (tcSpecSigs meth_prags)                `thenTc` \ (prag_binds1, prag_lie) ->
 540
 541      -- The prag_lie for a SPECIALISE pragma will mention the function
 542      -- itself, so we have to simplify them away right now lest they float
 543      -- outwards!
 544      bindInstsOfLocalFuns prag_lie [meth_id]    `thenTc` \ (prag_lie', prag_binds2) ->
 545
 546      -- Now check that the instance type variables
 547      -- (or, in the case of a class decl, the class tyvars)
 548      -- have not been unified with anything in the environment
 549      --
 550      -- We do this for each method independently to localise error messages
 551      -- ...and this is why the call to tcExtendGlobalTyVars must be here
 552      --    rather than in the caller
 553      tcAddErrCtxtM (sigCtxt sig_msg inst_tyvars inst_theta (idType meth_id))    $
 554      checkSigTyVars inst_tyvars emptyVarSet                                     `thenTc_`
 555
 556      returnTc (binds `AndMonoBinds` prag_binds1 `AndMonoBinds` prag_binds2,
 557                insts `plusLIE` prag_lie',
 558                meth)
 559
 560      -- The user didn't supply a method binding,
 561      -- so we have to make up a default binding
 562      -- The RHS of a default method depends on the default-method info
 563 mkDefMethRhs is_inst_decl clas inst_tys sel_id loc (DefMeth dm_id)
 564   =  -- An polymorphic default method
 565     returnTc (HsVar (idName dm_id))
 566
 567 mkDefMethRhs is_inst_decl clas inst_tys sel_id loc NoDefMeth
 568   =     -- No default method
 569         -- Warn only if -fwarn-missing-methods
 570     doptsTc Opt_WarnMissingMethods  `thenNF_Tc` \ warn ->
 571     warnTc (is_inst_decl && warn)
 572            (omittedMethodWarn sel_id clas)              `thenNF_Tc_`
 573     returnTc error_rhs
 574   where
 575     error_rhs = HsApp (HsVar (getName nO_METHOD_BINDING_ERROR_ID))
 576                           (HsLit (HsString (_PK_ error_msg)))
 577     error_msg = showSDoc (hcat [ppr loc, text "|", ppr sel_id ])
 578
 579
 580 mkDefMethRhs is_inst_decl clas inst_tys sel_id loc GenDefMeth
 581   =     -- A generic default method
 582         -- If the method is defined generically, we can only do the job if the
 583         -- instance declaration is for a single-parameter type class with
 584         -- a type constructor applied to type arguments in the instance decl
 585         --      (checkTc, so False provokes the error)
 586      checkTc (not is_inst_decl || simple_inst)
 587              (badGenericInstance sel_id clas)                   `thenTc_`
 588
 589      ioToTc (dumpIfSet opt_PprStyle_Debug "Generic RHS" stuff)  `thenNF_Tc_`
 590      returnTc rhs
 591   where
 592     rhs = mkGenericRhs sel_id clas_tyvar tycon
 593
 594     stuff = vcat [ppr clas <+> ppr inst_tys,
 595                   nest 4 (ppr sel_id <+> equals <+> ppr rhs)]
 596
 597           -- The tycon is only used in the generic case, and in that
 598           -- case we require that the instance decl is for a single-parameter
 599           -- type class with type variable arguments:
 600           --    instance (...) => C (T a b)
 601     simple_inst   = maybeToBool maybe_tycon
 602     clas_tyvar    = head (classTyVars clas)
 603     Just tycon    = maybe_tycon
 604     maybe_tycon   = case inst_tys of
 605                         [ty] -> case splitTyConApp_maybe ty of
 606                                   Just (tycon, arg_tys) | all isTyVarTy arg_tys -> Just tycon
 607                                   other                                         -> Nothing
 608                         other -> Nothing
 609 \end{code}
 610
 611
 612 \begin{code}
 613 -- The renamer just puts the selector ID as the binder in the method binding
 614 -- but we must use the method name; so we substitute it here.  Crude but simple.
 615 find_bind sel_name meth_name (FunMonoBind op_name fix matches loc)
 616     | op_name == sel_name = Just (FunMonoBind meth_name fix matches loc)
 617 find_bind sel_name meth_name (AndMonoBinds b1 b2)
 618     = find_bind sel_name meth_name b1 `seqMaybe` find_bind sel_name meth_name b2
 619 find_bind sel_name meth_name other  = Nothing   -- Default case
 620
 621  -- Find the prags for this method, and replace the
 622  -- selector name with the method name
 623 find_prags sel_name meth_name [] = []
 624 find_prags sel_name meth_name (SpecSig name ty loc : prags)
 625      | name == sel_name = SpecSig meth_name ty loc : find_prags sel_name meth_name prags
 626 find_prags sel_name meth_name (InlineSig name phase loc : prags)
 627    | name == sel_name = InlineSig meth_name phase loc : find_prags sel_name meth_name prags
 628 find_prags sel_name meth_name (NoInlineSig name phase loc : prags)
 629    | name == sel_name = NoInlineSig meth_name phase loc : find_prags sel_name meth_name prags
 630 find_prags sel_name meth_name (prag:prags) = find_prags sel_name meth_name prags
 631 \end{code}
 632
 633
 634 Contexts and errors
 635 ~~~~~~~~~~~~~~~~~~~
 636 \begin{code}
 637 classArityErr class_name
 638   = ptext SLIT("Too many parameters for class") <+> quotes (ppr class_name)
 639
 640 superClassErr clas sc
 641   = ptext SLIT("Illegal superclass constraint") <+> quotes (ppr sc)
 642     <+> ptext SLIT("in declaration for class") <+> quotes (ppr clas)
 643
 644 defltMethCtxt clas
 645   = ptext SLIT("When checking the default methods for class") <+> quotes (ppr clas)
 646
 647 methodCtxt sel_id
 648   = ptext SLIT("In the definition for method") <+> quotes (ppr sel_id)
 649
 650 badMethodErr clas op
 651   = hsep [ptext SLIT("Class"), quotes (ppr clas),
 652           ptext SLIT("does not have a method"), quotes (ppr op)]
 653
 654 omittedMethodWarn sel_id clas
 655   = sep [ptext SLIT("No explicit method nor default method for") <+> quotes (ppr sel_id),
 656          ptext SLIT("in an instance declaration for") <+> quotes (ppr clas)]
 657
 658 badGenericMethodType op op_ty
 659   = hang (ptext SLIT("Generic method type is too complex"))
 660        4 (vcat [ppr op <+> dcolon <+> ppr op_ty,
 661                 ptext SLIT("You can only use type variables, arrows, and tuples")])
 662
 663 badGenericInstance sel_id clas
 664   = sep [ptext SLIT("Can't derive generic code for") <+> quotes (ppr sel_id),
 665          ptext SLIT("because the instance declaration is not for a simple type (T a b c)"),
 666          ptext SLIT("(where T is a derivable type constructor)"),
 667          ptext SLIT("in an instance declaration for") <+> quotes (ppr clas)]
 668
 669 mixedGenericErr op
 670   = ptext SLIT("Can't mix generic and non-generic equations for class method") <+> quotes (ppr op)
 671
 672 genericMultiParamErr clas
 673   = ptext SLIT("The multi-parameter class") <+> quotes (ppr clas) <+>
 674     ptext SLIT("cannot have generic methods")
 675 \end{code}