\begin{code}
module RnNames (
- rnImports, importsFromLocalDecls, exportsFromAvail,
- reportUnusedNames, mkModDeps, exportsToAvails
+ rnImports, importsFromLocalDecls,
+ reportUnusedNames, reportDeprecations,
+ mkModDeps, exportsToAvails, exportsFromAvail
) where
#include "HsVersions.h"
import TcRnMonad
import FiniteMap
-import PrelNames ( pRELUDE_Name, isBuiltInSyntaxName, isUnboundName,
- main_RDR_Unqual )
-import Module ( Module, ModuleName, moduleName, mkPackageModule,
- moduleNameUserString, isHomeModule,
- unitModuleEnvByName, unitModuleEnv,
- lookupModuleEnvByName, moduleEnvElts )
-import Name ( Name, nameSrcLoc, nameOccName, nameModuleName,
- nameParent, nameParent_maybe, isExternalName )
+import PrelNames ( pRELUDE, isUnboundName, main_RDR_Unqual )
+import Module ( Module, moduleUserString,
+ unitModuleEnv, unitModuleEnv,
+ lookupModuleEnv, moduleEnvElts, foldModuleEnv )
+import Name ( Name, nameSrcLoc, nameOccName, nameModule, isWiredInName,
+ nameParent, nameParent_maybe, isExternalName,
+ isBuiltInSyntax )
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,
- availName, availNames, availsToNameSet, unQualInScope,
- Deprecs(..), ModIface(..), Dependencies(..)
+import HscTypes ( GenAvailInfo(..), AvailInfo, GhciMode(..),
+ IfaceExport, HomePackageTable, PackageIfaceTable,
+ availNames, unQualInScope,
+ Deprecs(..), ModIface(..), Dependencies(..),
+ lookupIface, ExternalPackageState(..),
+ IfacePackage(..)
)
import RdrName ( RdrName, rdrNameOcc, setRdrNameSpace,
GlobalRdrEnv, mkGlobalRdrEnv, GlobalRdrElt(..),
Provenance(..), ImportSpec(..),
isLocalGRE, pprNameProvenance )
import Outputable
-import Maybes ( isJust, isNothing, catMaybes, mapCatMaybes )
+import Maybes ( isNothing, catMaybes, mapCatMaybes, seqMaybe, orElse )
import SrcLoc ( noSrcLoc, Located(..), mkGeneralSrcSpan,
- unLoc, noLoc )
+ unLoc, noLoc, srcLocSpan, combineSrcSpans, SrcSpan )
+import BasicTypes ( DeprecTxt )
import ListSetOps ( removeDups )
-import Util ( sortLt, notNull, isSingleton )
-import List ( partition, insert )
+import Util ( sortLe, notNull, isSingleton )
+import List ( partition )
import IO ( openFile, IOMode(..) )
\end{code}
-> RnM (GlobalRdrEnv, ImportAvails)
rnImports imports
- = -- PROCESS IMPORT DECLS
+ = do { -- PROCESS IMPORT DECLS
-- Do the non {- SOURCE -} ones first, so that we get a helpful
-- warning for {- SOURCE -} ones that are unnecessary
- getModule `thenM` \ this_mod ->
- doptM Opt_NoImplicitPrelude `thenM` \ opt_no_prelude ->
- let
- all_imports = mk_prel_imports this_mod opt_no_prelude ++ imports
- (source, ordinary) = partition is_source_import all_imports
- is_source_import (L _ (ImportDecl _ is_boot _ _ _)) = is_boot
-
- get_imports = importsFromImportDecl this_mod
- in
- mappM get_imports ordinary `thenM` \ stuff1 ->
- mappM get_imports source `thenM` \ stuff2 ->
+ this_mod <- getModule
+ ; implicit_prelude <- doptM Opt_ImplicitPrelude
+ ; let
+ all_imports = mk_prel_imports this_mod implicit_prelude ++ imports
+ (source, ordinary) = partition is_source_import all_imports
+ is_source_import (L _ (ImportDecl _ is_boot _ _ _)) = is_boot
+
+ get_imports = importsFromImportDecl this_mod
+
+ ; stuff1 <- mappM get_imports ordinary
+ ; stuff2 <- mappM get_imports source
-- COMBINE RESULTS
- let
+ ; let
(imp_gbl_envs, imp_avails) = unzip (stuff1 ++ stuff2)
gbl_env :: GlobalRdrEnv
gbl_env = foldr plusGlobalRdrEnv emptyGlobalRdrEnv imp_gbl_envs
all_avails :: ImportAvails
all_avails = foldr plusImportAvails emptyImportAvails imp_avails
- in
+
-- ALL DONE
- returnM (gbl_env, all_avails)
+ ; return (gbl_env, all_avails) }
where
-- NB: opt_NoImplicitPrelude is slightly different to import Prelude ();
-- because the former doesn't even look at Prelude.hi for instance
-- declarations, whereas the latter does.
- mk_prel_imports this_mod no_prelude
- | moduleName this_mod == pRELUDE_Name
+ mk_prel_imports this_mod implicit_prelude
+ | this_mod == pRELUDE
|| explicit_prelude_import
- || no_prelude
+ || not implicit_prelude
= []
| otherwise = [preludeImportDecl]
explicit_prelude_import
= notNull [ () | L _ (ImportDecl mod _ _ _ _) <- imports,
- unLoc mod == pRELUDE_Name ]
+ unLoc mod == pRELUDE ]
preludeImportDecl
= L loc $
- ImportDecl (L loc pRELUDE_Name)
+ ImportDecl (L loc pRELUDE)
False {- Not a boot interface -}
False {- Not qualified -}
Nothing {- No "as" -}
importsFromImportDecl this_mod
(L loc (ImportDecl loc_imp_mod_name want_boot qual_only as_mod imp_details))
=
- addSrcSpan loc $
+ setSrcSpan loc $
-- If there's an error in loadInterface, (e.g. interface
-- file not found) we get lots of spurious errors from 'filterImports'
let
imp_mod_name = unLoc loc_imp_mod_name
- this_mod_name = moduleName this_mod
doc = ppr imp_mod_name <+> ptext SLIT("is directly imported")
in
loadSrcInterface doc imp_mod_name want_boot `thenM` \ iface ->
deps = mi_deps iface
filtered_exports = filter not_this_mod (mi_exports iface)
- not_this_mod (mod,_) = mod /= this_mod_name
+ not_this_mod (mod,_) = mod /= this_mod
-- If the module exports anything defined in this module, just ignore it.
-- Reason: otherwise it looks as if there are two local definition sites
-- for the thing, and an error gets reported. Easiest thing is just to
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
exportsToAvails filtered_exports `thenM` \ total_avails ->
filterImports iface imp_spec
imp_details total_avails `thenM` \ (avail_env, gbl_env) ->
+ getDOpts `thenM` \ dflags ->
+
let
-- Compute new transitive dependencies
- orphans | is_orph = insert imp_mod_name (dep_orphs deps)
+
+ orphans | is_orph = ASSERT( not (imp_mod_name `elem` dep_orphs deps) )
+ imp_mod_name : dep_orphs deps
| otherwise = dep_orphs deps
(dependent_mods, dependent_pkgs)
- | isHomeModule imp_mod
- = -- Imported module is from the home package
- -- Take its dependent modules and
- -- (a) remove this_mod (might be there as a hi-boot)
- -- (b) add imp_mod itself
+ = case mi_package iface of
+ ThisPackage ->
+ -- Imported module is from the home package
+ -- Take its dependent modules and add imp_mod itself
-- Take its dependent packages unchanged
- ((imp_mod_name, want_boot) : filter not_self (dep_mods deps), dep_pkgs deps)
-
- | otherwise
- = -- Imported module is from another package
+ --
+ -- NB: (dep_mods deps) might include a hi-boot file
+ -- for the module being compiled, CM. Do *not* filter
+ -- this out (as we used to), because when we've
+ -- finished dealing with the direct imports we want to
+ -- know if any of them depended on CM.hi-boot, in
+ -- which case we should do the hi-boot consistency
+ -- check. See LoadIface.loadHiBootInterface
+ ((imp_mod_name, want_boot) : dep_mods deps, dep_pkgs deps)
+
+ ExternalPackage pkg ->
+ -- Imported module is from another package
-- Dump the dependent modules
-- Add the package imp_mod comes from to the dependent packages
- -- from imp_mod
- ([], insert (mi_package iface) (dep_pkgs deps))
-
- not_self (m, _) = m /= this_mod_name
+ ASSERT2( not (pkg `elem` dep_pkgs deps), ppr pkg <+> ppr (dep_pkgs deps) )
+ ([], pkg : dep_pkgs deps)
import_all = case imp_details of
Just (is_hiding, ls) -- Imports are spec'd explicitly
-- module M ( module P ) where ...
-- Then we must export whatever came from P unqualified.
imports = ImportAvails {
- imp_qual = unitModuleEnvByName qual_mod_name avail_env,
- imp_env = avail_env,
- imp_mods = unitModuleEnv imp_mod (imp_mod, import_all),
+ imp_env = unitModuleEnv qual_mod_name avail_env,
+ imp_mods = unitModuleEnv imp_mod (imp_mod, import_all, loc),
imp_orphs = orphans,
imp_dep_mods = mkModDeps dependent_mods,
imp_dep_pkgs = dependent_pkgs }
returnM (gbl_env, imports)
-exportsToAvails :: [IfaceExport] -> TcRnIf gbl lcl Avails
+exportsToAvails :: [IfaceExport] -> TcRnIf gbl lcl NameSet
exportsToAvails exports
- = do { avails_by_module <- mappM do_one exports
- ; return (concat avails_by_module) }
+ = foldlM do_one emptyNameSet exports
where
- do_one (mod_name, exports) = mapM (do_avail mod_name) exports
- do_avail mod_nm (Avail n) = do { n' <- lookupOrig mod_nm n;
- ; return (Avail n') }
- do_avail mod_nm (AvailTC n ns) = do { n' <- lookupOrig mod_nm n
- ; ns' <- mappM (lookup_sub n') ns
- ; return (AvailTC n' ns') }
+ do_one acc (mod, exports) = foldlM (do_avail mod) acc exports
+ do_avail mod acc (Avail n) = do { n' <- lookupOrig mod n;
+ ; return (addOneToNameSet acc n') }
+ do_avail mod acc (AvailTC p_occ occs)
+ = do { p_name <- lookupOrig mod p_occ
+ ; ns <- mappM (lookup_sub p_name) occs
+ ; return (addListToNameSet acc ns) }
+ -- Remember that 'occs' is all the exported things, including
+ -- the parent. It's possible to export just class ops without
+ -- the class, via C( op ). If the class was exported too we'd
+ -- have C( C, op )
where
- mod = mkPackageModule mod_nm -- Not necessarily right yet
- lookup_sub parent occ = newGlobalBinder mod occ (Just parent) noSrcLoc
- -- Hack alert! Notice the newGlobalBinder. It ensures that the subordinate
- -- names record their parent; and that in turn ensures that the GlobalRdrEnv
- -- has the correct parent for all the names in its range.
- -- For imported things, we only suck in the binding site later, if ever.
+ lookup_sub parent occ
+ = newGlobalBinder mod occ mb_parent noSrcLoc
+ where
+ mb_parent | occ == p_occ = Nothing
+ | otherwise = Just parent
+
+ -- The use of newGlobalBinder here (rather than lookupOrig)
+ -- ensures that the subordinate names record their parent;
+ -- and that in turn ensures that the GlobalRdrEnv
+ -- has the correct parent for all the names in its range.
+ -- For imported things, we only suck in the binding site later, if ever.
-- Reason for all this:
-- Suppose module M exports type A.T, and constructor A.MkT
-- Then, we know that A.MkT is a subordinate name of A.T,
-- The complaint will come out as "Multiple declarations of Foo.f" because
-- since 'f' is in the env twice, the unQualInScope used by the error-msg
-- printer returns False. It seems awkward to fix, unfortunately.
- mappM_ (addErr . dupDeclErr) dups `thenM_`
+ mappM_ addDupDeclErr dups `thenM_`
- doptM Opt_NoImplicitPrelude `thenM` \ implicit_prelude ->
+ doptM Opt_ImplicitPrelude `thenM` \ implicit_prelude ->
let
- mod_name = moduleName this_mod
- prov = LocalDef mod_name
+ prov = LocalDef this_mod
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
-- It's worth doing because it makes the environment smaller for
-- every module that imports the Prelude
--
- -- Note: don't filter the gbl_env (hence avails, not avails' in
- -- defn of gbl_env above). Stupid reason: when parsing
+ -- Note: don't filter the gbl_env (hence all_names, not filered_all_names
+ -- in defn of gres above). Stupid reason: when parsing
-- data type decls, the constructors start as Exact tycon-names,
-- and then get turned into data con names by zapping the name space;
-- but that stops them being Exact, so they get looked up.
-- Ditto in fixity decls; e.g. infix 5 :
-- Sigh. It doesn't matter because it only affects the Data.Tuple really.
-- The important thing is to trim down the exports.
+ filtered_names
+ | implicit_prelude = all_names
+ | otherwise = filter (not . isBuiltInSyntax) all_names
- avails' | implicit_prelude = filter not_built_in_syntax avails
- | otherwise = avails
- not_built_in_syntax a = not (all isBuiltInSyntaxName (availNames a))
- -- Only filter it if all the names of the avail are built-in
- -- In particular, lists have (:) which is not built in syntax
- -- so we don't filter it out. [Sept 03: wrong: see isBuiltInSyntaxName]
-
- avail_env = mkAvailEnv avails'
- imports = emptyImportAvails {
- imp_qual = unitModuleEnv this_mod avail_env,
- imp_env = avail_env
+ imports = emptyImportAvails {
+ imp_env = unitModuleEnv this_mod $
+ mkNameSet filtered_names
}
in
returnM (gbl_env, imports)
filterImports :: ModIface
-> ImportSpec -- The span for the entire import decl
-> Maybe (Bool, [Located (IE RdrName)]) -- Import spec; True => hiding
- -> [AvailInfo] -- What's available
- -> RnM (AvailEnv, -- What's imported
- GlobalRdrEnv) -- ...in two forms
+ -> NameSet -- What's available
+ -> RnM (NameSet, -- What's imported (qualified or unqualified)
+ GlobalRdrEnv) -- Same again, but in GRE form
-- 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 }
- | avail <- avails, name <- availNames avail ]
-filterImports iface imp_spec Nothing total_avails
- = returnM (mkAvailEnv total_avails, mkGenericRdrEnv iface imp_spec total_avails)
+mkGenericRdrEnv imp_spec names
+ = mkGlobalRdrEnv [ GRE { gre_name = name, gre_prov = Imported [imp_spec] False }
+ | name <- nameSetToList names ]
-filterImports iface imp_spec (Just (want_hiding, import_items)) total_avails
- = mapAndUnzipM (addLocM get_item) import_items `thenM` \ (avails, gres) ->
+filterImports iface imp_spec Nothing all_names
+ = returnM (all_names, mkGenericRdrEnv imp_spec all_names)
+
+filterImports iface imp_spec (Just (want_hiding, import_items)) all_names
+ = mappM (addLocM get_item) import_items `thenM` \ gres_s ->
let
- all_avails = foldr plusAvailEnv emptyAvailEnv avails
- rdr_env = foldr plusGlobalRdrEnv emptyGlobalRdrEnv gres
+ gres = concat gres_s
+ specified_names = mkNameSet (map gre_name gres)
in
if not want_hiding then
- returnM (all_avails, rdr_env)
+ return (specified_names, mkGlobalRdrEnv gres)
else
- let -- Hide stuff in all_avails
- hidden = availsToNameSet (availEnvElts all_avails)
- keep n = not (n `elemNameSet` hidden)
- pruned_avails = pruneAvails keep total_avails
+ let
+ keep n = not (n `elemNameSet` specified_names)
+ pruned_avails = filterNameSet keep all_names
in
- returnM (mkAvailEnv pruned_avails, mkGenericRdrEnv iface imp_spec pruned_avails)
+ return (pruned_avails, mkGenericRdrEnv imp_spec pruned_avails)
+
where
- import_fm :: OccEnv AvailInfo
- import_fm = mkOccEnv [ (nameOccName name, avail)
- | avail <- total_avails,
- name <- availNames avail]
- -- Even though availNames returns data constructors too,
+ occ_env :: OccEnv Name -- Maps OccName to corresponding Name
+ occ_env = mkOccEnv [(nameOccName n, n) | n <- nameSetToList all_names]
+ -- This env will have entries for data constructors too,
-- they won't make any difference because naked entities like T
-- in an import list map to TcOccs, not VarOccs.
- bale_out item = addErr (badImportItemErr iface imp_spec item) `thenM_`
- returnM (emptyAvailEnv, emptyGlobalRdrEnv)
+ sub_env :: NameEnv [Name]
+ sub_env = mkSubNameEnv all_names
- mk_deprec = mi_dep_fn iface
+ bale_out item = addErr (badImportItemErr iface imp_spec item) `thenM_`
+ returnM []
- succeed_with :: Bool -> AvailInfo -> RnM (AvailEnv, GlobalRdrEnv)
- succeed_with all_explicit avail
+ succeed_with :: Bool -> [Name] -> RnM [GlobalRdrElt]
+ succeed_with all_explicit names
= do { loc <- getSrcSpanM
- ; returnM (unitAvailEnv avail,
- mkGlobalRdrEnv (map (mk_gre loc) (availNames avail))) }
+ ; returnM (map (mk_gre loc) names) }
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
+ explicit name = all_explicit || isNothing (nameParent_maybe name)
- get_item :: IE RdrName -> RnM (AvailEnv, GlobalRdrEnv)
+ get_item :: IE RdrName -> RnM [GlobalRdrElt]
-- Empty result for a bad item.
-- Singleton result is typical case.
-- Can have two when we are hiding, and mention C which might be
get_item item@(IEThingAll tc)
= case check_item item of
- Nothing -> bale_out item
- Just avail@(AvailTC _ [n]) -> -- This occurs when you import T(..), but
- -- only export T abstractly. The single [n]
- -- in the AvailTC is the type or class itself
- ifOptM Opt_WarnMisc (addWarn (dodgyImportWarn tc)) `thenM_`
- succeed_with False avail
- Just avail -> succeed_with False avail
+ [] -> bale_out item
+
+ [n] -> -- This occurs when you import T(..), but
+ -- only export T abstractly. The single [n]
+ -- in the AvailTC is the type or class itself
+ ifOptM Opt_WarnDodgyImports (addWarn (dodgyImportWarn tc)) `thenM_`
+ succeed_with False [n]
+
+ names -> succeed_with False names
get_item item@(IEThingAbs n)
| want_hiding -- hiding( C )
- -- Here the 'C' can be a data constructor *or* a type/class
- = case catMaybes [check_item item, check_item (IEVar data_n)] of
- [] -> bale_out item
- avails -> returnM (mkAvailEnv avails, emptyGlobalRdrEnv)
- -- The GlobalRdrEnv result is irrelevant when hiding
+ -- Here the 'C' can be a data constructor
+ -- *or* a type/class, or even both
+ = case concat [check_item item, check_item (IEVar data_n)] of
+ [] -> bale_out item
+ names -> succeed_with True names
where
data_n = setRdrNameSpace n srcDataName
get_item item
= case check_item item of
- Nothing -> bale_out item
- Just avail -> succeed_with True avail
-
- check_item item
- | isNothing maybe_in_import_avails ||
- isNothing maybe_filtered_avail
- = Nothing
-
- | otherwise
- = Just filtered_avail
-
- where
- wanted_occ = rdrNameOcc (ieName item)
- maybe_in_import_avails = lookupOccEnv import_fm wanted_occ
-
- Just avail = maybe_in_import_avails
- maybe_filtered_avail = filterAvail item avail
- Just filtered_avail = maybe_filtered_avail
-\end{code}
-
-\begin{code}
-filterAvail :: IE RdrName -- Wanted
- -> AvailInfo -- Available
- -> Maybe AvailInfo -- Resulting available;
- -- Nothing if (any of the) wanted stuff isn't there
-
-filterAvail ie@(IEThingWith want wants) avail@(AvailTC n ns)
- | sub_names_ok = Just (AvailTC n (filter is_wanted ns))
- | otherwise = Nothing
- where
- is_wanted name = nameOccName name `elem` wanted_occs
- sub_names_ok = all (`elem` avail_occs) wanted_occs
- avail_occs = map nameOccName ns
- wanted_occs = map rdrNameOcc (want:wants)
-
-filterAvail (IEThingAbs _) (AvailTC n ns) = ASSERT( n `elem` ns )
- Just (AvailTC n [n])
-
-filterAvail (IEThingAbs _) avail@(Avail n) = Just avail -- Type synonyms
-
-filterAvail (IEVar _) avail@(Avail n) = Just avail
-filterAvail (IEVar v) avail@(AvailTC n ns) = Just (AvailTC n (filter wanted ns))
- where
- wanted n = nameOccName n == occ
- occ = rdrNameOcc v
- -- The second equation happens if we import a class op, thus
- -- import A( op )
- -- where op is a class operation
-
-filterAvail (IEThingAll _) avail@(AvailTC _ _) = Just avail
- -- We don't complain even if the IE says T(..), but
- -- no constrs/class ops of T are available
- -- Instead that's caught with a warning by the caller
-
-filterAvail ie avail = Nothing
+ [] -> bale_out item
+ names -> succeed_with True names
+
+ check_item :: IE RdrName -> [Name]
+ check_item item
+ = case lookupOccEnv occ_env (rdrNameOcc (ieName item)) of
+ Nothing -> []
+ Just name -> filterAvail item name sub_env
\end{code}
\begin{code}
type ExportAccum -- The type of the accumulating parameter of
-- the main worker function in exportsFromAvail
- = ([ModuleName], -- 'module M's seen so far
+ = ([Module], -- '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
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
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
- ]
-
-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)
-
+ -- keeping only things that are locally-defined
+ return (mkNameSet [ gre_name gre
+ | gre <- globalRdrEnvElts rdr_env,
+ isLocalGRE gre ])
+
+exports_from_avail (Just items) rdr_env (ImportAvails { imp_env = imp_env })
+ = foldlM do_litem emptyExportAccum items `thenM` \ (_, _, exports) ->
+ returnM exports
where
- exports_from_litem :: ExportAccum -> Located (IE RdrName) -> RnM ExportAccum
- exports_from_litem acc = addLocM (exports_from_item acc)
+ sub_env :: NameEnv [Name] -- Classify each name by its parent
+ sub_env = mkSubNameEnv (foldModuleEnv unionNameSets emptyNameSet imp_env)
+
+ do_litem :: ExportAccum -> Located (IE RdrName) -> RnM ExportAccum
+ do_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) ;
returnM acc }
| otherwise
- = case lookupModuleEnvByName mod_avail_env mod of
+ = case lookupModuleEnv imp_env mod of
Nothing -> addErr (modExportErr mod) `thenM_`
returnM acc
-
- Just avail_env
+ Just names
-> 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 = filterNameSet (inScopeUnqual rdr_env) names
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 (nameSetToList new_exports) `thenM` \ occs' ->
+ returnM (mod:mods, occs', exports `unionNameSets` 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
- else
- -- Get the AvailInfo for the parent of the specified name
- let
- parent = nameParent name
- avail = lookupAvailEnv entity_avail_env parent
+ else let
+ new_exports = filterAvail ie name sub_env
in
- -- Filter out the bits we want
- case filterAvail ie avail of {
- Nothing -> -- Not enough availability
- addErr (exportItemErr ie) `thenM_`
- returnM acc ;
-
- 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)
- }
+ checkErr (not (null new_exports)) (exportItemErr ie) `thenM_`
+ checkForDodgyExport ie new_exports `thenM_`
+ check_occs ie occs new_exports `thenM` \ occs' ->
+ returnM (mods, occs', addListToNameSet exports new_exports)
+
+-------------------------------
+filterAvail :: IE RdrName -- Wanted
+ -> Name -- The Name of the ieName of the item
+ -> NameEnv [Name] -- Maps type/class names to their sub-names
+ -> [Name] -- Empty if even one thing reqd is missing
+
+filterAvail (IEVar _) n subs = [n]
+filterAvail (IEThingAbs _) n subs = [n]
+filterAvail (IEThingAll _) n subs = n : subNames subs n
+filterAvail (IEThingWith _ rdrs) n subs
+ | any isNothing mb_names = []
+ | otherwise = n : catMaybes mb_names
+ where
+ env = mkOccEnv [(nameOccName s, s) | s <- subNames subs n]
+ mb_names = map (lookupOccEnv env . rdrNameOcc) rdrs
+subNames :: NameEnv [Name] -> Name -> [Name]
+subNames env n = lookupNameEnv env n `orElse` []
--------------------------------
-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
+mkSubNameEnv :: NameSet -> NameEnv [Name]
+-- Maps types and classes to their constructors/classops respectively
+-- This mapping just makes it easier to deal with A(..) export items
+mkSubNameEnv names
+ = foldNameSet add_name emptyNameEnv names
where
- ns' = filter (in_scope env) ns
+ add_name name env
+ | Just parent <- nameParent_maybe name
+ = extendNameEnv_C (\ns _ -> name:ns) env parent [name]
+ | otherwise = env
-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)
- -- This occurs when you import T(..), but
- -- only export T abstractly. The single [n]
- -- in the AvailTC is the type or class itself
+checkForDodgyExport :: IE RdrName -> [Name] -> RnM ()
+checkForDodgyExport ie@(IEThingAll tc) [n]
+ | isTcOcc (nameOccName n) = addWarn (dodgyExportWarn tc)
+ -- This occurs when you export T(..), but
+ -- only import T abstractly, or T is a synonym.
+ -- The single [n] is the type or class itself
+ | otherwise = addErr (exportItemErr ie)
+ -- This happes if you export x(..), which is bogus
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
%*********************************************************
%* *
-\subsection{Unused names}
+ Deprecations
+%* *
+%*********************************************************
+
+\begin{code}
+reportDeprecations :: TcGblEnv -> RnM ()
+reportDeprecations tcg_env
+ = ifOptM Opt_WarnDeprecations $
+ do { (eps,hpt) <- getEpsAndHpt
+ ; 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
+ = setSrcSpan (is_loc imp_spec) $
+ addWarn (sep [ptext SLIT("Deprecated use of") <+>
+ occNameFlavour (nameOccName name) <+>
+ quotes (ppr name),
+ (parens imp_msg),
+ (ppr deprec_txt) ])
+ where
+ name_mod = nameModule 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
+ | isWiredInName n -> Nothing
+ -- We have not necessarily loaded the .hi file for a
+ -- wired-in name (yet), although we *could*.
+ -- And we never deprecate them
+
+ | otherwise -> 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
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
-- into a bunch of avails, so they are properly grouped
- minimal_imports :: FiniteMap ModuleName AvailEnv
+ minimal_imports :: FiniteMap Module AvailEnv
minimal_imports0 = emptyFM
minimal_imports1 = foldr add_name minimal_imports0 defined_and_used
minimal_imports = foldr add_inst_mod minimal_imports1 direct_import_mods
-- 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.
- add_name (GRE {gre_name = n,
- gre_prov = Imported imp_specs _}) acc
+ add_name (GRE {gre_name = n, gre_prov = Imported imp_specs _}) acc
= addToFM_C plusAvailEnv acc (is_mod (head imp_specs))
(unitAvailEnv (mk_avail n (nameParent_maybe n)))
add_name other acc
mk_avail n Nothing | isTcOcc (nameOccName n) = AvailTC n [n]
| otherwise = Avail n
- add_inst_mod m acc
- | m `elemFM` acc = acc -- We import something already
- | otherwise = addToFM acc m emptyAvailEnv
+ add_inst_mod (mod,_,_) acc
+ | mod `elemFM` acc = acc -- We import something already
+ | otherwise = addToFM acc mod emptyAvailEnv
+ where
-- Add an empty collection of imports for a module
-- from which we have sucked only instance decls
imports = tcg_imports gbl_env
- direct_import_mods :: [ModuleName]
- direct_import_mods = map (moduleName . fst)
- (moduleEnvElts (imp_mods imports))
-
- hasEmptyImpList :: ModuleName -> Bool
- hasEmptyImpList m =
- case lookupModuleEnvByName (imp_mods imports) m of
- Just (_,Just x) -> not x
- _ -> False
+ direct_import_mods :: [(Module, Maybe Bool, SrcSpan)]
+ -- See the type of the imp_mods for this triple
+ direct_import_mods = moduleEnvElts (imp_mods imports)
-- unused_imp_mods are the directly-imported modules
-- that are not mentioned in minimal_imports1
-- [Note: not 'minimal_imports', because that includes directly-imported
-- modules even if we use nothing from them; see notes above]
- unused_imp_mods = [m | m <- direct_import_mods,
- isNothing (lookupFM minimal_imports1 m),
- m /= pRELUDE_Name,
- not (hasEmptyImpList m)]
- -- hasEmptyImpList arranges not to complain about
+ unused_imp_mods = [(mod,loc) | (mod,imp,loc) <- direct_import_mods,
+ not (mod `elemFM` minimal_imports1),
+ mod /= pRELUDE,
+ imp /= Just False]
+ -- The Just False part is not to complain about
-- import M (), which is an idiom for importing
-- instance declarations
- module_unused :: ModuleName -> Bool
- module_unused mod = mod `elem` unused_imp_mods
-
+ module_unused :: Module -> Bool
+ module_unused mod = any (((==) mod) . fst) 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)
-- ToDo: deal with original imports with 'qualified' and 'as M' clauses
-printMinimalImports :: FiniteMap ModuleName AvailEnv -- Minimal imports
+printMinimalImports :: FiniteMap Module AvailEnv -- Minimal imports
-> RnM ()
printMinimalImports imps
= ifOptM Opt_D_dump_minimal_imports $ do {
(vcat (map ppr_mod_ie mod_ies)) })
}
where
- mkFilename this_mod = moduleNameUserString (moduleName this_mod) ++ ".imports"
+ mkFilename this_mod = moduleUserString this_mod ++ ".imports"
ppr_mod_ie (mod_name, ies)
- | mod_name == pRELUDE_Name
+ | mod_name == pRELUDE
= empty
| null ies -- Nothing except instances comes from here
= ptext SLIT("import") <+> ppr mod_name <> ptext SLIT("() -- Instances only")
where
all_used avail_occs = all (`elem` map nameOccName ns) avail_occs
doc = text "Compute minimal imports from" <+> ppr n
- n_mod = nameModuleName n
+ n_mod = nameModule n
\end{code}
(gre:_) -> gre
[] -> pprPanic "exportClashErr" (ppr name)
-dupDeclErr (n:ns)
- = vcat [ptext SLIT("Multiple declarations of") <+> quotes (ppr n),
- nest 4 (vcat (map ppr sorted_locs))]
+addDupDeclErr :: [Name] -> TcRn ()
+addDupDeclErr names
+ = addErrAt big_loc $
+ vcat [ptext SLIT("Multiple declarations of") <+> quotes (ppr name1),
+ ptext SLIT("Declared at:") <+> vcat (map ppr sorted_locs)]
where
- sorted_locs = sortLt occ'ed_before (map nameSrcLoc (n:ns))
- occ'ed_before a b = LT == compare a b
+ locs = map nameSrcLoc names
+ big_loc = foldr1 combineSrcSpans (map srcLocSpan locs)
+ name1 = head names
+ sorted_locs = sortLe (<=) (sortLe (<=) locs)
dupExportWarn occ_name ie1 ie2
= hsep [quotes (ppr occ_name),