From: simonpj Date: Wed, 31 Dec 2003 08:23:27 +0000 (+0000) Subject: [project @ 2003-12-31 08:23:25 by simonpj] X-Git-Tag: Approx_11550_changesets_converted~159 X-Git-Url: http://git.megacz.com/?p=ghc-hetmet.git;a=commitdiff_plain;h=7473349e010c1f8f5d78afbe2b7c66345818406c [project @ 2003-12-31 08:23:25 by simonpj] ----------------------------- Improve deprecation reporting ----------------------------- [PS: the 1.31 commit of basicTypes/RdrName.lhs also belongs in this commit.] Up to now, deprecated functions are only reported when imported from the module defining them, but not when re-exporting. This seems wrong -- often a "root" module gathers exports from sub-modules. It turned out that there was a structural problem: the deprectaions were getting put in the GlobalRdrEnv, and it simply doesn't have the defining-module's interface to hand. So this commit removes gre_deprec from GRE, and moves deprecation reporting from the individual occurrences (RnEnv.lookupGreRn) to RnNames.reportUnusedNames. In many ways this is a better place for it, because there we get a global view of the entire module. For example, repeated use of a single deprecated thing will only give rise to one warning instead of multiple warnings. So here's what we now get: Foo.hs:3:0: Warning: Deprecated use of Variable `withObject' (imported from Foreign.Marshal, but defined in Foreign.Marshal.Utils) use `with' instead --- diff --git a/ghc/compiler/basicTypes/OccName.lhs b/ghc/compiler/basicTypes/OccName.lhs index d0b1128..0269678 100644 --- a/ghc/compiler/basicTypes/OccName.lhs +++ b/ghc/compiler/basicTypes/OccName.lhs @@ -359,10 +359,10 @@ setOccNameSpace sp (OccName _ occ) = OccName sp occ -- occNameFlavour is used only to generate good error messages occNameFlavour :: OccName -> String -occNameFlavour (OccName DataName _) = "Data constructor" -occNameFlavour (OccName TvName _) = "Type variable" -occNameFlavour (OccName TcClsName _) = "Type constructor or class" -occNameFlavour (OccName VarName s) = "Variable" +occNameFlavour (OccName DataName _) = "data constructor" +occNameFlavour (OccName TvName _) = "type variable" +occNameFlavour (OccName TcClsName _) = "type constructor or class" +occNameFlavour (OccName VarName s) = "" -- briefOccNameFlavour is used in debug-printing of names briefOccNameFlavour :: OccName -> String diff --git a/ghc/compiler/rename/RnEnv.lhs b/ghc/compiler/rename/RnEnv.lhs index afcfe17..b0a6996 100644 --- a/ghc/compiler/rename/RnEnv.lhs +++ b/ghc/compiler/rename/RnEnv.lhs @@ -314,10 +314,7 @@ lookupGreRn_help rdr_name lookup = do { env <- getGlobalRdrEnv ; case lookup env of [] -> returnM Nothing - [gre] -> case gre_deprec gre of - Nothing -> returnM (Just gre) - Just _ -> do { warnDeprec gre - ; returnM (Just gre) } + [gre] -> returnM (Just gre) gres -> do { addNameClashErrRn rdr_name gres ; returnM (Just (head gres)) } } @@ -724,7 +721,7 @@ shadowedNameWarn doc shadow $$ doc unknownNameErr name - = sep [text flavour <+> ptext SLIT("not in scope:"), quotes (ppr name)] + = sep [ptext SLIT("Not in scope:"), text flavour <+> quotes (ppr name)] where flavour = occNameFlavour (rdrNameOcc name) @@ -740,10 +737,4 @@ dupNamesErr descriptor (L loc name : dup_things) addErr ((ptext SLIT("Conflicting definitions for") <+> quotes (ppr name)) $$ descriptor) -warnDeprec :: GlobalRdrElt -> RnM () -warnDeprec (GRE {gre_name = name, gre_deprec = Just txt}) - = ifOptM Opt_WarnDeprecations $ - addWarn (sep [ text (occNameFlavour (nameOccName name)) <+> - quotes (ppr name) <+> text "is deprecated:", - nest 4 (ppr txt) ]) \end{code} diff --git a/ghc/compiler/rename/RnNames.lhs b/ghc/compiler/rename/RnNames.lhs index d7eaf76..527a673 100644 --- a/ghc/compiler/rename/RnNames.lhs +++ b/ghc/compiler/rename/RnNames.lhs @@ -29,15 +29,16 @@ import Module ( Module, ModuleName, moduleName, mkPackageModule, unitModuleEnvByName, unitModuleEnv, lookupModuleEnvByName, moduleEnvElts ) import Name ( Name, nameSrcLoc, nameOccName, nameModuleName, - nameParent, nameParent_maybe, isExternalName ) + nameParent, nameParent_maybe, isExternalName, nameModule ) import NameSet import NameEnv -import OccName ( srcDataName, isTcOcc, OccEnv, +import OccName ( srcDataName, isTcOcc, occNameFlavour, OccEnv, mkOccEnv, lookupOccEnv, emptyOccEnv, extendOccEnv ) import HscTypes ( GenAvailInfo(..), AvailInfo, Avails, GhciMode(..), - IfaceExport, + IfaceExport, HomePackageTable, PackageIfaceTable, availName, availNames, availsToNameSet, unQualInScope, - Deprecs(..), ModIface(..), Dependencies(..) + Deprecs(..), ModIface(..), Dependencies(..), lookupIface, + ExternalPackageState(..) ) import RdrName ( RdrName, rdrNameOcc, setRdrNameSpace, GlobalRdrEnv, mkGlobalRdrEnv, GlobalRdrElt(..), @@ -46,9 +47,10 @@ import RdrName ( RdrName, rdrNameOcc, setRdrNameSpace, Provenance(..), ImportSpec(..), isLocalGRE, pprNameProvenance ) import Outputable -import Maybes ( isJust, isNothing, catMaybes, mapCatMaybes ) +import Maybes ( isJust, isNothing, catMaybes, mapCatMaybes, seqMaybe ) import SrcLoc ( noSrcLoc, Located(..), mkGeneralSrcSpan, unLoc, noLoc ) +import BasicTypes ( DeprecTxt ) import ListSetOps ( removeDups ) import Util ( sortLt, notNull, isSingleton ) import List ( partition, insert ) @@ -180,7 +182,6 @@ importsFromImportDecl this_mod Just another_name -> another_name imp_spec = ImportSpec { is_mod = imp_mod_name, is_qual = qual_only, is_loc = loc, is_as = qual_mod_name } - mk_deprec = mi_dep_fn iface in -- Get the total imports, and filter them according to the import list @@ -308,15 +309,8 @@ importsFromLocalDecls group mod_name = moduleName this_mod prov = LocalDef mod_name gbl_env = mkGlobalRdrEnv gres - gres = [ GRE { gre_name = name, gre_prov = prov, gre_deprec = Nothing} + gres = [ GRE { gre_name = name, gre_prov = prov} | name <- all_names] - -- gre_deprecs = Nothing: don't deprecate locally defined names - -- For a start, we may be exporting a deprecated thing - -- Also we may use a deprecated thing in the defn of another - -- deprecated things. We may even use a deprecated thing in - -- the defn of a non-deprecated thing, when changing a module's - -- interface - -- Optimisation: filter out names for built-in syntax -- They just clutter up the environment (esp tuples), and the parser @@ -413,13 +407,12 @@ filterImports :: ModIface -- Complains if import spec mentions things that the module doesn't export -- Warns/informs if import spec contains duplicates. -mkGenericRdrEnv iface imp_spec avails - = mkGlobalRdrEnv [ GRE { gre_name = name, gre_prov = Imported [imp_spec] False, - gre_deprec = mi_dep_fn iface name } +mkGenericRdrEnv imp_spec avails + = mkGlobalRdrEnv [ GRE { gre_name = name, gre_prov = Imported [imp_spec] False } | avail <- avails, name <- availNames avail ] filterImports iface imp_spec Nothing total_avails - = returnM (mkAvailEnv total_avails, mkGenericRdrEnv iface imp_spec total_avails) + = returnM (mkAvailEnv total_avails, mkGenericRdrEnv imp_spec total_avails) filterImports iface imp_spec (Just (want_hiding, import_items)) total_avails = mapAndUnzipM (addLocM get_item) import_items `thenM` \ (avails, gres) -> @@ -435,7 +428,7 @@ filterImports iface imp_spec (Just (want_hiding, import_items)) total_avails keep n = not (n `elemNameSet` hidden) pruned_avails = pruneAvails keep total_avails in - returnM (mkAvailEnv pruned_avails, mkGenericRdrEnv iface imp_spec pruned_avails) + returnM (mkAvailEnv pruned_avails, mkGenericRdrEnv imp_spec pruned_avails) where import_fm :: OccEnv AvailInfo import_fm = mkOccEnv [ (nameOccName name, avail) @@ -448,8 +441,6 @@ filterImports iface imp_spec (Just (want_hiding, import_items)) total_avails bale_out item = addErr (badImportItemErr iface imp_spec item) `thenM_` returnM (emptyAvailEnv, emptyGlobalRdrEnv) - mk_deprec = mi_dep_fn iface - succeed_with :: Bool -> AvailInfo -> RnM (AvailEnv, GlobalRdrEnv) succeed_with all_explicit avail = do { loc <- getSrcSpanM @@ -457,8 +448,7 @@ filterImports iface imp_spec (Just (want_hiding, import_items)) total_avails mkGlobalRdrEnv (map (mk_gre loc) (availNames avail))) } where mk_gre loc name = GRE { gre_name = name, - gre_prov = Imported [this_imp_spec loc] (explicit name), - gre_deprec = mk_deprec name } + gre_prov = Imported [this_imp_spec loc] (explicit name) } this_imp_spec loc = imp_spec { is_loc = loc } explicit name = all_explicit || name == main_name main_name = availName avail @@ -747,11 +737,12 @@ check_occs ie occs avail \begin{code} reportUnusedNames :: TcGblEnv -> RnM () reportUnusedNames gbl_env - = warnUnusedModules unused_imp_mods `thenM_` - warnUnusedTopBinds bad_locals `thenM_` - warnUnusedImports bad_imports `thenM_` - warnDuplicateImports dup_imps `thenM_` - printMinimalImports minimal_imports + = do { warnDeprecations defined_and_used + ; warnUnusedTopBinds unused_locals + ; warnUnusedModules unused_imp_mods + ; warnUnusedImports unused_imports + ; warnDuplicateImports dup_imps + ; printMinimalImports minimal_imports } where used_names, all_used_names :: NameSet used_names = findUses (tcg_dus gbl_env) emptyNameSet @@ -764,28 +755,34 @@ reportUnusedNames gbl_env defined_names :: [GlobalRdrElt] defined_names = globalRdrEnvElts (tcg_rdr_env gbl_env) + -- Note that defined_and_used, defined_but_not_used + -- are both [GRE]; that's why we need defined_and_used + -- rather than just all_used_names defined_and_used, defined_but_not_used :: [GlobalRdrElt] (defined_and_used, defined_but_not_used) = partition is_used defined_names - - dup_imps = filter isDupImport defined_and_used is_used gre = gre_name gre `elemNameSet` all_used_names - -- Filter out the ones that are - -- (a) defined in this module, and - -- (b) not defined by a 'deriving' clause - -- The latter have an Internal Name, so we can filter them out easily - bad_locals :: [GlobalRdrElt] - bad_locals = filter is_bad defined_but_not_used - is_bad :: GlobalRdrElt -> Bool - is_bad gre = isLocalGRE gre && isExternalName (gre_name gre) + -- Find the duplicate imports + dup_imps = filter is_dup defined_and_used + is_dup (GRE {gre_prov = Imported imp_spec True}) = not (isSingleton imp_spec) + is_dup other = False + + -- Filter out the ones that are + -- (a) defined in this module, and + -- (b) not defined by a 'deriving' clause + -- The latter have an Internal Name, so we can filter them out easily + unused_locals :: [GlobalRdrElt] + unused_locals = filter is_unused_local defined_but_not_used + is_unused_local :: GlobalRdrElt -> Bool + is_unused_local gre = isLocalGRE gre && isExternalName (gre_name gre) - bad_imports :: [GlobalRdrElt] - bad_imports = filter bad_imp defined_but_not_used - bad_imp (GRE {gre_prov = Imported imp_specs True}) + unused_imports :: [GlobalRdrElt] + unused_imports = filter unused_imp defined_but_not_used + unused_imp (GRE {gre_prov = Imported imp_specs True}) = not (all (module_unused . is_mod) imp_specs) -- Don't complain about unused imports if we've already said the -- entire import is unused - bad_imp other = False + unused_imp other = False -- 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 @@ -809,7 +806,6 @@ reportUnusedNames gbl_env -- There's really no good way to detect this, so the error message -- in RnEnv.warnUnusedModules is weakened instead - -- We've carefully preserved the provenance so that we can -- construct minimal imports that import the name by (one of) -- the same route(s) as the programmer originally did. @@ -858,10 +854,48 @@ reportUnusedNames gbl_env module_unused :: ModuleName -> Bool module_unused mod = mod `elem` unused_imp_mods - -isDupImport (GRE {gre_prov = Imported imp_spec True}) = not (isSingleton imp_spec) -isDupImport other = False +--------------------- +warnDeprecations :: [GlobalRdrElt] -> RnM () +warnDeprecations used_gres + = ifOptM Opt_WarnDeprecations $ + do { hpt <- getHpt + ; eps <- getEps + ; mapM_ (check hpt (eps_PIT eps)) used_gres } + where + check hpt pit (GRE {gre_name = name, gre_prov = Imported (imp_spec:_) _}) + | Just deprec_txt <- lookupDeprec hpt pit name + = addSrcSpan (is_loc imp_spec) $ + addWarn (sep [ptext SLIT("Deprecated use of") <+> + text (occNameFlavour (nameOccName name)) <+> + quotes (ppr name), + (parens imp_msg), + (ppr deprec_txt) ]) + where + name_mod = nameModuleName name + imp_mod = is_mod imp_spec + imp_msg = ptext SLIT("imported from") <+> ppr imp_mod <> extra + extra | imp_mod == name_mod = empty + | otherwise = ptext SLIT(", but defined in") <+> ppr name_mod + + check hpt pit ok_gre = returnM () -- Local, or not deprectated + -- The Imported pattern-match: don't deprecate locally defined names + -- For a start, we may be exporting a deprecated thing + -- Also we may use a deprecated thing in the defn of another + -- deprecated things. We may even use a deprecated thing in + -- the defn of a non-deprecated thing, when changing a module's + -- interface + +lookupDeprec :: HomePackageTable -> PackageIfaceTable + -> Name -> Maybe DeprecTxt +lookupDeprec hpt pit n + = case lookupIface hpt pit (nameModule n) of + Just iface -> mi_dep_fn iface n `seqMaybe` -- Bleat if the thing, *or + mi_dep_fn iface (nameParent n) -- its parent*, is deprec'd + Nothing -> pprPanic "lookupDeprec" (ppr n) + -- By now all the interfaces should have been loaded + +--------------------- warnDuplicateImports :: [GlobalRdrElt] -> RnM () warnDuplicateImports gres = ifOptM Opt_WarnUnusedImports (mapM_ warn gres) diff --git a/ghc/compiler/typecheck/TcRnDriver.lhs b/ghc/compiler/typecheck/TcRnDriver.lhs index d0e45d5..454f43d 100644 --- a/ghc/compiler/typecheck/TcRnDriver.lhs +++ b/ghc/compiler/typecheck/TcRnDriver.lhs @@ -808,8 +808,7 @@ getModuleExports :: ModuleName -> TcM GlobalRdrEnv getModuleExports mod = do { iface <- load_iface mod ; avails <- exportsToAvails (mi_exports iface) - ; let { gres = [ GRE { gre_name = name, gre_prov = vanillaProv mod, - gre_deprec = mi_dep_fn iface name } + ; let { gres = [ GRE { gre_name = name, gre_prov = vanillaProv mod } | avail <- avails, name <- availNames avail ] } ; returnM (mkGlobalRdrEnv gres) }