X-Git-Url: http://git.megacz.com/?a=blobdiff_plain;f=ghc%2Fcompiler%2Frename%2FRename.lhs;h=9699e5eab8adf39e25a0d21b091ec45c6802e63c;hb=b085ee40c7f265a5977ea6ec1c415e573be5ff8c;hp=0fdd0554e0f89ffd3fcdfedc58a73cfd8e7808c2;hpb=aa44169c3c01243cdbf38f50f58e80477586552c;p=ghc-hetmet.git diff --git a/ghc/compiler/rename/Rename.lhs b/ghc/compiler/rename/Rename.lhs index 0fdd055..9699e5e 100644 --- a/ghc/compiler/rename/Rename.lhs +++ b/ghc/compiler/rename/Rename.lhs @@ -4,587 +4,546 @@ \section[Rename]{Renaming and dependency analysis passes} \begin{code} -module Rename ( renameModule ) where +module Rename + ( renameModule + , RnResult(..) + , renameStmt + , renameRdrName + , renameExtCore + , mkGlobalContext + , closeIfaceDecls + , checkOldIface + , slurpIface + ) where #include "HsVersions.h" import HsSyn -import HsPragmas ( DataPragmas(..) ) -import RdrHsSyn ( RdrNameHsModule, RdrNameHsDecl, RdrNameDeprecation ) -import RnHsSyn ( RenamedHsModule, RenamedHsDecl, - extractHsTyNames, extractHsCtxtTyNames +import RdrHsSyn ( RdrNameHsModule, RdrNameHsDecl, RdrNameDeprecation, + RdrNameTyClDecl, RdrNameRuleDecl, RdrNameInstDecl, RdrNameImportDecl, + RdrNameStmt + ) +import RnHsSyn ( RenamedHsDecl, RenamedTyClDecl, RenamedRuleDecl, RenamedInstDecl, + RenamedStmt, + instDeclFVs, tyClDeclFVs, ruleDeclFVs ) -import CmdLineOpts ( DynFlags, DynFlag(..) ) +import CmdLineOpts ( DynFlags, DynFlag(..), opt_InPackage ) import RnMonad -import RnNames ( getGlobalNames ) -import RnSource ( rnSourceDecls, rnDecl ) -import RnIfaces ( getImportedInstDecls, importDecl, mkImportExportInfo, - getInterfaceExports, - getImportedRules, getSlurped, removeContext, - loadBuiltinRules, getDeferredDecls, ImportDeclResult(..) +import RnExpr ( rnStmt ) +import RnNames ( getGlobalNames, exportsFromAvail ) +import RnSource ( rnSourceDecls, rnTyClDecl, rnIfaceRuleDecl, rnInstDecl ) +import RnIfaces ( slurpImpDecls, mkImportInfo, recordLocalSlurps, + closeDecls, + RecompileRequired, outOfDate, recompileRequired ) -import RnEnv ( availName, availsToNameSet, - emptyAvailEnv, unitAvailEnv, availEnvElts, plusAvailEnv, - warnUnusedImports, warnUnusedLocalBinds, warnUnusedModules, - lookupOrigNames, unknownNameErr, - FreeVars, plusFVs, plusFV, unitFV, emptyFVs, isEmptyFVs, addOneFV +import RnHiFiles ( readIface, loadInterface, + loadExports, loadFixDecls, loadDeprecs, ) -import Module ( Module, ModuleName, WhereFrom(..), - moduleNameUserString, moduleName, mkModuleInThisPackage +import RnEnv ( availsToNameSet, + unitAvailEnv, availEnvElts, availNames, + plusAvailEnv, groupAvails, warnUnusedImports, + warnUnusedLocalBinds, warnUnusedModules, + lookupSrcName, getImplicitStmtFVs, + getImplicitModuleFVs, newGlobalName, unQualInScope, + ubiquitousNames, lookupOccRn, checkMain, + plusGlobalRdrEnv, mkGlobalRdrEnv ) -import Name ( Name, isLocallyDefined, NamedThing(..), getSrcLoc, - nameOccName, nameUnique, nameModule, --- maybeUserImportedFrom, --- isUserImportedExplicitlyName, isUserImportedName, --- maybeWiredInTyConName, maybeWiredInIdName, - isUserExportedName, toRdrName, - nameEnvElts, extendNameEnv +import Module ( Module, ModuleName, WhereFrom(..), + moduleNameUserString, moduleName, + moduleEnvElts ) -import OccName ( occNameFlavour, isValOcc ) -import Id ( idType ) -import TyCon ( isSynTyCon, getSynTyConDefn ) +import Name ( Name, nameModule, isExternalName ) +import NameEnv import NameSet -import TysWiredIn ( unitTyCon, intTyCon, doubleTyCon, boolTyCon ) -import PrelRules ( builtinRules ) -import PrelNames ( mAIN_Name, pREL_MAIN_Name, pRELUDE_Name, - ioTyCon_RDR, - unpackCString_RDR, unpackCStringFoldr_RDR, unpackCStringUtf8_RDR, - eqString_RDR - ) -import PrelInfo ( fractionalClassKeys, derivingOccurrences, - maybeWiredInTyConName, maybeWiredInIdName ) -import Type ( namesOfType, funTyCon ) -import ErrUtils ( printErrorsAndWarnings, dumpIfSet, ghcExit ) -import BasicTypes ( Version, initialVersion ) -import Bag ( isEmptyBag, bagToList ) -import FiniteMap ( FiniteMap, eltsFM, fmToList, emptyFM, lookupFM, +import RdrName ( foldRdrEnv, isQual, emptyRdrEnv ) +import PrelNames ( iNTERACTIVE, pRELUDE_Name ) +import ErrUtils ( dumpIfSet, dumpIfSet_dyn, showPass, + printErrorsAndWarnings, errorsFound ) +import Bag ( bagToList ) +import FiniteMap ( FiniteMap, fmToList, emptyFM, lookupFM, addToFM_C, elemFM, addToFM ) -import UniqSupply ( UniqSupply ) -import UniqFM ( lookupUFM ) -import SrcLoc ( noSrcLoc ) -import Maybes ( maybeToBool, expectJust ) +import Maybes ( maybeToBool, catMaybes ) import Outputable import IO ( openFile, IOMode(..) ) -import HscTypes ( Finder, PersistentCompilerState, HomeSymbolTable, GlobalRdrEnv, - AvailEnv, Avails, GenAvailInfo(..), AvailInfo, - Provenance(..), ImportReason(..) ) - --- HACKS: -maybeUserImportedFrom = panic "maybeUserImportedFrom" -isUserImportedExplicitlyName = panic "isUserImportedExplicitlyName" -isUserImportedName = panic "isUserImportedName" -iDeprecs = panic "iDeprecs" -type FixityEnv = LocalFixityEnv +import HscTypes -- lots of it +import List ( partition, nub ) \end{code} +%********************************************************* +%* * +\subsection{The main wrappers} +%* * +%********************************************************* \begin{code} -type RenameResult = ( PersistentCompilerState - , ModIface - ) - -renameModule :: DynFlags -> Finder - -> PersistentCompilerState -> HomeSymbolTable - -> RdrNameHsModule - -> IO (PersistentCompilerState, Maybe ModIface) - -- The mi_decls in the ModIface include - -- ones imported from packages too - -renameModule dflags finder old_pcs hst - this_mod@(HsModule mod_name vers exports imports local_decls _ loc) - = -- Initialise the renamer monad - do { - ((maybe_rn_stuff, dump_action), (rn_warns_bag, rn_errs_bag), new_pcs) - <- initRn dflags finder old_pcs hst loc (rename this_mod) ; - - -- Check for warnings - printErrorsAndWarnings (rn_warns_bag, rn_errs_bag) ; - - -- Dump any debugging output - dump_action ; - - -- Return results - if not (isEmptyBag rn_errs_bag) then - return (old_pcs, Nothing) - else - return (new_pcs, maybe_rn_stuff) - } +renameModule :: DynFlags -> GhciMode + -> HomeIfaceTable -> HomeSymbolTable + -> PersistentCompilerState + -> Module -> RdrNameHsModule + -> IO (PersistentCompilerState, PrintUnqualified, + Maybe (IsExported, ModIface, RnResult)) + -- Nothing => some error occurred in the renamer + +renameModule dflags ghci_mode hit hst pcs this_module rdr_module + = renameSource dflags hit hst pcs this_module $ + rename ghci_mode this_module rdr_module \end{code} \begin{code} -rename :: RdrNameHsModule -> RnMG (Maybe ModIface, IO ()) -rename this_mod@(HsModule mod_name vers exports imports local_decls mod_deprec loc) - = -- FIND THE GLOBAL NAME ENVIRONMENT - getGlobalNames this_mod `thenRn` \ maybe_stuff -> +renameStmt :: DynFlags + -> HomeIfaceTable -> HomeSymbolTable + -> PersistentCompilerState + -> InteractiveContext + -> RdrNameStmt -- parsed stmt + -> IO ( PersistentCompilerState, + PrintUnqualified, + Maybe ([Name], (RenamedStmt, [RenamedHsDecl])) + ) + +renameStmt dflags hit hst pcs ic stmt + = renameSource dflags hit hst pcs iNTERACTIVE $ + + -- load the context module + let InteractiveContext{ ic_rn_gbl_env = rdr_env, + ic_print_unqual = print_unqual, + ic_rn_local_env = local_rdr_env, + ic_type_env = type_env } = ic + in - -- CHECK FOR EARLY EXIT - case maybe_stuff of { - Nothing -> -- Everything is up to date; no need to recompile further - rnDump [] [] `thenRn` \ dump_action -> - returnRn (Nothing, dump_action) ; + extendTypeEnvRn type_env $ - Just (gbl_env, local_gbl_env, export_avails, global_avail_env, old_iface) -> + -- Rename the stmt + initRnMS rdr_env emptyAvailEnv local_rdr_env emptyLocalFixityEnv CmdLineMode ( + rnStmt stmt $ \ stmt' -> + returnRn (([], stmt'), emptyFVs) + ) `thenRn` \ ((binders, stmt), fvs) -> - -- DEAL WITH DEPRECATIONS - rnDeprecs local_gbl_env mod_deprec local_decls `thenRn` \ my_deprecs -> + -- Bale out if we fail + checkErrsRn `thenRn` \ no_errs_so_far -> + if not no_errs_so_far then + doDump dflags [] stmt [] `thenRn_` returnRn (print_unqual, Nothing) + else - -- DEAL WITH LOCAL FIXITIES - fixitiesFromLocalDecls local_gbl_env local_decls `thenRn` \ local_fixity_env -> + -- Add implicit free vars, and close decls + getImplicitStmtFVs `thenRn` \ implicit_fvs -> + slurpImpDecls (fvs `plusFV` implicit_fvs) `thenRn` \ decls -> + -- NB: an earlier version deleted (rdrEnvElts local_env) from + -- the fvs. But (a) that isn't necessary, because previously + -- bound things in the local_env will be in the TypeEnv, and + -- the renamer doesn't re-slurp such things, and + -- (b) it's WRONG to delete them. Consider in GHCi: + -- Mod> let x = e :: T + -- Mod> let y = x + 3 + -- We need to pass 'x' among the fvs to slurpImpDecls, so that + -- the latter can see that T is a gate, and hence import the Num T + -- instance decl. (See the InTypEnv case in RnIfaces.slurpSourceRefs.) + + doDump dflags binders stmt decls `thenRn_` + returnRn (print_unqual, Just (binders, (stmt, decls))) - -- RENAME THE SOURCE - initRnMS gbl_env local_fixity_env SourceMode ( - rnSourceDecls local_decls - ) `thenRn` \ (rn_local_decls, source_fvs) -> + where + doDump :: DynFlags -> [Name] -> RenamedStmt -> [RenamedHsDecl] + -> RnMG (Either IOError ()) + doDump dflags bndrs stmt decls + = ioToRnM (dumpIfSet_dyn dflags Opt_D_dump_rn "Renamer:" + (vcat [text "Binders:" <+> ppr bndrs, + ppr stmt, text "", + vcat (map ppr decls)])) + + +renameRdrName + :: DynFlags + -> HomeIfaceTable -> HomeSymbolTable + -> PersistentCompilerState + -> InteractiveContext + -> [RdrName] -- name to rename + -> IO ( PersistentCompilerState, + PrintUnqualified, + Maybe ([Name], [RenamedHsDecl]) + ) + +renameRdrName dflags hit hst pcs ic rdr_names = + renameSource dflags hit hst pcs iNTERACTIVE $ + + -- load the context module + let InteractiveContext{ ic_rn_gbl_env = rdr_env, + ic_print_unqual = print_unqual, + ic_rn_local_env = local_rdr_env, + ic_type_env = type_env } = ic + in - -- SLURP IN ALL THE NEEDED DECLARATIONS - implicitFVs mod_name rn_local_decls `thenRn` \ implicit_fvs -> - let - -- The export_fvs make the exported names look just as if they - -- occurred in the source program. For the reasoning, see the - -- comments with RnIfaces.getImportVersions. - -- We only need the 'parent name' of the avail; - -- that's enough to suck in the declaration. - export_fvs = mkNameSet (map availName export_avails) - real_source_fvs = source_fvs `plusFV` export_fvs + extendTypeEnvRn type_env $ - slurp_fvs = implicit_fvs `plusFV` real_source_fvs - -- It's important to do the "plus" this way round, so that - -- when compiling the prelude, locally-defined (), Bool, etc - -- override the implicit ones. + -- rename the rdr_name + initRnMS rdr_env emptyAvailEnv local_rdr_env emptyLocalFixityEnv CmdLineMode + (mapRn (tryRn.lookupOccRn) rdr_names) `thenRn` \ maybe_names -> + let + ok_names = [ a | Right a <- maybe_names ] in - loadBuiltinRules builtinRules `thenRn_` - slurpImpDecls slurp_fvs `thenRn` \ rn_imp_decls -> + if null ok_names + then let errs = head [ e | Left e <- maybe_names ] + in setErrsRn errs `thenRn_` + doDump dflags ok_names [] `thenRn_` + returnRn (print_unqual, Nothing) + else - -- EXIT IF ERRORS FOUND - rnDump rn_imp_decls rn_local_decls `thenRn` \ dump_action -> - checkErrsRn `thenRn` \ no_errs_so_far -> - if not no_errs_so_far then - -- Found errors already, so exit now - returnRn (Nothing, dump_action) - else + slurpImpDecls (mkNameSet ok_names) `thenRn` \ decls -> - -- GENERATE THE VERSION/USAGE INFO - mkImportExportInfo mod_name export_avails imports `thenRn` \ (my_exports, my_usages) -> + doDump dflags ok_names decls `thenRn_` + returnRn (print_unqual, Just (ok_names, decls)) + where + doDump :: DynFlags -> [Name] -> [RenamedHsDecl] -> RnMG (Either IOError ()) + doDump dflags names decls + = ioToRnM (dumpIfSet_dyn dflags Opt_D_dump_rn "Renamer:" + (vcat [ppr names, text "", + vcat (map ppr decls)])) +\end{code} - -- RETURN THE RENAMED MODULE - getNameSupplyRn `thenRn` \ name_supply -> - getIfacesRn `thenRn` \ ifaces -> +\begin{code} +renameExtCore :: DynFlags + -> HomeIfaceTable -> HomeSymbolTable + -> PersistentCompilerState + -> Module + -> RdrNameHsModule + -> IO (PersistentCompilerState, PrintUnqualified, + Maybe (IsExported, ModIface, [RenamedHsDecl])) + + -- Nothing => some error occurred in the renamer +renameExtCore dflags hit hst pcs this_module + rdr_module@(HsModule _ _ _ _ local_decls _ loc) + -- Rename the (Core) module + = renameSource dflags hit hst pcs this_module $ + pushSrcLocRn loc $ + + -- Rename the source + initIfaceRnMS this_module (rnExtCoreDecls local_decls) `thenRn` \ (rn_local_decls, binders, fvs) -> + recordLocalSlurps binders `thenRn_` + closeDecls rn_local_decls fvs `thenRn` \ final_decls -> + + -- Bail out if we fail + checkErrsRn `thenRn` \ no_errs_so_far -> + if not no_errs_so_far then + returnRn (print_unqualified, Nothing) + else + rnDump final_decls [] `thenRn_` let - direct_import_mods :: [Module] - direct_import_mods = [m | (_, _, Just (m, _, _, _, imp, _)) - <- eltsFM (iImpModInfo ifaces), user_import imp] - - -- *don't* just pick the forward edges. It's entirely possible - -- that a module is only reachable via back edges. - user_import ImportByUser = True - user_import ImportByUserSource = True - user_import _ = False - - this_module = mkModuleInThisPackage mod_name - - -- Export only those fixities that are for names that are - -- (a) defined in this module - -- (b) exported - exported_fixities - = mkNameEnv [ (name, fixity) - | FixitySig name fixity loc <- nameEnvElts local_fixity_env, - isUserExportedName name - ] - - mod_iface = ModIface { mi_module = this_module - mi_version = panic "mi_version: not filled in yet", - mi_orphan = any isOrphanDecl rn_local_decls, - mi_exports = my_exports, - mi_usages = my_usages, - mi_fixity = exported_fixities) - mi_deprecs = my_deprecs - mi_decls = rn_local_decls ++ rn_imp_decls + mod_iface = ModIface { mi_module = this_module, + mi_package = opt_InPackage, + mi_version = initialVersionInfo, + mi_usages = [], + mi_boot = False, + mi_orphan = panic "is_orphan", + -- ToDo: export the data types also. + mi_exports = [(moduleName this_module, + map Avail (nameSetToList binders))], + mi_globals = Nothing, + mi_fixities = mkNameEnv [], + mi_deprecs = NoDeprecs, + mi_decls = panic "mi_decls" } - in - -- REPORT UNUSED NAMES, AND DEBUG DUMP - reportUnusedNames mod_name direct_import_mods - gbl_env global_avail_env - export_avails source_fvs - rn_imp_decls `thenRn_` + is_exported _ = True + in + returnRn (print_unqualified, Just (is_exported, mod_iface, final_decls)) - returnRn (Just mod_iface, dump_action) } where - trashed_exports = {-trace "rnSource:trashed_exports"-} Nothing - trashed_imports = {-trace "rnSource:trashed_imports"-} [] -\end{code} - -@implicitFVs@ forces the renamer to slurp in some things which aren't -mentioned explicitly, but which might be needed by the type checker. - -\begin{code} -implicitFVs mod_name decls - = lookupOrigNames implicit_occs `thenRn` \ implicit_names -> - returnRn (mkNameSet (map getName default_tycons) `plusFV` - implicit_names) - where - -- Add occurrences for Int, and (), because they - -- are the types to which ambigious type variables may be defaulted by - -- the type checker; so they won't always appear explicitly. - -- [The () one is a GHC extension for defaulting CCall results.] - -- ALSO: funTyCon, since it occurs implicitly everywhere! - -- (we don't want to be bothered with making funTyCon a - -- free var at every function application!) - -- Double is dealt with separately in getGates - default_tycons = [unitTyCon, funTyCon, boolTyCon, intTyCon] - - -- Add occurrences for IO or PrimIO - implicit_main | mod_name == mAIN_Name - || mod_name == pREL_MAIN_Name = [ioTyCon_RDR] - | otherwise = [] - - -- Now add extra "occurrences" for things that - -- the deriving mechanism, or defaulting, will later need in order to - -- generate code - implicit_occs = string_occs ++ foldr ((++) . get) implicit_main decls - - -- Virtually every program has error messages in it somewhere - string_occs = [unpackCString_RDR, unpackCStringFoldr_RDR, unpackCStringUtf8_RDR, - eqString_RDR] - - get (TyClD (TyData _ _ _ _ _ _ (Just deriv_classes) _ _ _ _)) - = concat (map get_deriv deriv_classes) - get other = [] - - get_deriv cls = case lookupUFM derivingOccurrences cls of - Nothing -> [] - Just occs -> occs -\end{code} + print_unqualified = const False -- print everything qualified. -\begin{code} -isOrphanDecl (InstD (InstDecl inst_ty _ _ _ _)) - = not (foldNameSet ((||) . isLocallyDefined) False (extractHsTyNames (removeContext inst_ty))) - -- The 'removeContext' is because of - -- instance Foo a => Baz T where ... - -- The decl is an orphan if Baz and T are both not locally defined, - -- even if Foo *is* locally defined - -isOrphanDecl (RuleD (HsRule _ _ _ lhs _ _)) - = check lhs - where - -- At the moment we just check for common LHS forms - -- Expand as necessary. Getting it wrong just means - -- more orphans than necessary - check (HsVar v) = not (isLocallyDefined v) - check (HsApp f a) = check f && check a - check (HsLit _) = False - check (HsOverLit _) = False - check (OpApp l o _ r) = check l && check o && check r - check (NegApp e _) = check e - check (HsPar e) = check e - check (SectionL e o) = check e && check o - check (SectionR o e) = check e && check o - - check other = True -- Safe fall through - -isOrphanDecl other = False -\end{code} +rnExtCoreDecls :: [RdrNameHsDecl] + -> RnMS ([RenamedHsDecl], + NameSet, -- Binders + FreeVars) -- Free variables -\begin{code} -dupDefaultDeclErrRn (DefaultDecl _ locn1 : dup_things) - = pushSrcLocRn locn1 $ - addErrRn msg +rnExtCoreDecls decls + -- Renaming external-core decls is rather like renaming an interface file + -- All the decls are TyClDecls, and all the names are original names + = go [] emptyNameSet emptyNameSet decls where - msg = hang (ptext SLIT("Multiple default declarations")) - 4 (vcat (map pp dup_things)) - pp (DefaultDecl _ locn) = ptext SLIT("here was another default declaration") <+> ppr locn + go rn_decls bndrs fvs [] = returnRn (rn_decls, bndrs, fvs) + + go rn_decls bndrs fvs (TyClD decl : decls) + = rnTyClDecl decl `thenRn` \ rn_decl -> + go (TyClD rn_decl : rn_decls) + (addListToNameSet bndrs (map fst (tyClDeclSysNames rn_decl ++ tyClDeclNames rn_decl))) + (fvs `plusFV` tyClDeclFVs rn_decl) + decls + + go rn_decls bndrs fvs (decl : decls) + = addErrRn (text "Unexpected decl in ExtCore file" $$ ppr decl) `thenRn_` + go rn_decls bndrs fvs decls \end{code} %********************************************************* %* * -\subsection{Slurping declarations} +\subsection{Make up an interactive context} %* * %********************************************************* \begin{code} -------------------------------------------------------- -slurpImpDecls source_fvs - = traceRn (text "slurpImp" <+> fsep (map ppr (nameSetToList source_fvs))) `thenRn_` - - -- The current slurped-set records all local things - getSlurped `thenRn` \ source_binders -> - slurpSourceRefs source_binders source_fvs `thenRn` \ (decls, needed) -> - - -- Then get everything else - closeDecls decls needed `thenRn` \ decls1 -> - - -- Finally, get any deferred data type decls - slurpDeferredDecls decls1 `thenRn` \ final_decls -> - - returnRn final_decls - -------------------------------------------------------- -slurpSourceRefs :: NameSet -- Variables defined in source - -> FreeVars -- Variables referenced in source - -> RnMG ([RenamedHsDecl], - FreeVars) -- Un-satisfied needs --- The declaration (and hence home module) of each gate has --- already been loaded - -slurpSourceRefs source_binders source_fvs - = go_outer [] -- Accumulating decls - emptyFVs -- Unsatisfied needs - emptyFVs -- Accumulating gates - (nameSetToList source_fvs) -- Things whose defn hasn't been loaded yet - where - -- The outer loop repeatedly slurps the decls for the current gates - -- and the instance decls +mkGlobalContext + :: DynFlags -> HomeIfaceTable -> HomeSymbolTable + -> PersistentCompilerState + -> [Module] -> [Module] + -> IO (PersistentCompilerState, PrintUnqualified, Maybe GlobalRdrEnv) +mkGlobalContext dflags hit hst pcs toplevs exports + = renameSource dflags hit hst pcs iNTERACTIVE $ + + mapRn getTopLevScope toplevs `thenRn` \ toplev_envs -> + mapRn getModuleExports exports `thenRn` \ export_envs -> + let full_env = foldr plusGlobalRdrEnv emptyRdrEnv + (toplev_envs ++ export_envs) + print_unqual = unQualInScope full_env + in + checkErrsRn `thenRn` \ no_errs_so_far -> + if not no_errs_so_far then + returnRn (print_unqual, Nothing) + else + returnRn (print_unqual, Just full_env) - -- The outer loop is needed because consider - -- instance Foo a => Baz (Maybe a) where ... - -- It may be that @Baz@ and @Maybe@ are used in the source module, - -- but not @Foo@; so we need to chase @Foo@ too. - -- - -- We also need to follow superclass refs. In particular, 'chasing @Foo@' must - -- include actually getting in Foo's class decl - -- class Wib a => Foo a where .. - -- so that its superclasses are discovered. The point is that Wib is a gate too. - -- We do this for tycons too, so that we look through type synonyms. - - go_outer decls fvs all_gates [] - = returnRn (decls, fvs) - - go_outer decls fvs all_gates refs -- refs are not necessarily slurped yet - = traceRn (text "go_outer" <+> ppr refs) `thenRn_` - foldlRn go_inner (decls, fvs, emptyFVs) refs `thenRn` \ (decls1, fvs1, gates1) -> - getImportedInstDecls (all_gates `plusFV` gates1) `thenRn` \ inst_decls -> - rnInstDecls decls1 fvs1 gates1 inst_decls `thenRn` \ (decls2, fvs2, gates2) -> - go_outer decls2 fvs2 (all_gates `plusFV` gates2) - (nameSetToList (gates2 `minusNameSet` all_gates)) - -- Knock out the all_gates because even if we don't slurp any new - -- decls we can get some apparently-new gates from wired-in names - - go_inner (decls, fvs, gates) wanted_name - = importDecl wanted_name `thenRn` \ import_result -> - case import_result of - AlreadySlurped -> returnRn (decls, fvs, gates) - WiredIn -> returnRn (decls, fvs, gates `plusFV` getWiredInGates wanted_name) - Deferred -> returnRn (decls, fvs, gates `addOneFV` wanted_name) -- It's a type constructor - - HereItIs decl -> rnIfaceDecl decl `thenRn` \ (new_decl, fvs1) -> - returnRn (new_decl : decls, - fvs1 `plusFV` fvs, - gates `plusFV` getGates source_fvs new_decl) - -rnInstDecls decls fvs gates [] - = returnRn (decls, fvs, gates) -rnInstDecls decls fvs gates (d:ds) - = rnIfaceDecl d `thenRn` \ (new_decl, fvs1) -> - rnInstDecls (new_decl:decls) - (fvs1 `plusFV` fvs) - (gates `plusFV` getInstDeclGates new_decl) - ds -\end{code} +contextDoc = text "context for compiling statements" +getTopLevScope :: Module -> RnM d GlobalRdrEnv +getTopLevScope mod = + loadInterface contextDoc (moduleName mod) ImportByUser `thenRn` \ iface -> + case mi_globals iface of + Nothing -> panic "getTopLevScope" + Just env -> returnRn env -\begin{code} -------------------------------------------------------- --- closeDecls keeps going until the free-var set is empty -closeDecls decls needed - | not (isEmptyFVs needed) - = slurpDecls decls needed `thenRn` \ (decls1, needed1) -> - closeDecls decls1 needed1 - - | otherwise - = getImportedRules `thenRn` \ rule_decls -> - case rule_decls of - [] -> returnRn decls -- No new rules, so we are done - other -> rnIfaceDecls decls emptyFVs rule_decls `thenRn` \ (decls1, needed1) -> - closeDecls decls1 needed1 - - -------------------------------------------------------- --- Augment decls with any decls needed by needed. --- Return also free vars of the new decls (only) -slurpDecls decls needed - = go decls emptyFVs (nameSetToList needed) +getModuleExports :: Module -> RnM d GlobalRdrEnv +getModuleExports mod = + loadInterface contextDoc (moduleName mod) ImportByUser `thenRn` \ iface -> + returnRn (foldl add emptyRdrEnv (mi_exports iface)) where - go decls fvs [] = returnRn (decls, fvs) - go decls fvs (ref:refs) = slurpDecl decls fvs ref `thenRn` \ (decls1, fvs1) -> - go decls1 fvs1 refs - -------------------------------------------------------- -slurpDecl decls fvs wanted_name - = importDecl wanted_name `thenRn` \ import_result -> - case import_result of - -- Found a declaration... rename it - HereItIs decl -> rnIfaceDecl decl `thenRn` \ (new_decl, fvs1) -> - returnRn (new_decl:decls, fvs1 `plusFV` fvs) - - -- No declaration... (wired in thing, or deferred, or already slurped) - other -> returnRn (decls, fvs) - - -------------------------------------------------------- -rnIfaceDecls :: [RenamedHsDecl] -> FreeVars - -> [(Module, RdrNameHsDecl)] - -> RnM d ([RenamedHsDecl], FreeVars) -rnIfaceDecls decls fvs [] = returnRn (decls, fvs) -rnIfaceDecls decls fvs (d:ds) = rnIfaceDecl d `thenRn` \ (new_decl, fvs1) -> - rnIfaceDecls (new_decl:decls) (fvs1 `plusFV` fvs) ds - -rnIfaceDecl (mod, decl) = initIfaceRnMS mod (rnDecl decl) + prov_fn n = NonLocalDef ImplicitImport + add env (mod,avails) = + plusGlobalRdrEnv env (mkGlobalRdrEnv mod True prov_fn avails NoDeprecs) \end{code} - %********************************************************* %* * -\subsection{Deferred declarations} +\subsection{Slurp in a whole module eagerly} %* * %********************************************************* -The idea of deferred declarations is this. Suppose we have a function - f :: T -> Int - data T = T1 A | T2 B - data A = A1 X | A2 Y - data B = B1 P | B2 Q -Then we don't want to load T and all its constructors, and all -the types those constructors refer to, and all the types *those* -constructors refer to, and so on. That might mean loading many more -interface files than is really necessary. So we 'defer' loading T. - -But f might be strict, and the calling convention for evaluating -values of type T depends on how many constructors T has, so -we do need to load T, but not the full details of the type T. -So we load the full decl for T, but only skeleton decls for A and B: - f :: T -> Int - data T = {- 2 constructors -} - -Whether all this is worth it is moot. - \begin{code} -slurpDeferredDecls :: [RenamedHsDecl] -> RnMG [RenamedHsDecl] -slurpDeferredDecls decls - = getDeferredDecls `thenRn` \ def_decls -> - rnIfaceDecls decls emptyFVs (map stripDecl def_decls) `thenRn` \ (decls1, fvs) -> - ASSERT( isEmptyFVs fvs ) - returnRn decls1 - -stripDecl (mod, TyClD (TyData dt _ tc tvs _ nconstrs _ _ loc name1 name2)) - = (mod, TyClD (TyData dt [] tc tvs [] nconstrs Nothing NoDataPragmas loc - name1 name2)) - -- Nuke the context and constructors - -- But retain the *number* of constructors! - -- Also the tvs will have kinds on them. +slurpIface + :: DynFlags -> HomeIfaceTable -> HomeSymbolTable + -> PersistentCompilerState -> Module + -> IO (PersistentCompilerState, PrintUnqualified, + Maybe ([Name], [RenamedHsDecl])) +slurpIface dflags hit hst pcs mod = + renameSource dflags hit hst pcs iNTERACTIVE $ + + let mod_name = moduleName mod + in + loadInterface contextDoc mod_name ImportByUser `thenRn` \ iface -> + let fvs = availsToNameSet [ avail | (mn,avails) <- mi_exports iface, + avail <- avails ] + in + slurpImpDecls fvs `thenRn` \ rn_imp_decls -> + returnRn (alwaysQualify, Just (nameSetToList fvs, rn_imp_decls)) \end{code} - %********************************************************* %* * -\subsection{Extracting the `gates'} +\subsection{The main function: rename} %* * %********************************************************* -When we import a declaration like -\begin{verbatim} - data T = T1 Wibble | T2 Wobble -\end{verbatim} -we don't want to treat @Wibble@ and @Wobble@ as gates -{\em unless} @T1@, @T2@ respectively are mentioned by the user program. -If only @T@ is mentioned -we want only @T@ to be a gate; -that way we don't suck in useless instance -decls for (say) @Eq Wibble@, when they can't possibly be useful. - -@getGates@ takes a newly imported (and renamed) decl, and the free -vars of the source program, and extracts from the decl the gate names. +\begin{code} +renameSource :: DynFlags + -> HomeIfaceTable -> HomeSymbolTable + -> PersistentCompilerState + -> Module + -> RnMG (PrintUnqualified, Maybe r) + -> IO (PersistentCompilerState, PrintUnqualified, Maybe r) + -- Nothing => some error occurred in the renamer + +renameSource dflags hit hst old_pcs this_module thing_inside + = do { showPass dflags "Renamer" + + -- Initialise the renamer monad + ; (new_pcs, msgs, (print_unqual, maybe_rn_stuff)) + <- initRn dflags hit hst old_pcs this_module thing_inside + + -- Print errors from renaming + ; printErrorsAndWarnings print_unqual msgs ; + + -- Return results. No harm in updating the PCS + ; if errorsFound msgs then + return (new_pcs, print_unqual, Nothing) + else + return (new_pcs, print_unqual, maybe_rn_stuff) + } +\end{code} \begin{code} -getGates source_fvs (SigD (IfaceSig _ ty _ _)) - = extractHsTyNames ty - -getGates source_fvs (TyClD (ClassDecl ctxt cls tvs _ sigs _ _ _ _ )) - = (delListFromNameSet (foldr (plusFV . get) (extractHsCtxtTyNames ctxt) sigs) - (hsTyVarNames tvs) - `addOneToNameSet` cls) - `plusFV` maybe_double - where - get (ClassOpSig n _ ty _) - | n `elemNameSet` source_fvs = extractHsTyNames ty - | otherwise = emptyFVs - - -- If we load any numeric class that doesn't have - -- Int as an instance, add Double to the gates. - -- This takes account of the fact that Double might be needed for - -- defaulting, but we don't want to load Double (and all its baggage) - -- if the more exotic classes aren't used at all. - maybe_double | nameUnique cls `elem` fractionalClassKeys - = unitFV (getName doubleTyCon) - | otherwise - = emptyFVs - -getGates source_fvs (TyClD (TySynonym tycon tvs ty _)) - = delListFromNameSet (extractHsTyNames ty) - (hsTyVarNames tvs) - -- A type synonym type constructor isn't a "gate" for instance decls - -getGates source_fvs (TyClD (TyData _ ctxt tycon tvs cons _ _ _ _ _ _)) - = delListFromNameSet (foldr (plusFV . get) (extractHsCtxtTyNames ctxt) cons) - (hsTyVarNames tvs) - `addOneToNameSet` tycon - where - get (ConDecl n _ tvs ctxt details _) - | n `elemNameSet` source_fvs - -- If the constructor is method, get fvs from all its fields - = delListFromNameSet (get_details details `plusFV` - extractHsCtxtTyNames ctxt) - (hsTyVarNames tvs) - get (ConDecl n _ tvs ctxt (RecCon fields) _) - -- Even if the constructor isn't mentioned, the fields - -- might be, as selectors. They can't mention existentially - -- bound tyvars (typechecker checks for that) so no need for - -- the deleteListFromNameSet part - = foldr (plusFV . get_field) emptyFVs fields +data RnResult -- A RenamedModule ia passed from renamer to typechecker + = RnResult { rr_mod :: Module, -- Same as in the ModIface, + rr_fixities :: FixityEnv, -- but convenient to have it here + + rr_main :: Maybe Name, -- Just main, for module Main, + -- Nothing for other modules + + rr_decls :: [RenamedHsDecl] + -- The other declarations of the module + -- Fixity and deprecations have already been slurped out + } -- and are now in the ModIface for the module + +rename :: GhciMode -> Module -> RdrNameHsModule + -> RnMG (PrintUnqualified, Maybe (IsExported, ModIface, RnResult)) +rename ghci_mode this_module + contents@(HsModule _ _ exports imports local_decls mod_deprec loc) + = pushSrcLocRn loc $ + + -- FIND THE GLOBAL NAME ENVIRONMENT + getGlobalNames this_module contents `thenRn` \ (gbl_env, local_gbl_env, + (mod_avail_env, global_avail_env)) -> + let + print_unqualified = unQualInScope gbl_env + + full_avail_env :: NameEnv AvailInfo + -- The domain of global_avail_env is just the 'major' things; + -- variables, type constructors, classes. + -- E.g. Functor |-> Functor( Functor, fmap ) + -- The domain of full_avail_env is everything in scope + -- E.g. Functor |-> Functor( Functor, fmap ) + -- fmap |-> Functor( Functor, fmap ) + -- + -- This filled-out avail_env is needed to generate + -- exports (mkExportAvails), and for generating minimal + -- exports (reportUnusedNames) + full_avail_env = mkNameEnv [ (name,avail) + | avail <- availEnvElts global_avail_env, + name <- availNames avail] + in + -- Exit if we've found any errors + checkErrsRn `thenRn` \ no_errs_so_far -> + if not no_errs_so_far then + -- Found errors already, so exit now + rnDump [] [] `thenRn_` + returnRn (print_unqualified, Nothing) + else + + -- PROCESS EXPORT LIST + exportsFromAvail mod_name exports mod_avail_env + full_avail_env gbl_env `thenRn` \ export_avails -> - get other_con = emptyFVs + traceRn (text "Local top-level environment" $$ + nest 4 (pprGlobalRdrEnv local_gbl_env)) `thenRn_` - get_details (VanillaCon tys) = plusFVs (map get_bang tys) - get_details (InfixCon t1 t2) = get_bang t1 `plusFV` get_bang t2 - get_details (RecCon fields) = plusFVs [get_bang t | (_, t) <- fields] + -- DEAL WITH DEPRECATIONS + rnDeprecs local_gbl_env mod_deprec + [d | DeprecD d <- local_decls] `thenRn` \ my_deprecs -> - get_field (fs,t) | any (`elemNameSet` source_fvs) fs = get_bang t - | otherwise = emptyFVs + -- DEAL WITH LOCAL FIXITIES + fixitiesFromLocalDecls local_gbl_env local_decls `thenRn` \ local_fixity_env -> - get_bang bty = extractHsTyNames (getBangType bty) + -- RENAME THE SOURCE + rnSourceDecls gbl_env global_avail_env + local_fixity_env SourceMode local_decls `thenRn` \ (rn_local_decls, source_fvs) -> -getGates source_fvs other_decl = emptyFVs -\end{code} + -- GET ANY IMPLICIT FREE VARIALBES + getImplicitModuleFVs rn_local_decls `thenRn` \ implicit_fvs -> + checkMain ghci_mode mod_name gbl_env `thenRn` \ (maybe_main_name, main_fvs, implicit_main_fvs) -> + let + export_fvs = availsToNameSet export_avails + used_fvs = source_fvs `plusFV` export_fvs `plusFV` main_fvs + -- The export_fvs make the exported names look just as if they + -- occurred in the source program. For the reasoning, see the + -- comments with RnIfaces.mkImportInfo + -- It also helps reportUnusedNames, which of course must not complain + -- that 'f' isn't mentioned if it is mentioned in the export list -@getWiredInGates@ is just like @getGates@, but it sees a wired-in @Name@ -rather than a declaration. + needed_fvs = implicit_fvs `plusFV` implicit_main_fvs `plusFV` used_fvs + -- It's important to do the "plus" this way round, so that + -- when compiling the prelude, locally-defined (), Bool, etc + -- override the implicit ones. -\begin{code} -getWiredInGates :: Name -> FreeVars -getWiredInGates name -- No classes are wired in - | is_id = getWiredInGates_s (namesOfType (idType the_id)) - | isSynTyCon the_tycon = getWiredInGates_s - (delListFromNameSet (namesOfType ty) (map getName tyvars)) - | otherwise = unitFV name + in + traceRn (text "Needed FVs:" <+> fsep (map ppr (nameSetToList needed_fvs))) `thenRn_` + + -- EXIT IF ERRORS FOUND + -- We exit here if there are any errors in the source, *before* + -- we attempt to slurp the decls from the interfaces, otherwise + -- the slurped decls may get lost when we return up the stack + -- to hscMain/hscExpr. + checkErrsRn `thenRn` \ no_errs_so_far -> + if not no_errs_so_far then + -- Found errors already, so exit now + rnDump [] rn_local_decls `thenRn_` + returnRn (print_unqualified, Nothing) + else + + -- SLURP IN ALL THE NEEDED DECLARATIONS + slurpImpDecls needed_fvs `thenRn` \ rn_imp_decls -> + rnDump rn_imp_decls rn_local_decls `thenRn_` + + -- GENERATE THE VERSION/USAGE INFO + mkImportInfo mod_name imports `thenRn` \ my_usages -> + + -- BUILD THE MODULE INTERFACE + let + -- We record fixities even for things that aren't exported, + -- so that we can change into the context of this moodule easily + fixities = mkNameEnv [ (name, fixity) + | FixitySig name fixity loc <- nameEnvElts local_fixity_env + ] + + -- Sort the exports to make them easier to compare for versions + my_exports = groupAvails this_module export_avails + + final_decls = rn_local_decls ++ rn_imp_decls + + -- In interactive mode, we don't want to discard any top-level + -- entities at all (eg. do not inline them away during + -- simplification), and retain them all in the TypeEnv so they are + -- available from the command line. + -- + -- isExternalName separates the user-defined top-level names from those + -- introduced by the type checker. + dont_discard :: Name -> Bool + dont_discard | ghci_mode == Interactive = isExternalName + | otherwise = (`elemNameSet` exported_names) + + exported_names = availsToNameSet export_avails + + mod_iface = ModIface { mi_module = this_module, + mi_package = opt_InPackage, + mi_version = initialVersionInfo, + mi_usages = my_usages, + mi_boot = False, + mi_orphan = panic "is_orphan", + mi_exports = my_exports, + mi_globals = Just gbl_env, + mi_fixities = fixities, + mi_deprecs = my_deprecs, + mi_decls = panic "mi_decls" + } + + rn_result = RnResult { rr_mod = this_module, + rr_fixities = fixities, + rr_decls = final_decls, + rr_main = maybe_main_name } + in + + -- REPORT UNUSED NAMES, AND DEBUG DUMP + reportUnusedNames mod_iface print_unqualified + imports full_avail_env gbl_env + used_fvs rn_imp_decls `thenRn_` + -- NB: used_fvs: include exports (else we get bogus + -- warnings of unused things) but not implicit FVs. + + returnRn (print_unqualified, Just (dont_discard, mod_iface, rn_result)) where - maybe_wired_in_id = maybeWiredInIdName name - is_id = maybeToBool maybe_wired_in_id - maybe_wired_in_tycon = maybeWiredInTyConName name - Just the_id = maybe_wired_in_id - Just the_tycon = maybe_wired_in_tycon - (tyvars,ty) = getSynTyConDefn the_tycon - -getWiredInGates_s names = foldr (plusFV . getWiredInGates) emptyFVs (nameSetToList names) + mod_name = moduleName this_module \end{code} -\begin{code} -getInstDeclGates (InstD (InstDecl inst_ty _ _ _ _)) = extractHsTyNames inst_ty -getInstDeclGates other = emptyFVs -\end{code} %********************************************************* @@ -594,41 +553,33 @@ getInstDeclGates other = emptyFVs %********************************************************* \begin{code} -fixitiesFromLocalDecls :: GlobalRdrEnv -> [RdrNameHsDecl] -> RnMG FixityEnv +fixitiesFromLocalDecls :: GlobalRdrEnv -> [RdrNameHsDecl] -> RnMG LocalFixityEnv fixitiesFromLocalDecls gbl_env decls - = doptRn Opt_WarnUnusedBinds `thenRn` \ warn_unused -> - foldlRn (getFixities warn_unused) emptyNameEnv decls `thenRn` \ env -> - traceRn (text "fixity env" <+> vcat (map ppr (nameEnvElts env))) - `thenRn_` + = foldlRn getFixities emptyNameEnv decls `thenRn` \ env -> + traceRn (text "fixity env" <+> vcat (map ppr (nameEnvElts env))) `thenRn_` returnRn env where - getFixities :: Bool -> FixityEnv -> RdrNameHsDecl -> RnMG FixityEnv - getFixities warn_uu acc (FixD fix) - = fix_decl warn_uu acc fix + getFixities :: LocalFixityEnv -> RdrNameHsDecl -> RnMG LocalFixityEnv + getFixities acc (FixD fix) + = fix_decl acc fix - getFixities warn_uu acc (TyClD (ClassDecl _ _ _ _ sigs _ _ _ _ )) - = foldlRn (fix_decl warn_uu) acc [sig | FixSig sig <- sigs] + getFixities acc (TyClD (ClassDecl { tcdSigs = sigs})) + = foldlRn fix_decl acc [sig | FixSig sig <- sigs] -- Get fixities from class decl sigs too. - getFixities warn_uu acc other_decl + getFixities acc other_decl = returnRn acc - fix_decl warn_uu acc sig@(FixitySig rdr_name fixity loc) + fix_decl acc sig@(FixitySig rdr_name fixity loc) = -- Check for fixity decl for something not declared - case lookupRdrEnv gbl_env rdr_name of { - Nothing | warn_uu - -> pushSrcLocRn loc (addWarnRn (unusedFixityDecl rdr_name fixity)) - `thenRn_` returnRn acc - | otherwise -> returnRn acc ; - - Just ((name,_):_) -> + pushSrcLocRn loc $ + lookupSrcName gbl_env rdr_name `thenRn` \ name -> -- Check for duplicate fixity decl - case lookupNameEnv acc name of { - Just (FixitySig _ _ loc') -> addErrRn (dupFixityDecl rdr_name loc loc') - `thenRn_` returnRn acc ; + case lookupNameEnv acc name of + Just (FixitySig _ _ loc') -> addErrRn (dupFixityDecl rdr_name loc loc') `thenRn_` + returnRn acc ; - Nothing -> returnRn (extendNameEnv acc name (FixitySig name fixity loc)) - }} + Nothing -> returnRn (extendNameEnv acc name (FixitySig name fixity loc)) \end{code} @@ -644,168 +595,361 @@ gather them together. \begin{code} rnDeprecs :: GlobalRdrEnv -> Maybe DeprecTxt - -> [RdrNameHsDecl] -> RnMG [RdrNameDeprecation] -rnDeprecs gbl_env mod_deprec decls - = mapRn rn_deprec deprecs `thenRn_` - returnRn (extra_deprec ++ deprecs) + -> [RdrNameDeprecation] -> RnMG Deprecations +rnDeprecs gbl_env Nothing [] + = returnRn NoDeprecs + +rnDeprecs gbl_env (Just txt) decls + = mapRn (addErrRn . badDeprec) decls `thenRn_` + returnRn (DeprecAll txt) + +rnDeprecs gbl_env Nothing decls + = mapRn rn_deprec decls `thenRn` \ pairs -> + returnRn (DeprecSome (mkNameEnv (catMaybes pairs))) where - deprecs = [d | DeprecD d <- decls] - extra_deprec = case mod_deprec of - Nothing -> [] - Just txt -> [Deprecation (IEModuleContents undefined) txt noSrcLoc] - - rn_deprec (Deprecation ie txt loc) - = pushSrcLocRn loc $ - mapRn check (ieNames ie) - - check n = case lookupRdrEnv gbl_env n of - Nothing -> addErrRn (unknownNameErr n) - Just _ -> returnRn () + rn_deprec (Deprecation rdr_name txt loc) + = pushSrcLocRn loc $ + lookupSrcName gbl_env rdr_name `thenRn` \ name -> + returnRn (Just (name, (name,txt))) +\end{code} + + +%************************************************************************ +%* * +\subsection{Grabbing the old interface file and checking versions} +%* * +%************************************************************************ + +\begin{code} +checkOldIface :: GhciMode + -> DynFlags + -> HomeIfaceTable -> HomeSymbolTable + -> PersistentCompilerState + -> Module + -> FilePath + -> Bool -- Source unchanged + -> Maybe ModIface -- Old interface from compilation manager, if any + -> IO (PersistentCompilerState, Bool, (RecompileRequired, Maybe ModIface)) + -- True <=> errors happened + +checkOldIface ghci_mode dflags hit hst pcs mod iface_path source_unchanged maybe_iface + = runRn dflags hit hst pcs (panic "Bogus module") $ + + -- CHECK WHETHER THE SOURCE HAS CHANGED + ( if not source_unchanged then + traceHiDiffsRn (nest 4 (text "Source file changed or recompilation check turned off")) + else returnRn () ) `thenRn_` + + -- If the source has changed and we're in interactive mode, avoid reading + -- an interface; just return the one we might have been supplied with. + if ghci_mode == Interactive && not source_unchanged then + returnRn (outOfDate, maybe_iface) + else + + setModuleRn mod $ + case maybe_iface of + Just old_iface -> -- Use the one we already have + check_versions old_iface + + Nothing -- try and read it from a file + -> readIface iface_path `thenRn` \ read_result -> + case read_result of + Left err -> -- Old interface file not found, or garbled; give up + traceHiDiffsRn ( + text "Cannot read old interface file:" + $$ nest 4 err) `thenRn_` + returnRn (outOfDate, Nothing) + + Right parsed_iface -> + let read_mod_name = pi_mod parsed_iface + wanted_mod_name = moduleName mod + in + if (wanted_mod_name /= read_mod_name) then + traceHiDiffsRn ( + text "Existing interface file has wrong module name: " + <> quotes (ppr read_mod_name) + ) `thenRn_` + returnRn (outOfDate, Nothing) + else + loadOldIface mod parsed_iface `thenRn` \ m_iface -> + check_versions m_iface + where + check_versions :: ModIface -> RnMG (RecompileRequired, Maybe ModIface) + check_versions iface + | not source_unchanged + = returnRn (outOfDate, Just iface) + | otherwise + = -- Check versions + recompileRequired iface_path iface `thenRn` \ recompile -> + returnRn (recompile, Just iface) \end{code} +I think the following function should now have a more representative name, +but what? + +\begin{code} +loadOldIface :: Module -> ParsedIface -> RnMG ModIface + +loadOldIface mod parsed_iface + = let iface = parsed_iface + in + initIfaceRnMS mod ( + loadHomeDecls (pi_decls iface) `thenRn` \ decls -> + loadHomeRules (pi_rules iface) `thenRn` \ rules -> + loadHomeInsts (pi_insts iface) `thenRn` \ insts -> + returnRn (decls, rules, insts) + ) + `thenRn` \ ((decls_vers, new_decls), (rule_vers, new_rules), new_insts) -> + + mapRn loadHomeUsage (pi_usages iface) `thenRn` \ usages -> + loadExports (pi_exports iface) `thenRn` \ (export_vers, avails) -> + loadFixDecls mod (pi_fixity iface) `thenRn` \ fix_env -> + loadDeprecs mod (pi_deprecs iface) `thenRn` \ deprec_env -> + let + version = VersionInfo { vers_module = pi_vers iface, + vers_exports = export_vers, + vers_rules = rule_vers, + vers_decls = decls_vers } + + decls = mkIfaceDecls new_decls new_rules new_insts + + mod_iface = ModIface { mi_module = mod, mi_package = pi_pkg parsed_iface, + mi_version = version, + mi_exports = avails, mi_usages = usages, + mi_boot = False, mi_orphan = pi_orphan iface, + mi_fixities = fix_env, mi_deprecs = deprec_env, + mi_decls = decls, + mi_globals = Nothing + } + in + returnRn mod_iface +\end{code} + +\begin{code} +loadHomeDecls :: [(Version, RdrNameTyClDecl)] + -> RnMS (NameEnv Version, [RenamedTyClDecl]) +loadHomeDecls decls = foldlRn loadHomeDecl (emptyNameEnv, []) decls + +loadHomeDecl :: (NameEnv Version, [RenamedTyClDecl]) + -> (Version, RdrNameTyClDecl) + -> RnMS (NameEnv Version, [RenamedTyClDecl]) +loadHomeDecl (version_map, decls) (version, decl) + = rnTyClDecl decl `thenRn` \ decl' -> + returnRn (extendNameEnv version_map (tyClDeclName decl') version, decl':decls) + +------------------ +loadHomeRules :: (Version, [RdrNameRuleDecl]) + -> RnMS (Version, [RenamedRuleDecl]) +loadHomeRules (version, rules) + = mapRn rnIfaceRuleDecl rules `thenRn` \ rules' -> + returnRn (version, rules') + +------------------ +loadHomeInsts :: [RdrNameInstDecl] + -> RnMS [RenamedInstDecl] +loadHomeInsts insts = mapRn rnInstDecl insts + +------------------ +loadHomeUsage :: ImportVersion OccName + -> RnMG (ImportVersion Name) +loadHomeUsage (mod_name, orphans, is_boot, whats_imported) + = rn_imps whats_imported `thenRn` \ whats_imported' -> + returnRn (mod_name, orphans, is_boot, whats_imported') + where + rn_imps NothingAtAll = returnRn NothingAtAll + rn_imps (Everything v) = returnRn (Everything v) + rn_imps (Specifically mv ev items rv) = mapRn rn_imp items `thenRn` \ items' -> + returnRn (Specifically mv ev items' rv) + rn_imp (occ,vers) = newGlobalName mod_name occ `thenRn` \ name -> + returnRn (name,vers) +\end{code} + + %********************************************************* %* * -\subsection{Unused names} +\subsection{Closing up the interface decls} %* * %********************************************************* +Suppose we discover we don't need to recompile. Then we start from the +IfaceDecls in the ModIface, and fluff them up by sucking in all the decls they need. + \begin{code} -reportUnusedNames :: ModuleName -> [Module] - -> GlobalRdrEnv -> AvailEnv - -> Avails -> NameSet -> [RenamedHsDecl] - -> RnMG () -reportUnusedNames mod_name direct_import_mods - gbl_env avail_env - export_avails mentioned_names - imported_decls - = let - used_names = mentioned_names `unionNameSets` availsToNameSet export_avails - - -- Now, a use of C implies a use of T, - -- if C was brought into scope by T(..) or T(C) - really_used_names = used_names `unionNameSets` - mkNameSet [ availName parent_avail - | sub_name <- nameSetToList used_names - , isValOcc (getOccName sub_name) - - -- Usually, every used name will appear in avail_env, but there - -- is one time when it doesn't: tuples and other built in syntax. When you - -- write (a,b) that gives rise to a *use* of "(,)", so that the - -- instances will get pulled in, but the tycon "(,)" isn't actually - -- in scope. Hence the isValOcc filter. - -- - -- Also, (-x) gives rise to an implicit use of 'negate'; similarly, - -- 3.5 gives rise to an implcit use of :% - -- hence the isUserImportedName filter on the warning - - , let parent_avail - = case lookupNameEnv avail_env sub_name of - Just avail -> avail - Nothing -> WARN( isUserImportedName sub_name, - text "reportUnusedName: not in avail_env" <+> - ppr sub_name ) - Avail sub_name - - , case parent_avail of { AvailTC _ _ -> True; other -> False } - ] - - defined_names, defined_but_not_used :: [(Name,Provenance)] - defined_names = concat (rdrEnvElts gbl_env) - defined_but_not_used = filter not_used defined_names - not_used name = not (name `elemNameSet` really_used_names) - - -- Filter out the ones only defined implicitly - bad_locals :: [Name] - bad_locals = [n | (n,LocalDef) <- defined_but_not_used] - - bad_imp_names :: [(Name,Provenance)] - bad_imp_names = [(n,p) | (n,p@(UserImport mod _ True)) <- defined_but_not_used, - not (module_unused mod)] - - deprec_used deprec_env = [ (n,txt) - | n <- nameSetToList mentioned_names, - not (isLocallyDefined n), - Just txt <- [lookupNameEnv deprec_env n] ] - - -- inst_mods are directly-imported modules that - -- contain instance decl(s) that the renamer decided to suck in - -- It's not necessarily redundant to import such modules. - -- - -- NOTE: Consider - -- module This - -- import M () - -- - -- The import M() is not *necessarily* redundant, even if - -- we suck in no instance decls from M (e.g. it contains - -- no instance decls, or This contains no code). It may be - -- that we import M solely to ensure that M's orphan instance - -- decls (or those in its imports) are visible to people who - -- import This. Sigh. - -- There's really no good way to detect this, so the error message - -- in RnEnv.warnUnusedModules is weakened instead - inst_mods = [m | InstD (InstDecl _ _ _ (Just dfun) _) <- imported_decls, - let m = nameModule dfun, - m `elem` direct_import_mods - ] - - minimal_imports :: FiniteMap Module AvailEnv - minimal_imports0 = emptyFM - minimal_imports1 = foldNameSet add_name minimal_imports0 really_used_names - minimal_imports = foldr add_inst_mod minimal_imports1 inst_mods - - add_name n acc = case maybeUserImportedFrom n of - Nothing -> acc - Just m -> addToFM_C plusAvailEnv acc m - (unitAvailEnv (mk_avail n)) - add_inst_mod m acc - | m `elemFM` acc = acc -- We import something already - | otherwise = addToFM acc m emptyAvailEnv - -- Add an empty collection of imports for a module - -- from which we have sucked only instance decls - - mk_avail n = case lookupNameEnv avail_env n of - Just (AvailTC m _) | n==m -> AvailTC n [n] - | otherwise -> AvailTC m [n,m] - Just avail -> Avail n - Nothing -> pprPanic "mk_avail" (ppr n) - - -- unused_imp_mods are the directly-imported modules - -- that are not mentioned in minimal_imports - unused_imp_mods = [m | m <- direct_import_mods, - not (maybeToBool (lookupFM minimal_imports m)), - moduleName m /= pRELUDE_Name] - - module_unused :: Module -> Bool - module_unused mod = mod `elem` unused_imp_mods +closeIfaceDecls :: DynFlags + -> HomeIfaceTable -> HomeSymbolTable + -> PersistentCompilerState + -> ModIface -- Get the decls from here + -> IO (PersistentCompilerState, Bool, [RenamedHsDecl]) + -- True <=> errors happened +closeIfaceDecls dflags hit hst pcs + mod_iface@(ModIface { mi_module = mod, mi_decls = iface_decls }) + = runRn dflags hit hst pcs mod $ + let + rule_decls = dcl_rules iface_decls + inst_decls = dcl_insts iface_decls + tycl_decls = dcl_tycl iface_decls + decls = map RuleD rule_decls ++ + map InstD inst_decls ++ + map TyClD tycl_decls + needed = unionManyNameSets (map ruleDeclFVs rule_decls) `unionNameSets` + unionManyNameSets (map instDeclFVs inst_decls) `unionNameSets` + unionManyNameSets (map tyClDeclFVs tycl_decls) + local_names = foldl add emptyNameSet tycl_decls + add names decl = addListToNameSet names (map fst (tyClDeclSysNames decl ++ tyClDeclNames decl)) in - warnUnusedModules unused_imp_mods `thenRn_` + + recordLocalSlurps local_names `thenRn_` + + -- Do the transitive closure + closeDecls decls (needed `plusFV` implicit_fvs) `thenRn` \closed_decls -> + rnDump [] closed_decls `thenRn_` + returnRn closed_decls + where + implicit_fvs = ubiquitousNames -- Data type decls with record selectors, + -- which may appear in the decls, need unpackCString + -- and friends. It's easier to just grab them right now. +\end{code} + +%********************************************************* +%* * +\subsection{Unused names} +%* * +%********************************************************* + +\begin{code} +reportUnusedNames :: ModIface -> PrintUnqualified + -> [RdrNameImportDecl] + -> AvailEnv + -> GlobalRdrEnv + -> NameSet -- Used in this module + -> [RenamedHsDecl] + -> RnMG () +reportUnusedNames my_mod_iface unqual imports avail_env gbl_env + used_names imported_decls + = warnUnusedModules unused_imp_mods `thenRn_` warnUnusedLocalBinds bad_locals `thenRn_` warnUnusedImports bad_imp_names `thenRn_` - printMinimalImports mod_name minimal_imports `thenRn_` - getIfacesRn `thenRn` \ ifaces -> - doptRn Opt_WarnDeprecations `thenRn` \ warn_drs -> - (if warn_drs - then mapRn_ warnDeprec (deprec_used (iDeprecs ifaces)) - else returnRn ()) + printMinimalImports this_mod unqual minimal_imports + where + this_mod = mi_module my_mod_iface + + -- Now, a use of C implies a use of T, + -- if C was brought into scope by T(..) or T(C) + really_used_names = used_names `unionNameSets` + mkNameSet [ parent_name + | sub_name <- nameSetToList used_names + + -- Usually, every used name will appear in avail_env, but there + -- is one time when it doesn't: tuples and other built in syntax. When you + -- write (a,b) that gives rise to a *use* of "(,)", so that the + -- instances will get pulled in, but the tycon "(,)" isn't actually + -- in scope. Also, (-x) gives rise to an implicit use of 'negate'; + -- similarly, 3.5 gives rise to an implcit use of :% + -- Hence the silent 'False' in all other cases + + , Just parent_name <- [case lookupNameEnv avail_env sub_name of + Just (AvailTC n _) -> Just n + other -> Nothing] + ] + + -- Collect the defined names from the in-scope environment + -- Look for the qualified ones only, else get duplicates + defined_names :: [GlobalRdrElt] + defined_names = foldRdrEnv add [] gbl_env + add rdr_name ns acc | isQual rdr_name = ns ++ acc + | otherwise = acc + + defined_and_used, defined_but_not_used :: [GlobalRdrElt] + (defined_and_used, defined_but_not_used) = partition used defined_names + used (GRE name _ _) = name `elemNameSet` really_used_names + + -- Filter out the ones only defined implicitly + bad_locals :: [Name] + bad_locals = [n | (GRE n LocalDef _) <- defined_but_not_used] + + bad_imp_names :: [(Name,Provenance)] + bad_imp_names = [(n,p) | GRE n p@(NonLocalDef (UserImport mod _ True)) _ <- defined_but_not_used, + not (module_unused mod)] + + -- inst_mods are directly-imported modules that + -- contain instance decl(s) that the renamer decided to suck in + -- It's not necessarily redundant to import such modules. + -- + -- NOTE: Consider + -- module This + -- import M () + -- + -- The import M() is not *necessarily* redundant, even if + -- we suck in no instance decls from M (e.g. it contains + -- no instance decls, or This contains no code). It may be + -- that we import M solely to ensure that M's orphan instance + -- decls (or those in its imports) are visible to people who + -- import This. Sigh. + -- There's really no good way to detect this, so the error message + -- in RnEnv.warnUnusedModules is weakened instead + inst_mods :: [ModuleName] + inst_mods = [m | InstD (InstDecl _ _ _ (Just dfun) _) <- imported_decls, + let m = moduleName (nameModule dfun), + m `elem` direct_import_mods + ] + + -- To figure out the minimal set of imports, start with the things + -- that are in scope (i.e. in gbl_env). Then just combine them + -- into a bunch of avails, so they are properly grouped + minimal_imports :: FiniteMap ModuleName AvailEnv + minimal_imports0 = emptyFM + minimal_imports1 = foldr add_name minimal_imports0 defined_and_used + minimal_imports = foldr add_inst_mod minimal_imports1 inst_mods + + -- We've carefully preserved the provenance so that we can + -- construct minimal imports that import the name by (one of) + -- the same route(s) as the programmer originally did. + add_name (GRE n (NonLocalDef (UserImport m _ _)) _) acc = addToFM_C plusAvailEnv acc (moduleName m) + (unitAvailEnv (mk_avail n)) + add_name (GRE n other_prov _) acc = acc + + mk_avail n = case lookupNameEnv avail_env n of + Just (AvailTC m _) | n==m -> AvailTC n [n] + | otherwise -> AvailTC m [n,m] + Just avail -> Avail n + Nothing -> pprPanic "mk_avail" (ppr n) + + add_inst_mod m acc + | m `elemFM` acc = acc -- We import something already + | otherwise = addToFM acc m emptyAvailEnv + -- Add an empty collection of imports for a module + -- from which we have sucked only instance decls + + direct_import_mods :: [ModuleName] + direct_import_mods = nub [m | ImportDecl m _ _ _ _ _ <- imports] + + -- unused_imp_mods are the directly-imported modules + -- that are not mentioned in minimal_imports + unused_imp_mods = [m | m <- direct_import_mods, + not (maybeToBool (lookupFM minimal_imports m)), + m /= pRELUDE_Name] + + module_unused :: Module -> Bool + module_unused mod = moduleName mod `elem` unused_imp_mods + -- ToDo: deal with original imports with 'qualified' and 'as M' clauses -printMinimalImports mod_name imps - = doptRn Opt_D_dump_minimal_imports `thenRn` \ dump_minimal -> - printMinimalImports_wrk dump_minimal mod_name imps - -printMinimalImports_wrk dump_minimal mod_name imps - | not dump_minimal - = returnRn () - | otherwise - = mapRn to_ies (fmToList imps) `thenRn` \ mod_ies -> +printMinimalImports :: Module -- This module + -> PrintUnqualified + -> FiniteMap ModuleName AvailEnv -- Minimal imports + -> RnMG () +printMinimalImports this_mod unqual imps + = ifOptRn Opt_D_dump_minimal_imports $ + + mapRn to_ies (fmToList imps) `thenRn` \ mod_ies -> ioToRnM (do { h <- openFile filename WriteMode ; - printForUser h (vcat (map ppr_mod_ie mod_ies)) + printForUser h unqual (vcat (map ppr_mod_ie mod_ies)) }) `thenRn_` returnRn () where - filename = moduleNameUserString mod_name ++ ".imports" + filename = moduleNameUserString (moduleName this_mod) ++ ".imports" ppr_mod_ie (mod_name, ies) | mod_name == pRELUDE_Name = empty @@ -814,34 +958,47 @@ printMinimalImports_wrk dump_minimal mod_name imps parens (fsep (punctuate comma (map ppr ies))) to_ies (mod, avail_env) = mapRn to_ie (availEnvElts avail_env) `thenRn` \ ies -> - returnRn (moduleName mod, ies) + returnRn (mod, ies) to_ie :: AvailInfo -> RnMG (IE Name) + -- The main trick here is that if we're importing all the constructors + -- we want to say "T(..)", but if we're importing only a subset we want + -- to say "T(A,B,C)". So we have to find out what the module exports. to_ie (Avail n) = returnRn (IEVar n) to_ie (AvailTC n [m]) = ASSERT( n==m ) returnRn (IEThingAbs n) - to_ie (AvailTC n ns) = getInterfaceExports (moduleName (nameModule n)) - ImportBySystem `thenRn` \ (_, avails) -> - case [ms | AvailTC m ms <- avails, m == n] of - [ms] | all (`elem` ns) ms -> returnRn (IEThingAll n) - | otherwise -> returnRn (IEThingWith n (filter (/= n) ns)) - other -> pprTrace "to_ie" (ppr n <+> ppr (nameModule n) <+> ppr other) $ - returnRn (IEVar n) + to_ie (AvailTC n ns) + = loadInterface (text "Compute minimal imports from" <+> ppr n_mod) + n_mod ImportBySystem `thenRn` \ iface -> + case [xs | (m,as) <- mi_exports iface, + m == n_mod, + AvailTC x xs <- as, + x == n] of + [xs] | all (`elem` ns) xs -> returnRn (IEThingAll n) + | otherwise -> returnRn (IEThingWith n (filter (/= n) ns)) + other -> pprTrace "to_ie" (ppr n <+> ppr (nameModule n) <+> ppr other) $ + returnRn (IEVar n) + where + n_mod = moduleName (nameModule n) rnDump :: [RenamedHsDecl] -- Renamed imported decls -> [RenamedHsDecl] -- Renamed local decls - -> RnMG (IO ()) + -> RnMG () rnDump imp_decls local_decls - = doptRn Opt_D_dump_rn_trace `thenRn` \ dump_rn_trace -> - doptRn Opt_D_dump_rn_stats `thenRn` \ dump_rn_stats -> - doptRn Opt_D_dump_rn `thenRn` \ dump_rn -> - if dump_rn_trace || dump_rn_stats || dump_rn then - getRnStats imp_decls `thenRn` \ stats_msg -> - returnRn (printErrs stats_msg >> - dumpIfSet dump_rn "Renamer:" - (vcat (map ppr (local_decls ++ imp_decls)))) - else - returnRn (return ()) + = doptRn Opt_D_dump_rn_trace `thenRn` \ dump_rn_trace -> + doptRn Opt_D_dump_rn_stats `thenRn` \ dump_rn_stats -> + doptRn Opt_D_dump_rn `thenRn` \ dump_rn -> + getIfacesRn `thenRn` \ ifaces -> + + ioToRnM (do { dumpIfSet (dump_rn_trace || dump_rn_stats || dump_rn) + "Renamer statistics" + (getRnStats imp_decls ifaces) ; + + dumpIfSet dump_rn "Renamer:" + (vcat (map ppr (local_decls ++ imp_decls))) + }) `thenRn_` + + returnRn () \end{code} @@ -852,61 +1009,37 @@ rnDump imp_decls local_decls %********************************************************* \begin{code} -getRnStats :: [RenamedHsDecl] -> RnMG SDoc -getRnStats imported_decls - = getIfacesRn `thenRn` \ ifaces -> - let - n_mods = length [() | (_, _, Just _) <- eltsFM (iImpModInfo ifaces)] - - decls_read = [decl | (_, avail, True, (_,decl)) <- nameEnvElts (iDecls ifaces), - -- Data, newtype, and class decls are in the decls_fm - -- under multiple names; the tycon/class, and each - -- constructor/class op too. - -- The 'True' selects just the 'main' decl - not (isLocallyDefined (availName avail)) - ] - - (cd_rd, dd_rd, nd_rd, sd_rd, vd_rd, _) = count_decls decls_read - (cd_sp, dd_sp, nd_sp, sd_sp, vd_sp, id_sp) = count_decls imported_decls - - unslurped_insts = iInsts ifaces - inst_decls_unslurped = length (bagToList unslurped_insts) - inst_decls_read = id_sp + inst_decls_unslurped - - stats = vcat - [int n_mods <+> text "interfaces read", - hsep [ int cd_sp, text "class decls imported, out of", - int cd_rd, text "read"], - hsep [ int dd_sp, text "data decls imported, out of", - int dd_rd, text "read"], - hsep [ int nd_sp, text "newtype decls imported, out of", - int nd_rd, text "read"], - hsep [int sd_sp, text "type synonym decls imported, out of", - int sd_rd, text "read"], - hsep [int vd_sp, text "value signatures imported, out of", - int vd_rd, text "read"], - hsep [int id_sp, text "instance decls imported, out of", - int inst_decls_read, text "read"], - text "cls dcls slurp" <+> fsep (map (ppr . tyClDeclName) - [d | TyClD d <- imported_decls, isClassDecl d]), - text "cls dcls read" <+> fsep (map (ppr . tyClDeclName) - [d | TyClD d <- decls_read, isClassDecl d])] - in - returnRn (hcat [text "Renamer stats: ", stats]) - -count_decls decls - = (class_decls, - data_decls, - newtype_decls, - syn_decls, - val_decls, - inst_decls) +getRnStats :: [RenamedHsDecl] -> Ifaces -> SDoc +getRnStats imported_decls ifaces + = hcat [text "Renamer stats: ", stats] where - tycl_decls = [d | TyClD d <- decls] - (class_decls, data_decls, newtype_decls, syn_decls) = countTyClDecls tycl_decls - - val_decls = length [() | SigD _ <- decls] - inst_decls = length [() | InstD _ <- decls] + n_mods = length [() | _ <- moduleEnvElts (iPIT ifaces)] + -- This is really only right for a one-shot compile + + (decls_map, n_decls_slurped) = iDecls ifaces + + n_decls_left = length [decl | (avail, True, (_,decl)) <- nameEnvElts decls_map + -- Data, newtype, and class decls are in the decls_fm + -- under multiple names; the tycon/class, and each + -- constructor/class op too. + -- The 'True' selects just the 'main' decl + ] + + (insts_left, n_insts_slurped) = iInsts ifaces + n_insts_left = length (bagToList insts_left) + + (rules_left, n_rules_slurped) = iRules ifaces + n_rules_left = length (bagToList rules_left) + + stats = vcat + [int n_mods <+> text "interfaces read", + hsep [ int n_decls_slurped, text "type/class/variable imported, out of", + int (n_decls_slurped + n_decls_left), text "read"], + hsep [ int n_insts_slurped, text "instance decls imported, out of", + int (n_insts_slurped + n_insts_left), text "read"], + hsep [ int n_rules_slurped, text "rule decls imported, out of", + int (n_rules_slurped + n_rules_left), text "read"] + ] \end{code} @@ -917,19 +1050,14 @@ count_decls decls %************************************************************************ \begin{code} -warnDeprec :: (Name, DeprecTxt) -> RnM d () -warnDeprec (name, txt) - = pushSrcLocRn (getSrcLoc name) $ - addWarnRn $ - sep [ text (occNameFlavour (nameOccName name)) <+> ppr name <+> - text "is deprecated:", nest 4 (ppr txt) ] - - -unusedFixityDecl rdr_name fixity - = hsep [ptext SLIT("Unused fixity declaration for"), quotes (ppr rdr_name)] - dupFixityDecl rdr_name loc1 loc2 = vcat [ptext SLIT("Multiple fixity declarations for") <+> quotes (ppr rdr_name), ptext SLIT("at ") <+> ppr loc1, ptext SLIT("and") <+> ppr loc2] + +badDeprec d + = sep [ptext SLIT("Illegal deprecation when whole module is deprecated"), + nest 4 (ppr d)] \end{code} + +