[project @ 2005-05-04 16:20:27 by simonmar]
[ghc-hetmet.git] / ghc / compiler / main / GHC.hs
index b8672b9..9622729 100644 (file)
@@ -33,7 +33,10 @@ module GHC (
        -- * Loading\/compiling the program
        depanal,
        load, LoadHowMuch(..), SuccessFlag(..), -- also does depanal
+       loadMsgs,
        workingDirectoryChanged,
+       checkModule, CheckedModule(..),
+       TypecheckedSource, ParsedSource, RenamedSource,
 
        -- * Inspecting the module structure of the program
        ModuleGraph, ModSummary(..),
@@ -45,13 +48,16 @@ module GHC (
        ModuleInfo,
        getModuleInfo,
        modInfoTyThings,
-       lookupName,
-       allNamesInScope,
+       modInfoTopLevelScope,
+       modInfoPrintUnqualified,
+       modInfoExports,
+       lookupGlobalName,
 
        -- * Interactive evaluation
        getBindings, getPrintUnqual,
 #ifdef GHCI
        setContext, getContext, 
+       getNamesInScope,
        moduleIsInterpreted,
        getInfo, GetInfoResult,
        exprType,
@@ -62,6 +68,7 @@ module GHC (
        browseModule,
        showModule,
        compileExpr, HValue,
+       lookupName,
 #endif
 
        -- * Abstract syntax elements
@@ -99,6 +106,9 @@ module GHC (
        -- ** Entities
        TyThing(..), 
 
+       -- ** Syntax
+       module HsSyn, -- ToDo: remove extraneous bits
+
        -- * Exceptions
        GhcException(..), showGhcException,
 
@@ -110,10 +120,8 @@ module GHC (
 {-
  ToDo:
 
-  * return error messages rather than printing them.
   * inline bits of HscMain here to simplify layering: hscGetInfo,
     hscTcExpr, hscStmt.
-  * implement second argument to load.
   * we need to expose DynFlags, so should parseDynamicFlags really be
     part of this interface?
   * what StaticFlags should we expose, if any?
@@ -125,7 +133,8 @@ module GHC (
 import qualified Linker
 import Linker          ( HValue, extendLinkEnv )
 import NameEnv         ( lookupNameEnv )
-import TcRnDriver      ( mkExportEnv, getModuleContents, tcRnLookupRdrName )
+import TcRnDriver      ( mkExportEnv, getModuleContents, tcRnLookupRdrName,
+                         getModuleExports )
 import RdrName         ( plusGlobalRdrEnv )
 import HscMain         ( hscGetInfo, GetInfoResult, hscParseIdentifier,
                          hscStmt, hscTcExpr, hscKcType )
@@ -136,8 +145,9 @@ import IfaceSyn             ( IfaceDecl )
 #endif
 
 import Packages                ( initPackages )
+import NameSet         ( NameSet, nameSetToList )
 import RdrName         ( GlobalRdrEnv )
-import HsSyn           ( HsModule, LHsBinds )
+import HsSyn
 import Type            ( Kind, Type, dropForAlls )
 import Id              ( Id, idType, isImplicitId, isDeadBinder,
                           isSpecPragmaId, isExportedId, isLocalId, isGlobalId,
@@ -148,10 +158,11 @@ import Id         ( Id, idType, isImplicitId, isDeadBinder,
 import TyCon           ( TyCon, isClassTyCon, isSynTyCon, isNewTyCon )
 import Class           ( Class, classSCTheta, classTvsFds )
 import DataCon         ( DataCon )
+import InstEnv         ( Instance )
 import Name            ( Name, getName, nameModule_maybe )
 import RdrName         ( RdrName, gre_name, globalRdrEnvElts )
 import NameEnv         ( nameEnvElts )
-import SrcLoc          ( Located(..) )
+import SrcLoc          ( Located(..), mkSrcLoc, srcLocSpan )
 import DriverPipeline
 import DriverPhases    ( Phase(..), isHaskellSrcFilename, startPhase )
 import GetImports      ( getImports )
@@ -175,6 +186,8 @@ import SysTools             ( cleanTempFilesExcept )
 import BasicTypes      ( SuccessFlag(..), succeeded, failed )
 import Maybes          ( orElse, expectJust, mapCatMaybes )
 import TcType           ( tcSplitSigmaTy, isDictTy )
+import Bag             ( unitBag, emptyBag )
+import FastString      ( mkFastString )
 
 import Directory        ( getModificationTime, doesFileExist )
 import Maybe           ( isJust, isNothing, fromJust, fromMaybe, catMaybes )
@@ -392,12 +405,19 @@ data ErrMsg = ErrMsg {
 data LoadHowMuch
    = LoadAllTargets
    | LoadUpTo Module
+   | LoadDependenciesOf Module
 
 -- | Try to load the program.  If a Module is supplied, then just
 -- attempt to load up to this target.  If no Module is supplied,
 -- then try to load all targets.
 load :: Session -> LoadHowMuch -> IO SuccessFlag
-load s@(Session ref) how_much
+load session how_much = 
+   loadMsgs session how_much ErrUtils.printErrorsAndWarnings
+
+-- | Version of 'load' that takes a callback function to be invoked
+-- on compiler errors and warnings as they occur during compilation.
+loadMsgs :: Session -> LoadHowMuch -> (Messages-> IO ()) -> IO SuccessFlag
+loadMsgs s@(Session ref) how_much msg_act
    = do 
        -- Dependency analysis first.  Note that this fixes the module graph:
        -- even if we don't get a fully successful upsweep, the full module
@@ -475,11 +495,23 @@ load s@(Session ref) how_much
 
            maybe_top_mod = case how_much of
                                LoadUpTo m           -> Just m
+                               LoadDependenciesOf m -> Just m
                                _                    -> Nothing
 
-           partial_mg :: [SCC ModSummary]
-           partial_mg = topSortModuleGraph False mod_graph maybe_top_mod
-
+           partial_mg0 :: [SCC ModSummary]
+           partial_mg0 = topSortModuleGraph False mod_graph maybe_top_mod
+
+           -- LoadDependenciesOf m: we want the upsweep to stop just
+           -- short of the specified module (unless the specified module
+           -- is stable).
+           partial_mg
+               | LoadDependenciesOf mod <- how_much
+               = ASSERT( case last partial_mg0 of 
+                           AcyclicSCC ms -> ms_mod ms == mod; _ -> False )
+                 List.init partial_mg0
+               | otherwise
+               = partial_mg0
+  
            stable_mg = 
                [ AcyclicSCC ms
                | AcyclicSCC ms <- full_mg,
@@ -495,7 +527,7 @@ load s@(Session ref) how_much
 
         (upsweep_ok, hsc_env1, modsUpswept)
            <- upsweep (hsc_env { hsc_HPT = emptyHomePackageTable })
-                          pruned_hpt stable_mods cleanup mg
+                          pruned_hpt stable_mods cleanup msg_act mg
 
        -- Make modsDone be the summaries for each home module now
        -- available; this should equal the domain of hpt3.
@@ -599,7 +631,75 @@ discardProg hsc_env
 -- source file, but that doesn't do any harm.
 ppFilesFromSummaries summaries = [ fn | Just fn <- map ms_hspp_file summaries ]
 
------------------------------------------------------------------------------
+-- -----------------------------------------------------------------------------
+-- Check module
+
+data CheckedModule = 
+  CheckedModule { parsedSource      :: ParsedSource,
+                 renamedSource     :: Maybe RenamedSource,
+                 typecheckedSource :: Maybe TypecheckedSource,
+                 checkedModuleInfo :: Maybe ModuleInfo
+               }
+
+type ParsedSource      = Located (HsModule RdrName)
+type RenamedSource     = HsGroup Name
+type TypecheckedSource = LHsBinds Id
+
+-- | This is the way to get access to parsed and typechecked source code
+-- for a module.  'checkModule' loads all the dependencies of the specified
+-- module in the Session, and then attempts to typecheck the module.  If
+-- successful, it returns the abstract syntax for the module.
+checkModule :: Session -> Module -> (Messages -> IO ()) 
+       -> IO (Maybe CheckedModule)
+checkModule session@(Session ref) mod msg_act = do
+       -- load up the dependencies first
+   r <- loadMsgs session (LoadDependenciesOf mod) msg_act
+   if (failed r) then return Nothing else do
+
+       -- now parse & typecheck the module
+   hsc_env <- readIORef ref   
+   let mg  = hsc_mod_graph hsc_env
+   case [ ms | ms <- mg, ms_mod ms == mod ] of
+       [] -> return Nothing
+       (ms:_) -> do 
+          -- Add in the OPTIONS from the source file This is nasty:
+          -- we've done this once already, in the compilation manager
+          -- It might be better to cache the flags in the
+          -- ml_hspp_file field, say
+          let dflags0 = hsc_dflags hsc_env
+              hspp_buf = expectJust "GHC.checkModule" (ms_hspp_buf ms)
+              opts = getOptionsFromStringBuffer hspp_buf
+          (dflags1,leftovers) <- parseDynamicFlags dflags0 (map snd opts)
+          if (not (null leftovers))
+               then do let filename = fromJust (ml_hs_file (ms_location ms))
+                       msg_act (optionsErrorMsgs leftovers opts filename)
+                       return Nothing
+               else do
+
+          r <- hscFileCheck hsc_env{hsc_dflags=dflags1} msg_act ms
+          case r of
+               HscFail -> 
+                  return Nothing
+               HscChecked parsed renamed Nothing ->
+                  return (Just (CheckedModule {
+                                       parsedSource = parsed,
+                                       renamedSource = renamed,
+                                       typecheckedSource = Nothing,
+                                       checkedModuleInfo = Nothing }))
+               HscChecked parsed renamed
+                          (Just (tc_binds, rdr_env, details)) -> do
+                  let minf = ModuleInfo {
+                               minf_type_env = md_types details,
+                               minf_exports  = md_exports details,
+                               minf_rdr_env  = Just rdr_env
+                             }
+                  return (Just (CheckedModule {
+                                       parsedSource = parsed,
+                                       renamedSource = renamed,
+                                       typecheckedSource = Just tc_binds,
+                                       checkedModuleInfo = Just minf }))
+
+-- ---------------------------------------------------------------------------
 -- Unloading
 
 unload :: HscEnv -> [Linkable] -> IO ()
@@ -797,27 +897,32 @@ upsweep
     -> HomePackageTable                -- HPT from last time round (pruned)
     -> ([Module],[Module])     -- stable modules (see checkStability)
     -> IO ()                   -- How to clean up unwanted tmp files
+    -> (Messages -> IO ())     -- Compiler error message callback
     -> [SCC ModSummary]                -- Mods to do (the worklist)
     -> IO (SuccessFlag,
            HscEnv,             -- With an updated HPT
            [ModSummary])       -- Mods which succeeded
 
-upsweep hsc_env old_hpt stable_mods cleanup
-     []
+upsweep hsc_env old_hpt stable_mods cleanup msg_act mods
+   = upsweep' hsc_env old_hpt stable_mods cleanup msg_act mods 1 (length mods)
+
+upsweep' hsc_env old_hpt stable_mods cleanup msg_act
+     [] _ _
    = return (Succeeded, hsc_env, [])
 
-upsweep hsc_env old_hpt stable_mods cleanup
-     (CyclicSCC ms:_)
+upsweep' hsc_env old_hpt stable_mods cleanup msg_act
+     (CyclicSCC ms:_) _ _
    = do putMsg (showSDoc (cyclicModuleErr ms))
         return (Failed, hsc_env, [])
 
-upsweep hsc_env old_hpt stable_mods cleanup
-     (AcyclicSCC mod:mods)
+upsweep' hsc_env old_hpt stable_mods cleanup msg_act
+     (AcyclicSCC mod:mods) mod_index nmods
    = do -- putStrLn ("UPSWEEP_MOD: hpt = " ++ 
        --           show (map (moduleUserString.moduleName.mi_module.hm_iface) 
        --                     (moduleEnvElts (hsc_HPT hsc_env)))
 
-        mb_mod_info <- upsweep_mod hsc_env old_hpt stable_mods mod 
+        mb_mod_info <- upsweep_mod hsc_env old_hpt stable_mods msg_act mod 
+                       mod_index nmods
 
        cleanup         -- Remove unwanted tmp files between compilations
 
@@ -841,7 +946,8 @@ upsweep hsc_env old_hpt stable_mods cleanup
                               | otherwise = delModuleEnv old_hpt this_mod
 
                ; (restOK, hsc_env2, modOKs) 
-                       <- upsweep hsc_env1 old_hpt1 stable_mods cleanup mods
+                       <- upsweep' hsc_env1 old_hpt1 stable_mods cleanup 
+                               msg_act mods (mod_index+1) nmods
                ; return (restOK, hsc_env2, mod:modOKs)
                }
 
@@ -851,10 +957,13 @@ upsweep hsc_env old_hpt stable_mods cleanup
 upsweep_mod :: HscEnv
             -> HomePackageTable
            -> ([Module],[Module])
+           -> (Messages -> IO ())
             -> ModSummary
+            -> Int  -- index of module
+            -> Int  -- total number of modules
             -> IO (Maybe HomeModInfo)  -- Nothing => Failed
 
-upsweep_mod hsc_env old_hpt (stable_obj, stable_bco) summary
+upsweep_mod hsc_env old_hpt (stable_obj, stable_bco) msg_act summary mod_index nmods
    = do 
         let 
            this_mod    = ms_mod summary
@@ -863,7 +972,8 @@ upsweep_mod hsc_env old_hpt (stable_obj, stable_bco) summary
            hs_date     = ms_hs_date summary
 
            compile_it :: Maybe Linkable -> IO (Maybe HomeModInfo)
-           compile_it  = upsweep_compile hsc_env old_hpt this_mod summary
+           compile_it  = upsweep_compile hsc_env old_hpt this_mod 
+                               msg_act summary mod_index nmods
 
        case ghcMode (hsc_dflags hsc_env) of
            BatchCompile ->
@@ -916,11 +1026,13 @@ upsweep_mod hsc_env old_hpt (stable_obj, stable_bco) summary
                    old_hmi = lookupModuleEnv old_hpt this_mod
 
 -- Run hsc to compile a module
-upsweep_compile hsc_env old_hpt this_mod summary mb_old_linkable = do
+upsweep_compile hsc_env old_hpt this_mod msg_act summary
+                mod_index nmods
+                mb_old_linkable = do
   let
        -- The old interface is ok if it's in the old HPT 
        --      a) we're compiling a source file, and the old HPT
-       --      entry is for a source file
+       --         entry is for a source file
        --      b) we're compiling a hs-boot file
        -- Case (b) allows an hs-boot file to get the interface of its
        -- real source file on the second iteration of the compilation
@@ -936,7 +1048,8 @@ upsweep_compile hsc_env old_hpt this_mod summary mb_old_linkable = do
                                   where 
                                     iface = hm_iface hm_info
 
-  compresult <- compile hsc_env summary mb_old_linkable mb_old_iface
+  compresult <- compile hsc_env msg_act summary mb_old_linkable mb_old_iface
+                        mod_index nmods
 
   case compresult of
         -- Compilation failed.  Compile may still have updated the PCS, tho.
@@ -1316,7 +1429,7 @@ preprocessFile dflags src_fn (Just (buf, time))
        let 
            local_opts = getOptionsFromStringBuffer buf
        --
-       (dflags', errs) <- parseDynamicFlags dflags local_opts
+       (dflags', errs) <- parseDynamicFlags dflags (map snd local_opts)
 
        let
            needs_preprocessing
@@ -1329,7 +1442,7 @@ preprocessFile dflags src_fn (Just (buf, time))
        when needs_preprocessing $
           ghcError (ProgramError "buffer needs preprocesing; interactive check disabled")
 
-       return (dflags', "<buffer>", buf)
+       return (dflags', src_fn, buf)
 
 
 -----------------------------------------------------------------------------
@@ -1400,39 +1513,12 @@ getBindings s = withSession s (return . nameEnvElts . ic_type_env . hsc_IC)
 getPrintUnqual :: Session -> IO PrintUnqualified
 getPrintUnqual s = withSession s (return . icPrintUnqual . hsc_IC)
 
-#ifdef GHCI
--- | Parses a string as an identifier, and returns the list of 'Name's that
--- the identifier can refer to in the current interactive context.
-parseName :: Session -> String -> IO [Name]
-parseName s str = withSession s $ \hsc_env -> do
-   maybe_rdr_name <- hscParseIdentifier (hsc_dflags hsc_env) str
-   case maybe_rdr_name of
-       Nothing -> return []
-       Just (L _ rdr_name) -> do
-           mb_names <- tcRnLookupRdrName hsc_env rdr_name
-           case mb_names of
-               Nothing -> return []
-               Just ns -> return ns
-               -- ToDo: should return error messages
-#endif
-
-allNamesInScope :: Session -> IO [Name]
-allNamesInScope s = withSession s $ \hsc_env -> do
-  eps <- readIORef (hsc_EPS hsc_env)
-  return (map gre_name (globalRdrEnvElts (ic_rn_gbl_env (hsc_IC hsc_env))))
-
--- | Returns the 'TyThing' for a 'Name'.  The 'Name' may refer to any
--- entity known to GHC, including 'Name's defined using 'runStmt'.
-lookupName :: Session -> Name -> IO (Maybe TyThing)
-lookupName s name = withSession s $ \hsc_env -> do
-  case lookupTypeEnv (ic_type_env (hsc_IC hsc_env)) name of
-       Just tt -> return (Just tt)
-       Nothing -> do
-           eps <- readIORef (hsc_EPS hsc_env)
-           return $! lookupType (hsc_HPT hsc_env) (eps_PTE eps) name
-
 -- | Container for information about a 'Module'.
-newtype ModuleInfo = ModuleInfo ModDetails
+data ModuleInfo = ModuleInfo {
+       minf_type_env :: TypeEnv,
+       minf_exports  :: NameSet,
+       minf_rdr_env  :: Maybe GlobalRdrEnv
+  }
        -- ToDo: this should really contain the ModIface too
        -- We don't want HomeModInfo here, because a ModuleInfo applies
        -- to package modules too.
@@ -1441,35 +1527,73 @@ newtype ModuleInfo = ModuleInfo ModDetails
 getModuleInfo :: Session -> Module -> IO (Maybe ModuleInfo)
 getModuleInfo s mdl = withSession s $ \hsc_env -> do
   case lookupModuleEnv (hsc_HPT hsc_env) mdl of
-    Nothing  -> return Nothing
-    Just hmi -> return (Just (ModuleInfo (hm_details hmi)))
+    Nothing  -> do
+#ifdef GHCI
+       mb_names <- getModuleExports hsc_env mdl
+       case mb_names of
+          Nothing -> return Nothing
+          Just names -> do
+               eps <- readIORef (hsc_EPS hsc_env)
+               let pte = eps_PTE eps
+                   tys = [ ty | name <- nameSetToList names,
+                                Just ty <- [lookupTypeEnv pte name] ]
+               return (Just (ModuleInfo {
+                               minf_type_env = mkTypeEnv tys,
+                               minf_exports  = names,
+                               minf_rdr_env  = Nothing
+                       }))
+#else
+       -- bogusly different for non-GHCI (ToDo)
+       return Nothing
+#endif
+    Just hmi -> 
+       let details = hm_details hmi in
+       return (Just (ModuleInfo {
+                       minf_type_env = md_types details,
+                       minf_exports  = md_exports details,
+                       minf_rdr_env  = mi_globals $! hm_iface hmi
+                       }))
+
        -- ToDo: we should be able to call getModuleInfo on a package module,
        -- even one that isn't loaded yet.
 
 -- | The list of top-level entities defined in a module
 modInfoTyThings :: ModuleInfo -> [TyThing]
-modInfoTyThings (ModuleInfo md) = typeEnvElts (md_types md)
+modInfoTyThings minf = typeEnvElts (minf_type_env minf)
+
+modInfoTopLevelScope :: ModuleInfo -> Maybe [Name]
+modInfoTopLevelScope minf
+  = fmap (map gre_name . globalRdrEnvElts) (minf_rdr_env minf)
+
+modInfoExports :: ModuleInfo -> [Name]
+modInfoExports minf = nameSetToList $! minf_exports minf
+
+modInfoPrintUnqualified :: ModuleInfo -> Maybe PrintUnqualified
+modInfoPrintUnqualified minf = fmap unQualInScope (minf_rdr_env minf)
 
 isDictonaryId :: Id -> Bool
 isDictonaryId id
   = case tcSplitSigmaTy (idType id) of { (tvs, theta, tau) -> isDictTy tau }
 
+-- | Looks up a global name: that is, any top-level name in any
+-- visible module.  Unlike 'lookupName', lookupGlobalName does not use
+-- the interactive context, and therefore does not require a preceding
+-- 'setContext'.
+lookupGlobalName :: Session -> Name -> IO (Maybe TyThing)
+lookupGlobalName s name = withSession s $ \hsc_env -> do
+   eps <- readIORef (hsc_EPS hsc_env)
+   return $! lookupType (hsc_HPT hsc_env) (eps_PTE eps) name
+
 #if 0
 
 data ObjectCode
   = ByteCode
   | BinaryCode FilePath
 
-type TypecheckedCode = HsTypecheckedGroup
-type RenamedCode     = [HsGroup Name]
-
 -- ToDo: typechecks abstract syntax or renamed abstract syntax.  Issues:
 --   - typechecked syntax includes extra dictionary translation and
 --     AbsBinds which need to be translated back into something closer to
 --     the original source.
---   - renamed syntax currently doesn't exist in a single blob, since
---     renaming and typechecking are interleaved at splice points.  We'd
---     need a restriction that there are no splices in the source module.
 
 -- ToDo:
 --   - Data and Typeable instances for HsSyn.
@@ -1500,10 +1624,6 @@ type RenamedCode     = [HsGroup Name]
 -- :browse will use either lm_toplev or inspect lm_interface, depending
 -- on whether the module is interpreted or not.
 
--- various abstract syntax types (perhaps IfaceBlah)
-data Type = ...
-data Kind = ...
-
 -- This is for reconstructing refactored source code
 -- Calls the lexer repeatedly.
 -- ToDo: add comment tokens to token stream
@@ -1581,6 +1701,35 @@ moduleIsInterpreted s modl = withSession s $ \h ->
 getInfo :: Session -> String -> IO [GetInfoResult]
 getInfo s id = withSession s $ \hsc_env -> hscGetInfo hsc_env id
 
+-- | Returns all names in scope in the current interactive context
+getNamesInScope :: Session -> IO [Name]
+getNamesInScope s = withSession s $ \hsc_env -> do
+  return (map gre_name (globalRdrEnvElts (ic_rn_gbl_env (hsc_IC hsc_env))))
+
+-- | Parses a string as an identifier, and returns the list of 'Name's that
+-- the identifier can refer to in the current interactive context.
+parseName :: Session -> String -> IO [Name]
+parseName s str = withSession s $ \hsc_env -> do
+   maybe_rdr_name <- hscParseIdentifier (hsc_dflags hsc_env) str
+   case maybe_rdr_name of
+       Nothing -> return []
+       Just (L _ rdr_name) -> do
+           mb_names <- tcRnLookupRdrName hsc_env rdr_name
+           case mb_names of
+               Nothing -> return []
+               Just ns -> return ns
+               -- ToDo: should return error messages
+
+-- | Returns the 'TyThing' for a 'Name'.  The 'Name' may refer to any
+-- entity known to GHC, including 'Name's defined using 'runStmt'.
+lookupName :: Session -> Name -> IO (Maybe TyThing)
+lookupName s name = withSession s $ \hsc_env -> do
+  case lookupTypeEnv (ic_type_env (hsc_IC hsc_env)) name of
+       Just tt -> return (Just tt)
+       Nothing -> do
+           eps <- readIORef (hsc_EPS hsc_env)
+           return $! lookupType (hsc_HPT hsc_env) (eps_PTE eps) name
+
 -- -----------------------------------------------------------------------------
 -- Getting the type of an expression