[project @ 2000-11-14 10:46:39 by simonpj]
[ghc-hetmet.git] / ghc / compiler / rename / RnMonad.lhs
index 8f5270d..c1c7495 100644 (file)
@@ -35,39 +35,39 @@ import IOExts               ( IORef, newIORef, readIORef, writeIORef, unsafePerformIO )
 import HsSyn           
 import RdrHsSyn
 import RnHsSyn         ( RenamedFixitySig )
+import HscTypes                ( AvailEnv, lookupType,
+                         OrigNameEnv(..), OrigNameNameEnv, OrigNameIParamEnv,
+                         WhetherHasOrphans, ImportVersion, 
+                         PersistentRenamerState(..), IsBootInterface, Avails,
+                         DeclsMap, IfaceInsts, IfaceRules, 
+                         HomeSymbolTable, TyThing,
+                         PersistentCompilerState(..), GlobalRdrEnv,
+                         HomeIfaceTable, PackageIfaceTable,
+                         RdrAvailInfo )
 import BasicTypes      ( Version, defaultFixity )
 import ErrUtils                ( addShortErrLocLine, addShortWarnLocLine,
-                         pprBagOfErrors, ErrMsg, WarnMsg, Message
+                         pprBagOfErrors, Message, Messages, errorsFound,
+                         printErrorsAndWarnings
                        )
 import RdrName         ( RdrName, dummyRdrVarName, rdrNameModule, rdrNameOcc,
                          RdrNameEnv, emptyRdrEnv, extendRdrEnv, 
-                         lookupRdrEnv, addListToRdrEnv, rdrEnvToList, rdrEnvElts
+                         addListToRdrEnv, rdrEnvToList, rdrEnvElts
                        )
-import Name            ( Name, OccName, NamedThing(..), getSrcLoc,
-                         isLocallyDefinedName, nameModule, nameOccName,
-                         decode, mkLocalName, mkKnownKeyGlobal,
-                         NameEnv, lookupNameEnv, emptyNameEnv, unitNameEnv, 
-                         extendNameEnvList
+import Name            ( Name, OccName, NamedThing(..), 
+                         nameOccName,
+                         decode, mkLocalName, mkKnownKeyGlobal
                        )
-import Module          ( Module, ModuleName, WhereFrom, moduleName )
+import Name            ( NameEnv, lookupNameEnv, emptyNameEnv, unitNameEnv, extendNameEnvList )
+import Module          ( Module, ModuleName, ModuleSet, emptyModuleSet )
 import NameSet         
 import CmdLineOpts     ( DynFlags, DynFlag(..), dopt )
-import SrcLoc          ( SrcLoc, generatedSrcLoc )
+import SrcLoc          ( SrcLoc, generatedSrcLoc, noSrcLoc )
 import Unique          ( Unique )
-import FiniteMap       ( FiniteMap, emptyFM, listToFM, plusFM )
-import Bag             ( Bag, mapBag, emptyBag, isEmptyBag, snocBag )
+import FiniteMap       ( FiniteMap, emptyFM )
+import Bag             ( Bag, emptyBag, isEmptyBag, snocBag )
 import UniqSupply
 import Outputable
-import Finder          ( Finder )
 import PrelNames       ( mkUnboundName )
-import HscTypes                ( GlobalSymbolTable, AvailEnv, 
-                         OrigNameEnv(..), OrigNameNameEnv, OrigNameIParamEnv,
-                         WhetherHasOrphans, ImportVersion, ExportItem,
-                         PersistentRenamerState(..), IsBootInterface, Avails,
-                         DeclsMap, IfaceInsts, IfaceRules, DeprecationEnv,
-                         HomeSymbolTable, PackageSymbolTable,
-                         PersistentCompilerState(..), GlobalRdrEnv,
-                         HomeIfaceTable, PackageIfaceTable )
 
 infixr 9 `thenRn`, `thenRn_`
 \end{code}
@@ -84,14 +84,25 @@ ioToRnM :: IO r -> RnM d (Either IOError r)
 ioToRnM io rn_down g_down = (io >>= \ ok -> return (Right ok)) 
                            `catch` 
                            (\ err -> return (Left err))
+
+ioToRnM_no_fail :: IO r -> RnM d r
+ioToRnM_no_fail io rn_down g_down 
+   = (io >>= \ ok -> return ok) 
+     `catch` 
+     (\ err -> panic "ioToRnM_no_fail: the I/O operation failed!")
            
 traceRn :: SDoc -> RnM d ()
 traceRn msg
    = doptRn Opt_D_dump_rn_trace `thenRn` \b ->
      if b then putDocRn msg else returnRn ()
 
+traceHiDiffsRn :: SDoc -> RnM d ()
+traceHiDiffsRn msg
+   = doptRn Opt_D_dump_hi_diffs `thenRn` \b ->
+     if b then putDocRn msg else returnRn ()
+
 putDocRn :: SDoc -> RnM d ()
-putDocRn msg = ioToRnM (printErrs msg) `thenRn_`
+putDocRn msg = ioToRnM (printErrs alwaysQualify msg)   `thenRn_`
               returnRn ()
 \end{code}
 
@@ -117,12 +128,18 @@ data RnDown
        rn_mod     :: Module,           -- This module
        rn_loc     :: SrcLoc,           -- Current locn
 
-       rn_finder  :: Finder,
        rn_dflags  :: DynFlags,
+
        rn_hit     :: HomeIfaceTable,
-       rn_done    :: Name -> Bool,   -- available before compiling this module?
+       rn_done    :: Name -> Maybe TyThing,    -- Tells what things (both in the
+                                               -- home package and other packages)
+                                               -- were already available (i.e. in
+                                               -- the relevant SymbolTable) before 
+                                               -- compiling this module
+                       -- The Name passed to rn_done is guaranteed to be a Global,
+                       -- so it has a Module, so it can be looked up
 
-       rn_errs    :: IORef (Bag WarnMsg, Bag ErrMsg),
+       rn_errs    :: IORef Messages,
 
        -- The second and third components are a flattened-out OrigNameEnv
        rn_ns      :: IORef (UniqSupply, OrigNameNameEnv, OrigNameIParamEnv),
@@ -133,7 +150,7 @@ data RnDown
 data SDown = SDown {
                  rn_mode :: RnMode,
 
-                 rn_genv :: GlobalRdrEnv,      -- Global envt
+                 rn_genv :: GlobalRdrEnv,      -- Top level environment
 
                  rn_lenv :: LocalRdrEnv,       -- Local name envt
                        --   Does *not* include global name envt; may shadow it
@@ -143,9 +160,10 @@ data SDown = SDown {
                        -- We still need the unsullied global name env so that
                        --   we can look up record field names
 
-                 rn_fixenv :: LocalFixityEnv   -- Local fixities
+                 rn_fixenv :: LocalFixityEnv   -- Local fixities (for non-top-level
+                                               -- declarations)
                        -- The global fixities are held in the
-                       -- rn_ifaces field.  Why?  See the comments
+                       -- HIT or PIT.  Why?  See the comments
                        -- with RnIfaces.lookupLocalFixity
                }
 
@@ -186,6 +204,11 @@ type ExportAvails = (FiniteMap ModuleName Avails,
 %===================================================
 
 \begin{code}
+type ExportItem   = (ModuleName, [RdrAvailInfo])
+type IfaceDeprecs = Maybe (Either DeprecTxt [(RdrName,DeprecTxt)])
+       -- Nothing        => NoDeprecs
+       -- Just (Left t)  => DeprecAll
+       -- Just (Right p) => DeprecSome
 
 data ParsedIface
   = ParsedIface {
@@ -193,13 +216,12 @@ data ParsedIface
       pi_vers     :: Version,                          -- Module version number
       pi_orphan    :: WhetherHasOrphans,               -- Whether this module has orphans
       pi_usages           :: [ImportVersion OccName],          -- Usages
-      pi_exports   :: [ExportItem],                    -- Exports
+      pi_exports   :: (Version, [ExportItem]),         -- Exports
+      pi_decls    :: [(Version, RdrNameTyClDecl)],     -- Local definitions
+      pi_fixity           :: [RdrNameFixitySig],               -- Local fixity declarations,
       pi_insts    :: [RdrNameInstDecl],                -- Local instance declarations
-      pi_decls    :: [(Version, RdrNameHsDecl)],       -- Local definitions
-      pi_fixity           :: (Version, [RdrNameFixitySig]),    -- Local fixity declarations,
-                                                       --   with their version
       pi_rules    :: (Version, [RdrNameRuleDecl]),     -- Rules, with their version
-      pi_deprecs   :: [RdrNameDeprecation]             -- Deprecations
+      pi_deprecs   :: IfaceDeprecs                     -- Deprecations
     }
 \end{code}
 
@@ -242,25 +264,32 @@ data Ifaces = Ifaces {
     -- EPHEMERAL FIELDS
     -- These fields persist during the compilation of a single module only
        iImpModInfo :: ImportedModuleInfo,
-                       -- Modules this one depends on: that is, the union 
-                       -- of the modules its *direct* imports depend on.
-                       -- NB: The direct imports have .hi files that enumerate *all* the
-                       -- dependencies (direct or not) of the imported module.
+                       -- Modules that we know something about, because they are mentioned
+                       -- in interface files, BUT which we have not loaded yet.  
+                       -- No module is both in here and in the PIT
 
        iSlurp :: NameSet,
                -- All the names (whether "big" or "small", whether wired-in or not,
                -- whether locally defined or not) that have been slurped in so far.
 
-       iVSlurp :: [(Name,Version)]
-               -- All the (a) non-wired-in (b) "big" (c) non-locally-defined 
+       iVSlurp :: (ModuleSet, NameSet)
+               -- The Names are all the (a) non-wired-in
+               --                       (b) "big"
+               --                       (c) non-locally-defined
+               --                       (d) home-package
                -- names that have been slurped in so far, with their versions.
                -- This is used to generate the "usage" information for this module.
                -- Subset of the previous field.
+               -- The module set is the non-home-package modules from which we have
+               -- slurped at least one name.
+               -- It's worth keeping separately, because there's no very easy 
+               -- way to distinguish the "big" names from the "non-big" ones.
+               -- But this is a decision we might want to revisit.
     }
 
-type ImportedModuleInfo = FiniteMap ModuleName 
-                                   (WhetherHasOrphans, IsBootInterface, IsLoaded)
-type IsLoaded = Bool
+type ImportedModuleInfo = FiniteMap ModuleName (WhetherHasOrphans, IsBootInterface)
+       -- Contains info ONLY about modules that have not yet
+       --- been loaded into the iPIT
 \end{code}
 
 
@@ -271,29 +300,47 @@ type IsLoaded = Bool
 %************************************************************************
 
 \begin{code}
-initRn :: DynFlags 
-       -> Finder 
-       -> HomeIfaceTable
+runRn dflags hit hst pcs mod do_rn
+  = do { (pcs, msgs, r) <- initRn dflags hit hst pcs mod do_rn ;
+        printErrorsAndWarnings alwaysQualify msgs ;
+        return (pcs, errorsFound msgs, r)
+    }
+
+initRn :: DynFlags
+       -> HomeIfaceTable -> HomeSymbolTable
        -> PersistentCompilerState
-       -> Module 
-       -> SrcLoc
+       -> Module
        -> RnMG t
-       -> IO (t, PersistentCompilerState, (Bag WarnMsg, Bag ErrMsg))
+       -> IO (PersistentCompilerState, Messages, t)    
 
-initRn dflags finder hit pcs mod loc do_rn
+initRn dflags hit hst pcs mod do_rn
   = do 
        let prs = pcs_PRS pcs
-       uniqs     <- mkSplitUniqSupply 'r'
+       let pte = pcs_PTE pcs
+       let ifaces = Ifaces { iPIT   = pcs_PIT pcs,
+                             iDecls = prsDecls prs,
+                             iInsts = prsInsts prs,
+                             iRules = prsRules prs,
+
+                             iImpModInfo = emptyFM,
+                             iSlurp      = unitNameSet (mkUnboundName dummyRdrVarName),
+                               -- Pretend that the dummy unbound name has already been
+                               -- slurped.  This is what's returned for an out-of-scope name,
+                               -- and we don't want thereby to try to suck it in!
+                             iVSlurp = (emptyModuleSet, emptyNameSet)
+                     }
+        let uniqs = prsNS prs
+
        names_var <- newIORef (uniqs, origNames (prsOrig prs), 
                                      origIParam (prsOrig prs))
        errs_var  <- newIORef (emptyBag,emptyBag)
-       iface_var <- newIORef (initIfaces pcs)
+       iface_var <- newIORef ifaces
        let rn_down = RnDown { rn_mod = mod,
-                              rn_loc = loc, 
+                              rn_loc = noSrcLoc, 
        
-                              rn_finder = finder,
                               rn_dflags = dflags,
                               rn_hit    = hit,
+                              rn_done   = lookupType hst pte,
                                             
                               rn_ns     = names_var, 
                               rn_errs   = errs_var, 
@@ -304,38 +351,23 @@ initRn dflags finder hit pcs mod loc do_rn
        res <- do_rn rn_down ()
        
        -- Grab state and record it
-       (warns, errs)              <- readIORef errs_var
-       new_ifaces                 <- readIORef iface_var
-       (_, new_origN, new_origIP) <- readIORef names_var
+       (warns, errs)                   <- readIORef errs_var
+       new_ifaces                      <- readIORef iface_var
+       (new_NS, new_origN, new_origIP) <- readIORef names_var
        let new_orig = Orig { origNames = new_origN, origIParam = new_origIP }
        let new_prs = prs { prsOrig = new_orig,
                            prsDecls = iDecls new_ifaces,
                            prsInsts = iInsts new_ifaces,
-                           prsRules = iRules new_ifaces }
-       let new_pcs = pcs { pcs_PST = iPST new_ifaces, 
+                           prsRules = iRules new_ifaces,
+                           prsNS    = new_NS }
+       let new_pcs = pcs { pcs_PIT = iPIT new_ifaces, 
                            pcs_PRS = new_prs }
        
-       return (res, new_pcs, (warns, errs))
-
-
-initIfaces :: PersistentCompilerState -> Ifaces
-initIfaces (PCS { pcs_PST = pst, pcs_PRS = prs })
-  = Ifaces { iPST   = pst,
-            iDecls = prsDecls prs,
-            iInsts = prsInsts prs,
-            iRules = prsRules prs,
-
-            iImpModInfo = emptyFM,
-            iSlurp      = unitNameSet (mkUnboundName dummyRdrVarName),
-                       -- Pretend that the dummy unbound name has already been
-                       -- slurped.  This is what's returned for an out-of-scope name,
-                       -- and we don't want thereby to try to suck it in!
-            iVSlurp = []
-      }
-
+       return (new_pcs, (warns, errs), res)
 
-initRnMS :: GlobalRdrEnv -> LocalFixityEnv -> RnMode -> RnMS r -> RnM d r
 initRnMS rn_env fixity_env mode thing_inside rn_down g_down
+       -- The fixity_env appears in both the rn_fixenv field
+       -- and in the HIT.  See comments with RnHiFiles.lookupFixityRn
   = let
        s_down = SDown { rn_genv = rn_env, rn_lenv = emptyRdrEnv, 
                         rn_fixenv = fixity_env, rn_mode = mode }
@@ -346,7 +378,6 @@ initIfaceRnMS :: Module -> RnMS r -> RnM d r
 initIfaceRnMS mod thing_inside 
   = initRnMS emptyRdrEnv emptyNameEnv InterfaceMode $
     setModuleRn mod thing_inside
-
 \end{code}
 
 @renameSourceCode@ is used to rename stuff ``out-of-line'';
@@ -379,7 +410,8 @@ renameSourceCode dflags mod prs m
                               rn_loc = generatedSrcLoc, rn_ns = names_var,
                               rn_errs = errs_var, 
                               rn_mod = mod, 
-                              rn_ifaces = panic "rnameSourceCode: rn_ifaces"  -- Not required
+                              rn_done   = bogus "rn_done",     rn_hit    = bogus "rn_hit",
+                              rn_ifaces = bogus "rn_ifaces"
                             }
            s_down = SDown { rn_mode = InterfaceMode,
                               -- So that we can refer to PrelBase.True etc
@@ -404,6 +436,8 @@ renameSourceCode dflags mod prs m
   where
     display errs = pprBagOfErrors errs
 
+bogus s = panic ("rnameSourceCode: " ++ s)  -- Used for unused record fields
+
 {-# INLINE thenRn #-}
 {-# INLINE thenRn_ #-}
 {-# INLINE returnRn #-}
@@ -417,7 +451,8 @@ mapRn    :: (a -> RnM d b) -> [a] -> RnM d [b]
 mapRn_   :: (a -> RnM d b) -> [a] -> RnM d ()
 mapMaybeRn :: (a -> RnM d (Maybe b)) -> [a] -> RnM d [b]
 flatMapRn  :: (a -> RnM d [b])       -> [a] -> RnM d [b]
-sequenceRn :: [RnM d a] -> RnM d [a]
+sequenceRn  :: [RnM d a] -> RnM d [a]
+sequenceRn_ :: [RnM d a] -> RnM d ()
 foldlRn :: (b  -> a -> RnM d b) -> b -> [a] -> RnM d b
 mapAndUnzipRn :: (a -> RnM d (b,c)) -> [a] -> RnM d ([b],[c])
 fixRn    :: (a -> RnM d a) -> RnM d a
@@ -433,9 +468,12 @@ andRn combiner m1 m2 gdown ldown
 
 sequenceRn []     = returnRn []
 sequenceRn (m:ms) =  m                 `thenRn` \ r ->
-                    sequenceRn ms      `thenRn` \ rs ->
+                    sequenceRn ms      `thenRn` \ rs ->
                     returnRn (r:rs)
 
+sequenceRn_ []     = returnRn ()
+sequenceRn_ (m:ms) = m `thenRn_` sequenceRn_ ms
+
 mapRn f []     = returnRn []
 mapRn f (x:xs)
   = f x                `thenRn` \ r ->
@@ -554,11 +592,11 @@ getSrcLocRn down l_down
 %=====================
 
 \begin{code}
-getFinderRn :: RnM d Finder
-getFinderRn down l_down = return (rn_finder down)
-
 getHomeIfaceTableRn :: RnM d HomeIfaceTable
 getHomeIfaceTableRn down l_down = return (rn_hit down)
+
+getTypeEnvRn :: RnM d (Name -> Maybe TyThing)
+getTypeEnvRn down l_down = return (rn_done down)
 \end{code}
 
 %================