[project @ 1997-12-22 13:56:55 by simonm]
[ghc-hetmet.git] / ghc / compiler / rename / Rename.lhs
index 81059c2..bd51090 100644 (file)
@@ -8,38 +8,56 @@
 
 module Rename ( renameModule ) where
 
+#if __GLASGOW_HASKELL__ <= 201
 import PreludeGlaST    ( thenPrimIO )
+#else
+import GlaExts
+import IO
+#endif
 
 IMP_Ubiq()
 IMPORT_1_3(List(partition))
 
 import HsSyn
-import RdrHsSyn                ( RdrName, SYN_IE(RdrNameHsModule), SYN_IE(RdrNameImportDecl) )
+import RdrHsSyn                ( RdrName(..), SYN_IE(RdrNameHsModule), SYN_IE(RdrNameImportDecl) )
 import RnHsSyn         ( SYN_IE(RenamedHsModule), SYN_IE(RenamedHsDecl), extractHsTyNames )
 
-import CmdLineOpts     ( opt_HiMap )
+import CmdLineOpts     ( opt_HiMap, opt_WarnNameShadowing, opt_D_show_rn_trace,
+                         opt_D_dump_rn, opt_D_show_rn_stats,
+                         opt_D_show_unused_imports, opt_PprUserLength
+                       )
 import RnMonad
 import RnNames         ( getGlobalNames )
 import RnSource                ( rnDecl )
 import RnIfaces                ( getImportedInstDecls, importDecl, getImportVersions, getSpecialInstModules,
-                         mkSearchPath
+                         getDeferredDataDecls,
+                         mkSearchPath, getSlurpedNames, getRnStats
                        )
 import RnEnv           ( availsToNameSet, addAvailToNameSet, 
                          addImplicitOccsRn, lookupImplicitOccRn )
 import Id              ( GenId {- instance NamedThing -} )
 import Name            ( Name, Provenance, ExportFlag(..), isLocallyDefined,
-                         NameSet(..), elemNameSet, mkNameSet, unionNameSets, nameSetToList,
-                         isWiredInName, modAndOcc
+                         NameSet(..), elemNameSet, mkNameSet, unionNameSets, 
+                         nameSetToList, minusNameSet, NamedThing(..),
+                         nameModule, pprModule, pprOccName, nameOccName
                        )
 import TysWiredIn      ( unitTyCon, intTyCon, doubleTyCon )
-import PrelInfo                ( ioTyCon_NAME, primIoTyCon_NAME )
 import TyCon           ( TyCon )
 import PrelMods                ( mAIN, gHC_MAIN )
-import ErrUtils                ( SYN_IE(Error), SYN_IE(Warning) )
+import PrelInfo                ( ioTyCon_NAME )
+import ErrUtils                ( SYN_IE(Error), SYN_IE(Warning), pprBagOfErrors, 
+                         doIfSet, dumpIfSet, ghcExit
+                       )
 import FiniteMap       ( emptyFM, eltsFM, fmToList, addToFM, FiniteMap )
 import Pretty
-import PprStyle                ( PprStyle(..) )
-import Util            ( panic, assertPanic, pprTrace )
+import Outputable      ( Outputable(..), PprStyle(..), 
+                         pprErrorsStyle, pprDumpStyle, printErrs
+                       )
+import Bag             ( isEmptyBag )
+import Util            ( cmpPString, equivClasses, panic, assertPanic, pprTrace )
+#if __GLASGOW_HASKELL__ >= 202
+import UniqSupply
+#endif
 \end{code}
 
 
@@ -47,32 +65,55 @@ import Util         ( panic, assertPanic, pprTrace )
 \begin{code}
 renameModule :: UniqSupply
             -> RdrNameHsModule
-            -> IO (Maybe                       -- Nothing <=> everything up to date;
-                                               -- no ned to recompile any further
-                         (RenamedHsModule,     -- Output, after renaming
+            -> IO (Maybe (RenamedHsModule,     -- Output, after renaming
                           InterfaceDetails,    -- Interface; for interface file generatino
                           RnNameSupply,        -- Final env; for renaming derivings
-                          [Module]),           -- Imported modules; for profiling
-                   Bag Error, 
-                   Bag Warning
-                  )
-\end{code} 
+                          [Module]))           -- Imported modules; for profiling
 
-
-\begin{code}
 renameModule us this_mod@(HsModule mod_name vers exports imports fixities local_decls loc)
-  =    -- INITIALISE THE RENAMER MONAD
-    initRn mod_name us (mkSearchPath opt_HiMap) loc $
+  =    -- Initialise the renamer monad
+    initRn mod_name us (mkSearchPath opt_HiMap) loc
+          (rename this_mod)                            >>=
+       \ (maybe_rn_stuff, rn_errs_bag, rn_warns_bag) ->
+
+       -- Check for warnings
+    doIfSet (not (isEmptyBag rn_warns_bag))
+           (print_errs rn_warns_bag)                   >>
+
+       -- Check for errors; exit if so
+    doIfSet (not (isEmptyBag rn_errs_bag))
+           (print_errs rn_errs_bag      >>
+            ghcExit 1
+           )                                            >>
+
+       -- Dump output, if any
+    (case maybe_rn_stuff of
+       Nothing  -> return ()
+       Just results@(rn_mod, _, _, _)
+                -> dumpIfSet opt_D_dump_rn "Renamer:"
+                             (ppr pprDumpStyle rn_mod)
+    )                                                  >>
+
+       -- Return results
+    return maybe_rn_stuff
+
+
+print_errs errs = printErrs (pprBagOfErrors pprErrorsStyle errs)
+\end{code}
+
 
-       -- FIND THE GLOBAL NAME ENVIRONMENT
+\begin{code}
+rename this_mod@(HsModule mod_name vers exports imports fixities local_decls loc)
+  =    -- FIND THE GLOBAL NAME ENVIRONMENT
     getGlobalNames this_mod                    `thenRn` \ global_name_info ->
 
     case global_name_info of {
        Nothing ->      -- Everything is up to date; no need to recompile further
+                       rnStats []              `thenRn_`
                        returnRn Nothing ;
 
                        -- Otherwise, just carry on
-       Just (export_env, rn_env, local_avails) ->
+       Just (export_env, rn_env, explicit_names) ->
 
        -- RENAME THE SOURCE
     initRnMS rn_env mod_name SourceMode (
@@ -81,13 +122,15 @@ renameModule us this_mod@(HsModule mod_name vers exports imports fixities local_
     )                                                  `thenRn` \ rn_local_decls ->
 
        -- SLURP IN ALL THE NEEDED DECLARATIONS
-    closeDecls rn_local_decls                          `thenRn` \ rn_all_decls ->
+    slurpDecls rn_local_decls                          `thenRn` \ rn_all_decls ->
 
 
        -- GENERATE THE VERSION/USAGE INFO
     getImportVersions mod_name exports                 `thenRn` \ import_versions ->
     getNameSupplyRn                                    `thenRn` \ name_supply ->
 
+       -- REPORT UNUSED NAMES
+    reportUnusedNames explicit_names                   `thenRn_`
 
        -- GENERATE THE SPECIAL-INSTANCE MODULE LIST
        -- The "special instance" modules are those modules that contain instance
@@ -103,16 +146,16 @@ renameModule us this_mod@(HsModule mod_name vers exports imports fixities local_
     in
                  
     
-
        -- RETURN THE RENAMED MODULE
     let
-       import_mods = [mod | ImportDecl mod _ _ _ _ <- imports]
+       import_mods = [mod | ImportDecl mod _ _ _ _ _ <- imports]
 
        renamed_module = HsModule mod_name vers 
                                  trashed_exports trashed_imports trashed_fixities
                                  rn_all_decls
                                  loc
     in
+    rnStats rn_all_decls       `thenRn_`
     returnRn (Just (renamed_module, 
                    (import_versions, export_env, special_inst_mods),
                     name_supply,
@@ -135,67 +178,137 @@ addImplicits mod_name
        -- are the types to which ambigious type variables may be defaulted by
        -- the type checker; so they won't every appear explicitly.
        -- [The () one is a GHC extension for defaulting CCall results.]
-    default_tys = [getName intTyCon, getName doubleTyCon, getName unitTyCon]
+    default_tys = [getName intTyCon, getName doubleTyCon, getName unitTyCon ]
 
        -- Add occurrences for IO or PrimIO
-    implicit_main | mod_name == mAIN     = [ioTyCon_NAME]
-                 | mod_name == gHC_MAIN = [primIoTyCon_NAME]
-                 | otherwise            = []
+    implicit_main |  mod_name == mAIN
+                 || mod_name == gHC_MAIN = [ioTyCon_NAME]
+                 |  otherwise            = []
 \end{code}
 
 
 \begin{code}
-closeDecls :: [RenamedHsDecl]                  -- Declarations got so far
+slurpDecls decls
+  =    -- First of all, get all the compulsory decls
+    slurp_compulsories decls   `thenRn` \ decls1 ->
+
+       -- Next get the optional ones
+    closeDecls Optional decls1 `thenRn` \ decls2 ->
+
+       -- Finally get those deferred data type declarations
+    getDeferredDataDecls                       `thenRn` \ data_decls ->
+    mapRn rn_data_decl data_decls              `thenRn` \ rn_data_decls ->
+
+       -- Done
+    returnRn (rn_data_decls ++ decls2)
+
+  where
+       -- The "slurp_compulsories" function is a loop that alternates
+       -- between slurping compulsory decls and slurping the instance
+       -- decls thus made relavant.
+        -- We *must* loop again here.  Why?  Two reasons:
+       -- (a) an instance decl will give rise to an unresolved dfun, whose
+       --      decl we must slurp to get its version number; that's the version
+       --      number for the whole instance decl.  (And its unfolding might mention new
+       --  unresolved names.)
+       -- (b) an instance decl might give rise to a new unresolved class,
+       --      whose decl we must slurp, which might let in some new instance decls,
+       --      and so on.  Example:  instance Foo a => Baz [a] where ...
+    slurp_compulsories decls
+      = closeDecls Compulsory decls    `thenRn` \ decls1 ->
+       
+               -- Instance decls still pending?
+        getImportedInstDecls                   `thenRn` \ inst_decls ->
+       if null inst_decls then 
+               -- No, none
+           returnRn decls1
+       else
+               -- Yes, there are some, so rename them and loop
+            traceRn (sep [ptext SLIT("Slurped"), int (length inst_decls), ptext SLIT("instance decls")])
+                                               `thenRn_`
+            mapRn rn_inst_decl inst_decls      `thenRn` \ new_inst_decls ->
+            slurp_compulsories (new_inst_decls ++ decls1)
+\end{code}
+
+\begin{code}
+closeDecls :: Necessity
+          -> [RenamedHsDecl]                   -- Declarations got so far
           -> RnMG [RenamedHsDecl]              -- input + extra decls slurped
        -- The monad includes a list of possibly-unresolved Names
        -- This list is empty when closeDecls returns
 
-closeDecls decls 
-  = popOccurrenceName          `thenRn` \ maybe_unresolved ->
+closeDecls necessity decls 
+  = popOccurrenceName necessity                `thenRn` \ maybe_unresolved ->
     case maybe_unresolved of
 
        -- No more unresolved names
-       Nothing ->      -- Slurp instance declarations
-                  getImportedInstDecls                 `thenRn` \ inst_decls ->
-                  traceRn (ppSep [ppPStr SLIT("Slurped"), ppInt (length inst_decls), ppPStr SLIT("instance decls")])
-                                                       `thenRn_`
-
-                       -- None?  then at last we are done
-                  if null inst_decls then
-                       returnRn decls
-                  else 
-                  mapRn rn_inst_decl inst_decls        `thenRn` \ new_inst_decls ->
-
-                       -- We *must* loop again here.  Why?  Two reasons:
-                       -- (a) an instance decl will give rise to an unresolved dfun, whose
-                       --      decl we must slurp to get its version number; that's the version
-                       --      number for the whole instance decl.
-                       -- (b) an instance decl might give rise to a new unresolved class,
-                       --      whose decl we must slurp, which might let in some new instance decls,
-                       --      and so on.  Example:  instance Foo a => Baz [a] where ...
-       
-                  closeDecls (new_inst_decls ++ decls)
+       Nothing -> returnRn decls
                        
        -- An unresolved name
-       Just (name,necessity)
+       Just name
          ->    -- Slurp its declaration, if any
---          traceRn (ppSep [ppPStr SLIT("Considering"), ppr PprDebug name])    `thenRn_`
+--          traceRn (sep [ptext SLIT("Considering"), ppr PprDebug name])       `thenRn_`
             importDecl name necessity          `thenRn` \ maybe_decl ->
             case maybe_decl of
 
                -- No declaration... (wired in thing or optional)
-               Nothing   -> closeDecls decls
+               Nothing   -> closeDecls necessity decls
 
                -- Found a declaration... rename it
-               Just decl -> rn_iface_decl mod_name decl        `thenRn` \ new_decl ->
-                            closeDecls (new_decl : decls)
-                    where
-                        (mod_name,_) = modAndOcc name
-  where
-                                       -- Notice that the rnEnv starts empty
-    rn_iface_decl mod_name decl  = initRnMS emptyRnEnv mod_name InterfaceMode (rnDecl decl)
-    rn_inst_decl (mod_name,decl) = rn_iface_decl mod_name (InstD decl)
+               Just decl -> rn_iface_decl mod_name necessity decl      `thenRn` \ new_decl ->
+                            closeDecls necessity (new_decl : decls)
+                        where
+                          mod_name = nameModule name
+
 
+rn_iface_decl mod_name necessity decl  -- Notice that the rnEnv starts empty
+  = initRnMS emptyRnEnv mod_name (InterfaceMode necessity) (rnDecl decl)
+                                       
+rn_inst_decl (mod_name,decl)      = rn_iface_decl mod_name Compulsory (InstD decl)
+
+rn_data_decl (tycon_name,ty_decl) = rn_iface_decl mod_name Compulsory (TyD ty_decl)
+                                 where
+                                   mod_name = nameModule tycon_name
 \end{code}
 
+\begin{code}
+reportUnusedNames explicit_avail_names
+  | not opt_D_show_unused_imports
+  = returnRn ()
+
+  | otherwise
+  = getSlurpedNames                    `thenRn` \ slurped_names ->
+    let
+       unused        = explicit_avail_names `minusNameSet` slurped_names
+       (local_unused, imported_unused) = partition isLocallyDefined (nameSetToList unused)
+       imports_by_module = equivClasses cmp imported_unused
+       name1 `cmp` name2 = nameModule name1 `_CMP_STRING_` nameModule name2 
+
+       pp_imp sty = sep [text "For information: the following unqualified imports are unused:",
+                         nest 4 (vcat (map (pp_group sty) imports_by_module))]
+       pp_group sty (n:ns) = sep [hcat [text "Module ", pprModule (PprForUser opt_PprUserLength) (nameModule n), char ':'],
+                                  nest 4 (sep (map (pprOccName sty . nameOccName) (n:ns)))]
+
+       pp_local sty = sep [text "For information: the following local top-level definitions are unused:",
+                           nest 4 (sep (map (pprOccName sty . nameOccName) local_unused))]
+    in
+    (if null imported_unused 
+     then returnRn ()
+     else addWarnRn pp_imp)    `thenRn_`
+
+    (if null local_unused
+     then returnRn ()
+     else addWarnRn pp_local)
+
+rnStats :: [RenamedHsDecl] -> RnMG ()
+rnStats all_decls
+        | opt_D_show_rn_trace || 
+         opt_D_show_rn_stats ||
+         opt_D_dump_rn 
+       = getRnStats all_decls          `thenRn` \ msg ->
+         ioToRnMG (printErrs msg)      `thenRn_`
+         returnRn ()
+
+       | otherwise = returnRn ()
+\end{code}