[project @ 2002-03-29 21:39:36 by sof]
[ghc-hetmet.git] / ghc / compiler / rename / RnIfaces.lhs
index c8691df..9a07a2f 100644 (file)
@@ -6,7 +6,6 @@
 \begin{code}
 module RnIfaces
      (
-       getInterfaceExports,
        recordLocalSlurps, 
        mkImportInfo, 
 
@@ -24,34 +23,39 @@ import HsSyn                ( HsDecl(..), Sig(..), TyClDecl(..), ConDecl(..), ConDetails(..),
                          InstDecl(..), HsType(..), hsTyVarNames, getBangType
                        )
 import HsImpExp                ( ImportDecl(..) )
-import RdrHsSyn                ( RdrNameHsDecl, RdrNameTyClDecl, RdrNameInstDecl )
-import RnHsSyn         ( RenamedHsDecl, extractHsTyNames, extractHsCtxtTyNames, tyClDeclFVs )
-import RnHiFiles       ( tryLoadInterface, loadHomeInterface, loadInterface, 
+import RdrHsSyn                ( RdrNameTyClDecl, RdrNameInstDecl, RdrNameRuleDecl )
+import RnHsSyn         ( RenamedHsDecl, RenamedTyClDecl,
+                         extractHsTyNames, extractHsCtxtTyNames, 
+                         tyClDeclFVs, ruleDeclFVs, instDeclFVs
+                       )
+import RnHiFiles       ( tryLoadInterface, loadHomeInterface, 
                          loadOrphanModules
                        )
-import RnSource                ( rnTyClDecl, rnDecl )
+import RnSource                ( rnTyClDecl, rnInstDecl, rnIfaceRuleDecl )
 import RnEnv
 import RnMonad
-import Id              ( idType )
-import DataCon         ( classDataCon, dataConId )
-import Type            ( namesOfType )
-import TyCon           ( isSynTyCon, getSynTyConDefn )
+import Id              ( idType, idName, globalIdDetails )
+import IdInfo          ( GlobalIdDetails(..) )
+import TcType          ( namesOfType )
+import FieldLabel      ( fieldLabelTyCon )
+import DataCon         ( dataConTyCon )
+import TyCon           ( visibleDataCons, isSynTyCon, getSynTyConDefn, tyConClass_maybe, tyConName )
+import Class           ( className )
 import Name            ( Name {-instance NamedThing-}, nameOccName,
-                         nameModule, isLocalName, nameUnique,
-                         NamedThing(..),
+                         nameModule, isInternalName, NamedThing(..)
                         )
-import Name            ( elemNameEnv )
+import NameEnv                 ( elemNameEnv, delFromNameEnv, lookupNameEnv )
+import NameSet
 import Module          ( Module, ModuleEnv, 
-                         moduleName, isModuleInThisPackage,
+                         moduleName, isHomeModule,
                          ModuleName, WhereFrom(..),
                          emptyModuleEnv, 
                          extendModuleEnv_C, foldModuleEnv, lookupModuleEnv,
                          elemModuleSet, extendModuleSet
                        )
-import NameSet
-import PrelInfo                ( wiredInThingEnv, fractionalClassKeys )
-import TysWiredIn      ( doubleTyCon )
-import Maybes          ( orElse )
+import PrelInfo                ( wiredInThingEnv, hasKey, fractionalClassKey, numClassKey, 
+                         integerTyConName, doubleTyConName )
+import Maybe           ( isJust )
 import FiniteMap
 import Outputable
 import Bag
@@ -61,31 +65,23 @@ import Util         ( sortLt )
 
 %*********************************************************
 %*                                                     *
-\subsection{Getting what a module exports}
-%*                                                     *
-%*********************************************************
-
-@getInterfaceExports@ is called only for directly-imported modules.
-
-\begin{code}
-getInterfaceExports :: ModuleName -> WhereFrom -> RnMG (Module, [(ModuleName,Avails)])
-getInterfaceExports mod_name from
-  = loadInterface doc_str mod_name from        `thenRn` \ iface ->
-    returnRn (mi_module iface, mi_exports iface)
-  where
-      doc_str = sep [ppr mod_name, ptext SLIT("is directly imported")]
-\end{code}
-
-
-%*********************************************************
-%*                                                     *
 \subsection{Keeping track of what we've slurped, and version numbers}
 %*                                                     *
 %*********************************************************
 
-getImportVersions figures out what the ``usage information'' for this
+mkImportInfo figures out what the ``usage information'' for this
 moudule is; that is, what it must record in its interface file as the
-things it uses.  It records:
+things it uses.  
+
+We produce a line for every module B below the module, A, currently being
+compiled:
+       import B <n> ;
+to record the fact that A does import B indirectly.  This is used to decide
+to look to look for B.hi rather than B.hi-boot when compiling a module that
+imports A.  This line says that A imports B, but uses nothing in it.
+So we'll get an early bale-out when compiling A if B's version changes.
+
+The usage information records:
 
 \begin{itemize}
 \item  (a) anything reachable from its body code
@@ -123,17 +119,14 @@ number.  But with -O, a module that imports A must be recompiled if
 the occurrence of @B.f@ in the export list *just as if* it were in the
 code of A, and thereby haul in all the stuff reachable from it.
 
+       *** Conclusion: if A mentions B.f in its export list,
+           behave just as if A mentioned B.f in its source code,
+           and slurp in B.f and all its transitive closure ***
+
 [NB: If B was compiled with -O, but A isn't, we should really *still*
 haul in all the unfoldings for B, in case the module that imports A *is*
 compiled with -O.  I think this is the case.]
 
-Even if B is used at all we get a usage line for B
-       import B <n> :: ... ;
-in A.hi, to record the fact that A does import B.  This is used to decide
-to look to look for B.hi rather than B.hi-boot when compiling a module that
-imports A.  This line says that A imports B, but uses nothing in it.
-So we'll get an early bale-out when compiling A if B's version changes.
-
 \begin{code}
 mkImportInfo :: ModuleName                     -- Name of this module
             -> [ImportDecl n]                  -- The import decls
@@ -151,9 +144,9 @@ mkImportInfo this_mod imports
                -- (apart from hiding some, perhaps)
        import_all_mods = [ m | ImportDecl m _ _ _ imp_list _ <- imports,
                                import_all imp_list ]
-                       where
-                         import_all (Just (False, _)) = False  -- Imports are specified explicitly
-                         import_all other             = True   -- Everything is imported
+         where
+          import_all (Just (False, _)) = False -- Imports are spec'd explicitly
+          import_all other             = True  -- Everything is imported
 
        -- mv_map groups together all the things imported and used
        -- from a particular module in this package
@@ -166,29 +159,42 @@ mkImportInfo this_mod imports
                             add_item names _ = name:names
 
        -- In our usage list we record
-       --      a) Specifically: Detailed version info for imports from modules in this package
-       --                       Gotten from iVSlurp plus import_all_mods
        --
-       --      b) Everything:   Just the module version for imports from modules in other packages
-       --                       Gotten from iVSlurp plus import_all_mods
+       --      a) Specifically: Detailed version info for imports
+       --         from modules in this package Gotten from iVSlurp plus
+       --         import_all_mods
        --
-       --      c) NothingAtAll: The name only of modules, Baz, in this package that are 'below' us, 
-       --                       but which we didn't need at all (this is needed only to decide whether
-       --                       to open Baz.hi or Baz.hi-boot higher up the tree).
-       --                       This happens when a module, Foo, that we explicitly imported has 
-       --                       'import Baz' in its interface file, recording that Baz is below
-       --                       Foo in the module dependency hierarchy.  We want to propagate this info.
-       --                       These modules are in a combination of HIT/PIT and iImpModInfo
+       --      b) Everything: Just the module version for imports
+       --         from modules in other packages Gotten from iVSlurp plus
+       --         import_all_mods
        --
-       --      d) NothingAtAll: The name only of all orphan modules we know of (this is needed
-       --                       so that anyone who imports us can find the orphan modules)
-       --                       These modules are in a combination of HIT/PIT and iImpModInfo
+       --      c) NothingAtAll: The name only of modules, Baz, in
+       --         this package that are 'below' us, but which we didn't need
+       --         at all (this is needed only to decide whether to open Baz.hi
+       --         or Baz.hi-boot higher up the tree).  This happens when a
+       --         module, Foo, that we explicitly imported has 'import Baz' in
+       --         its interface file, recording that Baz is below Foo in the
+       --         module dependency hierarchy.  We want to propagate this
+       --         info.  These modules are in a combination of HIT/PIT and
+       --         iImpModInfo
+       --
+       --      d) NothingAtAll: The name only of all orphan modules
+       --         we know of (this is needed so that anyone who imports us can
+       --         find the orphan modules) These modules are in a combination
+       --         of HIT/PIT and iImpModInfo
 
        import_info0 = foldModuleEnv mk_imp_info  []           pit
        import_info1 = foldModuleEnv mk_imp_info  import_info0 hit
-       import_info  = [ (mod_name, orphans, is_boot, NothingAtAll) 
-                      | (mod_name, (orphans, is_boot)) <- fmToList (iImpModInfo ifaces) ] ++ 
-                      import_info1
+       import_info  = not_even_opened_imports ++ import_info1
+
+               -- Recall that iImpModInfo describes modules that have
+               -- been mentioned in the import lists of interfaces we
+               -- have opened, but which we have not even opened when
+               -- compiling this module
+       not_even_opened_imports =
+         [ (mod_name, orphans, is_boot, NothingAtAll) 
+         | (mod_name, (orphans, is_boot)) <- fmToList (iImpModInfo ifaces) ]
+
        
        mk_imp_info :: ModIface -> [ImportVersion Name] -> [ImportVersion Name]
        mk_imp_info iface so_far
@@ -203,6 +209,8 @@ mkImportInfo this_mod imports
          | import_all_mod                              -- Case (a) and (b); the import-all part
          = if is_home_pkg_mod then
                go_for_it (Specifically mod_vers (Just export_vers) [] rules_vers)
+               -- Since the module isn't in the mv_map, presumably we
+               -- didn't actually import anything at all from it
            else
                go_for_it (Everything mod_vers)
                
@@ -215,7 +223,7 @@ mkImportInfo this_mod imports
 
            mod             = mi_module iface
            mod_name        = moduleName mod
-           is_home_pkg_mod = isModuleInThisPackage mod
+           is_home_pkg_mod = isHomeModule mod
            version_info    = mi_version iface
            version_env     = vers_decls   version_info
            mod_vers        = vers_module  version_info
@@ -226,8 +234,7 @@ mkImportInfo this_mod imports
            
                -- The sort is to put them into canonical order
            mk_import_items ns = [(n,v) | n <- sortLt lt_occ ns, 
-                                         let v = lookupNameEnv version_env n `orElse` 
-                                                 pprPanic "mk_whats_imported" (ppr n)
+                                         let v = lookupVersion version_env n
                                 ]
                         where
                           lt_occ n1 n2 = nameOccName n1 < nameOccName n2
@@ -250,27 +257,20 @@ slurpImpDecls source_fvs
   = traceRn (text "slurpImp" <+> fsep (map ppr (nameSetToList source_fvs))) `thenRn_`
 
        -- The current slurped-set records all local things
-    getSlurped                                 `thenRn` \ source_binders ->
-    slurpSourceRefs source_binders source_fvs  `thenRn` \ (decls, needed) ->
+    slurpSourceRefs source_fvs `thenRn` \ (decls, needed) ->
 
        -- Then get everything else
-    closeDecls decls needed                    `thenRn` \ decls1 ->
-
-       -- Finally, get any deferred data type decls
-    slurpDeferredDecls decls1                  `thenRn` \ final_decls -> 
-
-    returnRn final_decls
+    closeDecls decls needed
 
 
 -------------------------------------------------------
-slurpSourceRefs :: NameSet                     -- Variables defined in source
-               -> FreeVars                     -- Variables referenced in source
+slurpSourceRefs :: FreeVars                    -- Variables referenced in source
                -> RnMG ([RenamedHsDecl],
                         FreeVars)              -- Un-satisfied needs
 -- The declaration (and hence home module) of each gate has
 -- already been loaded
 
-slurpSourceRefs source_binders source_fvs
+slurpSourceRefs source_fvs
   = go_outer []                        -- Accumulating decls
             emptyFVs                   -- Unsatisfied needs
             emptyFVs                   -- Accumulating gates
@@ -281,10 +281,10 @@ slurpSourceRefs source_binders source_fvs
 
        -- The outer loop is needed because consider
        --      instance Foo a => Baz (Maybe a) where ...
-       -- It may be that @Baz@ and @Maybe@ are used in the source module,
-       -- but not @Foo@; so we need to chase @Foo@ too.
+       -- It may be that Baz and Maybe are used in the source module,
+       -- but not Foo; so we need to chase Foo too.
        --
-       -- We also need to follow superclass refs.  In particular, 'chasing @Foo@' must
+       -- We also need to follow superclass refs.  In particular, 'chasing Foo' must
        -- include actually getting in Foo's class decl
        --      class Wib a => Foo a where ..
        -- so that its superclasses are discovered.  The point is that Wib is a gate too.
@@ -297,32 +297,23 @@ slurpSourceRefs source_binders source_fvs
        = traceRn (text "go_outer" <+> ppr refs)                `thenRn_`
          foldlRn go_inner (decls, fvs, emptyFVs) refs          `thenRn` \ (decls1, fvs1, gates1) ->
          getImportedInstDecls (all_gates `plusFV` gates1)      `thenRn` \ inst_decls ->
-         rnInstDecls decls1 fvs1 gates1 inst_decls             `thenRn` \ (decls2, fvs2, gates2) ->
+         rnIfaceInstDecls decls1 fvs1 gates1 inst_decls        `thenRn` \ (decls2, fvs2, gates2) ->
          go_outer decls2 fvs2 (all_gates `plusFV` gates2)
                               (nameSetToList (gates2 `minusNameSet` all_gates))
                -- Knock out the all_gates because even if we don't slurp any new
                -- decls we can get some apparently-new gates from wired-in names
+               -- and we get an infinite loop
 
     go_inner (decls, fvs, gates) wanted_name
        = importDecl wanted_name                `thenRn` \ import_result ->
          case import_result of
            AlreadySlurped     -> returnRn (decls, fvs, gates)
            InTypeEnv ty_thing -> returnRn (decls, fvs, gates `plusFV` getWiredInGates ty_thing)
-           Deferred           -> returnRn (decls, fvs, gates `addOneFV` wanted_name)   -- It's a type constructor
                        
            HereItIs decl -> rnIfaceTyClDecl decl               `thenRn` \ (new_decl, fvs1) ->
                             returnRn (TyClD new_decl : decls, 
                                       fvs1 `plusFV` fvs,
                                       gates `plusFV` getGates source_fvs new_decl)
-
-rnInstDecls decls fvs gates []
-  = returnRn (decls, fvs, gates)
-rnInstDecls decls fvs gates (d:ds) 
-  = rnIfaceDecl d              `thenRn` \ (new_decl, fvs1) ->
-    rnInstDecls (new_decl:decls) 
-               (fvs1 `plusFV` fvs)
-               (gates `plusFV` getInstDeclGates new_decl)
-               ds
 \end{code}
 
 
@@ -338,8 +329,13 @@ closeDecls decls needed
   = getImportedRules                   `thenRn` \ rule_decls ->
     case rule_decls of
        []    -> returnRn decls -- No new rules, so we are done
-       other -> rnIfaceDecls decls emptyFVs rule_decls         `thenRn` \ (decls1, needed1) ->
-                closeDecls decls1 needed1
+       other -> rnIfaceDecls rnIfaceRuleDecl rule_decls        `thenRn` \ rule_decls' ->
+                let
+                       rule_fvs = plusFVs (map ruleDeclFVs rule_decls')
+                in
+                traceRn (text "closeRules" <+> ppr rule_decls' $$ fsep (map ppr (nameSetToList rule_fvs)))     `thenRn_`
+                closeDecls (map RuleD rule_decls' ++ decls) rule_fvs
+
                 
 
 -------------------------------------------------------
@@ -365,92 +361,69 @@ slurpDecl decls fvs wanted_name
 
 
 -------------------------------------------------------
-rnIfaceDecls :: [RenamedHsDecl] -> FreeVars
-            -> [(Module, RdrNameHsDecl)]
-            -> RnM d ([RenamedHsDecl], FreeVars)
-rnIfaceDecls decls fvs []     = returnRn (decls, fvs)
-rnIfaceDecls decls fvs (d:ds) = rnIfaceDecl d          `thenRn` \ (new_decl, fvs1) ->
-                               rnIfaceDecls (new_decl:decls) (fvs1 `plusFV` fvs) ds
-
-rnIfaceDecl    (mod, decl) = initIfaceRnMS mod (rnDecl decl)   
+rnIfaceDecls rn decls     = mapRn (rnIfaceDecl rn) decls
+rnIfaceDecl rn (mod, decl) = initIfaceRnMS mod (rn decl)       
+
+rnIfaceInstDecls decls fvs gates inst_decls
+  = rnIfaceDecls rnInstDecl inst_decls `thenRn` \ inst_decls' ->
+    returnRn (map InstD inst_decls' ++ decls,
+             fvs `plusFV` plusFVs (map instDeclFVs inst_decls'),
+             gates `plusFV` plusFVs (map getInstDeclGates inst_decls'))
+
 rnIfaceTyClDecl (mod, decl) = initIfaceRnMS mod (rnTyClDecl decl)      `thenRn` \ decl' ->
                              returnRn (decl', tyClDeclFVs decl')
 \end{code}
 
 
 \begin{code}
-getSlurped
-  = getIfacesRn        `thenRn` \ ifaces ->
-    returnRn (iSlurp ifaces)
-
-recordSlurp ifaces@(Ifaces { iSlurp = slurped_names, iVSlurp = (imp_mods, imp_names) })
+recordDeclSlurp ifaces@(Ifaces { iDecls  = (decls_map, n_slurped),
+                                iSlurp  = slurped_names, 
+                                iVSlurp = vslurp })
            avail
-  = ASSERT2( not (isLocalName (availName avail)), ppr avail )
-    ifaces { iSlurp  = new_slurped_names, iVSlurp = new_vslurp }
+  = ASSERT2( not (isInternalName (availName avail)), ppr avail )
+    ifaces { iDecls = (new_decls_map, n_slurped+1),
+            iSlurp  = new_slurped_names, 
+            iVSlurp = updateVSlurp vslurp (availName avail) }
   where
-    main_name = availName avail
-    mod              = nameModule main_name
+    new_decls_map     = foldl delFromNameEnv decls_map (availNames avail)
     new_slurped_names = addAvailToNameSet slurped_names avail
-    new_vslurp | isModuleInThisPackage mod = (imp_mods, addOneToNameSet imp_names main_name)
-              | otherwise                 = (extendModuleSet imp_mods mod, imp_names)
-
-recordLocalSlurps local_avails
-  = getIfacesRn        `thenRn` \ ifaces ->
-    let
-       new_slurped_names = foldl addAvailToNameSet (iSlurp ifaces) local_avails
-    in
-    setIfacesRn (ifaces { iSlurp  = new_slurped_names })
-\end{code}
 
 
+-- recordTypeEnvSlurp is used when we slurp something that's
+-- already in the type environment, that was not slurped in an earlier compilation.
+-- We record it in the iVSlurp set, because that's used to
+-- generate usage information
 
-%*********************************************************
-%*                                                      *
-\subsection{Deferred declarations}
-%*                                                      *
-%*********************************************************
-
-The idea of deferred declarations is this.  Suppose we have a function
-       f :: T -> Int
-       data T = T1 A | T2 B
-       data A = A1 X | A2 Y
-       data B = B1 P | B2 Q
-Then we don't want to load T and all its constructors, and all
-the types those constructors refer to, and all the types *those*
-constructors refer to, and so on.  That might mean loading many more
-interface files than is really necessary.  So we 'defer' loading T.
-
-But f might be strict, and the calling convention for evaluating
-values of type T depends on how many constructors T has, so 
-we do need to load T, but not the full details of the type T.
-So we load the full decl for T, but only skeleton decls for A and B:
-       f :: T -> Int
-       data T = {- 2 constructors -}
-
-Whether all this is worth it is moot.
-
-\begin{code}
-slurpDeferredDecls :: [RenamedHsDecl] -> RnMG [RenamedHsDecl]
-slurpDeferredDecls decls = returnRn decls
-
-{-     OMIT FOR NOW
-slurpDeferredDecls :: [RenamedHsDecl] -> RnMG [RenamedHsDecl]
-slurpDeferredDecls decls
-  = getDeferredDecls                                           `thenRn` \ def_decls ->
-    rnIfaceDecls decls emptyFVs (map stripDecl def_decls)      `thenRn` \ (decls1, fvs) ->
-    ASSERT( isEmptyFVs fvs )
-    returnRn decls1
-
-stripDecl (mod, TyClD (TyData dt _ tc tvs _ nconstrs _ loc name1 name2))
-  = (mod, TyClD (TyData dt [] tc tvs [] nconstrs Nothing loc
-               name1 name2))
-       -- Nuke the context and constructors
-       -- But retain the *number* of constructors!
-       -- Also the tvs will have kinds on them.
--}
+recordTypeEnvSlurp ifaces ty_thing
+  = ifaces { iVSlurp = updateVSlurp (iVSlurp ifaces) (get_main_name ty_thing) }
+  where
+       -- Tiresomely, we must get the "main" name for the 
+       -- thing, because that's what VSlurp contains, and what
+       -- is recorded in the usage information
+    get_main_name (AClass cl) = className cl
+    get_main_name (ATyCon tc)
+       | Just clas <- tyConClass_maybe tc = get_main_name (AClass clas)
+        | otherwise                       = tyConName tc
+    get_main_name (AnId id)
+       = case globalIdDetails id of
+           DataConId     dc -> get_main_name (ATyCon (dataConTyCon dc))
+           DataConWrapId dc -> get_main_name (ATyCon (dataConTyCon dc))
+           RecordSelId lbl  -> get_main_name (ATyCon (fieldLabelTyCon lbl))
+           other            -> idName id
+
+updateVSlurp (imp_mods, imp_names) main_name
+  | isHomeModule mod = (imp_mods,                    addOneToNameSet imp_names main_name)
+  | otherwise        = (extendModuleSet imp_mods mod, imp_names)
+  where
+    mod = nameModule main_name
+  
+recordLocalSlurps new_names
+  = getIfacesRn        `thenRn` \ ifaces ->
+    setIfacesRn (ifaces { iSlurp  = iSlurp ifaces `unionNameSets` new_names })
 \end{code}
 
 
+
 %*********************************************************
 %*                                                      *
 \subsection{Extracting the `gates'}
@@ -465,82 +438,99 @@ its 'head' are all available in the program being compiled.  E.g.
 
        instance (..) => C (T1 a) (T2 b) where ...
 
-is only useful if C, T1 and T2 are all available.  So we keep
+is only useful if C, T1 and T2 are all "available".  So we keep
 instance decls that have been parsed from .hi files, but not yet
 slurped in, in a pool called the 'gated instance pool'.
 Each has its set of 'gates': {C, T1, T2} in the above example.
 
-THE GATING INVARIANT 
+More precisely, the gates of a module are the types and classes 
+that are mentioned in:
+
+       a) the source code
+       b) the type of an Id that's mentioned in the source code
+          [includes constructors and selectors]
+       c) the RHS of a type synonym that is a gate
+       d) the superclasses of a class that is a gate
+       e) the context of an instance decl that is slurped in
+
+We slurp in an instance decl from the gated instance pool iff
+       
+       all its gates are either in the gates of the module, 
+       or are a previously-loaded tycon or class.  
+
+The latter constraint is because there might have been an instance
+decl slurped in during an earlier compilation, like this:
+
+       instance Foo a => Baz (Maybe a) where ...
+
+In the module being compiled we might need (Baz (Maybe T)), where T
+is defined in this module, and hence we need (Foo T).  So @Foo@ becomes
+a gate.  But there's no way to 'see' that.  More generally, types
+might be involved as well:
+
+       instance Foo2 T a => Baz2 a where ...
 
-    *All* the instances whose gates are entirely in the stuff that's
-    already been through the type checker (i.e. are already in the
-    Persistent Type Environment or Home Symbol Table) have already been
-    slurped in, and are no longer in the gated instance pool.
+Now we must treat T as a gate too, as well as Foo.  So the solution
+we adopt is:
 
-Hence, when we read a new module, we see what new gates we have,
-and let in any instance decls whose gates are 
-       either  in the new gates, 
-       or      in the HST/PTE
+       we simply treat all previously-loaded 
+       tycons and classes as gates.
 
-An earlier optimisation: now infeasible
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+This gloss only affects ghc --make and ghc --interactive.
+
+
+Consructors and class operations
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 When we import a declaration like
-\begin{verbatim}
+
        data T = T1 Wibble | T2 Wobble
-\end{verbatim}
+
 we don't want to treat @Wibble@ and @Wobble@ as gates {\em unless}
-@T1@, @T2@ respectively are mentioned by the user program.  If only
+@T1@, @T2@ respectively are mentioned by the user program. If only
 @T@ is mentioned we want only @T@ to be a gate; that way we don't suck
 in useless instance decls for (say) @Eq Wibble@, when they can't
 possibly be useful.
 
-BUT, I can't see how to do this and still maintain the GATING INVARIANT.
-So I've simply ditched the optimisation to get things working.
-
-
-
+And that's just what (b) says: we only treat T1's type as a gate if
+T1 is mentioned.  getGates, which deals with decls we are slurping in,
+has to be a bit careful, because a mention of T1 will slurp in T's whole
+declaration.
 
+-----------------------------
 @getGates@ takes a newly imported (and renamed) decl, and the free
 vars of the source program, and extracts from the decl the gate names.
 
 \begin{code}
 getGates :: FreeVars           -- Things mentioned in the source program
-        -> RenamedHsDecl
+                               -- Used for the cunning "constructors and 
+                               -- class ops" story described 10 lines above.
+        -> RenamedTyClDecl
         -> FreeVars
 
-get_gates source_fvs decl = get_gates (\n -> True) decl
-       -- We'd use (\n -> n `elemNameSet` source_fvs)
-       -- if we were using the 'earlier optimisation above
+getGates source_fvs decl 
+  = get_gates (\n -> n `elemNameSet` source_fvs) decl
 
-get_gates is_used (IfaceSig _ ty _ _)
-  = extractHsTyNames ty
+get_gates is_used (ForeignType {tcdName = tycon}) = unitNameSet tycon
+get_gates is_used (IfaceSig    {tcdType = ty})    = extractHsTyNames ty
+get_gates is_used (CoreDecl    {tcdType = ty})    = extractHsTyNames ty
 
-get_gates is_used (ClassDecl ctxt cls tvs _ sigs _ _ _ )
-  = (delListFromNameSet (foldr (plusFV . get) (extractHsCtxtTyNames ctxt) sigs)
-                       (hsTyVarNames tvs)
-     `addOneToNameSet` cls)
-    `plusFV` maybe_double
+get_gates is_used (ClassDecl { tcdCtxt = ctxt, tcdName = cls, tcdTyVars = tvs, tcdSigs = sigs})
+  = (super_cls_and_sigs `addOneToNameSet` cls) `unionNameSets` 
+    implicitClassGates cls
   where
+    super_cls_and_sigs = delListFromNameSet (foldr (plusFV . get) (extractHsCtxtTyNames ctxt) sigs)
+                                           (hsTyVarNames tvs)
     get (ClassOpSig n _ ty _) 
        | is_used n = extractHsTyNames ty
        | otherwise = emptyFVs
 
-       -- If we load any numeric class that doesn't have
-       -- Int as an instance, add Double to the gates. 
-       -- This takes account of the fact that Double might be needed for
-       -- defaulting, but we don't want to load Double (and all its baggage)
-       -- if the more exotic classes aren't used at all.
-    maybe_double | nameUnique cls `elem` fractionalClassKeys 
-                = unitFV (getName doubleTyCon)
-                | otherwise
-                = emptyFVs
-
-get_gates is_used (TySynonym tycon tvs ty _)
+get_gates is_used (TySynonym {tcdTyVars = tvs, tcdSynRhs = ty})
   = delListFromNameSet (extractHsTyNames ty) (hsTyVarNames tvs)
        -- A type synonym type constructor isn't a "gate" for instance decls
 
-get_gates is_used (TyData _ ctxt tycon tvs cons _ _ _ _ _)
-  = delListFromNameSet (foldr (plusFV . get) (extractHsCtxtTyNames ctxt) cons)
+get_gates is_used (TyData {tcdCtxt = ctxt, tcdName = tycon, tcdTyVars = tvs, tcdCons = cons})
+  = delListFromNameSet (foldr (plusFV . get) (extractHsCtxtTyNames ctxt) 
+                                            (visibleDataCons cons))
                       (hsTyVarNames tvs)
     `addOneToNameSet` tycon
   where
@@ -567,40 +557,55 @@ get_gates is_used (TyData _ ctxt tycon tvs cons _ _ _ _ _)
                     | otherwise      = emptyFVs
 
     get_bang bty = extractHsTyNames (getBangType bty)
+
+implicitClassGates :: Name -> FreeVars
+implicitClassGates cls
+       -- If we load class Num, add Integer to the free gates
+       -- This takes account of the fact that Integer might be needed for
+       -- defaulting, but we don't want to load Integer (and all its baggage)
+       -- if there's no numeric stuff needed.
+       -- Similarly for class Fractional and Double
+       --
+       -- NB: adding T to the gates will force T to be loaded
+       --
+       -- NB: If we load (say) Floating, we'll end up loading Fractional too,
+       --     since Fractional is a superclass of Floating
+  | cls `hasKey` numClassKey       = unitFV integerTyConName
+  | cls `hasKey` fractionalClassKey = unitFV doubleTyConName
+  | otherwise                      = emptyFVs
 \end{code}
 
-@getWiredInGates@ is just like @getGates@, but it sees a wired-in @Name@
-rather than a declaration.
+@getWiredInGates@ is just like @getGates@, but it sees a previously-loaded
+thing rather than a declaration.
 
 \begin{code}
 getWiredInGates :: TyThing -> FreeVars
 -- The TyThing is one that we already have in our type environment, either
 --     a) because the TyCon or Id is wired in, or
 --     b) from a previous compile
--- Either way, we might have instance decls in the (persistend) collection
+-- Either way, we might have instance decls in the (persistent) collection
 -- of parsed-but-not-slurped instance decls that should be slurped in.
 -- This might be the first module that mentions both the type and the class
 -- for that instance decl, even though both the type and the class were
 -- mentioned in other modules, and hence are in the type environment
 
-getWiredInGates (AnId the_id) = getWiredInGates_s (namesOfType (idType the_id))
-getWiredInGates (AClass cl)   = namesOfType (idType (dataConId (classDataCon cl)))     -- Cunning
+getWiredInGates (AnId the_id) = namesOfType (idType the_id)
+getWiredInGates (AClass cl)   = implicitClassGates (getName cl)
+       -- The superclasses must also be previously
+       -- loaded, and hence are automatically gates
+       -- All previously-loaded classes are automatically gates
+       -- See "The gating story" above
 getWiredInGates (ATyCon tc)
-  | isSynTyCon tc = getWiredInGates_s (delListFromNameSet (namesOfType ty) (map getName tyvars))
+  | isSynTyCon tc = delListFromNameSet (namesOfType ty) (map getName tyvars)
   | otherwise    = unitFV (getName tc)
   where
     (tyvars,ty)  = getSynTyConDefn tc
 
-getWiredInGates_s names = foldr (plusFV . getWiredInGates) emptyFVs (nameSetToList names)
+getInstDeclGates (InstDecl inst_ty _ _ _ _) = extractHsTyNames inst_ty
 \end{code}
 
 \begin{code}
-getInstDeclGates (InstD (InstDecl inst_ty _ _ _ _)) = extractHsTyNames inst_ty
-getInstDeclGates other                             = emptyFVs
-\end{code}
-
-\begin{code}
-getImportedInstDecls :: NameSet -> RnMG [(Module,RdrNameHsDecl)]
+getImportedInstDecls :: NameSet -> RnMG [(Module,RdrNameInstDecl)]
 getImportedInstDecls gates
   =            -- First, load any orphan-instance modules that aren't aready loaded
        -- Orphan-instance modules are recorded in the module dependecnies
@@ -617,7 +622,10 @@ getImportedInstDecls gates
     getIfacesRn                                        `thenRn` \ ifaces ->
     getTypeEnvRn                                       `thenRn` \ lookup ->
     let
-       (decls, new_insts) = selectGated gates lookup (iInsts ifaces)
+       available n = n `elemNameSet` gates || isJust (lookup n)
+               -- See "The gating story" above for the isJust thing
+
+       (decls, new_insts) = selectGated available (iInsts ifaces)
     in
     setIfacesRn (ifaces { iInsts = new_insts })                `thenRn_`
 
@@ -629,21 +637,23 @@ getImportedInstDecls gates
   where
     gate_list      = nameSetToList gates
 
-ppr_brief_inst_decl (mod, InstD (InstDecl inst_ty _ _ _ _))
+ppr_brief_inst_decl (mod, InstDecl inst_ty _ _ _ _)
   = case inst_ty of
        HsForAllTy _ _ tau -> ppr tau
        other              -> ppr inst_ty
 
-getImportedRules :: RnMG [(Module,RdrNameHsDecl)]
+getImportedRules :: RnMG [(Module,RdrNameRuleDecl)]
 getImportedRules 
   | opt_IgnoreIfacePragmas = returnRn []
   | otherwise
   = getIfacesRn        `thenRn` \ ifaces ->
     getTypeEnvRn       `thenRn` \ lookup ->
     let
-       gates              = iSlurp ifaces      -- Anything at all that's been slurped
-       rules              = iRules ifaces
-       (decls, new_rules) = selectGated gates lookup rules
+               -- Slurp rules for anything that is slurped, 
+               -- either now or previously
+       gates              = iSlurp ifaces      
+       available n        = n `elemNameSet` gates || isJust (lookup n)
+       (decls, new_rules) = selectGated available (iRules ifaces)
     in
     if null decls then
        returnRn []
@@ -653,21 +663,25 @@ getImportedRules
                  text "Slurped" <+> int (length decls) <+> text "rules"])   `thenRn_`
     returnRn decls
 
-selectGated gates lookup decl_bag
-       -- Select only those decls whose gates are *all* in 'gates'
-       -- or are in the range of lookup
+selectGated :: (Name->Bool) -> GatedDecls d
+           -> ([(Module,d)], GatedDecls d)
+selectGated available (decl_bag, n_slurped)
+       -- Select only those decls whose gates are *all* available
 #ifdef DEBUG
   | opt_NoPruneDecls   -- Just to try the effect of not gating at all
-  = (foldrBag (\ (_,d) ds -> d:ds) [] decl_bag, emptyBag)      -- Grab them all
+  = let
+       decls = foldrBag (\ (_,d) ds -> d:ds) [] decl_bag       -- Grab them all
+    in
+    (decls, (emptyBag, n_slurped + length decls))
 
   | otherwise
 #endif
-  = foldrBag select ([], emptyBag) decl_bag
+  = case foldrBag select ([], emptyBag) decl_bag of
+       (decls, new_bag) -> (decls, (new_bag, n_slurped + length decls))
   where
-    available n = n `elemNameSet` gates || maybeToBool (lookup n)
-    select (reqd, decl) (yes, no)
-       | all available reqd = (decl:yes, no)
-       | otherwise          = (yes,      (reqd,decl) `consBag` no)
+    select (gate_fn, decl) (yes, no)
+       | gate_fn available  = (decl:yes, no)
+       | otherwise          = (yes,      (gate_fn,decl) `consBag` no)
 \end{code}
 
 
@@ -683,130 +697,57 @@ importDecl :: Name -> RnMG ImportDeclResult
 data ImportDeclResult
   = AlreadySlurped
   | InTypeEnv TyThing
-  | Deferred
   | HereItIs (Module, RdrNameTyClDecl)
 
 importDecl name
-  =    -- STEP 1: Check if it was loaded before beginning this module
-    if isLocalName name then
-       traceRn (text "Already (local)" <+> ppr name) `thenRn_`
-       returnRn AlreadySlurped
+  =    -- STEP 1: Check if we've slurped it in while compiling this module
+    getIfacesRn                                `thenRn` \ ifaces ->
+    if name `elemNameSet` iSlurp ifaces then   
+       returnRn AlreadySlurped 
     else
 
+
        -- STEP 2: Check if it's already in the type environment
     getTypeEnvRn                       `thenRn` \ lookup ->
     case lookup name of {
-       Just ty_thing | name `elemNameEnv` wiredInThingEnv
-                     ->        -- When we find a wired-in name we must load its home
-                               -- module so that we find any instance decls lurking therein
-                        loadHomeInterface wi_doc name  `thenRn_`
-                        returnRn (InTypeEnv (getWiredInGates ty_thing))
-
-                     | otherwise
-                     ->  returnRn (InTypeEnv ty_thing) ;
+       Just ty_thing 
+           |   name `elemNameEnv` wiredInThingEnv
+           ->  -- When we find a wired-in name we must load its home
+               -- module so that we find any instance decls lurking therein
+               loadHomeInterface wi_doc name   `thenRn_`
+               returnRn (InTypeEnv ty_thing)
+
+           |   otherwise
+           ->  -- Very important: record that we've seen it
+               -- See comments with recordTypeEnvSlurp
+               setIfacesRn (recordTypeEnvSlurp ifaces ty_thing)        `thenRn_`
+               returnRn (InTypeEnv ty_thing) ;
 
        Nothing -> 
 
-       -- STEP 3: Check if we've slurped it in while compiling this module
-    getIfacesRn                                `thenRn` \ ifaces ->
-    if name `elemNameSet` iSlurp ifaces then   
-       returnRn AlreadySlurped 
-    else
-
-       -- STEP 4: OK, we have to slurp it in from an interface file
+       -- STEP 3: OK, we have to slurp it in from an interface file
        --         First load the interface file
     traceRn nd_doc                     `thenRn_`
     loadHomeInterface nd_doc name      `thenRn_`
     getIfacesRn                                `thenRn` \ ifaces ->
 
-       -- STEP 5: Get the declaration out
-    case lookupNameEnv (iDecls ifaces) name of
-      Just (avail,_,decl)
-       -> setIfacesRn (recordSlurp ifaces avail)       `thenRn_`
-          returnRn (HereItIs decl)
+       -- STEP 4: Get the declaration out
+    let
+       (decls_map, _) = iDecls ifaces
+    in
+    case lookupNameEnv decls_map name of
+      Just (avail,_,decl) -> setIfacesRn (recordDeclSlurp ifaces avail)        `thenRn_`
+                            returnRn (HereItIs decl)
 
-      Nothing 
-       -> addErrRn (getDeclErr name)   `thenRn_` 
-          returnRn AlreadySlurped
+      Nothing -> addErrRn (getDeclErr name)    `thenRn_` 
+                returnRn AlreadySlurped
     }
   where
     wi_doc = ptext SLIT("need home module for wired in thing") <+> ppr name
     nd_doc = ptext SLIT("need decl for") <+> ppr name
 
-
-{-             OMIT DEFERRED STUFF FOR NOW, TILL GHCI WORKS
-      Just (version, avail, is_tycon_name, decl@(_, TyClD (TyData DataType _ _ _ _ ncons _ _ _ _)))
-       -- This case deals with deferred import of algebraic data types
-
-       |  not opt_NoPruneTyDecls
-
-       && (opt_IgnoreIfacePragmas || ncons > 1)
-               -- We only defer if imported interface pragmas are ingored
-               -- or if it's not a product type.
-               -- Sole reason: The wrapper for a strict function may need to look
-               -- inside its arg, and hence need to see its arg type's constructors.
-
-       && not (getUnique tycon_name `elem` cCallishTyKeys)
-               -- Never defer ccall types; we have to unbox them, 
-               -- and importing them does no harm
-
-
-       ->      -- OK, so we're importing a deferrable data type
-           if needed_name == tycon_name
-               -- The needed_name is the TyCon of a data type decl
-               -- Record that it's slurped, put it in the deferred set
-               -- and don't return a declaration at all
-               setIfacesRn (recordSlurp (ifaces {iDeferred = iDeferred ifaces 
-                                                             `addOneToNameSet` tycon_name})
-                                        version (AvailTC needed_name [needed_name]))   `thenRn_`
-               returnRn Deferred
-
-           else
-               -- The needed name is a constructor of a data type decl,
-               -- getting a constructor, so remove the TyCon from the deferred set
-               -- (if it's there) and return the full declaration
-               setIfacesRn (recordSlurp (ifaces {iDeferred = iDeferred ifaces 
-                                                              `delFromNameSet` tycon_name})
-                                   version avail)      `thenRn_`
-               returnRn (HereItIs decl)
-       where
-          tycon_name = availName avail
--}
-
-{-             OMIT FOR NOW
-getDeferredDecls :: RnMG [(Module, RdrNameHsDecl)]
-getDeferredDecls 
-  = getIfacesRn                `thenRn` \ ifaces ->
-    let
-       decls_map           = iDecls ifaces
-       deferred_names      = nameSetToList (iDeferred ifaces)
-        get_abstract_decl n = case lookupNameEnv decls_map n of
-                                Just (_, _, _, decl) -> decl
-    in
-    traceRn (sep [text "getDeferredDecls", nest 4 (fsep (map ppr deferred_names))])    `thenRn_`
-    returnRn (map get_abstract_decl deferred_names)
--}
 \end{code}
 
-@getWiredInDecl@ maps a wired-in @Name@ to what it makes available.
-It behaves exactly as if the wired in decl were actually in an interface file.
-Specifically,
-\begin{itemize}
-\item  if the wired-in name is a data type constructor or a data constructor, 
-       it brings in the type constructor and all the data constructors; and
-       marks as ``occurrences'' any free vars of the data con.
-
-\item  similarly for synonum type constructor
-
-\item  if the wired-in name is another wired-in Id, it marks as ``occurrences''
-       the free vars of the Id's type.
-
-\item  it loads the interface file for the wired-in thing for the
-       sole purpose of making sure that its instance declarations are available
-\end{itemize}
-All this is necessary so that we know all types that are ``in play'', so
-that we know just what instances to bring into scope.
-       
 
 %********************************************************
 %*                                                     *
@@ -825,17 +766,10 @@ upToDate  = False -- Recompile not required
 outOfDate = True       -- Recompile required
 
 recompileRequired :: FilePath          -- Only needed for debug msgs
-                 -> Bool               -- Source unchanged
                  -> ModIface           -- Old interface
                  -> RnMG RecompileRequired
-recompileRequired iface_path source_unchanged iface
-  = traceRn (text "Considering whether compilation is required for" <+> text iface_path <> colon)      `thenRn_`
-
-       -- CHECK WHETHER THE SOURCE HAS CHANGED
-    if not source_unchanged then
-       traceRn (nest 4 (text "Source file changed or recompilation check turned off")) `thenRn_` 
-       returnRn outOfDate
-    else
+recompileRequired iface_path iface
+  = traceHiDiffsRn (text "Considering whether compilation is required for" <+> text iface_path <> colon)       `thenRn_`
 
        -- Source code unchanged and no errors yet... carry on 
     checkList [checkModUsage u | u <- mi_usages iface]
@@ -863,8 +797,22 @@ checkModUsage (mod_name, _, _, NothingAtAll)
        -- In this case we don't even want to open Foo's interface.
   = up_to_date (ptext SLIT("Nothing used from:") <+> ppr mod_name)
 
-checkModUsage (mod_name, _, _, whats_imported)
-  = tryLoadInterface doc_str mod_name ImportBySystem   `thenRn` \ (iface, maybe_err) ->
+checkModUsage (mod_name, _, is_boot, whats_imported)
+  =    -- Load the imported interface is possible
+       -- We use tryLoadInterface, because failure is not an error
+       -- (might just be that the old .hi file for this module is out of date)
+       -- We use ImportByUser/ImportByUserSource as the 'from' flag, 
+       --      a) because we need to know whether to load the .hi-boot file
+       --      b) because loadInterface things matters are amiss if we 
+       --         ImportBySystem an interface it knows nothing about
+    let
+       doc_str = sep [ptext SLIT("need version info for"), ppr mod_name]
+       from    | is_boot   = ImportByUserSource
+               | otherwise = ImportByUser
+    in
+    traceHiDiffsRn (text "Checking usages for module" <+> ppr mod_name) `thenRn_`
+    tryLoadInterface doc_str mod_name from     `thenRn` \ (iface, maybe_err) ->
+
     case maybe_err of {
        Just err -> out_of_date (sep [ptext SLIT("Can't find version number for module"), 
                                      ppr mod_name]) ;
@@ -911,8 +859,6 @@ checkModUsage (mod_name, _, _, whats_imported)
        up_to_date (ptext SLIT("...but the bits I use haven't."))
 
     }}
-  where
-    doc_str = sep [ptext SLIT("need version info for"), ppr mod_name]
 
 ------------------------
 checkModuleVersion old_mod_vers new_vers
@@ -934,11 +880,13 @@ checkEntityUsage new_vers (name,old_vers)
                          out_of_date (sep [ptext SLIT("No longer exported:"), ppr name])
 
        Just new_vers   -- It's there, but is it up to date?
-         | new_vers == old_vers -> returnRn upToDate
-         | otherwise            -> out_of_date (sep [ptext SLIT("Out of date:"), ppr name])
+         | new_vers == old_vers -> traceHiDiffsRn (text "Up to date" <+> ppr name <+> parens (ppr new_vers)) `thenRn_`
+                                   returnRn upToDate
+         | otherwise            -> out_of_date (sep [ptext SLIT("Out of date:"), ppr name, ppr 
+                                                     old_vers, ptext SLIT("->"), ppr new_vers])
 
-up_to_date  msg = traceRn msg `thenRn_` returnRn upToDate
-out_of_date msg = traceRn msg `thenRn_` returnRn outOfDate
+up_to_date  msg = traceHiDiffsRn msg `thenRn_` returnRn upToDate
+out_of_date msg = traceHiDiffsRn msg `thenRn_` returnRn outOfDate
 \end{code}