2 % (c) The University of Glasgow 2006
3 % (c) The GRASP/AQUA Project, Glasgow University, 1992-1998
6 Typechecking class declarations
9 module TcClassDcl ( tcClassSigs, tcClassDecl2,
10 findMethodBind, instantiateMethod, tcInstanceMethodBody,
11 mkGenericDefMethBind, getGenericInstances,
12 tcAddDeclCtxt, badMethodErr, badATErr, omittedATWarn
15 #include "HsVersions.h"
22 import TcPat( addInlinePrags )
30 import BuildTyCl( TcMethInfo )
59 Every class implicitly declares a new data type, corresponding to dictionaries
60 of that class. So, for example:
62 class (D a) => C a where
64 op2 :: forall b. Ord b => a -> b -> b
66 would implicitly declare
68 data CDict a = CDict (D a)
70 (forall b. Ord b => a -> b -> b)
72 (We could use a record decl, but that means changing more of the existing apparatus.
75 For classes with just one superclass+method, we use a newtype decl instead:
78 op :: forallb. a -> b -> b
82 newtype CDict a = CDict (forall b. a -> b -> b)
84 Now DictTy in Type is just a form of type synomym:
85 DictTy c t = TyConTy CDict `AppTy` t
87 Death to "ExpandingDicts".
90 %************************************************************************
92 Type-checking the class op signatures
94 %************************************************************************
97 tcClassSigs :: Name -- Name of the class
102 tcClassSigs clas sigs def_methods
103 = do { dm_env <- mapM (addLocM (checkDefaultBind clas op_names))
104 (bagToList def_methods)
105 ; mapM (tcClassSig (mkNameEnv dm_env)) op_sigs }
107 op_sigs = [sig | sig@(L _ (TypeSig _ _)) <- sigs]
108 op_names = [n | (L _ (TypeSig (L _ n) _)) <- op_sigs]
110 checkDefaultBind :: Name -> [Name] -> HsBindLR Name Name -> TcM (Name, DefMethSpec)
111 -- Check default bindings
112 -- a) must be for a class op for this class
113 -- b) must be all generic or all non-generic
114 checkDefaultBind clas ops (FunBind {fun_id = L _ op, fun_matches = MatchGroup matches _ })
115 = do { -- Check that the op is from this class
116 checkTc (op `elem` ops) (badMethodErr clas op)
118 -- Check that all the defns ar generic, or none are
119 ; case (none_generic, all_generic) of
120 (True, _) -> return (op, VanillaDM)
121 (_, True) -> return (op, GenericDM)
122 _ -> failWith (mixedGenericErr op)
125 n_generic = count (isJust . maybeGenericMatch) matches
126 none_generic = n_generic == 0
127 all_generic = matches `lengthIs` n_generic
129 checkDefaultBind _ _ b = pprPanic "checkDefaultBind" (ppr b)
132 tcClassSig :: NameEnv DefMethSpec -- Info about default methods;
136 tcClassSig dm_env (L loc (TypeSig (L _ op_name) op_hs_ty))
137 = setSrcSpan loc $ do
138 { op_ty <- tcHsKindedType op_hs_ty -- Class tyvars already in scope
139 ; let dm = lookupNameEnv dm_env op_name `orElse` NoDM
140 ; return (op_name, dm, op_ty) }
141 tcClassSig _ s = pprPanic "tcClassSig" (ppr s)
145 %************************************************************************
149 %************************************************************************
152 tcClassDecl2 :: LTyClDecl Name -- The class declaration
155 tcClassDecl2 (L loc (ClassDecl {tcdLName = class_name, tcdSigs = sigs,
156 tcdMeths = default_binds}))
157 = recoverM (return emptyLHsBinds) $
159 do { clas <- tcLookupLocatedClass class_name
161 -- We make a separate binding for each default method.
162 -- At one time I used a single AbsBinds for all of them, thus
163 -- AbsBind [d] [dm1, dm2, dm3] { dm1 = ...; dm2 = ...; dm3 = ... }
164 -- But that desugars into
165 -- ds = \d -> (..., ..., ...)
166 -- dm1 = \d -> case ds d of (a,b,c) -> a
167 -- And since ds is big, it doesn't get inlined, so we don't get good
168 -- default methods. Better to make separate AbsBinds for each
170 (tyvars, _, _, op_items) = classBigSig clas
171 rigid_info = ClsSkol clas
172 prag_fn = mkPragFun sigs default_binds
173 sig_fn = mkSigFun sigs
174 clas_tyvars = tcSkolSigTyVars rigid_info tyvars
175 pred = mkClassPred clas (mkTyVarTys clas_tyvars)
176 ; this_dict <- newEvVar pred
178 ; let tc_dm = tcDefMeth clas clas_tyvars
179 this_dict default_binds
182 ; dm_binds <- tcExtendTyVarEnv clas_tyvars $
185 ; return (listToBag (catMaybes dm_binds)) }
187 tcClassDecl2 d = pprPanic "tcClassDecl2" (ppr d)
189 tcDefMeth :: Class -> [TyVar] -> EvVar -> LHsBinds Name
190 -> SigFun -> PragFun -> ClassOpItem
191 -> TcM (Maybe (LHsBind Id))
192 -- Generate code for polymorphic default methods only (hence DefMeth)
193 -- (Generic default methods have turned into instance decls by now.)
194 -- This is incompatible with Hugs, which expects a polymorphic
195 -- default method for every class op, regardless of whether or not
196 -- the programmer supplied an explicit default decl for the class.
197 -- (If necessary we can fix that, but we don't have a convenient Id to hand.)
198 tcDefMeth clas tyvars this_dict binds_in sig_fn prag_fn (sel_id, dm_info)
200 NoDefMeth -> return Nothing
201 GenDefMeth -> return Nothing
202 DefMeth dm_name -> do
203 { let sel_name = idName sel_id
204 ; local_dm_name <- newLocalName sel_name
205 -- Base the local_dm_name on the selector name, because
206 -- type errors from tcInstanceMethodBody come from here
208 -- See Note [Silly default-method bind]
209 -- (possibly out of date)
211 ; let meth_bind = findMethodBind sel_name binds_in
212 `orElse` pprPanic "tcDefMeth" (ppr sel_id)
213 -- dm_info = DefMeth dm_name only if there is a binding in binds_in
215 dm_sig_fn _ = sig_fn sel_name
216 dm_id = mkDefaultMethodId sel_id dm_name
217 local_dm_type = instantiateMethod clas sel_id (mkTyVarTys tyvars)
218 local_dm_id = mkLocalId local_dm_name local_dm_type
219 prags = prag_fn sel_name
221 ; dm_id_w_inline <- addInlinePrags dm_id prags
222 ; spec_prags <- tcSpecPrags dm_id prags
224 ; warnTc (not (null spec_prags))
225 (ptext (sLit "Ignoring SPECIALISE pragmas on default method")
226 <+> quotes (ppr sel_name))
229 tcInstanceMethodBody (ClsSkol clas)
232 dm_id_w_inline local_dm_id
233 dm_sig_fn IsDefaultMethod meth_bind }
236 tcInstanceMethodBody :: SkolemInfo -> [TcTyVar] -> [EvVar]
238 -> SigFun -> TcSpecPrags -> LHsBind Name
240 tcInstanceMethodBody skol_info tyvars dfun_ev_vars
241 meth_id local_meth_id
244 = do { -- Typecheck the binding, first extending the envt
245 -- so that when tcInstSig looks up the local_meth_id to find
246 -- its signature, we'll find it in the environment
247 let lm_bind = L loc (bind { fun_id = L loc (idName local_meth_id) })
248 -- Substitute the local_meth_name for the binder
249 -- NB: the binding is always a FunBind
251 ; (ev_binds, (tc_bind, _))
252 <- checkConstraints skol_info tyvars dfun_ev_vars $
253 tcExtendIdEnv [local_meth_id] $
254 tcPolyBinds TopLevel meth_sig_fn no_prag_fn
255 NonRecursive NonRecursive
258 ; let full_bind = AbsBinds { abs_tvs = tyvars, abs_ev_vars = dfun_ev_vars
259 , abs_exports = [(tyvars, meth_id, local_meth_id, specs)]
260 , abs_ev_binds = ev_binds
261 , abs_binds = tc_bind }
263 ; return (L loc full_bind) }
265 no_prag_fn _ = [] -- No pragmas for local_meth_id;
266 -- they are all for meth_id
270 instantiateMethod :: Class -> Id -> [TcType] -> TcType
271 -- Take a class operation, say
272 -- op :: forall ab. C a => forall c. Ix c => (b,c) -> a
273 -- Instantiate it at [ty1,ty2]
274 -- Return the "local method type":
275 -- forall c. Ix x => (ty2,c) -> ty1
276 instantiateMethod clas sel_id inst_tys
277 = ASSERT( ok_first_pred ) local_meth_ty
279 (sel_tyvars,sel_rho) = tcSplitForAllTys (idType sel_id)
280 rho_ty = ASSERT( length sel_tyvars == length inst_tys )
281 substTyWith sel_tyvars inst_tys sel_rho
283 (first_pred, local_meth_ty) = tcSplitPredFunTy_maybe rho_ty
284 `orElse` pprPanic "tcInstanceMethod" (ppr sel_id)
286 ok_first_pred = case getClassPredTys_maybe first_pred of
287 Just (clas1, _tys) -> clas == clas1
289 -- The first predicate should be of form (C a b)
290 -- where C is the class in question
293 ---------------------------
294 findMethodBind :: Name -- Selector name
295 -> LHsBinds Name -- A group of bindings
296 -> Maybe (LHsBind Name) -- The binding
297 findMethodBind sel_name binds
298 = foldlBag mplus Nothing (mapBag f binds)
300 f bind@(L _ (FunBind { fun_id = L _ op_name }))
301 | op_name == sel_name
306 Note [Polymorphic methods]
307 ~~~~~~~~~~~~~~~~~~~~~~~~~~
310 op :: forall b. Ord b => a -> b -> b -> b
311 instance Foo c => Foo [c] where
314 When typechecking the binding 'op = e', we'll have a meth_id for op
316 op :: forall c. Foo c => forall b. Ord b => [c] -> b -> b -> b
318 So tcPolyBinds must be capable of dealing with nested polytypes;
319 and so it is. See TcBinds.tcMonoBinds (with type-sig case).
321 Note [Silly default-method bind]
322 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
323 When we pass the default method binding to the type checker, it must
326 otherwise the "$dm" stuff comes out error messages. But we want the
327 "$dm" to come out in the interface file. So we typecheck the former,
328 and wrap it in a let, thus
329 $dmop2 = let op2 = e in op2
330 This makes the error messages right.
333 %************************************************************************
335 Extracting generic instance declaration from class declarations
337 %************************************************************************
339 @getGenericInstances@ extracts the generic instance declarations from a class
340 declaration. For exmaple
345 op{ x+y } (Inl v) = ...
346 op{ x+y } (Inr v) = ...
347 op{ x*y } (v :*: w) = ...
350 gives rise to the instance declarations
352 instance C (x+y) where
356 instance C (x*y) where
363 mkGenericDefMethBind :: Class -> [Type] -> Id -> TcM (LHsBind Name)
364 mkGenericDefMethBind clas inst_tys sel_id
365 = -- A generic default method
366 -- If the method is defined generically, we can only do the job if the
367 -- instance declaration is for a single-parameter type class with
368 -- a type constructor applied to type arguments in the instance decl
369 -- (checkTc, so False provokes the error)
370 do { checkTc (isJust maybe_tycon)
371 (badGenericInstance sel_id (notSimple inst_tys))
372 ; checkTc (tyConHasGenerics tycon)
373 (badGenericInstance sel_id (notGeneric tycon))
376 ; liftIO (dumpIfSet_dyn dflags Opt_D_dump_deriv "Filling in method body"
377 (vcat [ppr clas <+> ppr inst_tys,
378 nest 2 (ppr sel_id <+> equals <+> ppr rhs)]))
380 -- Rename it before returning it
381 ; (rn_rhs, _) <- rnLExpr rhs
382 ; return (noLoc $ mkFunBind (noLoc (idName sel_id))
383 [mkSimpleMatch [] rn_rhs]) }
385 rhs = mkGenericRhs sel_id clas_tyvar tycon
387 -- The tycon is only used in the generic case, and in that
388 -- case we require that the instance decl is for a single-parameter
389 -- type class with type variable arguments:
390 -- instance (...) => C (T a b)
391 clas_tyvar = ASSERT (not (null (classTyVars clas))) head (classTyVars clas)
392 Just tycon = maybe_tycon
393 maybe_tycon = case inst_tys of
394 [ty] -> case tcSplitTyConApp_maybe ty of
395 Just (tycon, arg_tys) | all tcIsTyVarTy arg_tys -> Just tycon
400 ---------------------------
401 getGenericInstances :: [LTyClDecl Name] -> TcM [InstInfo Name]
402 getGenericInstances class_decls
403 = do { gen_inst_infos <- mapM (addLocM get_generics) class_decls
404 ; let { gen_inst_info = concat gen_inst_infos }
406 -- Return right away if there is no generic stuff
407 ; if null gen_inst_info then return []
410 -- Otherwise print it out
411 { dumpDerivingInfo $ hang (ptext (sLit "Generic instances"))
412 2 (vcat (map pprInstInfoDetails gen_inst_info))
413 ; return gen_inst_info }}
415 get_generics :: TyClDecl Name -> TcM [InstInfo Name]
416 get_generics decl@(ClassDecl {tcdLName = class_name, tcdMeths = def_methods})
418 = return [] -- The comon case: no generic default methods
420 | otherwise -- A source class decl with generic default methods
421 = recoverM (return []) $
422 tcAddDeclCtxt decl $ do
423 clas <- tcLookupLocatedClass class_name
425 -- Group by type, and
426 -- make an InstInfo out of each group
428 groups = groupWith listToBag generic_binds
430 inst_infos <- mapM (mkGenericInstance clas) groups
432 -- Check that there is only one InstInfo for each type constructor
433 -- The main way this can fail is if you write
434 -- f {| a+b |} ... = ...
435 -- f {| x+y |} ... = ...
436 -- Then at this point we'll have an InstInfo for each
438 -- The class should be unary, which is why simpleInstInfoTyCon should be ok
440 tc_inst_infos :: [(TyCon, InstInfo Name)]
441 tc_inst_infos = [(simpleInstInfoTyCon i, i) | i <- inst_infos]
443 bad_groups = [group | group <- equivClassesByUniq get_uniq tc_inst_infos,
444 group `lengthExceeds` 1]
445 get_uniq (tc,_) = getUnique tc
447 mapM_ (addErrTc . dupGenericInsts) bad_groups
449 -- Check that there is an InstInfo for each generic type constructor
451 missing = genericTyConNames `minusList` [tyConName tc | (tc,_) <- tc_inst_infos]
453 checkTc (null missing) (missingGenericInstances missing)
457 generic_binds :: [(HsType Name, LHsBind Name)]
458 generic_binds = getGenericBinds def_methods
459 get_generics decl = pprPanic "get_generics" (ppr decl)
462 ---------------------------------
463 getGenericBinds :: LHsBinds Name -> [(HsType Name, LHsBind Name)]
464 -- Takes a group of method bindings, finds the generic ones, and returns
465 -- them in finite map indexed by the type parameter in the definition.
466 getGenericBinds binds = concat (map getGenericBind (bagToList binds))
468 getGenericBind :: LHsBindLR Name Name -> [(HsType Name, LHsBindLR Name Name)]
469 getGenericBind (L loc bind@(FunBind { fun_matches = MatchGroup matches ty }))
470 = groupWith wrap (mapCatMaybes maybeGenericMatch matches)
472 wrap ms = L loc (bind { fun_matches = MatchGroup ms ty })
476 groupWith :: ([a] -> b) -> [(HsType Name, a)] -> [(HsType Name, b)]
478 groupWith op ((t,v):prs) = (t, op (v:vs)) : groupWith op rest
481 (this,rest) = partition same_t prs
482 same_t (t', _v) = t `eqPatType` t'
484 eqPatLType :: LHsType Name -> LHsType Name -> Bool
485 eqPatLType t1 t2 = unLoc t1 `eqPatType` unLoc t2
487 eqPatType :: HsType Name -> HsType Name -> Bool
488 -- A very simple equality function, only for
489 -- type patterns in generic function definitions.
490 eqPatType (HsTyVar v1) (HsTyVar v2) = v1==v2
491 eqPatType (HsAppTy s1 t1) (HsAppTy s2 t2) = s1 `eqPatLType` s2 && t1 `eqPatLType` t2
492 eqPatType (HsOpTy s1 op1 t1) (HsOpTy s2 op2 t2) = s1 `eqPatLType` s2 && t1 `eqPatLType` t2 && unLoc op1 == unLoc op2
493 eqPatType (HsNumTy n1) (HsNumTy n2) = n1 == n2
494 eqPatType (HsParTy t1) t2 = unLoc t1 `eqPatType` t2
495 eqPatType t1 (HsParTy t2) = t1 `eqPatType` unLoc t2
496 eqPatType _ _ = False
498 ---------------------------------
499 mkGenericInstance :: Class
500 -> (HsType Name, LHsBinds Name)
501 -> TcM (InstInfo Name)
503 mkGenericInstance clas (hs_ty, binds) = do
504 -- Make a generic instance declaration
505 -- For example: instance (C a, C b) => C (a+b) where { binds }
507 -- Extract the universally quantified type variables
508 -- and wrap them as forall'd tyvars, so that kind inference
509 -- works in the standard way
511 sig_tvs = userHsTyVarBndrs $ map noLoc $ nameSetToList $
512 extractHsTyVars (noLoc hs_ty)
513 hs_forall_ty = noLoc $ mkExplicitHsForAllTy sig_tvs (noLoc []) (noLoc hs_ty)
515 -- Type-check the instance type, and check its form
516 forall_inst_ty <- tcHsSigType GenPatCtxt hs_forall_ty
518 (tyvars, inst_ty) = tcSplitForAllTys forall_inst_ty
520 checkTc (validGenericInstanceType inst_ty)
521 (badGenericInstanceType binds)
523 -- Make the dictionary function.
525 overlap_flag <- getOverlapFlag
526 dfun_name <- newDFunName clas [inst_ty] span
528 inst_theta = [mkClassPred clas [mkTyVarTy tv] | tv <- tyvars]
529 dfun_id = mkDictFunId dfun_name tyvars inst_theta clas [inst_ty]
530 ispec = mkLocalInstance dfun_id overlap_flag
532 return (InstInfo { iSpec = ispec, iBinds = VanillaInst binds [] False })
536 %************************************************************************
540 %************************************************************************
543 tcAddDeclCtxt :: TyClDecl Name -> TcM a -> TcM a
544 tcAddDeclCtxt decl thing_inside
545 = addErrCtxt ctxt thing_inside
547 thing | isClassDecl decl = "class"
548 | isTypeDecl decl = "type synonym" ++ maybeInst
549 | isDataDecl decl = if tcdND decl == NewType
550 then "newtype" ++ maybeInst
551 else "data type" ++ maybeInst
552 | isFamilyDecl decl = "family"
553 | otherwise = panic "tcAddDeclCtxt/thing"
555 maybeInst | isFamInstDecl decl = " instance"
558 ctxt = hsep [ptext (sLit "In the"), text thing,
559 ptext (sLit "declaration for"), quotes (ppr (tcdName decl))]
561 badMethodErr :: Outputable a => a -> Name -> SDoc
563 = hsep [ptext (sLit "Class"), quotes (ppr clas),
564 ptext (sLit "does not have a method"), quotes (ppr op)]
566 badATErr :: Class -> Name -> SDoc
568 = hsep [ptext (sLit "Class"), quotes (ppr clas),
569 ptext (sLit "does not have an associated type"), quotes (ppr at)]
571 omittedATWarn :: Name -> SDoc
573 = ptext (sLit "No explicit AT declaration for") <+> quotes (ppr at)
575 badGenericInstance :: Var -> SDoc -> SDoc
576 badGenericInstance sel_id because
577 = sep [ptext (sLit "Can't derive generic code for") <+> quotes (ppr sel_id),
580 notSimple :: [Type] -> SDoc
582 = vcat [ptext (sLit "because the instance type(s)"),
583 nest 2 (ppr inst_tys),
584 ptext (sLit "is not a simple type of form (T a1 ... an)")]
586 notGeneric :: TyCon -> SDoc
588 = vcat [ptext (sLit "because the instance type constructor") <+> quotes (ppr tycon) <+>
589 ptext (sLit "was not compiled with -XGenerics")]
591 badGenericInstanceType :: LHsBinds Name -> SDoc
592 badGenericInstanceType binds
593 = vcat [ptext (sLit "Illegal type pattern in the generic bindings"),
596 missingGenericInstances :: [Name] -> SDoc
597 missingGenericInstances missing
598 = ptext (sLit "Missing type patterns for") <+> pprQuotedList missing
600 dupGenericInsts :: [(TyCon, InstInfo a)] -> SDoc
601 dupGenericInsts tc_inst_infos
602 = vcat [ptext (sLit "More than one type pattern for a single generic type constructor:"),
603 nest 2 (vcat (map ppr_inst_ty tc_inst_infos)),
604 ptext (sLit "All the type patterns for a generic type constructor must be identical")
607 ppr_inst_ty (_,inst) = ppr (simpleInstInfoTy inst)
609 mixedGenericErr :: Name -> SDoc
611 = ptext (sLit "Can't mix generic and non-generic equations for class method") <+> quotes (ppr op)