X-Git-Url: http://git.megacz.com/?a=blobdiff_plain;f=ghc%2Fcompiler%2Frename%2FRename.lhs;h=094a01f4c3cb9cc885d0fd1cf224e7e18defa20e;hb=2ecf1c9f639dc75f1078e88c2e551116923f742a;hp=2d8bd929457f7bee2a8ece74f39250a122c3c956;hpb=f7ecf7234c224489be8a5e63fced903b655d92ee;p=ghc-hetmet.git diff --git a/ghc/compiler/rename/Rename.lhs b/ghc/compiler/rename/Rename.lhs index 2d8bd92..094a01f 100644 --- a/ghc/compiler/rename/Rename.lhs +++ b/ghc/compiler/rename/Rename.lhs @@ -1,258 +1,810 @@ % -% (c) The GRASP Project, Glasgow University, 1992-1996 +% (c) The GRASP Project, Glasgow University, 1992-1998 % \section[Rename]{Renaming and dependency analysis passes} \begin{code} -#include "HsVersions.h" - -module Rename ( renameModule ) where - -import PreludeGlaST ( thenPrimIO ) +module Rename ( renameModule, closeIfaceDecls, checkOldIface ) where -IMP_Ubiq() -IMPORT_1_3(List(partition)) +#include "HsVersions.h" import HsSyn -import RdrHsSyn ( RdrNameHsModule(..), RdrNameImportDecl(..) ) -import RnHsSyn ( RnName(..){-.. is for Ix hack only-}, SYN_IE(RenamedHsModule), isRnTyConOrClass, isRnWired ) - ---ToDo:rm: all for debugging only ---import Maybes ---import Name ---import Outputable ---import RnIfaces ---import PprStyle ---import Pretty ---import FiniteMap ---import Util (pprPanic, pprTrace) - -import ParseUtils ( ParsedIface(..), RdrIfaceDecl(..), RdrIfaceInst(..), - UsagesMap(..), VersionsMap(..) +import RdrHsSyn ( RdrNameHsModule, RdrNameHsDecl, RdrNameDeprecation, + RdrNameTyClDecl, RdrNameRuleDecl, RdrNameInstDecl, RdrNameImportDecl + ) +import RnHsSyn ( RenamedHsDecl, RenamedTyClDecl, RenamedRuleDecl, RenamedInstDecl, + extractHsTyNames, + instDeclFVs, tyClDeclFVs, ruleDeclFVs ) + +import CmdLineOpts ( DynFlags, DynFlag(..) ) import RnMonad -import RnNames ( getGlobalNames, SYN_IE(GlobalNameInfo) ) -import RnSource ( rnSource ) -import RnIfaces ( rnIfaces, initIfaceCache, IfaceCache ) -import RnUtils ( SYN_IE(RnEnv), extendGlobalRnEnv, emptyRnEnv ) - -import Bag ( isEmptyBag, unionBags, unionManyBags, bagToList, listToBag ) -import CmdLineOpts ( opt_HiMap, opt_NoImplicitPrelude ) -import ErrUtils ( SYN_IE(Error), SYN_IE(Warning) ) -import FiniteMap ( emptyFM, eltsFM, fmToList, addToFM, FiniteMap ) -import Maybes ( catMaybes ) -import Name ( isLocallyDefined, mkWiredInName, getLocalName, isLocalName, - origName, - Name, RdrName(..), ExportFlag(..) +import RnNames ( getGlobalNames ) +import RnSource ( rnSourceDecls, rnTyClDecl, rnIfaceRuleDecl, rnInstDecl ) +import RnIfaces ( slurpImpDecls, mkImportInfo, + getInterfaceExports, closeDecls, + RecompileRequired, recompileRequired ) ---import PprStyle -- ToDo:rm -import PrelInfo ( builtinNameMaps, builtinKeysMap, SYN_IE(BuiltinNames), SYN_IE(BuiltinKeys) ) -import Pretty -import Unique ( ixClassKey ) -import UniqFM ( emptyUFM, lookupUFM, addListToUFM_C, eltsUFM ) -import UniqSupply ( splitUniqSupply ) -import Util ( panic, assertPanic{-, pprTrace ToDo:rm-} ) +import RnHiFiles ( findAndReadIface, removeContext, loadExports, loadFixDecls, loadDeprecs ) +import RnEnv ( availName, + emptyAvailEnv, unitAvailEnv, availEnvElts, plusAvailEnv, groupAvails, + warnUnusedImports, warnUnusedLocalBinds, warnUnusedModules, + lookupOrigNames, lookupGlobalRn, newGlobalName + ) +import Module ( Module, ModuleName, WhereFrom(..), + moduleNameUserString, moduleName + ) +import Name ( Name, isLocallyDefined, NamedThing(..), getSrcLoc, + nameOccName, nameModule, + mkNameEnv, nameEnvElts, extendNameEnv + ) +import RdrName ( elemRdrEnv ) +import OccName ( occNameFlavour ) +import NameSet +import TysWiredIn ( unitTyCon, intTyCon, boolTyCon ) +import PrelNames ( mAIN_Name, pREL_MAIN_Name, pRELUDE_Name, + ioTyCon_RDR, main_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 UniqFM ( lookupUFM ) +import Maybes ( maybeToBool, catMaybes ) +import Outputable +import IO ( openFile, IOMode(..) ) +import HscTypes ( PersistentCompilerState, HomeIfaceTable, HomeSymbolTable, + ModIface(..), WhatsImported(..), + VersionInfo(..), ImportVersion, IfaceDecls(..), + GlobalRdrEnv, AvailEnv, GenAvailInfo(..), AvailInfo, + Provenance(..), ImportReason(..), initialVersionInfo, + Deprecations(..), lookupDeprec, lookupTable + ) +import List ( partition, nub ) \end{code} -\begin{code} -renameModule :: UniqSupply - -> RdrNameHsModule - -> IO (RenamedHsModule, -- output, after renaming - RnEnv, -- final env (for renaming derivings) - [Module], -- imported modules; for profiling - (Name -> ExportFlag, -- export info - ([(Name,ExportFlag)], - [(Name,ExportFlag)])), +%********************************************************* +%* * +\subsection{The main function: rename} +%* * +%********************************************************* - (UsagesMap, - VersionsMap, -- version info; for usage - [Module]), -- instance modules; for iface +\begin{code} +renameModule :: DynFlags + -> HomeIfaceTable -> HomeSymbolTable + -> PersistentCompilerState + -> Module -> RdrNameHsModule + -> IO (PersistentCompilerState, Maybe (ModIface, [RenamedHsDecl])) + -- Nothing => some error occurred in the renamer + +renameModule dflags hit hst old_pcs this_module rdr_module + = -- Initialise the renamer monad + do { + (new_pcs, errors_found, maybe_rn_stuff) + <- initRn dflags 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 :: Module -> RdrNameHsModule -> RnMG (Maybe (ModIface, [RenamedHsDecl])) +rename this_module contents@(HsModule _ _ _ imports local_decls mod_deprec loc) + = pushSrcLocRn loc $ + + -- FIND THE GLOBAL NAME ENVIRONMENT + getGlobalNames this_module contents `thenRn` \ (gbl_env, local_gbl_env, + export_avails, global_avail_env) -> + + -- 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 Nothing + else + + -- DEAL WITH DEPRECATIONS + rnDeprecs local_gbl_env mod_deprec + [d | DeprecD d <- local_decls] `thenRn` \ my_deprecs -> - Bag Error, - Bag Warning) -\end{code} + -- DEAL WITH LOCAL FIXITIES + fixitiesFromLocalDecls local_gbl_env local_decls `thenRn` \ local_fixity_env -> -ToDo: May want to arrange to return old interface for this module! -ToDo: Deal with instances (instance version, this module on instance list ???) + -- RENAME THE SOURCE + initRnMS gbl_env local_fixity_env SourceMode ( + rnSourceDecls local_decls + ) `thenRn` \ (rn_local_decls, source_fvs) -> -\begin{code} -renameModule us input@(HsModule modname _ _ imports _ _ _ _ _ _ _ _ _ _) + -- CHECK THAT main IS DEFINED, IF REQUIRED + checkMain this_module local_gbl_env `thenRn_` - = {- + -- SLURP IN ALL THE NEEDED DECLARATIONS + implicitFVs mod_name rn_local_decls `thenRn` \ implicit_fvs -> let - pp_pair (n,m) = ppBesides [ppPStr m,ppChar '.',ppPStr n] + -- 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 - pprTrace "builtins:\n" (case builtinNameMaps of { (builtin_ids, builtin_tcs) -> - ppAboves [ ppCat (map pp_pair (keysFM builtin_ids)) - , ppCat (map pp_pair (keysFM builtin_tcs)) - , ppCat (map pp_pair (keysFM builtinKeysMap)) - ]}) $ - -} - -- _scc_ "rnGlobalNames" - makeHiMap opt_HiMap >>= \ hi_files -> --- pprTrace "HiMap:\n" (ppAboves [ ppCat [ppPStr m, ppStr p] | (m,p) <- fmToList hi_files]) - initIfaceCache modname hi_files >>= \ iface_cache -> - - fixIO ( \ ~(_, _, _, _, rec_occ_fm, ~(rec_export_fn,_)) -> - let - rec_occ_fn :: Name -> [RdrName] - rec_occ_fn n = case lookupUFM rec_occ_fm n of - Nothing -> [] - Just (rn,occs) -> occs + slurpImpDecls slurp_fvs `thenRn` \ rn_imp_decls -> + + -- EXIT IF ERRORS FOUND + 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 + returnRn Nothing + else + + -- GENERATE THE VERSION/USAGE INFO + mkImportInfo mod_name imports `thenRn` \ my_usages -> - global_name_info = (builtinNameMaps, builtinKeysMap, rec_export_fn, rec_occ_fn) + -- RETURN THE RENAMED MODULE + getNameSupplyRn `thenRn` \ name_supply -> + getIfacesRn `thenRn` \ ifaces -> + 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 + + 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 - getGlobalNames iface_cache global_name_info us1 input >>= - \ (occ_env, imp_mods, unqual_imps, imp_fixes, top_errs, top_warns) -> - if not (isEmptyBag top_errs) then - return (rn_panic, rn_panic, top_errs, top_warns, emptyUFM, rn_panic) - else + -- REPORT UNUSED NAMES, AND DEBUG DUMP + reportUnusedNames mod_iface imports global_avail_env + real_source_fvs rn_imp_decls `thenRn_` - -- No top-level name errors so rename source ... - -- _scc_ "rnSource" - case initRn True modname occ_env us2 - (rnSource imp_mods unqual_imps imp_fixes input) of { - ((rn_module, export_fn, module_dotdots, src_occs), src_errs, src_warns) -> + returnRn (Just (mod_iface, final_decls)) + where + mod_name = moduleName this_module +\end{code} - --pprTrace "renameModule:" (ppCat (map (ppr PprDebug . fst) (bagToList src_occs))) $ - let - occ_fm :: UniqFM (RnName, [RdrName]) +Checking that main is defined + +\begin{code} +checkMain :: Module -> GlobalRdrEnv -> RnMG () +checkMain this_mod local_env + | moduleName this_mod == mAIN_Name + = checkRn (main_RDR `elemRdrEnv` local_env) noMainErr + | otherwise + = returnRn () +\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} - occ_list = [ (rn,(rn,[occ])) | (rn,occ) <- bagToList src_occs] - occ_fm = addListToUFM_C insert_occ emptyUFM occ_list +\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} - insert_occ (rn,olds) (rn',[new]) = (rn, insert new olds) - insert new [] = [new] - insert new xxs@(x:xs) = case cmp new x of LT_ -> new : xxs - EQ_ -> xxs - GT__ -> x : insert new xs +%********************************************************* +%* * +\subsection{Fixities} +%* * +%********************************************************* - occ_warns = map multipleOccWarn (filter multiple_occs (eltsUFM occ_fm)) +\begin{code} +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 + 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} - multiple_occs (rn, (o1:o2:_)) = getLocalName o1 /= SLIT("negate") - -- the user is rarely responsible if - -- "negate" is mentioned in multiple ways - multiple_occs _ = False - in - return (rn_module, imp_mods, - top_errs `unionBags` src_errs, - top_warns `unionBags` src_warns `unionBags` listToBag occ_warns, - occ_fm, (export_fn, module_dotdots)) - }) >>= \ (rn_module, imp_mods, errs_so_far, warns_so_far, occ_fm, export_stuff) -> +%********************************************************* +%* * +\subsection{Deprecations} +%* * +%********************************************************* - if not (isEmptyBag errs_so_far) then - return (rn_panic, rn_panic, rn_panic, rn_panic, rn_panic, errs_so_far, warns_so_far) - else +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. + +\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,(n,txt))) + Nothing -> returnRn Nothing +\end{code} + + +%************************************************************************ +%* * +\subsection{Grabbing the old interface file and checking versions} +%* * +%************************************************************************ + +\begin{code} +checkOldIface :: DynFlags + -> 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 hit hst pcs mod source_unchanged maybe_iface + = initRn dflags hit hst pcs mod $ + + -- Load the old interface file, if we havn't already got it + loadOldIface mod maybe_iface `thenRn` \ maybe_iface -> + + -- Check versions + recompileRequired mod source_unchanged maybe_iface `thenRn` \ recompile -> + + returnRn (recompile, maybe_iface) +\end{code} - -- No errors renaming source so rename the interfaces ... - -- _scc_ "preRnIfaces" + +\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 - -- split up all names that occurred in the source; between - -- those that are defined therein and those merely mentioned. - -- We also divide by tycon/class and value names (as usual). - - occ_rns = [ rn | (rn,_) <- eltsUFM occ_fm ] - -- all occurrence names, from this module and imported - - (defined_here, defined_elsewhere) - = partition isLocallyDefined occ_rns - - (_, imports_used) - = partition isRnWired defined_elsewhere - - (def_tcs, def_vals) = partition isRnTyConOrClass defined_here - (occ_tcs, occ_vals) = partition isRnTyConOrClass occ_rns - -- the occ stuff includes *all* occurrences, - -- including those for which we have definitions - - (orig_def_env, orig_def_dups) - = extendGlobalRnEnv emptyRnEnv (map pairify_rn def_vals) - (map pairify_rn def_tcs) - (orig_occ_env, orig_occ_dups) - = extendGlobalRnEnv emptyRnEnv (map pairify_rn occ_vals) - (map pairify_rn occ_tcs) - - -- This stuff is pretty dodgy right now: I think original - -- names and occurrence names may be getting entangled - -- when they shouldn't be... WDP 96/06 - - pairify_rn rn -- ToDo: move to Name? - = let - name = getName rn - in - (if isLocalName name - then Unqual (getLocalName name) - else case (origName "pairify_rn" name) of { OrigName m n -> - Qual m n } - , rn) + 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 --- ASSERT (isEmptyBag orig_occ_dups) --- (if (isEmptyBag orig_occ_dups) then \x->x --- else pprTrace "orig_occ_dups:" (ppAboves [ ppCat [ppr PprDebug m, ppr PprDebug n, ppr PprDebug o] | (m,n,o) <- bagToList orig_occ_dups])) $ - ASSERT (isEmptyBag orig_def_dups) - - -- _scc_ "rnIfaces" - rnIfaces iface_cache imp_mods us3 orig_def_env orig_occ_env - rn_module (initMustHaves ++ imports_used) >>= - \ (rn_module_with_imports, final_env, - (implicit_val_fm, implicit_tc_fm), - usage_stuff, - (iface_errs, iface_warns)) -> - - return (rn_module_with_imports, - final_env, - imp_mods, - export_stuff, - usage_stuff, - errs_so_far `unionBags` iface_errs, - warns_so_far `unionBags` iface_warns) + returnRn (Just mod_iface) + } + + where - rn_panic = panic "renameModule: aborted with errors" - - (us1, us') = splitUniqSupply us - (us2, us3) = splitUniqSupply us' - -initMustHaves :: [RnName] - -- things we *must* find declarations for, because the - -- compiler may eventually make reference to them (e.g., - -- class Eq) -initMustHaves - | opt_NoImplicitPrelude - = [{-no Prelude.hi, no point looking-}] - | otherwise - = [ name_fn (mkWiredInName u orig ExportAll) - | (orig@(OrigName mod str), (u, name_fn)) <- fmToList builtinKeysMap ] + doc_str = ptext SLIT("need usage info from") <+> ppr mod \end{code} \begin{code} -makeHiMap :: Maybe String -> IO (FiniteMap Module FilePath) - -makeHiMap Nothing = error "Rename.makeHiMap:no .hi map given by the GHC driver (?)" -makeHiMap (Just f) - = readFile f >>= \ cts -> - return (snag_mod emptyFM cts []) +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 - -- we alternate between "snag"ging mod(ule names) and path(names), - -- accumulating names (reversed) and the final resulting map - -- as we move along. + 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} - snag_mod map [] [] = map - snag_mod map (' ':cs) rmod = snag_path map (_PK_ (reverse rmod)) cs [] - snag_mod map (c:cs) rmod = snag_mod map cs (c:rmod) - snag_path map mod [] rpath = addToFM map mod (reverse rpath) - snag_path map mod ('\n':cs) rpath = snag_mod (addToFM map mod (reverse rpath)) cs [] - snag_path map mod (c:cs) rpath = snag_path map mod cs (c:rpath) + +%********************************************************* +%* * +\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 + -> 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 }) + = initRn 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) + in + closeDecls decls needed \end{code} -Warning message used herein: +%********************************************************* +%* * +\subsection{Unused names} +%* * +%********************************************************* + \begin{code} -multipleOccWarn (name, occs) sty - = ppBesides [ppStr "warning:multiple names used to refer to `", ppr sty name, ppStr "': ", - ppInterleave ppComma (map (ppr sty) occs)] +reportUnusedNames :: ModIface -> [RdrNameImportDecl] + -> AvailEnv + -> NameSet + -> [RenamedHsDecl] + -> RnMG () +reportUnusedNames my_mod_iface imports avail_env + used_names imported_decls + = warnUnusedModules unused_imp_mods `thenRn_` + warnUnusedLocalBinds bad_locals `thenRn_` + warnUnusedImports bad_imp_names `thenRn_` + printMinimalImports my_mod_iface minimal_imports `thenRn_` + warnDeprecations my_mod_iface really_used_names `thenRn_` + returnRn () + + where + gbl_env = mi_globals 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] + ] + + 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 + + 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 + + +warnDeprecations my_mod_iface 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 + mod = mi_module my_mod_iface + my_deprecs = mi_deprecs my_mod_iface + lookup_deprec hit pit n + | isLocalThing mod n = lookupDeprec my_deprecs n + | otherwise = case lookupTable hit pit n of + Just iface -> lookupDeprec (mi_deprecs iface) n + Nothing -> pprPanic "warnDeprecations:" (ppr n) + +-- ToDo: deal with original imports with 'qualified' and 'as M' clauses +printMinimalImports my_mod_iface 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 (moduleName (mi_module my_mod_iface)) + ++ ".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} + + +%********************************************************* +%* * +\subsection{Statistics} +%* * +%********************************************************* + +\begin{code} +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, + data_decls, + newtype_decls, + syn_decls, + val_decls, + inst_decls) + where + tycl_decls = [d | TyClD d <- decls] + (class_decls, data_decls, newtype_decls, syn_decls, val_decls) = countTyClDecls tycl_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)] + +noMainErr + = hsep [ptext SLIT("Module"), quotes (ppr mAIN_Name), + ptext SLIT("must include a definition for"), quotes (ptext SLIT("main"))] \end{code} + +