X-Git-Url: http://git.megacz.com/?p=ghc-hetmet.git;a=blobdiff_plain;f=compiler%2Frename%2FRnNames.lhs;h=68286b7ac67589ed91911fb932ec92f2e5d54928;hp=4ee759ab7f948dca44f50edcfbedbe04546ecb5b;hb=66579ff945831c5fc9a17c58c722ff01f2268d76;hpb=4f55ec2c7e78aa836b91ebc57ddd74675d92372c diff --git a/compiler/rename/RnNames.lhs b/compiler/rename/RnNames.lhs index 4ee759a..68286b7 100644 --- a/compiler/rename/RnNames.lhs +++ b/compiler/rename/RnNames.lhs @@ -5,24 +5,19 @@ \begin{code} module RnNames ( - rnImports, importsFromLocalDecls, - rnExports, - getLocalDeclBinders, extendRdrEnvRn, - reportUnusedNames, reportDeprecations + rnImports, getLocalNonValBinders, + rnExports, extendGlobalRdrEnvRn, + reportUnusedNames, finishWarnings, ) where #include "HsVersions.h" -import DynFlags ( DynFlag(..), GhcMode(..), DynFlags(..) ) -import HsSyn ( IE(..), ieName, ImportDecl(..), LImportDecl, - ForeignDecl(..), HsGroup(..), HsValBinds(..), - Sig(..), collectHsBindLocatedBinders, tyClDeclNames, - instDeclATs, isIdxTyDecl, - LIE ) +import DynFlags +import HsSyn import RnEnv import RnHsDoc ( rnHsDoc ) import IfaceEnv ( ifaceExportNames ) -import LoadIface ( loadSrcInterface ) +import LoadIface ( loadSrcInterface, loadSysInterface ) import TcRnMonad hiding (LIE) import PrelNames @@ -30,36 +25,22 @@ import Module import Name import NameEnv import NameSet -import OccName ( srcDataName, pprNonVarNameSpace, - occNameSpace, - OccEnv, mkOccEnv, mkOccEnv_C, lookupOccEnv, - emptyOccEnv, extendOccEnv ) -import HscTypes ( GenAvailInfo(..), AvailInfo, availNames, availName, - HomePackageTable, PackageIfaceTable, - mkPrintUnqualified, availsToNameSet, - Deprecs(..), ModIface(..), Dependencies(..), - lookupIfaceByModule, ExternalPackageState(..) - ) -import RdrName ( RdrName, rdrNameOcc, setRdrNameSpace, Parent(..), - GlobalRdrEnv, mkGlobalRdrEnv, GlobalRdrElt(..), - emptyGlobalRdrEnv, plusGlobalRdrEnv, globalRdrEnvElts, - extendGlobalRdrEnv, lookupGlobalRdrEnv, lookupGRE_Name, - Provenance(..), ImportSpec(..), ImpDeclSpec(..), ImpItemSpec(..), - importSpecLoc, importSpecModule, isLocalGRE, pprNameProvenance, - unQualSpecOK, qualSpecOK ) +import OccName +import HscTypes +import RdrName import Outputable import Maybes -import SrcLoc ( Located(..), mkGeneralSrcSpan, getLoc, - unLoc, noLoc, srcLocSpan, SrcSpan ) +import SrcLoc import FiniteMap import ErrUtils -import BasicTypes ( DeprecTxt ) +import BasicTypes ( WarningTxt(..) ) import DriverPhases ( isHsBoot ) import Util +import FastString import ListSetOps -import Data.List ( partition, concatMap, (\\) ) +import Data.List ( partition, concatMap, (\\), delete ) import IO ( openFile, IOMode(..) ) -import Monad ( when ) +import Monad ( when, mplus ) \end{code} @@ -72,7 +53,7 @@ import Monad ( when ) \begin{code} rnImports :: [LImportDecl RdrName] - -> RnM ([LImportDecl Name], GlobalRdrEnv, ImportAvails) + -> RnM ([LImportDecl Name], GlobalRdrEnv, ImportAvails,AnyHpcUsage) rnImports imports -- PROCESS IMPORT DECLS @@ -80,67 +61,80 @@ rnImports imports -- warning for {- SOURCE -} ones that are unnecessary = do 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 + let prel_imports = mkPrelImports this_mod implicit_prelude imports + (source, ordinary) = partition is_source_import imports + is_source_import (L _ (ImportDecl _ _ is_boot _ _ _)) = is_boot - stuff1 <- mapM (rnImportDecl this_mod) ordinary + ifOptM Opt_WarnImplicitPrelude ( + when (notNull prel_imports) $ addWarn (implicitPreludeWarn) + ) + + stuff1 <- mapM (rnImportDecl this_mod) (prel_imports ++ ordinary) stuff2 <- mapM (rnImportDecl this_mod) source - let (decls, rdr_env, imp_avails) = combine (stuff1 ++ stuff2) - return (decls, rdr_env, imp_avails) + let (decls, rdr_env, imp_avails,hpc_usage) = combine (stuff1 ++ stuff2) + return (decls, rdr_env, imp_avails,hpc_usage) where + combine :: [(LImportDecl Name, GlobalRdrEnv, ImportAvails,AnyHpcUsage)] + -> ([LImportDecl Name], GlobalRdrEnv, ImportAvails,AnyHpcUsage) + combine = foldr plus ([], emptyGlobalRdrEnv, emptyImportAvails,False) + where plus (decl, gbl_env1, imp_avails1,hpc_usage1) + (decls, gbl_env2, imp_avails2,hpc_usage2) + = (decl:decls, + gbl_env1 `plusGlobalRdrEnv` gbl_env2, + imp_avails1 `plusImportAvails` imp_avails2, + hpc_usage1 || hpc_usage2) + +mkPrelImports :: Module -> Bool -> [LImportDecl RdrName] -> [LImportDecl RdrName] +-- Consruct the implicit declaration "import Prelude" (or not) +-- -- 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 implicit_prelude - | this_mod == pRELUDE - || explicit_prelude_import - || not implicit_prelude - = [] - | otherwise = [preludeImportDecl] - explicit_prelude_import - = notNull [ () | L _ (ImportDecl mod _ _ _ _) <- imports, +mkPrelImports this_mod implicit_prelude import_decls + | this_mod == pRELUDE + || explicit_prelude_import + || not implicit_prelude + = [] + | otherwise = [preludeImportDecl] + where + explicit_prelude_import + = notNull [ () | L _ (ImportDecl mod Nothing _ _ _ _) <- import_decls, unLoc mod == pRELUDE_NAME ] - combine :: [(LImportDecl Name, GlobalRdrEnv, ImportAvails)] - -> ([LImportDecl Name], GlobalRdrEnv, ImportAvails) - combine = foldr plus ([], emptyGlobalRdrEnv, emptyImportAvails) - where plus (decl, gbl_env1, imp_avails1) - (decls, gbl_env2, imp_avails2) - = (decl:decls, - gbl_env1 `plusGlobalRdrEnv` gbl_env2, - imp_avails1 `plusImportAvails` imp_avails2) - -preludeImportDecl :: LImportDecl RdrName -preludeImportDecl - = L loc $ - ImportDecl (L loc pRELUDE_NAME) + preludeImportDecl :: LImportDecl RdrName + preludeImportDecl + = L loc $ + ImportDecl (L loc pRELUDE_NAME) + Nothing {- no specific package -} False {- Not a boot interface -} False {- Not qualified -} Nothing {- No "as" -} Nothing {- No import list -} - where - loc = mkGeneralSrcSpan FSLIT("Implicit import declaration") - + loc = mkGeneralSrcSpan (fsLit "Implicit import declaration") + rnImportDecl :: Module -> LImportDecl RdrName - -> RnM (LImportDecl Name, GlobalRdrEnv, ImportAvails) + -> RnM (LImportDecl Name, GlobalRdrEnv, ImportAvails,AnyHpcUsage) -rnImportDecl this_mod (L loc (ImportDecl loc_imp_mod_name want_boot +rnImportDecl this_mod (L loc (ImportDecl loc_imp_mod_name mb_pkg want_boot qual_only as_mod imp_details)) = setSrcSpan loc $ do + when (isJust mb_pkg) $ do + pkg_imports <- doptM Opt_PackageImports + when (not pkg_imports) $ addErr packageImportErr + -- 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 - doc = ppr imp_mod_name <+> ptext SLIT("is directly imported") + doc = ppr imp_mod_name <+> ptext (sLit "is directly imported") - iface <- loadSrcInterface doc imp_mod_name want_boot + iface <- loadSrcInterface doc imp_mod_name want_boot mb_pkg -- Compiler sanity check: if the import didn't say -- {-# SOURCE #-} we should not get a hi-boot file @@ -154,8 +148,8 @@ rnImportDecl this_mod (L loc (ImportDecl loc_imp_mod_name want_boot let imp_mod = mi_module iface - deprecs = mi_deprecs iface - is_orph = mi_orphan iface + warns = mi_warns iface + orph_iface = mi_orphan iface has_finsts = mi_finsts iface deps = mi_deps iface @@ -191,16 +185,16 @@ rnImportDecl this_mod (L loc (ImportDecl loc_imp_mod_name want_boot -- filter the imports according to the import declaration (new_imp_details, gbl_env) <- - filterImports2 iface imp_spec imp_details total_avails + filterImports iface imp_spec imp_details total_avails dflags <- getDOpts let -- Compute new transitive dependencies - orphans | is_orph = ASSERT( not (imp_mod `elem` dep_orphs deps) ) - imp_mod : dep_orphs deps - | otherwise = dep_orphs deps + orphans | orph_iface = ASSERT( not (imp_mod `elem` dep_orphs deps) ) + imp_mod : dep_orphs deps + | otherwise = dep_orphs deps finsts | has_finsts = ASSERT( not (imp_mod `elem` dep_finsts deps) ) imp_mod : dep_finsts deps @@ -233,10 +227,10 @@ rnImportDecl this_mod (L loc (ImportDecl loc_imp_mod_name want_boot -- True <=> import M () import_all = case imp_details of Just (is_hiding, ls) -> not is_hiding && null ls - other -> False + _ -> False imports = ImportAvails { - imp_mods = unitModuleEnv imp_mod (imp_mod, import_all, loc), + imp_mods = unitModuleEnv imp_mod [(qual_mod_name, import_all, loc)], imp_orphs = orphans, imp_finsts = finsts, imp_dep_mods = mkModDeps dependent_mods, @@ -244,20 +238,21 @@ rnImportDecl this_mod (L loc (ImportDecl loc_imp_mod_name want_boot } -- Complain if we import a deprecated module - ifOptM Opt_WarnDeprecations ( - case deprecs of - DeprecAll txt -> addWarn (moduleDeprec imp_mod_name txt) - other -> returnM () + ifOptM Opt_WarnWarningsDeprecations ( + case warns of + WarnAll txt -> addWarn (moduleWarn imp_mod_name txt) + _ -> return () ) - let new_imp_decl = L loc (ImportDecl loc_imp_mod_name want_boot + let new_imp_decl = L loc (ImportDecl loc_imp_mod_name mb_pkg want_boot qual_only as_mod new_imp_details) - returnM (new_imp_decl, gbl_env, imports) + return (new_imp_decl, gbl_env, imports, mi_hpc iface) ) +warnRedundantSourceImport :: ModuleName -> SDoc warnRedundantSourceImport mod_name - = ptext SLIT("Unnecessary {-# SOURCE #-} in the import of module") + = ptext (sLit "Unnecessary {-# SOURCE #-} in the import of module") <+> quotes (ppr mod_name) \end{code} @@ -273,36 +268,69 @@ From the top-level declarations of this module produce * the ImportAvails created by its bindings. -Complain about duplicate bindings +Note [Shadowing in extendGlobalRdrEnvRn] +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Usually when etending the GlobalRdrEnv we complain if a new binding +duplicates an existing one. By adding the bindings one at a time, +this check also complains if we add two new bindings for the same name. +(Remember that in Template Haskell the duplicates might *already be* +in the GlobalRdrEnv from higher up the module.) + +But with a Template Haskell quotation we want to *shadow*: + f x = h [d| f = 3 |] +Here the inner binding for 'f' simply shadows the outer one. +And that applies even if the binding for 'f' is in a where-clause, +and hence is in the *local* RdrEnv not the *global* RdrEnv. + +Hence the shadowP boolean passed in. \begin{code} -importsFromLocalDecls :: HsGroup RdrName -> RnM TcGblEnv -importsFromLocalDecls group - = do { gbl_env <- getGblEnv - - ; avails <- getLocalDeclBinders gbl_env group - - ; rdr_env' <- extendRdrEnvRn (tcg_rdr_env gbl_env) avails - - ; traceRn (text "local avails: " <> ppr avails) +extendGlobalRdrEnvRn :: Bool -- Note [Shadowing in extendGlobalRdrEnvRn] + -> [AvailInfo] + -> MiniFixityEnv + -> RnM (TcGblEnv, TcLclEnv) + -- Updates both the GlobalRdrEnv and the FixityEnv + -- We return a new TcLclEnv only becuase we might have to + -- delete some bindings from it; see Note [Shadowing in extendGlobalRdrEnvRn] + +extendGlobalRdrEnvRn shadowP avails new_fixities + = do { (gbl_env, lcl_env) <- getEnvs + ; let rdr_env = tcg_rdr_env gbl_env + fix_env = tcg_fix_env gbl_env + + -- Delete new_occs from global and local envs + -- We are going to shadow them + -- See Note [Shadowing in extendGlobalRdrEnvRn] + new_occs = map (nameOccName . gre_name) gres + rdr_env1 = hideSomeUnquals rdr_env new_occs + lcl_env1 = lcl_env { tcl_rdr = delListFromOccEnv (tcl_rdr lcl_env) new_occs } + + -- Note [Shadowing in extendGlobalRdrEnvRn] + (rdr_env2, lcl_env2) | shadowP = (rdr_env1, lcl_env1) + | otherwise = (rdr_env, lcl_env) - ; returnM (gbl_env { tcg_rdr_env = rdr_env' }) - } + rdr_env3 = foldl extendGlobalRdrEnv rdr_env2 gres + fix_env' = foldl extend_fix_env fix_env gres + (rdr_env', dups) = findLocalDupsRdrEnv rdr_env3 new_occs -extendRdrEnvRn :: GlobalRdrEnv -> [AvailInfo] -> RnM GlobalRdrEnv --- Add the new locally-bound names one by one, checking for duplicates as --- we do so. Remember that in Template Haskell the duplicates --- might *already be* in the GlobalRdrEnv from higher up the module -extendRdrEnvRn rdr_env avails - = foldlM add_local rdr_env (gresFromAvails LocalDef avails) + gbl_env' = gbl_env { tcg_rdr_env = rdr_env', tcg_fix_env = fix_env' } + + ; mapM_ addDupDeclErr dups + + ; traceRn (text "extendGlobalRdrEnvRn" <+> (ppr new_fixities $$ ppr fix_env $$ ppr fix_env')) + ; return (gbl_env', lcl_env2) } where - add_local rdr_env gre - | gres <- lookupGlobalRdrEnv rdr_env (nameOccName (gre_name gre)) - , (dup_gre:_) <- filter isLocalGRE gres -- Check for existing *local* defns - = do { addDupDeclErr (gre_name dup_gre) (gre_name gre) - ; return rdr_env } - | otherwise - = return (extendGlobalRdrEnv rdr_env gre) + gres = gresFromAvails LocalDef avails + + -- If there is a fixity decl for the gre, add it to the fixity env + extend_fix_env fix_env gre + | Just (L _ fi) <- lookupFsEnv new_fixities (occNameFS occ) + = extendNameEnv fix_env name (FixItem occ fi) + | otherwise + = fix_env + where + name = gre_name gre + occ = nameOccName name \end{code} @getLocalDeclBinders@ returns the names for an @HsDecl@. It's @@ -310,7 +338,7 @@ used for source code. *** See "THE NAMING STORY" in HsDecls **** -Instances of indexed types +Instances of type families ~~~~~~~~~~~~~~~~~~~~~~~~~~ Indexed data/newtype instances contain data constructors that we need to collect, too. Moreover, we need to descend into the data/newtypes instances @@ -322,48 +350,64 @@ raising a duplicate declaration error. So, we make a new name for it, but don't return it in the 'AvailInfo'. \begin{code} -getLocalDeclBinders :: TcGblEnv -> HsGroup RdrName -> RnM [AvailInfo] -getLocalDeclBinders gbl_env (HsGroup {hs_valds = ValBindsIn val_decls val_sigs, - hs_tyclds = tycl_decls, - hs_instds = inst_decls, - hs_fords = foreign_decls }) - = do { tc_names_s <- mappM new_tc tycl_decls - ; at_names_s <- mappM inst_ats inst_decls - ; val_names <- mappM new_simple val_bndrs +getLocalNonValBinders :: HsGroup RdrName -> RnM [AvailInfo] +-- Get all the top-level binders bound the group *except* +-- for value bindings, which are treated separately +-- Specificaly we return AvailInfo for +-- type decls +-- class decls +-- associated types +-- foreign imports +-- (in hs-boot files) value signatures + +getLocalNonValBinders group + = do { gbl_env <- getGblEnv + ; get_local_binders gbl_env group } + +get_local_binders :: TcGblEnv -> HsGroup RdrName -> RnM [GenAvailInfo Name] +get_local_binders gbl_env (HsGroup {hs_valds = ValBindsIn _ val_sigs, + hs_tyclds = tycl_decls, + hs_instds = inst_decls, + hs_fords = foreign_decls }) + = do { tc_names_s <- mapM new_tc tycl_decls + ; at_names_s <- mapM inst_ats inst_decls + ; val_names <- mapM new_simple val_bndrs ; return (val_names ++ tc_names_s ++ concat at_names_s) } where mod = tcg_mod gbl_env is_hs_boot = isHsBoot (tcg_src gbl_env) ; - val_bndrs | is_hs_boot = sig_hs_bndrs - | otherwise = for_hs_bndrs ++ val_hs_bndrs - -- In a hs-boot file, the value binders come from the - -- *signatures*, and there should be no foreign binders + for_hs_bndrs :: [Located RdrName] + for_hs_bndrs = [nm | L _ (ForeignImport nm _ _) <- foreign_decls] + + -- In a hs-boot file, the value binders come from the + -- *signatures*, and there should be no foreign binders + val_bndrs :: [Located RdrName] + val_bndrs | is_hs_boot = [nm | L _ (TypeSig nm _) <- val_sigs] + | otherwise = for_hs_bndrs + + new_simple :: Located RdrName -> RnM (GenAvailInfo Name) new_simple rdr_name = do nm <- newTopSrcBinder mod rdr_name return (Avail nm) - sig_hs_bndrs = [nm | L _ (TypeSig nm _) <- val_sigs] - val_hs_bndrs = collectHsBindLocatedBinders val_decls - for_hs_bndrs = [nm | L _ (ForeignImport nm _ _) <- foreign_decls] - new_tc tc_decl - | isIdxTyDecl (unLoc tc_decl) + | isFamInstDecl (unLoc tc_decl) = do { main_name <- lookupFamInstDeclBndr mod main_rdr - ; sub_names <- mappM (newTopSrcBinder mod) sub_rdrs + ; sub_names <- mapM (newTopSrcBinder mod) sub_rdrs ; return (AvailTC main_name sub_names) } -- main_name is not bound here! | otherwise = do { main_name <- newTopSrcBinder mod main_rdr - ; sub_names <- mappM (newTopSrcBinder mod) sub_rdrs + ; sub_names <- mapM (newTopSrcBinder mod) sub_rdrs ; return (AvailTC main_name (main_name : sub_names)) } where (main_rdr : sub_rdrs) = tyClDeclNames (unLoc tc_decl) inst_ats inst_decl - = mappM new_tc (instDeclATs (unLoc inst_decl)) + = mapM new_tc (instDeclATs (unLoc inst_decl)) -getLocalDeclBinders _ _ = panic "getLocalDeclBinders" -- ValBindsOut can't happen +get_local_binders _ g = pprPanic "get_local_binders" (ppr g) \end{code} @@ -383,8 +427,7 @@ filterImports :: ModIface -> [AvailInfo] -- What's available -> RnM (Maybe (Bool, [LIE Name]), -- Import spec w/ Names GlobalRdrEnv) -- Same again, but in GRE form - -filterImports iface decl_spec Nothing all_avails +filterImports _ decl_spec Nothing all_avails = return (Nothing, mkGlobalRdrEnv (gresFromAvails prov all_avails)) where prov = Imported [ImpSpec { is_decl = decl_spec, is_item = ImpAll }] @@ -392,8 +435,8 @@ filterImports iface decl_spec Nothing all_avails filterImports iface decl_spec (Just (want_hiding, import_items)) all_avails = do -- check for errors, convert RdrNames to Names - opt_indexedtypes <- doptM Opt_IndexedTypes - items1 <- mapM (lookup_lie opt_indexedtypes) import_items + opt_typeFamilies <- doptM Opt_TypeFamilies + items1 <- mapM (lookup_lie opt_typeFamilies) import_items let items2 :: [(LIE Name, AvailInfo)] items2 = concat items1 @@ -408,11 +451,6 @@ filterImports iface decl_spec (Just (want_hiding, import_items)) all_avails gres | want_hiding = gresFromAvails hiding_prov pruned_avails | otherwise = concatMap (gresFromIE decl_spec) items2 - traceRn (ppr $ all_avails) - traceRn (ppr $ occ_env) - traceRn (ppr $ items2) - traceRn (ppr $ mkGlobalRdrEnv gres) - return (Just (want_hiding, map fst items2), mkGlobalRdrEnv gres) where -- This environment is how we map names mentioned in the import @@ -443,12 +481,13 @@ filterImports iface decl_spec (Just (want_hiding, import_items)) all_avails (parent, subs) = if p1 == name then (p2, subs1) else (p1, subs2) in (name, AvailTC name subs, Just parent) + combine x y = pprPanic "filterImports/combine" (ppr x $$ ppr y) lookup_lie :: Bool -> LIE RdrName -> TcRn [(LIE Name, AvailInfo)] - lookup_lie opt_indexedtypes (L loc ieRdr) + lookup_lie opt_typeFamilies (L loc ieRdr) = do stuff <- setSrcSpan loc $ - case lookup_ie opt_indexedtypes ieRdr of + case lookup_ie opt_typeFamilies ieRdr of Failed err -> addErr err >> return [] Succeeded a -> return a checkDodgyImport stuff @@ -456,7 +495,7 @@ filterImports iface decl_spec (Just (want_hiding, import_items)) all_avails where -- Warn when importing T(..) if T was exported abstractly checkDodgyImport stuff - | IEThingAll n <- ieRdr, (_, AvailTC _ [one]):_ <- stuff + | IEThingAll n <- ieRdr, (_, AvailTC _ [_]):_ <- stuff = ifOptM Opt_WarnDodgyImports (addWarn (dodgyImportWarn n)) -- NB. use the RdrName for reporting the warning checkDodgyImport _ @@ -473,7 +512,7 @@ filterImports iface decl_spec (Just (want_hiding, import_items)) all_avails -- AvailInfos for the data constructors and the family (as they have -- different parents). See the discussion at occ_env. lookup_ie :: Bool -> IE RdrName -> MaybeErr Message [(IE Name,AvailInfo)] - lookup_ie opt_indexedtypes ie + lookup_ie opt_typeFamilies ie = let bad_ie = Failed (badImportItemErr iface decl_spec ie) lookup_name rdrName = @@ -511,15 +550,15 @@ filterImports iface decl_spec (Just (want_hiding, import_items)) all_avails return [mkIEThingAbs nameAvail] IEThingWith tc ns -> do - (name, AvailTC name2 subnames, mb_parent) <- lookup_name tc + (name, AvailTC _ subnames, mb_parent) <- lookup_name tc let env = mkOccEnv [(nameOccName s, s) | s <- subnames] mb_children = map (lookupOccEnv env . rdrNameOcc) ns children <- if any isNothing mb_children then bad_ie else return (catMaybes mb_children) - -- check for proper import of indexed types - when (not opt_indexedtypes && any isTyConName children) $ + -- check for proper import of type families + when (not opt_typeFamilies && any isTyConName children) $ Failed (typeItemErr (head . filter isTyConName $ children) (text "in import list")) case mb_parent of @@ -538,141 +577,13 @@ filterImports iface decl_spec (Just (want_hiding, import_items)) all_avails where mkIEThingAbs (n, av, Nothing ) = (IEThingAbs n, trimAvail av n) - mkIEThingAbs (n, av, Just parent) = (IEThingAbs n, AvailTC parent [n]) + mkIEThingAbs (n, _, Just parent) = (IEThingAbs n, AvailTC parent [n]) catMaybeErr :: [MaybeErr err a] -> [a] catMaybeErr ms = [ a | Succeeded a <- ms ] \end{code} -\begin{code} -filterImports2 :: ModIface - -> ImpDeclSpec -- The span for the entire import decl - -> Maybe (Bool, [LIE RdrName]) -- Import spec; True => hiding - -> [AvailInfo] -- What's available - -> RnM (Maybe (Bool, [LIE Name]), -- Import spec w/ Names - GlobalRdrEnv) -- Same again, but in GRE form - -filterImports2 iface decl_spec Nothing all_avails - = return (Nothing, mkGlobalRdrEnv (gresFromAvails prov all_avails)) - where - prov = Imported [ImpSpec { is_decl = decl_spec, is_item = ImpAll }] - - -filterImports2 iface decl_spec (Just (want_hiding, import_items)) all_avails - = do -- check for errors, convert RdrNames to Names - opt_indexedtypes <- doptM Opt_IndexedTypes - items1 <- mapM (lookup_lie opt_indexedtypes) import_items - - let items2 :: [(LIE Name, AvailInfo)] - items2 = concat items1 - -- NB the AvailInfo may have duplicates, and several items - -- for the same parent; e.g N(x) and N(y) - - names = availsToNameSet (map snd items2) - keep n = not (n `elemNameSet` names) - pruned_avails = filterAvails keep all_avails - hiding_prov = Imported [ImpSpec { is_decl = decl_spec, is_item = ImpAll }] - - gres | want_hiding = gresFromAvails hiding_prov pruned_avails - | otherwise = concatMap (gresFromIE decl_spec) items2 - - return (Just (want_hiding, map fst items2), mkGlobalRdrEnv gres) - where - -- This environment is how we map names mentioned in the import - -- list to the actual Name they correspond to, and the family - -- that the Name belongs to (an AvailInfo). - -- - -- 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. - occ_env :: OccEnv (Name,AvailInfo) - occ_env = mkOccEnv [ (nameOccName n, (n,a)) - | a <- all_avails, n <- availNames a ] - - lookup_lie :: Bool -> LIE RdrName -> TcRn [(LIE Name, AvailInfo)] - lookup_lie opt_indexedtypes (L loc ieRdr) - = do - stuff <- setSrcSpan loc $ - case lookup_ie opt_indexedtypes ieRdr of - Failed err -> addErr err >> return [] - Succeeded a -> return a - checkDodgyImport stuff - return [ (L loc ie, avail) | (ie,avail) <- stuff ] - where - -- Warn when importing T(..) if T was exported abstractly - checkDodgyImport stuff - | IEThingAll n <- ieRdr, (_, AvailTC _ [one]):_ <- stuff - = ifOptM Opt_WarnDodgyImports (addWarn (dodgyImportWarn n)) - -- NB. use the RdrName for reporting the warning - checkDodgyImport _ - = return () - - -- For each import item, we convert its RdrNames to Names, - -- and at the same time construct an AvailInfo corresponding - -- to what is actually imported by this item. - -- Returns Nothing on error. - -- We return a list here, because in the case of an import - -- item like C, if we are hiding, then C refers to *both* a - -- type/class and a data constructor. - lookup_ie :: Bool -> IE RdrName -> MaybeErr Message [(IE Name,AvailInfo)] - lookup_ie opt_indexedtypes ie - = let bad_ie = Failed (badImportItemErr iface decl_spec ie) - - lookup_name rdrName = - case lookupOccEnv occ_env (rdrNameOcc rdrName) of - Nothing -> bad_ie - Just n -> return n - in - case ie of - IEVar n -> do - (name,avail) <- lookup_name n - return [(IEVar name, trimAvail avail name)] - - IEThingAll tc -> do - (name,avail) <- lookup_name tc - return [(IEThingAll name, avail)] - - IEThingAbs tc - | want_hiding -- hiding ( C ) - -- Here the 'C' can be a data constructor - -- *or* a type/class, or even both - -> let tc_name = lookup_name tc - dc_name = lookup_name (setRdrNameSpace tc srcDataName) - in - case catMaybeErr [ tc_name, dc_name ] of - [] -> bad_ie - names -> return [ (IEThingAbs n, trimAvail av n) - | (n,av) <- names ] - | otherwise - -> do (name,avail) <- lookup_name tc - return [(IEThingAbs name, AvailTC name [name])] - - IEThingWith n ns -> do - (name,avail) <- lookup_name n - case avail of - AvailTC nm subnames | nm == name -> do - let env = mkOccEnv [ (nameOccName s, s) - | s <- subnames ] - let mb_children = map (lookupOccEnv env . rdrNameOcc) ns - children <- - if any isNothing mb_children - then bad_ie - else return (catMaybes mb_children) - -- check for proper import of indexed types - when (not opt_indexedtypes && any isTyConName children) $ - Failed (typeItemErr (head . filter isTyConName - $ children ) - (text "in import list")) - return [(IEThingWith name children, AvailTC name (name:children))] - - _otherwise -> bad_ie - - _other -> Failed illegalImportItemErr - -- could be IEModuleContents, IEGroup, IEDoc, IEDocNamed - -- all errors. -\end{code} - %************************************************************************ %* * Import/Export Utils @@ -702,17 +613,18 @@ mkUnitAvail me (ParentIs p) = AvailTC p [me] mkUnitAvail me NoParent | isTyConName me = AvailTC me [me] | otherwise = Avail me -plusAvail (Avail n1) (Avail n2) = Avail n1 -plusAvail (AvailTC n1 ns1) (AvailTC n2 ns2) = AvailTC n2 (ns1 `unionLists` ns2) +plusAvail :: GenAvailInfo Name -> GenAvailInfo Name -> GenAvailInfo Name +plusAvail (Avail n1) (Avail _) = Avail n1 +plusAvail (AvailTC _ ns1) (AvailTC n2 ns2) = AvailTC n2 (ns1 `unionLists` ns2) plusAvail a1 a2 = pprPanic "RnEnv.plusAvail" (hsep [ppr a1,ppr a2]) availParent :: Name -> AvailInfo -> Parent -availParent n (Avail _) = NoParent -availParent n (AvailTC m ms) | n==m = NoParent - | otherwise = ParentIs m +availParent _ (Avail _) = NoParent +availParent n (AvailTC m _) | n == m = NoParent + | otherwise = ParentIs m trimAvail :: AvailInfo -> Name -> AvailInfo -trimAvail (Avail n) m = Avail n +trimAvail (Avail n) _ = Avail n trimAvail (AvailTC n ns) m = ASSERT( m `elem` ns) AvailTC n [m] -- | filters 'AvailInfo's by the given predicate @@ -729,14 +641,14 @@ filterAvail keep ie rest = let left = filter keep ns in if null left then rest else AvailTC tc left : rest --- | Given an import/export spec, construct the appropriate 'GlobalRdrElt's. +-- | Given an import\/export spec, construct the appropriate 'GlobalRdrElt's. gresFromIE :: ImpDeclSpec -> (LIE Name, AvailInfo) -> [GlobalRdrElt] gresFromIE decl_spec (L loc ie, avail) = gresFromAvail prov_fn avail where is_explicit = case ie of - IEThingAll name -> \n -> n==name - other -> \n -> True + IEThingAll name -> \n -> n == name + _ -> \_ -> True prov_fn name = Imported [imp_spec] where imp_spec = ImpSpec { is_decl = decl_spec, is_item = item_spec } @@ -746,7 +658,7 @@ mkChildEnv :: [GlobalRdrElt] -> NameEnv [Name] mkChildEnv gres = foldr add emptyNameEnv gres where add (GRE { gre_name = n, gre_par = ParentIs p }) env = extendNameEnv_C (++) env p [n] - add other_gre env = env + add _ env = env findChildren :: NameEnv [Name] -> Name -> [Name] findChildren env n = lookupNameEnv env n `orElse` [] @@ -784,9 +696,18 @@ mkAvailEnv :: [AvailInfo] -> AvailEnv -- We want to combine these; addAvail does that mkAvailEnv avails = foldl addAvail emptyAvailEnv avails +-- After combining the avails, we need to ensure that the parent name is the +-- first entry in the list of subnames, if it is included at all. (Subsequent +-- functions rely on that.) +normaliseAvail :: AvailInfo -> AvailInfo +normaliseAvail avail@(Avail _) = avail +normaliseAvail (AvailTC name subs) = AvailTC name subs' + where + subs' = if name `elem` subs then name : (delete name subs) else subs + -- | combines 'AvailInfo's from the same family nubAvails :: [AvailInfo] -> [AvailInfo] -nubAvails avails = nameEnvElts (mkAvailEnv avails) +nubAvails avails = map normaliseAvail . nameEnvElts . mkAvailEnv $ avails \end{code} @@ -816,6 +737,7 @@ type ExportAccum -- The type of the accumulating parameter of [AvailInfo]) -- The accumulated exported stuff -- Not nub'd! +emptyExportAccum :: ExportAccum emptyExportAccum = ([], emptyOccEnv, []) type ExportOccMap = OccEnv (Name, IE RdrName) @@ -824,41 +746,44 @@ type ExportOccMap = OccEnv (Name, IE RdrName) -- it came from. It's illegal to export two distinct things -- that have the same occurrence name -rnExports :: Bool -- False => no 'module M(..) where' header at all +rnExports :: Bool -- False => no 'module M(..) where' header at all -> Maybe [LIE RdrName] -- Nothing => no explicit export list - -> RnM (Maybe [LIE Name], [AvailInfo]) + -> TcGblEnv + -> RnM TcGblEnv -- Complains if two distinct exports have same OccName -- Warns about identical exports. -- Complains about exports items not in scope -rnExports explicit_mod exports - = do TcGblEnv { tcg_mod = this_mod, - tcg_rdr_env = rdr_env, - tcg_imports = imports } <- getGblEnv - +rnExports explicit_mod exports + tcg_env@(TcGblEnv { tcg_mod = this_mod, + tcg_rdr_env = rdr_env, + tcg_imports = imports }) + = do { -- If the module header is omitted altogether, then behave -- as if the user had written "module Main(main) where..." -- EXCEPT in interactive mode, when we behave as if he had -- written "module Main where ..." -- Reason: don't want to complain about 'main' not in scope -- in interactive mode - ghc_mode <- getGhcMode - real_exports <- - case () of - () | explicit_mod - -> return exports - | ghc_mode == Interactive - -> return Nothing - | otherwise - -> do mainName <- lookupGlobalOccRn main_RDR_Unqual - return (Just ([noLoc (IEVar main_RDR_Unqual)])) - -- ToDo: the 'noLoc' here is unhelpful if 'main' turns - -- out to be out of scope - - (exp_spec, avails) <- exports_from_avail real_exports rdr_env imports this_mod - - return (exp_spec, nubAvails avails) -- Combine families + ; dflags <- getDOpts + ; let real_exports + | explicit_mod = exports + | ghcLink dflags == LinkInMemory = Nothing + | otherwise = Just ([noLoc (IEVar main_RDR_Unqual)]) + -- ToDo: the 'noLoc' here is unhelpful if 'main' + -- turns out to be out of scope + + ; (rn_exports, avails) <- exports_from_avail real_exports rdr_env imports this_mod + ; let final_avails = nubAvails avails -- Combine families + + ; return (tcg_env { tcg_exports = final_avails, + tcg_rn_exports = case tcg_rn_exports tcg_env of + Nothing -> Nothing + Just _ -> rn_exports, + tcg_dus = tcg_dus tcg_env `plusDU` + usesOnly (availsToNameSet final_avails) }) } + exports_from_avail :: Maybe [LIE RdrName] -- Nothing => no explicit export list @@ -867,7 +792,7 @@ exports_from_avail :: Maybe [LIE RdrName] -> Module -> RnM (Maybe [LIE Name], [AvailInfo]) -exports_from_avail Nothing rdr_env imports this_mod +exports_from_avail Nothing rdr_env _imports _this_mod = -- The same as (module M) where M is the current module name, -- so that's how we handle it. let @@ -878,6 +803,7 @@ exports_from_avail Nothing rdr_env imports this_mod exports_from_avail (Just rdr_items) rdr_env imports this_mod = do (ie_names, _, exports) <- foldlM do_litem emptyExportAccum rdr_items + return (Just ie_names, exports) where do_litem :: ExportAccum -> LIE RdrName -> RnM ExportAccum @@ -886,6 +812,10 @@ exports_from_avail (Just rdr_items) rdr_env imports this_mod kids_env :: NameEnv [Name] -- Maps a parent to its in-scope children kids_env = mkChildEnv (globalRdrEnvElts rdr_env) + imported_modules = [ qual_name + | xs <- moduleEnvElts $ imp_mods imports, + (qual_name, _, _) <- xs ] + exports_from_item :: ExportAccum -> LIE RdrName -> RnM ExportAccum exports_from_item acc@(ie_names, occs, exports) (L loc ie@(IEModuleContents mod)) @@ -893,14 +823,18 @@ exports_from_avail (Just rdr_items) rdr_env imports this_mod , mod `elem` earlier_mods -- Duplicate export of M = do { warn_dup_exports <- doptM Opt_WarnDuplicateExports ; warnIf warn_dup_exports (dupModuleExport mod) ; - returnM acc } + return acc } | otherwise = do { implicit_prelude <- doptM Opt_ImplicitPrelude - ; let gres = filter (isModuleExported implicit_prelude mod) - (globalRdrEnvElts rdr_env) + ; let { exportValid = (mod `elem` imported_modules) + || (moduleName this_mod == mod) + ; gres = filter (isModuleExported implicit_prelude mod) + (globalRdrEnvElts rdr_env) + } - ; warnIf (null gres) (nullModuleExport mod) + ; checkErr exportValid (moduleNotImported mod) + ; warnIf (exportValid && null gres) (nullModuleExport mod) ; occs' <- check_occs ie occs (map gre_name gres) -- This check_occs not only finds conflicts @@ -934,8 +868,13 @@ exports_from_avail (Just rdr_items) rdr_env imports this_mod return (IEVar (gre_name gre), greAvail gre) lookup_ie (IEThingAbs rdr) - = do name <- lookupGlobalOccRn rdr - return (IEThingAbs name, AvailTC name [name]) + = do gre <- lookupGreRn rdr + let name = gre_name gre + case gre_par gre of + NoParent -> return (IEThingAbs name, + AvailTC name [name]) + ParentIs p -> return (IEThingAbs name, + AvailTC p [name]) lookup_ie ie@(IEThingAll rdr) = do name <- lookupGlobalOccRn rdr @@ -960,15 +899,15 @@ exports_from_avail (Just rdr_items) rdr_env imports this_mod then do addErr (exportItemErr ie) return (IEThingWith name [], AvailTC name [name]) else do let names = catMaybes mb_names - optIdxTypes <- doptM Opt_IndexedTypes - when (not optIdxTypes && any isTyConName names) $ + optTyFam <- doptM Opt_TypeFamilies + when (not optTyFam && any isTyConName names) $ addErr (typeItemErr ( head . filter isTyConName $ names ) (text "in export list")) return (IEThingWith name names, AvailTC name (name:names)) - lookup_ie ie = panic "lookup_ie" -- Other cases covered earlier + lookup_ie _ = panic "lookup_ie" -- Other cases covered earlier ------------- lookup_doc_ie :: IE RdrName -> RnM (IE Name) @@ -977,9 +916,10 @@ exports_from_avail (Just rdr_items) rdr_env imports this_mod lookup_doc_ie (IEDoc doc) = do rn_doc <- rnHsDoc doc return (IEDoc rn_doc) lookup_doc_ie (IEDocNamed str) = return (IEDocNamed str) - lookup_doc_ie ie = panic "lookup_doc_ie" -- Other cases covered earlier + lookup_doc_ie _ = panic "lookup_doc_ie" -- Other cases covered earlier +isDoc :: IE RdrName -> Bool isDoc (IEDoc _) = True isDoc (IEDocNamed _) = True isDoc (IEGroup _ _) = True @@ -994,7 +934,7 @@ isModuleExported implicit_prelude mod (GRE { gre_name = name, gre_prov = prov }) -- They just clutter up the environment (esp tuples), and the parser -- will generate Exact RdrNames for them, so the cluttered -- envt is no use. To avoid doing this filter all the time, - -- we use -fno-implicit-prelude as a clue that the filter is + -- we use -XNoImplicitPrelude as a clue that the filter is -- worth while. Really, it's only useful for GHC.Base and GHC.Tuple. -- -- It's worth doing because it makes the environment smaller for @@ -1011,18 +951,18 @@ check_occs ie occs names where check occs name = case lookupOccEnv occs name_occ of - Nothing -> returnM (extendOccEnv occs name_occ (name, ie)) + Nothing -> return (extendOccEnv occs name_occ (name, ie)) Just (name', ie') | name == name' -- Duplicate export -> do { warn_dup_exports <- doptM Opt_WarnDuplicateExports ; warnIf warn_dup_exports (dupExportWarn name_occ ie ie') ; - returnM occs } + return occs } | otherwise -- Same occ name but different names: an error -> do { global_env <- getGlobalRdrEnv ; addErr (exportClashErr global_env name' name ie' ie) ; - returnM occs } + return occs } where name_occ = nameOccName name \end{code} @@ -1034,13 +974,23 @@ check_occs ie occs names %********************************************************* \begin{code} -reportDeprecations :: DynFlags -> TcGblEnv -> RnM () -reportDeprecations dflags tcg_env - = ifOptM Opt_WarnDeprecations $ - do { (eps,hpt) <- getEpsAndHpt +finishWarnings :: DynFlags -> Maybe WarningTxt + -> TcGblEnv -> RnM TcGblEnv +-- (a) Report usage of imports that are deprecated or have other warnings +-- (b) If the whole module is warned about or deprecated, update tcg_warns +-- All this happens only once per module +finishWarnings dflags mod_warn tcg_env + = do { (eps,hpt) <- getEpsAndHpt + ; ifOptM Opt_WarnWarningsDeprecations $ + mapM_ (check hpt (eps_PIT eps)) all_gres -- By this time, typechecking is complete, -- so the PIT is fully populated - ; mapM_ (check hpt (eps_PIT eps)) all_gres } + + -- Deal with a module deprecation; it overrides all existing warns + ; let new_warns = case mod_warn of + Just txt -> WarnAll txt + Nothing -> tcg_warns tcg_env + ; return (tcg_env { tcg_warns = new_warns }) } where used_names = allUses (tcg_dus tcg_env) -- Report on all deprecated uses; hence allUses @@ -1048,21 +998,21 @@ reportDeprecations dflags tcg_env check hpt pit gre@(GRE {gre_name = name, gre_prov = Imported (imp_spec:_)}) | name `elemNameSet` used_names - , Just deprec_txt <- lookupDeprec dflags hpt pit gre + , Just deprec_txt <- lookupImpDeprec dflags hpt pit gre = addWarnAt (importSpecLoc imp_spec) - (sep [ptext SLIT("Deprecated use of") <+> + (sep [ptext (sLit "In the use of") <+> pprNonVarNameSpace (occNameSpace (nameOccName name)) <+> quotes (ppr name), (parens imp_msg) <> colon, (ppr deprec_txt) ]) where - name_mod = nameModule name + name_mod = ASSERT2( isExternalName name, ppr name ) nameModule name imp_mod = importSpecModule imp_spec - imp_msg = ptext SLIT("imported from") <+> ppr imp_mod <> extra + imp_msg = ptext (sLit "imported from") <+> ppr imp_mod <> extra extra | imp_mod == moduleName name_mod = empty - | otherwise = ptext SLIT(", but defined in") <+> ppr name_mod + | otherwise = ptext (sLit ", but defined in") <+> ppr name_mod - check hpt pit ok_gre = returnM () -- Local, or not used, or not deprectated + check _ _ _ = return () -- 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 @@ -1070,26 +1020,44 @@ reportDeprecations dflags tcg_env -- the defn of a non-deprecated thing, when changing a module's -- interface -lookupDeprec :: DynFlags -> HomePackageTable -> PackageIfaceTable - -> GlobalRdrElt -> Maybe DeprecTxt -lookupDeprec dflags hpt pit gre - = case lookupIfaceByModule dflags hpt pit (nameModule name) of - Just iface -> mi_dep_fn iface name `seqMaybe` -- Bleat if the thing, *or +lookupImpDeprec :: DynFlags -> HomePackageTable -> PackageIfaceTable + -> GlobalRdrElt -> Maybe WarningTxt +-- The name is definitely imported, so look in HPT, PIT +lookupImpDeprec dflags hpt pit gre + = case lookupIfaceByModule dflags hpt pit mod of + Just iface -> mi_warn_fn iface name `mplus` -- Bleat if the thing, *or case gre_par gre of - ParentIs p -> mi_dep_fn iface p -- its parent*, is deprec'd + ParentIs p -> mi_warn_fn iface p -- its parent*, is warn'd NoParent -> Nothing - Nothing - | isWiredInName name -> 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 name) - -- By now all the interfaces should have been loaded + + Nothing -> Nothing -- See Note [Used names with interface not loaded] where - name = gre_name gre + name = gre_name gre + mod = ASSERT2( isExternalName name, ppr name ) nameModule name \end{code} +Note [Used names with interface not loaded] +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +By now all the interfaces should have been loaded, +because reportDeprecations happens after typechecking. +However, it's still (just) possible to to find a used +Name whose interface hasn't been loaded: + +a) It might be a WiredInName; in that case we may not load + its interface (although we could). + +b) It might be GHC.Real.fromRational, or GHC.Num.fromInteger + These are seen as "used" by the renamer (if -XNoImplicitPrelude) + is on), but the typechecker may discard their uses + if in fact the in-scope fromRational is GHC.Read.fromRational, + (see tcPat.tcOverloadedLit), and the typechecker sees that the type + is fixed, say, to GHC.Base.Float (see Inst.lookupSimpleInst). + In that obscure case it won't force the interface in. + +In both cases we simply don't permit deprecations; +this is, after all, wired-in stuff. + + %********************************************************* %* * Unused names @@ -1142,14 +1110,15 @@ reportUnusedNames export_decls gbl_env is_unused_local :: GlobalRdrElt -> Bool is_unused_local gre = isLocalGRE gre && isExternalName (gre_name gre) - unused_imports :: [GlobalRdrElt] - unused_imports = filter unused_imp defined_but_not_used - unused_imp (GRE {gre_prov = Imported imp_specs}) - = not (all (module_unused . importSpecModule) imp_specs) - && or [exp | ImpSpec { is_item = ImpSome { is_explicit = exp } } <- imp_specs] - -- Don't complain about unused imports if we've already said the - -- entire import is unused - unused_imp other = False + unused_imports :: [GlobalRdrElt] + unused_imports = mapCatMaybes unused_imp defined_but_not_used + unused_imp :: GlobalRdrElt -> Maybe GlobalRdrElt -- Result has trimmed Imported provenances + unused_imp (GRE {gre_prov = LocalDef}) = Nothing + unused_imp gre@(GRE {gre_prov = Imported imp_specs}) + | null trimmed_specs = Nothing + | otherwise = Just (gre {gre_prov = Imported trimmed_specs}) + where + trimmed_specs = filter report_if_unused imp_specs -- 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 @@ -1181,7 +1150,7 @@ reportUnusedNames export_decls gbl_env add_name gre@(GRE {gre_prov = Imported (imp_spec:_)}) acc = addToFM_C plusAvailEnv acc (importSpecModule imp_spec) (unitAvailEnv (greAvail gre)) - add_name gre acc = acc -- Local + add_name _ acc = acc -- Local -- Modules mentioned as 'module M' in the export list expall_mods = case export_decls of @@ -1204,7 +1173,7 @@ reportUnusedNames export_decls gbl_env -- qualified imports into account. But it's an improvement. add_expall mod acc = addToFM_C plusAvailEnv acc mod emptyAvailEnv - add_inst_mod (mod,_,_) acc + add_inst_mod (mod, _) acc | mod_name `elemFM` acc = acc -- We import something already | otherwise = addToFM acc mod_name emptyAvailEnv where @@ -1214,21 +1183,26 @@ reportUnusedNames export_decls gbl_env imports = tcg_imports gbl_env - direct_import_mods :: [(Module, Bool, SrcSpan)] + direct_import_mods :: [(Module, [(ModuleName, Bool, SrcSpan)])] -- See the type of the imp_mods for this triple - direct_import_mods = moduleEnvElts (imp_mods imports) + direct_import_mods = fmToList (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] -- - -- BUG WARNING: does not deal correctly with multiple imports of the same module - -- becuase direct_import_mods has only one entry per module - unused_imp_mods = [(mod_name,loc) | (mod,no_imp,loc) <- direct_import_mods, + -- BUG WARNING: this code is generally buggy + unused_imp_mods :: [(ModuleName, SrcSpan)] + unused_imp_mods = [(mod_name,loc) + | (mod, xs) <- direct_import_mods, + (_, no_imp, loc) <- xs, let mod_name = moduleName mod, not (mod_name `elemFM` minimal_imports1), - mod /= pRELUDE, + moduleName mod /= pRELUDE_NAME, + -- XXX not really correct, but we don't want + -- to generate warnings when compiling against + -- a compat version of base. not no_imp] -- The not no_imp part is not to complain about -- import M (), which is an idiom for importing @@ -1237,6 +1211,12 @@ reportUnusedNames export_decls gbl_env module_unused :: ModuleName -> Bool module_unused mod = any (((==) mod) . fst) unused_imp_mods + report_if_unused :: ImportSpec -> Bool + -- Do we want to report this as an unused import? + report_if_unused (ImpSpec {is_decl = d, is_item = i}) + = not (module_unused (is_mod d)) -- Not if we've already said entire import is unused + && isExplicitItem i -- Only if the import was explicit + --------------------- warnDuplicateImports :: [GlobalRdrElt] -> RnM () -- Given the GREs for names that are used, figure out which imports @@ -1254,16 +1234,14 @@ warnDuplicateImports :: [GlobalRdrElt] -> RnM () warnDuplicateImports gres = ifOptM Opt_WarnUnusedImports $ - sequenceM_ [ warn name pr - -- The 'head' picks the first offending group - -- for this particular name + sequence_ [ warn name pr | GRE { gre_name = name, gre_prov = Imported imps } <- gres , pr <- redundants imps ] where warn name (red_imp, cov_imp) = addWarnAt (importSpecLoc red_imp) - (vcat [ptext SLIT("Redundant import of:") <+> quotes pp_name, - ptext SLIT("It is also") <+> ppr cov_imp]) + (vcat [ptext (sLit "Redundant import of:") <+> quotes pp_name, + ptext (sLit "It is also") <+> ppr cov_imp]) where pp_name | is_qual red_decl = ppr (is_as red_decl) <> dot <> ppr occ | otherwise = ppr occ @@ -1275,7 +1253,12 @@ warnDuplicateImports gres redundants imps = [ (red_imp, cov_imp) | red_imp <- imps + , isExplicitItem (is_item red_imp) + -- Complain only about redundant imports + -- mentioned explicitly by the user , cov_imp <- take 1 (filter (covers red_imp) imps) ] + -- The 'take 1' picks the first offending group + -- for this particular name -- "red_imp" is a putative redundant import -- "cov_imp" potentially covers it @@ -1283,12 +1266,12 @@ warnDuplicateImports gres -- -- NOTE: currently the test does not warn about -- import M( x ) - -- imoprt N( x ) + -- import N( x ) -- even if the same underlying 'x' is involved, because dropping -- either import would change the qualified names in scope (M.x, N.x) -- But if the qualified names aren't used, the import is indeed redundant -- Sadly we don't know that. Oh well. - covers red_imp@(ImpSpec { is_decl = red_decl, is_item = red_item }) + covers red_imp@(ImpSpec { is_decl = red_decl }) cov_imp@(ImpSpec { is_decl = cov_decl, is_item = cov_item }) | red_loc == cov_loc = False -- Ignore diagonal elements @@ -1296,6 +1279,10 @@ warnDuplicateImports gres = False -- They bring into scope different qualified names | not (is_qual red_decl) && is_qual cov_decl = False -- Covering one doesn't bring unqualified name into scope + | otherwise + = not (isExplicitItem cov_item) -- Redundant one is selective and covering one isn't + || red_later -- or both are explicit; tie-break using red_later +{- | red_selective = not cov_selective -- Redundant one is selective and covering one isn't || red_later -- Both are explicit; tie-break using red_later @@ -1303,16 +1290,11 @@ warnDuplicateImports gres = not cov_selective -- Neither import is selective && (is_mod red_decl == is_mod cov_decl) -- They import the same module && red_later -- Tie-break +-} where red_loc = importSpecLoc red_imp cov_loc = importSpecLoc cov_imp red_later = red_loc > cov_loc - cov_selective = selectiveImpItem cov_item - red_selective = selectiveImpItem red_item - -selectiveImpItem :: ImpItemSpec -> Bool -selectiveImpItem ImpAll = False -selectiveImpItem (ImpSome {}) = True -- ToDo: deal with original imports with 'qualified' and 'as M' clauses printMinimalImports :: FiniteMap ModuleName AvailEnv -- Minimal imports @@ -1320,12 +1302,13 @@ printMinimalImports :: FiniteMap ModuleName AvailEnv -- Minimal imports printMinimalImports imps = ifOptM Opt_D_dump_minimal_imports $ do { - mod_ies <- mappM to_ies (fmToList imps) ; + mod_ies <- initIfaceTcRn $ mapM to_ies (fmToList imps) ; this_mod <- getModule ; rdr_env <- getGlobalRdrEnv ; - ioToTcRn (do { h <- openFile (mkFilename this_mod) WriteMode ; - printForUser h (mkPrintUnqualified rdr_env) - (vcat (map ppr_mod_ie mod_ies)) }) + dflags <- getDOpts ; + liftIO $ do h <- openFile (mkFilename this_mod) WriteMode + printForUser h (mkPrintUnqualified dflags rdr_env) + (vcat (map ppr_mod_ie mod_ies)) } where mkFilename this_mod = moduleNameString (moduleName this_mod) ++ ".imports" @@ -1333,35 +1316,35 @@ printMinimalImports imps | mod_name == moduleName pRELUDE = empty | null ies -- Nothing except instances comes from here - = ptext SLIT("import") <+> ppr mod_name <> ptext SLIT("() -- Instances only") + = ptext (sLit "import") <+> ppr mod_name <> ptext (sLit "() -- Instances only") | otherwise - = ptext SLIT("import") <+> ppr mod_name <> + = ptext (sLit "import") <+> ppr mod_name <> parens (fsep (punctuate comma (map ppr ies))) to_ies (mod, avail_env) = do ies <- mapM to_ie (availEnvElts avail_env) - returnM (mod, ies) + return (mod, ies) - to_ie :: AvailInfo -> RnM (IE Name) + to_ie :: AvailInfo -> IfG (IE Name) -- The main trick here is that if we're importing all the constructors -- we want to say "T(..)", but if we're importing only a subset we want -- to say "T(A,B,C)". So we have to find out what the module exports. - to_ie (Avail n) = returnM (IEVar n) + to_ie (Avail n) = return (IEVar n) to_ie (AvailTC n [m]) = ASSERT( n==m ) - returnM (IEThingAbs n) - to_ie (AvailTC n ns) - = loadSrcInterface doc n_mod False `thenM` \ iface -> + return (IEThingAbs n) + to_ie (AvailTC n ns) = do + iface <- loadSysInterface doc n_mod case [xs | (m,as) <- mi_exports iface, - moduleName m == n_mod, + m == n_mod, AvailTC x xs <- as, x == nameOccName n] of - [xs] | all_used xs -> returnM (IEThingAll n) - | otherwise -> returnM (IEThingWith n (filter (/= n) ns)) + [xs] | all_used xs -> return (IEThingAll n) + | otherwise -> return (IEThingWith n (filter (/= n) ns)) other -> pprTrace "to_ie" (ppr n <+> ppr n_mod <+> ppr other) $ - returnM (IEVar n) + return (IEVar n) where all_used avail_occs = all (`elem` map nameOccName ns) avail_occs doc = text "Compute minimal imports from" <+> ppr n - n_mod = moduleName (nameModule n) + n_mod = ASSERT( isExternalName n ) nameModule n \end{code} @@ -1372,38 +1355,47 @@ printMinimalImports imps %************************************************************************ \begin{code} +badImportItemErr :: ModIface -> ImpDeclSpec -> IE RdrName -> SDoc badImportItemErr iface decl_spec ie - = sep [ptext SLIT("Module"), quotes (ppr (is_mod decl_spec)), source_import, - ptext SLIT("does not export"), quotes (ppr ie)] + = sep [ptext (sLit "Module"), quotes (ppr (is_mod decl_spec)), source_import, + ptext (sLit "does not export"), quotes (ppr ie)] where - source_import | mi_boot iface = ptext SLIT("(hi-boot interface)") + source_import | mi_boot iface = ptext (sLit "(hi-boot interface)") | otherwise = empty -illegalImportItemErr = ptext SLIT("Illegal import item") +illegalImportItemErr :: SDoc +illegalImportItemErr = ptext (sLit "Illegal import item") -dodgyImportWarn item = dodgyMsg (ptext SLIT("import")) item -dodgyExportWarn item = dodgyMsg (ptext SLIT("export")) item +dodgyImportWarn :: RdrName -> SDoc +dodgyImportWarn item = dodgyMsg (ptext (sLit "import")) item +dodgyExportWarn :: Name -> SDoc +dodgyExportWarn item = dodgyMsg (ptext (sLit "export")) item +dodgyMsg :: OutputableBndr n => SDoc -> n -> SDoc 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") ] - + = sep [ ptext (sLit "The") <+> kind <+> ptext (sLit "item") <+> quotes (ppr (IEThingAll tc)), + ptext (sLit "suggests that") <+> quotes (ppr tc) <+> ptext (sLit "has constructors or class methods,"), + ptext (sLit "but it has none") ] + +exportItemErr :: IE RdrName -> SDoc exportItemErr export_item - = sep [ ptext SLIT("The export item") <+> quotes (ppr export_item), - ptext SLIT("attempts to export constructors or class methods that are not visible here") ] + = sep [ ptext (sLit "The export item") <+> quotes (ppr export_item), + ptext (sLit "attempts to export constructors or class methods that are not visible here") ] +typeItemErr :: Name -> SDoc -> SDoc typeItemErr name wherestr - = sep [ ptext SLIT("Using 'type' tag on") <+> quotes (ppr name) <+> wherestr, - ptext SLIT("Use -findexed-types to enable this extension") ] + = sep [ ptext (sLit "Using 'type' tag on") <+> quotes (ppr name) <+> wherestr, + ptext (sLit "Use -XTypeFamilies to enable this extension") ] +exportClashErr :: GlobalRdrEnv -> Name -> Name -> IE RdrName -> IE RdrName + -> Message exportClashErr global_env name1 name2 ie1 ie2 - = vcat [ ptext SLIT("Conflicting exports for") <+> quotes (ppr occ) <> colon - , ppr_export ie1 name1 - , ppr_export ie2 name2 ] + = vcat [ ptext (sLit "Conflicting exports for") <+> quotes (ppr occ) <> colon + , ppr_export ie1' name1' + , ppr_export ie2' name2' ] where occ = nameOccName name1 - ppr_export ie name = nest 2 (quotes (ppr ie) <+> ptext SLIT("exports") <+> + ppr_export ie name = nest 2 (quotes (ppr ie) <+> ptext (sLit "exports") <+> quotes (ppr name) <+> pprNameProvenance (get_gre name)) -- get_gre finds a GRE for the Name, so that we can show its provenance @@ -1411,32 +1403,57 @@ exportClashErr global_env name1 name2 ie1 ie2 = case lookupGRE_Name global_env name of (gre:_) -> gre [] -> pprPanic "exportClashErr" (ppr name) - -addDupDeclErr :: Name -> Name -> TcRn () -addDupDeclErr name_a name_b - = addErrAt (srcLocSpan loc2) $ - vcat [ptext SLIT("Multiple declarations of") <+> quotes (ppr name1), - ptext SLIT("Declared at:") <+> vcat [ppr (nameSrcLoc name1), ppr loc2]] - where - loc2 = nameSrcLoc name2 - (name1,name2) | nameSrcLoc name_a > nameSrcLoc name_b = (name_b,name_a) - | otherwise = (name_a,name_b) + get_loc name = nameSrcLoc $ gre_name $ get_gre name + (name1', ie1', name2', ie2') = if get_loc name1 < get_loc name2 + then (name1, ie1, name2, ie2) + else (name2, ie2, name1, ie1) + +addDupDeclErr :: [Name] -> TcRn () +addDupDeclErr [] + = panic "addDupDeclErr: empty list" +addDupDeclErr names@(name : _) + = addErrAt (getSrcSpan (last sorted_names)) $ -- Report the error at the later location + vcat [ptext (sLit "Multiple declarations of") <+> quotes (ppr name), + ptext (sLit "Declared at:") <+> vcat (map (ppr . nameSrcLoc) sorted_names)] + where + sorted_names = sortWith nameSrcLoc names +dupExportWarn :: OccName -> IE RdrName -> IE RdrName -> SDoc dupExportWarn occ_name ie1 ie2 = hsep [quotes (ppr occ_name), - ptext SLIT("is exported by"), quotes (ppr ie1), - ptext SLIT("and"), quotes (ppr ie2)] + ptext (sLit "is exported by"), quotes (ppr ie1), + ptext (sLit "and"), quotes (ppr ie2)] +dupModuleExport :: ModuleName -> SDoc dupModuleExport mod - = hsep [ptext SLIT("Duplicate"), - quotes (ptext SLIT("Module") <+> ppr mod), - ptext SLIT("in export list")] + = hsep [ptext (sLit "Duplicate"), + quotes (ptext (sLit "Module") <+> ppr mod), + ptext (sLit "in export list")] -nullModuleExport mod - = ptext SLIT("The export item `module") <+> ppr mod <> ptext SLIT("' exports nothing") +moduleNotImported :: ModuleName -> SDoc +moduleNotImported mod + = ptext (sLit "The export item `module") <+> ppr mod <> + ptext (sLit "' is not imported") -moduleDeprec mod txt - = sep [ ptext SLIT("Module") <+> quotes (ppr mod) <+> ptext SLIT("is deprecated:"), - nest 4 (ppr txt) ] +nullModuleExport :: ModuleName -> SDoc +nullModuleExport mod + = ptext (sLit "The export item `module") <+> ppr mod <> ptext (sLit "' exports nothing") + +moduleWarn :: ModuleName -> WarningTxt -> SDoc +moduleWarn mod (WarningTxt txt) + = sep [ ptext (sLit "Module") <+> quotes (ppr mod) <> ptext (sLit ":"), + nest 4 (ppr txt) ] +moduleWarn mod (DeprecatedTxt txt) + = sep [ ptext (sLit "Module") <+> quotes (ppr mod) + <+> ptext (sLit "is deprecated:"), + nest 4 (ppr txt) ] + +implicitPreludeWarn :: SDoc +implicitPreludeWarn + = ptext (sLit "Module `Prelude' implicitly imported") + +packageImportErr :: SDoc +packageImportErr + = ptext (sLit "Package-qualified imports are not enabled; use -XPackageImports") \end{code}