X-Git-Url: http://git.megacz.com/?a=blobdiff_plain;f=ghc%2Fcompiler%2Frename%2FRename.lhs;h=0fdd0554e0f89ffd3fcdfedc58a73cfd8e7808c2;hb=aa44169c3c01243cdbf38f50f58e80477586552c;hp=ab38df647ea3dc275c1ad7cac8bce1c652c6f639;hpb=6f7e6ae4b4c930e2ad7dfe9d6485871aacd1b623;p=ghc-hetmet.git diff --git a/ghc/compiler/rename/Rename.lhs b/ghc/compiler/rename/Rename.lhs index ab38df6..0fdd055 100644 --- a/ghc/compiler/rename/Rename.lhs +++ b/ghc/compiler/rename/Rename.lhs @@ -9,159 +9,209 @@ module Rename ( renameModule ) where #include "HsVersions.h" import HsSyn -import RdrHsSyn ( RdrNameHsModule ) +import HsPragmas ( DataPragmas(..) ) +import RdrHsSyn ( RdrNameHsModule, RdrNameHsDecl, RdrNameDeprecation ) import RnHsSyn ( RenamedHsModule, RenamedHsDecl, extractHsTyNames, extractHsCtxtTyNames ) -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, removeContext +import RnIfaces ( getImportedInstDecls, importDecl, mkImportExportInfo, + getInterfaceExports, + getImportedRules, getSlurped, removeContext, + loadBuiltinRules, getDeferredDecls, ImportDeclResult(..) ) -import RnEnv ( availName, availNames, availsToNameSet, - warnUnusedTopNames, mapFvRn, lookupImplicitOccRn, - FreeVars, plusFVs, plusFV, unitFV, emptyFVs, isEmptyFVs +import RnEnv ( availName, availsToNameSet, + emptyAvailEnv, unitAvailEnv, availEnvElts, plusAvailEnv, + warnUnusedImports, warnUnusedLocalBinds, warnUnusedModules, + lookupOrigNames, unknownNameErr, + FreeVars, plusFVs, plusFV, unitFV, emptyFVs, isEmptyFVs, addOneFV ) -import Module ( Module, ModuleName, pprModule, mkSearchPath, mkThisModule ) -import Name ( Name, isLocallyDefined, - NamedThing(..), ImportReason(..), Provenance(..), - pprOccName, nameOccName, - getNameProvenance, - maybeWiredInTyConName, maybeWiredInIdName, isWiredInName +import Module ( Module, ModuleName, WhereFrom(..), + moduleNameUserString, moduleName, mkModuleInThisPackage ) +import Name ( Name, isLocallyDefined, NamedThing(..), getSrcLoc, + nameOccName, nameUnique, nameModule, +-- maybeUserImportedFrom, +-- isUserImportedExplicitlyName, isUserImportedName, +-- maybeWiredInTyConName, maybeWiredInIdName, + isUserExportedName, toRdrName, + nameEnvElts, extendNameEnv + ) +import OccName ( occNameFlavour, isValOcc ) import Id ( idType ) -import DataCon ( dataConTyCon, dataConType ) -import TyCon ( TyCon, tyConDataCons, isSynTyCon, getSynTyConDefn ) -import RdrName ( RdrName ) +import TyCon ( isSynTyCon, getSynTyConDefn ) import NameSet -import PrelMods ( mAIN_Name, pREL_MAIN_Name ) import TysWiredIn ( unitTyCon, intTyCon, doubleTyCon, boolTyCon ) -import PrelInfo ( ioTyCon_NAME, numClass_RDR, thinAirIdNames, derivingOccurrences ) -import Type ( namesOfType, funTyCon ) -import ErrUtils ( pprBagOfErrors, pprBagOfWarnings, - doIfSet, dumpIfSet, ghcExit +import PrelRules ( builtinRules ) +import PrelNames ( mAIN_Name, pREL_MAIN_Name, pRELUDE_Name, + ioTyCon_RDR, + unpackCString_RDR, unpackCStringFoldr_RDR, unpackCStringUtf8_RDR, + eqString_RDR ) -import BasicTypes ( NewOrData(..) ) +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 ( fmToList, delListFromFM, addToFM, sizeFM, eltsFM ) +import FiniteMap ( FiniteMap, eltsFM, fmToList, emptyFM, lookupFM, + addToFM_C, elemFM, addToFM + ) import UniqSupply ( UniqSupply ) import UniqFM ( lookupUFM ) -import Util ( equivClasses ) -import Maybes ( maybeToBool ) +import SrcLoc ( noSrcLoc ) +import Maybes ( maybeToBool, expectJust ) 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 \end{code} \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) +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 - initRn mod_name us (mkSearchPath opt_HiMap) loc - (rename this_mod) >>= - \ (maybe_rn_stuff, rn_errs_bag, rn_warns_bag) -> + 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 - 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) - ) >> + printErrorsAndWarnings (rn_warns_bag, rn_errs_bag) ; + + -- Dump any debugging output + dump_action ; -- Return results - return maybe_rn_stuff + if not (isEmptyBag rn_errs_bag) then + return (old_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 :: 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 -> -- 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` \ dump_action -> + returnRn (Nothing, dump_action) ; + + Just (gbl_env, local_gbl_env, export_avails, global_avail_env, old_iface) -> + + -- DEAL WITH DEPRECATIONS + rnDeprecs local_gbl_env mod_deprec 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 = implicit_fvs `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 -> + loadBuiltinRules builtinRules `thenRn_` + 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` \ dump_action -> + checkErrsRn `thenRn` \ no_errs_so_far -> if not no_errs_so_far then -- Found errors already, so exit now - rnStats [] `thenRn_` - returnRn Nothing + returnRn (Nothing, dump_action) 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_` + mkImportExportInfo mod_name export_avails imports `thenRn` \ (my_exports, 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 :: [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 + } in - rnStats rn_imp_decls `thenRn_` - returnRn (Just (mkThisModule mod_name, - renamed_module, - (has_orphans, my_usages, export_env), - name_supply, - direct_import_mods)) + + -- 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, dump_action) } where trashed_exports = {-trace "rnSource:trashed_exports"-} Nothing trashed_imports = {-trace "rnSource:trashed_imports"-} [] @@ -172,35 +222,35 @@ mentioned explicitly, but which might be needed by the type checker. \begin{code} implicitFVs mod_name decls - = mapRn lookupImplicitOccRn implicit_occs `thenRn` \ implicit_names -> - returnRn (implicit_main `plusFV` - mkNameSet default_tys `plusFV` - mkNameSet thinAirIdNames `plusFV` - mkNameSet implicit_names) - + = 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 = foldr ((++) . get) [] decls + 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 (DefD _) = [numClass_RDR] - get (TyClD (TyData _ _ _ _ _ (Just deriv_classes) _ _)) + get (TyClD (TyData _ _ _ _ _ _ (Just deriv_classes) _ _ _ _)) = concat (map get_deriv deriv_classes) get other = [] @@ -217,16 +267,39 @@ isOrphanDecl (InstD (InstDecl inst_ty _ _ _ _)) -- The decl is an orphan if Baz and T are both not locally defined, -- even if Foo *is* locally defined -isOrphanDecl (RuleD (RuleDecl _ _ _ lhs _ _)) +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} +\begin{code} +dupDefaultDeclErrRn (DefaultDecl _ locn1 : dup_things) + = pushSrcLocRn locn1 $ + addErrRn msg + 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 +\end{code} + + %********************************************************* %* * \subsection{Slurping declarations} @@ -240,96 +313,81 @@ slurpImpDecls source_fvs -- The current slurped-set records all local things getSlurped `thenRn` \ source_binders -> - slurpSourceRefs source_binders source_fvs `thenRn` \ (decls1, needed1, inst_gates) -> + slurpSourceRefs source_binders source_fvs `thenRn` \ (decls, needed) -> + + -- Then get everything else + closeDecls decls needed `thenRn` \ decls1 -> - -- Now we can get the instance decls - slurpInstDecls decls1 needed1 inst_gates `thenRn` \ (decls2, needed2) -> + -- Finally, get any deferred data type decls + slurpDeferredDecls decls1 `thenRn` \ final_decls -> - -- And finally get everything else - closeDecls decls2 needed2 + returnRn final_decls ------------------------------------------------------- slurpSourceRefs :: NameSet -- Variables defined in source -> FreeVars -- Variables referenced in source -> RnMG ([RenamedHsDecl], - FreeVars, -- Un-satisfied needs - FreeVars) -- "Gates" + FreeVars) -- Un-satisfied needs -- The declaration (and hence home module) of each gate has -- already been loaded slurpSourceRefs source_binders source_fvs - = go [] -- Accumulating decls - emptyFVs -- Unsatisfied needs - source_fvs -- Accumulating gates - (nameSetToList source_fvs) -- Gates whose defn hasn't been loaded yet + = go_outer [] -- Accumulating decls + emptyFVs -- Unsatisfied needs + emptyFVs -- Accumulating gates + (nameSetToList source_fvs) -- Things whose defn hasn't been loaded yet where - go decls fvs gates [] - = returnRn (decls, fvs, gates) - - go decls fvs gates (wanted_name:refs) - | isWiredInName wanted_name - = load_home wanted_name `thenRn_` - go decls fvs (gates `plusFV` getWiredInGates wanted_name) refs - - | otherwise - = importDecl wanted_name `thenRn` \ maybe_decl -> - case maybe_decl of - -- No declaration... (already slurped, or local) - Nothing -> go decls fvs gates refs - Just decl -> rnIfaceDecl decl `thenRn` \ (new_decl, fvs1) -> - let - new_gates = getGates source_fvs new_decl - in - go (new_decl : decls) - (fvs1 `plusFV` fvs) - (gates `plusFV` new_gates) - (nameSetToList new_gates ++ refs) - - -- When we find a wired-in name we must load its - -- home module so that we find any instance decls therein - load_home name - | name `elemNameSet` source_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 + -- The outer loop repeatedly slurps the decls for the current gates + -- and the instance decls + + -- 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} -% -@slurpInstDecls@ imports appropriate instance decls. -It has to incorporate a loop, because consider -\begin{verbatim} - instance Foo a => Baz (Maybe a) where ... -\end{verbatim} -It may be that @Baz@ and @Maybe@ are used in the source module, -but not @Foo@; so we need to chase @Foo@ too. -\begin{code} -slurpInstDecls decls needed gates - | isEmptyFVs gates - = returnRn (decls, needed) - - | otherwise - = getImportedInstDecls gates `thenRn` \ inst_decls -> - rnInstDecls decls needed emptyFVs inst_decls `thenRn` \ (decls1, needed1, gates1) -> - slurpInstDecls decls1 needed1 gates1 - where - 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 - +\begin{code} ------------------------------------------------------- -- closeDecls keeps going until the free-var set is empty closeDecls decls needed @@ -346,17 +404,6 @@ closeDecls decls needed ------------------------------------------------------- -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 @@ -368,14 +415,67 @@ slurpDecls decls needed ------------------------------------------------------- slurpDecl decls fvs wanted_name - = importDecl wanted_name `thenRn` \ maybe_decl -> - case maybe_decl of - -- No declaration... (wired in thing) - Nothing -> returnRn (decls, fvs) - + = importDecl wanted_name `thenRn` \ import_result -> + case import_result of -- Found a declaration... rename it - Just decl -> rnIfaceDecl decl `thenRn` \ (new_decl, fvs1) -> - returnRn (new_decl:decls, fvs1 `plusFV` fvs) + 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) +\end{code} + + +%********************************************************* +%* * +\subsection{Deferred declarations} +%* * +%********************************************************* + +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. \end{code} @@ -403,32 +503,43 @@ vars of the source program, and extracts from the decl the gate names. 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 +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) - (map getTyVarName tvs) + (hsTyVarNames tvs) -- A type synonym type constructor isn't a "gate" for instance decls -getGates source_fvs (TyClD (TyData _ ctxt tycon tvs cons _ _ _)) +getGates source_fvs (TyClD (TyData _ ctxt tycon tvs cons _ _ _ _ _ _)) = delListFromNameSet (foldr (plusFV . get) (extractHsCtxtTyNames ctxt) cons) - (map getTyVarName tvs) + (hsTyVarNames tvs) `addOneToNameSet` tycon where - get (ConDecl n tvs ctxt details _) + 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) _) + (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 @@ -440,14 +551,11 @@ getGates source_fvs (TyClD (TyData _ ctxt tycon tvs cons _ _ _)) 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 get_field (fs,t) | any (`elemNameSet` source_fvs) fs = get_bang t | otherwise = emptyFVs - get_bang (Banged t) = extractHsTyNames t - get_bang (Unbanged t) = extractHsTyNames t - get_bang (Unpacked t) = extractHsTyNames t + get_bang bty = extractHsTyNames (getBangType bty) getGates source_fvs other_decl = emptyFVs \end{code} @@ -481,60 +589,262 @@ getInstDeclGates other = emptyFVs %********************************************************* %* * +\subsection{Fixities} +%* * +%********************************************************* + +\begin{code} +fixitiesFromLocalDecls :: GlobalRdrEnv -> [RdrNameHsDecl] -> RnMG FixityEnv +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 -> FixityEnv -> RdrNameHsDecl -> RnMG FixityEnv + 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 + 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,_):_) -> + + -- 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{Deprecations} +%* * +%********************************************************* + +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 + -> [RdrNameHsDecl] -> RnMG [RdrNameDeprecation] +rnDeprecs gbl_env mod_deprec decls + = mapRn rn_deprec deprecs `thenRn_` + returnRn (extra_deprec ++ deprecs) + 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 () +\end{code} + + +%********************************************************* +%* * \subsection{Unused names} %* * %********************************************************* \begin{code} -reportUnusedNames gbl_env avail_env (ExportEnv export_avails _) mentioned_names +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 avail - | sub_name <- nameSetToList used_names, - let avail = case lookupNameEnv avail_env sub_name of - Just avail -> avail - Nothing -> WARN( True, text "reportUnusedName: not in avail_env" <+> ppr sub_name ) - Avail sub_name + 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 = mkNameSet (concat (rdrEnvElts gbl_env)) - defined_but_not_used = - nameSetToList (defined_names `minusNameSet` really_used_names) + 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_guys = filter reportableUnusedName defined_but_not_used - in - warnUnusedTopNames bad_guys + 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 + ] -reportableUnusedName :: Name -> Bool -reportableUnusedName name - = explicitlyImported (getNameProvenance name) + 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 + + in + 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 ()) + +-- 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 -> + ioToRnM (do { h <- openFile filename WriteMode ; + printForUser h (vcat (map ppr_mod_ie mod_ies)) + }) `thenRn_` + returnRn () 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 - -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 () + 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 (moduleName 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 (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) + +rnDump :: [RenamedHsDecl] -- Renamed imported decls + -> [RenamedHsDecl] -- Renamed local decls + -> RnMG (IO ()) +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 ()) \end{code} - %********************************************************* %* * \subsection{Statistics} @@ -599,3 +909,27 @@ count_decls 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] +\end{code}