\begin{code}
module TcTyClsDecls (
- tcTyAndClassDecls, tcIdxTyInstDecl
+ tcTyAndClassDecls, tcFamInstDecl
) where
#include "HsVersions.h"
import TcHsType
import TcMType
import TcType
+import FunDeps
import Type
import Generics
import Class
import DynFlags
import Data.List ( partition, elemIndex )
+import Control.Monad ( mplus )
\end{code}
-> TcM TcGblEnv -- Input env extended by types and classes
-- and their implicit Ids,DataCons
tcTyAndClassDecls boot_details allDecls
- = do { -- Omit instances of indexed types; they are handled together
+ = do { -- Omit instances of type families; they are handled together
-- with the *heads* of class instances
- ; let decls = filter (not . isIdxTyDecl . unLoc) allDecls
+ ; let decls = filter (not . isFamInstDecl . unLoc) allDecls
-- First check for cyclic type synonysm or classes
-- See notes with checkCycleErrs
%************************************************************************
%* *
-\subsection{Type checking instances of indexed types}
+\subsection{Type checking family instances}
%* *
%************************************************************************
-Instances of indexed types are somewhat of a hybrid. They are processed
-together with class instance heads, but can contain data constructors and hence
-they share a lot of kinding and type checking code with ordinary algebraic
-data types (and GADTs).
+Family instances are somewhat of a hybrid. They are processed together with
+class instance heads, but can contain data constructors and hence they share a
+lot of kinding and type checking code with ordinary algebraic data types (and
+GADTs).
\begin{code}
-tcIdxTyInstDecl :: LTyClDecl Name -> TcM (Maybe TyThing) -- Nothing if error
-tcIdxTyInstDecl (L loc decl)
+tcFamInstDecl :: LTyClDecl Name -> TcM (Maybe TyThing) -- Nothing if error
+tcFamInstDecl (L loc decl)
= -- Prime error recovery, set source location
recoverM (returnM Nothing) $
setSrcSpan loc $
tcAddDeclCtxt decl $
- do { -- indexed data types require -findexed-types and can't be in an
+ do { -- type families require -ftype-families and can't be in an
-- hs-boot file
- ; gla_exts <- doptM Opt_IndexedTypes
+ ; gla_exts <- doptM Opt_TypeFamilies
; is_boot <- tcIsHsBoot -- Are we compiling an hs-boot file?
- ; checkTc gla_exts $ badIdxTyDecl (tcdLName decl)
- ; checkTc (not is_boot) $ badBootTyIdxDeclErr
+ ; checkTc gla_exts $ badFamInstDecl (tcdLName decl)
+ ; checkTc (not is_boot) $ badBootFamInstDeclErr
-- perform kind and type checking
- ; tcIdxTyInstDecl1 decl
+ ; tcFamInstDecl1 decl
}
-tcIdxTyInstDecl1 :: TyClDecl Name -> TcM (Maybe TyThing) -- Nothing if error
+tcFamInstDecl1 :: TyClDecl Name -> TcM (Maybe TyThing) -- Nothing if error
-tcIdxTyInstDecl1 (decl@TySynonym {})
+ -- "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
unless (isSynTyCon family) $
; t_typats <- mappM tcHsKindedType k_typats
; t_rhs <- tcHsKindedType k_rhs
- -- !!!of the form: forall t_tvs. (tcdLName decl) t_typats = t_rhs
- ; return Nothing -- !!!TODO: need TyThing for indexed synonym
+ -- (3) construct representation tycon
+ ; rep_tc_name <- newFamInstTyConName tc_name loc
+ ; tycon <- buildSynTyCon rep_tc_name t_tvs (SynonymTyCon t_rhs)
+ (Just (family, t_typats))
+
+ ; return $ Just (ATyCon tycon)
}}
-
-tcIdxTyInstDecl1 (decl@TyData {tcdND = new_or_data, tcdLName = L loc tc_name,
- tcdCons = cons})
+
+ -- "newtype instance" and "data instance"
+tcFamInstDecl1 (decl@TyData {tcdND = new_or_data, tcdLName = L loc tc_name,
+ tcdCons = cons})
= kcIdxTyPats decl $ \k_tvs k_typats resKind family ->
do { -- check that the family declaration is for the right kind
- unless (new_or_data == NewType && isNewTyCon family ||
- new_or_data == DataType && isDataTyCon family) $
+ unless (isAlgTyCon family) $
addErr (wrongKindOfFamily family)
; -- (1) kind check the data declaration as usual
; t_typats <- mappM tcHsKindedType k_typats
; stupid_theta <- tcHsKindedContext k_ctxt
- ; rep_tc_name <- newFamInstTyConName tc_name (srcSpanStart loc)
+ -- (3) construct representation tycon
+ ; rep_tc_name <- newFamInstTyConName tc_name loc
; tycon <- fixM (\ tycon -> do
- { data_cons <- mappM (addLocM (tcConDecl unbox_strict new_or_data
- tycon t_tvs))
+ { data_cons <- mappM (addLocM (tcConDecl unbox_strict tycon t_tvs))
k_cons
; tc_rhs <-
case new_or_data of
DataType -> return (mkDataTyConRhs data_cons)
NewType -> ASSERT( isSingleton data_cons )
- mkNewTyConRhs tc_name tycon (head data_cons)
+ mkNewTyConRhs rep_tc_name tycon (head data_cons)
; buildAlgTyCon rep_tc_name t_tvs stupid_theta tc_rhs Recursive
False h98_syntax (Just (family, t_typats))
-- We always assume that indexed types are recursive. Why?
use them, whereas for the mutually recursive data types D we bring into
scope kind bindings D -> k, where k is a kind variable, and do inference.
-Indexed Types
+Type families
~~~~~~~~~~~~~
This treatment of type synonyms only applies to Haskell 98-style synonyms.
General type functions can be recursive, and hence, appear in `alg_decls'.
-The kind of an indexed type is solely determinded by its kind signature;
+The kind of a type family is solely determinded by its kind signature;
hence, only kind signatures participate in the construction of the initial
kind environment (as constructed by `getInitialKind'). In fact, we ignore
-instances of indexed types altogether in the following. However, we need to
-include the kind signatures of associated types into the construction of the
+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}
-- instances of indexed types yet, but leave this to
-- `tcInstDecls1'
{ kc_alg_decls <- mappM (wrapLocM kcTyClDecl)
- (filter (not . isIdxTyDecl . unLoc) alg_decls)
+ (filter (not . isFamInstDecl . unLoc) alg_decls)
; return (kc_syn_decls, kc_alg_decls) }}}
where
-- environment
allDecls (decl@ClassDecl {tcdATs = ats}) = decl : [ at
| L _ at <- ats
- , isKindSigDecl at]
- allDecls decl | isIdxTyDecl decl = []
- | otherwise = [decl]
+ , isFamilyDecl at]
+ allDecls decl | isFamInstDecl decl = []
+ | otherwise = [decl]
------------------------------------------------------------------------
getInitialKind :: TyClDecl Name -> TcM (Name, TcKind)
mk_arg_kind (UserTyVar _) = newKindVar
mk_arg_kind (KindedTyVar _ kind) = return kind
- mk_res_kind (TyFunction { tcdKind = kind }) = return kind
- mk_res_kind (TyData { tcdKindSig = Just kind }) = return kind
- -- On GADT-style and data signature declarations we allow a kind
- -- signature
+ mk_res_kind (TyFamily { tcdKind = Just kind }) = return kind
+ mk_res_kind (TyData { tcdKindSig = Just kind }) = return kind
+ -- On GADT-style declarations we allow a kind signature
-- data T :: *->* where { ... }
mk_res_kind other = return liftedTypeKind
-- Not used for type synonyms (see kcSynDecl)
kcTyClDecl decl@(TyData {})
- = ASSERT( not . isJust $ tcdTyPats decl ) -- must not be instance of idx ty
+ = ASSERT( not . isFamInstDecl $ decl ) -- must not be a family instance
kcTyClDeclBody decl $
kcDataDecl decl
-kcTyClDecl decl@(TyFunction {})
+kcTyClDecl decl@(TyFamily {tcdKind = kind})
= kcTyClDeclBody decl $ \ tvs' ->
- return (decl {tcdTyVars = tvs'})
+ return (decl {tcdTyVars = tvs',
+ tcdKind = kind `mplus` Just liftedTypeKind})
+ -- default result kind is '*'
kcTyClDecl decl@(ClassDecl {tcdCtxt = ctxt, tcdSigs = sigs, tcdATs = ats})
= kcTyClDeclBody decl $ \ tvs' ->
kc_con_details (RecCon fields)
= do { fields' <- mappM kc_field fields; return (RecCon fields') }
- kc_field (HsRecField fld bty d) = do { bty' <- kc_larg_ty bty ; return (HsRecField fld bty' d) }
+ kc_field (ConDeclField fld bty d) = do { bty' <- kc_larg_ty bty
+ ; return (ConDeclField fld bty' d) }
kc_larg_ty bty = case new_or_data of
DataType -> kcHsSigType bty
; syn_tcs <- tcExtendGlobalEnv [syn_tc] (tcSynDecls decls)
; return (syn_tc : syn_tcs) }
+ -- "type"
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
- ; return (ATyCon (buildSynTyCon tc_name tvs' (SynonymTyCon rhs_ty'))) }
+ ; tycon <- buildSynTyCon tc_name tvs' (SynonymTyCon rhs_ty') Nothing
+ ; return (ATyCon tycon)
+ }
--------------------
tcTyClDecl :: (Name -> RecFlag) -> TyClDecl Name -> TcM [TyThing]
tcTyClDecl calc_isrec decl
= tcAddDeclCtxt decl (tcTyClDecl1 calc_isrec decl)
- -- kind signature for a type function
+ -- "type family" declarations
tcTyClDecl1 _calc_isrec
- (TyFunction {tcdLName = L _ tc_name, tcdTyVars = tvs, tcdKind = kind})
+ (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)
- ; gla_exts <- doptM Opt_IndexedTypes
+ ; idx_tys <- doptM Opt_TypeFamilies
- -- Check that we don't use kind signatures without Glasgow extensions
- ; checkTc gla_exts $ badSigTyDecl tc_name
+ -- Check that we don't use families without -ftype-families
+ ; checkTc idx_tys $ badFamInstDecl tc_name
- ; return [ATyCon $ buildSynTyCon tc_name tvs' (OpenSynTyCon kind)]
+ ; tycon <- buildSynTyCon tc_name tvs' (OpenSynTyCon kind Nothing) Nothing
+ ; return [ATyCon tycon]
}
- -- kind signature for an indexed data type
+ -- "newtype family" or "data family" declaration
tcTyClDecl1 _calc_isrec
- (TyData {tcdND = new_or_data, tcdCtxt = ctxt, tcdTyVars = tvs,
- tcdLName = L _ tc_name, tcdKindSig = Just ksig, tcdCons = []})
+ (TyFamily {tcdFlavour = DataFamily,
+ tcdLName = L _ tc_name, tcdTyVars = tvs, tcdKind = mb_kind})
= tcTyVarBndrs tvs $ \ tvs' -> do
- { traceTc (text "data/newtype family: " <+> ppr tc_name)
- ; extra_tvs <- tcDataKindSig (Just ksig)
+ { traceTc (text "data family: " <+> ppr tc_name)
+ ; extra_tvs <- tcDataKindSig mb_kind
; let final_tvs = tvs' ++ extra_tvs -- we may not need these
- ; checkTc (null . unLoc $ ctxt) $ badKindSigCtxt tc_name
- ; gla_exts <- doptM Opt_IndexedTypes
+ ; idx_tys <- doptM Opt_TypeFamilies
- -- Check that we don't use kind signatures without Glasgow extensions
- ; checkTc gla_exts $ badSigTyDecl tc_name
+ -- Check that we don't use families without -ftype-families
+ ; checkTc idx_tys $ badFamInstDecl tc_name
; tycon <- buildAlgTyCon tc_name final_tvs []
- (case new_or_data of
- DataType -> OpenDataTyCon
- NewType -> OpenNewTyCon)
- Recursive False True Nothing
+ mkOpenDataTyConRhs Recursive False True Nothing
; return [ATyCon tycon]
}
+ -- "newtype" and "data"
tcTyClDecl1 calc_isrec
(TyData {tcdND = new_or_data, tcdCtxt = ctxt, tcdTyVars = tvs,
tcdLName = L _ tc_name, tcdKindSig = mb_ksig, tcdCons = cons})
; want_generic <- doptM Opt_Generics
; unbox_strict <- doptM Opt_UnboxStrictFields
; gla_exts <- doptM Opt_GlasgowExts
+ ; gadt_ok <- doptM Opt_GADTs
; is_boot <- tcIsHsBoot -- Are we compiling an hs-boot file?
-- Check that we don't use GADT syntax in H98 world
- ; checkTc (gla_exts || h98_syntax) (badGadtDecl tc_name)
+ ; checkTc (gadt_ok || h98_syntax) (badGadtDecl tc_name)
-- Check that we don't use kind signatures without Glasgow extensions
; checkTc (gla_exts || isNothing mb_ksig) (badSigTyDecl tc_name)
(newtypeConError tc_name (length cons))
; tycon <- fixM (\ tycon -> do
- { data_cons <- mappM (addLocM (tcConDecl unbox_strict new_or_data
- tycon final_tvs))
+ { data_cons <- mappM (addLocM (tcConDecl unbox_strict tycon final_tvs))
cons
; tc_rhs <-
if null cons && is_boot -- In a hs-boot file, empty cons means
-----------------------------------
tcConDecl :: Bool -- True <=> -funbox-strict_fields
- -> NewOrData
-> TyCon -> [TyVar]
-> ConDecl Name
-> TcM DataCon
-tcConDecl unbox_strict NewType tycon tc_tvs -- Newtypes
- (ConDecl name _ ex_tvs ex_ctxt details ResTyH98 _)
- = do { let tc_datacon field_lbls arg_ty
- = do { arg_ty' <- tcHsKindedType arg_ty -- No bang on newtype
- ; buildDataCon (unLoc name) False {- Prefix -}
- [NotMarkedStrict]
- (map unLoc field_lbls)
- tc_tvs [] -- No existentials
- [] [] -- No equalities, predicates
- [arg_ty']
- tycon }
-
- -- Check that a newtype has no existential stuff
- ; checkTc (null ex_tvs && null (unLoc ex_ctxt)) (newtypeExError name)
-
- ; case details of
- PrefixCon [arg_ty] -> tc_datacon [] arg_ty
- RecCon [HsRecField field_lbl arg_ty _] -> tc_datacon [field_lbl] arg_ty
- other ->
- failWithTc (newtypeFieldErr name (length (hsConArgs details)))
- -- Check that the constructor has exactly one field
- }
-
-tcConDecl unbox_strict DataType tycon tc_tvs -- Data types
+tcConDecl unbox_strict tycon tc_tvs -- Data types
(ConDecl name _ tvs ctxt details res_ty _)
= tcTyVarBndrs tvs $ \ tvs' -> do
{ ctxt' <- tcHsKindedContext ctxt
InfixCon bty1 bty2 -> tc_datacon True [] [bty1,bty2]
RecCon fields -> tc_datacon False field_names btys
where
- (field_names, btys) = unzip [ (n, t) | HsRecField n t _ <- fields ]
-
+ field_names = map cd_fld_name fields
+ btys = map cd_fld_type fields
}
tcResultType :: TyCon
checkValidTyCon tc
| isSynTyCon tc
= case synTyConRhs tc of
- OpenSynTyCon _ -> return ()
- SynonymTyCon ty -> checkValidType syn_ctxt ty
+ OpenSynTyCon _ _ -> return ()
+ SynonymTyCon ty -> checkValidType syn_ctxt ty
| otherwise
= -- Check the context on the data decl
checkValidTheta (DataTyCtxt name) (tyConStupidTheta tc) `thenM_`
-- NB: this check assumes that all the constructors of a given
-- data type use the same type variables
where
- tvs1 = mkVarSet (dataConAllTyVars con1)
- res1 = dataConResTys con1
+ (tvs1, _, _, res1) = dataConSig con1
+ ts1 = mkVarSet tvs1
fty1 = dataConFieldType con1 label
checkOne (_, con2) -- Do it bothways to ensure they are structurally identical
- = do { checkFieldCompat label con1 con2 tvs1 res1 res2 fty1 fty2
- ; checkFieldCompat label con2 con1 tvs2 res2 res1 fty2 fty1 }
+ = do { checkFieldCompat label con1 con2 ts1 res1 res2 fty1 fty2
+ ; checkFieldCompat label con2 con1 ts2 res2 res1 fty2 fty1 }
where
- tvs2 = mkVarSet (dataConAllTyVars con2)
- res2 = dataConResTys con2
+ (tvs2, _, _, res2) = dataConSig con2
+ ts2 = mkVarSet tvs2
fty2 = dataConFieldType con2 label
checkFieldCompat fld con1 con2 tvs1 res1 res2 fty1 fty2
= do { checkTc (isJust mb_subst1) (resultTypeMisMatch fld con1 con2)
; checkTc (isJust mb_subst2) (fieldTypeMisMatch fld con1 con2) }
where
- mb_subst1 = tcMatchTys tvs1 res1 res2
+ mb_subst1 = tcMatchTy tvs1 res1 res2
mb_subst2 = tcMatchTyX tvs1 (expectJust "checkFieldCompat" mb_subst1) fty1 fty2
-------------------------------
= setSrcSpan (srcLocSpan (getSrcLoc con)) $
addErrCtxt (dataConCtxt con) $
do { checkTc (dataConTyCon con == tc) (badDataConTyCon con)
- ; checkValidType ctxt (dataConUserType con) }
+ ; checkValidType ctxt (dataConUserType con)
+ ; ifM (isNewTyCon tc) (checkNewDataCon con)
+ }
where
ctxt = ConArgCtxt (dataConName con)
-------------------------------
+checkNewDataCon :: DataCon -> TcM ()
+-- Checks for the data constructor of a newtype
+checkNewDataCon con
+ = do { checkTc (isSingleton arg_tys) (newtypeFieldErr con (length arg_tys))
+ -- One argument
+ ; checkTc (null eq_spec) (newtypePredError con)
+ -- Return type is (T a b c)
+ ; checkTc (null ex_tvs && null theta) (newtypeExError con)
+ -- No existentials
+ ; checkTc (not (any isMarkedStrict (dataConStrictMarks con)))
+ (newtypeStrictError con)
+ -- No strictness
+ }
+ where
+ (_univ_tvs, ex_tvs, eq_spec, theta, arg_tys, _res_ty) = dataConFullSig con
+
+-------------------------------
checkValidClass :: Class -> TcM ()
checkValidClass cls
= do { -- CHECK ARITY 1 FOR HASKELL 1.4
; checkValidType (FunSigCtxt op_name) tau
-- Check that the type mentions at least one of
- -- the class type variables
- ; checkTc (any (`elemVarSet` tyVarsOfType tau) tyvars)
+ -- the class type variables...or at least one reachable
+ -- from one of the class variables. Example: tc223
+ -- class Error e => Game b mv e | b -> mv e where
+ -- newBoard :: MonadState b m => m ()
+ -- Here, MonadState has a fundep m->b, so newBoard is fine
+ ; let grown_tyvars = grow theta (mkVarSet tyvars)
+ ; checkTc (tyVarsOfType tau `intersectsVarSet` grown_tyvars)
(noClassTyVarErr cls sel_id)
-- Check that for a generic method, the type of
badGadtDecl tc_name
= vcat [ ptext SLIT("Illegal generalised algebraic data declaration for") <+> quotes (ppr tc_name)
- , nest 2 (parens $ ptext SLIT("Use -fglasgow-exts to allow GADTs")) ]
+ , nest 2 (parens $ ptext SLIT("Use -X=GADT to allow GADTs")) ]
badStupidTheta tc_name
= ptext SLIT("A data type declared in GADT style cannot have a context:") <+> quotes (ppr tc_name)
= sep [ptext SLIT("A newtype constructor cannot have an existential context,"),
nest 2 $ ptext SLIT("but") <+> quotes (ppr con) <+> ptext SLIT("does")]
+newtypeStrictError con
+ = sep [ptext SLIT("A newtype constructor cannot have a strictness annotation,"),
+ nest 2 $ ptext SLIT("but") <+> quotes (ppr con) <+> ptext SLIT("does")]
+
+newtypePredError con
+ = sep [ptext SLIT("A newtype constructor must have a return type of form T a1 ... an"),
+ nest 2 $ ptext SLIT("but") <+> quotes (ppr con) <+> ptext SLIT("does not")]
+
newtypeFieldErr con_name n_flds
= sep [ptext SLIT("The constructor of a newtype must have exactly one field"),
nest 2 $ ptext SLIT("but") <+> quotes (ppr con_name) <+> ptext SLIT("has") <+> speakN n_flds]
badSigTyDecl tc_name
= vcat [ ptext SLIT("Illegal kind signature") <+>
quotes (ppr tc_name)
- , nest 2 (parens $ ptext SLIT("Use -fglasgow-exts to allow indexed types")) ]
-
-badKindSigCtxt tc_name
- = vcat [ ptext SLIT("Illegal context in kind signature") <+>
- quotes (ppr tc_name)
- , nest 2 (parens $ ptext SLIT("Currently, kind signatures cannot have a context")) ]
+ , nest 2 (parens $ ptext SLIT("Use -fglasgow-exts to allow kind signatures")) ]
-badIdxTyDecl tc_name
- = vcat [ ptext SLIT("Illegal indexed type instance for") <+>
+badFamInstDecl tc_name
+ = vcat [ ptext SLIT("Illegal family instance for") <+>
quotes (ppr tc_name)
- , nest 2 (parens $ ptext SLIT("Use -fglasgow-exts to allow indexed types")) ]
+ , nest 2 (parens $ ptext SLIT("Use -X=TypeFamilies to allow indexed type families")) ]
badGadtIdxTyDecl tc_name
= vcat [ ptext SLIT("Illegal generalised algebraic data declaration for") <+>
quotes (ppr tc_name)
- , nest 2 (parens $ ptext SLIT("Indexed types cannot use GADT declarations")) ]
+ , nest 2 (parens $ ptext SLIT("Family instances can not yet use GADT declarations")) ]
tooManyParmsErr tc_name
- = ptext SLIT("Indexed type instance has too many parameters:") <+>
+ = ptext SLIT("Family instance has too many parameters:") <+>
quotes (ppr tc_name)
tooFewParmsErr tc_name
- = ptext SLIT("Indexed type instance has too few parameters:") <+>
+ = ptext SLIT("Family instance has too few parameters:") <+>
quotes (ppr tc_name)
-badBootTyIdxDeclErr =
- ptext SLIT("Illegal indexed type instance in hs-boot file")
+badBootFamInstDeclErr =
+ ptext SLIT("Illegal family instance in hs-boot file")
wrongKindOfFamily family =
- ptext SLIT("Wrong category of type instance; declaration was for a") <+>
+ ptext SLIT("Wrong category of family instance; declaration was for a") <+>
kindOfFamily
where
- kindOfFamily | isSynTyCon family = ptext SLIT("type synonym")
- | isDataTyCon family = ptext SLIT("data type")
- | isNewTyCon family = ptext SLIT("newtype")
+ kindOfFamily | isSynTyCon family = ptext SLIT("type synonym")
+ | isAlgTyCon family = ptext SLIT("data type")
+ | otherwise = pprPanic "wrongKindOfFamily" (ppr family)
emptyConDeclsErr tycon
= sep [quotes (ppr tycon) <+> ptext SLIT("has no constructors"),