X-Git-Url: http://git.megacz.com/?a=blobdiff_plain;f=ghc%2Fcompiler%2Frename%2FRename.lhs;h=eb18d9d9a1a5c13c6f9c2232d6973e6b6ae7e43d;hb=bac531aaf56c7558eda70531e9565f753d21f848;hp=bc01d7cc1510b9c76474f1a52ecb20b710a60430;hpb=927b3cbb22ce99e09ee81afa682f125982af7214;p=ghc-hetmet.git diff --git a/ghc/compiler/rename/Rename.lhs b/ghc/compiler/rename/Rename.lhs index bc01d7c..eb18d9d 100644 --- a/ghc/compiler/rename/Rename.lhs +++ b/ghc/compiler/rename/Rename.lhs @@ -4,431 +4,502 @@ \section[Rename]{Renaming and dependency analysis passes} \begin{code} -module Rename ( renameModule ) where +module Rename ( renameModule, closeIfaceDecls ) where #include "HsVersions.h" import HsSyn -import RdrHsSyn ( RdrNameHsModule ) -import RnHsSyn ( RenamedHsModule, RenamedHsDecl, - extractHsTyNames, extractHsCtxtTyNames +import RdrHsSyn ( RdrNameHsModule, RdrNameHsDecl, RdrNameDeprecation, + RdrNameTyClDecl, RdrNameRuleDecl, RdrNameInstDecl + ) +import RnHsSyn ( RenamedHsDecl, RenamedTyClDecl, RenamedRuleDecl, RenamedInstDecl, + extractHsTyNames, + instDeclFVs, tyClDeclFVs, ruleDeclFVs ) -import CmdLineOpts ( opt_HiMap, opt_D_dump_rn_trace, - opt_D_dump_rn, opt_D_dump_rn_stats, - opt_WarnUnusedBinds, opt_WarnUnusedImports - ) +import CmdLineOpts ( DynFlags, DynFlag(..) ) import RnMonad import RnNames ( getGlobalNames ) -import RnSource ( rnSourceDecls, rnDecl ) -import RnIfaces ( getImportedInstDecls, importDecl, getImportVersions, - getImportedRules, loadHomeInterface, getSlurped +import RnSource ( rnSourceDecls, rnTyClDecl, rnIfaceRuleDecl, rnInstDecl ) +import RnIfaces ( slurpImpDecls, mkImportInfo, + getInterfaceExports, closeDecls, + RecompileRequired, recompileRequired + ) +import RnHiFiles ( findAndReadIface, removeContext, loadExports, loadFixDecls, loadDeprecs ) +import RnEnv ( availName, availsToNameSet, + emptyAvailEnv, unitAvailEnv, availEnvElts, plusAvailEnv, groupAvails, + warnUnusedImports, warnUnusedLocalBinds, warnUnusedModules, + lookupOrigNames, lookupGlobalRn, newGlobalName ) -import RnEnv ( availName, availNames, availsToNameSet, - warnUnusedTopNames, mapFvRn, - FreeVars, plusFVs, plusFV, unitFV, emptyFVs, isEmptyFVs +import Module ( Module, ModuleName, WhereFrom(..), + moduleNameUserString, moduleName, + lookupModuleEnv ) -import Module ( Module, ModuleName, pprModule, mkSearchPath, mkThisModule ) -import Name ( Name, isLocallyDefined, - NamedThing(..), ImportReason(..), Provenance(..), - pprOccName, nameOccName, - getNameProvenance, occNameUserString, - maybeWiredInTyConName, maybeWiredInIdName, isWiredInName +import Name ( Name, isLocallyDefined, NamedThing(..), getSrcLoc, + nameOccName, nameModule, + mkNameEnv, nameEnvElts, extendNameEnv ) -import Id ( idType ) -import DataCon ( dataConTyCon, dataConType ) -import TyCon ( TyCon, tyConDataCons, isSynTyCon, getSynTyConDefn ) -import RdrName ( RdrName ) +import OccName ( occNameFlavour ) import NameSet -import PrelMods ( mAIN_Name, pREL_MAIN_Name ) -import TysWiredIn ( unitTyCon, intTyCon, doubleTyCon, boolTyCon ) -import PrelInfo ( ioTyCon_NAME, thinAirIdNames ) -import Type ( namesOfType, funTyCon ) -import ErrUtils ( pprBagOfErrors, pprBagOfWarnings, - doIfSet, dumpIfSet, ghcExit +import TysWiredIn ( unitTyCon, intTyCon, boolTyCon ) +import PrelNames ( mAIN_Name, pREL_MAIN_Name, pRELUDE_Name, + ioTyCon_RDR, + unpackCString_RDR, unpackCStringFoldr_RDR, unpackCStringUtf8_RDR, + eqString_RDR + ) +import PrelInfo ( derivingOccurrences ) +import Type ( funTyCon ) +import ErrUtils ( dumpIfSet ) +import Bag ( bagToList ) +import FiniteMap ( FiniteMap, eltsFM, fmToList, emptyFM, lookupFM, + addToFM_C, elemFM, addToFM ) -import BasicTypes ( NewOrData(..) ) -import Bag ( isEmptyBag, bagToList ) -import FiniteMap ( fmToList, delListFromFM, addToFM, sizeFM, eltsFM ) -import UniqSupply ( UniqSupply ) -import Util ( equivClasses ) -import Maybes ( maybeToBool ) +import UniqFM ( lookupUFM ) +import Maybes ( maybeToBool, catMaybes ) import Outputable +import IO ( openFile, IOMode(..) ) +import HscTypes ( Finder, PersistentCompilerState, HomeIfaceTable, HomeSymbolTable, + ModIface(..), WhatsImported(..), + VersionInfo(..), ImportVersion, IfaceDecls(..), + GlobalRdrEnv, AvailEnv, Avails, GenAvailInfo(..), AvailInfo, + Provenance(..), ImportReason(..), initialVersionInfo, + Deprecations(..), lookupDeprec + ) +import List ( partition, nub ) \end{code} +%********************************************************* +%* * +\subsection{The main function: rename} +%* * +%********************************************************* + \begin{code} -renameModule :: UniqSupply - -> RdrNameHsModule - -> IO (Maybe - ( Module - , RenamedHsModule -- Output, after renaming - , InterfaceDetails -- Interface; for interface file generation - , RnNameSupply -- Final env; for renaming derivings - , [ModuleName] -- Imported modules; for profiling - )) - -renameModule us this_mod@(HsModule mod_name vers exports imports local_decls loc) +renameModule :: DynFlags -> Finder + -> HomeIfaceTable -> HomeSymbolTable + -> PersistentCompilerState + -> Module -> RdrNameHsModule + -> IO (PersistentCompilerState, Maybe (ModIface, [RenamedHsDecl])) + -- Nothing => some error occurred in the renamer + +renameModule dflags finder hit hst old_pcs this_module rdr_module = -- Initialise the renamer monad - initRn mod_name us (mkSearchPath opt_HiMap) loc - (rename this_mod) >>= - \ (maybe_rn_stuff, rn_errs_bag, rn_warns_bag) -> - - -- Check for warnings - doIfSet (not (isEmptyBag rn_warns_bag)) - (printErrs (pprBagOfWarnings rn_warns_bag)) >> - - -- Check for errors; exit if so - doIfSet (not (isEmptyBag rn_errs_bag)) - (printErrs (pprBagOfErrors rn_errs_bag) >> - ghcExit 1 - ) >> - - -- Dump output, if any - (case maybe_rn_stuff of - Nothing -> return () - Just results@(_, rn_mod, _, _, _) - -> dumpIfSet opt_D_dump_rn "Renamer:" - (ppr rn_mod) - ) >> - - -- Return results - return maybe_rn_stuff + do { + (new_pcs, errors_found, maybe_rn_stuff) + <- initRn dflags finder hit hst old_pcs this_module (rename this_module rdr_module) ; + + -- Return results. No harm in updating the PCS + if errors_found then + return (new_pcs, Nothing) + else + return (new_pcs, maybe_rn_stuff) + } \end{code} - \begin{code} -rename this_mod@(HsModule mod_name vers exports imports local_decls loc) +rename :: Module -> RdrNameHsModule -> RnMG (Maybe (ModIface, [RenamedHsDecl])) +rename this_module this_mod@(HsModule mod_name vers exports imports local_decls mod_deprec loc) = -- FIND THE GLOBAL NAME ENVIRONMENT getGlobalNames this_mod `thenRn` \ maybe_stuff -> -- CHECK FOR EARLY EXIT - if not (maybeToBool maybe_stuff) then - -- Everything is up to date; no need to recompile further - rnStats [] `thenRn_` - returnRn Nothing - else - let - Just (export_env, gbl_env, fixity_env, global_avail_env) = maybe_stuff - in + case maybe_stuff of { + Nothing -> -- Everything is up to date; no need to recompile further + rnDump [] [] `thenRn_` + returnRn Nothing ; + + Just (gbl_env, local_gbl_env, export_avails, global_avail_env) -> + + -- DEAL WITH DEPRECATIONS + rnDeprecs local_gbl_env mod_deprec + [d | DeprecD d <- local_decls] `thenRn` \ my_deprecs -> + + -- DEAL WITH LOCAL FIXITIES + fixitiesFromLocalDecls local_gbl_env local_decls `thenRn` \ local_fixity_env -> -- RENAME THE SOURCE - initRnMS gbl_env fixity_env SourceMode ( + initRnMS gbl_env local_fixity_env SourceMode ( rnSourceDecls local_decls ) `thenRn` \ (rn_local_decls, source_fvs) -> -- SLURP IN ALL THE NEEDED DECLARATIONS + implicitFVs mod_name rn_local_decls `thenRn` \ implicit_fvs -> let - real_source_fvs = implicitFVs mod_name `plusFV` source_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.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 + + 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. in - slurpImpDecls real_source_fvs `thenRn` \ rn_imp_decls -> + slurpImpDecls slurp_fvs `thenRn` \ rn_imp_decls -> -- EXIT IF ERRORS FOUND - checkErrsRn `thenRn` \ no_errs_so_far -> + rnDump rn_imp_decls rn_local_decls `thenRn_` + checkErrsRn `thenRn` \ no_errs_so_far -> if not no_errs_so_far then -- Found errors already, so exit now - rnStats [] `thenRn_` returnRn Nothing else -- GENERATE THE VERSION/USAGE INFO - getImportVersions mod_name exports `thenRn` \ my_usages -> - getNameSupplyRn `thenRn` \ name_supply -> - - -- REPORT UNUSED NAMES - reportUnusedNames gbl_env global_avail_env - export_env - source_fvs `thenRn_` + mkImportInfo mod_name imports `thenRn` \ my_usages -> -- RETURN THE RENAMED MODULE + getNameSupplyRn `thenRn` \ name_supply -> + getIfacesRn `thenRn` \ ifaces -> let - has_orphans = any isOrphanDecl rn_local_decls - direct_import_mods = [mod | ImportDecl mod _ _ _ _ _ <- imports] - rn_all_decls = rn_imp_decls ++ rn_local_decls - renamed_module = HsModule mod_name vers - trashed_exports trashed_imports - rn_all_decls - loc + direct_import_mods :: [ModuleName] + direct_import_mods = nub [m | ImportDecl m _ _ _ _ _ <- imports] + + -- 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 export_avails + + mod_iface = ModIface { mi_module = this_module, + mi_version = initialVersionInfo, + mi_orphan = any isOrphanDecl rn_local_decls, + mi_exports = my_exports, + mi_globals = gbl_env, + mi_usages = my_usages, + mi_fixities = fixities, + mi_deprecs = my_deprecs, + mi_decls = panic "mi_decls" + } + + final_decls = rn_local_decls ++ rn_imp_decls in - rnStats rn_imp_decls `thenRn_` - returnRn (Just (mkThisModule mod_name, - renamed_module, - (has_orphans, my_usages, export_env), - name_supply, - direct_import_mods)) - where - trashed_exports = {-trace "rnSource:trashed_exports"-} Nothing - trashed_imports = {-trace "rnSource:trashed_imports"-} [] + + -- 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_` + + returnRn (Just (mod_iface, final_decls)) + } \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 - = implicit_main `plusFV` - mkNameSet default_tys `plusFV` - mkNameSet thinAirIdNames +implicitFVs mod_name decls + = lookupOrigNames implicit_occs `thenRn` \ implicit_names -> + returnRn (mkNameSet (map getName default_tycons) `plusFV` + implicit_names) where - -- Add occurrences for Int, Double, and (), because they + -- 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!) - default_tys = [getName intTyCon, getName doubleTyCon, - getName unitTyCon, getName funTyCon, getName boolTyCon] + -- 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 = unitFV ioTyCon_NAME - | otherwise = emptyFVs + || 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} \begin{code} isOrphanDecl (InstD (InstDecl inst_ty _ _ _ _)) - = not (foldNameSet ((||) . isLocallyDefined) False (extractHsTyNames inst_ty)) -isOrphanDecl (RuleD (RuleDecl _ _ _ lhs _ _)) + = 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 - check (HsVar v) = not (isLocallyDefined v) - check (HsApp f a) = check f && check a - check other = True + -- 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} %********************************************************* %* * -\subsection{Slurping declarations} +\subsection{Fixities} %* * %********************************************************* \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` \ local_binders -> - - slurpSourceRefs source_fvs `thenRn` \ (decls1, needed1, wired_in) -> - let - inst_gates1 = foldr (plusFV . getWiredInGates) source_fvs wired_in - inst_gates2 = foldr (plusFV . getGates source_fvs) inst_gates1 decls1 - in - -- Do this first slurpDecls before the getImportedInstDecls, - -- so that the home modules of all the inst_gates will be sure to be loaded - slurpDecls decls1 needed1 `thenRn` \ (decls2, needed2) -> - mapRn_ (load_home local_binders) wired_in `thenRn_` - - -- Now we can get the instance decls - getImportedInstDecls inst_gates2 `thenRn` \ inst_decls -> - rnIfaceDecls decls2 needed2 inst_decls `thenRn` \ (decls3, needed3) -> - closeDecls decls3 needed3 - where - load_home local_binders name - | name `elemNameSet` local_binders = returnRn () - -- When compiling the prelude, a wired-in thing may - -- be defined in this module, in which case we don't - -- want to load its home module! - -- Using 'isLocallyDefined' doesn't work because some of - -- the free variables returned are simply 'listTyCon_Name', - -- with a system provenance. We could look them up every time - -- but that seems a waste. - | otherwise = loadHomeInterface doc name `thenRn_` - returnRn () - where - doc = ptext SLIT("need home module for wired in thing") <+> ppr name - -------------------------------------------------------- -slurpSourceRefs :: FreeVars -- Variables referenced in source - -> RnMG ([RenamedHsDecl], - FreeVars, -- Un-satisfied needs - [Name]) -- Those variables referenced in the source - -- that turned out to be wired in things - -slurpSourceRefs source_fvs - = go [] emptyFVs [] (nameSetToList source_fvs) - where - go decls fvs wired [] - = returnRn (decls, fvs, wired) - go decls fvs wired (wanted_name:refs) - | isWiredInName wanted_name - = go decls fvs (wanted_name:wired) refs - | otherwise - = importDecl wanted_name `thenRn` \ maybe_decl -> - case maybe_decl of - -- No declaration... (already slurped, or local) - Nothing -> go decls fvs wired refs - Just decl -> rnIfaceDecl decl `thenRn` \ (new_decl, fvs1) -> - go (new_decl : decls) (fvs1 `plusFV` fvs) wired - (extraGates new_decl ++ refs) - --- Hack alert. If we suck in a class --- class Ord a => Baz a where ... --- then Eq is also a 'gate'. Why? Because Eq is a superclass of Ord, --- and hence may be needed during context reduction even though --- Eq is never mentioned explicitly. So we snaffle out the super-classes --- right now, so that slurpSourceRefs will heave them in --- --- Similarly the RHS of type synonyms -extraGates (TyClD (ClassDecl ctxt _ tvs _ _ _ _ _ _ _)) - = nameSetToList (delListFromNameSet (extractHsCtxtTyNames ctxt) (map getTyVarName tvs)) -extraGates (TyClD (TySynonym _ tvs ty _)) - = nameSetToList (delListFromNameSet (extractHsTyNames ty) (map getTyVarName tvs)) -extraGates other = [] - -------------------------------------------------------- --- 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 - - -------------------------------------------------------- -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) - - -------------------------------------------------------- --- 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) +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_` + returnRn env 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` \ maybe_decl -> - case maybe_decl of - -- No declaration... (wired in thing) - Nothing -> returnRn (decls, fvs) - - -- Found a declaration... rename it - Just decl -> rnIfaceDecl decl `thenRn` \ (new_decl, fvs1) -> - returnRn (new_decl:decls, fvs1 `plusFV` fvs) + getFixities :: Bool -> LocalFixityEnv -> RdrNameHsDecl -> RnMG LocalFixityEnv + getFixities warn_uu acc (FixD fix) + = fix_decl warn_uu acc fix + + getFixities warn_uu acc (TyClD (ClassDecl _ _ _ _ sigs _ _ _ )) + = foldlRn (fix_decl warn_uu) acc [sig | FixSig sig <- sigs] + -- Get fixities from class decl sigs too. + getFixities warn_uu acc other_decl + = returnRn acc + + fix_decl warn_uu acc sig@(FixitySig rdr_name fixity loc) + = -- Check for fixity decl for something not declared + pushSrcLocRn loc $ + lookupGlobalRn gbl_env rdr_name `thenRn` \ maybe_name -> + case maybe_name of { + Nothing -> checkRn (not warn_uu) (unusedFixityDecl rdr_name fixity) `thenRn_` + returnRn acc ; + + Just name -> + + -- Check for duplicate fixity decl + 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)) + }} \end{code} %********************************************************* %* * -\subsection{Extracting the 'gates'} +\subsection{Deprecations} %* * %********************************************************* -When we import a declaration like +For deprecations, all we do is check that the names are in scope. +It's only imported deprecations, dealt with in RnIfaces, that we +gather them together. - data T = T1 Wibble | T2 Wobble +\begin{code} +rnDeprecs :: GlobalRdrEnv -> Maybe DeprecTxt + -> [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 + rn_deprec (Deprecation rdr_name txt loc) + = pushSrcLocRn loc $ + lookupGlobalRn gbl_env rdr_name `thenRn` \ maybe_name -> + case maybe_name of + Just n -> returnRn (Just (n,txt)) + Nothing -> returnRn Nothing +\end{code} -we don't want to treat Wibble and Wobble as gates *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. +%************************************************************************ +%* * +\subsection{Grabbing the old interface file and checking versions} +%* * +%************************************************************************ \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) - (map getTyVarName tvs) - `addOneToNameSet` cls - where - get (ClassOpSig n _ ty _) - | n `elemNameSet` source_fvs = extractHsTyNames ty - | otherwise = emptyFVs - -getGates source_fvs (TyClD (TySynonym tycon tvs ty _)) - = delListFromNameSet (extractHsTyNames ty) - (map getTyVarName tvs) - `addOneToNameSet` tycon - -getGates source_fvs (TyClD (TyData _ ctxt tycon tvs cons _ _ _)) - = delListFromNameSet (foldr (plusFV . get) (extractHsCtxtTyNames ctxt) cons) - (map getTyVarName 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) - (map getTyVarName 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 +checkOldIface :: DynFlags -> Finder + -> HomeIfaceTable -> HomeSymbolTable + -> PersistentCompilerState + -> Module + -> Bool -- Source unchanged + -> Maybe ModIface -- Old interface from compilation manager, if any + -> IO (PersistentCompilerState, Bool, (RecompileRequired, Maybe ModIface)) + -- True <=> errors happened + +checkOldIface dflags finder hit hst pcs mod source_unchanged maybe_iface + = initRn dflags finder hit hst pcs mod $ - get other_con = emptyFVs + -- Load the old interface file, if we havn't already got it + loadOldIface mod maybe_iface `thenRn` \ maybe_iface -> - 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] - get_details (NewCon t _) = extractHsTyNames t + -- Check versions + recompileRequired mod source_unchanged maybe_iface `thenRn` \ recompile -> - get_field (fs,t) | any (`elemNameSet` source_fvs) fs = get_bang t - | otherwise = emptyFVs + returnRn (recompile, maybe_iface) +\end{code} - get_bang (Banged t) = extractHsTyNames t - get_bang (Unbanged t) = extractHsTyNames t - get_bang (Unpacked t) = extractHsTyNames t -getGates source_fvs other_decl = emptyFVs -\end{code} +\begin{code} +loadOldIface :: Module -> Maybe ModIface -> RnMG (Maybe ModIface) +loadOldIface mod (Just iface) + = returnRn (Just iface) + +loadOldIface mod Nothing + = -- LOAD THE OLD INTERFACE FILE + findAndReadIface doc_str (moduleName mod) False {- Not hi-boot -} `thenRn` \ read_result -> + case read_result of { + Left err -> -- Old interface file not found, or garbled, so we'd better bail out + traceRn (vcat [ptext SLIT("No old interface file:"), err]) `thenRn_` + returnRn Nothing ; + + Right (_, iface) -> + + -- RENAME IT + 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 = IfaceDecls { dcl_tycl = new_decls, + dcl_rules = new_rules, + dcl_insts = new_insts } + + mod_iface = ModIface { mi_module = mod, mi_version = version, + mi_exports = avails, mi_orphan = pi_orphan iface, + mi_fixities = fix_env, mi_deprecs = deprec_env, + mi_usages = usages, + mi_decls = decls, + mi_globals = panic "No mi_globals in old interface" + } + in + returnRn (Just mod_iface) + } -getWiredInGates is just like getGates, but it sees a wired-in Name -rather than a declaration. + + where + doc_str = ptext SLIT("need usage info from") <+> ppr mod +\end{code} \begin{code} -getWiredInGates name | is_tycon = get_wired_tycon the_tycon - | otherwise = get_wired_id the_id +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 - maybe_wired_in_tycon = maybeWiredInTyConName name - is_tycon = maybeToBool maybe_wired_in_tycon - maybe_wired_in_id = maybeWiredInIdName name - Just the_tycon = maybe_wired_in_tycon - Just the_id = maybe_wired_in_id + 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} -get_wired_id id = namesOfType (idType id) -get_wired_tycon tycon - | isSynTyCon tycon - = namesOfType ty `minusNameSet` mkNameSet (map getName tyvars) - | otherwise -- data or newtype - = foldr (unionNameSets . namesOfType . dataConType) emptyNameSet data_cons - where - (tyvars,ty) = getSynTyConDefn tycon - data_cons = tyConDataCons tycon -\end{code} +%********************************************************* +%* * +\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} +closeIfaceDecls :: DynFlags -> Finder + -> HomeIfaceTable -> HomeSymbolTable + -> PersistentCompilerState + -> ModIface -- Get the decls from here + -> IO (PersistentCompilerState, Bool, [RenamedHsDecl]) + -- True <=> errors happened +closeIfaceDecls dflags finder hit hst pcs + mod_iface@(ModIface { mi_module = mod, mi_decls = iface_decls }) + = initRn dflags finder 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) + in + closeDecls decls needed +\end{code} %********************************************************* %* * @@ -437,60 +508,194 @@ get_wired_tycon tycon %********************************************************* \begin{code} -reportUnusedNames gbl_env avail_env (ExportEnv export_avails _) mentioned_names - | not (opt_WarnUnusedBinds || opt_WarnUnusedImports) - = returnRn () - - | otherwise - = 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 avail - | sub_name <- nameSetToList used_names, - let avail = case lookupNameEnv avail_env sub_name of - Just avail -> avail - Nothing -> pprTrace "r.u.n" (ppr sub_name) $ - Avail sub_name - ] - - defined_names = mkNameSet (concat (rdrEnvElts gbl_env)) - defined_but_not_used = nameSetToList (defined_names `minusNameSet` really_used_names) - - -- Filter out the ones only defined implicitly - bad_guys = filter reportableUnusedName defined_but_not_used - in - warnUnusedTopNames bad_guys `thenRn_` +reportUnusedNames :: ModuleName -> [ModuleName] + -> GlobalRdrEnv -> AvailEnv + -> Avails -> NameSet -> [RenamedHsDecl] + -> RnMG () +reportUnusedNames mod_name direct_import_mods + gbl_env avail_env + export_avails mentioned_names + imported_decls + = warnUnusedModules unused_imp_mods `thenRn_` + warnUnusedLocalBinds bad_locals `thenRn_` + warnUnusedImports bad_imp_names `thenRn_` + printMinimalImports mod_name minimal_imports `thenRn_` + warnDeprecations really_used_names `thenRn_` returnRn () -reportableUnusedName :: Name -> Bool -reportableUnusedName name - = explicitlyImported (getNameProvenance name) && - not (startsWithUnderscore (occNameUserString (nameOccName name))) where - explicitlyImported (LocalDef _ _) = True -- Report unused defns of local vars - explicitlyImported (NonLocalDef (UserImport _ _ expl) _) = expl -- Report unused explicit imports - explicitlyImported other = False -- Don't report others - - -- Haskell 98 encourages compilers to suppress warnings about - -- unused names in a pattern if they start with "_". - startsWithUnderscore ('_' : _) = True -- Suppress warnings for names starting - startsWithUnderscore other = False -- with an underscore - -rnStats :: [RenamedHsDecl] -> RnMG () -rnStats imp_decls - | opt_D_dump_rn_trace || - opt_D_dump_rn_stats || - opt_D_dump_rn - = getRnStats imp_decls `thenRn` \ msg -> - ioToRnM (printErrs msg) `thenRn_` - returnRn () - - | otherwise = returnRn () -\end{code} + 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 [ 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] + ] + + defined_names, defined_and_used, defined_but_not_used :: [(Name,Provenance)] + defined_names = concat (rdrEnvElts gbl_env) + (defined_and_used, defined_but_not_used) = partition used defined_names + 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@(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 + + add_name (n,NonLocalDef (UserImport m _ _) _) acc = addToFM_C plusAvailEnv acc (moduleName (nameModule n)) + (unitAvailEnv (mk_avail n)) + add_name (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 + + -- 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 + + +warnDeprecations used_names + = doptRn Opt_WarnDeprecations `thenRn` \ warn_drs -> + if not warn_drs then returnRn () else + + getIfacesRn `thenRn` \ ifaces -> + getHomeIfaceTableRn `thenRn` \ hit -> + let + pit = iPIT ifaces + deprecs = [ (n,txt) + | n <- nameSetToList used_names, + Just txt <- [lookup_deprec hit pit n] ] + in + mapRn_ warnDeprec deprecs + where + lookup_deprec hit pit n + = case lookupModuleEnv hit mod of + Just iface -> lookupDeprec iface n + Nothing -> case lookupModuleEnv pit mod of + Just iface -> lookupDeprec iface n + Nothing -> pprPanic "warnDeprecations:" (ppr n) + where + mod = nameModule n + +-- ToDo: deal with original imports with 'qualified' and 'as M' clauses +printMinimalImports mod_name imps + = doptRn Opt_D_dump_minimal_imports `thenRn` \ dump_minimal -> + if not dump_minimal then returnRn () else + + mapRn to_ies (fmToList imps) `thenRn` \ mod_ies -> + ioToRnM (do { h <- openFile filename WriteMode ; + printForUser h (vcat (map ppr_mod_ie mod_ies)) + }) `thenRn_` + returnRn () + where + filename = moduleNameUserString mod_name ++ ".imports" + ppr_mod_ie (mod_name, ies) + | mod_name == pRELUDE_Name + = empty + | otherwise + = ptext SLIT("import") <+> ppr mod_name <> + parens (fsep (punctuate comma (map ppr ies))) + + to_ies (mod, avail_env) = mapRn to_ie (availEnvElts avail_env) `thenRn` \ ies -> + returnRn (mod, ies) + + to_ie :: AvailInfo -> RnMG (IE Name) + to_ie (Avail n) = returnRn (IEVar n) + to_ie (AvailTC n [m]) = ASSERT( n==m ) + returnRn (IEThingAbs n) + to_ie (AvailTC n ns) + = getInterfaceExports n_mod ImportBySystem `thenRn` \ (_, avails_by_module) -> + case [xs | (m,as) <- avails_by_module, + 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 () +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 -> + 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} %********************************************************* @@ -500,47 +705,45 @@ rnStats imp_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]) +getRnStats :: [RenamedHsDecl] -> Ifaces -> SDoc +getRnStats imported_decls ifaces + = hcat [text "Renamer stats: ", stats] + where + n_mods = length [() | (_, _, True) <- 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) = countTyClDecls 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 | d <- decls_read, isClassDecl d])] count_decls decls = (class_decls, @@ -551,9 +754,38 @@ count_decls decls inst_decls) where tycl_decls = [d | TyClD d <- decls] - (class_decls, data_decls, newtype_decls, syn_decls) = countTyClDecls tycl_decls + (class_decls, data_decls, newtype_decls, syn_decls, val_decls) = countTyClDecls tycl_decls - val_decls = length [() | SigD _ <- decls] inst_decls = length [() | InstD _ <- decls] \end{code} + +%************************************************************************ +%* * +\subsection{Errors and warnings} +%* * +%************************************************************************ + +\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} + +