compiler/main/GHC.hs

   1 -- -----------------------------------------------------------------------------
   2 --
   3 -- (c) The University of Glasgow, 2005
   4 --
   5 -- The GHC API
   6 --
   7 -- -----------------------------------------------------------------------------
   8
   9 module GHC (
  10         -- * Initialisation
  11         Session,
  12         defaultErrorHandler,
  13         defaultCleanupHandler,
  14         newSession,
  15
  16         -- * Flags and settings
  17         DynFlags(..), DynFlag(..), Severity(..), HscTarget(..), dopt,
  18         GhcMode(..), GhcLink(..), defaultObjectTarget,
  19         parseDynamicFlags,
  20         getSessionDynFlags,
  21         setSessionDynFlags,
  22         parseStaticFlags,
  23
  24         -- * Targets
  25         Target(..), TargetId(..), Phase,
  26         setTargets,
  27         getTargets,
  28         addTarget,
  29         removeTarget,
  30         guessTarget,
  31
  32         -- * Extending the program scope
  33         extendGlobalRdrScope,  -- :: Session -> [GlobalRdrElt] -> IO ()
  34         setGlobalRdrScope,     -- :: Session -> [GlobalRdrElt] -> IO ()
  35         extendGlobalTypeScope, -- :: Session -> [Id] -> IO ()
  36         setGlobalTypeScope,    -- :: Session -> [Id] -> IO ()
  37
  38         -- * Loading\/compiling the program
  39         depanal,
  40         load, LoadHowMuch(..), SuccessFlag(..), -- also does depanal
  41         workingDirectoryChanged,
  42         checkModule, CheckedModule(..),
  43         TypecheckedSource, ParsedSource, RenamedSource,
  44         compileToCore,
  45
  46         -- * Parsing Haddock comments
  47         parseHaddockComment,
  48
  49         -- * Inspecting the module structure of the program
  50         ModuleGraph, ModSummary(..), ms_mod_name, ModLocation(..),
  51         getModuleGraph,
  52         isLoaded,
  53         topSortModuleGraph,
  54
  55         -- * Inspecting modules
  56         ModuleInfo,
  57         getModuleInfo,
  58         modInfoTyThings,
  59         modInfoTopLevelScope,
  60         modInfoExports,
  61         modInfoInstances,
  62         modInfoIsExportedName,
  63         modInfoLookupName,
  64         lookupGlobalName,
  65         mkPrintUnqualifiedForModule,
  66
  67         -- * Printing
  68         PrintUnqualified, alwaysQualify,
  69
  70         -- * Interactive evaluation
  71         getBindings, getPrintUnqual,
  72         findModule,
  73 #ifdef GHCI
  74         setContext, getContext,
  75         getNamesInScope,
  76         getRdrNamesInScope,
  77         moduleIsInterpreted,
  78         getInfo,
  79         exprType,
  80         typeKind,
  81         parseName,
  82         RunResult(..),
  83         runStmt, SingleStep(..),
  84         resume,
  85         Resume(resumeStmt, resumeThreadId, resumeBreakInfo, resumeSpan,
  86                resumeHistory, resumeHistoryIx),
  87         History(historyBreakInfo, historyEnclosingDecl),
  88         GHC.getHistorySpan, getHistoryModule,
  89         getResumeContext,
  90         abandon, abandonAll,
  91         InteractiveEval.back,
  92         InteractiveEval.forward,
  93         showModule,
  94         isModuleInterpreted,
  95         compileExpr, HValue, dynCompileExpr,
  96         lookupName,
  97         GHC.obtainTerm, GHC.obtainTerm1, GHC.obtainTermB, reconstructType,
  98         modInfoModBreaks,
  99         ModBreaks(..), BreakIndex,
 100         BreakInfo(breakInfo_number, breakInfo_module),
 101         BreakArray, setBreakOn, setBreakOff, getBreak,
 102 #endif
 103
 104         -- * Abstract syntax elements
 105
 106         -- ** Packages
 107         PackageId,
 108
 109         -- ** Modules
 110         Module, mkModule, pprModule, moduleName, modulePackageId,
 111         ModuleName, mkModuleName, moduleNameString,
 112
 113         -- ** Names
 114         Name,
 115         isExternalName, nameModule, pprParenSymName, nameSrcSpan,
 116         NamedThing(..),
 117         RdrName(Qual,Unqual),
 118
 119         -- ** Identifiers
 120         Id, idType,
 121         isImplicitId, isDeadBinder,
 122         isExportedId, isLocalId, isGlobalId,
 123         isRecordSelector,
 124         isPrimOpId, isFCallId, isClassOpId_maybe,
 125         isDataConWorkId, idDataCon,
 126         isBottomingId, isDictonaryId,
 127         recordSelectorFieldLabel,
 128
 129         -- ** Type constructors
 130         TyCon,
 131         tyConTyVars, tyConDataCons, tyConArity,
 132         isClassTyCon, isSynTyCon, isNewTyCon, isPrimTyCon, isFunTyCon,
 133         isOpenTyCon,
 134         synTyConDefn, synTyConType, synTyConResKind,
 135
 136         -- ** Type variables
 137         TyVar,
 138         alphaTyVars,
 139
 140         -- ** Data constructors
 141         DataCon,
 142         dataConSig, dataConType, dataConTyCon, dataConFieldLabels,
 143         dataConIsInfix, isVanillaDataCon,
 144         dataConStrictMarks,
 145         StrictnessMark(..), isMarkedStrict,
 146
 147         -- ** Classes
 148         Class,
 149         classMethods, classSCTheta, classTvsFds,
 150         pprFundeps,
 151
 152         -- ** Instances
 153         Instance,
 154         instanceDFunId, pprInstance, pprInstanceHdr,
 155
 156         -- ** Types and Kinds
 157         Type, splitForAllTys, funResultTy,
 158         pprParendType, pprTypeApp,
 159         Kind,
 160         PredType,
 161         ThetaType, pprThetaArrow,
 162
 163         -- ** Entities
 164         TyThing(..),
 165
 166         -- ** Syntax
 167         module HsSyn, -- ToDo: remove extraneous bits
 168
 169         -- ** Fixities
 170         FixityDirection(..),
 171         defaultFixity, maxPrecedence,
 172         negateFixity,
 173         compareFixity,
 174
 175         -- ** Source locations
 176         SrcLoc, pprDefnLoc,
 177         mkSrcLoc, isGoodSrcLoc, noSrcLoc,
 178         srcLocFile, srcLocLine, srcLocCol,
 179         SrcSpan,
 180         mkSrcSpan, srcLocSpan, isGoodSrcSpan, noSrcSpan,
 181         srcSpanStart, srcSpanEnd,
 182         srcSpanFile,
 183         srcSpanStartLine, srcSpanEndLine,
 184         srcSpanStartCol, srcSpanEndCol,
 185
 186         -- * Exceptions
 187         GhcException(..), showGhcException,
 188
 189         -- * Miscellaneous
 190         sessionHscEnv,
 191         cyclicModuleErr,
 192   ) where
 193
 194 {-
 195  ToDo:
 196
 197   * inline bits of HscMain here to simplify layering: hscTcExpr, hscStmt.
 198   * what StaticFlags should we expose, if any?
 199 -}
 200
 201 #include "HsVersions.h"
 202
 203 #ifdef GHCI
 204 import qualified Linker
 205 import Linker           ( HValue )
 206 import ByteCodeInstr
 207 import BreakArray
 208 import NameSet
 209 import InteractiveEval
 210 import TcRnDriver
 211 #endif
 212
 213 import TcIface
 214 import TcRnMonad        ( initIfaceCheck )
 215 import Packages
 216 import NameSet
 217 import RdrName
 218 import HsSyn
 219 import Type             hiding (typeKind)
 220 import TcType           hiding (typeKind)
 221 import Id
 222 import Var              hiding (setIdType)
 223 import TysPrim          ( alphaTyVars )
 224 import TyCon
 225 import Class
 226 import FunDeps
 227 import DataCon
 228 import Name             hiding ( varName )
 229 import OccName          ( parenSymOcc )
 230 import InstEnv          ( Instance, instanceDFunId, pprInstance, pprInstanceHdr )
 231 import SrcLoc
 232 import CoreSyn
 233 import DriverPipeline
 234 import DriverPhases     ( HscSource(..), Phase(..), isHaskellSrcFilename, startPhase )
 235 import HeaderInfo       ( getImports, getOptions )
 236 import Finder
 237 import HscMain          ( newHscEnv, hscFileCheck, HscChecked(..) )
 238 import HscTypes
 239 import DynFlags
 240 import StaticFlags
 241 import SysTools     ( initSysTools, cleanTempFiles, cleanTempFilesExcept,
 242                       cleanTempDirs )
 243 import Module
 244 import UniqFM
 245 import UniqSet
 246 import Unique
 247 import PackageConfig
 248 import FiniteMap
 249 import Panic
 250 import Digraph
 251 import Bag              ( unitBag, listToBag )
 252 import ErrUtils         ( Severity(..), showPass, fatalErrorMsg, debugTraceMsg,
 253                           mkPlainErrMsg, printBagOfErrors, printBagOfWarnings,
 254                           WarnMsg )
 255 import qualified ErrUtils
 256 import Util
 257 import StringBuffer     ( StringBuffer, hGetStringBuffer )
 258 import Outputable
 259 import BasicTypes
 260 import Maybes           ( expectJust, mapCatMaybes )
 261 import HaddockParse
 262 import HaddockLex       ( tokenise )
 263
 264 import Control.Concurrent
 265 import System.Directory ( getModificationTime, doesFileExist )
 266 import Data.Maybe
 267 import Data.List
 268 import qualified Data.List as List
 269 import Control.Monad
 270 import System.Exit      ( exitWith, ExitCode(..) )
 271 import System.Time      ( ClockTime )
 272 import Control.Exception as Exception hiding (handle)
 273 import Data.IORef
 274 import System.IO
 275 import System.IO.Error  ( try, isDoesNotExistError )
 276 import Prelude hiding (init)
 277
 278
 279 -- -----------------------------------------------------------------------------
 280 -- Exception handlers
 281
 282 -- | Install some default exception handlers and run the inner computation.
 283 -- Unless you want to handle exceptions yourself, you should wrap this around
 284 -- the top level of your program.  The default handlers output the error
 285 -- message(s) to stderr and exit cleanly.
 286 defaultErrorHandler :: DynFlags -> IO a -> IO a
 287 defaultErrorHandler dflags inner =
 288   -- top-level exception handler: any unrecognised exception is a compiler bug.
 289   handle (\exception -> do
 290            hFlush stdout
 291            case exception of
 292                 -- an IO exception probably isn't our fault, so don't panic
 293                 IOException _ ->
 294                   fatalErrorMsg dflags (text (show exception))
 295                 AsyncException StackOverflow ->
 296                   fatalErrorMsg dflags (text "stack overflow: use +RTS -K<size> to increase it")
 297                 _other ->
 298                   fatalErrorMsg dflags (text (show (Panic (show exception))))
 299            exitWith (ExitFailure 1)
 300          ) $
 301
 302   -- program errors: messages with locations attached.  Sometimes it is
 303   -- convenient to just throw these as exceptions.
 304   handleDyn (\dyn -> do printBagOfErrors dflags (unitBag dyn)
 305                         exitWith (ExitFailure 1)) $
 306
 307   -- error messages propagated as exceptions
 308   handleDyn (\dyn -> do
 309                 hFlush stdout
 310                 case dyn of
 311                      PhaseFailed _ code -> exitWith code
 312                      Interrupted -> exitWith (ExitFailure 1)
 313                      _ -> do fatalErrorMsg dflags (text (show (dyn :: GhcException)))
 314                              exitWith (ExitFailure 1)
 315             ) $
 316   inner
 317
 318 -- | Install a default cleanup handler to remove temporary files
 319 -- deposited by a GHC run.  This is seperate from
 320 -- 'defaultErrorHandler', because you might want to override the error
 321 -- handling, but still get the ordinary cleanup behaviour.
 322 defaultCleanupHandler :: DynFlags -> IO a -> IO a
 323 defaultCleanupHandler dflags inner =
 324     -- make sure we clean up after ourselves
 325     later (do cleanTempFiles dflags
 326               cleanTempDirs dflags
 327           )
 328           -- exceptions will be blocked while we clean the temporary files,
 329           -- so there shouldn't be any difficulty if we receive further
 330           -- signals.
 331     inner
 332
 333
 334 -- | Starts a new session.  A session consists of a set of loaded
 335 -- modules, a set of options (DynFlags), and an interactive context.
 336 newSession :: Maybe FilePath -> IO Session
 337 newSession mb_top_dir = do
 338   -- catch ^C
 339   main_thread <- myThreadId
 340   modifyMVar_ interruptTargetThread (return . (main_thread :))
 341   installSignalHandlers
 342
 343   initStaticOpts
 344   dflags0 <- initSysTools mb_top_dir defaultDynFlags
 345   dflags  <- initDynFlags dflags0
 346   env <- newHscEnv dflags
 347   ref <- newIORef env
 348   return (Session ref)
 349
 350 -- tmp: this breaks the abstraction, but required because DriverMkDepend
 351 -- needs to call the Finder.  ToDo: untangle this.
 352 sessionHscEnv :: Session -> IO HscEnv
 353 sessionHscEnv (Session ref) = readIORef ref
 354
 355 -- -----------------------------------------------------------------------------
 356 -- Flags & settings
 357
 358 -- | Grabs the DynFlags from the Session
 359 getSessionDynFlags :: Session -> IO DynFlags
 360 getSessionDynFlags s = withSession s (return . hsc_dflags)
 361
 362 -- | Updates the DynFlags in a Session.  This also reads
 363 -- the package database (unless it has already been read),
 364 -- and prepares the compilers knowledge about packages.  It
 365 -- can be called again to load new packages: just add new
 366 -- package flags to (packageFlags dflags).
 367 --
 368 -- Returns a list of new packages that may need to be linked in using
 369 -- the dynamic linker (see 'linkPackages') as a result of new package
 370 -- flags.  If you are not doing linking or doing static linking, you
 371 -- can ignore the list of packages returned.
 372 --
 373 setSessionDynFlags :: Session -> DynFlags -> IO [PackageId]
 374 setSessionDynFlags (Session ref) dflags = do
 375   hsc_env <- readIORef ref
 376   (dflags', preload) <- initPackages dflags
 377   writeIORef ref $! hsc_env{ hsc_dflags = dflags' }
 378   return preload
 379
 380 -- | If there is no -o option, guess the name of target executable
 381 -- by using top-level source file name as a base.
 382 guessOutputFile :: Session -> IO ()
 383 guessOutputFile s = modifySession s $ \env ->
 384     let dflags = hsc_dflags env
 385         mod_graph = hsc_mod_graph env
 386         mainModuleSrcPath, guessedName :: Maybe String
 387         mainModuleSrcPath = do
 388             let isMain = (== mainModIs dflags) . ms_mod
 389             [ms] <- return (filter isMain mod_graph)
 390             ml_hs_file (ms_location ms)
 391         guessedName = fmap basenameOf mainModuleSrcPath
 392     in
 393     case outputFile dflags of
 394         Just _ -> env
 395         Nothing -> env { hsc_dflags = dflags { outputFile = guessedName } }
 396
 397 -- -----------------------------------------------------------------------------
 398 -- Targets
 399
 400 -- ToDo: think about relative vs. absolute file paths. And what
 401 -- happens when the current directory changes.
 402
 403 -- | Sets the targets for this session.  Each target may be a module name
 404 -- or a filename.  The targets correspond to the set of root modules for
 405 -- the program\/library.  Unloading the current program is achieved by
 406 -- setting the current set of targets to be empty, followed by load.
 407 setTargets :: Session -> [Target] -> IO ()
 408 setTargets s targets = modifySession s (\h -> h{ hsc_targets = targets })
 409
 410 -- | returns the current set of targets
 411 getTargets :: Session -> IO [Target]
 412 getTargets s = withSession s (return . hsc_targets)
 413
 414 -- | Add another target
 415 addTarget :: Session -> Target -> IO ()
 416 addTarget s target
 417   = modifySession s (\h -> h{ hsc_targets = target : hsc_targets h })
 418
 419 -- | Remove a target
 420 removeTarget :: Session -> TargetId -> IO ()
 421 removeTarget s target_id
 422   = modifySession s (\h -> h{ hsc_targets = filter (hsc_targets h) })
 423   where
 424    filter targets = [ t | t@(Target id _) <- targets, id /= target_id ]
 425
 426 -- Attempts to guess what Target a string refers to.  This function implements
 427 -- the --make/GHCi command-line syntax for filenames:
 428 --
 429 --      - if the string looks like a Haskell source filename, then interpret
 430 --        it as such
 431 --      - if adding a .hs or .lhs suffix yields the name of an existing file,
 432 --        then use that
 433 --      - otherwise interpret the string as a module name
 434 --
 435 guessTarget :: String -> Maybe Phase -> IO Target
 436 guessTarget file (Just phase)
 437    = return (Target (TargetFile file (Just phase)) Nothing)
 438 guessTarget file Nothing
 439    | isHaskellSrcFilename file
 440    = return (Target (TargetFile file Nothing) Nothing)
 441    | otherwise
 442    = do exists <- doesFileExist hs_file
 443         if exists
 444            then return (Target (TargetFile hs_file Nothing) Nothing)
 445            else do
 446         exists <- doesFileExist lhs_file
 447         if exists
 448            then return (Target (TargetFile lhs_file Nothing) Nothing)
 449            else do
 450         return (Target (TargetModule (mkModuleName file)) Nothing)
 451      where
 452          hs_file  = file `joinFileExt` "hs"
 453          lhs_file = file `joinFileExt` "lhs"
 454
 455 -- -----------------------------------------------------------------------------
 456 -- Extending the program scope
 457
 458 extendGlobalRdrScope :: Session -> [GlobalRdrElt] -> IO ()
 459 extendGlobalRdrScope session rdrElts
 460     = modifySession session $ \hscEnv ->
 461       let global_rdr = hsc_global_rdr_env hscEnv
 462       in hscEnv{ hsc_global_rdr_env = foldl extendGlobalRdrEnv global_rdr rdrElts }
 463
 464 setGlobalRdrScope :: Session -> [GlobalRdrElt] -> IO ()
 465 setGlobalRdrScope session rdrElts
 466     = modifySession session $ \hscEnv ->
 467       hscEnv{ hsc_global_rdr_env = foldl extendGlobalRdrEnv emptyGlobalRdrEnv rdrElts }
 468
 469 extendGlobalTypeScope :: Session -> [Id] -> IO ()
 470 extendGlobalTypeScope session ids
 471     = modifySession session $ \hscEnv ->
 472       let global_type = hsc_global_type_env hscEnv
 473       in hscEnv{ hsc_global_type_env = extendTypeEnvWithIds global_type ids }
 474
 475 setGlobalTypeScope :: Session -> [Id] -> IO ()
 476 setGlobalTypeScope session ids
 477     = modifySession session $ \hscEnv ->
 478       hscEnv{ hsc_global_type_env = extendTypeEnvWithIds emptyTypeEnv ids }
 479
 480 -- -----------------------------------------------------------------------------
 481 -- Parsing Haddock comments
 482
 483 parseHaddockComment :: String -> Either String (HsDoc RdrName)
 484 parseHaddockComment string = parseHaddockParagraphs (tokenise string)
 485
 486 -- -----------------------------------------------------------------------------
 487 -- Loading the program
 488
 489 -- Perform a dependency analysis starting from the current targets
 490 -- and update the session with the new module graph.
 491 depanal :: Session -> [ModuleName] -> Bool -> IO (Maybe ModuleGraph)
 492 depanal (Session ref) excluded_mods allow_dup_roots = do
 493   hsc_env <- readIORef ref
 494   let
 495          dflags  = hsc_dflags hsc_env
 496          targets = hsc_targets hsc_env
 497          old_graph = hsc_mod_graph hsc_env
 498
 499   showPass dflags "Chasing dependencies"
 500   debugTraceMsg dflags 2 (hcat [
 501              text "Chasing modules from: ",
 502              hcat (punctuate comma (map pprTarget targets))])
 503
 504   r <- downsweep hsc_env old_graph excluded_mods allow_dup_roots
 505   case r of
 506     Just mod_graph -> writeIORef ref hsc_env{ hsc_mod_graph = mod_graph }
 507     _ -> return ()
 508   return r
 509
 510 {-
 511 -- | The result of load.
 512 data LoadResult
 513   = LoadOk      Errors  -- ^ all specified targets were loaded successfully.
 514   | LoadFailed  Errors  -- ^ not all modules were loaded.
 515
 516 type Errors = [String]
 517
 518 data ErrMsg = ErrMsg {
 519         errMsgSeverity  :: Severity,  -- warning, error, etc.
 520         errMsgSpans     :: [SrcSpan],
 521         errMsgShortDoc  :: Doc,
 522         errMsgExtraInfo :: Doc
 523         }
 524 -}
 525
 526 data LoadHowMuch
 527    = LoadAllTargets
 528    | LoadUpTo ModuleName
 529    | LoadDependenciesOf ModuleName
 530
 531 -- | Try to load the program.  If a Module is supplied, then just
 532 -- attempt to load up to this target.  If no Module is supplied,
 533 -- then try to load all targets.
 534 load :: Session -> LoadHowMuch -> IO SuccessFlag
 535 load s@(Session ref) how_much
 536    = do
 537         -- Dependency analysis first.  Note that this fixes the module graph:
 538         -- even if we don't get a fully successful upsweep, the full module
 539         -- graph is still retained in the Session.  We can tell which modules
 540         -- were successfully loaded by inspecting the Session's HPT.
 541         mb_graph <- depanal s [] False
 542         case mb_graph of
 543            Just mod_graph -> catchingFailure $ load2 s how_much mod_graph
 544            Nothing        -> return Failed
 545     where catchingFailure f = f `Exception.catch` \e -> do
 546               hsc_env <- readIORef ref
 547               -- trac #1565 / test ghci021:
 548               -- let bindings may explode if we try to use them after
 549               -- failing to reload
 550               writeIORef ref $! hsc_env{ hsc_IC = emptyInteractiveContext }
 551               throw e
 552
 553 load2 :: Session -> LoadHowMuch -> [ModSummary] -> IO SuccessFlag
 554 load2 s@(Session ref) how_much mod_graph = do
 555         guessOutputFile s
 556         hsc_env <- readIORef ref
 557
 558         let hpt1      = hsc_HPT hsc_env
 559         let dflags    = hsc_dflags hsc_env
 560
 561         -- The "bad" boot modules are the ones for which we have
 562         -- B.hs-boot in the module graph, but no B.hs
 563         -- The downsweep should have ensured this does not happen
 564         -- (see msDeps)
 565         let all_home_mods = [ms_mod_name s
 566                             | s <- mod_graph, not (isBootSummary s)]
 567             bad_boot_mods = [s        | s <- mod_graph, isBootSummary s,
 568                                         not (ms_mod_name s `elem` all_home_mods)]
 569         ASSERT( null bad_boot_mods ) return ()
 570
 571         -- mg2_with_srcimps drops the hi-boot nodes, returning a
 572         -- graph with cycles.  Among other things, it is used for
 573         -- backing out partially complete cycles following a failed
 574         -- upsweep, and for removing from hpt all the modules
 575         -- not in strict downwards closure, during calls to compile.
 576         let mg2_with_srcimps :: [SCC ModSummary]
 577             mg2_with_srcimps = topSortModuleGraph True mod_graph Nothing
 578
 579         -- If we can determine that any of the {-# SOURCE #-} imports
 580         -- are definitely unnecessary, then emit a warning.
 581         warnUnnecessarySourceImports dflags mg2_with_srcimps
 582
 583         let
 584             -- check the stability property for each module.
 585             stable_mods@(stable_obj,stable_bco)
 586                 = checkStability hpt1 mg2_with_srcimps all_home_mods
 587
 588             -- prune bits of the HPT which are definitely redundant now,
 589             -- to save space.
 590             pruned_hpt = pruneHomePackageTable hpt1
 591                                 (flattenSCCs mg2_with_srcimps)
 592                                 stable_mods
 593
 594         evaluate pruned_hpt
 595
 596         debugTraceMsg dflags 2 (text "Stable obj:" <+> ppr stable_obj $$
 597                                 text "Stable BCO:" <+> ppr stable_bco)
 598
 599         -- Unload any modules which are going to be re-linked this time around.
 600         let stable_linkables = [ linkable
 601                                | m <- stable_obj++stable_bco,
 602                                  Just hmi <- [lookupUFM pruned_hpt m],
 603                                  Just linkable <- [hm_linkable hmi] ]
 604         unload hsc_env stable_linkables
 605
 606         -- We could at this point detect cycles which aren't broken by
 607         -- a source-import, and complain immediately, but it seems better
 608         -- to let upsweep_mods do this, so at least some useful work gets
 609         -- done before the upsweep is abandoned.
 610         --hPutStrLn stderr "after tsort:\n"
 611         --hPutStrLn stderr (showSDoc (vcat (map ppr mg2)))
 612
 613         -- Now do the upsweep, calling compile for each module in
 614         -- turn.  Final result is version 3 of everything.
 615
 616         -- Topologically sort the module graph, this time including hi-boot
 617         -- nodes, and possibly just including the portion of the graph
 618         -- reachable from the module specified in the 2nd argument to load.
 619         -- This graph should be cycle-free.
 620         -- If we're restricting the upsweep to a portion of the graph, we
 621         -- also want to retain everything that is still stable.
 622         let full_mg :: [SCC ModSummary]
 623             full_mg    = topSortModuleGraph False mod_graph Nothing
 624
 625             maybe_top_mod = case how_much of
 626                                 LoadUpTo m           -> Just m
 627                                 LoadDependenciesOf m -> Just m
 628                                 _                    -> Nothing
 629
 630             partial_mg0 :: [SCC ModSummary]
 631             partial_mg0 = topSortModuleGraph False mod_graph maybe_top_mod
 632
 633             -- LoadDependenciesOf m: we want the upsweep to stop just
 634             -- short of the specified module (unless the specified module
 635             -- is stable).
 636             partial_mg
 637                 | LoadDependenciesOf _mod <- how_much
 638                 = ASSERT( case last partial_mg0 of
 639                             AcyclicSCC ms -> ms_mod_name ms == _mod; _ -> False )
 640                   List.init partial_mg0
 641                 | otherwise
 642                 = partial_mg0
 643
 644             stable_mg =
 645                 [ AcyclicSCC ms
 646                 | AcyclicSCC ms <- full_mg,
 647                   ms_mod_name ms `elem` stable_obj++stable_bco,
 648                   ms_mod_name ms `notElem` [ ms_mod_name ms' |
 649                                                 AcyclicSCC ms' <- partial_mg ] ]
 650
 651             mg = stable_mg ++ partial_mg
 652
 653         -- clean up between compilations
 654         let cleanup = cleanTempFilesExcept dflags
 655                           (ppFilesFromSummaries (flattenSCCs mg2_with_srcimps))
 656
 657         debugTraceMsg dflags 2 (hang (text "Ready for upsweep")
 658                                    2 (ppr mg))
 659         (upsweep_ok, hsc_env1, modsUpswept)
 660            <- upsweep (hsc_env { hsc_HPT = emptyHomePackageTable })
 661                            pruned_hpt stable_mods cleanup mg
 662
 663         -- Make modsDone be the summaries for each home module now
 664         -- available; this should equal the domain of hpt3.
 665         -- Get in in a roughly top .. bottom order (hence reverse).
 666
 667         let modsDone = reverse modsUpswept
 668
 669         -- Try and do linking in some form, depending on whether the
 670         -- upsweep was completely or only partially successful.
 671
 672         if succeeded upsweep_ok
 673
 674          then
 675            -- Easy; just relink it all.
 676            do debugTraceMsg dflags 2 (text "Upsweep completely successful.")
 677
 678               -- Clean up after ourselves
 679               cleanTempFilesExcept dflags (ppFilesFromSummaries modsDone)
 680
 681               -- Issue a warning for the confusing case where the user
 682               -- said '-o foo' but we're not going to do any linking.
 683               -- We attempt linking if either (a) one of the modules is
 684               -- called Main, or (b) the user said -no-hs-main, indicating
 685               -- that main() is going to come from somewhere else.
 686               --
 687               let ofile = outputFile dflags
 688               let no_hs_main = dopt Opt_NoHsMain dflags
 689               let
 690                 main_mod = mainModIs dflags
 691                 a_root_is_Main = any ((==main_mod).ms_mod) mod_graph
 692                 do_linking = a_root_is_Main || no_hs_main
 693
 694               when (ghcLink dflags == LinkBinary
 695                     && isJust ofile && not do_linking) $
 696                 debugTraceMsg dflags 1 $
 697                     text ("Warning: output was redirected with -o, " ++
 698                           "but no output will be generated\n" ++
 699                           "because there is no " ++
 700                           moduleNameString (moduleName main_mod) ++ " module.")
 701
 702               -- link everything together
 703               linkresult <- link (ghcLink dflags) dflags do_linking (hsc_HPT hsc_env1)
 704
 705               loadFinish Succeeded linkresult ref hsc_env1
 706
 707          else
 708            -- Tricky.  We need to back out the effects of compiling any
 709            -- half-done cycles, both so as to clean up the top level envs
 710            -- and to avoid telling the interactive linker to link them.
 711            do debugTraceMsg dflags 2 (text "Upsweep partially successful.")
 712
 713               let modsDone_names
 714                      = map ms_mod modsDone
 715               let mods_to_zap_names
 716                      = findPartiallyCompletedCycles modsDone_names
 717                           mg2_with_srcimps
 718               let mods_to_keep
 719                      = filter ((`notElem` mods_to_zap_names).ms_mod)
 720                           modsDone
 721
 722               let hpt4 = retainInTopLevelEnvs (map ms_mod_name mods_to_keep)
 723                                               (hsc_HPT hsc_env1)
 724
 725               -- Clean up after ourselves
 726               cleanTempFilesExcept dflags (ppFilesFromSummaries mods_to_keep)
 727
 728               -- there should be no Nothings where linkables should be, now
 729               ASSERT(all (isJust.hm_linkable)
 730                         (eltsUFM (hsc_HPT hsc_env))) do
 731
 732               -- Link everything together
 733               linkresult <- link (ghcLink dflags) dflags False hpt4
 734
 735               let hsc_env4 = hsc_env1{ hsc_HPT = hpt4 }
 736               loadFinish Failed linkresult ref hsc_env4
 737
 738 -- Finish up after a load.
 739
 740 -- If the link failed, unload everything and return.
 741 loadFinish :: SuccessFlag -> SuccessFlag -> IORef HscEnv -> HscEnv -> IO SuccessFlag
 742 loadFinish _all_ok Failed ref hsc_env
 743   = do unload hsc_env []
 744        writeIORef ref $! discardProg hsc_env
 745        return Failed
 746
 747 -- Empty the interactive context and set the module context to the topmost
 748 -- newly loaded module, or the Prelude if none were loaded.
 749 loadFinish all_ok Succeeded ref hsc_env
 750   = do writeIORef ref $! hsc_env{ hsc_IC = emptyInteractiveContext }
 751        return all_ok
 752
 753
 754 -- Forget the current program, but retain the persistent info in HscEnv
 755 discardProg :: HscEnv -> HscEnv
 756 discardProg hsc_env
 757   = hsc_env { hsc_mod_graph = emptyMG,
 758               hsc_IC = emptyInteractiveContext,
 759               hsc_HPT = emptyHomePackageTable }
 760
 761 -- used to fish out the preprocess output files for the purposes of
 762 -- cleaning up.  The preprocessed file *might* be the same as the
 763 -- source file, but that doesn't do any harm.
 764 ppFilesFromSummaries :: [ModSummary] -> [FilePath]
 765 ppFilesFromSummaries summaries = map ms_hspp_file summaries
 766
 767 -- -----------------------------------------------------------------------------
 768 -- Check module
 769
 770 data CheckedModule =
 771   CheckedModule { parsedSource      :: ParsedSource,
 772                   renamedSource     :: Maybe RenamedSource,
 773                   typecheckedSource :: Maybe TypecheckedSource,
 774                   checkedModuleInfo :: Maybe ModuleInfo,
 775                   coreBinds         :: Maybe [CoreBind]
 776                 }
 777         -- ToDo: improvements that could be made here:
 778         --  if the module succeeded renaming but not typechecking,
 779         --  we can still get back the GlobalRdrEnv and exports, so
 780         --  perhaps the ModuleInfo should be split up into separate
 781         --  fields within CheckedModule.
 782
 783 type ParsedSource      = Located (HsModule RdrName)
 784 type RenamedSource     = (HsGroup Name, [LImportDecl Name], Maybe [LIE Name],
 785                           Maybe (HsDoc Name), HaddockModInfo Name)
 786 type TypecheckedSource = LHsBinds Id
 787
 788 -- NOTE:
 789 --   - things that aren't in the output of the typechecker right now:
 790 --     - the export list
 791 --     - the imports
 792 --     - type signatures
 793 --     - type/data/newtype declarations
 794 --     - class declarations
 795 --     - instances
 796 --   - extra things in the typechecker's output:
 797 --     - default methods are turned into top-level decls.
 798 --     - dictionary bindings
 799
 800
 801 -- | This is the way to get access to parsed and typechecked source code
 802 -- for a module.  'checkModule' attempts to typecheck the module.  If
 803 -- successful, it returns the abstract syntax for the module.
 804 -- If compileToCore is true, it also desugars the module and returns the
 805 -- resulting Core bindings as a component of the CheckedModule.
 806 checkModule :: Session -> ModuleName -> Bool -> IO (Maybe CheckedModule)
 807 checkModule (Session ref) mod compileToCore = do
 808         -- parse & typecheck the module
 809    hsc_env <- readIORef ref
 810    let mg  = hsc_mod_graph hsc_env
 811    case [ ms | ms <- mg, ms_mod_name ms == mod ] of
 812         [] -> return Nothing
 813         (ms:_) -> do
 814            mbChecked <- hscFileCheck
 815                           hsc_env{hsc_dflags=ms_hspp_opts ms}
 816                           ms compileToCore
 817            case mbChecked of
 818              Nothing -> return Nothing
 819              Just (HscChecked parsed renamed Nothing _) ->
 820                    return (Just (CheckedModule {
 821                                         parsedSource = parsed,
 822                                         renamedSource = renamed,
 823                                         typecheckedSource = Nothing,
 824                                         checkedModuleInfo = Nothing,
 825                                         coreBinds = Nothing }))
 826              Just (HscChecked parsed renamed
 827                            (Just (tc_binds, rdr_env, details))
 828                            maybeCoreBinds) -> do
 829                    let minf = ModuleInfo {
 830                                 minf_type_env  = md_types details,
 831                                 minf_exports   = availsToNameSet $
 832                                                      md_exports details,
 833                                 minf_rdr_env   = Just rdr_env,
 834                                 minf_instances = md_insts details
 835 #ifdef GHCI
 836                                ,minf_modBreaks = emptyModBreaks
 837 #endif
 838                               }
 839                    return (Just (CheckedModule {
 840                                         parsedSource = parsed,
 841                                         renamedSource = renamed,
 842                                         typecheckedSource = Just tc_binds,
 843                                         checkedModuleInfo = Just minf,
 844                                         coreBinds = maybeCoreBinds}))
 845
 846 -- | This is the way to get access to the Core bindings corresponding
 847 -- to a module. 'compileToCore' invokes 'checkModule' to parse, typecheck, and
 848 -- desugar the module, then returns the resulting list of Core bindings if
 849 -- successful.
 850 compileToCore :: Session -> FilePath -> IO (Maybe [CoreBind])
 851 compileToCore session fn = do
 852    -- First, set the target to the desired filename
 853    target <- guessTarget fn Nothing
 854    addTarget session target
 855    load session LoadAllTargets
 856    -- Then find dependencies
 857    maybeModGraph <- depanal session [] True
 858    case maybeModGraph of
 859      Nothing -> return Nothing
 860      Just modGraph -> do
 861         let modSummary = expectJust "compileToCore" $
 862                           find ((== fn) . msHsFilePath) modGraph
 863         -- Now we have the module name;
 864         -- parse, typecheck and desugar the module
 865         let mod = ms_mod_name modSummary
 866         maybeCheckedModule <- checkModule session mod True
 867         case maybeCheckedModule of
 868              Nothing -> return Nothing
 869              Just checkedMod -> return $ coreBinds checkedMod
 870  -- ---------------------------------------------------------------------------
 871 -- Unloading
 872
 873 unload :: HscEnv -> [Linkable] -> IO ()
 874 unload hsc_env stable_linkables -- Unload everthing *except* 'stable_linkables'
 875   = case ghcLink (hsc_dflags hsc_env) of
 876 #ifdef GHCI
 877         LinkInMemory -> Linker.unload (hsc_dflags hsc_env) stable_linkables
 878 #else
 879         LinkInMemory -> panic "unload: no interpreter"
 880                                 -- urgh.  avoid warnings:
 881                                 hsc_env stable_linkables
 882 #endif
 883         _other -> return ()
 884
 885 -- -----------------------------------------------------------------------------
 886 -- checkStability
 887
 888 {-
 889   Stability tells us which modules definitely do not need to be recompiled.
 890   There are two main reasons for having stability:
 891
 892    - avoid doing a complete upsweep of the module graph in GHCi when
 893      modules near the bottom of the tree have not changed.
 894
 895    - to tell GHCi when it can load object code: we can only load object code
 896      for a module when we also load object code fo  all of the imports of the
 897      module.  So we need to know that we will definitely not be recompiling
 898      any of these modules, and we can use the object code.
 899
 900   The stability check is as follows.  Both stableObject and
 901   stableBCO are used during the upsweep phase later.
 902
 903   -------------------
 904   stable m = stableObject m || stableBCO m
 905
 906   stableObject m =
 907         all stableObject (imports m)
 908         && old linkable does not exist, or is == on-disk .o
 909         && date(on-disk .o) > date(.hs)
 910
 911   stableBCO m =
 912         all stable (imports m)
 913         && date(BCO) > date(.hs)
 914   -------------------
 915
 916   These properties embody the following ideas:
 917
 918     - if a module is stable, then:
 919         - if it has been compiled in a previous pass (present in HPT)
 920           then it does not need to be compiled or re-linked.
 921         - if it has not been compiled in a previous pass,
 922           then we only need to read its .hi file from disk and
 923           link it to produce a ModDetails.
 924
 925     - if a modules is not stable, we will definitely be at least
 926       re-linking, and possibly re-compiling it during the upsweep.
 927       All non-stable modules can (and should) therefore be unlinked
 928       before the upsweep.
 929
 930     - Note that objects are only considered stable if they only depend
 931       on other objects.  We can't link object code against byte code.
 932 -}
 933
 934 checkStability
 935         :: HomePackageTable             -- HPT from last compilation
 936         -> [SCC ModSummary]             -- current module graph (cyclic)
 937         -> [ModuleName]                 -- all home modules
 938         -> ([ModuleName],               -- stableObject
 939             [ModuleName])               -- stableBCO
 940
 941 checkStability hpt sccs all_home_mods = foldl checkSCC ([],[]) sccs
 942   where
 943    checkSCC (stable_obj, stable_bco) scc0
 944      | stableObjects = (scc_mods ++ stable_obj, stable_bco)
 945      | stableBCOs    = (stable_obj, scc_mods ++ stable_bco)
 946      | otherwise     = (stable_obj, stable_bco)
 947      where
 948         scc = flattenSCC scc0
 949         scc_mods = map ms_mod_name scc
 950         home_module m   = m `elem` all_home_mods && m `notElem` scc_mods
 951
 952         scc_allimps = nub (filter home_module (concatMap ms_allimps scc))
 953             -- all imports outside the current SCC, but in the home pkg
 954
 955         stable_obj_imps = map (`elem` stable_obj) scc_allimps
 956         stable_bco_imps = map (`elem` stable_bco) scc_allimps
 957
 958         stableObjects =
 959            and stable_obj_imps
 960            && all object_ok scc
 961
 962         stableBCOs =
 963            and (zipWith (||) stable_obj_imps stable_bco_imps)
 964            && all bco_ok scc
 965
 966         object_ok ms
 967           | Just t <- ms_obj_date ms  =  t >= ms_hs_date ms
 968                                          && same_as_prev t
 969           | otherwise = False
 970           where
 971              same_as_prev t = case lookupUFM hpt (ms_mod_name ms) of
 972                                 Just hmi  | Just l <- hm_linkable hmi
 973                                  -> isObjectLinkable l && t == linkableTime l
 974                                 _other  -> True
 975                 -- why '>=' rather than '>' above?  If the filesystem stores
 976                 -- times to the nearset second, we may occasionally find that
 977                 -- the object & source have the same modification time,
 978                 -- especially if the source was automatically generated
 979                 -- and compiled.  Using >= is slightly unsafe, but it matches
 980                 -- make's behaviour.
 981
 982         bco_ok ms
 983           = case lookupUFM hpt (ms_mod_name ms) of
 984                 Just hmi  | Just l <- hm_linkable hmi ->
 985                         not (isObjectLinkable l) &&
 986                         linkableTime l >= ms_hs_date ms
 987                 _other  -> False
 988
 989 ms_allimps :: ModSummary -> [ModuleName]
 990 ms_allimps ms = map unLoc (ms_srcimps ms ++ ms_imps ms)
 991
 992 -- -----------------------------------------------------------------------------
 993 -- Prune the HomePackageTable
 994
 995 -- Before doing an upsweep, we can throw away:
 996 --
 997 --   - For non-stable modules:
 998 --      - all ModDetails, all linked code
 999 --   - all unlinked code that is out of date with respect to
1000 --     the source file
1001 --
1002 -- This is VERY IMPORTANT otherwise we'll end up requiring 2x the
1003 -- space at the end of the upsweep, because the topmost ModDetails of the
1004 -- old HPT holds on to the entire type environment from the previous
1005 -- compilation.
1006
1007 pruneHomePackageTable
1008    :: HomePackageTable
1009    -> [ModSummary]
1010    -> ([ModuleName],[ModuleName])
1011    -> HomePackageTable
1012
1013 pruneHomePackageTable hpt summ (stable_obj, stable_bco)
1014   = mapUFM prune hpt
1015   where prune hmi
1016           | is_stable modl = hmi'
1017           | otherwise      = hmi'{ hm_details = emptyModDetails }
1018           where
1019            modl = moduleName (mi_module (hm_iface hmi))
1020            hmi' | Just l <- hm_linkable hmi, linkableTime l < ms_hs_date ms
1021                 = hmi{ hm_linkable = Nothing }
1022                 | otherwise
1023                 = hmi
1024                 where ms = expectJust "prune" (lookupUFM ms_map modl)
1025
1026         ms_map = listToUFM [(ms_mod_name ms, ms) | ms <- summ]
1027
1028         is_stable m = m `elem` stable_obj || m `elem` stable_bco
1029
1030 -- -----------------------------------------------------------------------------
1031
1032 -- Return (names of) all those in modsDone who are part of a cycle
1033 -- as defined by theGraph.
1034 findPartiallyCompletedCycles :: [Module] -> [SCC ModSummary] -> [Module]
1035 findPartiallyCompletedCycles modsDone theGraph
1036    = chew theGraph
1037      where
1038         chew [] = []
1039         chew ((AcyclicSCC _):rest) = chew rest    -- acyclic?  not interesting.
1040         chew ((CyclicSCC vs):rest)
1041            = let names_in_this_cycle = nub (map ms_mod vs)
1042                  mods_in_this_cycle
1043                     = nub ([done | done <- modsDone,
1044                                    done `elem` names_in_this_cycle])
1045                  chewed_rest = chew rest
1046              in
1047              if   notNull mods_in_this_cycle
1048                   && length mods_in_this_cycle < length names_in_this_cycle
1049              then mods_in_this_cycle ++ chewed_rest
1050              else chewed_rest
1051
1052 -- -----------------------------------------------------------------------------
1053 -- The upsweep
1054
1055 -- This is where we compile each module in the module graph, in a pass
1056 -- from the bottom to the top of the graph.
1057
1058 -- There better had not be any cyclic groups here -- we check for them.
1059
1060 upsweep
1061     :: HscEnv                   -- Includes initially-empty HPT
1062     -> HomePackageTable         -- HPT from last time round (pruned)
1063     -> ([ModuleName],[ModuleName]) -- stable modules (see checkStability)
1064     -> IO ()                    -- How to clean up unwanted tmp files
1065     -> [SCC ModSummary]         -- Mods to do (the worklist)
1066     -> IO (SuccessFlag,
1067            HscEnv,              -- With an updated HPT
1068            [ModSummary])        -- Mods which succeeded
1069
1070 upsweep hsc_env old_hpt stable_mods cleanup sccs = do
1071    (res, hsc_env, done) <- upsweep' hsc_env old_hpt [] sccs 1 (length sccs)
1072    return (res, hsc_env, reverse done)
1073  where
1074
1075   upsweep' hsc_env _old_hpt done
1076      [] _ _
1077    = return (Succeeded, hsc_env, done)
1078
1079   upsweep' hsc_env _old_hpt done
1080      (CyclicSCC ms:_) _ _
1081    = do fatalErrorMsg (hsc_dflags hsc_env) (cyclicModuleErr ms)
1082         return (Failed, hsc_env, done)
1083
1084   upsweep' hsc_env old_hpt done
1085      (AcyclicSCC mod:mods) mod_index nmods
1086    = do -- putStrLn ("UPSWEEP_MOD: hpt = " ++
1087         --           show (map (moduleUserString.moduleName.mi_module.hm_iface)
1088         --                     (moduleEnvElts (hsc_HPT hsc_env)))
1089
1090         mb_mod_info <- upsweep_mod hsc_env old_hpt stable_mods mod
1091                        mod_index nmods
1092
1093         cleanup         -- Remove unwanted tmp files between compilations
1094
1095         case mb_mod_info of
1096             Nothing -> return (Failed, hsc_env, [])
1097             Just mod_info -> do
1098                 let this_mod = ms_mod_name mod
1099
1100                         -- Add new info to hsc_env
1101                     hpt1     = addToUFM (hsc_HPT hsc_env) this_mod mod_info
1102                     hsc_env1 = hsc_env { hsc_HPT = hpt1 }
1103
1104                         -- Space-saving: delete the old HPT entry
1105                         -- for mod BUT if mod is a hs-boot
1106                         -- node, don't delete it.  For the
1107                         -- interface, the HPT entry is probaby for the
1108                         -- main Haskell source file.  Deleting it
1109                         -- would force the real module to be recompiled
1110                         -- every time.
1111                     old_hpt1 | isBootSummary mod = old_hpt
1112                              | otherwise = delFromUFM old_hpt this_mod
1113
1114                     done' = mod:done
1115
1116                         -- fixup our HomePackageTable after we've finished compiling
1117                         -- a mutually-recursive loop.  See reTypecheckLoop, below.
1118                 hsc_env2 <- reTypecheckLoop hsc_env1 mod done'
1119
1120                 upsweep' hsc_env2 old_hpt1 done' mods (mod_index+1) nmods
1121
1122
1123 -- Compile a single module.  Always produce a Linkable for it if
1124 -- successful.  If no compilation happened, return the old Linkable.
1125 upsweep_mod :: HscEnv
1126             -> HomePackageTable
1127             -> ([ModuleName],[ModuleName])
1128             -> ModSummary
1129             -> Int  -- index of module
1130             -> Int  -- total number of modules
1131             -> IO (Maybe HomeModInfo)   -- Nothing => Failed
1132
1133 upsweep_mod hsc_env old_hpt (stable_obj, stable_bco) summary mod_index nmods
1134    =    let
1135             this_mod_name = ms_mod_name summary
1136             this_mod    = ms_mod summary
1137             mb_obj_date = ms_obj_date summary
1138             obj_fn      = ml_obj_file (ms_location summary)
1139             hs_date     = ms_hs_date summary
1140
1141             is_stable_obj = this_mod_name `elem` stable_obj
1142             is_stable_bco = this_mod_name `elem` stable_bco
1143
1144             old_hmi = lookupUFM old_hpt this_mod_name
1145
1146             -- We're using the dflags for this module now, obtained by
1147             -- applying any options in its LANGUAGE & OPTIONS_GHC pragmas.
1148             dflags = ms_hspp_opts summary
1149             prevailing_target = hscTarget (hsc_dflags hsc_env)
1150             local_target      = hscTarget dflags
1151
1152             -- If OPTIONS_GHC contains -fasm or -fvia-C, be careful that
1153             -- we don't do anything dodgy: these should only work to change
1154             -- from -fvia-C to -fasm and vice-versa, otherwise we could
1155             -- end up trying to link object code to byte code.
1156             target = if prevailing_target /= local_target
1157                         && (not (isObjectTarget prevailing_target)
1158                             || not (isObjectTarget local_target))
1159                         then prevailing_target
1160                         else local_target
1161
1162             -- store the corrected hscTarget into the summary
1163             summary' = summary{ ms_hspp_opts = dflags { hscTarget = target } }
1164
1165             -- The old interface is ok if
1166             --  a) we're compiling a source file, and the old HPT
1167             --     entry is for a source file
1168             --  b) we're compiling a hs-boot file
1169             -- Case (b) allows an hs-boot file to get the interface of its
1170             -- real source file on the second iteration of the compilation
1171             -- manager, but that does no harm.  Otherwise the hs-boot file
1172             -- will always be recompiled
1173
1174             mb_old_iface
1175                 = case old_hmi of
1176                      Nothing                              -> Nothing
1177                      Just hm_info | isBootSummary summary -> Just iface
1178                                   | not (mi_boot iface)   -> Just iface
1179                                   | otherwise             -> Nothing
1180                                    where
1181                                      iface = hm_iface hm_info
1182
1183             compile_it :: Maybe Linkable -> IO (Maybe HomeModInfo)
1184             compile_it  = compile hsc_env summary' mod_index nmods mb_old_iface
1185
1186             compile_it_discard_iface
1187                         = compile hsc_env summary' mod_index nmods Nothing
1188
1189         in
1190         case target of
1191
1192             _any
1193                 -- Regardless of whether we're generating object code or
1194                 -- byte code, we can always use an existing object file
1195                 -- if it is *stable* (see checkStability).
1196                 | is_stable_obj, isJust old_hmi ->
1197                         return old_hmi
1198                         -- object is stable, and we have an entry in the
1199                         -- old HPT: nothing to do
1200
1201                 | is_stable_obj, isNothing old_hmi -> do
1202                         linkable <- findObjectLinkable this_mod obj_fn
1203                                         (expectJust "upseep1" mb_obj_date)
1204                         compile_it (Just linkable)
1205                         -- object is stable, but we need to load the interface
1206                         -- off disk to make a HMI.
1207
1208             HscInterpreted
1209                 | is_stable_bco ->
1210                         ASSERT(isJust old_hmi) -- must be in the old_hpt
1211                         return old_hmi
1212                         -- BCO is stable: nothing to do
1213
1214                 | Just hmi <- old_hmi,
1215                   Just l <- hm_linkable hmi, not (isObjectLinkable l),
1216                   linkableTime l >= ms_hs_date summary ->
1217                         compile_it (Just l)
1218                         -- we have an old BCO that is up to date with respect
1219                         -- to the source: do a recompilation check as normal.
1220
1221                 | otherwise ->
1222                         compile_it Nothing
1223                         -- no existing code at all: we must recompile.
1224
1225               -- When generating object code, if there's an up-to-date
1226               -- object file on the disk, then we can use it.
1227               -- However, if the object file is new (compared to any
1228               -- linkable we had from a previous compilation), then we
1229               -- must discard any in-memory interface, because this
1230               -- means the user has compiled the source file
1231               -- separately and generated a new interface, that we must
1232               -- read from the disk.
1233               --
1234             obj | isObjectTarget obj,
1235                   Just obj_date <- mb_obj_date, obj_date >= hs_date -> do
1236                      case old_hmi of
1237                         Just hmi
1238                           | Just l <- hm_linkable hmi,
1239                             isObjectLinkable l && linkableTime l == obj_date
1240                             -> compile_it (Just l)
1241                         _otherwise -> do
1242                           linkable <- findObjectLinkable this_mod obj_fn obj_date
1243                           compile_it_discard_iface (Just linkable)
1244
1245             _otherwise ->
1246                   compile_it Nothing
1247
1248
1249
1250 -- Filter modules in the HPT
1251 retainInTopLevelEnvs :: [ModuleName] -> HomePackageTable -> HomePackageTable
1252 retainInTopLevelEnvs keep_these hpt
1253    = listToUFM   [ (mod, expectJust "retain" mb_mod_info)
1254                  | mod <- keep_these
1255                  , let mb_mod_info = lookupUFM hpt mod
1256                  , isJust mb_mod_info ]
1257
1258 -- ---------------------------------------------------------------------------
1259 -- Typecheck module loops
1260
1261 {-
1262 See bug #930.  This code fixes a long-standing bug in --make.  The
1263 problem is that when compiling the modules *inside* a loop, a data
1264 type that is only defined at the top of the loop looks opaque; but
1265 after the loop is done, the structure of the data type becomes
1266 apparent.
1267
1268 The difficulty is then that two different bits of code have
1269 different notions of what the data type looks like.
1270
1271 The idea is that after we compile a module which also has an .hs-boot
1272 file, we re-generate the ModDetails for each of the modules that
1273 depends on the .hs-boot file, so that everyone points to the proper
1274 TyCons, Ids etc. defined by the real module, not the boot module.
1275 Fortunately re-generating a ModDetails from a ModIface is easy: the
1276 function TcIface.typecheckIface does exactly that.
1277
1278 Picking the modules to re-typecheck is slightly tricky.  Starting from
1279 the module graph consisting of the modules that have already been
1280 compiled, we reverse the edges (so they point from the imported module
1281 to the importing module), and depth-first-search from the .hs-boot
1282 node.  This gives us all the modules that depend transitively on the
1283 .hs-boot module, and those are exactly the modules that we need to
1284 re-typecheck.
1285
1286 Following this fix, GHC can compile itself with --make -O2.
1287 -}
1288
1289 reTypecheckLoop :: HscEnv -> ModSummary -> ModuleGraph -> IO HscEnv
1290 reTypecheckLoop hsc_env ms graph
1291   | not (isBootSummary ms) &&
1292     any (\m -> ms_mod m == this_mod && isBootSummary m) graph
1293   = do
1294         let mss = reachableBackwards (ms_mod_name ms) graph
1295             non_boot = filter (not.isBootSummary) mss
1296         debugTraceMsg (hsc_dflags hsc_env) 2 $
1297            text "Re-typechecking loop: " <> ppr (map ms_mod_name non_boot)
1298         typecheckLoop hsc_env (map ms_mod_name non_boot)
1299   | otherwise
1300   = return hsc_env
1301  where
1302   this_mod = ms_mod ms
1303
1304 typecheckLoop :: HscEnv -> [ModuleName] -> IO HscEnv
1305 typecheckLoop hsc_env mods = do
1306   new_hpt <-
1307     fixIO $ \new_hpt -> do
1308       let new_hsc_env = hsc_env{ hsc_HPT = new_hpt }
1309       mds <- initIfaceCheck new_hsc_env $
1310                 mapM (typecheckIface . hm_iface) hmis
1311       let new_hpt = addListToUFM old_hpt
1312                         (zip mods [ hmi{ hm_details = details }
1313                                   | (hmi,details) <- zip hmis mds ])
1314       return new_hpt
1315   return hsc_env{ hsc_HPT = new_hpt }
1316   where
1317     old_hpt = hsc_HPT hsc_env
1318     hmis    = map (expectJust "typecheckLoop" . lookupUFM old_hpt) mods
1319
1320 reachableBackwards :: ModuleName -> [ModSummary] -> [ModSummary]
1321 reachableBackwards mod summaries
1322   = [ ms | (ms,_,_) <- map vertex_fn nodes_we_want ]
1323   where
1324         -- all the nodes reachable by traversing the edges backwards
1325         -- from the root node:
1326         nodes_we_want = reachable (transposeG graph) root
1327
1328         -- the rest just sets up the graph:
1329         (nodes, lookup_key) = moduleGraphNodes False summaries
1330         (graph, vertex_fn, key_fn) = graphFromEdges' nodes
1331         root
1332           | Just key <- lookup_key HsBootFile mod, Just v <- key_fn key = v
1333           | otherwise = panic "reachableBackwards"
1334
1335 -- ---------------------------------------------------------------------------
1336 -- Topological sort of the module graph
1337
1338 topSortModuleGraph
1339           :: Bool               -- Drop hi-boot nodes? (see below)
1340           -> [ModSummary]
1341           -> Maybe ModuleName
1342           -> [SCC ModSummary]
1343 -- Calculate SCCs of the module graph, possibly dropping the hi-boot nodes
1344 -- The resulting list of strongly-connected-components is in topologically
1345 -- sorted order, starting with the module(s) at the bottom of the
1346 -- dependency graph (ie compile them first) and ending with the ones at
1347 -- the top.
1348 --
1349 -- Drop hi-boot nodes (first boolean arg)?
1350 --
1351 --   False:     treat the hi-boot summaries as nodes of the graph,
1352 --              so the graph must be acyclic
1353 --
1354 --   True:      eliminate the hi-boot nodes, and instead pretend
1355 --              the a source-import of Foo is an import of Foo
1356 --              The resulting graph has no hi-boot nodes, but can by cyclic
1357
1358 topSortModuleGraph drop_hs_boot_nodes summaries Nothing
1359   = stronglyConnComp (fst (moduleGraphNodes drop_hs_boot_nodes summaries))
1360 topSortModuleGraph drop_hs_boot_nodes summaries (Just mod)
1361   = stronglyConnComp (map vertex_fn (reachable graph root))
1362   where
1363         -- restrict the graph to just those modules reachable from
1364         -- the specified module.  We do this by building a graph with
1365         -- the full set of nodes, and determining the reachable set from
1366         -- the specified node.
1367         (nodes, lookup_key) = moduleGraphNodes drop_hs_boot_nodes summaries
1368         (graph, vertex_fn, key_fn) = graphFromEdges' nodes
1369         root
1370           | Just key <- lookup_key HsSrcFile mod, Just v <- key_fn key = v
1371           | otherwise  = throwDyn (ProgramError "module does not exist")
1372
1373 moduleGraphNodes :: Bool -> [ModSummary]
1374   -> ([(ModSummary, Int, [Int])], HscSource -> ModuleName -> Maybe Int)
1375 moduleGraphNodes drop_hs_boot_nodes summaries = (nodes, lookup_key)
1376    where
1377         -- Drop hs-boot nodes by using HsSrcFile as the key
1378         hs_boot_key | drop_hs_boot_nodes = HsSrcFile
1379                     | otherwise          = HsBootFile
1380
1381         -- We use integers as the keys for the SCC algorithm
1382         nodes :: [(ModSummary, Int, [Int])]
1383         nodes = [(s, expectJust "topSort" $
1384                         lookup_key (ms_hsc_src s) (ms_mod_name s),
1385                      out_edge_keys hs_boot_key (map unLoc (ms_srcimps s)) ++
1386                      out_edge_keys HsSrcFile   (map unLoc (ms_imps s)) ++
1387                      (-- see [boot-edges] below
1388                       if drop_hs_boot_nodes || ms_hsc_src s == HsBootFile
1389                         then []
1390                         else case lookup_key HsBootFile (ms_mod_name s) of
1391                                 Nothing -> []
1392                                 Just k  -> [k])
1393                  )
1394                 | s <- summaries
1395                 , not (isBootSummary s && drop_hs_boot_nodes) ]
1396                 -- Drop the hi-boot ones if told to do so
1397
1398         -- [boot-edges] if this is a .hs and there is an equivalent
1399         -- .hs-boot, add a link from the former to the latter.  This
1400         -- has the effect of detecting bogus cases where the .hs-boot
1401         -- depends on the .hs, by introducing a cycle.  Additionally,
1402         -- it ensures that we will always process the .hs-boot before
1403         -- the .hs, and so the HomePackageTable will always have the
1404         -- most up to date information.
1405
1406         key_map :: NodeMap Int
1407         key_map = listToFM ([(moduleName (ms_mod s), ms_hsc_src s)
1408                             | s <- summaries]
1409                            `zip` [1..])
1410
1411         lookup_key :: HscSource -> ModuleName -> Maybe Int
1412         lookup_key hs_src mod = lookupFM key_map (mod, hs_src)
1413
1414         out_edge_keys :: HscSource -> [ModuleName] -> [Int]
1415         out_edge_keys hi_boot ms = mapCatMaybes (lookup_key hi_boot) ms
1416                 -- If we want keep_hi_boot_nodes, then we do lookup_key with
1417                 -- the IsBootInterface parameter True; else False
1418
1419
1420 type NodeKey   = (ModuleName, HscSource)  -- The nodes of the graph are
1421 type NodeMap a = FiniteMap NodeKey a      -- keyed by (mod, src_file_type) pairs
1422
1423 msKey :: ModSummary -> NodeKey
1424 msKey (ModSummary { ms_mod = mod, ms_hsc_src = boot }) = (moduleName mod,boot)
1425
1426 mkNodeMap :: [ModSummary] -> NodeMap ModSummary
1427 mkNodeMap summaries = listToFM [ (msKey s, s) | s <- summaries]
1428
1429 nodeMapElts :: NodeMap a -> [a]
1430 nodeMapElts = eltsFM
1431
1432 -- If there are {-# SOURCE #-} imports between strongly connected
1433 -- components in the topological sort, then those imports can
1434 -- definitely be replaced by ordinary non-SOURCE imports: if SOURCE
1435 -- were necessary, then the edge would be part of a cycle.
1436 warnUnnecessarySourceImports :: DynFlags -> [SCC ModSummary] -> IO ()
1437 warnUnnecessarySourceImports dflags sccs =
1438   printBagOfWarnings dflags (listToBag (concat (map (check.flattenSCC) sccs)))
1439   where check ms =
1440            let mods_in_this_cycle = map ms_mod_name ms in
1441            [ warn i | m <- ms, i <- ms_srcimps m,
1442                         unLoc i `notElem`  mods_in_this_cycle ]
1443
1444         warn :: Located ModuleName -> WarnMsg
1445         warn (L loc mod) =
1446            mkPlainErrMsg loc
1447                 (ptext SLIT("Warning: {-# SOURCE #-} unnecessary in import of ")
1448                  <+> quotes (ppr mod))
1449
1450 -----------------------------------------------------------------------------
1451 -- Downsweep (dependency analysis)
1452
1453 -- Chase downwards from the specified root set, returning summaries
1454 -- for all home modules encountered.  Only follow source-import
1455 -- links.
1456
1457 -- We pass in the previous collection of summaries, which is used as a
1458 -- cache to avoid recalculating a module summary if the source is
1459 -- unchanged.
1460 --
1461 -- The returned list of [ModSummary] nodes has one node for each home-package
1462 -- module, plus one for any hs-boot files.  The imports of these nodes
1463 -- are all there, including the imports of non-home-package modules.
1464
1465 downsweep :: HscEnv
1466           -> [ModSummary]       -- Old summaries
1467           -> [ModuleName]       -- Ignore dependencies on these; treat
1468                                 -- them as if they were package modules
1469           -> Bool               -- True <=> allow multiple targets to have
1470                                 --          the same module name; this is
1471                                 --          very useful for ghc -M
1472           -> IO (Maybe [ModSummary])
1473                 -- The elts of [ModSummary] all have distinct
1474                 -- (Modules, IsBoot) identifiers, unless the Bool is true
1475                 -- in which case there can be repeats
1476 downsweep hsc_env old_summaries excl_mods allow_dup_roots
1477    = -- catch error messages and return them
1478      handleDyn (\err_msg -> printBagOfErrors (hsc_dflags hsc_env) (unitBag err_msg) >> return Nothing) $ do
1479        rootSummaries <- mapM getRootSummary roots
1480        let root_map = mkRootMap rootSummaries
1481        checkDuplicates root_map
1482        summs <- loop (concatMap msDeps rootSummaries) root_map
1483        return (Just summs)
1484      where
1485         roots = hsc_targets hsc_env
1486
1487         old_summary_map :: NodeMap ModSummary
1488         old_summary_map = mkNodeMap old_summaries
1489
1490         getRootSummary :: Target -> IO ModSummary
1491         getRootSummary (Target (TargetFile file mb_phase) maybe_buf)
1492            = do exists <- doesFileExist file
1493                 if exists
1494                     then summariseFile hsc_env old_summaries file mb_phase maybe_buf
1495                     else throwDyn $ mkPlainErrMsg noSrcSpan $
1496                            text "can't find file:" <+> text file
1497         getRootSummary (Target (TargetModule modl) maybe_buf)
1498            = do maybe_summary <- summariseModule hsc_env old_summary_map False
1499                                            (L rootLoc modl) maybe_buf excl_mods
1500                 case maybe_summary of
1501                    Nothing -> packageModErr modl
1502                    Just s  -> return s
1503
1504         rootLoc = mkGeneralSrcSpan FSLIT("<command line>")
1505
1506         -- In a root module, the filename is allowed to diverge from the module
1507         -- name, so we have to check that there aren't multiple root files
1508         -- defining the same module (otherwise the duplicates will be silently
1509         -- ignored, leading to confusing behaviour).
1510         checkDuplicates :: NodeMap [ModSummary] -> IO ()
1511         checkDuplicates root_map
1512            | allow_dup_roots = return ()
1513            | null dup_roots  = return ()
1514            | otherwise       = multiRootsErr (head dup_roots)
1515            where
1516              dup_roots :: [[ModSummary]]        -- Each at least of length 2
1517              dup_roots = filterOut isSingleton (nodeMapElts root_map)
1518
1519         loop :: [(Located ModuleName,IsBootInterface)]
1520                         -- Work list: process these modules
1521              -> NodeMap [ModSummary]
1522                         -- Visited set; the range is a list because
1523                         -- the roots can have the same module names
1524                         -- if allow_dup_roots is True
1525              -> IO [ModSummary]
1526                         -- The result includes the worklist, except
1527                         -- for those mentioned in the visited set
1528         loop [] done      = return (concat (nodeMapElts done))
1529         loop ((wanted_mod, is_boot) : ss) done
1530           | Just summs <- lookupFM done key
1531           = if isSingleton summs then
1532                 loop ss done
1533             else
1534                 do { multiRootsErr summs; return [] }
1535           | otherwise         = do { mb_s <- summariseModule hsc_env old_summary_map
1536                                                  is_boot wanted_mod Nothing excl_mods
1537                                    ; case mb_s of
1538                                         Nothing -> loop ss done
1539                                         Just s  -> loop (msDeps s ++ ss)
1540                                                         (addToFM done key [s]) }
1541           where
1542             key = (unLoc wanted_mod, if is_boot then HsBootFile else HsSrcFile)
1543
1544 mkRootMap :: [ModSummary] -> NodeMap [ModSummary]
1545 mkRootMap summaries = addListToFM_C (++) emptyFM
1546                         [ (msKey s, [s]) | s <- summaries ]
1547
1548 msDeps :: ModSummary -> [(Located ModuleName, IsBootInterface)]
1549 -- (msDeps s) returns the dependencies of the ModSummary s.
1550 -- A wrinkle is that for a {-# SOURCE #-} import we return
1551 --      *both* the hs-boot file
1552 --      *and* the source file
1553 -- as "dependencies".  That ensures that the list of all relevant
1554 -- modules always contains B.hs if it contains B.hs-boot.
1555 -- Remember, this pass isn't doing the topological sort.  It's
1556 -- just gathering the list of all relevant ModSummaries
1557 msDeps s =
1558     concat [ [(m,True), (m,False)] | m <- ms_srcimps s ]
1559          ++ [ (m,False) | m <- ms_imps s ]
1560
1561 -----------------------------------------------------------------------------
1562 -- Summarising modules
1563
1564 -- We have two types of summarisation:
1565 --
1566 --    * Summarise a file.  This is used for the root module(s) passed to
1567 --      cmLoadModules.  The file is read, and used to determine the root
1568 --      module name.  The module name may differ from the filename.
1569 --
1570 --    * Summarise a module.  We are given a module name, and must provide
1571 --      a summary.  The finder is used to locate the file in which the module
1572 --      resides.
1573
1574 summariseFile
1575         :: HscEnv
1576         -> [ModSummary]                 -- old summaries
1577         -> FilePath                     -- source file name
1578         -> Maybe Phase                  -- start phase
1579         -> Maybe (StringBuffer,ClockTime)
1580         -> IO ModSummary
1581
1582 summariseFile hsc_env old_summaries file mb_phase maybe_buf
1583         -- we can use a cached summary if one is available and the
1584         -- source file hasn't changed,  But we have to look up the summary
1585         -- by source file, rather than module name as we do in summarise.
1586    | Just old_summary <- findSummaryBySourceFile old_summaries file
1587    = do
1588         let location = ms_location old_summary
1589
1590                 -- return the cached summary if the source didn't change
1591         src_timestamp <- case maybe_buf of
1592                            Just (_,t) -> return t
1593                            Nothing    -> getModificationTime file
1594                 -- The file exists; we checked in getRootSummary above.
1595                 -- If it gets removed subsequently, then this
1596                 -- getModificationTime may fail, but that's the right
1597                 -- behaviour.
1598
1599         if ms_hs_date old_summary == src_timestamp
1600            then do -- update the object-file timestamp
1601                   obj_timestamp <- getObjTimestamp location False
1602                   return old_summary{ ms_obj_date = obj_timestamp }
1603            else
1604                 new_summary
1605
1606    | otherwise
1607    = new_summary
1608   where
1609     new_summary = do
1610         let dflags = hsc_dflags hsc_env
1611
1612         (dflags', hspp_fn, buf)
1613             <- preprocessFile dflags file mb_phase maybe_buf
1614
1615         (srcimps,the_imps, L _ mod_name) <- getImports dflags' buf hspp_fn file
1616
1617         -- Make a ModLocation for this file
1618         location <- mkHomeModLocation dflags mod_name file
1619
1620         -- Tell the Finder cache where it is, so that subsequent calls
1621         -- to findModule will find it, even if it's not on any search path
1622         mod <- addHomeModuleToFinder hsc_env mod_name location
1623
1624         src_timestamp <- case maybe_buf of
1625                            Just (_,t) -> return t
1626                            Nothing    -> getModificationTime file
1627                         -- getMofificationTime may fail
1628
1629         obj_timestamp <- modificationTimeIfExists (ml_obj_file location)
1630
1631         return (ModSummary { ms_mod = mod, ms_hsc_src = HsSrcFile,
1632                              ms_location = location,
1633                              ms_hspp_file = hspp_fn,
1634                              ms_hspp_opts = dflags',
1635                              ms_hspp_buf  = Just buf,
1636                              ms_srcimps = srcimps, ms_imps = the_imps,
1637                              ms_hs_date = src_timestamp,
1638                              ms_obj_date = obj_timestamp })
1639
1640 findSummaryBySourceFile :: [ModSummary] -> FilePath -> Maybe ModSummary
1641 findSummaryBySourceFile summaries file
1642   = case [ ms | ms <- summaries, HsSrcFile <- [ms_hsc_src ms],
1643                                  expectJust "findSummaryBySourceFile" (ml_hs_file (ms_location ms)) == file ] of
1644         [] -> Nothing
1645         (x:_) -> Just x
1646
1647 -- Summarise a module, and pick up source and timestamp.
1648 summariseModule
1649           :: HscEnv
1650           -> NodeMap ModSummary -- Map of old summaries
1651           -> IsBootInterface    -- True <=> a {-# SOURCE #-} import
1652           -> Located ModuleName -- Imported module to be summarised
1653           -> Maybe (StringBuffer, ClockTime)
1654           -> [ModuleName]               -- Modules to exclude
1655           -> IO (Maybe ModSummary)      -- Its new summary
1656
1657 summariseModule hsc_env old_summary_map is_boot (L loc wanted_mod) maybe_buf excl_mods
1658   | wanted_mod `elem` excl_mods
1659   = return Nothing
1660
1661   | Just old_summary <- lookupFM old_summary_map (wanted_mod, hsc_src)
1662   = do          -- Find its new timestamp; all the
1663                 -- ModSummaries in the old map have valid ml_hs_files
1664         let location = ms_location old_summary
1665             src_fn = expectJust "summariseModule" (ml_hs_file location)
1666
1667                 -- check the modification time on the source file, and
1668                 -- return the cached summary if it hasn't changed.  If the
1669                 -- file has disappeared, we need to call the Finder again.
1670         case maybe_buf of
1671            Just (_,t) -> check_timestamp old_summary location src_fn t
1672            Nothing    -> do
1673                 m <- System.IO.Error.try (getModificationTime src_fn)
1674                 case m of
1675                    Right t -> check_timestamp old_summary location src_fn t
1676                    Left e | isDoesNotExistError e -> find_it
1677                           | otherwise             -> ioError e
1678
1679   | otherwise  = find_it
1680   where
1681     dflags = hsc_dflags hsc_env
1682
1683     hsc_src = if is_boot then HsBootFile else HsSrcFile
1684
1685     check_timestamp old_summary location src_fn src_timestamp
1686         | ms_hs_date old_summary == src_timestamp = do
1687                 -- update the object-file timestamp
1688                 obj_timestamp <- getObjTimestamp location is_boot
1689                 return (Just old_summary{ ms_obj_date = obj_timestamp })
1690         | otherwise =
1691                 -- source changed: re-summarise.
1692                 new_summary location (ms_mod old_summary) src_fn src_timestamp
1693
1694     find_it = do
1695         -- Don't use the Finder's cache this time.  If the module was
1696         -- previously a package module, it may have now appeared on the
1697         -- search path, so we want to consider it to be a home module.  If
1698         -- the module was previously a home module, it may have moved.
1699         uncacheModule hsc_env wanted_mod
1700         found <- findImportedModule hsc_env wanted_mod Nothing
1701         case found of
1702              Found location mod
1703                 | isJust (ml_hs_file location) ->
1704                         -- Home package
1705                          just_found location mod
1706                 | otherwise ->
1707                         -- Drop external-pkg
1708                         ASSERT(modulePackageId mod /= thisPackage dflags)
1709                         return Nothing
1710                 where
1711
1712              err -> noModError dflags loc wanted_mod err
1713                         -- Not found
1714
1715     just_found location mod = do
1716                 -- Adjust location to point to the hs-boot source file,
1717                 -- hi file, object file, when is_boot says so
1718         let location' | is_boot   = addBootSuffixLocn location
1719                       | otherwise = location
1720             src_fn = expectJust "summarise2" (ml_hs_file location')
1721
1722                 -- Check that it exists
1723                 -- It might have been deleted since the Finder last found it
1724         maybe_t <- modificationTimeIfExists src_fn
1725         case maybe_t of
1726           Nothing -> noHsFileErr loc src_fn
1727           Just t  -> new_summary location' mod src_fn t
1728
1729
1730     new_summary location mod src_fn src_timestamp
1731       = do
1732         -- Preprocess the source file and get its imports
1733         -- The dflags' contains the OPTIONS pragmas
1734         (dflags', hspp_fn, buf) <- preprocessFile dflags src_fn Nothing maybe_buf
1735         (srcimps, the_imps, L mod_loc mod_name) <- getImports dflags' buf hspp_fn src_fn
1736
1737         when (mod_name /= wanted_mod) $
1738                 throwDyn $ mkPlainErrMsg mod_loc $
1739                               text "file name does not match module name"
1740                               <+> quotes (ppr mod_name)
1741
1742                 -- Find the object timestamp, and return the summary
1743         obj_timestamp <- getObjTimestamp location is_boot
1744
1745         return (Just ( ModSummary { ms_mod       = mod,
1746                                     ms_hsc_src   = hsc_src,
1747                                     ms_location  = location,
1748                                     ms_hspp_file = hspp_fn,
1749                                     ms_hspp_opts = dflags',
1750                                     ms_hspp_buf  = Just buf,
1751                                     ms_srcimps   = srcimps,
1752                                     ms_imps      = the_imps,
1753                                     ms_hs_date   = src_timestamp,
1754                                     ms_obj_date  = obj_timestamp }))
1755
1756
1757 getObjTimestamp :: ModLocation -> Bool -> IO (Maybe ClockTime)
1758 getObjTimestamp location is_boot
1759   = if is_boot then return Nothing
1760                else modificationTimeIfExists (ml_obj_file location)
1761
1762
1763 preprocessFile :: DynFlags -> FilePath -> Maybe Phase -> Maybe (StringBuffer,ClockTime)
1764   -> IO (DynFlags, FilePath, StringBuffer)
1765 preprocessFile dflags src_fn mb_phase Nothing
1766   = do
1767         (dflags', hspp_fn) <- preprocess dflags (src_fn, mb_phase)
1768         buf <- hGetStringBuffer hspp_fn
1769         return (dflags', hspp_fn, buf)
1770
1771 preprocessFile dflags src_fn mb_phase (Just (buf, _time))
1772   = do
1773         -- case we bypass the preprocessing stage?
1774         let
1775             local_opts = getOptions buf src_fn
1776         --
1777         (dflags', _errs) <- parseDynamicFlags dflags (map unLoc local_opts)
1778         -- XXX: shouldn't we be reporting the errors?
1779
1780         let
1781             needs_preprocessing
1782                 | Just (Unlit _) <- mb_phase    = True
1783                 | Nothing <- mb_phase, Unlit _ <- startPhase src_fn  = True
1784                   -- note: local_opts is only required if there's no Unlit phase
1785                 | dopt Opt_Cpp dflags'          = True
1786                 | dopt Opt_Pp  dflags'          = True
1787                 | otherwise                     = False
1788
1789         when needs_preprocessing $
1790            ghcError (ProgramError "buffer needs preprocesing; interactive check disabled")
1791
1792         return (dflags', src_fn, buf)
1793
1794
1795 -----------------------------------------------------------------------------
1796 --                      Error messages
1797 -----------------------------------------------------------------------------
1798
1799 noModError :: DynFlags -> SrcSpan -> ModuleName -> FindResult -> IO ab
1800 -- ToDo: we don't have a proper line number for this error
1801 noModError dflags loc wanted_mod err
1802   = throwDyn $ mkPlainErrMsg loc $ cannotFindModule dflags wanted_mod err
1803
1804 noHsFileErr :: SrcSpan -> String -> a
1805 noHsFileErr loc path
1806   = throwDyn $ mkPlainErrMsg loc $ text "Can't find" <+> text path
1807
1808 packageModErr :: ModuleName -> a
1809 packageModErr mod
1810   = throwDyn $ mkPlainErrMsg noSrcSpan $
1811         text "module" <+> quotes (ppr mod) <+> text "is a package module"
1812
1813 multiRootsErr :: [ModSummary] -> IO ()
1814 multiRootsErr [] = panic "multiRootsErr"
1815 multiRootsErr summs@(summ1:_)
1816   = throwDyn $ mkPlainErrMsg noSrcSpan $
1817         text "module" <+> quotes (ppr mod) <+>
1818         text "is defined in multiple files:" <+>
1819         sep (map text files)
1820   where
1821     mod = ms_mod summ1
1822     files = map (expectJust "checkDup" . ml_hs_file . ms_location) summs
1823
1824 cyclicModuleErr :: [ModSummary] -> SDoc
1825 cyclicModuleErr ms
1826   = hang (ptext SLIT("Module imports form a cycle for modules:"))
1827        2 (vcat (map show_one ms))
1828   where
1829     show_one ms = sep [ show_mod (ms_hsc_src ms) (ms_mod ms),
1830                         nest 2 $ ptext SLIT("imports:") <+>
1831                                    (pp_imps HsBootFile (ms_srcimps ms)
1832                                    $$ pp_imps HsSrcFile  (ms_imps ms))]
1833     show_mod hsc_src mod = ppr mod <> text (hscSourceString hsc_src)
1834     pp_imps src mods = fsep (map (show_mod src) mods)
1835
1836
1837 -- | Inform GHC that the working directory has changed.  GHC will flush
1838 -- its cache of module locations, since it may no longer be valid.
1839 -- Note: if you change the working directory, you should also unload
1840 -- the current program (set targets to empty, followed by load).
1841 workingDirectoryChanged :: Session -> IO ()
1842 workingDirectoryChanged s = withSession s $ flushFinderCaches
1843
1844 -- -----------------------------------------------------------------------------
1845 -- inspecting the session
1846
1847 -- | Get the module dependency graph.
1848 getModuleGraph :: Session -> IO ModuleGraph -- ToDo: DiGraph ModSummary
1849 getModuleGraph s = withSession s (return . hsc_mod_graph)
1850
1851 isLoaded :: Session -> ModuleName -> IO Bool
1852 isLoaded s m = withSession s $ \hsc_env ->
1853   return $! isJust (lookupUFM (hsc_HPT hsc_env) m)
1854
1855 getBindings :: Session -> IO [TyThing]
1856 getBindings s = withSession s $ \hsc_env ->
1857    -- we have to implement the shadowing behaviour of ic_tmp_ids here
1858    -- (see InteractiveContext) and the quickest way is to use an OccEnv.
1859    let
1860        tmp_ids = ic_tmp_ids (hsc_IC hsc_env)
1861        filtered = foldr f (const []) tmp_ids emptyUniqSet
1862        f id rest set
1863            | uniq `elementOfUniqSet` set = rest set
1864            | otherwise  = AnId id : rest (addOneToUniqSet set uniq)
1865            where uniq = getUnique (nameOccName (idName id))
1866    in
1867    return filtered
1868
1869 getPrintUnqual :: Session -> IO PrintUnqualified
1870 getPrintUnqual s = withSession s $ \hsc_env ->
1871   return (icPrintUnqual (hsc_dflags hsc_env) (hsc_IC hsc_env))
1872
1873 -- | Container for information about a 'Module'.
1874 data ModuleInfo = ModuleInfo {
1875         minf_type_env  :: TypeEnv,
1876         minf_exports   :: NameSet, -- ToDo, [AvailInfo] like ModDetails?
1877         minf_rdr_env   :: Maybe GlobalRdrEnv,   -- Nothing for a compiled/package mod
1878         minf_instances :: [Instance]
1879 #ifdef GHCI
1880         ,minf_modBreaks :: ModBreaks
1881 #endif
1882         -- ToDo: this should really contain the ModIface too
1883   }
1884         -- We don't want HomeModInfo here, because a ModuleInfo applies
1885         -- to package modules too.
1886
1887 -- | Request information about a loaded 'Module'
1888 getModuleInfo :: Session -> Module -> IO (Maybe ModuleInfo)
1889 getModuleInfo s mdl = withSession s $ \hsc_env -> do
1890   let mg = hsc_mod_graph hsc_env
1891   if mdl `elem` map ms_mod mg
1892         then getHomeModuleInfo hsc_env (moduleName mdl)
1893         else do
1894   {- if isHomeModule (hsc_dflags hsc_env) mdl
1895         then return Nothing
1896         else -} getPackageModuleInfo hsc_env mdl
1897    -- getPackageModuleInfo will attempt to find the interface, so
1898    -- we don't want to call it for a home module, just in case there
1899    -- was a problem loading the module and the interface doesn't
1900    -- exist... hence the isHomeModule test here.  (ToDo: reinstate)
1901
1902 getPackageModuleInfo :: HscEnv -> Module -> IO (Maybe ModuleInfo)
1903 #ifdef GHCI
1904 getPackageModuleInfo hsc_env mdl = do
1905   (_msgs, mb_avails) <- getModuleExports hsc_env mdl
1906   case mb_avails of
1907     Nothing -> return Nothing
1908     Just avails -> do
1909         eps <- readIORef (hsc_EPS hsc_env)
1910         let
1911             names  = availsToNameSet avails
1912             pte    = eps_PTE eps
1913             tys    = [ ty | name <- concatMap availNames avails,
1914                             Just ty <- [lookupTypeEnv pte name] ]
1915         --
1916         return (Just (ModuleInfo {
1917                         minf_type_env  = mkTypeEnv tys,
1918                         minf_exports   = names,
1919                         minf_rdr_env   = Just $! nameSetToGlobalRdrEnv names (moduleName mdl),
1920                         minf_instances = error "getModuleInfo: instances for package module unimplemented",
1921                         minf_modBreaks = emptyModBreaks
1922                 }))
1923 #else
1924 getPackageModuleInfo _hsc_env _mdl = do
1925   -- bogusly different for non-GHCI (ToDo)
1926   return Nothing
1927 #endif
1928
1929 getHomeModuleInfo :: HscEnv -> ModuleName -> IO (Maybe ModuleInfo)
1930 getHomeModuleInfo hsc_env mdl =
1931   case lookupUFM (hsc_HPT hsc_env) mdl of
1932     Nothing  -> return Nothing
1933     Just hmi -> do
1934       let details = hm_details hmi
1935       return (Just (ModuleInfo {
1936                         minf_type_env  = md_types details,
1937                         minf_exports   = availsToNameSet (md_exports details),
1938                         minf_rdr_env   = mi_globals $! hm_iface hmi,
1939                         minf_instances = md_insts details
1940 #ifdef GHCI
1941                        ,minf_modBreaks = getModBreaks hmi
1942 #endif
1943                         }))
1944
1945 -- | The list of top-level entities defined in a module
1946 modInfoTyThings :: ModuleInfo -> [TyThing]
1947 modInfoTyThings minf = typeEnvElts (minf_type_env minf)
1948
1949 modInfoTopLevelScope :: ModuleInfo -> Maybe [Name]
1950 modInfoTopLevelScope minf
1951   = fmap (map gre_name . globalRdrEnvElts) (minf_rdr_env minf)
1952
1953 modInfoExports :: ModuleInfo -> [Name]
1954 modInfoExports minf = nameSetToList $! minf_exports minf
1955
1956 -- | Returns the instances defined by the specified module.
1957 -- Warning: currently unimplemented for package modules.
1958 modInfoInstances :: ModuleInfo -> [Instance]
1959 modInfoInstances = minf_instances
1960
1961 modInfoIsExportedName :: ModuleInfo -> Name -> Bool
1962 modInfoIsExportedName minf name = elemNameSet name (minf_exports minf)
1963
1964 mkPrintUnqualifiedForModule :: Session -> ModuleInfo -> IO (Maybe PrintUnqualified)
1965 mkPrintUnqualifiedForModule s minf = withSession s $ \hsc_env -> do
1966   return (fmap (mkPrintUnqualified (hsc_dflags hsc_env)) (minf_rdr_env minf))
1967
1968 modInfoLookupName :: Session -> ModuleInfo -> Name -> IO (Maybe TyThing)
1969 modInfoLookupName s minf name = withSession s $ \hsc_env -> do
1970    case lookupTypeEnv (minf_type_env minf) name of
1971      Just tyThing -> return (Just tyThing)
1972      Nothing      -> do
1973        eps <- readIORef (hsc_EPS hsc_env)
1974        return $! lookupType (hsc_dflags hsc_env)
1975                             (hsc_HPT hsc_env) (eps_PTE eps) name
1976
1977 #ifdef GHCI
1978 modInfoModBreaks :: ModuleInfo -> ModBreaks
1979 modInfoModBreaks = minf_modBreaks
1980 #endif
1981
1982 isDictonaryId :: Id -> Bool
1983 isDictonaryId id
1984   = case tcSplitSigmaTy (idType id) of { (_tvs, _theta, tau) -> isDictTy tau }
1985
1986 -- | Looks up a global name: that is, any top-level name in any
1987 -- visible module.  Unlike 'lookupName', lookupGlobalName does not use
1988 -- the interactive context, and therefore does not require a preceding
1989 -- 'setContext'.
1990 lookupGlobalName :: Session -> Name -> IO (Maybe TyThing)
1991 lookupGlobalName s name = withSession s $ \hsc_env -> do
1992    eps <- readIORef (hsc_EPS hsc_env)
1993    return $! lookupType (hsc_dflags hsc_env)
1994                         (hsc_HPT hsc_env) (eps_PTE eps) name
1995
1996 -- -----------------------------------------------------------------------------
1997 -- Misc exported utils
1998
1999 dataConType :: DataCon -> Type
2000 dataConType dc = idType (dataConWrapId dc)
2001
2002 -- | print a 'NamedThing', adding parentheses if the name is an operator.
2003 pprParenSymName :: NamedThing a => a -> SDoc
2004 pprParenSymName a = parenSymOcc (getOccName a) (ppr (getName a))
2005
2006 -- ----------------------------------------------------------------------------
2007
2008 #if 0
2009
2010 -- ToDo:
2011 --   - Data and Typeable instances for HsSyn.
2012
2013 -- ToDo: check for small transformations that happen to the syntax in
2014 -- the typechecker (eg. -e ==> negate e, perhaps for fromIntegral)
2015
2016 -- ToDo: maybe use TH syntax instead of IfaceSyn?  There's already a way
2017 -- to get from TyCons, Ids etc. to TH syntax (reify).
2018
2019 -- :browse will use either lm_toplev or inspect lm_interface, depending
2020 -- on whether the module is interpreted or not.
2021
2022 -- This is for reconstructing refactored source code
2023 -- Calls the lexer repeatedly.
2024 -- ToDo: add comment tokens to token stream
2025 getTokenStream :: Session -> Module -> IO [Located Token]
2026 #endif
2027
2028 -- -----------------------------------------------------------------------------
2029 -- Interactive evaluation
2030
2031 -- | Takes a 'ModuleName' and possibly a 'PackageId', and consults the
2032 -- filesystem and package database to find the corresponding 'Module',
2033 -- using the algorithm that is used for an @import@ declaration.
2034 findModule :: Session -> ModuleName -> Maybe PackageId -> IO Module
2035 findModule s mod_name maybe_pkg = withSession s $ \hsc_env ->
2036   let
2037         dflags = hsc_dflags hsc_env
2038         hpt    = hsc_HPT hsc_env
2039         this_pkg = thisPackage dflags
2040   in
2041   case lookupUFM hpt mod_name of
2042     Just mod_info -> return (mi_module (hm_iface mod_info))
2043     _not_a_home_module -> do
2044           res <- findImportedModule hsc_env mod_name maybe_pkg
2045           case res of
2046             Found _ m | modulePackageId m /= this_pkg -> return m
2047                       | otherwise -> throwDyn (CmdLineError (showSDoc $
2048                                         text "module" <+> pprModule m <+>
2049                                         text "is not loaded"))
2050             err -> let msg = cannotFindModule dflags mod_name err in
2051                    throwDyn (CmdLineError (showSDoc msg))
2052
2053 #ifdef GHCI
2054 getHistorySpan :: Session -> History -> IO SrcSpan
2055 getHistorySpan sess h = withSession sess $ \hsc_env ->
2056                           return$ InteractiveEval.getHistorySpan hsc_env h
2057
2058 obtainTerm :: Session -> Bool -> Id -> IO Term
2059 obtainTerm sess force id = withSession sess $ \hsc_env ->
2060                             InteractiveEval.obtainTerm hsc_env force id
2061
2062 obtainTerm1 :: Session -> Bool -> Maybe Type -> a -> IO Term
2063 obtainTerm1 sess force mb_ty a = withSession sess $ \hsc_env ->
2064                                InteractiveEval.obtainTerm1 hsc_env force mb_ty a
2065
2066 obtainTermB :: Session -> Int -> Bool -> Id -> IO Term
2067 obtainTermB sess bound force id = withSession sess $ \hsc_env ->
2068                             InteractiveEval.obtainTermB hsc_env bound force id
2069
2070 #endif