\begin{code}
module RnNames (
- getGlobalNames, exportsFromAvail
+ ExportAvails, getGlobalNames, exportsFromAvail
) where
#include "HsVersions.h"
import CmdLineOpts ( DynFlag(..) )
import HsSyn ( HsModule(..), HsDecl(..), IE(..), ieName, ImportDecl(..),
- ForeignDecl(..), ForKind(..), isDynamicExtName,
- collectTopBinders
+ ForeignDecl(..),
+ collectLocatedHsBinders
)
import RdrHsSyn ( RdrNameIE, RdrNameImportDecl,
RdrNameHsModule, RdrNameHsDecl
)
-import RnIfaces ( getInterfaceExports, recordLocalSlurps )
-import RnHiFiles ( getTyClDeclBinders )
+import RnIfaces ( recordLocalSlurps )
+import RnHiFiles ( getTyClDeclBinders, loadInterface )
import RnEnv
import RnMonad
import FiniteMap
import PrelNames ( pRELUDE_Name, mAIN_Name, main_RDR_Unqual, isUnboundName )
-import UniqFM ( lookupUFM )
-import Bag ( bagToList )
import Module ( ModuleName, moduleName, WhereFrom(..) )
+import Name ( Name, nameSrcLoc, nameOccName )
import NameSet
-import Name ( Name, nameSrcLoc, nameOccName, nameEnvElts )
+import NameEnv
import HscTypes ( Provenance(..), ImportReason(..), GlobalRdrEnv,
- GenAvailInfo(..), AvailInfo, Avails, AvailEnv )
-import RdrName ( RdrName, rdrNameOcc, setRdrNameOcc, mkRdrQual, mkRdrUnqual )
+ GenAvailInfo(..), AvailInfo, Avails, AvailEnv,
+ Deprecations(..), ModIface(..), emptyAvailEnv
+ )
+import RdrName ( rdrNameOcc, setRdrNameOcc )
import OccName ( setOccNameSpace, dataName )
import NameSet ( elemNameSet, emptyNameSet )
import Outputable
import Maybes ( maybeToBool, catMaybes, mapMaybe )
-import UniqFM ( emptyUFM, listToUFM )
import ListSetOps ( removeDups )
import Util ( sortLt )
import List ( partition )
importsFromImportDecl this_mod_name (ImportDecl imp_mod_name from qual_only as_mod import_spec iloc)
= pushSrcLocRn iloc $
- getInterfaceExports imp_mod_name from `thenRn` \ (imp_mod, avails_by_module) ->
-
- if null avails_by_module then
- -- If there's an error in getInterfaceExports, (e.g. interface
- -- file not found) we get lots of spurious errors from 'filterImports'
- returnRn (emptyRdrEnv, mkEmptyExportAvails imp_mod_name)
- else
+ loadInterface (ppr imp_mod_name <+> ptext SLIT("is directly imported"))
+ imp_mod_name from `thenRn` \ iface ->
let
+ imp_mod = mi_module iface
+ avails_by_module = mi_exports iface
+ deprecs = mi_deprecs iface
+
avails :: Avails
avails = [ avail | (mod_name, avails) <- avails_by_module,
mod_name /= this_mod_name,
-- then you'll get a 'B does not export AType' message. Oh well.
in
- filterImports imp_mod_name from import_spec avails `thenRn` \ (filtered_avails, hides, explicits) ->
+ if null avails_by_module then
+ -- If there's an error in loadInterface, (e.g. interface
+ -- file not found) we get lots of spurious errors from 'filterImports'
+ returnRn (emptyRdrEnv, mkEmptyExportAvails imp_mod_name)
+ else
+
+ -- Complain if we import a deprecated module
+ ifOptRn Opt_WarnDeprecations (
+ case deprecs of
+ DeprecAll txt -> addWarnRn (moduleDeprec imp_mod_name txt)
+ other -> returnRn ()
+ ) `thenRn_`
+
+ -- Filter the imports according to the import list
+ filterImports imp_mod_name from import_spec avails `thenRn` \ (filtered_avails, explicits) ->
let
- mk_provenance name = NonLocalDef (UserImport imp_mod iloc (name `elemNameSet` explicits))
+ unqual_imp = not qual_only -- Maybe want unqualified names
+ qual_mod = case as_mod of
+ Nothing -> imp_mod_name
+ Just another_name -> another_name
+
+ mk_prov name = NonLocalDef (UserImport imp_mod iloc (name `elemNameSet` explicits))
+ gbl_env = mkGlobalRdrEnv qual_mod unqual_imp mk_prov filtered_avails deprecs
+ exports = mkExportAvails qual_mod unqual_imp gbl_env filtered_avails
in
-
- qualifyImports imp_mod_name
- (not qual_only) -- Maybe want unqualified names
- as_mod hides
- mk_provenance
- filtered_avails
+ returnRn (gbl_env, exports)
\end{code}
\begin{code}
importsFromLocalDecls this_mod decls
= mapRn (getLocalDeclBinders this_mod) decls `thenRn` \ avails_s ->
-
+ -- The avails that are returned don't include the "system" names
let
avails = concat avails_s
(_, dups) = removeDups compare all_names
in
-- Check for duplicate definitions
- mapRn_ (addErrRn . dupDeclErr) dups `thenRn_`
+ -- 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.
+ mapRn_ (addErrRn . dupDeclErr) dups `thenRn_`
- -- Record that locally-defined things are available
- recordLocalSlurps avails `thenRn_`
- -- Build the environment
- qualifyImports (moduleName this_mod)
- True -- Want unqualified names
- Nothing -- no 'as M'
- [] -- Hide nothing
- (\n -> LocalDef) -- Provenance is local
- avails
+ -- Record that locally-defined things are available
+ recordLocalSlurps (availsToNameSet avails) `thenRn_`
+ let
+ mod_name = moduleName this_mod
+ unqual_imp = True -- Want unqualified names
+ mk_prov n = LocalDef -- Provenance is local
+
+ gbl_env = mkGlobalRdrEnv mod_name unqual_imp mk_prov avails NoDeprecs
+ -- NoDeprecs: don't complain about 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
+
+ exports = mkExportAvails mod_name unqual_imp gbl_env avails
+ in
+ returnRn (gbl_env, exports)
---------------------------
-getLocalDeclBinders :: Module
- -> RdrNameHsDecl -> RnMG Avails
+getLocalDeclBinders :: Module -> RdrNameHsDecl -> RnMG [AvailInfo]
getLocalDeclBinders mod (TyClD tycl_decl)
= -- For type and class decls, we generate Global names, with
-- no export indicator. They need to be global because they get
-- permanently bound into the TyCons and Classes. They don't need
-- an export indicator because they are all implicitly exported.
- getTyClDeclBinders mod tycl_decl `thenRn` \ avail ->
+ getTyClDeclBinders mod tycl_decl `thenRn` \ (avail, sys_names) ->
+
+ -- Record that the system names are available
+ recordLocalSlurps (mkNameSet sys_names) `thenRn_`
returnRn [avail]
getLocalDeclBinders mod (ValD binds)
- = mapRn new (bagToList (collectTopBinders binds))
+ = mapRn new (collectLocatedHsBinders binds) `thenRn` \ avails ->
+ returnRn avails
where
new (rdr_name, loc) = newTopBinder mod rdr_name loc `thenRn` \ name ->
returnRn (Avail name)
-getLocalDeclBinders mod (ForD (ForeignDecl nm kind _ ext_nm _ loc))
- | binds_haskell_name kind
+getLocalDeclBinders mod (ForD (ForeignImport nm _ _ loc))
= newTopBinder mod nm loc `thenRn` \ name ->
returnRn [Avail name]
-
- | otherwise -- a foreign export
+getLocalDeclBinders mod (ForD _)
= returnRn []
- where
- binds_haskell_name (FoImport _) = True
- binds_haskell_name FoLabel = True
- binds_haskell_name FoExport = isDynamicExtName ext_nm
getLocalDeclBinders mod (FixD _) = returnRn []
getLocalDeclBinders mod (DeprecD _) = returnRn []
-> WhereFrom -- Tells whether it's a {-# SOURCE #-} import
-> Maybe (Bool, [RdrNameIE]) -- Import spec; True => hiding
-> [AvailInfo] -- What's available
- -> RnMG ([AvailInfo], -- What's actually imported
- [AvailInfo], -- What's to be hidden
- -- (the unqualified version, that is)
- -- (We need to return both the above sets, because
- -- the qualified version is never hidden; so we can't
- -- implement hiding by reducing what's imported.)
+ -> RnMG ([AvailInfo], -- What's imported
NameSet) -- What was imported explicitly
-- Complains if import spec mentions things that the module doesn't export
-- Warns/informs if import spec contains duplicates.
filterImports mod from Nothing imports
- = returnRn (imports, [], emptyNameSet)
+ = returnRn (imports, emptyNameSet)
filterImports mod from (Just (want_hiding, import_items)) total_avails
= flatMapRn get_item import_items `thenRn` \ avails_w_explicits ->
(item_avails, explicits_s) = unzip avails_w_explicits
explicits = foldl addListToNameSet emptyNameSet explicits_s
in
- if want_hiding
- then
- -- All imported; item_avails to be hidden
- returnRn (total_avails, item_avails, emptyNameSet)
+ if want_hiding then
+ let -- All imported; item_avails to be hidden
+ hidden = availsToNameSet item_avails
+ keep n = not (n `elemNameSet` hidden)
+ in
+ returnRn (pruneAvails keep total_avails, emptyNameSet)
else
-- Just item_avails imported; nothing to be hidden
- returnRn (item_avails, [], explicits)
+ returnRn (item_avails, explicits)
where
import_fm :: FiniteMap OccName AvailInfo
import_fm = listToFM [ (nameOccName name, avail)
bale_out item = addErrRn (badImportItemErr mod from item) `thenRn_`
returnRn []
+ get_item :: RdrNameIE -> RnMG [(AvailInfo, [Name])]
get_item item@(IEModuleContents _) = bale_out item
get_item item@(IEThingAll _)
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
- addWarnRn (dodgyImportWarn mod item) `thenRn_`
+ ifOptRn Opt_WarnMisc (addWarnRn (dodgyImportWarn mod item)) `thenRn_`
returnRn [(avail, [availName avail])]
Just avail -> returnRn [(avail, [availName avail])]
get_item item@(IEThingAbs n)
| want_hiding -- hiding( C )
-- Here the 'C' can be a data constructor *or* a type/class
- = case catMaybes [check_item item, check_item (IEThingAbs data_n)] of
+ = case catMaybes [check_item item, check_item (IEVar data_n)] of
[] -> bale_out item
avails -> returnRn [(a, []) | a <- avails]
-- The 'explicits' list is irrelevant when hiding
%* *
%************************************************************************
-@qualifyImports@ takes the @ExportEnv@ after filtering through the import spec
-of an import decl, and deals with producing an @RnEnv@ with the
-right qualified names. It also turns the @Names@ in the @ExportEnv@ into
-fully fledged @Names@.
-
\begin{code}
-qualifyImports :: ModuleName -- Imported module
- -> Bool -- True <=> want unqualified import
- -> Maybe ModuleName -- Optional "as M" part
- -> [AvailInfo] -- What's to be hidden
- -> (Name -> Provenance)
- -> Avails -- Whats imported and how
- -> RnMG (GlobalRdrEnv, ExportAvails)
-
-qualifyImports this_mod unqual_imp as_mod hides mk_provenance avails
- =
- -- Make the name environment. We're talking about a
- -- single module here, so there must be no name clashes.
- -- In practice there only ever will be if it's the module
- -- being compiled.
- let
- -- Add the things that are available
- name_env1 = foldl add_avail emptyRdrEnv avails
-
- -- Delete things that are hidden
- name_env2 = foldl del_avail name_env1 hides
-
- -- Create the export-availability info
- export_avails = mkExportAvails qual_mod unqual_imp name_env2 avails
- in
- returnRn (name_env2, export_avails)
-
- where
- qual_mod = case as_mod of
- Nothing -> this_mod
- Just another_name -> another_name
-
- add_avail :: GlobalRdrEnv -> AvailInfo -> GlobalRdrEnv
- add_avail env avail = foldl add_name env (availNames avail)
-
- add_name env name
- | unqual_imp = env2
- | otherwise = env1
- where
- env1 = addOneToGlobalRdrEnv env (mkRdrQual qual_mod occ) (name,prov)
- env2 = addOneToGlobalRdrEnv env1 (mkRdrUnqual occ) (name,prov)
- occ = nameOccName name
- prov = mk_provenance name
-
- del_avail env avail = foldl delOneFromGlobalRdrEnv env rdr_names
- where
- rdr_names = map (mkRdrUnqual . nameOccName) (availNames avail)
+type ExportAvails
+ = (FiniteMap ModuleName Avails,
+ -- Used to figure out "module M" export specifiers
+ -- Includes avails only from *unqualified* imports
+ -- (see 1.4 Report Section 5.1.1)
+ AvailEnv) -- All the things that are available.
+ -- Its domain is all the "main" things;
+ -- i.e. *excluding* class ops and constructors
+ -- (which appear inside their parent AvailTC)
mkEmptyExportAvails :: ModuleName -> ExportAvails
-mkEmptyExportAvails mod_name = (unitFM mod_name [], emptyUFM)
+mkEmptyExportAvails mod_name = (unitFM mod_name [], emptyNameEnv)
+
+plusExportAvails :: ExportAvails -> ExportAvails -> ExportAvails
+plusExportAvails (m1, e1) (m2, e2) = (plusFM_C (++) m1 m2, plusAvailEnv e1 e2)
mkExportAvails :: ModuleName -> Bool -> GlobalRdrEnv -> [AvailInfo] -> ExportAvails
-mkExportAvails mod_name unqual_imp name_env avails
+mkExportAvails mod_name unqual_imp gbl_env avails
= (mod_avail_env, entity_avail_env)
where
mod_avail_env = unitFM mod_name unqual_avails
- -- unqual_avails is the Avails that are visible in *unqualfied* form
- -- (1.4 Report, Section 5.1.1)
- -- For example, in
- -- import T hiding( f )
- -- we delete f from avails
+ -- 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.
unqual_avails | not unqual_imp = [] -- Short cut when no unqualified imports
- | otherwise = mapMaybe prune avails
-
- prune (Avail n) | unqual_in_scope n = Just (Avail n)
- prune (Avail n) | otherwise = Nothing
- prune (AvailTC n ns) | null uqs = Nothing
- | otherwise = Just (AvailTC n uqs)
- where
- uqs = filter unqual_in_scope ns
+ | otherwise = pruneAvails (unQualInScope gbl_env) avails
- unqual_in_scope n = unQualInScope name_env n
-
- entity_avail_env = listToUFM [ (name,avail) | avail <- avails,
- name <- availNames avail]
-
-plusExportAvails :: ExportAvails -> ExportAvails -> ExportAvails
-plusExportAvails (m1, e1) (m2, e2)
- = (plusFM_C (++) m1 m2, plusAvailEnv e1 e2)
- -- ToDo: wasteful: we do this once for each constructor!
+ entity_avail_env = mkNameEnv [(availName avail, avail) | avail <- avails]
\end{code}
exportsFromAvail :: ModuleName
- -> Maybe [RdrNameIE] -- Export spec
- -> ExportAvails
+ -> Maybe [RdrNameIE] -- Export spec
+ -> FiniteMap ModuleName Avails -- Used for (module M) exports
+ -> NameEnv AvailInfo -- Domain is every in-scope thing
-> GlobalRdrEnv
-> RnMG Avails
-- Complains if two distinct exports have same OccName
-- Warns about identical exports.
-- Complains about exports items not in scope
-exportsFromAvail this_mod Nothing export_avails global_name_env
- = exportsFromAvail this_mod true_exports export_avails global_name_env
+exportsFromAvail this_mod Nothing
+ mod_avail_env entity_avail_env global_name_env
+ = exportsFromAvail this_mod true_exports mod_avail_env entity_avail_env global_name_env
where
true_exports = Just $ if this_mod == mAIN_Name
then [IEVar main_RDR_Unqual]
-- but for all other modules export everything.
exportsFromAvail this_mod (Just export_items)
- (mod_avail_env, entity_avail_env)
- global_name_env
+ mod_avail_env entity_avail_env global_name_env
= doptRn Opt_WarnDuplicateExports `thenRn` \ warn_dup_exports ->
foldlRn (exports_from_item warn_dup_exports)
([], emptyFM, emptyAvailEnv) export_items
= lookupSrcName global_name_env (ieName ie) `thenRn` \ name ->
-- See what's available in the current environment
- case lookupUFM entity_avail_env name of {
+ case lookupNameEnv entity_avail_env name of {
Nothing -> -- Presumably this happens because lookupSrcName didn't find
-- the name and returned an unboundName, which won't be in
-- the entity_avail_env, of course
= hsep [ptext SLIT("Duplicate"),
quotes (ptext SLIT("Module") <+> ppr mod),
ptext SLIT("in export list")]
+
+moduleDeprec mod txt
+ = sep [ ptext SLIT("Module") <+> quotes (ppr mod) <+> ptext SLIT("is deprecated:"),
+ nest 4 (ppr txt) ]
\end{code}