[project @ 1999-05-28 08:07:52 by simonpj]
[ghc-hetmet.git] / ghc / compiler / rename / Rename.lhs
index d1b2fbc..377e4ba 100644 (file)
-%
-% (c) The GRASP Project, Glasgow University, 1992-1996
-%
-\section[Rename]{Renaming and dependency analysis passes}
-
-\begin{code}
-#include "HsVersions.h"
-
-module Rename ( renameModule ) where
-
-import PreludeGlaST    ( thenPrimIO, newVar, MutableVar(..) )
-
-IMP_Ubiq()
-
-import HsSyn
-import RdrHsSyn                ( RdrNameHsModule(..), RdrNameImportDecl(..) )
-import RnHsSyn         ( RnName(..){-.. is for Ix hack only-}, RenamedHsModule(..), isRnTyConOrClass, isRnWired )
-
---ToDo:rm: all for debugging only
-import Maybes
-import Name
-import Outputable
-import RnIfaces
-import PprStyle
-import Pretty
-import FiniteMap
-import Util (pprPanic, pprTrace)
-
-import ParseUtils      ( ParsedIface(..), RdrIfaceDecl(..), RdrIfaceInst(..),
-                         UsagesMap(..), VersionsMap(..)
-                       )
-import RnMonad
-import RnNames         ( getGlobalNames, GlobalNameInfo(..) )
-import RnSource                ( rnSource )
-import RnIfaces                ( rnIfaces )
-import RnUtils         ( RnEnv(..), extendGlobalRnEnv, emptyRnEnv )
-
-import Bag             ( isEmptyBag, unionBags, unionManyBags, bagToList, listToBag )
-import CmdLineOpts     ( opt_HiMap, opt_NoImplicitPrelude )
-import ErrUtils                ( Error(..), Warning(..) )
-import FiniteMap       ( emptyFM, eltsFM, fmToList, lookupFM{-ToDo:rm-} )
-import Maybes          ( catMaybes )
-import Name            ( isLocallyDefined, mkWiredInName, Name, RdrName(..) )
-import PrelInfo                ( builtinNameInfo, BuiltinNames(..), BuiltinKeys(..) )
-import Unique          ( ixClassKey )
-import UniqFM          ( emptyUFM, lookupUFM, addListToUFM_C, eltsUFM )
-import UniqSupply      ( splitUniqSupply )
-import Util            ( panic, assertPanic )
-\end{code}
-
-\begin{code}
-renameModule :: UniqSupply
-            -> RdrNameHsModule
-
-            -> IO (RenamedHsModule,    -- output, after renaming
-                   RnEnv,              -- final env (for renaming derivings)
-                   [Module],           -- imported modules; for profiling
-
-                   (UsagesMap,
-                   VersionsMap,        -- version info; for usage
-                   [Module]),          -- instance modules; for iface
-
-                   Bag Error,
-                   Bag Warning)
-\end{code} 
-
-ToDo: May want to arrange to return old interface for this module!
-ToDo: Deal with instances (instance version, this module on instance list ???)
-
-\begin{code}
-renameModule us input@(HsModule modname _ _ imports _ _ _ _ _ _ _ _ _ _)
-
-  = let
-       (b_names, b_keys, _) = builtinNameInfo
-       pp_pair (n,m) = ppBesides [ppPStr m,ppChar '.',ppPStr n]
-    in
-    {-
-    pprTrace "builtins:\n" (case b_names of { (builtin_ids, builtin_tcs) ->
-                           ppAboves [ ppCat (map pp_pair (keysFM builtin_ids))
-                                    , ppCat (map pp_pair (keysFM builtin_tcs))
-                                    , ppCat (map pp_pair (keysFM b_keys))
-                                    ]}) $
-    -}
-    makeHiMap opt_HiMap            >>=          \ hi_files ->
---  pprTrace "HiMap:\n" (ppAboves [ ppCat [ppPStr m, ppStr p] | (m,p) <- fmToList hi_files])
-    newVar (emptyFM,emptyFM,hi_files){-init iface cache-}  `thenPrimIO` \ iface_cache ->
-
-    fixIO ( \ ~(_, _, _, _, rec_occ_fm, rec_export_fn) ->
-    let
-       rec_occ_fn :: Name -> [RdrName]
-       rec_occ_fn n = case lookupUFM rec_occ_fm n of
-                        Nothing        -> []
-                        Just (rn,occs) -> occs
-
-       global_name_info = (b_names, b_keys, rec_export_fn, rec_occ_fn)
-    in
-    getGlobalNames iface_cache global_name_info us1 input >>=
-       \ (occ_env, imp_mods, unqual_imps, imp_fixes, top_errs, top_warns) ->
-
-    if not (isEmptyBag top_errs) then
-       return (rn_panic, rn_panic, top_errs, top_warns, emptyUFM, rn_panic)
-    else
-
-    -- No top-level name errors so rename source ...
-    case initRn True modname occ_env us2
-               (rnSource imp_mods unqual_imps imp_fixes input) of {
-       ((rn_module, export_fn, src_occs), src_errs, src_warns) ->
-
-    --pprTrace "renameModule:" (ppCat (map (ppr PprDebug . fst) (bagToList src_occs))) $
-
-    let
-       occ_fm :: UniqFM (RnName, [RdrName])
-
-       occ_list = [ (rn,(rn,[occ])) | (rn,occ) <- bagToList src_occs]
-        occ_fm = addListToUFM_C insert_occ emptyUFM occ_list
-
-       insert_occ (rn,olds) (rn',[new]) = (rn, insert new olds)
-
-        insert new []         = [new]
-        insert new xxs@(x:xs) = case cmp new x of LT_  -> new : xxs
-                                                 EQ_  -> xxs
-                                                 GT__ -> x : insert new xs
-
-       occ_warns = map multipleOccWarn (filter multiple_occs (eltsUFM occ_fm))
-       multiple_occs (rn, (o1:o2:_)) = True
-       multiple_occs _               = False
-    in
-    return (rn_module, imp_mods, 
-           top_errs  `unionBags` src_errs,
-           top_warns `unionBags` src_warns `unionBags` listToBag occ_warns,
-           occ_fm, export_fn)
-
-    }) >>= \ (rn_module, imp_mods, errs_so_far, warns_so_far, occ_fm, _) ->
-
-    if not (isEmptyBag errs_so_far) then
-       return (rn_panic, rn_panic, rn_panic, rn_panic, errs_so_far, warns_so_far)
-    else
-
-    -- No errors renaming source so rename the interfaces ...
-    let
-       -- split up all names that occurred in the source; between
-       -- those that are defined therein and those merely mentioned.
-       -- We also divide by tycon/class and value names (as usual).
-
-       occ_rns = [ rn | (rn,_) <- eltsUFM occ_fm ]
-               -- all occurrence names, from this module and imported
-
-       (defined_here, defined_elsewhere)
-         = partition isLocallyDefined occ_rns
-
-       (_, imports_used)
-          = partition isRnWired defined_elsewhere
-
-       (def_tcs, def_vals) = partition isRnTyConOrClass defined_here
-       (occ_tcs, occ_vals) = partition isRnTyConOrClass occ_rns
-               -- the occ stuff includes *all* occurrences,
-               -- including those for which we have definitions
-
-       (orig_def_env, orig_def_dups)
-         = extendGlobalRnEnv emptyRnEnv (map pairify_rn def_vals)
-                                        (map pairify_rn def_tcs)
-       (orig_occ_env, orig_occ_dups)
-         = extendGlobalRnEnv emptyRnEnv (map pairify_rn occ_vals)
-                                        (map pairify_rn occ_tcs)
-
-       -- This stuff is pretty dodgy right now: I think original
-       -- names and occurrence names may be getting entangled
-       -- when they shouldn't be... WDP 96/06
-
-        pairify_rn rn -- ToDo: move to Name?
-         = let
-               name = getName rn
-           in
-           (if isLocalName name
-            then Unqual (getLocalName name)
-            else case (origName "pairify_rn" name) of { OrigName m n ->
-                 Qual m n }
-            , rn)
-
-       must_haves
-         | opt_NoImplicitPrelude
-         = [{-no Prelude.hi, no point looking-}]
-         | otherwise
-         = [ name_fn (mkWiredInName u orig)
-           | (orig@(OrigName mod str), (u, name_fn)) <- fmToList b_keys,
-             str `notElem` [ SLIT("main"), SLIT("mainPrimIO")] ]
-    in
---  ASSERT (isEmptyBag orig_occ_dups)
-    (if (isEmptyBag orig_occ_dups) then \x->x
-     else pprTrace "orig_occ_dups:" (ppAboves [ ppCat [ppr PprDebug m, ppr PprDebug n, ppr PprDebug o] | (m,n,o) <- bagToList orig_occ_dups])) $
-    ASSERT (isEmptyBag orig_def_dups)
-
-    rnIfaces iface_cache imp_mods us3 orig_def_env orig_occ_env
-            rn_module (must_haves ++ imports_used) >>=
-       \ (rn_module_with_imports, final_env,
-          (implicit_val_fm, implicit_tc_fm),
-          usage_stuff,
-          (iface_errs, iface_warns)) ->
-
-    return (rn_module_with_imports,
-           final_env,
-           imp_mods,
-           usage_stuff,
-           errs_so_far  `unionBags` iface_errs,
-           warns_so_far `unionBags` iface_warns)
-  where
-    rn_panic = panic "renameModule: aborted with errors"
-
-    (us1, us') = splitUniqSupply us
-    (us2, us3) = splitUniqSupply us'
-\end{code}
-
-\begin{code}
-makeHiMap :: Maybe String -> IO (FiniteMap Module FilePath)
-
-makeHiMap Nothing = error "Rename.makeHiMap:no .hi map given by the GHC driver (?)"
-makeHiMap (Just f)
-  = readFile f >>= \ cts ->
-    return (snag_mod emptyFM cts [])
-  where
-    -- we alternate between "snag"ging mod(ule names) and path(names),
-    -- accumulating names (reversed) and the final resulting map
-    -- as we move along.
-
-    snag_mod map  []       []   = map
-    snag_mod map  (' ':cs) rmod = snag_path map (_PK_ (reverse rmod)) cs []
-    snag_mod map  (c:cs)   rmod = snag_mod  map cs (c:rmod)
-
-    snag_path map mod []        rpath = addToFM map mod (reverse rpath)
-    snag_path map mod ('\n':cs) rpath = snag_mod (addToFM map mod (reverse rpath)) cs []
-    snag_path map mod (c:cs)    rpath = snag_path map mod cs (c:rpath)
-\end{code}
-
-Warning message used herein:
-\begin{code}
-multipleOccWarn (name, occs) sty
-  = ppBesides [ppStr "warning:multiple names used to refer to `", ppr sty name, ppStr "': ",
-              ppInterleave ppComma (map (ppr sty) occs)]
-\end{code}
+%\r
+% (c) The GRASP Project, Glasgow University, 1992-1998\r
+%\r
+\section[Rename]{Renaming and dependency analysis passes}\r
+\r
+\begin{code}\r
+module Rename ( renameModule ) where\r
+\r
+#include "HsVersions.h"\r
+\r
+import HsSyn\r
+import RdrHsSyn                ( RdrNameHsModule )\r
+import RnHsSyn         ( RenamedHsModule, RenamedHsDecl, \r
+                         extractHsTyNames, extractHsCtxtTyNames\r
+                       )\r
+\r
+import CmdLineOpts     ( opt_HiMap, opt_D_dump_rn_trace,\r
+                         opt_D_dump_rn, opt_D_dump_rn_stats,\r
+                         opt_WarnUnusedBinds, opt_WarnUnusedImports\r
+                       )\r
+import RnMonad\r
+import RnNames         ( getGlobalNames )\r
+import RnSource                ( rnSourceDecls, rnDecl )\r
+import RnIfaces                ( getImportedInstDecls, importDecl, getImportVersions,\r
+                         getImportedRules, loadHomeInterface, getSlurped\r
+                       )\r
+import RnEnv           ( availName, availNames, availsToNameSet, \r
+                         warnUnusedTopNames, mapFvRn,\r
+                         FreeVars, plusFVs, plusFV, unitFV, emptyFVs, isEmptyFVs\r
+                       )\r
+import Module           ( Module, ModuleName, pprModule, mkSearchPath, mkThisModule )\r
+import Name            ( Name, isLocallyDefined,\r
+                         NamedThing(..), ImportReason(..), Provenance(..),\r
+                         pprOccName, nameOccName,\r
+                         getNameProvenance, occNameUserString, \r
+                         maybeWiredInTyConName, maybeWiredInIdName, isWiredInName\r
+                       )\r
+import Id              ( idType )\r
+import DataCon         ( dataConTyCon, dataConType )\r
+import TyCon           ( TyCon, tyConDataCons, isSynTyCon, getSynTyConDefn )\r
+import RdrName         ( RdrName )\r
+import NameSet\r
+import PrelMods                ( mAIN_Name, pREL_MAIN_Name )\r
+import TysWiredIn      ( unitTyCon, intTyCon, doubleTyCon, boolTyCon )\r
+import PrelInfo                ( ioTyCon_NAME, thinAirIdNames )\r
+import Type            ( namesOfType, funTyCon )\r
+import ErrUtils                ( pprBagOfErrors, pprBagOfWarnings,\r
+                         doIfSet, dumpIfSet, ghcExit\r
+                       )\r
+import BasicTypes      ( NewOrData(..) )\r
+import Bag             ( isEmptyBag, bagToList )\r
+import FiniteMap       ( fmToList, delListFromFM, addToFM, sizeFM, eltsFM )\r
+import UniqSupply      ( UniqSupply )\r
+import Util            ( equivClasses )\r
+import Maybes          ( maybeToBool )\r
+import Outputable\r
+\end{code}\r
+\r
+\r
+\r
+\begin{code}\r
+renameModule :: UniqSupply\r
+            -> RdrNameHsModule\r
+            -> IO (Maybe \r
+                     ( Module\r
+                     , RenamedHsModule   -- Output, after renaming\r
+                     , InterfaceDetails  -- Interface; for interface file generation\r
+                     , RnNameSupply      -- Final env; for renaming derivings\r
+                     , [ModuleName]      -- Imported modules; for profiling\r
+                     ))\r
+\r
+renameModule us this_mod@(HsModule mod_name vers exports imports local_decls loc)\r
+  =    -- Initialise the renamer monad\r
+    initRn mod_name us (mkSearchPath opt_HiMap) loc\r
+          (rename this_mod)                            >>=\r
+       \ (maybe_rn_stuff, rn_errs_bag, rn_warns_bag) ->\r
+\r
+       -- Check for warnings\r
+    doIfSet (not (isEmptyBag rn_warns_bag))\r
+           (printErrs (pprBagOfWarnings rn_warns_bag)) >>\r
+\r
+       -- Check for errors; exit if so\r
+    doIfSet (not (isEmptyBag rn_errs_bag))\r
+           (printErrs (pprBagOfErrors rn_errs_bag)      >>\r
+            ghcExit 1\r
+           )                                            >>\r
+\r
+       -- Dump output, if any\r
+    (case maybe_rn_stuff of\r
+       Nothing  -> return ()\r
+       Just results@(_, rn_mod, _, _, _)\r
+                -> dumpIfSet opt_D_dump_rn "Renamer:"\r
+                             (ppr rn_mod)\r
+    )                                                  >>\r
+\r
+       -- Return results\r
+    return maybe_rn_stuff\r
+\end{code}\r
+\r
+\r
+\begin{code}\r
+rename this_mod@(HsModule mod_name vers exports imports local_decls loc)\r
+  =    -- FIND THE GLOBAL NAME ENVIRONMENT\r
+    getGlobalNames this_mod                    `thenRn` \ maybe_stuff ->\r
+\r
+       -- CHECK FOR EARLY EXIT\r
+    if not (maybeToBool maybe_stuff) then\r
+       -- Everything is up to date; no need to recompile further\r
+       rnStats []              `thenRn_`\r
+       returnRn Nothing\r
+    else\r
+    let\r
+       Just (export_env, gbl_env, fixity_env, global_avail_env) = maybe_stuff\r
+    in\r
+\r
+       -- RENAME THE SOURCE\r
+    initRnMS gbl_env fixity_env SourceMode (\r
+       rnSourceDecls local_decls\r
+    )                                  `thenRn` \ (rn_local_decls, source_fvs) ->\r
+\r
+       -- SLURP IN ALL THE NEEDED DECLARATIONS\r
+    let\r
+       real_source_fvs = implicitFVs mod_name `plusFV` source_fvs\r
+               -- It's important to do the "plus" this way round, so that\r
+               -- when compiling the prelude, locally-defined (), Bool, etc\r
+               -- override the implicit ones. \r
+    in\r
+    slurpImpDecls real_source_fvs      `thenRn` \ rn_imp_decls ->\r
+\r
+       -- EXIT IF ERRORS FOUND\r
+    checkErrsRn                                `thenRn` \ no_errs_so_far ->\r
+    if not no_errs_so_far then\r
+       -- Found errors already, so exit now\r
+       rnStats []              `thenRn_`\r
+       returnRn Nothing\r
+    else\r
+\r
+       -- GENERATE THE VERSION/USAGE INFO\r
+    getImportVersions mod_name exports                 `thenRn` \ my_usages ->\r
+    getNameSupplyRn                                    `thenRn` \ name_supply ->\r
+\r
+       -- REPORT UNUSED NAMES\r
+    reportUnusedNames gbl_env global_avail_env\r
+                     export_env\r
+                     source_fvs                        `thenRn_`\r
+\r
+       -- RETURN THE RENAMED MODULE\r
+    let\r
+       has_orphans        = any isOrphanDecl rn_local_decls\r
+       direct_import_mods = [mod | ImportDecl mod _ _ _ _ _ <- imports]\r
+       rn_all_decls       = rn_imp_decls ++ rn_local_decls \r
+       renamed_module = HsModule mod_name vers \r
+                                 trashed_exports trashed_imports\r
+                                 rn_all_decls\r
+                                 loc\r
+    in\r
+    rnStats rn_imp_decls       `thenRn_`\r
+    returnRn (Just (mkThisModule mod_name,\r
+                   renamed_module, \r
+                   (has_orphans, my_usages, export_env),\r
+                   name_supply,\r
+                   direct_import_mods))\r
+  where\r
+    trashed_exports  = {-trace "rnSource:trashed_exports"-} Nothing\r
+    trashed_imports  = {-trace "rnSource:trashed_imports"-} []\r
+\end{code}\r
+\r
+@implicitFVs@ forces the renamer to slurp in some things which aren't\r
+mentioned explicitly, but which might be needed by the type checker.\r
+\r
+\begin{code}\r
+implicitFVs mod_name\r
+  = implicit_main              `plusFV` \r
+    mkNameSet default_tys      `plusFV`\r
+    mkNameSet thinAirIdNames\r
+  where\r
+       -- Add occurrences for Int, Double, and (), because they\r
+       -- are the types to which ambigious type variables may be defaulted by\r
+       -- the type checker; so they won't always appear explicitly.\r
+       -- [The () one is a GHC extension for defaulting CCall results.]\r
+       -- ALSO: funTyCon, since it occurs implicitly everywhere!\r
+       --       (we don't want to be bothered with making funTyCon a\r
+       --        free var at every function application!)\r
+    default_tys = [getName intTyCon, getName doubleTyCon,\r
+                  getName unitTyCon, getName funTyCon, getName boolTyCon]\r
+\r
+       -- Add occurrences for IO or PrimIO\r
+    implicit_main |  mod_name == mAIN_Name\r
+                 || mod_name == pREL_MAIN_Name = unitFV ioTyCon_NAME\r
+                 |  otherwise                  = emptyFVs\r
+\end{code}\r
+\r
+\begin{code}\r
+isOrphanDecl (InstD (InstDecl inst_ty _ _ _ _))\r
+  = not (foldNameSet ((||) . isLocallyDefined) False (extractHsTyNames inst_ty))\r
+isOrphanDecl (RuleD (RuleDecl _ _ _ lhs _ _))\r
+  = check lhs\r
+  where\r
+    check (HsVar v)   = not (isLocallyDefined v)\r
+    check (HsApp f a) = check f && check a\r
+    check other              = True\r
+isOrphanDecl other = False\r
+\end{code}\r
+\r
+\r
+%*********************************************************\r
+%*                                                      *\r
+\subsection{Slurping declarations}\r
+%*                                                      *\r
+%*********************************************************\r
+\r
+\begin{code}\r
+-------------------------------------------------------\r
+slurpImpDecls source_fvs\r
+  = traceRn (text "slurpImp" <+> fsep (map ppr (nameSetToList source_fvs))) `thenRn_`\r
+\r
+       -- The current slurped-set records all local things\r
+    getSlurped                                 `thenRn` \ source_binders ->\r
+    slurpSourceRefs source_binders source_fvs  `thenRn` \ (decls1, needed1, inst_gates) ->\r
+\r
+       -- Now we can get the instance decls\r
+    slurpInstDecls decls1 needed1 inst_gates   `thenRn` \ (decls2, needed2) ->\r
+\r
+       -- And finally get everything else\r
+    closeDecls  decls2 needed2\r
+\r
+-------------------------------------------------------\r
+slurpSourceRefs :: NameSet                     -- Variables defined in source\r
+               -> FreeVars                     -- Variables referenced in source\r
+               -> RnMG ([RenamedHsDecl],\r
+                        FreeVars,              -- Un-satisfied needs\r
+                        FreeVars)              -- "Gates"\r
+-- The declaration (and hence home module) of each gate has\r
+-- already been loaded\r
+\r
+slurpSourceRefs source_binders source_fvs\r
+  = go []                              -- Accumulating decls\r
+       emptyFVs                        -- Unsatisfied needs\r
+       source_fvs                      -- Accumulating gates\r
+       (nameSetToList source_fvs)      -- Gates whose defn hasn't been loaded yet\r
+  where\r
+    go decls fvs gates []\r
+       = returnRn (decls, fvs, gates)\r
+\r
+    go decls fvs gates (wanted_name:refs) \r
+       | isWiredInName wanted_name\r
+       = load_home wanted_name         `thenRn_`\r
+         go decls fvs (gates `plusFV` getWiredInGates wanted_name) refs\r
+\r
+       | otherwise\r
+       = importDecl wanted_name                `thenRn` \ maybe_decl ->\r
+         case maybe_decl of\r
+               -- No declaration... (already slurped, or local)\r
+           Nothing   -> go decls fvs gates refs\r
+           Just decl -> rnIfaceDecl decl               `thenRn` \ (new_decl, fvs1) ->\r
+                        let\r
+                           new_gates = getGates source_fvs new_decl\r
+                        in\r
+                        go (new_decl : decls)\r
+                           (fvs1 `plusFV` fvs)\r
+                           (gates `plusFV` new_gates)\r
+                           (nameSetToList new_gates ++ refs)\r
+\r
+       -- When we find a wired-in name we must load its\r
+       -- home module so that we find any instance decls therein\r
+    load_home name \r
+       | name `elemNameSet` source_binders = returnRn ()\r
+               -- When compiling the prelude, a wired-in thing may\r
+               -- be defined in this module, in which case we don't\r
+               -- want to load its home module!\r
+               -- Using 'isLocallyDefined' doesn't work because some of\r
+               -- the free variables returned are simply 'listTyCon_Name',\r
+               -- with a system provenance.  We could look them up every time\r
+               -- but that seems a waste.\r
+       | otherwise                           = loadHomeInterface doc name      `thenRn_`\r
+                                               returnRn ()\r
+        where\r
+         doc = ptext SLIT("need home module for wired in thing") <+> ppr name\r
+\r
+-------------------------------------------------------\r
+-- slurpInstDecls imports appropriate instance decls.\r
+-- It has to incorporate a loop, because consider\r
+--     instance Foo a => Baz (Maybe a) where ...\r
+-- It may be that Baz and Maybe are used in the source module,\r
+-- but not Foo; so we need to chase Foo too.\r
+\r
+slurpInstDecls decls needed gates\r
+  | isEmptyFVs gates\r
+  = returnRn (decls, needed)\r
+\r
+  | otherwise\r
+  = getImportedInstDecls gates                         `thenRn` \ inst_decls ->\r
+    rnInstDecls decls needed emptyFVs inst_decls       `thenRn` \ (decls1, needed1, gates1) ->\r
+    slurpInstDecls decls1 needed1 gates1\r
+  where\r
+    rnInstDecls decls fvs gates []\r
+       = returnRn (decls, fvs, gates)\r
+    rnInstDecls decls fvs gates (d:ds) \r
+       = rnIfaceDecl d         `thenRn` \ (new_decl, fvs1) ->\r
+         rnInstDecls (new_decl:decls) \r
+                     (fvs1 `plusFV` fvs)\r
+                     (gates `plusFV` getInstDeclGates new_decl)\r
+                     ds\r
+    \r
+\r
+-------------------------------------------------------\r
+-- closeDecls keeps going until the free-var set is empty\r
+closeDecls decls needed\r
+  | not (isEmptyFVs needed)\r
+  = slurpDecls decls needed    `thenRn` \ (decls1, needed1) ->\r
+    closeDecls decls1 needed1\r
+\r
+  | otherwise\r
+  = getImportedRules                   `thenRn` \ rule_decls ->\r
+    case rule_decls of\r
+       []    -> returnRn decls -- No new rules, so we are done\r
+       other -> rnIfaceDecls decls emptyFVs rule_decls         `thenRn` \ (decls1, needed1) ->\r
+                closeDecls decls1 needed1\r
+                \r
+\r
+-------------------------------------------------------\r
+rnIfaceDecls :: [RenamedHsDecl] -> FreeVars\r
+            -> [(Module, RdrNameHsDecl)]\r
+            -> RnM d ([RenamedHsDecl], FreeVars)\r
+rnIfaceDecls decls fvs []     = returnRn (decls, fvs)\r
+rnIfaceDecls decls fvs (d:ds) = rnIfaceDecl d          `thenRn` \ (new_decl, fvs1) ->\r
+                               rnIfaceDecls (new_decl:decls) (fvs1 `plusFV` fvs) ds\r
+\r
+rnIfaceDecl (mod, decl) = initIfaceRnMS mod (rnDecl decl)      \r
+                       \r
+\r
+-------------------------------------------------------\r
+-- Augment decls with any decls needed by needed.\r
+-- Return also free vars of the new decls (only)\r
+slurpDecls decls needed\r
+  = go decls emptyFVs (nameSetToList needed) \r
+  where\r
+    go decls fvs []         = returnRn (decls, fvs)\r
+    go decls fvs (ref:refs) = slurpDecl decls fvs ref  `thenRn` \ (decls1, fvs1) ->\r
+                             go decls1 fvs1 refs\r
+\r
+-------------------------------------------------------\r
+slurpDecl decls fvs wanted_name\r
+  = importDecl wanted_name             `thenRn` \ maybe_decl ->\r
+    case maybe_decl of\r
+       -- No declaration... (wired in thing)\r
+       Nothing -> returnRn (decls, fvs)\r
+\r
+       -- Found a declaration... rename it\r
+       Just decl -> rnIfaceDecl decl           `thenRn` \ (new_decl, fvs1) ->\r
+                    returnRn (new_decl:decls, fvs1 `plusFV` fvs)\r
+\end{code}\r
+\r
+\r
+%*********************************************************\r
+%*                                                      *\r
+\subsection{Extracting the 'gates'}\r
+%*                                                      *\r
+%*********************************************************\r
+\r
+When we import a declaration like\r
+\r
+       data T = T1 Wibble | T2 Wobble\r
+\r
+we don't want to treat Wibble and Wobble as gates *unless* T1, T2\r
+respectively are mentioned by the user program.  If only T is mentioned\r
+we want only T to be a gate; that way we don't suck in useless instance\r
+decls for (say) Eq Wibble, when they can't possibly be useful.\r
+\r
+@getGates@ takes a newly imported (and renamed) decl, and the free\r
+vars of the source program, and extracts from the decl the gate names.\r
+\r
+\begin{code}\r
+getGates source_fvs (SigD (IfaceSig _ ty _ _))\r
+  = extractHsTyNames ty\r
+\r
+getGates source_fvs (TyClD (ClassDecl ctxt cls tvs sigs _ _ _ _ _ _))\r
+  = delListFromNameSet (foldr (plusFV . get) (extractHsCtxtTyNames ctxt) sigs)\r
+                      (map getTyVarName tvs)\r
+    `addOneToNameSet` cls\r
+  where\r
+    get (ClassOpSig n _ ty _) \r
+       | n `elemNameSet` source_fvs = extractHsTyNames ty\r
+       | otherwise                  = emptyFVs\r
+\r
+getGates source_fvs (TyClD (TySynonym tycon tvs ty _))\r
+  = delListFromNameSet (extractHsTyNames ty)\r
+                      (map getTyVarName tvs)\r
+       -- A type synonym type constructor isn't a "gate" for instance decls\r
+\r
+getGates source_fvs (TyClD (TyData _ ctxt tycon tvs cons _ _ _))\r
+  = delListFromNameSet (foldr (plusFV . get) (extractHsCtxtTyNames ctxt) cons)\r
+                      (map getTyVarName tvs)\r
+    `addOneToNameSet` tycon\r
+  where\r
+    get (ConDecl n tvs ctxt details _)\r
+       | n `elemNameSet` source_fvs\r
+               -- If the constructor is method, get fvs from all its fields\r
+       = delListFromNameSet (get_details details `plusFV` \r
+                             extractHsCtxtTyNames ctxt)\r
+                            (map getTyVarName tvs)\r
+    get (ConDecl n tvs ctxt (RecCon fields) _)\r
+               -- Even if the constructor isn't mentioned, the fields\r
+               -- might be, as selectors.  They can't mention existentially\r
+               -- bound tyvars (typechecker checks for that) so no need for \r
+               -- the deleteListFromNameSet part\r
+       = foldr (plusFV . get_field) emptyFVs fields\r
+       \r
+    get other_con = emptyFVs\r
+\r
+    get_details (VanillaCon tys) = plusFVs (map get_bang tys)\r
+    get_details (InfixCon t1 t2) = get_bang t1 `plusFV` get_bang t2\r
+    get_details (RecCon fields)  = plusFVs [get_bang t | (_, t) <- fields]\r
+    get_details (NewCon t _)    = extractHsTyNames t\r
+\r
+    get_field (fs,t) | any (`elemNameSet` source_fvs) fs = get_bang t\r
+                    | otherwise                         = emptyFVs\r
+\r
+    get_bang (Banged   t) = extractHsTyNames t\r
+    get_bang (Unbanged t) = extractHsTyNames t\r
+    get_bang (Unpacked t) = extractHsTyNames t\r
+\r
+getGates source_fvs other_decl = emptyFVs\r
+\end{code}\r
+\r
+getWiredInGates is just like getGates, but it sees a wired-in Name\r
+rather than a declaration.\r
+\r
+\begin{code}\r
+getWiredInGates :: Name -> FreeVars\r
+getWiredInGates name   -- No classes are wired in\r
+  | is_id               = getWiredInGates_s (namesOfType (idType the_id))\r
+  | isSynTyCon the_tycon = getWiredInGates_s (delListFromNameSet (namesOfType ty) (map getName tyvars))\r
+  | otherwise           = unitFV name\r
+  where\r
+    maybe_wired_in_id    = maybeWiredInIdName name\r
+    is_id               = maybeToBool maybe_wired_in_id\r
+    maybe_wired_in_tycon = maybeWiredInTyConName name\r
+    Just the_id         = maybe_wired_in_id\r
+    Just the_tycon      = maybe_wired_in_tycon\r
+    (tyvars,ty)         = getSynTyConDefn the_tycon\r
+\r
+getWiredInGates_s names = foldr (plusFV . getWiredInGates) emptyFVs (nameSetToList names)\r
+\end{code}\r
+\r
+\begin{code}\r
+getInstDeclGates (InstD (InstDecl inst_ty _ _ _ _)) = extractHsTyNames inst_ty\r
+getInstDeclGates other                             = emptyFVs\r
+\end{code}\r
+\r
+\r
+%*********************************************************\r
+%*                                                      *\r
+\subsection{Unused names}\r
+%*                                                      *\r
+%*********************************************************\r
+\r
+\begin{code}\r
+reportUnusedNames gbl_env avail_env (ExportEnv export_avails _) mentioned_names\r
+  | not (opt_WarnUnusedBinds || opt_WarnUnusedImports)\r
+  = returnRn ()\r
+\r
+  | otherwise\r
+  = let\r
+       used_names = mentioned_names `unionNameSets` availsToNameSet export_avails\r
+\r
+       -- Now, a use of C implies a use of T,\r
+       -- if C was brought into scope by T(..) or T(C)\r
+       really_used_names = used_names `unionNameSets`\r
+                           mkNameSet [ availName avail \r
+                                     | sub_name <- nameSetToList used_names,\r
+                                       let avail = case lookupNameEnv avail_env sub_name of\r
+                                                       Just avail -> avail\r
+                                                       Nothing -> pprTrace "r.u.n" (ppr sub_name) $\r
+                                                                  Avail sub_name\r
+                                     ]\r
+\r
+       defined_names = mkNameSet (concat (rdrEnvElts gbl_env))\r
+       defined_but_not_used = nameSetToList (defined_names `minusNameSet` really_used_names)\r
+\r
+       -- Filter out the ones only defined implicitly\r
+       bad_guys = filter reportableUnusedName defined_but_not_used\r
+    in\r
+    warnUnusedTopNames bad_guys        `thenRn_`\r
+    returnRn ()\r
+\r
+reportableUnusedName :: Name -> Bool\r
+reportableUnusedName name\r
+  = explicitlyImported (getNameProvenance name) &&\r
+    not (startsWithUnderscore (occNameUserString (nameOccName name)))\r
+  where\r
+    explicitlyImported (LocalDef _ _)                       = True     -- Report unused defns of local vars\r
+    explicitlyImported (NonLocalDef (UserImport _ _ expl) _) = expl    -- Report unused explicit imports\r
+    explicitlyImported other                                = False    -- Don't report others\r
+   \r
+       -- Haskell 98 encourages compilers to suppress warnings about\r
+       -- unused names in a pattern if they start with "_".\r
+    startsWithUnderscore ('_' : _) = True      -- Suppress warnings for names starting\r
+    startsWithUnderscore other     = False     -- with an underscore\r
+\r
+rnStats :: [RenamedHsDecl] -> RnMG ()\r
+rnStats imp_decls\r
+        | opt_D_dump_rn_trace || \r
+         opt_D_dump_rn_stats ||\r
+         opt_D_dump_rn \r
+       = getRnStats imp_decls          `thenRn` \ msg ->\r
+         ioToRnM (printErrs msg)       `thenRn_`\r
+         returnRn ()\r
+\r
+       | otherwise = returnRn ()\r
+\end{code}\r
+\r
+\r
+\r
+%*********************************************************\r
+%*                                                     *\r
+\subsection{Statistics}\r
+%*                                                     *\r
+%*********************************************************\r
+\r
+\begin{code}\r
+getRnStats :: [RenamedHsDecl] -> RnMG SDoc\r
+getRnStats imported_decls\r
+  = getIfacesRn                `thenRn` \ ifaces ->\r
+    let\r
+       n_mods = length [() | (_, _, Just _) <- eltsFM (iImpModInfo ifaces)]\r
+\r
+       decls_read     = [decl | (_, avail, True, (_,decl)) <- nameEnvElts (iDecls ifaces),\r
+                                       -- Data, newtype, and class decls are in the decls_fm\r
+                                       -- under multiple names; the tycon/class, and each\r
+                                       -- constructor/class op too.\r
+                                       -- The 'True' selects just the 'main' decl\r
+                                not (isLocallyDefined (availName avail))\r
+                            ]\r
+\r
+       (cd_rd, dd_rd, nd_rd, sd_rd, vd_rd,     _) = count_decls decls_read\r
+       (cd_sp, dd_sp, nd_sp, sd_sp, vd_sp, id_sp) = count_decls imported_decls\r
+\r
+       unslurped_insts       = iInsts ifaces\r
+       inst_decls_unslurped  = length (bagToList unslurped_insts)\r
+       inst_decls_read       = id_sp + inst_decls_unslurped\r
+\r
+       stats = vcat \r
+               [int n_mods <+> text "interfaces read",\r
+                hsep [ int cd_sp, text "class decls imported, out of", \r
+                       int cd_rd, text "read"],\r
+                hsep [ int dd_sp, text "data decls imported, out of",  \r
+                       int dd_rd, text "read"],\r
+                hsep [ int nd_sp, text "newtype decls imported, out of",  \r
+                       int nd_rd, text "read"],\r
+                hsep [int sd_sp, text "type synonym decls imported, out of",  \r
+                       int sd_rd, text "read"],\r
+                hsep [int vd_sp, text "value signatures imported, out of",  \r
+                       int vd_rd, text "read"],\r
+                hsep [int id_sp, text "instance decls imported, out of",  \r
+                       int inst_decls_read, text "read"],\r
+                text "cls dcls slurp" <+> fsep (map (ppr . tyClDeclName) \r
+                                          [d | TyClD d <- imported_decls, isClassDecl d]),\r
+                text "cls dcls read"  <+> fsep (map (ppr . tyClDeclName) \r
+                                          [d | TyClD d <- decls_read, isClassDecl d])]\r
+    in\r
+    returnRn (hcat [text "Renamer stats: ", stats])\r
+\r
+count_decls decls\r
+  = (class_decls, \r
+     data_decls, \r
+     newtype_decls,\r
+     syn_decls, \r
+     val_decls, \r
+     inst_decls)\r
+  where\r
+    tycl_decls = [d | TyClD d <- decls]\r
+    (class_decls, data_decls, newtype_decls, syn_decls) = countTyClDecls tycl_decls\r
+\r
+    val_decls     = length [() | SigD _          <- decls]\r
+    inst_decls    = length [() | InstD _  <- decls]\r
+\end{code}    \r
+\r