%
+% (c) The University of Glasgow 2006
% (c) The AQUA Project, Glasgow University, 1996-1998
%
-\section[TcTyClsDecls]{Typecheck type and class declarations}
+
+TcTyClsDecls: Typecheck type and class declarations
\begin{code}
module TcTyClsDecls (
- tcTyAndClassDecls, tcIdxTyInstDecl
+ tcTyAndClassDecls, tcFamInstDecl
) where
#include "HsVersions.h"
-import HsSyn ( TyClDecl(..), HsConDetails(..), HsTyVarBndr(..),
- ConDecl(..), HsRecField(..), Sig(..), NewOrData(..), ResType(..),
- tyClDeclTyVars, isSynDecl, isIdxTyDecl,
- isKindSigDecl, hsConArgs, LTyClDecl, tcdName,
- hsTyVarName, LHsTyVarBndr, LHsType
- )
-import HsTypes ( HsBang(..), getBangStrictness, hsLTyVarNames )
-import BasicTypes ( RecFlag(..), StrictnessMark(..) )
-import HscTypes ( implicitTyThings, ModDetails )
-import BuildTyCl ( buildClass, buildAlgTyCon, buildSynTyCon, buildDataCon,
- mkDataTyConRhs, mkNewTyConRhs )
+import HsSyn
+import HsTypes
+import BasicTypes
+import HscTypes
+import BuildTyCl
import TcRnMonad
-import TcEnv ( TyThing(..),
- tcLookupLocated, tcLookupLocatedGlobal,
- tcExtendGlobalEnv, tcExtendKindEnv,
- tcExtendKindEnvTvs, newFamInstTyConName,
- tcExtendRecEnv, tcLookupTyVar, tcLookupLocatedTyCon )
-import TcTyDecls ( calcRecFlags, calcClassCycles, calcSynCycles )
-import TcClassDcl ( tcClassSigs, tcAddDeclCtxt )
-import TcHsType ( kcHsTyVars, kcHsLiftedSigType, kcHsType,
- kcHsContext, tcTyVarBndrs, tcHsKindedType, tcHsKindedContext,
- kcHsSigType, tcHsBangType, tcLHsConResTy,
- tcDataKindSig, kcCheckHsType )
-import TcMType ( newKindVar, checkValidTheta, checkValidType,
- -- checkFreeness,
- UserTypeCtxt(..), SourceTyCtxt(..) )
-import TcType ( TcKind, TcType, Type, tyVarsOfType, mkPhiTy,
- mkArrowKind, liftedTypeKind,
- tcSplitSigmaTy, tcGetTyVar_maybe )
-import Type ( splitTyConApp_maybe,
- newTyConInstRhs, isLiftedTypeKind, Kind,
- splitKindFunTys, mkArrowKinds
- -- pprParendType, pprThetaArrow
- )
-import Generics ( validGenericMethodType, canDoGenerics )
-import Class ( Class, className, classTyCon, DefMeth(..), classBigSig, classTyVars )
-import TyCon ( TyCon, AlgTyConRhs( AbstractTyCon, OpenDataTyCon,
- OpenNewTyCon ),
- SynTyConRhs( OpenSynTyCon, SynonymTyCon ),
- tyConDataCons, mkForeignTyCon, isProductTyCon,
- isRecursiveTyCon,
- tyConStupidTheta, synTyConRhs, isSynTyCon, tyConName,
- isNewTyCon, isDataTyCon, tyConKind,
- setTyConArgPoss )
-import DataCon ( DataCon, dataConUserType, dataConName,
- dataConFieldLabels, dataConTyCon, dataConAllTyVars,
- dataConFieldType, dataConResTys )
-import Var ( TyVar, idType, idName, tyVarName, setTyVarName )
-import VarSet ( elemVarSet, mkVarSet )
-import Name ( Name, getSrcLoc, tidyNameOcc, getOccName )
-import OccName ( initTidyOccEnv, tidyOccName )
+import TcEnv
+import TcTyDecls
+import TcClassDcl
+import TcHsType
+import TcMType
+import TcType
+import FunDeps
+import Type
+import Generics
+import Class
+import TyCon
+import DataCon
+import Var
+import VarSet
+import Name
+import OccName
import Outputable
-import Maybe ( isJust, fromJust, isNothing, catMaybes )
-import Maybes ( expectJust )
-import Monad ( unless )
-import Unify ( tcMatchTys, tcMatchTyX )
-import Util ( zipLazy, isSingleton, notNull, sortLe, mapAccumL )
-import List ( partition, elemIndex )
-import SrcLoc ( Located(..), unLoc, getLoc, srcLocSpan,
- srcSpanStart )
-import ListSetOps ( equivClasses, minusList )
-import Digraph ( SCC(..) )
-import DynFlags ( DynFlag( Opt_GlasgowExts, Opt_Generics,
- Opt_UnboxStrictFields, Opt_IndexedTypes ) )
+import Maybes
+import Monad
+import Unify
+import Util
+import SrcLoc
+import ListSetOps
+import Digraph
+import DynFlags
+
+import Data.List ( partition, elemIndex )
+import Control.Monad ( mplus )
\end{code}
tcTyAndClassDecls boot_details allDecls
= do { -- Omit instances of indexed types; 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 -findexed-types and can't be in an
-- hs-boot file
; gla_exts <- doptM Opt_IndexedTypes
; 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 {})
+tcFamInstDecl1 (decl@TySynonym {})
= kcIdxTyPats decl $ \k_tvs k_typats resKind family ->
do { -- check that the family declaration is for a synonym
unless (isSynTyCon family) $
; return Nothing -- !!!TODO: need TyThing for indexed synonym
}}
-tcIdxTyInstDecl1 (decl@TyData {tcdND = new_or_data, tcdLName = L loc tc_name,
- tcdCons = cons})
+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 ||
-- type functions can have a higher-kinded result
; let resultKind = mkArrowKinds (drop (length hs_typats) kinds) resKind
- ; typats <- zipWithM kcCheckHsType hs_typats kinds
+ ; typats <- TcRnMonad.zipWithM kcCheckHsType hs_typats kinds
; thing_inside tvs typats resultKind family
}
where
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' ->
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_IndexedTypes
- -- 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 -findexed-types
+ ; checkTc idx_tys $ badFamInstDecl tc_name
; return [ATyCon $ buildSynTyCon tc_name tvs' (OpenSynTyCon kind)]
}
- -- 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 new_or_data,
+ 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)
+ ; 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_IndexedTypes
- -- 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 -findexed-types
+ ; checkTc idx_tys $ badFamInstDecl tc_name
; tycon <- buildAlgTyCon tc_name final_tvs []
(case new_or_data of
; return [ATyCon tycon]
}
+ -- "newtype", "data", "newtype instance", "data instance"
tcTyClDecl1 calc_isrec
(TyData {tcdND = new_or_data, tcdCtxt = ctxt, tcdTyVars = tvs,
tcdLName = L _ tc_name, tcdKindSig = mb_ksig, tcdCons = cons})
; 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
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 -findexed-types 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")