X-Git-Url: http://git.megacz.com/?a=blobdiff_plain;f=ghc%2Fcompiler%2Frename%2FRnNames.lhs;h=9b172cfabd3b16c45e52ff467e92f1160ddc485f;hb=ef5b4b146aa172d8ac10f39b5eb3d7a0f948d8f1;hp=eb87208c4134bb199a0f64f23f46b43d00e04cd8;hpb=a195d525eb3ad5fd60a8797191c31907e6d9bfb0;p=ghc-hetmet.git diff --git a/ghc/compiler/rename/RnNames.lhs b/ghc/compiler/rename/RnNames.lhs index eb87208..9b172cf 100644 --- a/ghc/compiler/rename/RnNames.lhs +++ b/ghc/compiler/rename/RnNames.lhs @@ -6,37 +6,39 @@ \begin{code} module RnNames ( rnImports, importsFromLocalDecls, exportsFromAvail, - reportUnusedNames, mkModDeps, exportsToAvails + reportUnusedNames, reportDeprecations, + mkModDeps, exportsToAvails ) where #include "HsVersions.h" import CmdLineOpts ( DynFlag(..) ) -import HsSyn ( IE(..), ieName, ImportDecl(..), +import HsSyn ( IE(..), ieName, ImportDecl(..), LImportDecl, ForeignDecl(..), HsGroup(..), - collectLocatedHsBinders, tyClDeclNames + collectGroupBinders, tyClDeclNames ) -import RdrHsSyn ( RdrNameIE, RdrNameImportDecl, main_RDR_Unqual ) import RnEnv import IfaceEnv ( lookupOrig, newGlobalBinder ) import LoadIface ( loadSrcInterface ) import TcRnMonad import FiniteMap -import PrelNames ( pRELUDE_Name, isBuiltInSyntaxName, isUnboundName ) -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 ) +import Name ( Name, nameSrcLoc, nameOccName, nameModule, isWiredInName, + nameParent, nameParent_maybe, isExternalName, + isBuiltInSyntax ) import NameSet -import NameEnv -import OccName ( OccName, srcDataName, isTcOcc ) +import OccName ( srcDataName, isTcOcc, occNameFlavour, OccEnv, + mkOccEnv, lookupOccEnv, emptyOccEnv, extendOccEnv ) import HscTypes ( GenAvailInfo(..), AvailInfo, Avails, GhciMode(..), - IsBootInterface, IfaceExport, + IfaceExport, HomePackageTable, PackageIfaceTable, availName, availNames, availsToNameSet, unQualInScope, - Deprecs(..), ModIface(..), Dependencies(..) + Deprecs(..), ModIface(..), Dependencies(..), + lookupIface, ExternalPackageState(..), + IfacePackage(..) ) import RdrName ( RdrName, rdrNameOcc, setRdrNameSpace, GlobalRdrEnv, mkGlobalRdrEnv, GlobalRdrElt(..), @@ -45,11 +47,13 @@ import RdrName ( RdrName, rdrNameOcc, setRdrNameSpace, Provenance(..), ImportSpec(..), isLocalGRE, pprNameProvenance ) import Outputable -import Maybes ( isJust, isNothing, catMaybes, mapCatMaybes ) -import SrcLoc ( noSrcLoc ) +import Maybes ( isNothing, catMaybes, mapCatMaybes, seqMaybe ) +import SrcLoc ( noSrcLoc, Located(..), mkGeneralSrcSpan, + unLoc, noLoc, srcLocSpan, combineSrcSpans, SrcSpan ) +import BasicTypes ( DeprecTxt ) import ListSetOps ( removeDups ) -import Util ( sortLt, notNull ) -import List ( partition, insert ) +import Util ( sortLe, notNull, isSingleton ) +import List ( partition ) import IO ( openFile, IOMode(..) ) \end{code} @@ -62,75 +66,77 @@ import IO ( openFile, IOMode(..) ) %************************************************************************ \begin{code} -rnImports :: [RdrNameImportDecl] +rnImports :: [LImportDecl RdrName] -> 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 -> - getSrcLocM `thenM` \ loc -> - doptM Opt_NoImplicitPrelude `thenM` \ opt_no_prelude -> - let - all_imports = mk_prel_imports this_mod loc opt_no_prelude ++ imports - (source, ordinary) = partition is_source_import all_imports - is_source_import (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 + ; opt_no_prelude <- doptM Opt_NoImplicitPrelude + ; 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 + + ; 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 loc no_prelude - | moduleName this_mod == pRELUDE_Name + mk_prel_imports this_mod no_prelude + | this_mod == pRELUDE || explicit_prelude_import || no_prelude = [] - | otherwise = [preludeImportDecl loc] + | otherwise = [preludeImportDecl] explicit_prelude_import - = notNull [ () | (ImportDecl mod _ _ _ _ _) <- imports, - mod == pRELUDE_Name ] + = notNull [ () | L _ (ImportDecl mod _ _ _ _) <- imports, + unLoc mod == pRELUDE ] -preludeImportDecl loc - = ImportDecl pRELUDE_Name +preludeImportDecl + = L loc $ + ImportDecl (L loc pRELUDE) False {- Not a boot interface -} False {- Not qualified -} Nothing {- No "as" -} Nothing {- No import list -} - loc + where + loc = mkGeneralSrcSpan FSLIT("Implicit import declaration") \end{code} \begin{code} importsFromImportDecl :: Module - -> RdrNameImportDecl + -> LImportDecl RdrName -> RnM (GlobalRdrEnv, ImportAvails) importsFromImportDecl this_mod - (ImportDecl imp_mod_name want_boot qual_only as_mod imp_details iloc) - = addSrcLoc iloc $ + (L loc (ImportDecl loc_imp_mod_name want_boot qual_only as_mod imp_details)) + = + setSrcSpan loc $ -- If there's an error in loadInterface, (e.g. interface -- file not found) we get lots of spurious errors from 'filterImports' let - this_mod_name = moduleName this_mod + imp_mod_name = unLoc loc_imp_mod_name doc = ppr imp_mod_name <+> ptext SLIT("is directly imported") in loadSrcInterface doc imp_mod_name want_boot `thenM` \ iface -> @@ -152,7 +158,7 @@ importsFromImportDecl this_mod 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 @@ -169,34 +175,50 @@ importsFromImportDecl this_mod -- import {-# SOURCE #-} A( AType ) -- -- then you'll get a 'B does not export AType' message. Oh well. + + qual_mod_name = case as_mod of + Nothing -> imp_mod_name + 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 } in - exportsToAvails filtered_exports `thenM` \ avails -> - -- Filter the imports according to the import list - filterImports imp_mod want_boot imp_details avails `thenM` \ (filtered_avails, explicits) -> + -- 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 @@ -204,28 +226,14 @@ importsFromImportDecl this_mod _ -> Nothing -- Everything is imported, -- (or almost everything [hiding]) - qual_mod_name = case as_mod of - Nothing -> imp_mod_name - Just another_name -> another_name - -- unqual_avails is the Avails that are visible in *unqualified* form -- We need to know this so we know what to export when we see -- module M ( module P ) where ... -- Then we must export whatever came from P unqualified. - imp_spec = ImportSpec { is_mod = imp_mod_name, is_qual = qual_only, - is_loc = iloc , is_as = qual_mod_name } - mk_deprec = mi_dep_fn iface - gres = [ GRE { gre_name = name, - gre_prov = Imported [imp_spec] (name `elemNameSet` explicits), - gre_deprec = mk_deprec name } - | avail <- filtered_avails, name <- availNames avail ] - gbl_env = mkGlobalRdrEnv gres - - avail_env = mkAvailEnv filtered_avails imports = ImportAvails { - imp_qual = unitModuleEnvByName qual_mod_name avail_env, + imp_qual = unitModuleEnv qual_mod_name avail_env, imp_env = avail_env, - imp_mods = unitModuleEnv imp_mod (imp_mod, import_all), + imp_mods = unitModuleEnv imp_mod (imp_mod, import_all, loc), imp_orphs = orphans, imp_dep_mods = mkModDeps dependent_mods, imp_dep_pkgs = dependent_pkgs } @@ -246,13 +254,12 @@ exportsToAvails exports ; return (concat avails_by_module) } where do_one (mod_name, exports) = mapM (do_avail mod_name) exports - do_avail mod_nm (Avail n) = do { n' <- lookupOrig mod_nm n; + do_avail mod (Avail n) = do { n' <- lookupOrig mod n; ; return (Avail n') } - do_avail mod_nm (AvailTC n ns) = do { n' <- lookupOrig mod_nm n + do_avail mod (AvailTC n ns) = do { n' <- lookupOrig mod n ; ns' <- mappM (lookup_sub n') ns ; return (AvailTC n' ns') } 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 @@ -302,22 +309,14 @@ importsFromLocalDecls group -- 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 -> 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 @@ -340,10 +339,10 @@ importsFromLocalDecls group avails' | implicit_prelude = filter not_built_in_syntax avails | otherwise = avails - not_built_in_syntax a = not (all isBuiltInSyntaxName (availNames a)) + not_built_in_syntax a = not (all isBuiltInSyntax (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] + -- so we don't filter it out. [Sept 03: wrong: see isBuiltInSyntax] avail_env = mkAvailEnv avails' imports = emptyImportAvails { @@ -361,9 +360,8 @@ importsFromLocalDecls group %* * %********************************************************* -@getLocalDeclBinders@ returns the names for a @RdrNameHsDecl@. It's -used for both source code (from @importsFromLocalDecls@) and interface -files (@loadDecl@ calls @getTyClDeclBinders@). +@getLocalDeclBinders@ returns the names for an @HsDecl@. It's +used for source code. *** See "THE NAMING STORY" in HsDecls **** @@ -384,15 +382,15 @@ getLocalDeclBinders mod (HsGroup {hs_valds = val_decls, new_simple rdr_name = newTopSrcBinder mod Nothing rdr_name `thenM` \ name -> returnM (Avail name) - val_hs_bndrs = collectLocatedHsBinders val_decls - for_hs_bndrs = [(nm,loc) | ForeignImport nm _ _ _ loc <- foreign_decls] + val_hs_bndrs = collectGroupBinders val_decls + for_hs_bndrs = [nm | L _ (ForeignImport nm _ _ _) <- foreign_decls] new_tc tc_decl = newTopSrcBinder mod Nothing main_rdr `thenM` \ main_name -> mappM (newTopSrcBinder mod (Just main_name)) sub_rdrs `thenM` \ sub_names -> returnM (AvailTC main_name (main_name : sub_names)) where - (main_rdr : sub_rdrs) = tyClDeclNames tc_decl + (main_rdr : sub_rdrs) = tyClDeclNames (unLoc tc_decl) \end{code} @@ -406,77 +404,98 @@ getLocalDeclBinders mod (HsGroup {hs_valds = val_decls, available, and filters it through the import spec (if any). \begin{code} -filterImports :: Module -- The module being imported - -> IsBootInterface -- Tells whether it's a {-# SOURCE #-} import - -> Maybe (Bool, [RdrNameIE]) -- Import spec; True => hiding +filterImports :: ModIface + -> ImportSpec -- The span for the entire import decl + -> Maybe (Bool, [Located (IE RdrName)]) -- Import spec; True => hiding -> [AvailInfo] -- What's available - -> RnM ([AvailInfo], -- What's imported - NameSet) -- What was imported explicitly + -> RnM (AvailEnv, -- 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. -filterImports mod from Nothing imports - = returnM (imports, emptyNameSet) + +mkGenericRdrEnv imp_spec avails + = mkGlobalRdrEnv [ GRE { gre_name = name, gre_prov = Imported [imp_spec] False } + | avail <- avails, name <- availNames avail ] -filterImports mod from (Just (want_hiding, import_items)) total_avails - = mappM get_item import_items `thenM` \ avails_w_explicits_s -> +filterImports iface imp_spec Nothing 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_s, gres) -> let - (item_avails, explicits_s) = unzip (concat avails_w_explicits_s) - explicits = foldl addListToNameSet emptyNameSet explicits_s + avails = concat avails_s in - if want_hiding then - let -- All imported; item_avails to be hidden - hidden = availsToNameSet item_avails - keep n = not (n `elemNameSet` hidden) - in - returnM (pruneAvails keep total_avails, emptyNameSet) + if not want_hiding then + return (mkAvailEnv avails, + foldr plusGlobalRdrEnv emptyGlobalRdrEnv gres) else - -- Just item_avails imported; nothing to be hidden - returnM (item_avails, explicits) + let + hidden = availsToNameSet avails + keep n = not (n `elemNameSet` hidden) + pruned_avails = pruneAvails keep total_avails + in + return (mkAvailEnv pruned_avails, + mkGenericRdrEnv imp_spec pruned_avails) + where - import_fm :: FiniteMap OccName AvailInfo - import_fm = listToFM [ (nameOccName name, avail) + import_fm :: OccEnv AvailInfo + import_fm = mkOccEnv [ (nameOccName name, avail) | avail <- total_avails, name <- availNames avail] -- Even though availNames returns 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 mod from item) `thenM_` - returnM [] + bale_out item = addErr (badImportItemErr iface imp_spec item) `thenM_` + returnM ([], emptyGlobalRdrEnv) - get_item :: RdrNameIE -> RnM [(AvailInfo, [Name])] - -- Empty list for a bad item. - -- Singleton is typical case. + succeed_with :: Bool -> AvailInfo -> RnM ([AvailInfo], GlobalRdrEnv) + succeed_with all_explicit avail + = do { loc <- getSrcSpanM + ; returnM ([avail], + 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) } + this_imp_spec loc = imp_spec { is_loc = loc } + explicit name = all_explicit || name == main_name + main_name = availName avail + + get_item :: IE RdrName -> RnM ([AvailInfo], GlobalRdrEnv) + -- Empty result for a bad item. + -- Singleton result is typical case. -- Can have two when we are hiding, and mention C which might be -- both a class and a data constructor. - -- The [Name] is the list of explicitly-mentioned names - get_item item@(IEModuleContents _) = bale_out item + get_item item@(IEModuleContents _) + = bale_out item - get_item item@(IEThingAll _) + 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 mod item)) `thenM_` - returnM [(avail, [availName avail])] - Just avail -> returnM [(avail, [availName avail])] + ifOptM Opt_WarnDodgyImports (addWarn (dodgyImportWarn tc)) `thenM_` + succeed_with False avail + Just avail -> succeed_with False avail get_item item@(IEThingAbs n) | want_hiding -- hiding( C ) - -- Here the 'C' can be a data constructor *or* a type/class + -- Here the 'C' can be a data constructor + -- *or* a type/class, or even both = case catMaybes [check_item item, check_item (IEVar data_n)] of - [] -> bale_out item - avails -> returnM [(a, []) | a <- avails] - -- The 'explicits' list is irrelevant when hiding + [] -> bale_out item + avails -> returnM (avails, emptyGlobalRdrEnv) + -- The GlobalRdrEnv result is irrelevant when hiding where data_n = setRdrNameSpace n srcDataName get_item item = case check_item item of Nothing -> bale_out item - Just avail -> returnM [(avail, availNames avail)] + Just avail -> succeed_with True avail check_item item | isNothing maybe_in_import_avails || @@ -488,7 +507,7 @@ filterImports mod from (Just (want_hiding, import_items)) total_avails where wanted_occ = rdrNameOcc (ieName item) - maybe_in_import_avails = lookupFM import_fm wanted_occ + maybe_in_import_avails = lookupOccEnv import_fm wanted_occ Just avail = maybe_in_import_avails maybe_filtered_avail = filterAvail item avail @@ -496,7 +515,7 @@ filterImports mod from (Just (want_hiding, import_items)) total_avails \end{code} \begin{code} -filterAvail :: RdrNameIE -- Wanted +filterAvail :: IE RdrName -- Wanted -> AvailInfo -- Available -> Maybe AvailInfo -- Resulting available; -- Nothing if (any of the) wanted stuff isn't there @@ -554,27 +573,26 @@ it re-exports @GHC@, which includes @takeMVar#@, whose type includes \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 = ([], emptyFM, emptyAvailEnv) + NameSet) -- The accumulated exported stuff +emptyExportAccum = ([], emptyOccEnv, emptyNameSet) -type ExportOccMap = FiniteMap OccName (Name, RdrNameIE) +type ExportOccMap = OccEnv (Name, IE RdrName) -- Tracks what a particular exported OccName -- in an export list refers to, and which item -- it came from. It's illegal to export two distinct things -- that have the same occurrence name -exportsFromAvail :: Maybe Module -- Nothing => no 'module M(..) where' header at all - -> Maybe [RdrNameIE] -- Nothing => no explicit export list - -> RnM Avails +exportsFromAvail :: Bool -- False => no 'module M(..) where' header at all + -> Maybe [Located (IE RdrName)] -- Nothing => no explicit export list + -> RnM NameSet -- Complains if two distinct exports have same OccName -- Warns about identical exports. -- Complains about exports items not in scope -exportsFromAvail maybe_mod exports +exportsFromAvail explicit_mod exports = do { TcGblEnv { tcg_rdr_env = rdr_env, tcg_imports = imports } <- getGblEnv ; @@ -586,67 +604,58 @@ exportsFromAvail maybe_mod exports -- in interactive mode ghci_mode <- getGhciMode ; let { real_exports - = case maybe_mod of - Just mod -> exports - Nothing | ghci_mode == Interactive -> Nothing - | otherwise -> Just [IEVar main_RDR_Unqual] } ; - + | explicit_mod = exports + | ghci_mode == Interactive = Nothing + | otherwise = Just [noLoc (IEVar main_RDR_Unqual)] } ; 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_item emptyExportAccum - export_items `thenM` \ (_, _, export_avail_map) -> - returnM (nameEnvElts export_avail_map) + = foldlM (exports_from_litem) emptyExportAccum + export_items `thenM` \ (_, _, exports) -> + returnM exports where - exports_from_item :: ExportAccum -> RdrNameIE -> RnM ExportAccum + exports_from_litem :: ExportAccum -> Located (IE RdrName) -> RnM ExportAccum + exports_from_litem acc = addLocM (exports_from_item acc) - exports_from_item acc@(mods, occs, avails) ie@(IEModuleContents mod) + exports_from_item :: ExportAccum -> IE RdrName -> RnM ExportAccum + 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 mod_avail_env mod of Nothing -> addErr (modExportErr mod) `thenM_` returnM acc 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 @@ -665,45 +674,38 @@ exports_from_avail (Just export_items) rdr_env Just export_avail -> -- Phew! It's OK! Now to check the occurrence stuff! - warnIf (not (ok_item ie avail)) (dodgyExportWarn ie) `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) ------------------------------- -ok_item (IEThingAll _) (AvailTC _ [n]) = False +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 -ok_item _ _ = True +checkForDodgyExport _ _ = return () ------------------------------- -check_occs :: RdrNameIE -> 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 lookupFM occs name_occ of - Nothing -> returnM (addToFM occs name_occ (name, ie)) + = case lookupOccEnv occs name_occ of + Nothing -> returnM (extendOccEnv occs name_occ (name, ie)) Just (name', ie') | name == name' -- Duplicate export @@ -721,17 +723,77 @@ check_occs ie occs avail %********************************************************* %* * -\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_` - 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 @@ -744,32 +806,39 @@ 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 - - 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 @@ -788,12 +857,10 @@ 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. - 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 @@ -804,42 +871,46 @@ reportUnusedNames gbl_env 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 direcly-imported + -- [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 +--------------------- +warnDuplicateImports :: [GlobalRdrElt] -> RnM () +warnDuplicateImports gres + = ifOptM Opt_WarnUnusedImports (mapM_ warn gres) + where + warn (GRE { gre_name = name, gre_prov = Imported imps _ }) + = addWarn ((quotes (ppr name) <+> ptext SLIT("is imported more than once:")) + $$ nest 2 (vcat (map ppr imps))) + -- 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 { @@ -852,9 +923,9 @@ printMinimalImports imps (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") @@ -885,7 +956,7 @@ printMinimalImports imps 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} @@ -896,19 +967,18 @@ printMinimalImports imps %************************************************************************ \begin{code} -badImportItemErr mod from ie - = sep [ptext SLIT("Module"), quotes (ppr mod), source_import, +badImportItemErr iface imp_spec ie + = sep [ptext SLIT("Module"), quotes (ppr (is_mod imp_spec)), source_import, ptext SLIT("does not export"), quotes (ppr ie)] where - source_import = case from of - True -> ptext SLIT("(hi-boot interface)") - other -> empty + source_import | mi_boot iface = ptext SLIT("(hi-boot interface)") + | otherwise = empty -dodgyImportWarn mod item = dodgyMsg (ptext SLIT("import")) item -dodgyExportWarn item = dodgyMsg (ptext SLIT("export")) item +dodgyImportWarn item = dodgyMsg (ptext SLIT("import")) item +dodgyExportWarn item = dodgyMsg (ptext SLIT("export")) item -dodgyMsg kind item@(IEThingAll tc) - = sep [ ptext SLIT("The") <+> kind <+> ptext SLIT("item") <+> quotes (ppr item), +dodgyMsg kind tc + = sep [ ptext SLIT("The") <+> kind <+> ptext SLIT("item") <+> quotes (ppr (IEThingAll tc)), ptext SLIT("suggests that") <+> quotes (ppr tc) <+> ptext SLIT("has constructor or class methods"), ptext SLIT("but it has none; it is a type synonym or abstract type or class") ] @@ -934,12 +1004,16 @@ exportClashErr global_env name1 name2 ie1 ie2 (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),