[project @ 2002-01-09 12:41:45 by simonmar]
[ghc-hetmet.git] / ghc / compiler / main / HscTypes.lhs
index 762e315..9b8e819 100644 (file)
@@ -32,7 +32,8 @@ module HscTypes (
        PersistentRenamerState(..), IsBootInterface, DeclsMap,
        IfaceInsts, IfaceRules, GatedDecl, GatedDecls, GateFn, IsExported,
        NameSupply(..), OrigNameCache, OrigIParamCache,
-       Avails, AvailEnv, GenAvailInfo(..), AvailInfo, RdrAvailInfo, 
+       Avails, AvailEnv, emptyAvailEnv,
+       GenAvailInfo(..), AvailInfo, RdrAvailInfo, 
        PersistentCompilerState(..),
 
        Deprecations(..), lookupDeprec,
@@ -64,12 +65,11 @@ import InstEnv              ( InstEnv, ClsInstEnv, DFunId )
 import Rules           ( RuleBase )
 import CoreSyn         ( CoreBind )
 import Id              ( Id )
-import Type            ( IPName )
 import Class           ( Class, classSelIds )
 import TyCon           ( TyCon, isNewTyCon, tyConGenIds, tyConSelIds, tyConDataConsIfAvailable )
 import DataCon         ( dataConId, dataConWrapId )
 
-import BasicTypes      ( Version, initialVersion, Fixity )
+import BasicTypes      ( Version, initialVersion, Fixity, IPName )
 
 import HsSyn           ( DeprecTxt, tyClDeclName, ifaceRuleDeclName )
 import RdrHsSyn                ( RdrNameInstDecl, RdrNameRuleDecl, RdrNameTyClDecl )
@@ -135,15 +135,22 @@ where the object file will reside if/when it is created.
 
 A @ModIface@ plus a @ModDetails@ summarises everything we know 
 about a compiled module.  The @ModIface@ is the stuff *before* linking,
-and can be written out to an interface file.  The @ModDetails@ is after
-linking; it is the "linked" form of the mi_decls field.
+and can be written out to an interface file.  (The @ModDetails@ is after 
+linking; it is the "linked" form of the mi_decls field.)
+
+When we *read* an interface file, we also construct a @ModIface@ from it,
+except that the mi_decls part is empty; when reading we consolidate
+the declarations into a single indexed map in the @PersistentRenamerState@.
 
 \begin{code}
 data ModIface 
    = ModIface {
         mi_module   :: !Module,                    -- Complete with package info
         mi_version  :: !VersionInfo,       -- Module version number
+
         mi_orphan   :: WhetherHasOrphans,   -- Whether this module has orphans
+               -- NOT STRICT!  we fill this field with _|_ sometimes
+
        mi_boot     :: !IsBootInterface,    -- read from an hi-boot file?
 
         mi_usages   :: ![ImportVersion Name],  
@@ -155,12 +162,15 @@ data ModIface
                -- What it exports Kept sorted by (mod,occ), to make
                -- version comparisons easier
 
-        mi_globals  :: !GlobalRdrEnv,      -- Its top level environment
+        mi_globals  :: !(Maybe GlobalRdrEnv),
+               -- Its top level environment or Nothing if we read this
+               -- interface from a file.
 
         mi_fixities :: !(NameEnv Fixity),   -- Fixities
        mi_deprecs  :: !Deprecations,       -- Deprecations
 
        mi_decls    :: IfaceDecls           -- The RnDecls form of ModDetails
+               -- NOT STRICT!  we fill this field with _|_ sometimes
      }
 
 data IfaceDecls = IfaceDecls { dcl_tycl  :: [RenamedTyClDecl], -- Sorted
@@ -232,7 +242,7 @@ emptyModIface mod
               mi_boot     = False,
               mi_exports  = [],
               mi_fixities = emptyNameEnv,
-              mi_globals  = emptyRdrEnv,
+              mi_globals  = Nothing,
               mi_deprecs  = NoDeprecs,
               mi_decls    = panic "emptyModIface: decls"
     }          
@@ -282,10 +292,19 @@ lookupIfaceByModName hit pit mod
 \begin{code}
 data InteractiveContext 
   = InteractiveContext { 
-       ic_module :: Module,            -- The current module in which 
-                                       -- the  user is sitting
+       ic_toplev_scope :: [Module],    -- Include the "top-level" scope of
+                                       -- these modules
+
+       ic_exports :: [Module],         -- Include just the exports of these
+                                       -- modules
+
+       ic_rn_gbl_env :: GlobalRdrEnv,  -- The cached GlobalRdrEnv, built from
+                                       -- ic_toplev_scope and ic_exports
 
-       ic_rn_env :: LocalRdrEnv,       -- Lexical context for variables bound
+       ic_print_unqual :: PrintUnqualified,
+                                       -- cached PrintUnqualified, as above
+
+       ic_rn_local_env :: LocalRdrEnv, -- Lexical context for variables bound
                                        -- during interaction
 
        ic_type_env :: TypeEnv          -- Ditto for types
@@ -445,7 +464,10 @@ data GenAvailInfo name     = Avail name     -- An ordinary identifier
                        deriving( Eq )
                        -- Equality used when deciding if the interface has changed
 
-type AvailEnv    = NameEnv AvailInfo   -- Maps a Name to the AvailInfo that contains it
+type AvailEnv = NameEnv AvailInfo      -- Maps a Name to the AvailInfo that contains it
+
+emptyAvailEnv :: AvailEnv
+emptyAvailEnv = emptyNameEnv
                                
 instance Outputable n => Outputable (GenAvailInfo n) where
    ppr = pprAvail
@@ -511,6 +533,24 @@ type IsExported = Name -> Bool             -- True for names that are exported from this mo
 %*                                                                     *
 %************************************************************************
 
+The @PersistentCompilerState@ persists across successive calls to the
+compiler.
+
+  * A ModIface for each non-home-package module
+
+  * An accumulated TypeEnv from all the modules in imported packages
+
+  * An accumulated InstEnv from all the modules in imported packages
+    The point is that we don't want to keep recreating it whenever
+    we compile a new module.  The InstEnv component of pcPST is empty.
+    (This means we might "see" instances that we shouldn't "really" see;
+    but the Haskell Report is vague on what is meant to be visible, 
+    so we just take the easy road here.)
+
+  * Ditto for rules
+  * The persistent renamer state
+
 \begin{code}
 data PersistentCompilerState 
    = PCS {
@@ -529,24 +569,12 @@ data PersistentCompilerState
      }
 \end{code}
 
-The @PersistentRenamerState@ persists across successive calls to the
-compiler.
 
-It contains:
+The persistent renamer state contains:
+
   * A name supply, which deals with allocating unique names to
     (Module,OccName) original names, 
  
-  * An accumulated TypeEnv from all the modules in imported packages
-
-  * An accumulated InstEnv from all the modules in imported packages
-    The point is that we don't want to keep recreating it whenever
-    we compile a new module.  The InstEnv component of pcPST is empty.
-    (This means we might "see" instances that we shouldn't "really" see;
-    but the Haskell Report is vague on what is meant to be visible, 
-    so we just take the easy road here.)
-
-  * Ditto for rules
-
   * A "holding pen" for declarations that have been read out of
     interface files but not yet sucked in, renamed, and typechecked
 
@@ -558,6 +586,9 @@ type PackageInstEnv  = InstEnv
 data PersistentRenamerState
   = PRS { prsOrig    :: !NameSupply,
          prsImpMods :: !ImportedModuleInfo,
+
+               -- Holding pens for stuff that has been read in
+               -- but not yet slurped into the renamer
          prsDecls   :: !DeclsMap,
          prsInsts   :: !IfaceInsts,
          prsRules   :: !IfaceRules