%
-% (c) The GRASP/AQUA Project, Glasgow University, 1992-1996
+% (c) The GRASP/AQUA Project, Glasgow University, 1992-1998
%
\section[TcModule]{Typechecking a whole module}
\begin{code}
module TcModule (
typecheckModule,
- TcResults,
- TcDDumpDeriv
+ TcResults(..)
) where
#include "HsVersions.h"
-import CmdLineOpts ( opt_D_dump_tc, opt_D_dump_deriv )
+import CmdLineOpts ( opt_D_dump_tc, opt_D_dump_types, opt_PprStyle_Debug )
import HsSyn ( HsModule(..), HsBinds(..), MonoBinds(..), HsDecl(..) )
+import HsTypes ( toHsType )
import RnHsSyn ( RenamedHsModule )
-import TcHsSyn ( TcMonoBinds, TypecheckedMonoBinds, zonkTopBinds )
+import TcHsSyn ( TypecheckedMonoBinds,
+ TypecheckedForeignDecl, TypecheckedRuleDecl,
+ zonkTopBinds, zonkForeignExports, zonkRules
+ )
import TcMonad
-import Inst ( Inst, emptyLIE, plusLIE )
-import TcBinds ( tcTopBindsAndThen )
-import TcClassDcl ( tcClassDecls2 )
+import Inst ( emptyLIE, plusLIE )
+import TcBinds ( tcTopBinds )
+import TcClassDcl ( tcClassDecls2, mkImplicitClassBinds )
import TcDefaults ( tcDefaults )
-import TcEnv ( TcIdOcc(..), tcExtendGlobalValEnv, tcExtendTyConEnv,
- getEnv_TyCons, getEnv_Classes, tcLookupLocalValue,
- tcLookupTyCon, initEnv )
-import TcExpr ( tcId )
+import TcEnv ( tcExtendGlobalValEnv, tcLookupGlobal_maybe,
+ tcEnvTyCons, tcEnvClasses,
+ tcSetEnv, tcSetInstEnv, initEnv
+ )
+import TcRules ( tcRules )
+import TcForeign ( tcForeignImports, tcForeignExports )
import TcIfaceSig ( tcInterfaceSigs )
import TcInstDcls ( tcInstDecls1, tcInstDecls2 )
-import TcInstUtil ( buildInstanceEnvs, classDataCon, InstInfo )
+import TcInstUtil ( InstInfo )
import TcSimplify ( tcSimplifyTop )
-import TcTyClsDecls ( tcTyAndClassDecls1 )
-import TcTyDecls ( mkDataBinds )
-import TcType ( TcType, tcInstType )
-import TcKind ( TcKind, kindToTcKind )
+import TcTyClsDecls ( tcTyAndClassDecls )
+import TcTyDecls ( mkImplicitDataBinds )
-import RnMonad ( RnNameSupply(..) )
+import CoreUnfold ( unfoldingTemplate )
+import Type ( funResultTy, splitForAllTys )
+import RnMonad ( RnNameSupply, FixityEnv )
import Bag ( isEmptyBag )
-import ErrUtils ( WarnMsg, ErrMsg,
- pprBagOfErrors, dumpIfSet
+import ErrUtils ( printErrorsAndWarnings, dumpIfSet )
+import Id ( idType, idName, idUnfolding )
+import Module ( pprModuleName, mkThisModule, plusModuleEnv )
+import Name ( nameOccName, isLocallyDefined, isGlobalName,
+ toRdrName, nameEnvElts,
)
-import Id ( idType, GenId )
-import Name ( Name, isLocallyDefined, pprModule, NamedThing(..) )
-import TyCon ( TyCon, tyConKind )
-import Class ( Class, classSelIds, classTyCon )
-import Type ( mkTyConApp, Type )
-import TyVar ( emptyTyVarEnv )
-import TysWiredIn ( unitTy )
-import PrelMods ( mAIN )
-import PrelInfo ( main_NAME, ioTyCon_NAME )
-import Unify ( unifyTauTy )
-import Unique ( Unique )
+import TyCon ( TyCon, isDataTyCon, tyConName, tyConGenInfo )
+import OccName ( isSysOcc )
+import TyCon ( TyCon, isClassTyCon )
+import Class ( Class )
+import PrelNames ( mAIN_Name, mainKey )
import UniqSupply ( UniqSupply )
+import Maybes ( maybeToBool )
import Util
+import BasicTypes ( EP(..) )
import Bag ( Bag, isEmptyBag )
-import FiniteMap ( FiniteMap )
-import Outputable
+vimport Outputable
+
\end{code}
Outside-world interface:
\begin{code}
-- Convenient type synonyms first:
-type TcResults
- = (TypecheckedMonoBinds,
- [TyCon], [Class],
- Bag InstInfo, -- Instance declaration information
- TcDDumpDeriv)
-
-type TcDDumpDeriv = SDoc
+data TcResults
+ = TcResults {
+ tc_pcs :: PersistentCompilerState, -- Augmented with imported information,
+ -- (but not stuff from this module)
+ tc_env :: TypeEnv, -- The TypeEnv just for the stuff from this module
+ tc_insts :: [DFunId], -- Instances, just for this module
+ tc_binds :: TypecheckedMonoBinds,
+ tc_fords :: [TypecheckedForeignDecl], -- Foreign import & exports.
+ tc_rules :: [TypecheckedRuleDecl], -- Transformation rules
+ }
---------------
typecheckModule
- :: UniqSupply
- -> RnNameSupply
+ :: PersistentCompilerState
+ -> HomeSymbolTable
-> RenamedHsModule
- -> IO (Maybe TcResults)
+ -> IO (Maybe (PersistentCompilerState, TcResults))
+
+typecheckModule pcs hst (HsModule mod_name _ _ _ decls _ src_loc)
+ = do { env <- initTcEnv global_symbol_table global_inst_env ;
+
+ (_, (maybe_result, msgs)) <- initTc env src_loc tc_module
+
+ printErrorsAndWarnings msgs ;
+
+ printTcDumps maybe_result ;
+
+ if isEmptyBag errs then
+ return Nothing
+ else
+ return result
+ }
+ where
+ this_mod = mkThisModule
+ global_symbol_table = pcs_PST pcs `plusModuleEnv` hst
-typecheckModule us rn_name_supply mod
- = let
- (maybe_result, warns, errs) =
- initTc us initEnv (tcModule rn_name_supply mod)
- in
- print_errs warns >>
- print_errs errs >>
-
- dumpIfSet opt_D_dump_tc "Typechecked"
- (case maybe_result of
- Just (binds, _, _, _, _) -> ppr binds
- Nothing -> text "Typecheck failed") >>
-
- dumpIfSet opt_D_dump_deriv "Derived instances"
- (case maybe_result of
- Just (_, _, _, _, dump_deriv) -> dump_deriv
- Nothing -> empty) >>
-
- return (if isEmptyBag errs then
- maybe_result
- else
- Nothing)
-
-print_errs errs
- | isEmptyBag errs = return ()
- | otherwise = printErrs (pprBagOfErrors errs)
+ tc_module = fixTc (\ ~(unf_env ,_) -> tcModule pcs hst this_mod decls unf_env)
\end{code}
The internal monster:
\begin{code}
-tcModule :: RnNameSupply -- for renaming derivings
- -> RenamedHsModule -- input
- -> TcM s TcResults -- output
-
-tcModule rn_name_supply
- (HsModule mod_name verion exports imports fixities decls src_loc)
- = tcAddSrcLoc src_loc $ -- record where we're starting
-
- fixTc (\ ~(unf_env ,_) ->
- -- unf_env is used for type-checking interface pragmas
- -- which is done lazily [ie failure just drops the pragma
- -- without having any global-failure effect].
- --
- -- unf_env is also used to get the pragam info
- -- for imported dfuns and default methods
-
- -- The knot for instance information. This isn't used at all
- -- till we type-check value declarations
- fixTc ( \ ~(rec_inst_mapper, _, _, _, _) ->
+tcModule :: PersistentCompilerState
+ -> HomeSymbolTable
+ -> Module
+ -> [RenamedHsDecl]
+ -> TcEnv -- The knot-tied environment
+ -> TcM TcResults
+
+ -- (unf_env :: TcEnv) is used for type-checking interface pragmas
+ -- which is done lazily [ie failure just drops the pragma
+ -- without having any global-failure effect].
+ --
+ -- unf_env is also used to get the pragama info
+ -- for imported dfuns and default methods
+
+tcModule pcs hst this_mod decls unf_env
+ = -- Type-check the type and class decls
+ tcTyAndClassDecls unf_env decls `thenTc` \ env ->
+ tcSetEnv env $
+ let
+ classes = tcEnvClasses env
+ tycons = tcEnvTyCons env -- INCLUDES tycons derived from classes
+ local_classes = filter isLocallyDefined classes
+ local_tycons = [ tc | tc <- tycons,
+ isLocallyDefined tc,
+ not (isClassTyCon tc)
+ ]
+ -- For local_tycons, filter out the ones derived from classes
+ -- Otherwise the latter show up in interface files
+ in
+
+ -- Typecheck the instance decls, includes deriving
+ tcInstDecls1 pcs hst unf_env this_mod
+ local_tycons decls `thenTc` \ (pcs_with_insts, inst_env, inst_info, deriv_binds) ->
+ tcSetInstEnv inst_env $
+
+ -- Default declarations
+ tcDefaults decls `thenTc` \ defaulting_tys ->
+ tcSetDefaultTys defaulting_tys $
+
+ -- Interface type signatures
+ -- We tie a knot so that the Ids read out of interfaces are in scope
+ -- when we read their pragmas.
+ -- What we rely on is that pragmas are typechecked lazily; if
+ -- any type errors are found (ie there's an inconsistency)
+ -- we silently discard the pragma
+ -- We must do this before mkImplicitDataBinds (which comes next), since
+ -- the latter looks up unpackCStringId, for example, which is usually
+ -- imported
+ tcInterfaceSigs unf_env decls `thenTc` \ sig_ids ->
+ tcExtendGlobalValEnv sig_ids $
+
+ -- Create any necessary record selector Ids and their bindings
+ -- "Necessary" includes data and newtype declarations
+ -- We don't create bindings for dictionary constructors;
+ -- they are always fully applied, and the bindings are just there
+ -- to support partial applications
+ mkImplicitDataBinds tycons `thenTc` \ (data_ids, imp_data_binds) ->
+ mkImplicitClassBinds classes `thenNF_Tc` \ (cls_ids, imp_cls_binds) ->
+
+ -- Extend the global value environment with
+ -- (a) constructors
+ -- (b) record selectors
+ -- (c) class op selectors
+ -- (d) default-method ids... where? I can't see where these are
+ -- put into the envt, and I'm worried that the zonking phase
+ -- will find they aren't there and complain.
+ tcExtendGlobalValEnv data_ids $
+ tcExtendGlobalValEnv cls_ids $
+
+ -- Foreign import declarations next
+ tcForeignImports decls `thenTc` \ (fo_ids, foi_decls) ->
+ tcExtendGlobalValEnv fo_ids $
+
+ -- Value declarations next.
+ -- We also typecheck any extra binds that came out of the "deriving" process
+ tcTopBinds (get_binds decls `ThenBinds` deriv_binds) `thenTc` \ ((val_binds, env), lie_valdecls) ->
+ tcSetEnv env $
- -- Type-check the type and class decls
- -- trace "tcTyAndClassDecls:" $
- tcTyAndClassDecls1 unf_env rec_inst_mapper decls `thenTc` \ env ->
+ -- Foreign export declarations next
+ tcForeignExports decls `thenTc` \ (lie_fodecls, foe_binds, foe_decls) ->
- -- trace "tc3" $
- -- Typecheck the instance decls, includes deriving
- tcSetEnv env (
- -- trace "tcInstDecls:" $
- tcInstDecls1 unf_env decls mod_name rn_name_supply
- ) `thenTc` \ (inst_info, deriv_binds, ddump_deriv) ->
+ -- Second pass over class and instance declarations,
+ -- to compile the bindings themselves.
+ tcInstDecls2 inst_info `thenNF_Tc` \ (lie_instdecls, inst_binds) ->
+ tcClassDecls2 decls `thenNF_Tc` \ (lie_clasdecls, cls_dm_binds) ->
+ tcRules decls `thenNF_Tc` \ (lie_rules, rules) ->
- -- trace "tc4" $
- buildInstanceEnvs inst_info `thenNF_Tc` \ inst_mapper ->
+ -- Deal with constant or ambiguous InstIds. How could
+ -- there be ambiguous ones? They can only arise if a
+ -- top-level decl falls under the monomorphism
+ -- restriction, and no subsequent decl instantiates its
+ -- type. (Usually, ambiguous type variables are resolved
+ -- during the generalisation step.)
+ let
+ lie_alldecls = lie_valdecls `plusLIE`
+ lie_instdecls `plusLIE`
+ lie_clasdecls `plusLIE`
+ lie_fodecls `plusLIE`
+ lie_rules
+ in
+ tcSimplifyTop lie_alldecls `thenTc` \ const_inst_binds ->
+
+ -- Check that Main defines main
+ checkMain this_mod `thenTc_`
+
+ -- Backsubstitution. This must be done last.
+ -- Even tcSimplifyTop may do some unification.
+ let
+ all_binds = imp_data_binds `AndMonoBinds`
+ imp_cls_binds `AndMonoBinds`
+ val_binds `AndMonoBinds`
+ inst_binds `AndMonoBinds`
+ cls_dm_binds `AndMonoBinds`
+ const_inst_binds `AndMonoBinds`
+ foe_binds
+ in
+ zonkTopBinds all_binds `thenNF_Tc` \ (all_binds', final_env) ->
+ tcSetEnv final_env $
+ -- zonkTopBinds puts all the top-level Ids into the tcGEnv
+ zonkForeignExports foe_decls `thenNF_Tc` \ foe_decls' ->
+ zonkRules rules `thenNF_Tc` \ rules' ->
- returnTc (inst_mapper, env, inst_info, deriv_binds, ddump_deriv)
- -- End of inner fix loop
- ) `thenTc` \ (_, env, inst_info, deriv_binds, ddump_deriv) ->
+ let groups :: FiniteMap Module TypeEnv
+ groups = groupTyThings (nameEnvElts (tcGEnv final_env))
- -- trace "tc5" $
- tcSetEnv env $
-
- -- Default declarations
- tcDefaults decls `thenTc` \ defaulting_tys ->
- tcSetDefaultTys defaulting_tys $
-
- -- Create any necessary record selector Ids and their bindings
- -- "Necessary" includes data and newtype declarations
- -- We don't create bindings for dictionary constructors;
- -- they are always fully applied, and the bindings are just there
- -- to support partial applications
- let
- tycons = getEnv_TyCons env
- classes = getEnv_Classes env
- local_tycons = filter isLocallyDefined tycons
- local_classes = filter isLocallyDefined classes
- in
- mkDataBinds tycons `thenTc` \ (data_ids, data_binds) ->
-
- -- Extend the global value environment with
- -- (a) constructors
- -- (b) record selectors
- -- (c) class op selectors
- -- (d) default-method ids
- tcExtendGlobalValEnv data_ids $
- tcExtendGlobalValEnv (concat (map classSelIds classes)) $
-
- -- Extend the TyCon envt with the tycons corresponding to
- -- the classes, and the global value environment with the
- -- corresponding data cons.
- -- They are mentioned in types in interface files.
- tcExtendGlobalValEnv (map classDataCon classes) $
- tcExtendTyConEnv [ (getName tycon, (kindToTcKind (tyConKind tycon), Nothing, tycon))
- | clas <- classes,
- let tycon = classTyCon clas
- ] $
-
- -- Interface type signatures
- -- We tie a knot so that the Ids read out of interfaces are in scope
- -- when we read their pragmas.
- -- What we rely on is that pragmas are typechecked lazily; if
- -- any type errors are found (ie there's an inconsistency)
- -- we silently discard the pragma
- tcInterfaceSigs unf_env decls `thenTc` \ sig_ids ->
- tcExtendGlobalValEnv sig_ids $
-
-
- -- Value declarations next.
- -- We also typecheck any extra binds that came out of the "deriving" process
- -- trace "tcBinds:" $
- tcTopBindsAndThen
- (\ is_rec binds1 (binds2, thing) -> (binds1 `AndMonoBinds` binds2, thing))
- (get_val_decls decls `ThenBinds` deriv_binds)
- ( tcGetEnv `thenNF_Tc` \ env ->
- returnTc ((EmptyMonoBinds, env), emptyLIE)
- ) `thenTc` \ ((val_binds, final_env), lie_valdecls) ->
- tcSetEnv final_env $
-
-
- -- Second pass over class and instance declarations,
- -- to compile the bindings themselves.
- -- trace "tc8" $
- tcInstDecls2 inst_info `thenNF_Tc` \ (lie_instdecls, inst_binds) ->
- tcClassDecls2 decls `thenNF_Tc` \ (lie_clasdecls, cls_binds) ->
-
-
-
- -- Check that "main" has the right signature
- tcCheckMainSig mod_name `thenTc_`
-
- -- Deal with constant or ambiguous InstIds. How could
- -- there be ambiguous ones? They can only arise if a
- -- top-level decl falls under the monomorphism
- -- restriction, and no subsequent decl instantiates its
- -- type. (Usually, ambiguous type variables are resolved
- -- during the generalisation step.)
- -- trace "tc9" $
- let
- lie_alldecls = lie_valdecls `plusLIE` lie_instdecls `plusLIE` lie_clasdecls
- in
- tcSimplifyTop lie_alldecls `thenTc` \ const_inst_binds ->
-
-
- -- Backsubstitution. This must be done last.
- -- Even tcCheckMainSig and tcSimplifyTop may do some unification.
- let
- all_binds = data_binds `AndMonoBinds`
- val_binds `AndMonoBinds`
- inst_binds `AndMonoBinds`
- cls_binds `AndMonoBinds`
- const_inst_binds
- in
- zonkTopBinds all_binds `thenNF_Tc` \ (all_binds', really_final_env) ->
-
- returnTc (really_final_env,
- (all_binds', local_tycons, local_classes, inst_info, ddump_deriv))
-
- -- End of outer fix loop
- ) `thenTc` \ (final_env, stuff) ->
- returnTc stuff
-
-get_val_decls decls = foldr ThenBinds EmptyBinds [binds | ValD binds <- decls]
+ local_type_env :: TypeEnv
+ local_type_env = lookupWithDefaultFM groups this_mod emptyNameEnv
+
+ new_pst :: PackageSymbolTable
+ new_pst = extendTypeEnv (pcs_PST pcs) (delFromFM groups this_mod)
+
+ final_pcs :: PersistentCompilerState
+ final_pcs = pcs_with_insts {pcs_PST = new_pst}
+ in
+ returnTc (really_final_env,
+ TcResults { tc_pcs = final_pcs,
+ tc_env = local_type_env,
+ tc_binds = all_binds',
+ tc_insts = map instInfoDfunId inst_infos,
+ tc_fords = foi_decls ++ foe_decls',
+ tc_rules = rules'
+ }))
+
+get_binds decls = foldr ThenBinds EmptyBinds [binds | ValD binds <- decls]
\end{code}
\begin{code}
-tcCheckMainSig mod_name
- | mod_name /= mAIN
- = returnTc () -- A non-main module
-
- | otherwise
- = -- Check that main is defined
- tcLookupTyCon ioTyCon_NAME `thenTc` \ (_,_,ioTyCon) ->
- tcLookupLocalValue main_NAME `thenNF_Tc` \ maybe_main_id ->
- case maybe_main_id of {
- Nothing -> failWithTc noMainErr ;
- Just main_id ->
-
- -- Check that it has the right type (or a more general one)
- let
- expected_ty = mkTyConApp ioTyCon [unitTy]
- in
- tcInstType emptyTyVarEnv expected_ty `thenNF_Tc` \ expected_tau ->
- tcId main_NAME `thenNF_Tc` \ (_, lie, main_tau) ->
- tcSetErrCtxt mainTyCheckCtxt $
- unifyTauTy expected_tau
- main_tau `thenTc_`
- checkTc (isEmptyBag lie) (mainTyMisMatch expected_ty (idType main_id))
- }
-
+checkMain :: Module -> TcM ()
+checkMain this_mod
+ | moduleName this_mod == mAIN_Name
+ = tcLookupGlobal_maybe mainName `thenNF_Tc` \ maybe_main ->
+ case maybe_main of
+ Just (AnId _) -> returnTc ()
+ other -> addErrTc noMainErr
-mainTyCheckCtxt
- = hsep [ptext SLIT("When checking that"), ppr main_NAME, ptext SLIT("has the required type")]
+ | otherwise = returnTc ()
noMainErr
- = hsep [ptext SLIT("Module"), quotes (pprModule mAIN),
- ptext SLIT("must include a definition for"), quotes (ppr main_NAME)]
-
-mainTyMisMatch :: Type -> TcType s -> ErrMsg
-mainTyMisMatch expected actual
- = hang (hsep [ppr main_NAME, ptext SLIT("has the wrong type")])
- 4 (vcat [
- hsep [ptext SLIT("Expected:"), ppr expected],
- hsep [ptext SLIT("Inferred:"), ppr actual]
- ])
+ = hsep [ptext SLIT("Module"), quotes (pprModuleName mAIN_Name),
+ ptext SLIT("must include a definition for"), quotes (ptext SLIT("main"))]
+\end{code}
+
+
+%************************************************************************
+%* *
+\subsection{Dumping output}
+%* *
+%************************************************************************
+
+\begin{code}
+printTcDump Nothing = return ()
+printTcDump (Just results)
+ = do { dumpIfSet opt_D_dump_types "Type signatures" (dump_sigs results) ;
+ dumpIfSet opt_D_dump_tc "Typechecked" (dump_tc results)
+ }
+
+dump_tc results
+ = vcat [ppr (tc_binds results),
+ pp_rules (tc_rules results),
+ ppr_gen_tycons (tc_tycons results)
+ ]
+
+dump_sigs results -- Print type signatures
+ = -- Convert to HsType so that we get source-language style printing
+ -- And sort by RdrName
+ vcat $ map ppr_sig $ sortLt lt_sig $
+ [(toRdrName id, toHsType (idType id)) | id <- nameEnvElts (tc_env results),
+ want_sig id
+ ]
+ where
+ lt_sig (n1,_) (n2,_) = n1 < n2
+ ppr_sig (n,t) = ppr n <+> dcolon <+> ppr t
+
+ want_sig id | opt_PprStyle_Debug = True
+ | otherwise = isLocallyDefined n &&
+ isGlobalName n &&
+ not (isSysOcc (nameOccName n))
+ where
+ n = idName id
+
+ppr_gen_tycons tcs = vcat [ptext SLIT("{-# Generic type constructor details"),
+ vcat (map ppr_gen_tycon (filter isLocallyDefined tcs)),
+ ptext SLIT("#-}")
+ ]
+
+-- x&y are now Id's, not CoreExpr's
+ppr_gen_tycon tycon
+ | Just ep <- tyConGenInfo tycon
+ = (ppr tycon <> colon) $$ nest 4 (ppr_ep ep)
+
+ | otherwise = ppr tycon <> colon <+> ptext SLIT("Not derivable")
+
+ppr_ep (EP from to)
+ = vcat [ ptext SLIT("Rep type:") <+> ppr (funResultTy from_tau),
+ ptext SLIT("From:") <+> ppr (unfoldingTemplate (idUnfolding from)),
+ ptext SLIT("To:") <+> ppr (unfoldingTemplate (idUnfolding to))
+ ]
+ where
+ (_,from_tau) = splitForAllTys (idType from)
+
+pp_rules [] = empty
+pp_rules rs = vcat [ptext SLIT("{-# RULES"),
+ nest 4 (vcat (map ppr rs)),
+ ptext SLIT("#-}")]
\end{code}