X-Git-Url: http://git.megacz.com/?a=blobdiff_plain;f=ghc%2Fcompiler%2Ftypecheck%2FTcClassDcl.lhs;h=14682a295dfce033d00222e85b745e880a692a1b;hb=28a464a75e14cece5db40f2765a29348273ff2d2;hp=86d3bba3bc42303f9770f7c069fc9e689b102f41;hpb=9aba9a7f16e3f4acd79c75aacdbaad5af92f8752;p=ghc-hetmet.git diff --git a/ghc/compiler/typecheck/TcClassDcl.lhs b/ghc/compiler/typecheck/TcClassDcl.lhs index 86d3bba..14682a2 100644 --- a/ghc/compiler/typecheck/TcClassDcl.lhs +++ b/ghc/compiler/typecheck/TcClassDcl.lhs @@ -4,62 +4,63 @@ \section[TcClassDcl]{Typechecking class declarations} \begin{code} -module TcClassDcl ( tcClassDecl1, tcClassDecls2, - MethodSpec, tcMethodBind, mkMethodBind, badMethodErr +module TcClassDcl ( tcClassSigs, tcClassDecl2, + getGenericInstances, + MethodSpec, tcMethodBind, mkMethodBind, + tcAddDeclCtxt, badMethodErr ) where #include "HsVersions.h" -import HsSyn ( TyClDecl(..), Sig(..), MonoBinds(..), - HsExpr(..), HsLit(..), Pat(WildPat), - mkSimpleMatch, andMonoBinds, andMonoBindList, - isClassOpSig, isPragSig, - placeHolderType +import HsSyn +import RnHsSyn ( maybeGenericMatch, extractHsTyVars ) +import RnExpr ( rnLExpr ) +import RnEnv ( lookupTopBndrRn, lookupImportedName ) +import Inst ( instToId, newDicts, newDictsAtLoc, newMethod, getOverlapFlag ) +import InstEnv ( mkLocalInstance ) +import TcEnv ( tcLookupLocatedClass, + tcExtendTyVarEnv, tcExtendIdEnv, + InstInfo(..), pprInstInfoDetails, + simpleInstInfoTyCon, simpleInstInfoTy, + InstBindings(..), newDFunName ) -import BasicTypes ( RecFlag(..), StrictnessMark(..) ) -import RnHsSyn ( RenamedTyClDecl, RenamedSig, - RenamedClassOpSig, RenamedMonoBinds, - maybeGenericMatch - ) -import RnEnv ( lookupSysName ) -import TcHsSyn ( TcMonoBinds ) - -import Inst ( Inst, InstOrigin(..), instToId, newDicts, tcInstClassOp ) -import TcEnv ( TyThingDetails(..), - tcLookupClass, tcExtendTyVarEnv2, - tcExtendTyVarEnv - ) -import TcBinds ( tcMonoBinds ) -import TcMonoType ( TcSigInfo(..), tcHsType, tcHsTheta, mkTcSig ) +import TcBinds ( TcPragFun, tcMonoBinds, tcPrags, mkPragFun, TcSigInfo(..) ) +import TcHsType ( tcHsKindedType, tcHsSigType ) import TcSimplify ( tcSimplifyCheck ) import TcUnify ( checkSigTyVars, sigCtxt ) -import TcMType ( tcInstTyVars ) -import TcType ( Type, TyVarDetails(..), TcType, TcThetaType, TcTyVar, - mkTyVarTys, mkPredTys, mkClassPred, tcSplitSigmaTy, tcSplitFunTys, - tcIsTyVarTy, tcSplitTyConApp_maybe +import TcMType ( tcSkolSigTyVars ) +import TcType ( Type, SkolemInfo(ClsSkol, InstSkol), UserTypeCtxt( GenPatCtxt ), + TcType, TcThetaType, TcTyVar, mkTyVarTys, + mkClassPred, tcSplitSigmaTy, tcSplitFunTys, + tcIsTyVarTy, tcSplitTyConApp_maybe, tcSplitForAllTys, tcSplitPhiTy, + getClassPredTys_maybe, mkPhiTy, mkTyVarTy ) import TcRnMonad -import Generics ( mkGenericRhs ) +import Generics ( mkGenericRhs, validGenericInstanceType ) import PrelInfo ( nO_METHOD_BINDING_ERROR_ID ) -import Class ( classTyVars, classBigSig, classTyCon, +import Class ( classTyVars, classBigSig, Class, ClassOpItem, DefMeth (..) ) -import TyCon ( tyConGenInfo ) -import MkId ( mkDictSelId, mkDataConId, mkDataConWrapId, mkDefaultMethodId ) -import DataCon ( mkDataCon ) -import Id ( Id, idType, idName, setIdLocalExported, setInlinePragma ) +import TyCon ( TyCon, tyConName, tyConHasGenerics ) +import Type ( substTyWith ) +import MkId ( mkDefaultMethodId, mkDictFunId ) +import Id ( Id, idType, idName, mkUserLocal ) import Name ( Name, NamedThing(..) ) -import NameEnv ( NameEnv, lookupNameEnv, emptyNameEnv, unitNameEnv, plusNameEnv ) -import NameSet ( emptyNameSet, unitNameSet ) -import OccName ( mkClassTyConOcc, mkClassDataConOcc, mkWorkerOcc, - mkSuperDictSelOcc, reportIfUnused ) +import NameEnv ( NameEnv, lookupNameEnv, mkNameEnv ) +import NameSet ( nameSetToList ) +import OccName ( reportIfUnused, mkDefaultMethodOcc ) +import RdrName ( RdrName, mkDerivedRdrName ) import Outputable -import Var ( TyVar ) -import CmdLineOpts -import UnicodeUtil ( stringToUtf8 ) -import ErrUtils ( dumpIfSet ) -import Util ( count, lengthIs ) -import Maybes ( seqMaybe ) -import Maybe ( isJust ) +import PrelNames ( genericTyConNames ) +import DynFlags +import ErrUtils ( dumpIfSet_dyn ) +import Util ( count, lengthIs, isSingleton, lengthExceeds ) +import Unique ( Uniquable(..) ) +import ListSetOps ( equivClassesByUniq, minusList ) +import SrcLoc ( Located(..), srcSpanStart, unLoc, noLoc ) +import Maybes ( seqMaybe, isJust, mapCatMaybes ) +import List ( partition ) +import BasicTypes ( RecFlag(..), Boxity(..) ) +import Bag import FastString \end{code} @@ -100,157 +101,63 @@ Death to "ExpandingDicts". %************************************************************************ %* * -\subsection{Type checking} + Type-checking the class op signatures %* * %************************************************************************ \begin{code} +tcClassSigs :: Name -- Name of the class + -> [LSig Name] + -> LHsBinds Name + -> TcM [TcMethInfo] + +type TcMethInfo = (Name, DefMeth, Type) -- A temporary intermediate, to communicate + -- between tcClassSigs and buildClass +tcClassSigs clas sigs def_methods + = do { dm_env <- checkDefaultBinds clas op_names def_methods + ; mappM (tcClassSig dm_env) op_sigs } + where + op_sigs = [sig | sig@(L _ (TypeSig _ _)) <- sigs] + op_names = [n | sig@(L _ (TypeSig (L _ n) _)) <- op_sigs] -tcClassDecl1 :: RenamedTyClDecl -> TcM (Name, TyThingDetails) -tcClassDecl1 (ClassDecl {tcdCtxt = context, tcdName = class_name, - tcdTyVars = tyvar_names, tcdFDs = fundeps, - tcdSigs = class_sigs, tcdMeths = def_methods, - tcdLoc = src_loc}) - = -- LOOK THINGS UP IN THE ENVIRONMENT - tcLookupClass class_name `thenM` \ clas -> - let - tyvars = classTyVars clas - op_sigs = filter isClassOpSig class_sigs - op_names = [n | ClassOpSig n _ _ _ <- op_sigs] - in - tcExtendTyVarEnv tyvars $ - - checkDefaultBinds clas op_names def_methods `thenM` \ mb_dm_env -> - - -- CHECK THE CONTEXT - -- The renamer has already checked that the context mentions - -- only the type variable of the class decl. - -- Context is already kind-checked - tcHsTheta context `thenM` \ sc_theta -> - - -- CHECK THE CLASS SIGNATURES, - mappM (tcClassSig clas tyvars mb_dm_env) op_sigs `thenM` \ sig_stuff -> - - -- MAKE THE CLASS DETAILS - lookupSysName class_name mkClassDataConOcc `thenM` \ datacon_name -> - lookupSysName datacon_name mkWorkerOcc `thenM` \ datacon_wkr_name -> - mapM (lookupSysName class_name . mkSuperDictSelOcc) - [1..length context] `thenM` \ sc_sel_names -> - -- We number off the superclass selectors, 1, 2, 3 etc so that we - -- can construct names for the selectors. Thus - -- class (C a, C b) => D a b where ... - -- gives superclass selectors - -- D_sc1, D_sc2 - -- (We used to call them D_C, but now we can have two different - -- superclasses both called C!) - lookupSysName class_name mkClassTyConOcc `thenM` \ tycon_name -> - let - (op_tys, op_items) = unzip sig_stuff - sc_tys = mkPredTys sc_theta - dict_component_tys = sc_tys ++ op_tys - sc_sel_ids = [mkDictSelId sc_name clas | sc_name <- sc_sel_names] - - dict_con = mkDataCon datacon_name - [NotMarkedStrict | _ <- dict_component_tys] - [{- No labelled fields -}] - tyvars - [{-No context-}] - [{-No existential tyvars-}] [{-Or context-}] - dict_component_tys - (classTyCon clas) - dict_con_id dict_wrap_id - - dict_con_id = mkDataConId datacon_wkr_name dict_con - dict_wrap_id = mkDataConWrapId dict_con - in - returnM (class_name, ClassDetails sc_theta sc_sel_ids op_items dict_con tycon_name) -\end{code} - -\begin{code} -checkDefaultBinds :: Class -> [Name] -> Maybe RenamedMonoBinds - -> TcM (Maybe (NameEnv Bool)) - -- The returned environment says - -- x not in env => no default method - -- x -> True => generic default method - -- x -> False => polymorphic default method +checkDefaultBinds :: Name -> [Name] -> LHsBinds Name -> TcM (NameEnv Bool) -- Check default bindings -- a) must be for a class op for this class -- b) must be all generic or all non-generic - -- and return a mapping from class-op to DefMeth info - - -- But do all this only for source binds - -checkDefaultBinds clas ops Nothing - = returnM Nothing + -- and return a mapping from class-op to Bool + -- where True <=> it's a generic default method +checkDefaultBinds clas ops binds + = do dm_infos <- mapM (addLocM (checkDefaultBind clas ops)) (bagToList binds) + return (mkNameEnv dm_infos) -checkDefaultBinds clas ops (Just mbs) - = go mbs `thenM` \ dm_env -> - returnM (Just dm_env) - where - go EmptyMonoBinds = returnM emptyNameEnv - - go (AndMonoBinds b1 b2) - = go b1 `thenM` \ dm_info1 -> - go b2 `thenM` \ dm_info2 -> - returnM (dm_info1 `plusNameEnv` dm_info2) - - go (FunMonoBind op _ matches loc) - = addSrcLoc loc $ - - -- Check that the op is from this class - checkTc (op `elem` ops) (badMethodErr clas op) `thenM_` +checkDefaultBind clas ops (FunBind {fun_id = L _ op, fun_matches = MatchGroup matches _ }) + = do { -- Check that the op is from this class + checkTc (op `elem` ops) (badMethodErr clas op) -- Check that all the defns ar generic, or none are - checkTc (all_generic || none_generic) (mixedGenericErr op) `thenM_` + ; checkTc (all_generic || none_generic) (mixedGenericErr op) - returnM (unitNameEnv op all_generic) - where - n_generic = count (isJust . maybeGenericMatch) matches - none_generic = n_generic == 0 - all_generic = matches `lengthIs` n_generic -\end{code} - - -\begin{code} -tcClassSig :: Class -- ...ditto... - -> [TyVar] -- The class type variable, used for error check only - -> Maybe (NameEnv Bool) -- Info about default methods; - -- Nothing => imported class defn with no method binds - -> RenamedClassOpSig - -> TcM (Type, -- Type of the method - ClassOpItem) -- Selector Id, default-method Id, True if explicit default binding - --- This warrants an explanation: we need to separate generic --- default methods and default methods later on in the compiler --- so we distinguish them in checkDefaultBinds, and pass this knowledge in the --- Class.DefMeth data structure. - -tcClassSig clas clas_tyvars maybe_dm_env - (ClassOpSig op_name sig_dm op_ty src_loc) - = addSrcLoc src_loc $ - - -- Check the type signature. NB that the envt *already has* - -- bindings for the type variables; see comments in TcTyAndClassDcls. - tcHsType op_ty `thenM` \ local_ty -> - - let - theta = [mkClassPred clas (mkTyVarTys clas_tyvars)] - - -- Build the selector id and default method id - sel_id = mkDictSelId op_name clas - DefMeth dm_name = sig_dm - - dm_info = case maybe_dm_env of - Nothing -> sig_dm - Just dm_env -> mk_src_dm_info dm_env - - mk_src_dm_info dm_env = case lookupNameEnv dm_env op_name of - Nothing -> NoDefMeth - Just True -> GenDefMeth - Just False -> DefMeth dm_name - in - returnM (local_ty, (sel_id, dm_info)) + ; returnM (op, all_generic) + } + where + n_generic = count (isJust . maybeGenericMatch) matches + none_generic = n_generic == 0 + all_generic = matches `lengthIs` n_generic + + +tcClassSig :: NameEnv Bool -- Info about default methods; + -> LSig Name + -> TcM TcMethInfo + +tcClassSig dm_env (L loc (TypeSig (L _ op_name) op_hs_ty)) + = setSrcSpan loc $ do + { op_ty <- tcHsKindedType op_hs_ty -- Class tyvars already in scope + ; let dm = case lookupNameEnv dm_env op_name of + Nothing -> NoDefMeth + Just False -> DefMeth + Just True -> GenDefMeth + ; returnM (op_name, dm, op_ty) } \end{code} @@ -315,37 +222,18 @@ dfun.Foo.List dfoo_list \end{verbatim} -The function @tcClassDecls2@ just arranges to apply @tcClassDecl2@ to -each local class decl. - -\begin{code} -tcClassDecls2 :: [RenamedTyClDecl] -> TcM (TcMonoBinds, [Id]) - -tcClassDecls2 decls - = foldr combine - (returnM (EmptyMonoBinds, [])) - [tcClassDecl2 cls_decl | cls_decl@(ClassDecl {tcdMeths = Just _}) <- decls] - -- The 'Just' picks out source ClassDecls - where - combine tc1 tc2 = tc1 `thenM` \ (binds1, ids1) -> - tc2 `thenM` \ (binds2, ids2) -> - returnM (binds1 `AndMonoBinds` binds2, - ids1 ++ ids2) -\end{code} - -@tcClassDecl2@ generates bindings for polymorphic default methods +@tcClassDecls2@ generates bindings for polymorphic default methods (generic default methods have by now turned into instance declarations) \begin{code} -tcClassDecl2 :: RenamedTyClDecl -- The class declaration - -> TcM (TcMonoBinds, [Id]) +tcClassDecl2 :: LTyClDecl Name -- The class declaration + -> TcM (LHsBinds Id, [Id]) -tcClassDecl2 (ClassDecl {tcdName = class_name, tcdSigs = sigs, - tcdMeths = Just default_binds, tcdLoc = src_loc}) - = -- The 'Just' picks out source ClassDecls - recoverM (returnM (EmptyMonoBinds, [])) $ - addSrcLoc src_loc $ - tcLookupClass class_name `thenM` \ clas -> +tcClassDecl2 (L loc (ClassDecl {tcdLName = class_name, tcdSigs = sigs, + tcdMeths = default_binds})) + = recoverM (returnM (emptyLHsBinds, [])) $ + setSrcSpan loc $ + tcLookupLocatedClass class_name `thenM` \ clas -> -- We make a separate binding for each default method. -- At one time I used a single AbsBinds for all of them, thus @@ -357,70 +245,66 @@ tcClassDecl2 (ClassDecl {tcdName = class_name, tcdSigs = sigs, -- default methods. Better to make separate AbsBinds for each let (tyvars, _, _, op_items) = classBigSig clas - prags = filter isPragSig sigs - tc_dm = tcDefMeth clas tyvars default_binds prags - in - mapAndUnzipM tc_dm op_items `thenM` \ (defm_binds, dm_ids_s) -> + prag_fn = mkPragFun sigs + tc_dm = tcDefMeth clas tyvars default_binds prag_fn - returnM (andMonoBindList defm_binds, concat dm_ids_s) - - -tcDefMeth clas tyvars binds_in prags (_, NoDefMeth) = returnM (EmptyMonoBinds, []) -tcDefMeth clas tyvars binds_in prags (_, GenDefMeth) = returnM (EmptyMonoBinds, []) + dm_sel_ids = [sel_id | (sel_id, DefMeth) <- op_items] -- Generate code for polymorphic default methods only -- (Generic default methods have turned into instance decls by now.) -- This is incompatible with Hugs, which expects a polymorphic -- default method for every class op, regardless of whether or not -- the programmer supplied an explicit default decl for the class. -- (If necessary we can fix that, but we don't have a convenient Id to hand.) - -tcDefMeth clas tyvars binds_in prags op_item@(sel_id, DefMeth dm_name) - = tcInstTyVars ClsTv tyvars `thenM` \ (clas_tyvars, inst_tys, _) -> - let - dm_ty = idType sel_id -- Same as dict selector! - -- The default method's type should really come from the - -- iface file, since it could be usage-generalised, but this - -- requires altering the mess of knots in TcModule and I'm - -- too scared to do that. Instead, I have disabled generalisation - -- of types of default methods (and dict funs) by annotating them - -- TyGenNever (in MkId). Ugh! KSW 1999-09. - - theta = [mkClassPred clas inst_tys] - local_dm_id = mkDefaultMethodId dm_name dm_ty - xtve = tyvars `zip` clas_tyvars in - newDicts origin theta `thenM` \ [this_dict] -> - - mkMethodBind origin clas inst_tys binds_in op_item `thenM` \ (dm_inst, meth_info) -> - getLIE (tcMethodBind xtve clas_tyvars theta - [this_dict] prags meth_info) `thenM` \ (defm_bind, insts_needed) -> + mapAndUnzipM tc_dm dm_sel_ids `thenM` \ (defm_binds, dm_ids_s) -> + returnM (listToBag defm_binds, concat dm_ids_s) - addErrCtxt (defltMethCtxt clas) $ +tcDefMeth clas tyvars binds_in prag_fn sel_id + = do { dm_name <- lookupTopBndrRn (mkDefMethRdrName sel_id) + ; let rigid_info = ClsSkol clas + clas_tyvars = tcSkolSigTyVars rigid_info tyvars + inst_tys = mkTyVarTys clas_tyvars + dm_ty = idType sel_id -- Same as dict selector! + theta = [mkClassPred clas inst_tys] + local_dm_id = mkDefaultMethodId dm_name dm_ty + origin = SigOrigin rigid_info + + ; (_, meth_info) <- mkMethodBind origin clas inst_tys binds_in (sel_id, DefMeth) + ; [this_dict] <- newDicts origin theta + ; (defm_bind, insts_needed) <- getLIE (tcMethodBind clas_tyvars theta + [this_dict] prag_fn meth_info) + + ; addErrCtxt (defltMethCtxt clas) $ do -- Check the context - tcSimplifyCheck - (ptext SLIT("class") <+> ppr clas) - clas_tyvars - [this_dict] - insts_needed `thenM` \ dict_binds -> + { dict_binds <- tcSimplifyCheck + (ptext SLIT("class") <+> ppr clas) + clas_tyvars + [this_dict] + insts_needed -- Simplification can do unification - checkSigTyVars clas_tyvars `thenM` \ clas_tyvars' -> + ; checkSigTyVars clas_tyvars - let - full_bind = AbsBinds - clas_tyvars' - [instToId this_dict] - [(clas_tyvars', local_dm_id, instToId dm_inst)] - emptyNameSet -- No inlines (yet) - (dict_binds `andMonoBinds` defm_bind) - in - returnM (full_bind, [local_dm_id]) - where - origin = ClassDeclOrigin + -- Inline pragmas + -- We'll have an inline pragma on the local binding, made by tcMethodBind + -- but that's not enough; we want one on the global default method too + -- Specialisations, on the other hand, belong on the thing inside only, I think + ; let (_,dm_inst_id,_) = meth_info + sel_name = idName sel_id + inline_prags = filter isInlineLSig (prag_fn sel_name) + ; prags <- tcPrags dm_inst_id inline_prags + + ; let full_bind = AbsBinds clas_tyvars + [instToId this_dict] + [(clas_tyvars, local_dm_id, dm_inst_id, prags)] + (dict_binds `unionBags` defm_bind) + ; returnM (noLoc full_bind, [local_dm_id]) }} + +mkDefMethRdrName :: Id -> RdrName +mkDefMethRdrName sel_id = mkDerivedRdrName (idName sel_id) mkDefaultMethodOcc \end{code} - %************************************************************************ %* * @@ -435,31 +319,47 @@ tyvar sets. \begin{code} type MethodSpec = (Id, -- Global selector Id - TcSigInfo, -- Signature - RenamedMonoBinds) -- Binding for the method + Id, -- Local Id (class tyvars instantiated) + LHsBind Name) -- Binding for the method tcMethodBind - :: [(TyVar,TcTyVar)] -- Bindings for type environment - -> [TcTyVar] -- Instantiated type variables for the + :: [TcTyVar] -- Skolemised type variables for the -- enclosing class/instance decl. -- They'll be signature tyvars, and we -- want to check that they don't get bound + -- Also they are scoped, so we bring them into scope -- Always equal the range of the type envt -> TcThetaType -- Available theta; it's just used for the error message -> [Inst] -- Available from context, used to simplify constraints -- from the method body - -> [RenamedSig] -- Pragmas (e.g. inline pragmas) + -> TcPragFun -- Pragmas (e.g. inline pragmas) -> MethodSpec -- Details of this method - -> TcM TcMonoBinds + -> TcM (LHsBinds Id) + +tcMethodBind inst_tyvars inst_theta avail_insts prag_fn + (sel_id, meth_id, meth_bind) + = recoverM (returnM emptyLHsBinds) $ + -- If anything fails, recover returning no bindings. + -- This is particularly useful when checking the default-method binding of + -- a class decl. If we don't recover, we don't add the default method to + -- the type enviroment, and we get a tcLookup failure on $dmeth later. -tcMethodBind xtve inst_tyvars inst_theta avail_insts prags - (sel_id, meth_sig, meth_bind) - = -- Check the bindings; first adding inst_tyvars to the envt + -- Check the bindings; first adding inst_tyvars to the envt -- so that we don't quantify over them in nested places - tcExtendTyVarEnv2 xtve ( - addErrCtxt (methodCtxt sel_id) $ - getLIE (tcMonoBinds meth_bind [meth_sig] NonRecursive) - ) `thenM` \ ((meth_bind, _, _), meth_lie) -> + + + let meth_sig = noLoc (TypeSig (noLoc (idName meth_id)) (noLoc bogus_ty)) + bogus_ty = HsTupleTy Boxed [] -- *Only* used to extract scoped type + -- variables... and there aren't any + lookup_sig name = ASSERT( name == idName meth_id ) + Just meth_sig + in + tcExtendTyVarEnv inst_tyvars ( + tcExtendIdEnv [meth_id] $ -- In scope for tcInstSig + addErrCtxt (methodCtxt sel_id) $ + getLIE $ + tcMonoBinds [meth_bind] lookup_sig Recursive + ) `thenM` \ ((meth_bind, mono_bind_infos), meth_lie) -> -- Now do context reduction. We simplify wrt both the local tyvars -- and the ones of the class/instance decl, so that there is @@ -469,82 +369,113 @@ tcMethodBind xtve inst_tyvars inst_theta avail_insts prags -- -- We do this for each method independently to localise error messages - let - TySigInfo meth_id meth_tvs meth_theta _ local_meth_id _ _ = meth_sig - in - addErrCtxtM (sigCtxt sel_id inst_tyvars inst_theta (idType meth_id)) $ - newDicts SignatureOrigin meth_theta `thenM` \ meth_dicts -> - let + let + [(_, Just sig, local_meth_id)] = mono_bind_infos + in + + addErrCtxtM (sigCtxt sel_id inst_tyvars inst_theta (idType meth_id)) $ + newDictsAtLoc (sig_loc sig) (sig_theta sig) `thenM` \ meth_dicts -> + let + meth_tvs = sig_tvs sig all_tyvars = meth_tvs ++ inst_tyvars all_insts = avail_insts ++ meth_dicts - in - tcSimplifyCheck + sel_name = idName sel_id + in + tcSimplifyCheck (ptext SLIT("class or instance method") <+> quotes (ppr sel_id)) all_tyvars all_insts meth_lie `thenM` \ lie_binds -> - checkSigTyVars all_tyvars `thenM` \ all_tyvars' -> - - let - -- Attach inline pragmas as appropriate - (final_meth_id, inlines) - | (InlineSig inl _ phase _ : _) <- filter is_inline prags - = (meth_id `setInlinePragma` phase, - if inl then unitNameSet (idName meth_id) else emptyNameSet) - | otherwise - = (meth_id, emptyNameSet) - - is_inline (InlineSig _ name _ _) = name == idName sel_id - is_inline other = False + checkSigTyVars all_tyvars `thenM_` - meth_tvs' = take (length meth_tvs) all_tyvars' - poly_meth_bind = AbsBinds meth_tvs' + tcPrags meth_id (prag_fn sel_name) `thenM` \ prags -> + let + poly_meth_bind = noLoc $ AbsBinds meth_tvs (map instToId meth_dicts) - [(meth_tvs', final_meth_id, local_meth_id)] - inlines - (lie_binds `andMonoBinds` meth_bind) - in - returnM poly_meth_bind + [(meth_tvs, meth_id, local_meth_id, prags)] + (lie_binds `unionBags` meth_bind) + in + returnM (unitBag poly_meth_bind) mkMethodBind :: InstOrigin -> Class -> [TcType] -- Class and instance types - -> RenamedMonoBinds -- Method binding (pick the right one from in here) + -> LHsBinds Name -- Method binding (pick the right one from in here) -> ClassOpItem - -> TcM (Inst, -- Method inst + -> TcM (Maybe Inst, -- Method inst MethodSpec) -- Find the binding for the specified method, or make -- up a suitable default method if it isn't there mkMethodBind origin clas inst_tys meth_binds (sel_id, dm_info) - = getInstLoc origin `thenM` \ inst_loc -> - tcInstClassOp inst_loc sel_id inst_tys `thenM` \ meth_inst -> - -- Do not dump anything into the LIE + = mkMethId origin clas sel_id inst_tys `thenM` \ (mb_inst, meth_id) -> let - meth_id = instToId meth_inst meth_name = idName meth_id in -- Figure out what method binding to use -- If the user suppplied one, use it, else construct a default one - getSrcLocM `thenM` \ loc -> + getSrcSpanM `thenM` \ loc -> (case find_bind (idName sel_id) meth_name meth_binds of Just user_bind -> returnM user_bind - Nothing -> mkDefMethRhs origin clas inst_tys sel_id loc dm_info `thenM` \ rhs -> - returnM (FunMonoBind meth_name False -- Not infix decl - [mkSimpleMatch [] rhs placeHolderType loc] loc) - ) `thenM` \ meth_bind -> - - mkTcSig meth_id loc `thenM` \ meth_sig -> - - returnM (meth_inst, (sel_id, meth_sig, meth_bind)) - + Nothing -> + mkDefMethRhs origin clas inst_tys sel_id loc dm_info `thenM` \ rhs -> + -- Not infix decl + returnM (noLoc $ mkFunBind (noLoc meth_name) [mkSimpleMatch [] rhs]) + ) `thenM` \ meth_bind -> + + returnM (mb_inst, (sel_id, meth_id, meth_bind)) + +mkMethId :: InstOrigin -> Class + -> Id -> [TcType] -- Selector, and instance types + -> TcM (Maybe Inst, Id) + +-- mkMethId instantiates the selector Id at the specified types +mkMethId origin clas sel_id inst_tys + = let + (tyvars,rho) = tcSplitForAllTys (idType sel_id) + rho_ty = ASSERT( length tyvars == length inst_tys ) + substTyWith tyvars inst_tys rho + (preds,tau) = tcSplitPhiTy rho_ty + first_pred = head preds + in + -- The first predicate should be of form (C a b) + -- where C is the class in question + ASSERT( not (null preds) && + case getClassPredTys_maybe first_pred of + { Just (clas1,tys) -> clas == clas1 ; Nothing -> False } + ) + if isSingleton preds then + -- If it's the only one, make a 'method' + getInstLoc origin `thenM` \ inst_loc -> + newMethod inst_loc sel_id inst_tys `thenM` \ meth_inst -> + returnM (Just meth_inst, instToId meth_inst) + else + -- If it's not the only one we need to be careful + -- For example, given 'op' defined thus: + -- class Foo a where + -- op :: (?x :: String) => a -> a + -- (mkMethId op T) should return an Inst with type + -- (?x :: String) => T -> T + -- That is, the class-op's context is still there. + -- BUT: it can't be a Method any more, because it breaks + -- INVARIANT 2 of methods. (See the data decl for Inst.) + newUnique `thenM` \ uniq -> + getSrcSpanM `thenM` \ loc -> + let + real_tau = mkPhiTy (tail preds) tau + meth_id = mkUserLocal (getOccName sel_id) uniq real_tau + (srcSpanStart loc) --TODO + in + returnM (Nothing, meth_id) -- The user didn't supply a method binding, -- so we have to make up a default binding -- The RHS of a default method depends on the default-method info -mkDefMethRhs origin clas inst_tys sel_id loc (DefMeth dm_name) +mkDefMethRhs origin clas inst_tys sel_id loc DefMeth = -- An polymorphic default method - traceRn (text "mkDefMeth" <+> ppr dm_name) `thenM_` - returnM (HsVar dm_name) + lookupImportedName (mkDefMethRdrName sel_id) `thenM` \ dm_name -> + -- Might not be imported, but will be an OrigName + traceRn (text "mkDefMeth" <+> ppr dm_name) `thenM_` + returnM (nlHsVar dm_name) mkDefMethRhs origin clas inst_tys sel_id loc NoDefMeth = -- No default method @@ -556,9 +487,9 @@ mkDefMethRhs origin clas inst_tys sel_id loc NoDefMeth (omittedMethodWarn sel_id) `thenM_` returnM error_rhs where - error_rhs = HsLam (mkSimpleMatch wild_pats simple_rhs placeHolderType loc) - simple_rhs = HsApp (HsVar (getName nO_METHOD_BINDING_ERROR_ID)) - (HsLit (HsStringPrim (mkFastString (stringToUtf8 error_msg)))) + error_rhs = noLoc $ HsLam (mkMatchGroup [mkSimpleMatch wild_pats simple_rhs]) + simple_rhs = nlHsApp (nlHsVar (getName nO_METHOD_BINDING_ERROR_ID)) + (nlHsLit (HsStringPrim (mkFastString error_msg))) error_msg = showSDoc (hcat [ppr loc, text "|", ppr sel_id ]) -- When the type is of form t1 -> t2 -> t3 @@ -579,29 +510,31 @@ mkDefMethRhs origin clas inst_tys sel_id loc NoDefMeth -- Need two splits because the selector can have a type like -- forall a. Foo a => forall b. Eq b => ... (arg_tys, _) = tcSplitFunTys tau2 - wild_pats = [WildPat placeHolderType | ty <- arg_tys] + wild_pats = [nlWildPat | ty <- arg_tys] mkDefMethRhs origin clas inst_tys sel_id loc GenDefMeth - = -- A generic default method - -- If the method is defined generically, we can only do the job if the + = -- A generic default method + -- If the method is defined generically, we can only do the job if the -- instance declaration is for a single-parameter type class with -- a type constructor applied to type arguments in the instance decl -- (checkTc, so False provokes the error) - ASSERT( isInstDecl origin ) -- We never get here from a class decl - - checkTc (isJust maybe_tycon) - (badGenericInstance sel_id (notSimple inst_tys)) `thenM_` - checkTc (isJust (tyConGenInfo tycon)) - (badGenericInstance sel_id (notGeneric tycon)) `thenM_` - - ioToTcRn (dumpIfSet opt_PprStyle_Debug "Generic RHS" stuff) `thenM_` - returnM rhs + ASSERT( isInstDecl origin ) -- We never get here from a class decl + do { checkTc (isJust maybe_tycon) + (badGenericInstance sel_id (notSimple inst_tys)) + ; checkTc (tyConHasGenerics tycon) + (badGenericInstance sel_id (notGeneric tycon)) + + ; dflags <- getDOpts + ; ioToTcRn (dumpIfSet_dyn dflags Opt_D_dump_deriv "Filling in method body" + (vcat [ppr clas <+> ppr inst_tys, + nest 2 (ppr sel_id <+> equals <+> ppr rhs)])) + + -- Rename it before returning it + ; (rn_rhs, _) <- rnLExpr rhs + ; returnM rn_rhs } where rhs = mkGenericRhs sel_id clas_tyvar tycon - stuff = vcat [ppr clas <+> ppr inst_tys, - nest 4 (ppr sel_id <+> equals <+> ppr rhs)] - -- The tycon is only used in the generic case, and in that -- case we require that the instance decl is for a single-parameter -- type class with type variable arguments: @@ -614,34 +547,203 @@ mkDefMethRhs origin clas inst_tys sel_id loc GenDefMeth other -> Nothing other -> Nothing -isInstDecl InstanceDeclOrigin = True -isInstDecl ClassDeclOrigin = False +isInstDecl (SigOrigin (InstSkol _)) = True +isInstDecl (SigOrigin (ClsSkol _)) = False \end{code} \begin{code} -- 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 sel_name meth_name (FunMonoBind op_name fix matches loc) - | op_name == sel_name = Just (FunMonoBind meth_name fix matches loc) -find_bind sel_name meth_name (AndMonoBinds b1 b2) - = find_bind sel_name meth_name b1 `seqMaybe` find_bind sel_name meth_name b2 -find_bind sel_name meth_name other = Nothing -- Default case - - -- Find the prags for this method, and replace the - -- selector name with the method name -find_prags sel_name meth_name [] = [] -find_prags sel_name meth_name (SpecSig name ty loc : prags) - | name == sel_name = SpecSig meth_name ty loc : find_prags sel_name meth_name prags -find_prags sel_name meth_name (InlineSig sense name phase loc : prags) - | name == sel_name = InlineSig sense meth_name phase loc : find_prags sel_name meth_name prags -find_prags sel_name meth_name (prag:prags) = find_prags sel_name meth_name prags +find_bind sel_name meth_name binds + = foldlBag seqMaybe Nothing (mapBag f binds) + where + f (L loc1 bind@(FunBind { fun_id = L loc2 op_name })) | op_name == sel_name + = Just (L loc1 (bind { fun_id = L loc2 meth_name })) + f _other = Nothing \end{code} -Contexts and errors -~~~~~~~~~~~~~~~~~~~ +%************************************************************************ +%* * +\subsection{Extracting generic instance declaration from class declarations} +%* * +%************************************************************************ + +@getGenericInstances@ extracts the generic instance declarations from a class +declaration. For exmaple + + class C a where + op :: a -> a + + op{ x+y } (Inl v) = ... + op{ x+y } (Inr v) = ... + op{ x*y } (v :*: w) = ... + op{ 1 } Unit = ... + +gives rise to the instance declarations + + instance C (x+y) where + op (Inl v) = ... + op (Inr v) = ... + + instance C (x*y) where + op (v :*: w) = ... + + instance C 1 where + op Unit = ... + + \begin{code} +getGenericInstances :: [LTyClDecl Name] -> TcM [InstInfo] +getGenericInstances class_decls + = do { gen_inst_infos <- mappM (addLocM get_generics) class_decls + ; let { gen_inst_info = concat gen_inst_infos } + + -- Return right away if there is no generic stuff + ; if null gen_inst_info then returnM [] + else do + + -- Otherwise print it out + { dflags <- getDOpts + ; ioToTcRn (dumpIfSet_dyn dflags Opt_D_dump_deriv "Generic instances" + (vcat (map pprInstInfoDetails gen_inst_info))) + ; returnM gen_inst_info }} + +get_generics decl@(ClassDecl {tcdLName = class_name, tcdMeths = def_methods}) + | null generic_binds + = returnM [] -- The comon case: no generic default methods + + | otherwise -- A source class decl with generic default methods + = recoverM (returnM []) $ + tcAddDeclCtxt decl $ + tcLookupLocatedClass class_name `thenM` \ clas -> + + -- Group by type, and + -- make an InstInfo out of each group + let + groups = groupWith listToBag generic_binds + in + mappM (mkGenericInstance clas) groups `thenM` \ inst_infos -> + + -- Check that there is only one InstInfo for each type constructor + -- The main way this can fail is if you write + -- f {| a+b |} ... = ... + -- f {| x+y |} ... = ... + -- Then at this point we'll have an InstInfo for each + let + tc_inst_infos :: [(TyCon, InstInfo)] + tc_inst_infos = [(simpleInstInfoTyCon i, i) | i <- inst_infos] + + bad_groups = [group | group <- equivClassesByUniq get_uniq tc_inst_infos, + group `lengthExceeds` 1] + get_uniq (tc,_) = getUnique tc + in + mappM (addErrTc . dupGenericInsts) bad_groups `thenM_` + + -- Check that there is an InstInfo for each generic type constructor + let + missing = genericTyConNames `minusList` [tyConName tc | (tc,_) <- tc_inst_infos] + in + checkTc (null missing) (missingGenericInstances missing) `thenM_` + + returnM inst_infos + where + generic_binds :: [(HsType Name, LHsBind Name)] + generic_binds = getGenericBinds def_methods + + +--------------------------------- +getGenericBinds :: LHsBinds Name -> [(HsType Name, LHsBind Name)] + -- Takes a group of method bindings, finds the generic ones, and returns + -- them in finite map indexed by the type parameter in the definition. +getGenericBinds binds = concat (map getGenericBind (bagToList binds)) + +getGenericBind (L loc bind@(FunBind { fun_matches = MatchGroup matches ty })) + = groupWith wrap (mapCatMaybes maybeGenericMatch matches) + where + wrap ms = L loc (bind { fun_matches = MatchGroup ms ty }) +getGenericBind _ + = [] + +groupWith :: ([a] -> b) -> [(HsType Name, a)] -> [(HsType Name, b)] +groupWith op [] = [] +groupWith op ((t,v):prs) = (t, op (v:vs)) : groupWith op rest + where + vs = map snd this + (this,rest) = partition same_t prs + same_t (t',v) = t `eqPatType` t' + +eqPatLType :: LHsType Name -> LHsType Name -> Bool +eqPatLType t1 t2 = unLoc t1 `eqPatType` unLoc t2 + +eqPatType :: HsType Name -> HsType Name -> Bool +-- A very simple equality function, only for +-- type patterns in generic function definitions. +eqPatType (HsTyVar v1) (HsTyVar v2) = v1==v2 +eqPatType (HsAppTy s1 t1) (HsAppTy s2 t2) = s1 `eqPatLType` s2 && t2 `eqPatLType` t2 +eqPatType (HsOpTy s1 op1 t1) (HsOpTy s2 op2 t2) = s1 `eqPatLType` s2 && t2 `eqPatLType` t2 && unLoc op1 == unLoc op2 +eqPatType (HsNumTy n1) (HsNumTy n2) = n1 == n2 +eqPatType (HsParTy t1) t2 = unLoc t1 `eqPatType` t2 +eqPatType t1 (HsParTy t2) = t1 `eqPatType` unLoc t2 +eqPatType _ _ = False + +--------------------------------- +mkGenericInstance :: Class + -> (HsType Name, LHsBinds Name) + -> TcM InstInfo + +mkGenericInstance clas (hs_ty, binds) + -- Make a generic instance declaration + -- For example: instance (C a, C b) => C (a+b) where { binds } + + = -- Extract the universally quantified type variables + -- and wrap them as forall'd tyvars, so that kind inference + -- works in the standard way + let + sig_tvs = map (noLoc.UserTyVar) (nameSetToList (extractHsTyVars (noLoc hs_ty))) + hs_forall_ty = noLoc $ mkExplicitHsForAllTy sig_tvs (noLoc []) (noLoc hs_ty) + in + -- Type-check the instance type, and check its form + tcHsSigType GenPatCtxt hs_forall_ty `thenM` \ forall_inst_ty -> + let + (tyvars, inst_ty) = tcSplitForAllTys forall_inst_ty + in + checkTc (validGenericInstanceType inst_ty) + (badGenericInstanceType binds) `thenM_` + + -- Make the dictionary function. + getSrcSpanM `thenM` \ span -> + getOverlapFlag `thenM` \ overlap_flag -> + newDFunName clas [inst_ty] (srcSpanStart span) `thenM` \ dfun_name -> + let + inst_theta = [mkClassPred clas [mkTyVarTy tv] | tv <- tyvars] + dfun_id = mkDictFunId dfun_name tyvars inst_theta clas [inst_ty] + ispec = mkLocalInstance dfun_id overlap_flag + in + returnM (InstInfo { iSpec = ispec, iBinds = VanillaInst binds [] }) +\end{code} + + +%************************************************************************ +%* * + Error messages +%* * +%************************************************************************ + +\begin{code} +tcAddDeclCtxt decl thing_inside + = addErrCtxt ctxt thing_inside + where + thing = case decl of + ClassDecl {} -> "class" + TySynonym {} -> "type synonym" + TyData {tcdND = NewType} -> "newtype" + TyData {tcdND = DataType} -> "data type" + + ctxt = hsep [ptext SLIT("In the"), text thing, + ptext SLIT("declaration for"), quotes (ppr (tcdName decl))] + defltMethCtxt clas = ptext SLIT("When checking the default methods for class") <+> quotes (ppr clas) @@ -668,6 +770,21 @@ notGeneric tycon = vcat [ptext SLIT("because the instance type constructor") <+> quotes (ppr tycon) <+> ptext SLIT("was not compiled with -fgenerics")] +badGenericInstanceType binds + = vcat [ptext SLIT("Illegal type pattern in the generic bindings"), + nest 4 (ppr binds)] + +missingGenericInstances missing + = ptext SLIT("Missing type patterns for") <+> pprQuotedList missing + +dupGenericInsts tc_inst_infos + = vcat [ptext SLIT("More than one type pattern for a single generic type constructor:"), + nest 4 (vcat (map ppr_inst_ty tc_inst_infos)), + ptext SLIT("All the type patterns for a generic type constructor must be identical") + ] + where + ppr_inst_ty (_,inst) = ppr (simpleInstInfoTy inst) + mixedGenericErr op = ptext SLIT("Can't mix generic and non-generic equations for class method") <+> quotes (ppr op) \end{code}