%
-% (c) The GRASP/AQUA Project, Glasgow University, 1992-1995
+% (c) The GRASP/AQUA Project, Glasgow University, 1992-1998
%
\section[TcClassDcl]{Typechecking class declarations}
\begin{code}
-#include "HsVersions.h"
-
-module TcClassDcl (
- tcClassDecls1, tcClassDecls2,
- ClassInfo -- abstract
- ) where
+module TcClassDcl ( kcClassDecl, tcClassDecl1, tcClassDecls2, mkImplicitClassBinds,
+ tcMethodBind, checkFromThisClass
+ ) where
-IMPORT_Trace -- ToDo: rm (debugging)
-import Pretty -- add proper one below
+#include "HsVersions.h"
-import TcMonad -- typechecking monad machinery
-import TcMonadFns ( newDicts, newClassOpLocals, copyTyVars )
-import AbsSyn -- the stuff being typechecked
+import HsSyn ( HsDecl(..), TyClDecl(..), Sig(..), MonoBinds(..),
+ InPat(..), HsBinds(..), GRHSs(..),
+ HsExpr(..), HsLit(..), HsType(..), HsPred(..),
+ pprHsClassAssertion, unguardedRHS,
+ andMonoBinds, andMonoBindList, getTyVarName,
+ isClassDecl, isClassOpSig, isPragSig, collectMonoBinders
+ )
+import HsPragmas ( ClassPragmas(..) )
+import BasicTypes ( NewOrData(..), TopLevelFlag(..), RecFlag(..) )
+import RnHsSyn ( RenamedTyClDecl, RenamedClassPragmas,
+ RenamedClassOpSig, RenamedMonoBinds,
+ RenamedContext, RenamedHsDecl, RenamedSig
+ )
+import TcHsSyn ( TcMonoBinds, idsToMonoBinds )
-import AbsPrel ( pAT_ERROR_ID )
-import AbsUniType ( mkClass, getClassKey, getClassBigSig,
- getClassOpString, getClassOps, splitType,
- mkSuperDictSelType, InstTyEnv(..),
- instantiateTy, instantiateThetaTy, UniType
+import Inst ( Inst, InstOrigin(..), LIE, emptyLIE, plusLIE, plusLIEs, newDicts, newMethod )
+import TcEnv ( TcId, ValueEnv, TcTyThing(..), tcAddImportedIdInfo,
+ tcLookupClass, tcLookupTy, tcExtendTyVarEnvForMeths, tcExtendGlobalTyVars,
+ tcExtendLocalValEnv
)
-import BackSubst ( applyTcSubstToBinds )
-import CE -- ( nullCE, unitCE, plusCE, CE(..), UniqFM )
-import E ( mkE, getE_TCE, getE_CE, tvOfE, nullGVE, plusGVE, E, TCE(..), UniqFM, GVE(..) )
-import Errors ( confusedNameErr, Error(..) )
-import HsPragmas -- ****** NEED TO SEE CONSTRUCTORS ******
-import Id ( mkSuperDictSelId, mkInstId, getIdUniType,
- Id, DictFun(..)
+import TcBinds ( tcBindWithSigs, tcSpecSigs )
+import TcTyDecls ( mkNewTyConRep )
+import TcUnify ( unifyKinds )
+import TcMonad
+import TcMonoType ( kcHsType, tcHsTopType, tcExtendTopTyVarScope,
+ tcContext, checkSigTyVars, sigCtxt, mkTcSig
)
+import TcSimplify ( tcSimplifyAndCheck, bindInstsOfLocalFuns )
+import TcType ( TcType, TcTyVar, tcInstTyVars, zonkTcTyVarBndr, tcGetTyVar )
+import TcInstUtil ( classDataCon )
+import PrelInfo ( nO_METHOD_BINDING_ERROR_ID )
+import FieldLabel ( firstFieldLabelTag )
+import Bag ( unionManyBags, bagToList )
+import Class ( mkClass, classBigSig, classSelIds, Class, ClassOpItem )
+import CmdLineOpts ( opt_GlasgowExts, opt_WarnMissingMethods )
+import MkId ( mkDictSelId, mkDataConId, mkDataConWrapId, mkDefaultMethodId )
+import DataCon ( mkDataCon, dataConId, dataConWrapId, notMarkedStrict )
+import Id ( Id, setInlinePragma, idUnfolding, idType, idName )
+import CoreUnfold ( unfoldingTemplate )
import IdInfo
-import Inst ( InstOrigin(..), Inst )
-import InstEnv
-import LIE ( nullLIE, mkLIE, plusLIE, LIE )
-import Maybes ( Maybe(..) )
-import Name ( Name(..) )
-import PlainCore ( escErrorMsg )
-import Spec ( specTy )
-import TVE ( mkTVE, TVE(..)
- IF_ATTACK_PRAGMAS(COMMA u2i)
+import Name ( Name, nameOccName, isLocallyDefined, NamedThing(..) )
+import NameSet ( emptyNameSet )
+import Outputable
+import Type ( Type, ThetaType, ClassContext,
+ mkFunTy, mkTyVarTy, mkTyVarTys, mkDictTy, mkDictTys,
+ mkSigmaTy, mkForAllTys, mkClassPred, classesOfPreds,
+ boxedTypeKind, mkArrowKind
)
-import TcClassSig ( tcClassSigs )
-import TcContext ( tcContext )
-import TcInstDcls ( processInstBinds )
-import TcPragmas ( tcGenPragmas )
+import Var ( tyVarKind, TyVar )
+import VarSet ( mkVarSet, emptyVarSet )
+import TyCon ( AlgTyConFlavour(..), mkClassTyCon )
+import Unique ( Unique, Uniquable(..) )
import Util
+import Maybes ( seqMaybe )
+import FiniteMap ( lookupWithDefaultFM )
\end{code}
-@ClassInfo@ communicates the essential information about
-locally-defined classes between passes 1 and 2.
+
+
+Dictionary handling
+~~~~~~~~~~~~~~~~~~~
+Every class implicitly declares a new data type, corresponding to dictionaries
+of that class. So, for example:
+
+ class (D a) => C a where
+ op1 :: a -> a
+ op2 :: forall b. Ord b => a -> b -> b
+
+would implicitly declare
+
+ data CDict a = CDict (D a)
+ (a -> a)
+ (forall b. Ord b => a -> b -> b)
+
+(We could use a record decl, but that means changing more of the existing apparatus.
+One step at at time!)
+
+For classes with just one superclass+method, we use a newtype decl instead:
+
+ class C a where
+ op :: forallb. a -> b -> b
+
+generates
+
+ newtype CDict a = CDict (forall b. a -> b -> b)
+
+Now DictTy in Type is just a form of type synomym:
+ DictTy c t = TyConTy CDict `AppTy` t
+
+Death to "ExpandingDicts".
+
+
+%************************************************************************
+%* *
+\subsection{Kind checking}
+%* *
+%************************************************************************
\begin{code}
-data ClassInfo
- = ClassInfo Class
- RenamedMonoBinds
+kcClassDecl (ClassDecl context class_name
+ tyvar_names fundeps class_sigs def_methods pragmas
+ _ _ _ _ src_loc)
+ = -- CHECK ARITY 1 FOR HASKELL 1.4
+ checkTc (opt_GlasgowExts || length tyvar_names == 1)
+ (classArityErr class_name) `thenTc_`
+
+ -- Get the (mutable) class kind
+ tcLookupTy class_name `thenNF_Tc` \ (kind, _, _) ->
+
+ -- Make suitable tyvars and do kind checking
+ -- The net effect is to mutate the class kind
+ tcExtendTopTyVarScope kind tyvar_names $ \ _ _ ->
+ tcContext context `thenTc_`
+ mapTc kc_sig the_class_sigs `thenTc_`
+
+ returnTc ()
+ where
+ the_class_sigs = filter isClassOpSig class_sigs
+
+ kc_sig (ClassOpSig _ _ _ op_ty loc) = tcAddSrcLoc loc (kcHsType op_ty)
\end{code}
%************************************************************************
%* *
-\subsection[TcClassDcl]{Does the real work (apart from default methods)}
+\subsection{Type checking}
%* *
%************************************************************************
\begin{code}
-tcClassDecls1
- :: E -- Consult the CE/TCE args only to build knots
- -> InstanceMapper -- Maps class name to its instances,
- -- ...and its ops to their instances,
- -> [RenamedClassDecl]
- -> TcM ([ClassInfo], -- boiled-down info related to classes
- CE, -- env so we can look up classes elsewhere
- GVE) -- env so we can look up class ops elsewhere
-
-tcClassDecls1 e rec_inst_mapper []
- = returnTc ([], nullCE, nullGVE)
-
-tcClassDecls1 e rec_inst_mapper (cd:cds)
- = tc_clas1 cd `thenTc` \ (cinfo1_maybe, ce1, gve1) ->
- tcClassDecls1 e rec_inst_mapper cds `thenTc` \ (cinfo2, ce2, gve2) ->
+tcClassDecl1 rec_env rec_inst_mapper rec_vrcs
+ (ClassDecl context class_name
+ tyvar_names fundeps class_sigs def_methods pragmas
+ tycon_name datacon_name datacon_wkr_name sc_sel_names src_loc)
+ = -- LOOK THINGS UP IN THE ENVIRONMENT
+ tcLookupTy class_name `thenTc` \ (class_kind, _, AClass rec_class) ->
+ tcExtendTopTyVarScope class_kind tyvar_names $ \ tyvars _ ->
+ -- The class kind is by now immutable
+
+ -- CHECK THE CONTEXT
+-- traceTc (text "tcClassCtxt" <+> ppr class_name) `thenTc_`
+ tcClassContext class_name rec_class tyvars context sc_sel_names
+ `thenTc` \ (sc_theta, sc_tys, sc_sel_ids) ->
+-- traceTc (text "tcClassCtxt done" <+> ppr class_name) `thenTc_`
+
+ -- CHECK THE FUNCTIONAL DEPENDENCIES,
+ tcFundeps fundeps `thenTc` \ fds ->
+
+ -- CHECK THE CLASS SIGNATURES,
+ mapTc (tcClassSig rec_env rec_class tyvars)
+ (filter isClassOpSig class_sigs)
+ `thenTc` \ sig_stuff ->
+
+ -- MAKE THE CLASS OBJECT ITSELF
+ let
+ (op_tys, op_items) = unzip sig_stuff
+ rec_class_inst_env = rec_inst_mapper rec_class
+ clas = mkClass class_name tyvars fds
+ sc_theta sc_sel_ids op_items
+ tycon
+ rec_class_inst_env
+
+ dict_component_tys = sc_tys ++ op_tys
+ new_or_data = case dict_component_tys of
+ [_] -> NewTyCon (mkNewTyConRep tycon)
+ other -> DataTyCon
+
+ dict_con = mkDataCon datacon_name
+ [notMarkedStrict | _ <- dict_component_tys]
+ [{- No labelled fields -}]
+ tyvars
+ [{-No context-}]
+ [{-No existential tyvars-}] [{-Or context-}]
+ dict_component_tys
+ tycon dict_con_id dict_wrap_id
+
+ dict_con_id = mkDataConId datacon_wkr_name dict_con
+ dict_wrap_id = mkDataConWrapId dict_con
+
+ argvrcs = lookupWithDefaultFM rec_vrcs (pprPanic "tcClassDecl1: argvrcs:" $
+ ppr tycon_name)
+ tycon_name
+
+ tycon = mkClassTyCon tycon_name
+ class_kind
+ tyvars
+ argvrcs
+ dict_con -- Constructors
+ clas -- Yes! It's a dictionary
+ new_or_data
+ in
+ returnTc clas
+\end{code}
+
+\begin{code}
+tcFundeps = mapTc tc_fundep
+tc_fundep (us, vs) =
+ mapTc tc_fd_tyvar us `thenTc` \ us' ->
+ mapTc tc_fd_tyvar vs `thenTc` \ vs' ->
+ returnTc (us', vs')
+tc_fd_tyvar v =
+ tcLookupTy v `thenTc` \(_, _, thing) ->
+ case thing of
+ ATyVar tv -> returnTc tv
+ -- ZZ else should fail more gracefully
+\end{code}
+
+\begin{code}
+tcClassContext :: Name -> Class -> [TyVar]
+ -> RenamedContext -- class context
+ -> [Name] -- Names for superclass selectors
+ -> TcM s (ClassContext, -- the superclass context
+ [Type], -- types of the superclass dictionaries
+ [Id]) -- superclass selector Ids
+
+tcClassContext class_name rec_class rec_tyvars context sc_sel_names
+ = -- Check the context.
+ -- The renamer has already checked that the context mentions
+ -- only the type variable of the class decl.
+
+ -- For std Haskell check that the context constrains only tyvars
+ (if opt_GlasgowExts then
+ returnTc []
+ else
+ mapTc check_constraint context
+ ) `thenTc_`
+
+ tcContext context `thenTc` \ sc_theta ->
+
let
- glued_cinfos
- = case cinfo1_maybe of
- Nothing -> cinfo2
- Just xx -> xx : cinfo2
+ sc_theta' = classesOfPreds sc_theta
+ sc_tys = mkDictTys sc_theta'
+ sc_sel_ids = zipWithEqual "tcClassContext" mk_super_id sc_sel_names sc_tys
in
- returnTc (glued_cinfos, ce1 `plusCE` ce2, gve1 `plusGVE` gve2)
+ -- Done
+ returnTc (sc_theta', sc_tys, sc_sel_ids)
+
where
- rec_ce = getE_CE e
- rec_tce = getE_TCE e
---FAKE: fake_E = mkE rec_tce rec_ce
-
- tc_clas1 (ClassDecl context class_name
- tyvar_name class_sigs def_methods pragmas src_loc)
-
- = addSrcLocTc src_loc (
-
- -- The knot is needed so that the signatures etc can point
- -- back to the class itself
- fixTc (\ ~(rec_clas, _) ->
- let
- (rec_clas_inst_env, rec_class_op_inst_fn) = rec_inst_mapper rec_clas
- in
- -- Get new (template) type variables for the class
- let (tve, [clas_tyvar], [alpha]) = mkTVE [tyvar_name] in
-
- -- Typecheck the class context; since there is only one type
- -- variable in scope, we are assured that the it will be of
- -- the form (C1 a, C2 a...)
- babyTcMtoTcM (tcContext rec_ce rec_tce tve context) `thenTc` \ theta ->
-
- -- Make the superclass selector ids; the "class" pragmas
- -- may have info about the superclass dict selectors;
- -- so it is only tcClassPragmas that gives back the
- -- final Ids.
- getUniquesTc (length theta) `thenNF_Tc` \ uniqs ->
- let
- super_classes = [ supers | (supers, _) <- theta ]
- super_tys
- = [ mkSuperDictSelType rec_clas super | super <- super_classes ]
- super_info = zip3 super_classes uniqs super_tys
- in
- (case pragmas of
- NoClassPragmas ->
- returnNF_Tc [ mk_super_id rec_clas info noIdInfo | info <- super_info ]
-
- SuperDictPragmas prags ->
--- pprTrace "SuperDictPragmas:" (ppAboves (ppr PprDebug prags : map pp super_info)) (
- mapNF_Tc (mk_super_id_w_info rec_clas) (super_info `zipEqual` prags)
--- )
--- where
--- pp (sc, u, ty) = ppCat [ppr PprDebug sc, ppr PprDebug ty]
-
- ) `thenNF_Tc` \ super_class_sel_ids ->
-
- -- Typecheck the class signatures, checking that each mentions
- -- the class type variable somewhere, and manufacturing
- -- suitable Ids for selectors and default methods.
- babyTcMtoTcM
- (tcClassSigs e tve rec_clas rec_class_op_inst_fn
- clas_tyvar class_sigs)
- `thenTc` \ (ops, ops_gve, op_sel_ids, defm_ids) ->
-
- -- Make the class object itself, producing clas::Class
- let
- clas
- = mkClass class_name clas_tyvar
- super_classes super_class_sel_ids
- ops op_sel_ids defm_ids
- rec_clas_inst_env
- in
- returnTc (clas, ops_gve)
- ) `thenTc` \ (clas, ops_gve) ->
-
- -- Return the class decl for further work if it is
- -- local, otherwise just return the CE
- returnTc (if (isLocallyDefined class_name) then
- Just (ClassInfo clas def_methods)
- else
- Nothing,
- unitCE (getClassKey clas) clas,
- ops_gve
- ))
- where
- -----------
- mk_super_id clas (super_clas, uniq, ty) id_info
- = mkSuperDictSelId uniq clas super_clas ty id_info
-
- -----------
- mk_super_id_w_info clas ((super_clas, uniq, ty), gen_prags)
- = fixNF_Tc ( \ rec_super_id ->
- babyTcMtoNF_TcM
- (tcGenPragmas e{-fake_E-} Nothing{-ty unknown-} rec_super_id gen_prags)
- `thenNF_Tc` \ id_info ->
-
- returnNF_Tc(mkSuperDictSelId uniq clas super_clas ty id_info)
- )
-
-{- SOMETHING LIKE THIS NEEDED? ToDo [WDP]
- tc_clas1 (ClassDecl _ bad_name _ _ _ _ src_loc)
- = failTc (confusedNameErr
- "Bad name for a class (a type constructor, or Prelude name?)"
- bad_name src_loc)
--}
+ rec_tyvar_tys = mkTyVarTys rec_tyvars
+
+ mk_super_id name dict_ty
+ = mkDictSelId name rec_class {- SUP:??? ty
+ where
+ ty = mkForAllTys rec_tyvars $
+ mkFunTy (mkDictTy rec_class rec_tyvar_tys) dict_ty -}
+
+ check_constraint (HsPClass c tys) = checkTc (all is_tyvar tys)
+ (superClassErr class_name (c, tys))
+
+ is_tyvar (MonoTyVar _) = True
+ is_tyvar other = False
+
+
+tcClassSig :: ValueEnv -- Knot tying only!
+ -> Class -- ...ditto...
+ -> [TyVar] -- The class type variable, used for error check only
+ -> RenamedClassOpSig
+ -> TcM s (Type, -- Type of the method
+ ClassOpItem) -- Selector Id, default-method Id, True if explicit default binding
+
+
+tcClassSig rec_env rec_clas rec_clas_tyvars
+ (ClassOpSig op_name dm_name explicit_dm
+ op_ty src_loc)
+ = tcAddSrcLoc src_loc $
+
+ -- Check the type signature. NB that the envt *already has*
+ -- bindings for the type variables; see comments in TcTyAndClassDcls.
+
+ -- NB: Renamer checks that the class type variable is mentioned in local_ty,
+ -- and that it is not constrained by theta
+-- traceTc (text "tcClassSig" <+> ppr op_name) `thenTc_`
+ tcHsTopType op_ty `thenTc` \ local_ty ->
+ let
+ global_ty = mkSigmaTy rec_clas_tyvars
+ [mkClassPred rec_clas (mkTyVarTys rec_clas_tyvars)]
+ local_ty
+
+ -- Build the selector id and default method id
+ sel_id = mkDictSelId op_name rec_clas {- SUP:??? global_ty -}
+ dm_id = mkDefaultMethodId dm_name rec_clas global_ty
+ final_dm_id = tcAddImportedIdInfo rec_env dm_id
+ in
+-- traceTc (text "tcClassSig done" <+> ppr op_name) `thenTc_`
+ returnTc (local_ty, (sel_id, final_dm_id, explicit_dm))
\end{code}
(Omitted ones elicit an error message.)
\item
to produce a definition for the selector function for each method
+and superclass dictionary.
\end{enumerate}
Pass~2 only applies to locally-defined class declarations.
-The function @tcClassDecls2@ just arranges to apply
-@tcClassDecls2_help@ to each local class decl.
+The function @tcClassDecls2@ just arranges to apply @tcClassDecl2@ to
+each local class decl.
\begin{code}
-tcClassDecls2 e class_info
- = let
- -- Get type variables free in environment. Sadly, there may be
- -- some, because of the dreaded monomorphism restriction
- free_tyvars = tvOfE e
- in
- tcClassDecls2_help e free_tyvars class_info
-
-tcClassDecls2_help
- :: E
- -> [TyVar]
- -> [ClassInfo]
- -> NF_TcM (LIE, TypecheckedBinds)
+tcClassDecls2 :: [RenamedHsDecl]
+ -> NF_TcM s (LIE, TcMonoBinds)
-tcClassDecls2_help e free_tyvars [] = returnNF_Tc (nullLIE, EmptyBinds)
-
-tcClassDecls2_help e free_tyvars ((ClassInfo clas default_binds) : rest)
- = tcClassDecl2 e free_tyvars clas default_binds `thenNF_Tc` \ (lie1, binds1) ->
- tcClassDecls2_help e free_tyvars rest `thenNF_Tc` \ (lie2, binds2) ->
- returnNF_Tc (lie1 `plusLIE` lie2, binds1 `ThenBinds` binds2)
+tcClassDecls2 decls
+ = foldr combine
+ (returnNF_Tc (emptyLIE, EmptyMonoBinds))
+ [tcClassDecl2 cls_decl | TyClD cls_decl <- decls, isClassDecl cls_decl]
+ where
+ combine tc1 tc2 = tc1 `thenNF_Tc` \ (lie1, binds1) ->
+ tc2 `thenNF_Tc` \ (lie2, binds2) ->
+ returnNF_Tc (lie1 `plusLIE` lie2,
+ binds1 `AndMonoBinds` binds2)
\end{code}
@tcClassDecl2@ is the business end of things.
\begin{code}
-tcClassDecl2 :: E
- -> [TyVar] -- Free in the envt
- -> Class
- -> RenamedMonoBinds -- The default decls
- -> NF_TcM (LIE, TypecheckedBinds)
-
-tcClassDecl2 e free_tyvars clas default_binds
- = let
- src_loc = getSrcLoc clas
- origin = ClassDeclOrigin src_loc
- (clas_tyvar_tmpl, scs, sc_sel_ids, ops, op_sel_ids, defm_ids)
- = getClassBigSig clas
- in
- -- Prune the substitution when we are finished, and arrange error recovery
- recoverTc (nullLIE, EmptyBinds) (
- addSrcLocTc src_loc (
- pruneSubstTc free_tyvars (
-
- -- Generate bindings for the selector functions
- buildSelectors origin clas clas_tyvar_tmpl scs sc_sel_ids ops op_sel_ids
- `thenNF_Tc` \ sel_binds ->
- -- Ditto for the methods
- buildDefaultMethodBinds e free_tyvars origin clas clas_tyvar_tmpl
- defm_ids default_binds `thenTc` \ (const_insts, meth_binds) ->
-
- -- Back-substitute through the definitions
- applyTcSubstToInsts const_insts `thenNF_Tc` \ final_const_insts ->
- applyTcSubstToBinds (sel_binds `ThenBinds` meth_binds) `thenNF_Tc` \ final_binds ->
- returnTc (mkLIE final_const_insts, final_binds)
- )))
-\end{code}
+tcClassDecl2 :: RenamedTyClDecl -- The class declaration
+ -> NF_TcM s (LIE, TcMonoBinds)
-%************************************************************************
-%* *
-\subsection[ClassDcl-bld-sels]{Building the selector functions for methods and superclasses}
-%* *
-%************************************************************************
+tcClassDecl2 (ClassDecl context class_name
+ tyvar_names _ class_sigs default_binds pragmas _ _ _ _ src_loc)
-\begin{code}
-buildSelectors :: InstOrigin
- -> Class -- The class object
- -> TyVarTemplate -- Class type variable
- -> [Class] -> [Id] -- Superclasses and selectors
- -> [ClassOp] -> [Id] -- Class ops and selectors
- -> NF_TcM TypecheckedBinds
-
-buildSelectors origin clas clas_tyvar_tmpl
- scs sc_sel_ids
- ops op_sel_ids
- =
- -- Instantiate the class variable
- copyTyVars [clas_tyvar_tmpl] `thenNF_Tc` \ (inst_env, [clas_tyvar], [clas_tyvar_ty]) ->
- -- Make an Inst for each class op, and
- -- dicts for the superclasses. These are used to
- -- construct the selector functions
- newClassOpLocals inst_env ops `thenNF_Tc` \ method_ids ->
- newDicts origin [ (super_clas, clas_tyvar_ty)
- | super_clas <- scs
- ] `thenNF_Tc` \ dicts ->
- let dict_ids = map mkInstId dicts in
-
- -- Make suitable bindings for the selectors
- let mk_op_sel op sel_id method_id
- = mkSelExpr origin clas_tyvar dict_ids method_ids method_id `thenNF_Tc` \ rhs ->
- returnNF_Tc (VarMonoBind sel_id rhs)
- mk_sc_sel sc sel_id dict_id
- = mkSelExpr origin clas_tyvar dict_ids method_ids dict_id `thenNF_Tc` \ rhs ->
- returnNF_Tc (VarMonoBind sel_id rhs)
- in
- listNF_Tc (zipWith3 mk_op_sel ops op_sel_ids method_ids) `thenNF_Tc` \ op_sel_binds ->
- listNF_Tc (zipWith3 mk_sc_sel scs sc_sel_ids dict_ids) `thenNF_Tc` \ sc_sel_binds ->
+ | not (isLocallyDefined class_name)
+ = returnNF_Tc (emptyLIE, EmptyMonoBinds)
- returnNF_Tc (SingleBind (
- NonRecBind (
- foldr AndMonoBinds EmptyMonoBinds (
- op_sel_binds ++ sc_sel_binds))))
+ | otherwise -- It is locally defined
+ = recoverNF_Tc (returnNF_Tc (emptyLIE, EmptyMonoBinds)) $
+ tcAddSrcLoc src_loc $
+ tcLookupClass class_name `thenNF_Tc` \ clas ->
+ tcDefaultMethodBinds clas default_binds class_sigs
\end{code}
-%************************************************************************
-%* *
-\subsection[ClassDcl-misc]{Miscellaneous}
-%* *
-%************************************************************************
-
-Make a selector expression for @local@ from a dictionary consisting of
-@dicts@ and @op_locals@.
-
-We have to do a bit of jiggery pokery to get the type variables right.
-Suppose we have the class decl:
-\begin{verbatim}
- class Foo a where
- op1 :: Ord b => a -> b -> a
- op2 :: ...
-\end{verbatim}
-Then the method selector for \tr{op1} is like this:
-\begin{verbatim}
- op1_sel = /\ab -> \dFoo -> case dFoo of
- (op1_method,op2_method) -> op1_method b
-\end{verbatim}
-Note that the type variable for \tr{b} is lifted to the top big lambda, and
-\tr{op1_method} is applied to it. This is preferable to the alternative:
-\begin{verbatim}
- op1_sel' = /\a -> \dFoo -> case dFoo of
- (op1_method,op2_method) -> op1_method
-\end{verbatim}
-because \tr{op1_sel'} then has the rather strange type
-\begin{verbatim}
- op1_sel' :: forall a. Foo a -> forall b. Ord b -> a -> b -> a
-\end{verbatim}
-whereas \tr{op1_sel} (the one we use) has the decent type
-\begin{verbatim}
- op1_sel :: forall a b. Foo a -> Ord b -> a -> b -> a
-\end{verbatim}
-
-{\em NOTE:}
-We could do the same thing for the dictionaries, giving
-\begin{verbatim}
- op1_sel = /\ab -> \dFoo -> \dOrd -> case dFoo of
- (m1,m2) -> m1 b dOrd
-\end{verbatim}
-but WE ASSUME THAT DICTIONARY APPLICATION IS CURRIED, so the two are
-precisely equivalent, and have the same type, namely
-\begin{verbatim}
- op1_sel :: forall a b. Foo a -> Ord b -> a -> b -> a
-\end{verbatim}
-
-WDP 95/03: Quite false (``DICTIONARY APPLICATION IS CURRIED'').
-Specialisation now wants to see all type- and dictionary-applications
-absolutely explicitly.
-
\begin{code}
-mkSelExpr :: InstOrigin -> TyVar -> [Id] -> [Id] -> Id -> NF_TcM TypecheckedExpr
+mkImplicitClassBinds :: [Class] -> NF_TcM s ([Id], TcMonoBinds)
+mkImplicitClassBinds classes
+ = returnNF_Tc (concat cls_ids_s, andMonoBindList binds_s)
+ -- The selector binds are already in the selector Id's unfoldings
+ where
+ (cls_ids_s, binds_s) = unzip (map mk_implicit classes)
-mkSelExpr origin clas_tyvar dicts op_locals local
- = let
- (op_tyvar_tmpls,local_theta,_) = splitType (getIdUniType local)
- in
- copyTyVars op_tyvar_tmpls `thenNF_Tc` \ (inst_env, op_tyvars, tys) ->
- let
- inst_theta = instantiateThetaTy inst_env local_theta
- in
- newDicts origin inst_theta `thenNF_Tc` \ local_dict_insts ->
- let
- local_dicts = map mkInstId local_dict_insts
- in
- returnNF_Tc (TyLam (clas_tyvar:op_tyvars)
- (ClassDictLam
- dicts
- op_locals
- (mkDictLam local_dicts
- (mkDictApp (mkTyApp (Var local) tys) local_dicts))))
-\end{code}
+ mk_implicit clas = (all_cls_ids, binds)
+ where
+ dict_con = classDataCon clas
+ all_cls_ids = dataConId dict_con : cls_ids
+ cls_ids = dataConWrapId dict_con : classSelIds clas
+ -- The wrapper and selectors get bindings, the worker does not
+ binds | isLocallyDefined clas = idsToMonoBinds cls_ids
+ | otherwise = EmptyMonoBinds
+\end{code}
%************************************************************************
%* *
defm.Foo.op1 :: forall a. Foo a => a -> Bool
defm.Foo.op1 = /\a -> \dfoo -> \x -> True
-defm.Foo.op2 :: forall a, b. (Foo a, Ord b) => a -> b -> b -> b
-defm.Foo.op2 = /\ a b -> \ dfoo dord -> \x y z ->
+defm.Foo.op2 :: forall a. Foo a => forall b. Ord b => a -> b -> b -> b
+defm.Foo.op2 = /\ a -> \ dfoo -> /\ b -> \ dord -> \x y z ->
if (op1 a dfoo x) && (< b dord y z) then y else z
\end{verbatim}
-Notice that, like all ids, the foralls of defm.Foo.op2 are at the top.
When we come across an instance decl, we may need to use the default
methods:
const.Foo.Int.op1 = defm.Foo.op1 Int dfun.Foo.Int
const.Foo.Int.op2 :: forall b. Ord b => Int -> b -> b -> b
-const.Foo.Int.op2 = /\b -> defm.Foo.op2 Int b dfun.Foo.Int
+const.Foo.Int.op2 = defm.Foo.op2 Int dfun.Foo.Int
dfun.Foo.Int :: Foo Int
dfun.Foo.Int = (const.Foo.Int.op1, const.Foo.Int.op2)
\end{verbatim}
Notice that, as with method selectors above, we assume that dictionary
application is curried, so there's no need to mention the Ord dictionary
-in const.Foo.Int.op2
+in const.Foo.Int.op2 (or the type variable).
+
\begin{verbatim}
instance Foo a => Foo [a] where {}
= /\ a -> \ dfoo_a ->
let rec
op1 = defm.Foo.op1 [a] dfoo_list
- op2 = /\b -> defm.Foo.op2 [a] b dfoo_list
+ op2 = defm.Foo.op2 [a] dfoo_list
dfoo_list = (op1, op2)
in
dfoo_list
\end{verbatim}
\begin{code}
-buildDefaultMethodBinds
- :: E
- -> [TyVar]
- -> InstOrigin
- -> Class
- -> TyVarTemplate
- -> [Id]
+tcDefaultMethodBinds
+ :: Class
-> RenamedMonoBinds
- -> TcM ([Inst], TypecheckedBinds)
-
-buildDefaultMethodBinds e free_tyvars origin clas clas_tyvar_tmpl
- default_method_ids default_binds
- = -- Deal with the method declarations themselves
- processInstBinds e
- free_tyvars
- (makeClassDeclDefaultMethodRhs clas origin default_method_ids)
- [] -- No tyvars in scope for "this inst decl"
- [] -- No insts available
- default_method_ids
- default_binds `thenTc` \ (dicts_needed, default_binds') ->
-
- returnTc (dicts_needed, SingleBind (NonRecBind default_binds'))
+ -> [RenamedSig]
+ -> TcM s (LIE, TcMonoBinds)
+
+tcDefaultMethodBinds clas default_binds sigs
+ = -- Check that the default bindings come from this class
+ checkFromThisClass clas op_items default_binds `thenNF_Tc_`
+
+ -- Do each default method separately
+ -- For Hugs compatibility we make a default-method for every
+ -- class op, regardless of whether or not the programmer supplied an
+ -- explicit default decl for the class. GHC will actually never
+ -- call the default method for such operations, because it'll whip up
+ -- a more-informative default method at each instance decl.
+ mapAndUnzipTc tc_dm op_items `thenTc` \ (defm_binds, const_lies) ->
+
+ returnTc (plusLIEs const_lies, andMonoBindList defm_binds)
+ where
+ prags = filter isPragSig sigs
+
+ (tyvars, _, _, op_items) = classBigSig clas
+
+ origin = ClassDeclOrigin
+
+ -- We make a separate binding for each default method.
+ -- At one time I used a single AbsBinds for all of them, thus
+ -- AbsBind [d] [dm1, dm2, dm3] { dm1 = ...; dm2 = ...; dm3 = ... }
+ -- But that desugars into
+ -- ds = \d -> (..., ..., ...)
+ -- dm1 = \d -> case ds d of (a,b,c) -> a
+ -- And since ds is big, it doesn't get inlined, so we don't get good
+ -- default methods. Better to make separate AbsBinds for each
+
+ tc_dm op_item@(_, dm_id, _)
+ = tcInstTyVars tyvars `thenNF_Tc` \ (clas_tyvars, inst_tys, _) ->
+ let
+ theta = [(mkClassPred clas inst_tys)]
+ in
+ newDicts origin theta `thenNF_Tc` \ (this_dict, [this_dict_id]) ->
+ let
+ avail_insts = this_dict
+ in
+ tcExtendTyVarEnvForMeths tyvars clas_tyvars (
+ tcMethodBind clas origin clas_tyvars inst_tys theta
+ default_binds prags False
+ op_item
+ ) `thenTc` \ (defm_bind, insts_needed, (_, local_dm_id)) ->
+
+ tcAddErrCtxt (defltMethCtxt clas) $
+
+ -- tcMethodBind has checked that the class_tyvars havn't
+ -- been unified with each other or another type, but we must
+ -- still zonk them before passing them to tcSimplifyAndCheck
+ mapNF_Tc zonkTcTyVarBndr clas_tyvars `thenNF_Tc` \ clas_tyvars' ->
+
+ -- Check the context
+ tcSimplifyAndCheck
+ (ptext SLIT("class") <+> ppr clas)
+ (mkVarSet clas_tyvars')
+ avail_insts
+ insts_needed `thenTc` \ (const_lie, dict_binds) ->
+
+ let
+ full_bind = AbsBinds
+ clas_tyvars'
+ [this_dict_id]
+ [(clas_tyvars', dm_id, local_dm_id)]
+ emptyNameSet -- No inlines (yet)
+ (dict_binds `andMonoBinds` defm_bind)
+ in
+ returnTc (full_bind, const_lie)
+\end{code}
+
+\begin{code}
+checkFromThisClass :: Class -> [ClassOpItem] -> RenamedMonoBinds -> NF_TcM s ()
+checkFromThisClass clas op_items mono_binds
+ = mapNF_Tc check_from_this_class bndrs `thenNF_Tc_`
+ returnNF_Tc ()
+ where
+ check_from_this_class (bndr, loc)
+ | nameOccName bndr `elem` sel_names = returnNF_Tc ()
+ | otherwise = tcAddSrcLoc loc $
+ addErrTc (badMethodErr bndr clas)
+ sel_names = [getOccName sel_id | (sel_id,_,_) <- op_items]
+ bndrs = bagToList (collectMonoBinders mono_binds)
\end{code}
+
-@makeClassDeclDefaultMethodRhs@ builds the default method for a
-class declaration when no explicit default method is given.
+@tcMethodBind@ is used to type-check both default-method and
+instance-decl method declarations. We must type-check methods one at a
+time, because their signatures may have different contexts and
+tyvar sets.
\begin{code}
-makeClassDeclDefaultMethodRhs
+tcMethodBind
:: Class
-> InstOrigin
- -> [Id]
- -> Int
- -> NF_TcM TypecheckedExpr
+ -> [TcTyVar] -- Instantiated type variables for the
+ -- enclosing class/instance decl.
+ -- They'll be signature tyvars, and we
+ -- want to check that they don't get bound
+ -> [TcType] -- Instance types
+ -> TcThetaType -- Available theta; this could be used to check
+ -- the method signature, but actually that's done by
+ -- the caller; here, it's just used for the error message
+ -> RenamedMonoBinds -- Method binding (pick the right one from in here)
+ -> [RenamedSig] -- Pramgas (just for this one)
+ -> Bool -- True <=> This method is from an instance declaration
+ -> ClassOpItem -- The method selector and default-method Id
+ -> TcM s (TcMonoBinds, LIE, (LIE, TcId))
+
+tcMethodBind clas origin inst_tyvars inst_tys inst_theta
+ meth_binds prags is_inst_decl
+ (sel_id, dm_id, explicit_dm)
+ = tcGetSrcLoc `thenNF_Tc` \ loc ->
+
+ newMethod origin sel_id inst_tys `thenNF_Tc` \ meth@(_, meth_id) ->
+ mkTcSig meth_id loc `thenNF_Tc` \ sig_info ->
+
+ let
+ meth_name = idName meth_id
+ maybe_user_bind = find_bind meth_name meth_binds
+
+ no_user_bind = case maybe_user_bind of {Nothing -> True; other -> False}
+
+ meth_bind = case maybe_user_bind of
+ Just bind -> bind
+ Nothing -> mk_default_bind meth_name loc
+
+ meth_prags = find_prags meth_name prags
+ in
+
+ -- Warn if no method binding, only if -fwarn-missing-methods
+ warnTc (is_inst_decl && opt_WarnMissingMethods && no_user_bind && not explicit_dm)
+ (omittedMethodWarn sel_id clas) `thenNF_Tc_`
+
+ -- Check the bindings; first add inst_tyvars to the envt
+ -- so that we don't quantify over them in nested places
+ -- The *caller* put the class/inst decl tyvars into the envt
+ tcExtendGlobalTyVars (mkVarSet inst_tyvars) (
+ tcAddErrCtxt (methodCtxt sel_id) $
+ tcBindWithSigs NotTopLevel meth_bind
+ [sig_info] meth_prags NonRecursive
+ ) `thenTc` \ (binds, insts, _) ->
+
+
+ tcExtendLocalValEnv [(meth_name, meth_id)] (
+ tcSpecSigs meth_prags
+ ) `thenTc` \ (prag_binds1, prag_lie) ->
+
+ -- The prag_lie for a SPECIALISE pragma will mention the function
+ -- itself, so we have to simplify them away right now lest they float
+ -- outwards!
+ bindInstsOfLocalFuns prag_lie [meth_id] `thenTc` \ (prag_lie', prag_binds2) ->
+
+
+ -- Now check that the instance type variables
+ -- (or, in the case of a class decl, the class tyvars)
+ -- have not been unified with anything in the environment
+ tcAddErrCtxtM (sigCtxt sig_msg inst_tyvars inst_theta (idType meth_id)) $
+ checkSigTyVars inst_tyvars emptyVarSet `thenTc_`
+
+ returnTc (binds `AndMonoBinds` prag_binds1 `AndMonoBinds` prag_binds2,
+ insts `plusLIE` prag_lie',
+ meth)
+ where
+ sig_msg = ptext SLIT("When checking the expected type for class method") <+> ppr sel_name
+
+ sel_name = idName sel_id
+
+ -- The renamer just puts the selector ID as the binder in the method binding
+ -- but we must use the method name; so we substitute it here. Crude but simple.
+ find_bind meth_name (FunMonoBind op_name fix matches loc)
+ | op_name == sel_name = Just (FunMonoBind meth_name fix matches loc)
+ find_bind meth_name (PatMonoBind (VarPatIn op_name) grhss loc)
+ | op_name == sel_name = Just (PatMonoBind (VarPatIn meth_name) grhss loc)
+ find_bind meth_name (AndMonoBinds b1 b2)
+ = find_bind meth_name b1 `seqMaybe` find_bind meth_name b2
+ find_bind meth_name other = Nothing -- Default case
+
+
+ -- Find the prags for this method, and replace the
+ -- selector name with the method name
+ find_prags meth_name [] = []
+ find_prags meth_name (SpecSig name ty loc : prags)
+ | name == sel_name = SpecSig meth_name ty loc : find_prags meth_name prags
+ find_prags meth_name (InlineSig name phase loc : prags)
+ | name == sel_name = InlineSig meth_name phase loc : find_prags meth_name prags
+ find_prags meth_name (NoInlineSig name phase loc : prags)
+ | name == sel_name = NoInlineSig meth_name phase loc : find_prags meth_name prags
+ find_prags meth_name (prag:prags) = find_prags meth_name prags
+
+ mk_default_bind local_meth_name loc
+ = PatMonoBind (VarPatIn local_meth_name)
+ (GRHSs (unguardedRHS (default_expr loc) loc) EmptyBinds Nothing)
+ loc
+
+ default_expr loc
+ | explicit_dm = HsVar (getName dm_id) -- There's a default method
+ | otherwise = error_expr loc -- No default method
+
+ error_expr loc = HsApp (HsVar (getName nO_METHOD_BINDING_ERROR_ID))
+ (HsLit (HsString (_PK_ (error_msg loc))))
+
+ error_msg loc = showSDoc (hcat [ppr loc, text "|", ppr sel_id ])
+\end{code}
-makeClassDeclDefaultMethodRhs clas origin method_ids tag
- = specTy origin (getIdUniType method_id) `thenNF_Tc` \ (tyvars, dicts, tau) ->
+Contexts and errors
+~~~~~~~~~~~~~~~~~~~
+\begin{code}
+classArityErr class_name
+ = ptext SLIT("Too many parameters for class") <+> quotes (ppr class_name)
- returnNF_Tc (mkTyLam tyvars (
- mkDictLam (map mkInstId dicts) (
- App (mkTyApp (Var pAT_ERROR_ID) [tau])
- (Lit (StringLit (_PK_ error_msg))))))
- where
- method_id = method_ids !! (tag-1)
- class_op = (getClassOps clas) !! (tag-1)
+superClassErr class_name sc
+ = ptext SLIT("Illegal superclass constraint") <+> quotes (pprHsClassAssertion sc)
+ <+> ptext SLIT("in declaration for class") <+> quotes (ppr class_name)
+
+defltMethCtxt class_name
+ = ptext SLIT("When checking the default methods for class") <+> quotes (ppr class_name)
- error_msg = "%D" -- => No default method for \"
- ++ unencoded_part_of_msg
+methodCtxt sel_id
+ = ptext SLIT("In the definition for method") <+> quotes (ppr sel_id)
- unencoded_part_of_msg = escErrorMsg (
- _UNPK_ clas_mod ++ "." ++ _UNPK_ clas_name ++ "."
- ++ (ppShow 80 (ppr PprForUser class_op))
- ++ "\"" )
+badMethodErr bndr clas
+ = hsep [ptext SLIT("Class"), quotes (ppr clas),
+ ptext SLIT("does not have a method"), quotes (ppr bndr)]
- (clas_mod, clas_name) = getOrigName clas
+omittedMethodWarn sel_id clas
+ = sep [ptext SLIT("No explicit method nor default method for") <+> quotes (ppr sel_id),
+ ptext SLIT("in an instance declaration for") <+> quotes (ppr clas)]
\end{code}