X-Git-Url: http://git.megacz.com/?a=blobdiff_plain;f=ghc%2Fcompiler%2Frename%2FRnNames.lhs;h=62cb2dbb837bf3263f184cf3cae82f6eb178935a;hb=3721dd37a707d2aacb5cac814410a78096e28a2c;hp=d7eaf76e2e5375763c7260f6754e333c7217b5df;hpb=f714e6b642fd614a9971717045ae47c3d871275e;p=ghc-hetmet.git diff --git a/ghc/compiler/rename/RnNames.lhs b/ghc/compiler/rename/RnNames.lhs index d7eaf76..62cb2db 100644 --- a/ghc/compiler/rename/RnNames.lhs +++ b/ghc/compiler/rename/RnNames.lhs @@ -6,7 +6,8 @@ \begin{code} module RnNames ( rnImports, importsFromLocalDecls, exportsFromAvail, - reportUnusedNames, mkModDeps, exportsToAvails + reportUnusedNames, reportDeprecations, + mkModDeps, exportsToAvails ) where #include "HsVersions.h" @@ -29,15 +30,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 +48,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 +183,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 +310,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 +408,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 +429,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 +442,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 +449,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 @@ -574,9 +565,8 @@ type ExportAccum -- The type of the accumulating parameter of -- the main worker function in exportsFromAvail = ([ModuleName], -- 'module M's seen so far ExportOccMap, -- Tracks exported occurrence names - AvailEnv) -- The accumulated exported stuff, kept in an env - -- so we can common-up related AvailInfos -emptyExportAccum = ([], emptyOccEnv, emptyAvailEnv) + NameSet) -- The accumulated exported stuff +emptyExportAccum = ([], emptyOccEnv, emptyNameSet) type ExportOccMap = OccEnv (Name, IE RdrName) -- Tracks what a particular exported OccName @@ -587,7 +577,7 @@ type ExportOccMap = OccEnv (Name, IE RdrName) exportsFromAvail :: Bool -- False => no 'module M(..) where' header at all -> Maybe [Located (IE RdrName)] -- Nothing => no explicit export list - -> RnM Avails + -> RnM NameSet -- Complains if two distinct exports have same OccName -- Warns about identical exports. -- Complains about exports items not in scope @@ -610,33 +600,27 @@ exportsFromAvail explicit_mod exports exports_from_avail real_exports rdr_env imports } -exports_from_avail Nothing rdr_env - imports@(ImportAvails { imp_env = entity_avail_env }) +exports_from_avail Nothing rdr_env imports = -- Export all locally-defined things -- We do this by filtering the global RdrEnv, - -- keeping only things that are (a) qualified, - -- (b) locally defined, (c) a 'main' name - -- Then we look up in the entity-avail-env - return [ lookupAvailEnv entity_avail_env name - | gre <- globalRdrEnvElts rdr_env, - isLocalGRE gre, - let name = gre_name gre, - isNothing (nameParent_maybe name) -- Main things only - ] + -- keeping only things that are locally-defined + return (mkNameSet [ gre_name gre + | gre <- globalRdrEnvElts rdr_env, + isLocalGRE gre ]) exports_from_avail (Just export_items) rdr_env (ImportAvails { imp_qual = mod_avail_env, imp_env = entity_avail_env }) = foldlM (exports_from_litem) emptyExportAccum - export_items `thenM` \ (_, _, export_avail_map) -> - returnM (nameEnvElts export_avail_map) + export_items `thenM` \ (_, _, exports) -> + returnM exports where exports_from_litem :: ExportAccum -> Located (IE RdrName) -> RnM ExportAccum exports_from_litem acc = addLocM (exports_from_item acc) exports_from_item :: ExportAccum -> IE RdrName -> RnM ExportAccum - exports_from_item acc@(mods, occs, avails) ie@(IEModuleContents mod) + exports_from_item acc@(mods, occs, exports) ie@(IEModuleContents mod) | mod `elem` mods -- Duplicate export of M = do { warn_dup_exports <- doptM Opt_WarnDuplicateExports ; warnIf warn_dup_exports (dupModuleExport mod) ; @@ -649,23 +633,19 @@ exports_from_avail (Just export_items) rdr_env Just avail_env -> let - mod_avails = [ filtered_avail - | avail <- availEnvElts avail_env, - let mb_avail = filter_unqual rdr_env avail, - isJust mb_avail, - let Just filtered_avail = mb_avail] - - avails' = foldl addAvail avails mod_avails + new_exports = [ name | avail <- availEnvElts avail_env, + name <- availNames avail, + inScopeUnqual rdr_env name ] in + -- This check_occs not only finds conflicts between this item -- and others, but also internally within this item. That is, -- if 'M.x' is in scope in several ways, we'll have several -- members of mod_avails with the same OccName. + check_occs ie occs new_exports `thenM` \ occs' -> + returnM (mod:mods, occs', addListToNameSet exports new_exports) - foldlM (check_occs ie) occs mod_avails `thenM` \ occs' -> - returnM (mod:mods, occs', avails') - - exports_from_item acc@(mods, occs, avails) ie + exports_from_item acc@(mods, occs, exports) ie = lookupGlobalOccRn (ieName ie) `thenM` \ name -> if isUnboundName name then returnM acc -- Avoid error cascade @@ -684,41 +664,34 @@ exports_from_avail (Just export_items) rdr_env Just export_avail -> -- Phew! It's OK! Now to check the occurrence stuff! - checkForDodgyExport ie avail `thenM_` - check_occs ie occs export_avail `thenM` \ occs' -> - returnM (mods, occs', addAvail avails export_avail) + + let + new_exports = availNames export_avail + in + checkForDodgyExport ie new_exports `thenM_` + check_occs ie occs new_exports `thenM` \ occs' -> + returnM (mods, occs', addListToNameSet exports new_exports) } ------------------------------- -filter_unqual :: GlobalRdrEnv -> AvailInfo -> Maybe AvailInfo --- Filter the Avail by what's in scope unqualified -filter_unqual env (Avail n) - | in_scope env n = Just (Avail n) - | otherwise = Nothing -filter_unqual env (AvailTC n ns) - | not (null ns') = Just (AvailTC n ns') - | otherwise = Nothing - where - ns' = filter (in_scope env) ns - -in_scope :: GlobalRdrEnv -> Name -> Bool +inScopeUnqual :: GlobalRdrEnv -> Name -> Bool -- Checks whether the Name is in scope unqualified, -- regardless of whether it's ambiguous or not -in_scope env n = any unQualOK (lookupGRE_Name env n) +inScopeUnqual env n = any unQualOK (lookupGRE_Name env n) ------------------------------- -checkForDodgyExport :: IE RdrName -> AvailInfo -> RnM () -checkForDodgyExport (IEThingAll tc) (AvailTC _ [n]) = addWarn (dodgyExportWarn tc) +checkForDodgyExport :: IE RdrName -> [Name] -> RnM () +checkForDodgyExport (IEThingAll tc) [n] = addWarn (dodgyExportWarn tc) -- This occurs when you import T(..), but -- only export T abstractly. The single [n] -- in the AvailTC is the type or class itself checkForDodgyExport _ _ = return () ------------------------------- -check_occs :: IE RdrName -> ExportOccMap -> AvailInfo -> RnM ExportOccMap -check_occs ie occs avail - = foldlM check occs (availNames avail) +check_occs :: IE RdrName -> ExportOccMap -> [Name] -> RnM ExportOccMap +check_occs ie occs names + = foldlM check occs names where check occs name = case lookupOccEnv occs name_occ of @@ -740,18 +713,72 @@ check_occs ie occs avail %********************************************************* %* * -\subsection{Unused names} + Deprecations +%* * +%********************************************************* + +\begin{code} +reportDeprecations :: TcGblEnv -> RnM () +reportDeprecations tcg_env + = ifOptM Opt_WarnDeprecations $ + do { hpt <- getHpt + ; eps <- getEps + ; mapM_ (check hpt (eps_PIT eps)) all_gres } + where + used_names = findUses (tcg_dus tcg_env) emptyNameSet + all_gres = globalRdrEnvElts (tcg_rdr_env tcg_env) + + check hpt pit (GRE {gre_name = name, gre_prov = Imported (imp_spec:_) _}) + | name `elemNameSet` used_names + , 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 used, 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 + +gre_is_used :: NameSet -> GlobalRdrElt -> Bool +gre_is_used used_names gre = gre_name gre `elemNameSet` used_names +\end{code} + +%********************************************************* +%* * + Unused names %* * %********************************************************* \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 { 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 +791,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 + (defined_and_used, defined_but_not_used) + = partition (gre_is_used all_used_names) defined_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 +842,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 +890,7 @@ 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 - +--------------------- warnDuplicateImports :: [GlobalRdrElt] -> RnM () warnDuplicateImports gres = ifOptM Opt_WarnUnusedImports (mapM_ warn gres)