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 ( kcClassDecl, tcClassDecl1, tcClassDecls2, mkImplicitClassBinds,
   8                     tcMethodBind, checkFromThisClass
   9                   ) where
  10
  11 #include "HsVersions.h"
  12
  13 import HsSyn            ( HsDecl(..), TyClDecl(..), Sig(..), MonoBinds(..),
  14                           InPat(..), HsBinds(..), GRHSs(..),
  15                           HsExpr(..), HsLit(..), HsType(..), HsPred(..),
  16                           pprHsClassAssertion, unguardedRHS,
  17                           andMonoBinds, andMonoBindList, getTyVarName,
  18                           isClassDecl, isClassOpSig, isPragSig, collectMonoBinders
  19                         )
  20 import HsPragmas        ( ClassPragmas(..) )
  21 import BasicTypes       ( NewOrData(..), TopLevelFlag(..), RecFlag(..) )
  22 import RnHsSyn          ( RenamedTyClDecl, RenamedClassPragmas,
  23                           RenamedClassOpSig, RenamedMonoBinds,
  24                           RenamedContext, RenamedHsDecl, RenamedSig
  25                         )
  26 import TcHsSyn          ( TcMonoBinds, idsToMonoBinds )
  27
  28 import Inst             ( Inst, InstOrigin(..), LIE, emptyLIE, plusLIE, plusLIEs, newDicts, newMethod )
  29 import TcEnv            ( TcId, ValueEnv, TcTyThing(..), tcAddImportedIdInfo,
  30                           tcLookupClass, tcLookupTy, tcExtendTyVarEnvForMeths, tcExtendGlobalTyVars,
  31                           tcExtendLocalValEnv
  32                         )
  33 import TcBinds          ( tcBindWithSigs, tcSpecSigs )
  34 import TcTyDecls        ( mkNewTyConRep )
  35 import TcUnify          ( unifyKinds )
  36 import TcMonad
  37 import TcMonoType       ( kcHsType, tcHsTopType, tcExtendTopTyVarScope,
  38                           tcContext, checkSigTyVars, sigCtxt, mkTcSig
  39                         )
  40 import TcSimplify       ( tcSimplifyAndCheck, bindInstsOfLocalFuns )
  41 import TcType           ( TcType, TcTyVar, tcInstTyVars, zonkTcTyVarBndr, tcGetTyVar )
  42 import TcInstUtil       ( classDataCon )
  43 import PrelInfo         ( nO_METHOD_BINDING_ERROR_ID )
  44 import FieldLabel       ( firstFieldLabelTag )
  45 import Bag              ( unionManyBags, bagToList )
  46 import Class            ( mkClass, classBigSig, classSelIds, Class, ClassOpItem )
  47 import CmdLineOpts      ( opt_GlasgowExts, opt_WarnMissingMethods )
  48 import MkId             ( mkDictSelId, mkDataConId, mkDataConWrapId, mkDefaultMethodId )
  49 import DataCon          ( mkDataCon, dataConId, dataConWrapId, notMarkedStrict )
  50 import Id               ( Id, setInlinePragma, idUnfolding, idType, idName )
  51 import CoreUnfold       ( unfoldingTemplate )
  52 import IdInfo
  53 import Name             ( Name, nameOccName, isLocallyDefined, NamedThing(..) )
  54 import NameSet          ( emptyNameSet )
  55 import Outputable
  56 import Type             ( Type, ThetaType, ClassContext,
  57                           mkFunTy, mkTyVarTy, mkTyVarTys, mkDictTy, mkDictTys,
  58                           mkSigmaTy, mkForAllTys, mkClassPred, classesOfPreds,
  59                           boxedTypeKind, mkArrowKind
  60                         )
  61 import Var              ( tyVarKind, TyVar )
  62 import VarSet           ( mkVarSet, emptyVarSet )
  63 import TyCon            ( AlgTyConFlavour(..), mkClassTyCon )
  64 import Unique           ( Unique, Uniquable(..) )
  65 import Util
  66 import Maybes           ( seqMaybe )
  67 import FiniteMap        ( lookupWithDefaultFM )
  68 \end{code}
  69
  70
  71
  72 Dictionary handling
  73 ~~~~~~~~~~~~~~~~~~~
  74 Every class implicitly declares a new data type, corresponding to dictionaries
  75 of that class. So, for example:
  76
  77         class (D a) => C a where
  78           op1 :: a -> a
  79           op2 :: forall b. Ord b => a -> b -> b
  80
  81 would implicitly declare
  82
  83         data CDict a = CDict (D a)
  84                              (a -> a)
  85                              (forall b. Ord b => a -> b -> b)
  86
  87 (We could use a record decl, but that means changing more of the existing apparatus.
  88 One step at at time!)
  89
  90 For classes with just one superclass+method, we use a newtype decl instead:
  91
  92         class C a where
  93           op :: forallb. a -> b -> b
  94
  95 generates
  96
  97         newtype CDict a = CDict (forall b. a -> b -> b)
  98
  99 Now DictTy in Type is just a form of type synomym:
 100         DictTy c t = TyConTy CDict `AppTy` t
 101
 102 Death to "ExpandingDicts".
 103
 104
 105 %************************************************************************
 106 %*                                                                      *
 107 \subsection{Kind checking}
 108 %*                                                                      *
 109 %************************************************************************
 110
 111 \begin{code}
 112 kcClassDecl (ClassDecl  context class_name
 113                         tyvar_names fundeps class_sigs def_methods pragmas
 114                         _ _ _ _ src_loc)
 115   =         -- CHECK ARITY 1 FOR HASKELL 1.4
 116     checkTc (opt_GlasgowExts || length tyvar_names == 1)
 117             (classArityErr class_name)          `thenTc_`
 118
 119         -- Get the (mutable) class kind
 120     tcLookupTy class_name                       `thenNF_Tc` \ (kind, _, _) ->
 121
 122         -- Make suitable tyvars and do kind checking
 123         -- The net effect is to mutate the class kind
 124     tcExtendTopTyVarScope kind tyvar_names      $ \ _ _ ->
 125     tcContext context                           `thenTc_`
 126     mapTc kc_sig the_class_sigs                 `thenTc_`
 127
 128     returnTc ()
 129   where
 130     the_class_sigs = filter isClassOpSig class_sigs
 131
 132     kc_sig (ClassOpSig _ _ _ op_ty loc) = tcAddSrcLoc loc (kcHsType op_ty)
 133 \end{code}
 134
 135
 136 %************************************************************************
 137 %*                                                                      *
 138 \subsection{Type checking}
 139 %*                                                                      *
 140 %************************************************************************
 141
 142 \begin{code}
 143 tcClassDecl1 rec_env rec_inst_mapper rec_vrcs
 144              (ClassDecl context class_name
 145                         tyvar_names fundeps class_sigs def_methods pragmas
 146                         tycon_name datacon_name datacon_wkr_name sc_sel_names src_loc)
 147   =     -- LOOK THINGS UP IN THE ENVIRONMENT
 148     tcLookupTy class_name                               `thenTc` \ (class_kind, _, AClass rec_class) ->
 149     tcExtendTopTyVarScope class_kind tyvar_names        $ \ tyvars _ ->
 150         -- The class kind is by now immutable
 151
 152         -- CHECK THE CONTEXT
 153 --  traceTc (text "tcClassCtxt" <+> ppr class_name)     `thenTc_`
 154     tcClassContext class_name rec_class tyvars context sc_sel_names
 155                                                 `thenTc` \ (sc_theta, sc_tys, sc_sel_ids) ->
 156 --  traceTc (text "tcClassCtxt done" <+> ppr class_name)        `thenTc_`
 157
 158         -- CHECK THE FUNCTIONAL DEPENDENCIES,
 159     tcFundeps fundeps                           `thenTc` \ fds ->
 160
 161         -- CHECK THE CLASS SIGNATURES,
 162     mapTc (tcClassSig rec_env rec_class tyvars)
 163           (filter isClassOpSig class_sigs)
 164                                                 `thenTc` \ sig_stuff ->
 165
 166         -- MAKE THE CLASS OBJECT ITSELF
 167     let
 168         (op_tys, op_items) = unzip sig_stuff
 169         rec_class_inst_env = rec_inst_mapper rec_class
 170         clas = mkClass class_name tyvars fds
 171                        sc_theta sc_sel_ids op_items
 172                        tycon
 173                        rec_class_inst_env
 174
 175         dict_component_tys = sc_tys ++ op_tys
 176         new_or_data = case dict_component_tys of
 177                         [_]   -> NewTyCon (mkNewTyConRep tycon)
 178                         other -> DataTyCon
 179
 180         dict_con = mkDataCon datacon_name
 181                            [notMarkedStrict | _ <- dict_component_tys]
 182                            [{- No labelled fields -}]
 183                            tyvars
 184                            [{-No context-}]
 185                            [{-No existential tyvars-}] [{-Or context-}]
 186                            dict_component_tys
 187                            tycon dict_con_id dict_wrap_id
 188
 189         dict_con_id  = mkDataConId datacon_wkr_name dict_con
 190         dict_wrap_id = mkDataConWrapId dict_con
 191
 192         argvrcs = lookupWithDefaultFM rec_vrcs (pprPanic "tcClassDecl1: argvrcs:" $
 193                                                          ppr tycon_name)
 194                                       tycon_name
 195
 196         tycon = mkClassTyCon tycon_name
 197                              class_kind
 198                              tyvars
 199                              argvrcs
 200                              dict_con           -- Constructors
 201                              clas               -- Yes!  It's a dictionary
 202                              new_or_data
 203     in
 204     returnTc clas
 205 \end{code}
 206
 207 \begin{code}
 208 tcFundeps = mapTc tc_fundep
 209 tc_fundep (us, vs) =
 210     mapTc tc_fd_tyvar us        `thenTc` \ us' ->
 211     mapTc tc_fd_tyvar vs        `thenTc` \ vs' ->
 212     returnTc (us', vs')
 213 tc_fd_tyvar v =
 214     tcLookupTy v `thenTc` \(_, _, thing) ->
 215     case thing of
 216         ATyVar tv -> returnTc tv
 217         -- ZZ else should fail more gracefully
 218 \end{code}
 219
 220 \begin{code}
 221 tcClassContext :: Name -> Class -> [TyVar]
 222                -> RenamedContext        -- class context
 223                -> [Name]                -- Names for superclass selectors
 224                -> TcM s (ClassContext,  -- the superclass context
 225                          [Type],        -- types of the superclass dictionaries
 226                          [Id])          -- superclass selector Ids
 227
 228 tcClassContext class_name rec_class rec_tyvars context sc_sel_names
 229   =     -- Check the context.
 230         -- The renamer has already checked that the context mentions
 231         -- only the type variable of the class decl.
 232
 233         -- For std Haskell check that the context constrains only tyvars
 234     (if opt_GlasgowExts then
 235         returnTc []
 236      else
 237         mapTc check_constraint context
 238     )                                   `thenTc_`
 239
 240     tcContext context                   `thenTc` \ sc_theta ->
 241
 242     let
 243        sc_theta' = classesOfPreds sc_theta
 244        sc_tys = mkDictTys sc_theta'
 245        sc_sel_ids = [mkDictSelId sc_name rec_class | sc_name <- sc_sel_names]
 246     in
 247         -- Done
 248     returnTc (sc_theta', sc_tys, sc_sel_ids)
 249
 250   where
 251     rec_tyvar_tys = mkTyVarTys rec_tyvars
 252
 253     check_constraint (HsPClass c tys) = checkTc (all is_tyvar tys)
 254                                                 (superClassErr class_name (c, tys))
 255
 256     is_tyvar (MonoTyVar _) = True
 257     is_tyvar other         = False
 258
 259
 260 tcClassSig :: ValueEnv          -- Knot tying only!
 261            -> Class                     -- ...ditto...
 262            -> [TyVar]                   -- The class type variable, used for error check only
 263            -> RenamedClassOpSig
 264            -> TcM s (Type,              -- Type of the method
 265                      ClassOpItem)       -- Selector Id, default-method Id, True if explicit default binding
 266
 267
 268 tcClassSig rec_env rec_clas rec_clas_tyvars
 269            (ClassOpSig op_name dm_name explicit_dm
 270                        op_ty src_loc)
 271   = tcAddSrcLoc src_loc $
 272
 273         -- Check the type signature.  NB that the envt *already has*
 274         -- bindings for the type variables; see comments in TcTyAndClassDcls.
 275
 276     -- NB: Renamer checks that the class type variable is mentioned in local_ty,
 277     -- and that it is not constrained by theta
 278 --  traceTc (text "tcClassSig" <+> ppr op_name) `thenTc_`
 279     tcHsTopType op_ty                           `thenTc` \ local_ty ->
 280     let
 281         global_ty   = mkSigmaTy rec_clas_tyvars
 282                                 [mkClassPred rec_clas (mkTyVarTys rec_clas_tyvars)]
 283                                 local_ty
 284
 285         -- Build the selector id and default method id
 286         sel_id      = mkDictSelId op_name rec_clas
 287         dm_id       = mkDefaultMethodId dm_name rec_clas global_ty
 288         final_dm_id = tcAddImportedIdInfo rec_env dm_id
 289     in
 290 --  traceTc (text "tcClassSig done" <+> ppr op_name)    `thenTc_`
 291     returnTc (local_ty, (sel_id, final_dm_id, explicit_dm))
 292 \end{code}
 293
 294
 295 %************************************************************************
 296 %*                                                                      *
 297 \subsection[ClassDcl-pass2]{Class decls pass 2: default methods}
 298 %*                                                                      *
 299 %************************************************************************
 300
 301 The purpose of pass 2 is
 302 \begin{enumerate}
 303 \item
 304 to beat on the explicitly-provided default-method decls (if any),
 305 using them to produce a complete set of default-method decls.
 306 (Omitted ones elicit an error message.)
 307 \item
 308 to produce a definition for the selector function for each method
 309 and superclass dictionary.
 310 \end{enumerate}
 311
 312 Pass~2 only applies to locally-defined class declarations.
 313
 314 The function @tcClassDecls2@ just arranges to apply @tcClassDecl2@ to
 315 each local class decl.
 316
 317 \begin{code}
 318 tcClassDecls2 :: [RenamedHsDecl]
 319               -> NF_TcM s (LIE, TcMonoBinds)
 320
 321 tcClassDecls2 decls
 322   = foldr combine
 323           (returnNF_Tc (emptyLIE, EmptyMonoBinds))
 324           [tcClassDecl2 cls_decl | TyClD cls_decl <- decls, isClassDecl cls_decl]
 325   where
 326     combine tc1 tc2 = tc1 `thenNF_Tc` \ (lie1, binds1) ->
 327                       tc2 `thenNF_Tc` \ (lie2, binds2) ->
 328                       returnNF_Tc (lie1 `plusLIE` lie2,
 329                                    binds1 `AndMonoBinds` binds2)
 330 \end{code}
 331
 332 @tcClassDecl2@ is the business end of things.
 333
 334 \begin{code}
 335 tcClassDecl2 :: RenamedTyClDecl         -- The class declaration
 336              -> NF_TcM s (LIE, TcMonoBinds)
 337
 338 tcClassDecl2 (ClassDecl context class_name
 339                         tyvar_names _ class_sigs default_binds pragmas _ _ _ _ src_loc)
 340
 341   | not (isLocallyDefined class_name)
 342   = returnNF_Tc (emptyLIE, EmptyMonoBinds)
 343
 344   | otherwise   -- It is locally defined
 345   = recoverNF_Tc (returnNF_Tc (emptyLIE, EmptyMonoBinds)) $
 346     tcAddSrcLoc src_loc                                   $
 347     tcLookupClass class_name                            `thenNF_Tc` \ clas ->
 348     tcDefaultMethodBinds clas default_binds class_sigs
 349 \end{code}
 350
 351 \begin{code}
 352 mkImplicitClassBinds :: [Class] -> NF_TcM s ([Id], TcMonoBinds)
 353 mkImplicitClassBinds classes
 354   = returnNF_Tc (concat cls_ids_s, andMonoBindList binds_s)
 355         -- The selector binds are already in the selector Id's unfoldings
 356   where
 357     (cls_ids_s, binds_s) = unzip (map mk_implicit classes)
 358
 359     mk_implicit clas = (all_cls_ids, binds)
 360                      where
 361                         dict_con    = classDataCon clas
 362                         all_cls_ids = dataConId dict_con : cls_ids
 363                         cls_ids     = dataConWrapId dict_con : classSelIds clas
 364
 365                         -- The wrapper and selectors get bindings, the worker does not
 366                         binds | isLocallyDefined clas = idsToMonoBinds cls_ids
 367                               | otherwise             = EmptyMonoBinds
 368 \end{code}
 369
 370 %************************************************************************
 371 %*                                                                      *
 372 \subsection[Default methods]{Default methods}
 373 %*                                                                      *
 374 %************************************************************************
 375
 376 The default methods for a class are each passed a dictionary for the
 377 class, so that they get access to the other methods at the same type.
 378 So, given the class decl
 379 \begin{verbatim}
 380 class Foo a where
 381         op1 :: a -> Bool
 382         op2 :: Ord b => a -> b -> b -> b
 383
 384         op1 x = True
 385         op2 x y z = if (op1 x) && (y < z) then y else z
 386 \end{verbatim}
 387 we get the default methods:
 388 \begin{verbatim}
 389 defm.Foo.op1 :: forall a. Foo a => a -> Bool
 390 defm.Foo.op1 = /\a -> \dfoo -> \x -> True
 391
 392 defm.Foo.op2 :: forall a. Foo a => forall b. Ord b => a -> b -> b -> b
 393 defm.Foo.op2 = /\ a -> \ dfoo -> /\ b -> \ dord -> \x y z ->
 394                   if (op1 a dfoo x) && (< b dord y z) then y else z
 395 \end{verbatim}
 396
 397 When we come across an instance decl, we may need to use the default
 398 methods:
 399 \begin{verbatim}
 400 instance Foo Int where {}
 401 \end{verbatim}
 402 gives
 403 \begin{verbatim}
 404 const.Foo.Int.op1 :: Int -> Bool
 405 const.Foo.Int.op1 = defm.Foo.op1 Int dfun.Foo.Int
 406
 407 const.Foo.Int.op2 :: forall b. Ord b => Int -> b -> b -> b
 408 const.Foo.Int.op2 = defm.Foo.op2 Int dfun.Foo.Int
 409
 410 dfun.Foo.Int :: Foo Int
 411 dfun.Foo.Int = (const.Foo.Int.op1, const.Foo.Int.op2)
 412 \end{verbatim}
 413 Notice that, as with method selectors above, we assume that dictionary
 414 application is curried, so there's no need to mention the Ord dictionary
 415 in const.Foo.Int.op2 (or the type variable).
 416
 417 \begin{verbatim}
 418 instance Foo a => Foo [a] where {}
 419
 420 dfun.Foo.List :: forall a. Foo a -> Foo [a]
 421 dfun.Foo.List
 422   = /\ a -> \ dfoo_a ->
 423     let rec
 424         op1 = defm.Foo.op1 [a] dfoo_list
 425         op2 = defm.Foo.op2 [a] dfoo_list
 426         dfoo_list = (op1, op2)
 427     in
 428         dfoo_list
 429 \end{verbatim}
 430
 431 \begin{code}
 432 tcDefaultMethodBinds
 433         :: Class
 434         -> RenamedMonoBinds
 435         -> [RenamedSig]
 436         -> TcM s (LIE, TcMonoBinds)
 437
 438 tcDefaultMethodBinds clas default_binds sigs
 439   =     -- Check that the default bindings come from this class
 440     checkFromThisClass clas op_items default_binds      `thenNF_Tc_`
 441
 442         -- Do each default method separately
 443         -- For Hugs compatibility we make a default-method for every
 444         -- class op, regardless of whether or not the programmer supplied an
 445         -- explicit default decl for the class.  GHC will actually never
 446         -- call the default method for such operations, because it'll whip up
 447         -- a more-informative default method at each instance decl.
 448     mapAndUnzipTc tc_dm op_items                `thenTc` \ (defm_binds, const_lies) ->
 449
 450     returnTc (plusLIEs const_lies, andMonoBindList defm_binds)
 451   where
 452     prags = filter isPragSig sigs
 453
 454     (tyvars, _, _, op_items) = classBigSig clas
 455
 456     origin = ClassDeclOrigin
 457
 458     -- We make a separate binding for each default method.
 459     -- At one time I used a single AbsBinds for all of them, thus
 460     --  AbsBind [d] [dm1, dm2, dm3] { dm1 = ...; dm2 = ...; dm3 = ... }
 461     -- But that desugars into
 462     --  ds = \d -> (..., ..., ...)
 463     --  dm1 = \d -> case ds d of (a,b,c) -> a
 464     -- And since ds is big, it doesn't get inlined, so we don't get good
 465     -- default methods.  Better to make separate AbsBinds for each
 466
 467     tc_dm op_item@(_, dm_id, _)
 468       = tcInstTyVars tyvars             `thenNF_Tc` \ (clas_tyvars, inst_tys, _) ->
 469         let
 470             theta = [(mkClassPred clas inst_tys)]
 471         in
 472         newDicts origin theta                   `thenNF_Tc` \ (this_dict, [this_dict_id]) ->
 473         let
 474             avail_insts = this_dict
 475         in
 476         tcExtendTyVarEnvForMeths tyvars clas_tyvars (
 477             tcMethodBind clas origin clas_tyvars inst_tys theta
 478                          default_binds prags False
 479                          op_item
 480         )                                       `thenTc` \ (defm_bind, insts_needed, (_, local_dm_id)) ->
 481
 482         tcAddErrCtxt (defltMethCtxt clas) $
 483
 484             -- tcMethodBind has checked that the class_tyvars havn't
 485             -- been unified with each other or another type, but we must
 486             -- still zonk them before passing them to tcSimplifyAndCheck
 487         mapNF_Tc zonkTcTyVarBndr clas_tyvars    `thenNF_Tc` \ clas_tyvars' ->
 488
 489             -- Check the context
 490         tcSimplifyAndCheck
 491             (ptext SLIT("class") <+> ppr clas)
 492             (mkVarSet clas_tyvars')
 493             avail_insts
 494             insts_needed                        `thenTc` \ (const_lie, dict_binds) ->
 495
 496         let
 497             full_bind = AbsBinds
 498                             clas_tyvars'
 499                             [this_dict_id]
 500                             [(clas_tyvars', dm_id, local_dm_id)]
 501                             emptyNameSet        -- No inlines (yet)
 502                             (dict_binds `andMonoBinds` defm_bind)
 503         in
 504         returnTc (full_bind, const_lie)
 505 \end{code}
 506
 507 \begin{code}
 508 checkFromThisClass :: Class -> [ClassOpItem] -> RenamedMonoBinds -> NF_TcM s ()
 509 checkFromThisClass clas op_items mono_binds
 510   = mapNF_Tc check_from_this_class bndrs        `thenNF_Tc_`
 511     returnNF_Tc ()
 512   where
 513     check_from_this_class (bndr, loc)
 514           | nameOccName bndr `elem` sel_names = returnNF_Tc ()
 515           | otherwise                         = tcAddSrcLoc loc $
 516                                                 addErrTc (badMethodErr bndr clas)
 517     sel_names = [getOccName sel_id | (sel_id,_,_) <- op_items]
 518     bndrs = bagToList (collectMonoBinders mono_binds)
 519 \end{code}
 520
 521
 522 @tcMethodBind@ is used to type-check both default-method and
 523 instance-decl method declarations.  We must type-check methods one at a
 524 time, because their signatures may have different contexts and
 525 tyvar sets.
 526
 527 \begin{code}
 528 tcMethodBind
 529         :: Class
 530         -> InstOrigin
 531         -> [TcTyVar]            -- Instantiated type variables for the
 532                                 --  enclosing class/instance decl.
 533                                 --  They'll be signature tyvars, and we
 534                                 --  want to check that they don't get bound
 535         -> [TcType]             -- Instance types
 536         -> TcThetaType          -- Available theta; this could be used to check
 537                                 --  the method signature, but actually that's done by
 538                                 --  the caller;  here, it's just used for the error message
 539         -> RenamedMonoBinds     -- Method binding (pick the right one from in here)
 540         -> [RenamedSig]         -- Pramgas (just for this one)
 541         -> Bool                 -- True <=> This method is from an instance declaration
 542         -> ClassOpItem          -- The method selector and default-method Id
 543         -> TcM s (TcMonoBinds, LIE, (LIE, TcId))
 544
 545 tcMethodBind clas origin inst_tyvars inst_tys inst_theta
 546              meth_binds prags is_inst_decl
 547              (sel_id, dm_id, explicit_dm)
 548  = tcGetSrcLoc          `thenNF_Tc` \ loc ->
 549
 550    newMethod origin sel_id inst_tys     `thenNF_Tc` \ meth@(_, meth_id) ->
 551    mkTcSig meth_id loc                  `thenNF_Tc` \ sig_info ->
 552
 553    let
 554      meth_name       = idName meth_id
 555      maybe_user_bind = find_bind meth_name meth_binds
 556
 557      no_user_bind    = case maybe_user_bind of {Nothing -> True; other -> False}
 558
 559      meth_bind = case maybe_user_bind of
 560                         Just bind -> bind
 561                         Nothing   -> mk_default_bind meth_name loc
 562
 563      meth_prags = find_prags meth_name prags
 564    in
 565
 566         -- Warn if no method binding, only if -fwarn-missing-methods
 567    warnTc (is_inst_decl && opt_WarnMissingMethods && no_user_bind && not explicit_dm)
 568           (omittedMethodWarn sel_id clas)               `thenNF_Tc_`
 569
 570         -- Check the bindings; first add inst_tyvars to the envt
 571         -- so that we don't quantify over them in nested places
 572         -- The *caller* put the class/inst decl tyvars into the envt
 573    tcExtendGlobalTyVars (mkVarSet inst_tyvars) (
 574      tcAddErrCtxt (methodCtxt sel_id)           $
 575      tcBindWithSigs NotTopLevel meth_bind
 576                     [sig_info] meth_prags NonRecursive
 577    )                                            `thenTc` \ (binds, insts, _) ->
 578
 579
 580    tcExtendLocalValEnv [(meth_name, meth_id)] (
 581         tcSpecSigs meth_prags
 582    )                                            `thenTc` \ (prag_binds1, prag_lie) ->
 583
 584         -- The prag_lie for a SPECIALISE pragma will mention the function
 585         -- itself, so we have to simplify them away right now lest they float
 586         -- outwards!
 587    bindInstsOfLocalFuns prag_lie [meth_id]      `thenTc` \ (prag_lie', prag_binds2) ->
 588
 589
 590         -- Now check that the instance type variables
 591         -- (or, in the case of a class decl, the class tyvars)
 592         -- have not been unified with anything in the environment
 593    tcAddErrCtxtM (sigCtxt sig_msg inst_tyvars inst_theta (idType meth_id))      $
 594    checkSigTyVars inst_tyvars emptyVarSet                                       `thenTc_`
 595
 596    returnTc (binds `AndMonoBinds` prag_binds1 `AndMonoBinds` prag_binds2,
 597              insts `plusLIE` prag_lie',
 598              meth)
 599  where
 600    sig_msg = ptext SLIT("When checking the expected type for class method") <+> ppr sel_name
 601
 602    sel_name = idName sel_id
 603
 604         -- The renamer just puts the selector ID as the binder in the method binding
 605         -- but we must use the method name; so we substitute it here.  Crude but simple.
 606    find_bind meth_name (FunMonoBind op_name fix matches loc)
 607         | op_name == sel_name = Just (FunMonoBind meth_name fix matches loc)
 608    find_bind meth_name (PatMonoBind (VarPatIn op_name) grhss loc)
 609         | op_name == sel_name = Just (PatMonoBind (VarPatIn meth_name) grhss loc)
 610    find_bind meth_name (AndMonoBinds b1 b2)
 611                               = find_bind meth_name b1 `seqMaybe` find_bind meth_name b2
 612    find_bind meth_name other  = Nothing -- Default case
 613
 614
 615         -- Find the prags for this method, and replace the
 616         -- selector name with the method name
 617    find_prags meth_name [] = []
 618    find_prags meth_name (SpecSig name ty loc : prags)
 619         | name == sel_name = SpecSig meth_name ty loc : find_prags meth_name prags
 620    find_prags meth_name (InlineSig name phase loc : prags)
 621         | name == sel_name = InlineSig meth_name phase loc : find_prags meth_name prags
 622    find_prags meth_name (NoInlineSig name phase loc : prags)
 623         | name == sel_name = NoInlineSig meth_name phase loc : find_prags meth_name prags
 624    find_prags meth_name (prag:prags) = find_prags meth_name prags
 625
 626    mk_default_bind local_meth_name loc
 627       = PatMonoBind (VarPatIn local_meth_name)
 628                     (GRHSs (unguardedRHS (default_expr loc) loc) EmptyBinds Nothing)
 629                     loc
 630
 631    default_expr loc
 632         | explicit_dm = HsVar (getName dm_id)   -- There's a default method
 633         | otherwise   = error_expr loc          -- No default method
 634
 635    error_expr loc = HsApp (HsVar (getName nO_METHOD_BINDING_ERROR_ID))
 636                           (HsLit (HsString (_PK_ (error_msg loc))))
 637
 638    error_msg loc = showSDoc (hcat [ppr loc, text "|", ppr sel_id ])
 639 \end{code}
 640
 641 Contexts and errors
 642 ~~~~~~~~~~~~~~~~~~~
 643 \begin{code}
 644 classArityErr class_name
 645   = ptext SLIT("Too many parameters for class") <+> quotes (ppr class_name)
 646
 647 superClassErr class_name sc
 648   = ptext SLIT("Illegal superclass constraint") <+> quotes (pprHsClassAssertion sc)
 649     <+> ptext SLIT("in declaration for class") <+> quotes (ppr class_name)
 650
 651 defltMethCtxt class_name
 652   = ptext SLIT("When checking the default methods for class") <+> quotes (ppr class_name)
 653
 654 methodCtxt sel_id
 655   = ptext SLIT("In the definition for method") <+> quotes (ppr sel_id)
 656
 657 badMethodErr bndr clas
 658   = hsep [ptext SLIT("Class"), quotes (ppr clas),
 659           ptext SLIT("does not have a method"), quotes (ppr bndr)]
 660
 661 omittedMethodWarn sel_id clas
 662   = sep [ptext SLIT("No explicit method nor default method for") <+> quotes (ppr sel_id),
 663          ptext SLIT("in an instance declaration for") <+> quotes (ppr clas)]
 664 \end{code}