[project @ 2004-12-21 12:11:37 by simonpj]
[ghc-hetmet.git] / ghc / compiler / iface / LoadIface.lhs
index b1a6223..ef52bdb 100644 (file)
@@ -6,52 +6,56 @@
 \begin{code}
 module LoadIface (
        loadHomeInterface, loadInterface,
-       loadSrcInterface, loadOrphanModules,
+       loadSrcInterface, loadOrphanModules, loadHiBootInterface,
        readIface,      -- Used when reading the module's old interface
        predInstGates, ifaceInstGates, ifaceStats, discardDeclPrags,
-       initExternalPackageState
+       initExternalPackageState,
+       noIfaceErr,   -- used by CompManager too
    ) where
 
 #include "HsVersions.h"
 
 import {-# SOURCE #-}  TcIface( tcIfaceDecl )
 
+import Packages                ( PackageState(..), isHomeModule  )
 import DriverState     ( v_GhcMode, isCompManagerMode )
 import DriverUtil      ( replaceFilenameSuffix )
-import CmdLineOpts     ( DynFlags( verbosity ), DynFlag( Opt_IgnoreInterfacePragmas ), 
-                         opt_InPackage )
+import CmdLineOpts     ( DynFlags(..), DynFlag( Opt_IgnoreInterfacePragmas ) )
 import Parser          ( parseIface )
 
-import IfaceSyn                ( IfaceDecl(..), IfaceConDecls(..), IfaceConDecl(..), IfaceClassOp(..), 
-                         IfaceInst(..), IfaceRule(..), IfaceExpr(..), IfaceTyCon(..), IfaceIdInfo(..), 
-                         IfaceType(..), IfacePredType(..), IfaceExtName, visibleIfConDecls, mkIfaceExtName )
-import IfaceEnv                ( newGlobalBinder, lookupIfaceExt, lookupIfaceTc )
-import HscTypes                ( HscEnv(..), ModIface(..), TyThing, emptyModIface, EpsStats(..), addEpsInStats,
-                         ExternalPackageState(..), PackageTypeEnv, emptyTypeEnv, 
-                         lookupIfaceByModName, emptyPackageIfaceTable,
-                         IsBootInterface, mkIfaceFixCache, mkTypeEnv,
-                         Gated, implicitTyThings,
-                         addRulesToPool, addInstsToPool
+import IfaceSyn                ( IfaceDecl(..), IfaceConDecl(..), IfaceClassOp(..),
+                         IfaceConDecls(..), IfaceInst(..), IfaceRule(..),
+                         IfaceExpr(..), IfaceTyCon(..), IfaceIdInfo(..), 
+                         IfaceType(..), IfacePredType(..), IfaceExtName,
+                         mkIfaceExtName )
+import IfaceEnv                ( newGlobalBinder, lookupIfaceExt, lookupIfaceTc,
+                         lookupOrig )
+import HscTypes                ( ModIface(..), TyThing, emptyModIface, EpsStats(..),
+                         addEpsInStats, ExternalPackageState(..),
+                         PackageTypeEnv, emptyTypeEnv,  IfacePackage(..),
+                         lookupIfaceByModule, emptyPackageIfaceTable,
+                         IsBootInterface, mkIfaceFixCache, Gated,
+                         implicitTyThings, addRulesToPool, addInstsToPool,
+                         availNames
                         )
 
-import BasicTypes      ( Version, Fixity(..), FixityDirection(..), isMarkedStrict )
+import BasicTypes      ( Version, Fixity(..), FixityDirection(..),
+                         isMarkedStrict )
 import TcType          ( Type, tcSplitTyConApp_maybe )
 import Type            ( funTyCon )
 import TcRnMonad
 
-import PrelNames       ( gHC_PRIM_Name )
-import PrelInfo                ( ghcPrimExports, wiredInThings )
+import PrelNames       ( gHC_PRIM )
+import PrelInfo                ( ghcPrimExports )
 import PrelRules       ( builtinRules )
 import Rules           ( emptyRuleBase )
 import InstEnv         ( emptyInstEnv )
 import Name            ( Name {-instance NamedThing-}, getOccName,
-                         nameModuleName, isInternalName )
+                         nameModule, isInternalName )
 import NameEnv
 import MkId            ( seqId )
-import Packages                ( basePackage )
-import Module          ( Module, ModuleName, ModLocation(ml_hi_file),
-                         moduleName, isHomeModule, emptyModuleEnv, moduleEnvElts,
-                         extendModuleEnv, lookupModuleEnvByName, moduleUserString
+import Module          ( Module, ModLocation(ml_hi_file), emptyModuleEnv, 
+                         extendModuleEnv, lookupModuleEnv, moduleUserString
                        )
 import OccName         ( OccName, mkOccEnv, lookupOccEnv, mkClassTyConOcc, mkClassDataConOcc,
                          mkSuperDictSelOcc, mkDataConWrapperOcc, mkDataConWorkerOcc )
@@ -62,7 +66,7 @@ import Maybes         ( isJust, mapCatMaybes )
 import StringBuffer     ( hGetStringBuffer )
 import FastString      ( mkFastString )
 import ErrUtils         ( Message, mkLocMessage )
-import Finder          ( findModule, findPackageModule, 
+import Finder          ( findModule, findPackageModule,  FindResult(..),
                          hiBootExt, hiBootVerExt )
 import Lexer
 import Outputable
@@ -85,7 +89,7 @@ import Directory
 %************************************************************************
 
 \begin{code}
-loadSrcInterface :: SDoc -> ModuleName -> IsBootInterface -> RnM ModIface
+loadSrcInterface :: SDoc -> Module -> IsBootInterface -> RnM ModIface
 -- This is called for each 'import' declaration in the source code
 -- On a failure, fail in the monad with an error message
 
@@ -100,7 +104,42 @@ loadSrcInterface doc mod_name want_boot
     elaborate err = hang (ptext SLIT("Failed to load interface for") <+> 
                         quotes (ppr mod_name) <> colon) 4 err
 
-loadOrphanModules :: [ModuleName] -> TcM ()
+loadHiBootInterface :: TcRn [Name]
+-- Load the hi-boot iface for the module being compiled,
+-- if it indeed exists in the transitive closure of imports
+-- Return the list of names exported by the hi-boot file
+loadHiBootInterface
+  = do         { eps <- getEps
+       ; mod <- getModule
+
+       ; traceIf (text "loadHiBootInterface" <+> ppr mod)
+
+       -- We're read all the direct imports by now, so eps_is_boot will
+       -- record if any of our imports mention us by way of hi-boot file
+       ; case lookupModuleEnv (eps_is_boot eps) mod of {
+           Nothing             -> return [] ;  -- The typical case
+
+           Just (_, False) ->          -- Someone below us imported us!
+               -- This is a loop with no hi-boot in the way
+               failWithTc (moduleLoop mod) ;
+
+           Just (mod_nm, True) ->      -- There's a hi-boot interface below us
+               
+
+    do {       -- Load it (into the PTE), and return the exported names
+         iface <- loadSrcInterface (mk_doc mod_nm) mod_nm True
+       ; sequenceM [ lookupOrig mod_nm occ
+                   | (mod,avails) <- mi_exports iface, 
+                     avail <- avails, occ <- availNames avail]
+    }}}
+  where
+    mk_doc mod = ptext SLIT("Need the hi-boot interface for") <+> ppr mod
+                <+> ptext SLIT("to compare against the Real Thing")
+
+    moduleLoop mod = ptext SLIT("Circular imports: module") <+> quotes (ppr mod) 
+                    <+> ptext SLIT("depends on itself")
+
+loadOrphanModules :: [Module] -> TcM ()
 loadOrphanModules mods
   | null mods = returnM ()
   | otherwise = initIfaceTcRn $
@@ -124,9 +163,9 @@ loadOrphanModules mods
 loadHomeInterface :: SDoc -> Name -> IfM lcl ModIface
 loadHomeInterface doc name
   = ASSERT2( not (isInternalName name), ppr name <+> parens doc )
-    loadSysInterface doc (nameModuleName name)
+    loadSysInterface doc (nameModule name)
 
-loadSysInterface :: SDoc -> ModuleName -> IfM lcl ModIface
+loadSysInterface :: SDoc -> Module -> IfM lcl ModIface
 -- A wrapper for loadInterface that Throws an exception if it fails
 loadSysInterface doc mod_name
   = do { mb_iface <- loadInterface doc mod_name ImportBySystem
@@ -147,7 +186,7 @@ loadSysInterface doc mod_name
 %*********************************************************
 
 \begin{code}
-loadInterface :: SDoc -> ModuleName -> WhereFrom 
+loadInterface :: SDoc -> Module -> WhereFrom 
              -> IfM lcl (Either Message ModIface)
 -- If it can't find a suitable interface file, we
 --     a) modify the PackageIfaceTable to have an empty entry
@@ -163,8 +202,10 @@ loadInterface doc_str mod_name from
   = do {       -- Read the state
          (eps,hpt) <- getEpsAndHpt
 
+       ; traceIf (text "Considering whether to load" <+> ppr mod_name <+> ppr from)
+
                -- Check whether we have the interface already
-       ; case lookupIfaceByModName hpt (eps_PIT eps) mod_name of {
+       ; case lookupIfaceByModule hpt (eps_PIT eps) mod_name of {
            Just iface 
                -> returnM (Right iface) ;      -- Already loaded
                        -- The (src_imp == mi_boot iface) test checks that the already-loaded
@@ -176,7 +217,7 @@ loadInterface doc_str mod_name from
                                ImportByUser usr_boot -> usr_boot
                                ImportBySystem        -> sys_boot
 
-             ; mb_dep   = lookupModuleEnvByName (eps_is_boot eps) mod_name
+             ; mb_dep   = lookupModuleEnv (eps_is_boot eps) mod_name
              ; sys_boot = case mb_dep of
                                Just (_, is_boot) -> is_boot
                                Nothing           -> False
@@ -184,10 +225,13 @@ loadInterface doc_str mod_name from
              }         -- based on the dependencies in directly-imported modules
 
        -- READ THE MODULE IN
-       ; read_result <- findAndReadIface doc_str mod_name hi_boot_file
+       ; let explicit | ImportByUser _ <- from = True
+                      | otherwise              = False
+       ; read_result <- findAndReadIface explicit doc_str mod_name hi_boot_file
+       ; dflags <- getDOpts
        ; case read_result of {
            Left err -> do
-               { let fake_iface = emptyModIface opt_InPackage mod_name
+               { let fake_iface = emptyModIface ThisPackage mod_name
 
                ; updateEps_ $ \eps ->
                        eps { eps_PIT = extendModuleEnv (eps_PIT eps) (mi_module fake_iface) fake_iface }
@@ -199,14 +243,13 @@ loadInterface doc_str mod_name from
        -- Found and parsed!
            Right iface -> 
 
-       let { mod      = mi_module iface
-           ; mod_name = moduleName mod } in
+       let { mod = mi_module iface } in
 
        -- Sanity check.  If we're system-importing a module we know nothing at all
        -- about, it should be from a different package to this one
        WARN(   case from of { ImportBySystem -> True; other -> False } &&
                not (isJust mb_dep) && 
-               isHomeModule mod,
+               isHomeModule dflags mod,
                ppr mod $$ ppr mb_dep $$ ppr (eps_is_boot eps) )
 
        initIfaceLcl mod_name $ do
@@ -235,8 +278,6 @@ loadInterface doc_str mod_name from
                                        mi_insts = panic "No mi_insts in PIT",
                                        mi_rules = panic "No mi_rules in PIT" } }
 
-       ; traceIf (text "Extending PTE" <+> ppr (map fst (concat new_eps_decls)))
-
        ; updateEps_  $ \ eps -> 
                eps {   eps_PIT   = extendModuleEnv (eps_PIT eps) mod final_iface,
                        eps_PTE   = addDeclsToPTE   (eps_PTE eps) new_eps_decls,
@@ -274,7 +315,7 @@ loadDecl ignore_prags mod (_version, decl)
        ; implicit_names <- mapM (mk_new_bndr (Just main_name)) (ifaceDeclSubBndrs decl)
 
        -- Typecheck the thing, lazily
-       ; thing <- forkM doc (bumpDeclStats main_name >> tcIfaceDecl decl)
+       ; thing <- forkM doc (bumpDeclStats main_name >> tcIfaceDecl stripped_decl)
        ; let mini_env = mkOccEnv [(getOccName t, t) | t <- implicitTyThings thing]
              lookup n = case lookupOccEnv mini_env (getOccName n) of
                           Just thing -> thing
@@ -285,12 +326,11 @@ loadDecl ignore_prags mod (_version, decl)
                -- as the TyThings.  That way we can extend the PTE without poking the
                -- thunks
   where
-    decl' | ignore_prags = discardDeclPrags decl
-         | otherwise    = decl
+    stripped_decl | ignore_prags = discardDeclPrags decl
+                 | otherwise    = decl
 
        -- mk_new_bndr allocates in the name cache the final canonical
        -- name for the thing, with the correct 
-       --      * package info
        --      * parent
        --      * location
        -- imported name, to fix the module correctly in the cache
@@ -330,32 +370,36 @@ ifaceDeclSubBndrs (IfaceClass {ifCtxt = sc_ctxt, ifName = cls_occ, ifSigs = sigs
 
 ifaceDeclSubBndrs (IfaceData {ifCons = IfAbstractTyCon}) 
   = []
-ifaceDeclSubBndrs (IfaceData {ifCons = IfNewTyCon (IfaceConDecl con_occ _ _ _ _ _ fields)}) 
+-- Newtype
+ifaceDeclSubBndrs (IfaceData {ifCons = IfNewTyCon (IfVanillaCon { ifConOcc = con_occ, 
+                                                                 ifConFields = fields})}) 
   = fields ++ [con_occ, mkDataConWrapperOcc con_occ]   
        -- Wrapper, no worker; see MkId.mkDataConIds
 
-ifaceDeclSubBndrs (IfaceData {ifCons = IfDataTyCon cons})
+ifaceDeclSubBndrs (IfaceData {ifCons = IfDataTyCon _ cons})
   = nub (concatMap fld_occs cons)      -- Eliminate duplicate fields
     ++ concatMap dc_occs cons
   where
-    fld_occs (IfaceConDecl _ _ _ _ _ _ fields) = fields
-    dc_occs (IfaceConDecl con_occ _ _ _ _ strs _)
+    fld_occs (IfVanillaCon { ifConFields = fields }) = fields
+    fld_occs (IfGadtCon {})                         = []
+    dc_occs con_decl
        | has_wrapper = [con_occ, work_occ, wrap_occ]
        | otherwise   = [con_occ, work_occ]
        where
+         con_occ = ifConOcc con_decl
+         strs    = ifConStricts con_decl
          wrap_occ = mkDataConWrapperOcc con_occ
          work_occ = mkDataConWorkerOcc con_occ
          has_wrapper = any isMarkedStrict strs -- See MkId.mkDataConIds (sigh)
                -- ToDo: may miss strictness in existential dicts
 
-ifaceDeclSubBndrs _other = []
-
+ifaceDeclSubBndrs _other                     = []
 
 -----------------------------------------------------
 --     Loading instance decls
 -----------------------------------------------------
 
-loadInsts :: ModuleName -> [IfaceInst] -> IfL [(Name, Gated IfaceInst)]
+loadInsts :: Module -> [IfaceInst] -> IfL [(Name, Gated IfaceInst)]
 loadInsts mod decls = mapM (loadInstDecl mod) decls
 
 loadInstDecl mod decl@(IfaceInst {ifInstHead = inst_ty})
@@ -396,13 +440,13 @@ loadInstDecl mod decl@(IfaceInst {ifInstHead = inst_ty})
 -----------------------------------------------------
 
 loadRules :: Bool      -- Don't load pragmas into the decl pool
-         -> ModuleName
+         -> Module
          -> [IfaceRule] -> IfL [Gated IfaceRule]
 loadRules ignore_prags mod rules
   | ignore_prags = returnM []
   | otherwise    = mapM (loadRule mod) rules
 
-loadRule :: ModuleName -> IfaceRule -> IfL (Gated IfaceRule)
+loadRule :: Module -> IfaceRule -> IfL (Gated IfaceRule)
 -- "Gate" the rule simply by a crude notion of the free vars of
 -- the LHS.  It can be crude, because having too few free vars is safe.
 loadRule mod decl@(IfaceRule {ifRuleHead = fn, ifRuleArgs = args})
@@ -492,7 +536,8 @@ predInstGates cls tys
 %*********************************************************
 
 \begin{code}
-findAndReadIface :: SDoc -> ModuleName 
+findAndReadIface :: Bool               -- True <=> explicit user import
+                -> SDoc -> Module 
                 -> IsBootInterface     -- True  <=> Look for a .hi-boot file
                                        -- False <=> Look for .hi file
                 -> IfM lcl (Either Message ModIface)
@@ -502,7 +547,7 @@ findAndReadIface :: SDoc -> ModuleName
        -- It *doesn't* add an error to the monad, because 
        -- sometimes it's ok to fail... see notes with loadInterface
 
-findAndReadIface doc_str mod_name hi_boot_file
+findAndReadIface explicit doc_str mod_name hi_boot_file
   = do { traceIf (sep [hsep [ptext SLIT("Reading"), 
                              if hi_boot_file 
                                then ptext SLIT("[boot]") 
@@ -512,19 +557,26 @@ findAndReadIface doc_str mod_name hi_boot_file
                        nest 4 (ptext SLIT("reason:") <+> doc_str)])
 
        -- Check for GHC.Prim, and return its static interface
-       ; if mod_name == gHC_PRIM_Name
-         then returnM (Right ghcPrimIface)
+       ; dflags <- getDOpts
+       ; let base_id = basePackageId (pkgState dflags)
+             base_pkg 
+               | Just id <- base_id = ExternalPackage id
+               | otherwise          = ThisPackage
+               -- if basePackageId is Nothing, it means we must be
+               -- compiling the base package.
+       ; if mod_name == gHC_PRIM
+         then returnM (Right (ghcPrimIface{ mi_package = base_pkg }))
          else do
 
        -- Look for the file
-       ; mb_found <- ioToIOEnv (findHiFile mod_name hi_boot_file)
+       ; mb_found <- ioToIOEnv (findHiFile dflags explicit mod_name hi_boot_file)
        ; case mb_found of {
-             Left files -> do
+             Left err -> do
                { traceIf (ptext SLIT("...not found"))
                ; dflags <- getDOpts
-               ; returnM (Left (noIfaceErr dflags mod_name hi_boot_file files)) } ;
+               ; returnM (Left (noIfaceErr dflags mod_name err)) } ;
 
-             Right file_path -> do
+             Right (file_path,pkg) -> do 
 
        -- Found file, so read it
        { traceIf (ptext SLIT("readIFace") <+> text file_path)
@@ -532,15 +584,16 @@ findAndReadIface doc_str mod_name hi_boot_file
        ; case read_result of
            Left err    -> returnM (Left (badIfaceFile file_path err))
            Right iface 
-               | moduleName (mi_module iface) /= mod_name ->
+               | mi_module iface /= mod_name ->
                  return (Left (wrongIfaceModErr iface mod_name file_path))
                | otherwise ->
-                 returnM (Right iface)
+                 returnM (Right iface{mi_package=pkg})
+                       -- don't forget to fill in the package name...
        }}}
 
-findHiFile :: ModuleName -> IsBootInterface
-          -> IO (Either [FilePath] FilePath)
-findHiFile mod_name hi_boot_file
+findHiFile :: DynFlags -> Bool -> Module -> IsBootInterface
+          -> IO (Either FindResult (FilePath, IfacePackage))
+findHiFile dflags explicit mod_name hi_boot_file
  = do { 
        -- In interactive or --make mode, we are *not allowed* to demand-load
        -- a home package .hi file.  So don't even look for them.
@@ -551,13 +604,15 @@ findHiFile mod_name hi_boot_file
        let { home_allowed = hi_boot_file || 
                             not (isCompManagerMode ghci_mode) } ;
        maybe_found <-  if home_allowed 
-                       then findModule mod_name
-                       else findPackageModule mod_name ;
+                       then findModule dflags mod_name explicit
+                       else findPackageModule dflags mod_name explicit;
 
        case maybe_found of {
-         Left files -> return (Left files) ;
-
-         Right (_, loc) -> do {        -- Don't need module returned by finder
+         Found loc pkg -> foundOk loc hi_boot_file pkg;
+         err           -> return (Left err) ;
+       }}
+   where
+    foundOk loc hi_boot_file pkg = do {        -- Don't need module returned by finder
 
        -- Return the path to M.hi, M.hi-boot, or M.hi-boot-n as appropriate
        let { hi_path            = ml_hi_file loc ;
@@ -566,18 +621,18 @@ findHiFile mod_name hi_boot_file
            };
 
        if not hi_boot_file then
-          return (Right hi_path)
+          return (Right (hi_path,pkg))
        else do {
                hi_ver_exists <- doesFileExist hi_boot_ver_path ;
-               if hi_ver_exists then return (Right hi_boot_ver_path)
-                                else return (Right hi_boot_path)
-       }}}}
+               if hi_ver_exists then return (Right (hi_boot_ver_path,pkg))
+                                else return (Right (hi_boot_path,pkg))
+       }}
 \end{code}
 
 @readIface@ tries just the one file.
 
 \begin{code}
-readIface :: ModuleName -> String -> IsBootInterface 
+readIface :: Module -> String -> IsBootInterface 
          -> IfM lcl (Either Message ModIface)
        -- Left err    <=> file not found, or unreadable, or illegible
        -- Right iface <=> successfully found and parsed 
@@ -598,7 +653,7 @@ read_iface dflags wanted_mod file_path is_hi_boot_file
             | wanted_mod == actual_mod -> return (Right iface)
             | otherwise                -> return (Left err) 
             where
-               actual_mod = moduleName (mi_module iface)
+               actual_mod = mi_module iface
                err = hiModuleNameMismatchWarn wanted_mod actual_mod
      }}
 
@@ -636,7 +691,7 @@ initExternalPackageState
     }
   where
     mk_gated_rule (fn_name, core_rule)
-       = ([fn_name], (nameModuleName fn_name, IfaceBuiltinRule (mkIfaceExtName fn_name) core_rule))
+       = ([fn_name], (nameModule fn_name, IfaceBuiltinRule (mkIfaceExtName fn_name) core_rule))
 \end{code}
 
 
@@ -649,8 +704,8 @@ initExternalPackageState
 \begin{code}
 ghcPrimIface :: ModIface
 ghcPrimIface
-  = (emptyModIface basePackage gHC_PRIM_Name) {
-       mi_exports  = [(gHC_PRIM_Name, ghcPrimExports)],
+  = (emptyModIface ThisPackage gHC_PRIM) {
+       mi_exports  = [(gHC_PRIM, ghcPrimExports)],
        mi_decls    = [],
        mi_fixities = fixities,
        mi_fix_fn  = mkIfaceFixCache fixities
@@ -695,7 +750,7 @@ badIfaceFile file err
   = vcat [ptext SLIT("Bad interface file:") <+> text file, 
          nest 4 err]
 
-hiModuleNameMismatchWarn :: ModuleName -> ModuleName -> Message
+hiModuleNameMismatchWarn :: Module -> Module -> Message
 hiModuleNameMismatchWarn requested_mod read_mod = 
     hsep [ ptext SLIT("Something is amiss; requested module name")
         , ppr requested_mod
@@ -703,11 +758,21 @@ hiModuleNameMismatchWarn requested_mod read_mod =
         , ppr read_mod
         ]
 
-noIfaceErr dflags mod_name boot_file files
+noIfaceErr dflags mod_name (PackageHidden pkg)
+  = ptext SLIT("Could not import") <+> quotes (ppr mod_name) <> colon
+    $$ ptext SLIT("it is a member of package") <+> ppr pkg <> comma
+        <+> ptext SLIT("which is hidden")
+
+noIfaceErr dflags mod_name (ModuleHidden pkg)
+  = ptext SLIT("Could not import") <+> quotes (ppr mod_name) <> colon
+    $$ ptext SLIT("it is hidden") 
+       <+> parens (ptext SLIT("in package") <+> ppr pkg)
+
+noIfaceErr dflags mod_name (NotFound files)
   = ptext SLIT("Could not find interface file for") <+> quotes (ppr mod_name)
-    $$ extra
+    $$ extra files
   where 
-   extra
+  extra files
     | verbosity dflags < 3 = 
         text "(use -v to see a list of the files searched for)"
     | otherwise =