X-Git-Url: http://git.megacz.com/?p=ghc-hetmet.git;a=blobdiff_plain;f=compiler%2Ftypecheck%2FTcTyClsDecls.lhs;h=a433d697b9d8d5667899e15968f32ae517134833;hp=126113168361bd1ab9de8ec9eebfaf2eef7c59d3;hb=6ea06bbf08517d9805feb82df65cc56ecbaf23a4;hpb=60789c09584c8a12fa27289605221942fb05764d diff --git a/compiler/typecheck/TcTyClsDecls.lhs b/compiler/typecheck/TcTyClsDecls.lhs index 1261131..a433d69 100644 --- a/compiler/typecheck/TcTyClsDecls.lhs +++ b/compiler/typecheck/TcTyClsDecls.lhs @@ -7,7 +7,7 @@ TcTyClsDecls: Typecheck type and class declarations \begin{code} module TcTyClsDecls ( - tcTyAndClassDecls, tcFamInstDecl, mkAuxBinds + tcTyAndClassDecls, tcFamInstDecl, mkRecSelBinds ) where #include "HsVersions.h" @@ -30,7 +30,8 @@ import Class import TyCon import DataCon import Id -import MkId ( rEC_SEL_ERROR_ID ) +import MkId ( mkDefaultMethodId ) +import MkCore ( rEC_SEL_ERROR_ID ) import IdInfo import Var import VarSet @@ -59,176 +60,78 @@ import Data.List %* * %************************************************************************ -Dealing with a group -~~~~~~~~~~~~~~~~~~~~ -Consider a mutually-recursive group, binding -a type constructor T and a class C. - -Step 1: getInitialKind - Construct a KindEnv by binding T and C to a kind variable - -Step 2: kcTyClDecl - In that environment, do a kind check - -Step 3: Zonk the kinds - -Step 4: buildTyConOrClass - Construct an environment binding T to a TyCon and C to a Class. - a) Their kinds comes from zonking the relevant kind variable - b) Their arity (for synonyms) comes direct from the decl - c) The funcional dependencies come from the decl - d) The rest comes a knot-tied binding of T and C, returned from Step 4 - e) The variances of the tycons in the group is calculated from - the knot-tied stuff - -Step 5: tcTyClDecl1 - In this environment, walk over the decls, constructing the TyCons and Classes. - This uses in a strict way items (a)-(c) above, which is why they must - be constructed in Step 4. Feed the results back to Step 4. - For this step, pass the is-recursive flag as the wimp-out flag - to tcTyClDecl1. - - -Step 6: Extend environment - We extend the type environment with bindings not only for the TyCons and Classes, - but also for their "implicit Ids" like data constructors and class selectors - -Step 7: checkValidTyCl - For a recursive group only, check all the decls again, just - to check all the side conditions on validity. We could not - do this before because we were in a mutually recursive knot. - -Identification of recursive TyCons -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -The knot-tying parameters: @rec_details_list@ is an alist mapping @Name@s to -@TyThing@s. - -Identifying a TyCon as recursive serves two purposes - -1. Avoid infinite types. Non-recursive newtypes are treated as -"transparent", like type synonyms, after the type checker. If we did -this for all newtypes, we'd get infinite types. So we figure out for -each newtype whether it is "recursive", and add a coercion if so. In -effect, we are trying to "cut the loops" by identifying a loop-breaker. - -2. Avoid infinite unboxing. This is nothing to do with newtypes. -Suppose we have - data T = MkT Int T - f (MkT x t) = f t -Well, this function diverges, but we don't want the strictness analyser -to diverge. But the strictness analyser will diverge because it looks -deeper and deeper into the structure of T. (I believe there are -examples where the function does something sane, and the strictness -analyser still diverges, but I can't see one now.) - -Now, concerning (1), the FC2 branch currently adds a coercion for ALL -newtypes. I did this as an experiment, to try to expose cases in which -the coercions got in the way of optimisations. If it turns out that we -can indeed always use a coercion, then we don't risk recursive types, -and don't need to figure out what the loop breakers are. - -For newtype *families* though, we will always have a coercion, so they -are always loop breakers! So you can easily adjust the current -algorithm by simply treating all newtype families as loop breakers (and -indeed type families). I think. - \begin{code} -tcTyAndClassDecls :: ModDetails -> [LTyClDecl Name] +tcTyAndClassDecls :: ModDetails + -> [[LTyClDecl Name]] -- Mutually-recursive groups in dependency order -> TcM (TcGblEnv, -- Input env extended by types and classes -- and their implicit Ids,DataCons - HsValBinds Name) -- Renamed bindings for record selectors + HsValBinds Name, -- Renamed bindings for record selectors + [Id]) -- Default method ids -- Fails if there are any errors -tcTyAndClassDecls boot_details allDecls +tcTyAndClassDecls boot_details decls_s = checkNoErrs $ -- The code recovers internally, but if anything gave rise to -- an error we'd better stop now, to avoid a cascade - do { -- Omit instances of type families; they are handled together - -- with the *heads* of class instances - ; let decls = filter (not . isFamInstDecl . unLoc) allDecls + do { let tyclds_s = map (filterOut (isFamInstDecl . unLoc)) decls_s + -- Remove family instance decls altogether + -- They are dealt with by TcInstDcls + + ; tyclss <- fixM $ \ rec_tyclss -> + tcExtendRecEnv (zipRecTyClss tyclds_s rec_tyclss) $ + -- We must populate the environment with the loop-tied + -- T's right away (even before kind checking), because + -- the kind checker may "fault in" some type constructors + -- that recursively mention T + + do { -- Kind-check in dependency order + -- See Note [Kind checking for type and class decls] + kc_decls <- kcTyClDecls tyclds_s + + -- And now build the TyCons/Classes + ; let rec_flags = calcRecFlags boot_details rec_tyclss + ; concatMapM (tcTyClDecl rec_flags) kc_decls } + + ; tcExtendGlobalEnv tyclss $ do + { -- Perform the validity check + -- We can do this now because we are done with the recursive knot + traceTc "ready for validity check" empty + ; mapM_ (addLocM checkValidTyCl) (concat tyclds_s) + ; traceTc "done" empty - -- First check for cyclic type synonysm or classes - -- See notes with checkCycleErrs - ; checkCycleErrs decls - ; mod <- getModule - ; traceTc (text "tcTyAndCl" <+> ppr mod) - ; (syn_tycons, alg_tyclss) <- fixM (\ ~(_rec_syn_tycons, rec_alg_tyclss) -> - do { let { -- Seperate ordinary synonyms from all other type and - -- class declarations and add all associated type - -- declarations from type classes. The latter is - -- required so that the temporary environment for the - -- knot includes all associated family declarations. - ; (syn_decls, alg_decls) = partition (isSynDecl . unLoc) - decls - ; alg_at_decls = concatMap addATs alg_decls - } - -- Extend the global env with the knot-tied results - -- for data types and classes - -- - -- We must populate the environment with the loop-tied - -- T's right away, because the kind checker may "fault - -- in" some type constructors that recursively - -- mention T - ; let gbl_things = mkGlobalThings alg_at_decls rec_alg_tyclss - ; tcExtendRecEnv gbl_things $ do - - -- Kind-check the declarations - { (kc_syn_decls, kc_alg_decls) <- kcTyClDecls syn_decls alg_decls - - ; let { -- Calculate rec-flag - ; calc_rec = calcRecFlags boot_details rec_alg_tyclss - ; tc_decl = addLocM (tcTyClDecl calc_rec) } - - -- Type-check the type synonyms, and extend the envt - ; syn_tycons <- tcSynDecls kc_syn_decls - ; tcExtendGlobalEnv syn_tycons $ do - - -- Type-check the data types and classes - { alg_tyclss <- mapM tc_decl kc_alg_decls - ; return (syn_tycons, concat alg_tyclss) - }}}) - -- Finished with knot-tying now - -- Extend the environment with the finished things - ; tcExtendGlobalEnv (syn_tycons ++ alg_tyclss) $ do - - -- Perform the validity check - { traceTc (text "ready for validity check") - ; mapM_ (addLocM checkValidTyCl) decls - ; traceTc (text "done") - -- Add the implicit things; - -- we want them in the environment because + -- we want them in the environment because -- they may be mentioned in interface files -- NB: All associated types and their implicit things will be added a -- second time here. This doesn't matter as the definitions are -- the same. - ; let { implicit_things = concatMap implicitTyThings alg_tyclss - ; aux_binds = mkAuxBinds alg_tyclss } - ; traceTc ((text "Adding" <+> ppr alg_tyclss) - $$ (text "and" <+> ppr implicit_things)) + ; let { implicit_things = concatMap implicitTyThings tyclss + ; rec_sel_binds = mkRecSelBinds tyclss + ; dm_ids = mkDefaultMethodIds tyclss } + ; env <- tcExtendGlobalEnv implicit_things getGblEnv - ; return (env, aux_binds) } - } + ; return (env, rec_sel_binds, dm_ids) } } + +zipRecTyClss :: [[LTyClDecl Name]] + -> [TyThing] -- Knot-tied + -> [(Name,TyThing)] +-- Build a name-TyThing mapping for the things bound by decls +-- being careful not to look at the [TyThing] +-- The TyThings in the result list must have a visible ATyCon/AClass, +-- because typechecking types (in, say, tcTyClDecl) looks at this outer constructor +zipRecTyClss decls_s rec_things + = [ get decl | decls <- decls_s, L _ decl <- flattenATs decls ] where - -- Pull associated types out of class declarations, to tie them into the - -- knot above. - -- NB: We put them in the same place in the list as `tcTyClDecl' will - -- eventually put the matching `TyThing's. That's crucial; otherwise, - -- the two argument lists of `mkGlobalThings' don't match up. - addATs decl@(L _ (ClassDecl {tcdATs = ats})) = decl : ats - addATs decl = [decl] - -mkGlobalThings :: [LTyClDecl Name] -- The decls - -> [TyThing] -- Knot-tied, in 1-1 correspondence with the decls - -> [(Name,TyThing)] --- Driven by the Decls, and treating the TyThings lazily --- make a TypeEnv for the new things -mkGlobalThings decls things - = map mk_thing (decls `zipLazy` things) - where - mk_thing (L _ (ClassDecl {tcdLName = L _ name}), ~(AClass cl)) - = (name, AClass cl) - mk_thing (L _ decl, ~(ATyCon tc)) - = (tcdName decl, ATyCon tc) + rec_type_env :: TypeEnv + rec_type_env = mkTypeEnv rec_things + + get :: TyClDecl Name -> (Name, TyThing) + get (ClassDecl {tcdLName = L _ name}) = (name, AClass cl) + where + Just (AClass cl) = lookupTypeEnv rec_type_env name + get decl = (name, ATyCon tc) + where + name = tcdName decl + Just (ATyCon tc) = lookupTypeEnv rec_type_env name \end{code} @@ -244,14 +147,14 @@ lot of kinding and type checking code with ordinary algebraic data types (and GADTs). \begin{code} -tcFamInstDecl :: LTyClDecl Name -> TcM TyThing -tcFamInstDecl (L loc decl) +tcFamInstDecl :: TopLevelFlag -> LTyClDecl Name -> TcM TyThing +tcFamInstDecl top_lvl (L loc decl) = -- Prime error recovery, set source location setSrcSpan loc $ tcAddDeclCtxt decl $ do { -- type family instances require -XTypeFamilies -- and can't (currently) be in an hs-boot file - ; type_families <- doptM Opt_TypeFamilies + ; type_families <- xoptM Opt_TypeFamilies ; is_boot <- tcIsHsBoot -- Are we compiling an hs-boot file? ; checkTc type_families $ badFamInstDecl (tcdLName decl) ; checkTc (not is_boot) $ badBootFamInstDeclErr @@ -260,15 +163,33 @@ tcFamInstDecl (L loc decl) ; tc <- tcFamInstDecl1 decl ; checkValidTyCon tc -- Remember to check validity; -- no recursion to worry about here + + -- Check that toplevel type instances are not for associated types. + ; when (isTopLevel top_lvl && isAssocFamily tc) + (addErr $ assocInClassErr (tcdName decl)) + ; return (ATyCon tc) } +isAssocFamily :: TyCon -> Bool -- Is an assocaited type +isAssocFamily tycon + = case tyConFamInst_maybe tycon of + Nothing -> panic "isAssocFamily: no family?!?" + Just (fam, _) -> isTyConAssoc fam + +assocInClassErr :: Name -> SDoc +assocInClassErr name + = ptext (sLit "Associated type") <+> quotes (ppr name) <+> + ptext (sLit "must be inside a class instance") + + + tcFamInstDecl1 :: TyClDecl Name -> TcM TyCon -- "type instance" tcFamInstDecl1 (decl@TySynonym {tcdLName = L loc tc_name}) = kcIdxTyPats decl $ \k_tvs k_typats resKind family -> do { -- check that the family declaration is for a synonym - checkTc (isOpenTyCon family) (notFamily family) + checkTc (isFamilyTyCon family) (notFamily family) ; checkTc (isSynTyCon family) (wrongKindOfFamily family) ; -- (1) kind check the right-hand side of the type equation @@ -292,7 +213,8 @@ tcFamInstDecl1 (decl@TySynonym {tcdLName = L loc tc_name}) -- (4) construct representation tycon ; rep_tc_name <- newFamInstTyConName tc_name t_typats loc ; buildSynTyCon rep_tc_name t_tvs (SynonymTyCon t_rhs) - (typeKind t_rhs) (Just (family, t_typats)) + (typeKind t_rhs) + NoParentTyCon (Just (family, t_typats)) }} -- "newtype instance" and "data instance" @@ -300,7 +222,7 @@ tcFamInstDecl1 (decl@TyData {tcdND = new_or_data, tcdLName = L loc tc_name, tcdCons = cons}) = kcIdxTyPats decl $ \k_tvs k_typats resKind fam_tycon -> do { -- check that the family declaration is for the right kind - checkTc (isOpenTyCon fam_tycon) (notFamily fam_tycon) + checkTc (isFamilyTyCon fam_tycon) (notFamily fam_tycon) ; checkTc (isAlgTyCon fam_tycon) (wrongKindOfFamily fam_tycon) ; -- (1) kind check the data declaration as usual @@ -326,7 +248,7 @@ tcFamInstDecl1 (decl@TyData {tcdND = new_or_data, tcdLName = L loc tc_name, ; mapM_ checkTyFamFreeness t_typats -- Check that we don't use GADT syntax in H98 world - ; gadt_ok <- doptM Opt_GADTs + ; gadt_ok <- xoptM Opt_GADTs ; checkTc (gadt_ok || consUseH98Syntax cons) (badGadtDecl tc_name) -- (b) a newtype has exactly one constructor @@ -346,7 +268,7 @@ tcFamInstDecl1 (decl@TyData {tcdND = new_or_data, tcdLName = L loc tc_name, NewType -> ASSERT( not (null data_cons) ) mkNewTyConRhs rep_tc_name rep_tycon (head data_cons) ; buildAlgTyCon rep_tc_name t_tvs stupid_theta tc_rhs Recursive - False h98_syntax (Just (fam_tycon, t_typats)) + False h98_syntax NoParentTyCon (Just (fam_tycon, t_typats)) -- We always assume that indexed types are recursive. Why? -- (1) Due to their open nature, we can never be sure that a -- further instance might not introduce a new recursive @@ -401,6 +323,25 @@ kcIdxTyPats decl thing_inside %* * %************************************************************************ +Note [Kind checking for type and class decls] +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Kind checking is done thus: + + 1. Make up a kind variable for each parameter of the *data* type, + and class, decls, and extend the kind environment (which is in + the TcLclEnv) + + 2. Dependency-analyse the type *synonyms* (which must be non-recursive), + and kind-check them in dependency order. Extend the kind envt. + + 3. Kind check the data type and class decls + +Synonyms are treated differently to data type and classes, +because a type synonym can be an unboxed type + type Foo = Int# +and a kind variable can't unify with UnboxedTypeKind +So we infer their kinds in dependency order + We need to kind check all types in the mutually recursive group before we know the kind of the type variables. For example: @@ -435,48 +376,52 @@ instances of families altogether in the following. However, we need to include the kinds of associated families into the construction of the initial kind environment. (This is handled by `allDecls'). + \begin{code} -kcTyClDecls :: [LTyClDecl Name] -> [Located (TyClDecl Name)] - -> TcM ([LTyClDecl Name], [Located (TyClDecl Name)]) -kcTyClDecls syn_decls alg_decls - = do { -- First extend the kind env with each data type, class, and - -- indexed type, mapping them to a type variable - let initialKindDecls = concat [allDecls decl | L _ decl <- alg_decls] - ; alg_kinds <- mapM getInitialKind initialKindDecls - ; tcExtendKindEnv alg_kinds $ do - - -- Now kind-check the type synonyms, in dependency order - -- We do these differently to data type and classes, - -- because a type synonym can be an unboxed type - -- type Foo = Int# - -- and a kind variable can't unify with UnboxedTypeKind - -- So we infer their kinds in dependency order - { (kc_syn_decls, syn_kinds) <- kcSynDecls (calcSynCycles syn_decls) - ; tcExtendKindEnv syn_kinds $ do - - -- Now kind-check the data type, class, and kind signatures, - -- returning kind-annotated decls; we don't kind-check - -- instances of indexed types yet, but leave this to - -- `tcInstDecls1' - { kc_alg_decls <- mapM (wrapLocM kcTyClDecl) - (filter (not . isFamInstDecl . unLoc) alg_decls) - - ; return (kc_syn_decls, kc_alg_decls) }}} +kcTyClDecls :: [[LTyClDecl Name]] -> TcM [LTyClDecl Name] +kcTyClDecls [] = return [] +kcTyClDecls (decls : decls_s) = do { (tcl_env, kc_decls1) <- kcTyClDecls1 decls + ; kc_decls2 <- setLclEnv tcl_env (kcTyClDecls decls_s) + ; return (kc_decls1 ++ kc_decls2) } + +kcTyClDecls1 :: [LTyClDecl Name] -> TcM (TcLclEnv, [LTyClDecl Name]) +kcTyClDecls1 decls + = do { -- Omit instances of type families; they are handled together + -- with the *heads* of class instances + ; let (syn_decls, alg_decls) = partition (isSynDecl . unLoc) decls + alg_at_decls = flattenATs alg_decls + + ; mod <- getModule + ; traceTc "tcTyAndCl" (ptext (sLit "module") <+> ppr mod $$ vcat (map ppr decls)) + + -- First check for cyclic classes + ; checkClassCycleErrs alg_decls + + -- Kind checking; see Note [Kind checking for type and class decls] + ; alg_kinds <- mapM getInitialKind alg_at_decls + ; tcExtendKindEnv alg_kinds $ do + + { (kc_syn_decls, tcl_env) <- kcSynDecls (calcSynCycles syn_decls) + ; setLclEnv tcl_env $ do + { kc_alg_decls <- mapM (wrapLocM kcTyClDecl) alg_decls + + -- Kind checking done for this group, so zonk the kind variables + -- See Note [Kind checking for type and class decls] + ; mapM_ (zonkTcKindToKind . snd) alg_kinds + + ; return (tcl_env, kc_syn_decls ++ kc_alg_decls) } } } + +flattenATs :: [LTyClDecl Name] -> [LTyClDecl Name] +flattenATs decls = concatMap flatten decls where - -- get all declarations relevant for determining the initial kind - -- environment - allDecls (decl@ClassDecl {tcdATs = ats}) = decl : [ at - | L _ at <- ats - , isFamilyDecl at] - allDecls decl | isFamInstDecl decl = [] - | otherwise = [decl] + flatten decl@(L _ (ClassDecl {tcdATs = ats})) = decl : ats + flatten decl = [decl] ------------------------------------------------------------------------- -getInitialKind :: TyClDecl Name -> TcM (Name, TcKind) +getInitialKind :: LTyClDecl Name -> TcM (Name, TcKind) -- Only for data type, class, and indexed type declarations -- Get as much info as possible from the data, class, or indexed type decl, -- so as to maximise usefulness of error messages -getInitialKind decl +getInitialKind (L _ decl) = do { arg_kinds <- mapM (mk_arg_kind . unLoc) (tyClDeclTyVars decl) ; res_kind <- mk_res_kind decl ; return (tcdName decl, mkArrowKinds arg_kinds res_kind) } @@ -494,13 +439,13 @@ getInitialKind decl ---------------- kcSynDecls :: [SCC (LTyClDecl Name)] -> TcM ([LTyClDecl Name], -- Kind-annotated decls - [(Name,TcKind)]) -- Kind bindings + TcLclEnv) -- Kind bindings kcSynDecls [] - = return ([], []) + = do { tcl_env <- getLclEnv; return ([], tcl_env) } kcSynDecls (group : groups) - = do { (decl, nk) <- kcSynDecl group - ; (decls, nks) <- tcExtendKindEnv [nk] (kcSynDecls groups) - ; return (decl:decls, nk:nks) } + = do { (decl, nk) <- kcSynDecl group + ; (decls, tcl_env) <- tcExtendKindEnv [nk] (kcSynDecls groups) + ; return (decl:decls, tcl_env) } ---------------- kcSynDecl :: SCC (LTyClDecl Name) @@ -509,10 +454,10 @@ kcSynDecl :: SCC (LTyClDecl Name) kcSynDecl (AcyclicSCC (L loc decl)) = tcAddDeclCtxt decl $ kcHsTyVars (tcdTyVars decl) (\ k_tvs -> - do { traceTc (text "kcd1" <+> ppr (unLoc (tcdLName decl)) <+> brackets (ppr (tcdTyVars decl)) + do { traceTc "kcd1" (ppr (unLoc (tcdLName decl)) <+> brackets (ppr (tcdTyVars decl)) <+> brackets (ppr k_tvs)) ; (k_rhs, rhs_kind) <- kcLHsType (tcdSynRhs decl) - ; traceTc (text "kcd2" <+> ppr (unLoc (tcdLName decl))) + ; traceTc "kcd2" (ppr (unLoc (tcdLName decl))) ; let tc_kind = foldr (mkArrowKind . hsTyVarKind . unLoc) rhs_kind k_tvs ; return (L loc (decl { tcdTyVars = k_tvs, tcdSynRhs = k_rhs }), (unLoc (tcdLName decl), tc_kind)) }) @@ -651,88 +596,82 @@ kcFamilyDecl _ d = pprPanic "kcFamilyDecl" (ppr d) %************************************************************************ \begin{code} -tcSynDecls :: [LTyClDecl Name] -> TcM [TyThing] -tcSynDecls [] = return [] -tcSynDecls (decl : decls) - = do { syn_tc <- addLocM tcSynDecl decl - ; syn_tcs <- tcExtendGlobalEnv [syn_tc] (tcSynDecls decls) - ; return (syn_tc : syn_tcs) } - - -- "type" -tcSynDecl :: TyClDecl Name -> TcM TyThing -tcSynDecl - (TySynonym {tcdLName = L _ tc_name, tcdTyVars = tvs, tcdSynRhs = rhs_ty}) - = tcTyVarBndrs tvs $ \ tvs' -> do - { traceTc (text "tcd1" <+> ppr tc_name) - ; rhs_ty' <- tcHsKindedType rhs_ty - ; tycon <- buildSynTyCon tc_name tvs' (SynonymTyCon rhs_ty') - (typeKind rhs_ty') Nothing - ; return (ATyCon tycon) - } -tcSynDecl d = pprPanic "tcSynDecl" (ppr d) - --------------------- -tcTyClDecl :: (Name -> RecFlag) -> TyClDecl Name -> TcM [TyThing] +tcTyClDecl :: (Name -> RecFlag) -> LTyClDecl Name -> TcM [TyThing] -tcTyClDecl calc_isrec decl - = tcAddDeclCtxt decl (tcTyClDecl1 calc_isrec decl) +tcTyClDecl calc_isrec (L loc decl) + = setSrcSpan loc $ tcAddDeclCtxt decl $ + tcTyClDecl1 NoParentTyCon calc_isrec decl -- "type family" declarations -tcTyClDecl1 :: (Name -> RecFlag) -> TyClDecl Name -> TcM [TyThing] -tcTyClDecl1 _calc_isrec +tcTyClDecl1 :: TyConParent -> (Name -> RecFlag) -> TyClDecl Name -> TcM [TyThing] +tcTyClDecl1 parent _calc_isrec (TyFamily {tcdFlavour = TypeFamily, tcdLName = L _ tc_name, tcdTyVars = tvs, tcdKind = Just kind}) -- NB: kind at latest added during kind checking = tcTyVarBndrs tvs $ \ tvs' -> do - { traceTc (text "type family: " <+> ppr tc_name) + { traceTc "type family:" (ppr tc_name) -- Check that we don't use families without -XTypeFamilies - ; idx_tys <- doptM Opt_TypeFamilies + ; idx_tys <- xoptM Opt_TypeFamilies ; checkTc idx_tys $ badFamInstDecl tc_name - ; tycon <- buildSynTyCon tc_name tvs' (OpenSynTyCon kind Nothing) kind Nothing + ; tycon <- buildSynTyCon tc_name tvs' SynFamilyTyCon kind parent Nothing ; return [ATyCon tycon] } -- "data family" declaration -tcTyClDecl1 _calc_isrec +tcTyClDecl1 parent _calc_isrec (TyFamily {tcdFlavour = DataFamily, tcdLName = L _ tc_name, tcdTyVars = tvs, tcdKind = mb_kind}) = tcTyVarBndrs tvs $ \ tvs' -> do - { traceTc (text "data family: " <+> ppr tc_name) + { traceTc "data family:" (ppr tc_name) ; extra_tvs <- tcDataKindSig mb_kind ; let final_tvs = tvs' ++ extra_tvs -- we may not need these -- Check that we don't use families without -XTypeFamilies - ; idx_tys <- doptM Opt_TypeFamilies + ; idx_tys <- xoptM Opt_TypeFamilies ; checkTc idx_tys $ badFamInstDecl tc_name ; tycon <- buildAlgTyCon tc_name final_tvs [] - mkOpenDataTyConRhs Recursive False True Nothing + DataFamilyTyCon Recursive False True + parent Nothing ; return [ATyCon tycon] } + -- "type" +tcTyClDecl1 _parent _calc_isrec + (TySynonym {tcdLName = L _ tc_name, tcdTyVars = tvs, tcdSynRhs = rhs_ty}) + = ASSERT( isNoParent _parent ) + tcTyVarBndrs tvs $ \ tvs' -> do + { traceTc "tcd1" (ppr tc_name) + ; rhs_ty' <- tcHsKindedType rhs_ty + ; tycon <- buildSynTyCon tc_name tvs' (SynonymTyCon rhs_ty') + (typeKind rhs_ty') NoParentTyCon Nothing + ; return [ATyCon tycon] } + -- "newtype" and "data" -- NB: not used for newtype/data instances (whether associated or not) -tcTyClDecl1 calc_isrec +tcTyClDecl1 _parent calc_isrec (TyData {tcdND = new_or_data, tcdCtxt = ctxt, tcdTyVars = tvs, tcdLName = L _ tc_name, tcdKindSig = mb_ksig, tcdCons = cons}) - = tcTyVarBndrs tvs $ \ tvs' -> do + = ASSERT( isNoParent _parent ) + tcTyVarBndrs tvs $ \ tvs' -> do { extra_tvs <- tcDataKindSig mb_ksig ; let final_tvs = tvs' ++ extra_tvs ; stupid_theta <- tcHsKindedContext ctxt - ; want_generic <- doptM Opt_Generics + ; want_generic <- xoptM Opt_Generics ; unbox_strict <- doptM Opt_UnboxStrictFields - ; empty_data_decls <- doptM Opt_EmptyDataDecls - ; kind_signatures <- doptM Opt_KindSignatures - ; existential_ok <- doptM Opt_ExistentialQuantification - ; gadt_ok <- doptM Opt_GADTs + ; empty_data_decls <- xoptM Opt_EmptyDataDecls + ; kind_signatures <- xoptM Opt_KindSignatures + ; existential_ok <- xoptM Opt_ExistentialQuantification + ; gadt_ok <- xoptM Opt_GADTs + ; gadtSyntax_ok <- xoptM Opt_GADTSyntax ; is_boot <- tcIsHsBoot -- Are we compiling an hs-boot file? ; let ex_ok = existential_ok || gadt_ok -- Data cons can have existential context -- Check that we don't use GADT syntax in H98 world - ; checkTc (gadt_ok || h98_syntax) (badGadtDecl tc_name) + ; checkTc (gadtSyntax_ok || h98_syntax) (badGadtDecl tc_name) -- Check that we don't use kind signatures without Glasgow extensions ; checkTc (kind_signatures || isNothing mb_ksig) (badSigTyDecl tc_name) @@ -763,7 +702,8 @@ tcTyClDecl1 calc_isrec NewType -> ASSERT( not (null data_cons) ) mkNewTyConRhs tc_name tycon (head data_cons) ; buildAlgTyCon tc_name final_tvs stupid_theta tc_rhs is_rec - (want_generic && canDoGenerics data_cons) h98_syntax Nothing + (want_generic && canDoGenerics data_cons) (not h98_syntax) + NoParentTyCon Nothing }) ; return [ATyCon tycon] } @@ -771,29 +711,28 @@ tcTyClDecl1 calc_isrec is_rec = calc_isrec tc_name h98_syntax = consUseH98Syntax cons -tcTyClDecl1 calc_isrec +tcTyClDecl1 _parent calc_isrec (ClassDecl {tcdLName = L _ class_name, tcdTyVars = tvs, tcdCtxt = ctxt, tcdMeths = meths, tcdFDs = fundeps, tcdSigs = sigs, tcdATs = ats} ) - = tcTyVarBndrs tvs $ \ tvs' -> do + = ASSERT( isNoParent _parent ) + tcTyVarBndrs tvs $ \ tvs' -> do { ctxt' <- tcHsKindedContext ctxt ; fds' <- mapM (addLocM tc_fundep) fundeps - ; atss <- mapM (addLocM (tcTyClDecl1 (const Recursive))) ats - -- NB: 'ats' only contains "type family" and "data family" - -- declarations as well as type family defaults - ; let ats' = map (setAssocFamilyPermutation tvs') (concat atss) ; sig_stuff <- tcClassSigs class_name sigs meths - ; clas <- fixM (\ clas -> - let -- This little knot is just so we can get + ; clas <- fixM $ \ clas -> do + { let -- This little knot is just so we can get -- hold of the name of the class TyCon, which we -- need to look up its recursiveness tycon_name = tyConName (classTyCon clas) tc_isrec = calc_isrec tycon_name - in - buildClass False {- Must include unfoldings for selectors -} - class_name tvs' ctxt' fds' ats' - sig_stuff tc_isrec) - ; return (AClass clas : ats') + ; atss' <- mapM (addLocM $ tcTyClDecl1 (AssocFamilyTyCon clas) (const Recursive)) ats + -- NB: 'ats' only contains "type family" and "data family" + -- declarations as well as type family defaults + ; buildClass False {- Must include unfoldings for selectors -} + class_name tvs' ctxt' fds' (concat atss') + sig_stuff tc_isrec } + ; return (AClass clas : map ATyCon (classATs clas)) -- NB: Order is important due to the call to `mkGlobalThings' when -- tying the the type and class declaration type checking knot. } @@ -802,11 +741,11 @@ tcTyClDecl1 calc_isrec ; tvs2' <- mapM tcLookupTyVar tvs2 ; ; return (tvs1', tvs2') } -tcTyClDecl1 _ +tcTyClDecl1 _ _ (ForeignType {tcdLName = L _ tc_name, tcdExtName = tc_ext_name}) = return [ATyCon (mkForeignTyCon tc_name tc_ext_name liftedTypeKind 0)] -tcTyClDecl1 _ d = pprPanic "tcTyClDecl1" (ppr d) +tcTyClDecl1 _ _ d = pprPanic "tcTyClDecl1" (ppr d) ----------------------------------- tcConDecls :: Bool -> Bool -> TyCon -> ([TyVar], Type) @@ -822,12 +761,12 @@ tcConDecl :: Bool -- True <=> -funbox-strict_fields -> TcM DataCon tcConDecl unbox_strict existential_ok rep_tycon res_tmpl -- Data types - (ConDecl {con_name =name, con_qvars = tvs, con_cxt = ctxt + con@(ConDecl {con_name = name, con_qvars = tvs, con_cxt = ctxt , con_details = details, con_res = res_ty }) = addErrCtxt (dataConCtxt name) $ tcTyVarBndrs tvs $ \ tvs' -> do { ctxt' <- tcHsKindedContext ctxt - ; checkTc (existential_ok || (null tvs && null (unLoc ctxt))) + ; checkTc (existential_ok || conRepresentibleWithH98Syntax con) (badExistential name) ; (univ_tvs, ex_tvs, eq_preds, res_ty') <- tcResultType res_tmpl tvs' res_ty ; let @@ -922,14 +861,29 @@ consUseH98Syntax (L _ (ConDecl { con_res = ResTyGADT _ }) : _) = False consUseH98Syntax _ = True -- All constructors have same shape +conRepresentibleWithH98Syntax :: ConDecl Name -> Bool +conRepresentibleWithH98Syntax + (ConDecl {con_qvars = tvs, con_cxt = ctxt, con_res = ResTyH98 }) + = null tvs && null (unLoc ctxt) +conRepresentibleWithH98Syntax + (ConDecl {con_qvars = tvs, con_cxt = ctxt, con_res = ResTyGADT (L _ t) }) + = null (unLoc ctxt) && f t (map (hsTyVarName . unLoc) tvs) + where -- Each type variable should be used exactly once in the + -- result type, and the result type must just be the type + -- constructor applied to type variables + f (HsAppTy (L _ t1) (L _ (HsTyVar v2))) vs + = (v2 `elem` vs) && f t1 (delete v2 vs) + f (HsTyVar _) [] = True + f _ _ = False + ------------------- tcConArg :: Bool -- True <=> -funbox-strict_fields -> LHsType Name - -> TcM (TcType, StrictnessMark) + -> TcM (TcType, HsBang) tcConArg unbox_strict bty = do { arg_ty <- tcHsBangType bty ; let bang = getBangStrictness bty - ; strict_mark <- chooseBoxingStrategy unbox_strict arg_ty bang + ; let strict_mark = chooseBoxingStrategy unbox_strict arg_ty bang ; return (arg_ty, strict_mark) } -- We attempt to unbox/unpack a strict field when either: @@ -938,31 +892,47 @@ tcConArg unbox_strict bty -- -- We have turned off unboxing of newtypes because coercions make unboxing -- and reboxing more complicated -chooseBoxingStrategy :: Bool -> TcType -> HsBang -> TcM StrictnessMark +chooseBoxingStrategy :: Bool -> TcType -> HsBang -> HsBang chooseBoxingStrategy unbox_strict_fields arg_ty bang = case bang of - HsNoBang -> return NotMarkedStrict - HsUnbox | can_unbox arg_ty -> return MarkedUnboxed - | otherwise -> do { addWarnTc cant_unbox_msg - ; return MarkedStrict } - HsStrict | unbox_strict_fields - , can_unbox arg_ty -> return MarkedUnboxed - _ -> return MarkedStrict + HsNoBang -> HsNoBang + HsUnpack -> can_unbox HsUnpackFailed arg_ty + HsStrict | unbox_strict_fields -> can_unbox HsStrict arg_ty + | otherwise -> HsStrict + HsUnpackFailed -> pprPanic "chooseBoxingStrategy" (ppr arg_ty) + -- Source code never has shtes where - -- we can unbox if the type is a chain of newtypes with a product tycon - -- at the end - can_unbox arg_ty = case splitTyConApp_maybe arg_ty of - Nothing -> False - Just (arg_tycon, tycon_args) -> - not (isRecursiveTyCon arg_tycon) && -- Note [Recusive unboxing] - isProductTyCon arg_tycon && - (if isNewTyCon arg_tycon then - can_unbox (newTyConInstRhs arg_tycon tycon_args) - else True) - - cant_unbox_msg = ptext (sLit "Ignoring unusable UNPACK pragma") + can_unbox :: HsBang -> TcType -> HsBang + -- Returns HsUnpack if we can unpack arg_ty + -- fail_bang if we know what arg_ty is but we can't unpack it + -- HsStrict if it's abstract, so we don't know whether or not we can unbox it + can_unbox fail_bang arg_ty + = case splitTyConApp_maybe arg_ty of + Nothing -> fail_bang + + Just (arg_tycon, tycon_args) + | isAbstractTyCon arg_tycon -> HsStrict + -- See Note [Don't complain about UNPACK on abstract TyCons] + | not (isRecursiveTyCon arg_tycon) -- Note [Recusive unboxing] + , isProductTyCon arg_tycon + -- We can unbox if the type is a chain of newtypes + -- with a product tycon at the end + -> if isNewTyCon arg_tycon + then can_unbox fail_bang (newTyConInstRhs arg_tycon tycon_args) + else HsUnpack + + | otherwise -> fail_bang \end{code} +Note [Don't complain about UNPACK on abstract TyCons] +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +We are going to complain about UnpackFailed, but if we say + data T = MkT {-# UNPACK #-} !Wobble +and Wobble is a newtype imported from a module that was compiled +without optimisation, we don't want to complain. Because it might +be fine when optimsation is on. I think this happens when Haddock +is working over (say) GHC souce files. + Note [Recursive unboxing] ~~~~~~~~~~~~~~~~~~~~~~~~~ Be careful not to try to unbox this! @@ -982,8 +952,8 @@ Validity checking is done once the mutually-recursive knot has been tied, so we can look at things freely. \begin{code} -checkCycleErrs :: [LTyClDecl Name] -> TcM () -checkCycleErrs tyclss +checkClassCycleErrs :: [LTyClDecl Name] -> TcM () +checkClassCycleErrs tyclss | null cls_cycles = return () | otherwise @@ -999,12 +969,13 @@ checkValidTyCl :: TyClDecl Name -> TcM () checkValidTyCl decl = tcAddDeclCtxt decl $ do { thing <- tcLookupLocatedGlobal (tcdLName decl) - ; traceTc (text "Validity of" <+> ppr thing) + ; traceTc "Validity of" (ppr thing) ; case thing of ATyCon tc -> checkValidTyCon tc - AClass cl -> checkValidClass cl - _ -> panic "checkValidTyCl" - ; traceTc (text "Done validity of" <+> ppr thing) + AClass cl -> do { checkValidClass cl + ; mapM_ (addLocM checkValidTyCl) (tcdATs decl) } + _ -> panic "checkValidTyCl" + ; traceTc "Done validity of" (ppr thing) } ------------------------- @@ -1026,8 +997,8 @@ checkValidTyCon :: TyCon -> TcM () checkValidTyCon tc | isSynTyCon tc = case synTyConRhs tc of - OpenSynTyCon _ _ -> return () - SynonymTyCon ty -> checkValidType syn_ctxt ty + SynFamilyTyCon {} -> return () + SynonymTyCon ty -> checkValidType syn_ctxt ty | otherwise = do -- Check the context on the data decl checkValidTheta (DataTyCtxt name) (tyConStupidTheta tc) @@ -1097,7 +1068,7 @@ checkValidDataCon :: TyCon -> DataCon -> TcM () checkValidDataCon tc con = setSrcSpan (srcLocSpan (getSrcLoc con)) $ addErrCtxt (dataConCtxt con) $ - do { traceTc (ptext (sLit "Validity of data con") <+> ppr con) + do { traceTc "Validity of data con" (ppr con) ; let tc_tvs = tyConTyVars tc res_ty_tmpl = mkFamilyTyConApp tc (mkTyVarTys tc_tvs) actual_res_ty = dataConOrigResTy con @@ -1110,9 +1081,15 @@ checkValidDataCon tc con -- Reason: it's really the argument of an equality constraint ; checkValidType ctxt (dataConUserType con) ; when (isNewTyCon tc) (checkNewDataCon con) + ; mapM_ check_bang (dataConStrictMarks con `zip` [1..]) } where ctxt = ConArgCtxt (dataConName con) + check_bang (HsUnpackFailed, n) = addWarnTc (cant_unbox_msg n) + check_bang _ = return () + + cant_unbox_msg n = sep [ ptext (sLit "Ignoring unusable UNPACK pragma on the") + , speakNth n <+> ptext (sLit "argument of") <+> quotes (ppr con)] ------------------------------- checkNewDataCon :: DataCon -> TcM () @@ -1124,7 +1101,7 @@ checkNewDataCon con -- Return type is (T a b c) ; checkTc (null ex_tvs && null eq_theta && null dict_theta) (newtypeExError con) -- No existentials - ; checkTc (not (any isMarkedStrict (dataConStrictMarks con))) + ; checkTc (not (any isBanged (dataConStrictMarks con))) (newtypeStrictError con) -- No strictness } @@ -1134,9 +1111,9 @@ checkNewDataCon con ------------------------------- checkValidClass :: Class -> TcM () checkValidClass cls - = do { constrained_class_methods <- doptM Opt_ConstrainedClassMethods - ; multi_param_type_classes <- doptM Opt_MultiParamTypeClasses - ; fundep_classes <- doptM Opt_FunctionalDependencies + = do { constrained_class_methods <- xoptM Opt_ConstrainedClassMethods + ; multi_param_type_classes <- xoptM Opt_MultiParamTypeClasses + ; fundep_classes <- xoptM Opt_FunctionalDependencies -- Check that the class is unary, unless GlaExs ; checkTc (notNull tyvars) (nullaryClassErr cls) @@ -1165,7 +1142,7 @@ checkValidClass cls -- The 'tail' removes the initial (C a) from the -- class itself, leaving just the method type - ; traceTc (text "class op type" <+> ppr op_ty <+> ppr tau) + ; traceTc "class op type" (ppr op_ty <+> ppr tau) ; checkValidType (FunSigCtxt op_name) tau -- Check that the type mentions at least one of @@ -1206,11 +1183,36 @@ checkValidClass cls %************************************************************************ \begin{code} -mkAuxBinds :: [TyThing] -> HsValBinds Name +mkDefaultMethodIds :: [TyThing] -> [Id] +-- See Note [Default method Ids and Template Haskell] +mkDefaultMethodIds things + = [ mkDefaultMethodId sel_id dm_name + | AClass cls <- things + , (sel_id, DefMeth dm_name) <- classOpItems cls ] +\end{code} + +Note [Default method Ids and Template Haskell] +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Consider this (Trac #4169): + class Numeric a where + fromIntegerNum :: a + fromIntegerNum = ... + + ast :: Q [Dec] + ast = [d| instance Numeric Int |] + +When we typecheck 'ast' we have done the first pass over the class decl +(in tcTyClDecls), but we have not yet typechecked the default-method +declarations (becuase they can mention value declarations). So we +must bring the default method Ids into scope first (so they can be seen +when typechecking the [d| .. |] quote, and typecheck them later. + +\begin{code} +mkRecSelBinds :: [TyThing] -> HsValBinds Name -- NB We produce *un-typechecked* bindings, rather like 'deriving' -- This makes life easier, because the later type checking will add -- all necessary type abstractions and applications -mkAuxBinds ty_things +mkRecSelBinds ty_things = ValBindsOut [(NonRecursive, b) | b <- binds] sigs where (sigs, binds) = unzip rec_sels @@ -1425,7 +1427,7 @@ genericMultiParamErr clas badGenericMethodType :: Name -> Kind -> SDoc badGenericMethodType op op_ty = hang (ptext (sLit "Generic method type is too complex")) - 4 (vcat [ppr op <+> dcolon <+> ppr op_ty, + 2 (vcat [ppr op <+> dcolon <+> ppr op_ty, ptext (sLit "You can only use type variables, arrows, lists, and tuples")]) recSynErr :: [LTyClDecl Name] -> TcRn () @@ -1465,7 +1467,7 @@ badGadtDecl tc_name badExistential :: Located Name -> SDoc badExistential con_name = hang (ptext (sLit "Data constructor") <+> quotes (ppr con_name) <+> - ptext (sLit "has existential type variables, or a context")) + ptext (sLit "has existential type variables, a context, or a specialised result type")) 2 (parens $ ptext (sLit "Use -XExistentialQuantification or -XGADTs to allow this")) badStupidTheta :: Name -> SDoc