-- for details
module RnNames (
- rnImports, importsFromLocalDecls,
- rnExports,
- getLocalDeclBinders, extendRdrEnvRn,
+ rnImports, getLocalNonValBinders,
+ rnExports, extendGlobalRdrEnvRn,
reportUnusedNames, finishDeprecations,
) where
import Module
import Name
import NameEnv
-import UniqFM
+import LazyUniqFM
import NameSet
import OccName
import HscTypes
import BasicTypes ( DeprecTxt, Fixity )
import DriverPhases ( isHsBoot )
import Util
+import FastString
import ListSetOps
import Data.List ( partition, concatMap, (\\), delete )
import IO ( openFile, IOMode(..) )
Nothing {- No "as" -}
Nothing {- No import list -}
- loc = mkGeneralSrcSpan FSLIT("Implicit import declaration")
+ loc = mkGeneralSrcSpan (fsLit "Implicit import declaration")
rnImportDecl :: Module
-- 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
ifOptM Opt_WarnDeprecations (
case deprecs of
DeprecAll txt -> addWarn (moduleDeprec imp_mod_name txt)
- other -> returnM ()
+ other -> return ()
)
let new_imp_decl = L loc (ImportDecl loc_imp_mod_name want_boot
qual_only as_mod new_imp_details)
- returnM (new_imp_decl, gbl_env, imports, mi_hpc iface)
+ return (new_imp_decl, gbl_env, imports, mi_hpc iface)
)
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}
* the ImportAvails
created by its bindings.
-\begin{code}
--- Bool determines shadowing:
--- true: names in the group should shadow other UnQuals
--- with the same OccName (used in Template Haskell)
--- false: duplicates should be reported as an error
---
--- The UniqFM (OccName -> FixItem) associates a Name's OccName's
--- FastString with a fixity declaration (that needs the actual OccName
--- to be plugged in). This fixity must be brought into scope when such
--- a Name is.
-importsFromLocalDecls :: Bool -> HsGroup RdrName -> UniqFM (Located Fixity) -> RnM TcGblEnv
-importsFromLocalDecls shadowP group fixities
- = do { gbl_env <- getGblEnv
-
- ; avails <- getLocalDeclBinders gbl_env group
+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.
- ; (rdr_env', fix_env') <- extendRdrEnvRn shadowP (tcg_rdr_env gbl_env,
- tcg_fix_env gbl_env)
- avails fixities
+\begin{code}
+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)
- ; traceRn (text "local avails: " <> ppr avails)
+ ; (rdr_env', fix_env') <- foldlM extend (rdr_env2, fix_env) gres
+
+ ; let gbl_env' = gbl_env { tcg_rdr_env = rdr_env', tcg_fix_env = fix_env' }
+ ; traceRn (text "extendGlobalRdrEnvRn" <+> (ppr new_fixities $$ ppr fix_env $$ ppr fix_env'))
+ ; return (gbl_env', lcl_env2) }
+ where
+ gres = gresFromAvails LocalDef avails
- ; returnM (gbl_env { tcg_rdr_env = rdr_env',
- tcg_fix_env = fix_env'})
- }
+ extend envs@(cur_rdr_env, cur_fix_env) gre
+ = let gres = lookupGlobalRdrEnv cur_rdr_env (nameOccName (gre_name gre))
+ in case filter isLocalGRE gres of -- Check for existing *local* defns
+ dup_gre:_ -> do { addDupDeclErr (gre_name dup_gre) (gre_name gre)
+ ; return envs }
+ [] -> return (simple_extend envs gre)
--- Bool determines shadowing as in importsFromLocalDecls.
--- UniqFM FixItem is the same as in importsFromLocalDecls.
---
--- 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.
---
--- Also update the FixityEnv with the fixities for the names brought into scope.
---
--- Note that the return values are the extensions of the two inputs,
--- not the extras relative to them.
-extendRdrEnvRn :: Bool -> (GlobalRdrEnv, NameEnv FixItem)
- -> [AvailInfo] -> UniqFM (Located Fixity) -> RnM (GlobalRdrEnv, NameEnv FixItem)
-extendRdrEnvRn shadowP (rdr_env, fix_env) avails fixities =
- let -- if there is a fixity decl for the gre,
- -- add it to the fixity env
- extendFixEnv env gre =
- let name = gre_name gre
- occ = nameOccName name
- curKey = occNameFS occ in
- case lookupUFM fixities curKey of
- Nothing -> env
- Just (L _ fi) -> extendNameEnv env name (FixItem occ fi)
-
- (rdr_env_to_extend, extender) =
- if shadowP
- then -- when shadowing is on,
- -- (1) we need to remove the existing Unquals for the
- -- names we're extending the env with
- -- (2) but extending the env is simple
- let names = concatMap availNames avails
- new_occs = map nameOccName names
- trimmed_rdr_env = hideSomeUnquals rdr_env new_occs
- in
- (trimmed_rdr_env,
- \(cur_rdr_env, cur_fix_env) -> \gre ->
- return (extendGlobalRdrEnv cur_rdr_env gre,
- extendFixEnv cur_fix_env gre))
- else -- when shadowing is off,
- -- (1) we don't munge the incoming env
- -- (2) but we need to check for dups when extending
- (rdr_env,
- \(cur_rdr_env, cur_fix_env) -> \gre ->
- let gres = lookupGlobalRdrEnv cur_rdr_env (nameOccName (gre_name gre))
- in case filter isLocalGRE gres of -- Check for existing *local* defns
- dup_gre:_ -> do { addDupDeclErr (gre_name dup_gre) (gre_name gre)
- ; return (cur_rdr_env, cur_fix_env) }
- [] -> return (extendGlobalRdrEnv cur_rdr_env gre,
- extendFixEnv cur_fix_env gre))
- in foldlM extender (rdr_env_to_extend, fix_env) (gresFromAvails LocalDef avails)
+ simple_extend (rdr_env, fix_env) gre
+ = (extendGlobalRdrEnv rdr_env gre, fix_env')
+ where
+ -- If there is a fixity decl for the gre, add it to the fixity env
+ name = gre_name gre
+ occ = nameOccName name
+ fix_env' = case lookupFsEnv new_fixities (occNameFS occ) of
+ Nothing -> fix_env
+ Just (L _ fi) -> extendNameEnv fix_env name (FixItem occ fi)
\end{code}
@getLocalDeclBinders@ returns the names for an @HsDecl@. It's
don't return it in the 'AvailInfo'.
\begin{code}
--- Note: this function does NOT get the binders of the ValBinds that
--- will be bound during renaming
-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 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
new_tc 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
\end{code}
, 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
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}
| name `elemNameSet` used_names
, Just deprec_txt <- lookupImpDeprec dflags hpt pit gre
= addWarnAt (importSpecLoc imp_spec)
- (sep [ptext SLIT("Deprecated use of") <+>
+ (sep [ptext (sLit "Deprecated use of") <+>
pprNonVarNameSpace (occNameSpace (nameOccName name)) <+>
quotes (ppr name),
(parens imp_msg) <> colon,
where
name_mod = 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 hpt pit ok_gre = 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
warnDuplicateImports gres
= ifOptM Opt_WarnUnusedImports $
- sequenceM_ [ warn name pr
+ 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
--
-- 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
printMinimalImports imps
= ifOptM Opt_D_dump_minimal_imports $ do {
- mod_ies <- initIfaceTcRn $ mappM to_ies (fmToList imps) ;
+ mod_ies <- initIfaceTcRn $ mapM to_ies (fmToList imps) ;
this_mod <- getModule ;
rdr_env <- getGlobalRdrEnv ;
dflags <- getDOpts ;
- ioToTcRn (do { h <- openFile (mkFilename this_mod) WriteMode ;
- printForUser h (mkPrintUnqualified dflags rdr_env)
- (vcat (map ppr_mod_ie mod_ies)) })
+ 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"
| 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 -> 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)
- = loadSysInterface doc n_mod `thenM` \ iface ->
+ return (IEThingAbs n)
+ to_ie (AvailTC n ns) = do
+ iface <- loadSysInterface doc n_mod
case [xs | (m,as) <- mi_exports iface,
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
\begin{code}
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 = ptext (sLit "Illegal import item")
-dodgyImportWarn 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 tc
- = 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") ]
+ = 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 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 wherestr
- = sep [ ptext SLIT("Using 'type' tag on") <+> quotes (ppr name) <+> wherestr,
- ptext SLIT("Use -XTypeFamilies 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
+ = 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
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]]
+ 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)
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 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")]
moduleNotImported :: ModuleName -> SDoc
moduleNotImported mod
- = ptext SLIT("The export item `module") <+> ppr mod <>
- ptext SLIT("' is not imported")
+ = ptext (sLit "The export item `module") <+> ppr mod <>
+ ptext (sLit "' is not imported")
nullModuleExport mod
- = ptext SLIT("The export item `module") <+> ppr mod <> ptext SLIT("' exports nothing")
+ = ptext (sLit "The export item `module") <+> ppr mod <> ptext (sLit "' exports nothing")
moduleDeprec mod txt
- = sep [ ptext SLIT("Module") <+> quotes (ppr mod) <+> ptext SLIT("is deprecated:"),
+ = sep [ ptext (sLit "Module") <+> quotes (ppr mod) <+> ptext (sLit "is deprecated:"),
nest 4 (ppr txt) ]
implicitPreludeWarn
- = ptext SLIT("Module `Prelude' implicitly imported")
+ = ptext (sLit "Module `Prelude' implicitly imported")
\end{code}