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