[project @ 2002-04-05 23:24:25 by sof]
[ghc-hetmet.git] / ghc / compiler / rename / RnNames.lhs
index 5dc3100..1eefbc3 100644 (file)
@@ -5,7 +5,7 @@
 
 \begin{code}
 module RnNames (
-       getGlobalNames, exportsFromAvail
+       ExportAvails, getGlobalNames, exportsFromAvail
     ) where
 
 #include "HsVersions.h"
@@ -13,34 +13,34 @@ module RnNames (
 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 PrelNames       ( pRELUDE_Name, mAIN_Name, isUnboundName )
 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 )
+                         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 Maybes          ( maybeToBool, catMaybes )
 import ListSetOps      ( removeDups )
-import Util            ( sortLt )
+import Util            ( sortLt, notNull )
 import List            ( partition )
 \end{code}
 
@@ -113,7 +113,7 @@ getGlobalNames this_mod (HsModule _ _ _ imports decls _ mod_loc)
                                  mod_loc]
     
     explicit_prelude_import
-      = not (null [ () | (ImportDecl mod _ _ _ _ _) <- imports, mod == pRELUDE_Name ])
+      = notNull [ () | (ImportDecl mod _ _ _ _ _) <- imports, mod == pRELUDE_Name ]
 \end{code}
        
 \begin{code}
@@ -124,15 +124,14 @@ importsFromImportDecl :: ModuleName
 
 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,
@@ -155,7 +154,21 @@ importsFromImportDecl this_mod_name (ImportDecl imp_mod_name from qual_only as_m
        -- 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
        unqual_imp = not qual_only              -- Maybe want unqualified names
@@ -164,8 +177,8 @@ importsFromImportDecl this_mod_name (ImportDecl imp_mod_name from qual_only as_m
                        Just another_name -> another_name
 
        mk_prov name = NonLocalDef (UserImport imp_mod iloc (name `elemNameSet` explicits)) 
-       gbl_env      = mkGlobalRdrEnv qual_mod unqual_imp hides mk_prov filtered_avails
-       exports      = mkExportAvails qual_mod unqual_imp gbl_env       filtered_avails
+       gbl_env      = mkGlobalRdrEnv qual_mod unqual_imp mk_prov filtered_avails deprecs
+       exports      = mkExportAvails qual_mod unqual_imp gbl_env filtered_avails
     in
     returnRn (gbl_env, exports)
 \end{code}
@@ -174,7 +187,7 @@ importsFromImportDecl this_mod_name (ImportDecl imp_mod_name from qual_only as_m
 \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
 
@@ -185,49 +198,56 @@ importsFromLocalDecls this_mod decls
        (_, dups) = removeDups compare all_names
     in
        -- Check for duplicate definitions
+       -- 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 (availsToNameSet avails)         `thenRn_`
-
     let
        mod_name   = moduleName this_mod
        unqual_imp = True       -- Want unqualified names
        mk_prov n  = LocalDef   -- Provenance is local
-       hides      = []         -- Hide nothing
-       gbl_env    = mkGlobalRdrEnv mod_name unqual_imp hides mk_prov avails
-       exports    = mkExportAvails mod_name unqual_imp gbl_env       avails
+
+       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 []
@@ -251,18 +271,13 @@ filterImports :: ModuleName                       -- The module being imported
              -> 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 ->
@@ -270,13 +285,15 @@ filterImports mod from (Just (want_hiding, import_items)) total_avails
        (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) 
@@ -289,6 +306,12 @@ filterImports mod from (Just (want_hiding, import_items)) total_avails
     bale_out item = addErrRn (badImportItemErr mod from item)  `thenRn_`
                    returnRn []
 
+    get_item :: RdrNameIE -> RnMG [(AvailInfo, [Name])]
+       -- Empty list for a bad item.
+       -- Singleton 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@(IEThingAll _)
@@ -297,14 +320,14 @@ filterImports mod from (Just (want_hiding, import_items)) total_avails
          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
@@ -342,40 +365,43 @@ filterImports mod from (Just (want_hiding, import_items)) total_avails
 %************************************************************************
 
 \begin{code}
+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 gbl_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
-
-    unqual_in_scope n = unQualInScope gbl_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!
+                 | otherwise      = pruneAvails (unQualInScope gbl_env) avails
+
+    entity_avail_env = foldl insert emptyAvailEnv avails
+    insert env avail = extendNameEnv_C plusAvail env (availName avail) avail
+       -- 'avails' may have several items with the same availName
+       -- E.g  import Ix( Ix(..), index )
+       -- will give Ix(Ix,index,range) and Ix(index)
+       -- We want to combine these
 \end{code}
 
 
@@ -413,25 +439,27 @@ type ExportOccMap = FiniteMap OccName (Name, RdrNameIE)
 
 
 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 (Just 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]
-                               -- export Main.main *only* unless otherwise specified,
-                          else [IEModuleContents this_mod]
-                               -- but for all other modules export everything.
+    true_exports 
+      | this_mod == mAIN_Name = []
+              -- Export nothing; Main.$main is automatically exported
+      | otherwise            = [IEModuleContents this_mod]
+              -- 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
@@ -464,7 +492,7 @@ exportsFromAvail this_mod (Just 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
@@ -565,4 +593,8 @@ dupModuleExport mod
   = 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}