[project @ 2001-08-14 06:35:56 by simonpj]
[ghc-hetmet.git] / ghc / compiler / rename / RnNames.lhs
index cccffc3..a0613ab 100644 (file)
@@ -5,7 +5,7 @@
 
 \begin{code}
 module RnNames (
-       getGlobalNames
+       getGlobalNames, exportsFromAvail
     ) where
 
 #include "HsVersions.h"
@@ -13,33 +13,32 @@ 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 Module          ( ModuleName, moduleName, WhereFrom(..) )
+import Name            ( Name, nameSrcLoc, nameOccName )
 import NameSet
-import Name            ( Name, nameSrcLoc,
-                         setLocalNameSort, 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(..)
+                       )
+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 )
@@ -57,24 +56,13 @@ import List         ( partition )
 getGlobalNames :: Module -> RdrNameHsModule
               -> RnMG (GlobalRdrEnv,   -- Maps all in-scope things
                        GlobalRdrEnv,   -- Maps just *local* things
-                       Avails,         -- The exported stuff
-                       AvailEnv)       -- Maps a name to its parent AvailInfo
-                                       -- Just for in-scope things only
-
-getGlobalNames this_mod (HsModule _ _ exports imports decls _ mod_loc)
-  =    -- These two fix-loops are to get the right
-       -- provenance information into a Name
-    fixRn ( \ ~(rec_gbl_env, _, rec_export_avails, _) ->
-
-       let
-          rec_exp_fn :: Name -> Bool
-          rec_exp_fn = mk_export_fn (availsToNameSet rec_export_avails)
-       in
+                       ExportAvails)   -- The exported stuff
 
-               -- PROCESS LOCAL DECLS
+getGlobalNames this_mod (HsModule _ _ _ imports decls _ mod_loc)
+  =            -- PROCESS LOCAL DECLS
                -- Do these *first* so that the correct provenance gets
                -- into the global name cache.
-       importsFromLocalDecls this_mod rec_exp_fn decls         `thenRn` \ (local_gbl_env, local_mod_avails) ->
+       importsFromLocalDecls this_mod decls            `thenRn` \ (local_gbl_env, local_mod_avails) ->
 
                -- PROCESS IMPORT DECLS
                -- Do the non {- SOURCE -} ones first, so that we get a helpful
@@ -101,21 +89,10 @@ getGlobalNames this_mod (HsModule _ _ exports imports decls _ mod_loc)
 
            all_avails :: ExportAvails
            all_avails = foldr plusExportAvails local_mod_avails (imp_avails_s2 ++ imp_avails_s1)
-
-           (_, global_avail_env) = all_avails
        in
 
-               -- PROCESS EXPORT LIST (but not if we've had errors already)
-       checkErrsRn             `thenRn` \ no_errs_so_far ->
-       (if no_errs_so_far then
-           exportsFromAvail this_mod_name exports all_avails gbl_env
-        else
-           returnRn []
-       )                                               `thenRn` \ export_avails ->
-       
                -- ALL DONE
-       returnRn (gbl_env, local_gbl_env, export_avails, global_avail_env)
-   )
+       returnRn (gbl_env, local_gbl_env, all_avails)
   where
     this_mod_name = moduleName this_mod
 
@@ -147,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,
@@ -178,24 +154,40 @@ 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
+    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, hides, 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 hides 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 rec_exp_fn decls
-  = mapRn (getLocalDeclBinders this_mod rec_exp_fn) decls      `thenRn` \ avails_s ->
-
+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
 
@@ -206,58 +198,63 @@ importsFromLocalDecls this_mod rec_exp_fn decls
        (_, 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
+       hides      = []         -- Hide nothing
+
+       gbl_env    = mkGlobalRdrEnv mod_name unqual_imp mk_prov avails hides 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 
-                   -> (Name -> Bool)   -- Whether exported
-                   -> RdrNameHsDecl -> RnMG Avails
-getLocalDeclBinders mod rec_exp_fn (TyClD tycl_decl)
+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 ->
-    returnRn [avail]
-
-getLocalDeclBinders mod rec_exp_fn (ValD binds)
-  = mapRn (newLocalBinder mod rec_exp_fn) 
-         (bagToList (collectTopBinders binds))
+    getTyClDeclBinders mod tycl_decl   `thenRn` \ (avail, sys_names) ->
 
-getLocalDeclBinders mod rec_exp_fn (ForD (ForeignDecl nm kind _ ext_nm _ loc))
-  | binds_haskell_name kind
-  = newLocalBinder mod rec_exp_fn (nm, loc)        `thenRn` \ avail ->
+       -- Record that the system names are available
+    recordLocalSlurps (mkNameSet sys_names)    `thenRn_`
     returnRn [avail]
 
-  | otherwise          -- a foreign export
-  = returnRn []
+getLocalDeclBinders mod (ValD binds)
+  = mapRn new (collectLocatedHsBinders binds)          `thenRn` \ avails ->
+    returnRn avails
   where
-    binds_haskell_name (FoImport _) = True
-    binds_haskell_name FoLabel      = True
-    binds_haskell_name FoExport     = isDynamicExtName ext_nm
+    new (rdr_name, loc) = newTopBinder mod rdr_name loc        `thenRn` \ name ->
+                         returnRn (Avail name)
 
-getLocalDeclBinders mod rec_exp_fn (FixD _)    = returnRn []
-getLocalDeclBinders mod rec_exp_fn (DeprecD _) = returnRn []
-getLocalDeclBinders mod rec_exp_fn (DefD _)    = returnRn []
-getLocalDeclBinders mod rec_exp_fn (InstD _)   = returnRn []
-getLocalDeclBinders mod rec_exp_fn (RuleD _)   = returnRn []
+getLocalDeclBinders mod (ForD (ForeignImport nm _ _ loc))
+  = newTopBinder mod nm loc        `thenRn` \ name ->
+    returnRn [Avail name]
+getLocalDeclBinders mod (ForD _)
+  = returnRn []
 
----------------------------
-newLocalBinder mod rec_exp_fn (rdr_name, loc)
-  =    -- Generate a local name, and with a suitable export indicator
-    newTopBinder mod rdr_name loc      `thenRn` \ name ->
-    returnRn (Avail (setLocalNameSort name (rec_exp_fn name)))
+getLocalDeclBinders mod (FixD _)    = returnRn []
+getLocalDeclBinders mod (DeprecD _) = returnRn []
+getLocalDeclBinders mod (DefD _)    = returnRn []
+getLocalDeclBinders mod (InstD _)   = returnRn []
+getLocalDeclBinders mod (RuleD _)   = returnRn []
 \end{code}
 
 
@@ -275,12 +272,12 @@ 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],             -- "chosens"
+                      [AvailInfo],             -- "hides"
+                       -- The true imports are "chosens" - "hides"
+                       -- (It's convenient to return both the above sets, because
+                       --  the substraction can be done more efficiently when
+                       --  building the environment.)
                       NameSet)                 -- What was imported explicitly
 
        -- Complains if import spec mentions things that the module doesn't export
@@ -313,6 +310,7 @@ 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])]
     get_item item@(IEModuleContents _) = bale_out item
 
     get_item item@(IEThingAll _)
@@ -321,14 +319,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
@@ -365,65 +363,12 @@ filterImports mod from (Just (want_hiding, import_items)) total_avails
 %*                                                                     *
 %************************************************************************
 
-@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)
-
-
 mkEmptyExportAvails :: ModuleName -> ExportAvails
-mkEmptyExportAvails mod_name = (unitFM mod_name [], emptyUFM)
+mkEmptyExportAvails mod_name = (unitFM mod_name [], emptyNameEnv)
 
 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 
@@ -444,9 +389,9 @@ mkExportAvails mod_name unqual_imp name_env avails
                         where
                           uqs = filter unqual_in_scope ns
 
-    unqual_in_scope n = unQualInScope name_env n
+    unqual_in_scope n = unQualInScope gbl_env n
 
-    entity_avail_env = listToUFM [ (name,avail) | avail <- avails, 
+    entity_avail_env = mkNameEnv [ (name,avail) | avail <- avails, 
                                                  name  <- availNames avail]
 
 plusExportAvails ::  ExportAvails ->  ExportAvails ->  ExportAvails
@@ -541,7 +486,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
@@ -589,9 +534,6 @@ check_occs ie occs avail
                                failWithRn occs (exportClashErr name_occ ie ie')
       where
        name_occ = nameOccName name
-       
-mk_export_fn :: NameSet -> (Name -> Bool)      -- True => exported
-mk_export_fn exported_names = \name ->  name `elemNameSet` exported_names
 \end{code}
 
 %************************************************************************
@@ -645,4 +587,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}