1 -- -----------------------------------------------------------------------------
3 -- (c) The University of Glasgow, 2005
7 -- -----------------------------------------------------------------------------
13 defaultCleanupHandler,
16 -- * Flags and settings
17 DynFlags(..), DynFlag(..), Severity(..), HscTarget(..), dopt,
18 GhcMode(..), GhcLink(..), defaultObjectTarget,
25 Target(..), TargetId(..), Phase,
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 ()
38 -- * Loading\/compiling the program
40 load, LoadHowMuch(..), SuccessFlag(..), -- also does depanal
41 workingDirectoryChanged,
42 checkModule, CheckedModule(..),
43 TypecheckedSource, ParsedSource, RenamedSource,
46 -- * Parsing Haddock comments
49 -- * Inspecting the module structure of the program
50 ModuleGraph, ModSummary(..), ms_mod_name, ModLocation(..),
55 -- * Inspecting modules
60 modInfoPrintUnqualified,
63 modInfoIsExportedName,
68 PrintUnqualified, alwaysQualify,
70 -- * Interactive evaluation
71 getBindings, getPrintUnqual,
74 setContext, getContext,
83 runStmt, SingleStep(..),
85 Resume(resumeStmt, resumeThreadId, resumeBreakInfo, resumeSpan,
86 resumeHistory, resumeHistoryIx),
87 History(historyBreakInfo, historyEnclosingDecl),
88 GHC.getHistorySpan, getHistoryModule,
92 InteractiveEval.forward,
95 compileExpr, HValue, dynCompileExpr,
97 GHC.obtainTerm, GHC.obtainTerm1, GHC.obtainTermB, reconstructType,
99 ModBreaks(..), BreakIndex,
100 BreakInfo(breakInfo_number, breakInfo_module),
101 BreakArray, setBreakOn, setBreakOff, getBreak,
104 -- * Abstract syntax elements
110 Module, mkModule, pprModule, moduleName, modulePackageId,
111 ModuleName, mkModuleName, moduleNameString,
115 isExternalName, nameModule, pprParenSymName, nameSrcSpan,
117 RdrName(Qual,Unqual),
121 isImplicitId, isDeadBinder,
122 isExportedId, isLocalId, isGlobalId,
124 isPrimOpId, isFCallId, isClassOpId_maybe,
125 isDataConWorkId, idDataCon,
126 isBottomingId, isDictonaryId,
127 recordSelectorFieldLabel,
129 -- ** Type constructors
131 tyConTyVars, tyConDataCons, tyConArity,
132 isClassTyCon, isSynTyCon, isNewTyCon, isPrimTyCon, isFunTyCon,
134 synTyConDefn, synTyConType, synTyConResKind,
140 -- ** Data constructors
142 dataConSig, dataConType, dataConTyCon, dataConFieldLabels,
143 dataConIsInfix, isVanillaDataCon,
145 StrictnessMark(..), isMarkedStrict,
149 classMethods, classSCTheta, classTvsFds,
154 instanceDFunId, pprInstance, pprInstanceHdr,
156 -- ** Types and Kinds
157 Type, dropForAlls, splitForAllTys, funResultTy,
158 pprParendType, pprTypeApp,
161 ThetaType, pprThetaArrow,
167 module HsSyn, -- ToDo: remove extraneous bits
171 defaultFixity, maxPrecedence,
175 -- ** Source locations
177 mkSrcLoc, isGoodSrcLoc, noSrcLoc,
178 srcLocFile, srcLocLine, srcLocCol,
180 mkSrcSpan, srcLocSpan, isGoodSrcSpan, noSrcSpan,
181 srcSpanStart, srcSpanEnd,
183 srcSpanStartLine, srcSpanEndLine,
184 srcSpanStartCol, srcSpanEndCol,
187 GhcException(..), showGhcException,
197 * inline bits of HscMain here to simplify layering: hscTcExpr, hscStmt.
198 * what StaticFlags should we expose, if any?
201 #include "HsVersions.h"
204 import qualified Linker
205 import Linker ( HValue )
210 import InteractiveEval
217 import Type hiding (typeKind)
218 import TcType hiding (typeKind)
220 import Var hiding (setIdType)
221 import TysPrim ( alphaTyVars )
226 import Name hiding ( varName )
227 import OccName ( parenSymOcc )
228 import InstEnv ( Instance, instanceDFunId, pprInstance, pprInstanceHdr )
232 import TcRnDriver ( tcRnModule )
233 import DriverPipeline
234 import DriverPhases ( HscSource(..), Phase(..), isHaskellSrcFilename, startPhase )
235 import HeaderInfo ( getImports, getOptions )
237 import HscMain ( newHscEnv, hscFileCheck, HscChecked(..) )
241 import SysTools ( initSysTools, cleanTempFiles, cleanTempFilesExcept,
251 import Bag ( unitBag, listToBag )
252 import ErrUtils ( Severity(..), showPass, fatalErrorMsg, debugTraceMsg,
253 mkPlainErrMsg, printBagOfErrors, printBagOfWarnings,
255 import qualified ErrUtils
257 import StringBuffer ( StringBuffer, hGetStringBuffer )
260 import Maybes ( expectJust, mapCatMaybes )
262 import HaddockLex ( tokenise )
264 import Control.Concurrent
265 import System.Directory ( getModificationTime, doesFileExist )
268 import qualified Data.List as List
270 import System.Exit ( exitWith, ExitCode(..) )
271 import System.Time ( ClockTime )
272 import Control.Exception as Exception hiding (handle)
275 import System.IO.Error ( try, isDoesNotExistError )
276 import Prelude hiding (init)
279 -- -----------------------------------------------------------------------------
280 -- Exception handlers
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
292 -- an IO exception probably isn't our fault, so don't panic
294 fatalErrorMsg dflags (text (show exception))
295 AsyncException StackOverflow ->
296 fatalErrorMsg dflags (text "stack overflow: use +RTS -K<size> to increase it")
298 fatalErrorMsg dflags (text (show (Panic (show exception))))
299 exitWith (ExitFailure 1)
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)) $
307 -- error messages propagated as exceptions
308 handleDyn (\dyn -> do
311 PhaseFailed _ code -> exitWith code
312 Interrupted -> exitWith (ExitFailure 1)
313 _ -> do fatalErrorMsg dflags (text (show (dyn :: GhcException)))
314 exitWith (ExitFailure 1)
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
328 -- exceptions will be blocked while we clean the temporary files,
329 -- so there shouldn't be any difficulty if we receive further
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
339 main_thread <- myThreadId
340 modifyMVar_ interruptTargetThread (return . (main_thread :))
341 installSignalHandlers
344 dflags0 <- initSysTools mb_top_dir defaultDynFlags
345 dflags <- initDynFlags dflags0
346 env <- newHscEnv dflags
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
355 -- -----------------------------------------------------------------------------
358 -- | Grabs the DynFlags from the Session
359 getSessionDynFlags :: Session -> IO DynFlags
360 getSessionDynFlags s = withSession s (return . hsc_dflags)
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).
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.
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' }
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
393 case outputFile dflags of
395 Nothing -> env { hsc_dflags = dflags { outputFile = guessedName } }
397 -- -----------------------------------------------------------------------------
400 -- ToDo: think about relative vs. absolute file paths. And what
401 -- happens when the current directory changes.
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 })
410 -- | returns the current set of targets
411 getTargets :: Session -> IO [Target]
412 getTargets s = withSession s (return . hsc_targets)
414 -- | Add another target
415 addTarget :: Session -> Target -> IO ()
417 = modifySession s (\h -> h{ hsc_targets = target : hsc_targets h })
420 removeTarget :: Session -> TargetId -> IO ()
421 removeTarget s target_id
422 = modifySession s (\h -> h{ hsc_targets = filter (hsc_targets h) })
424 filter targets = [ t | t@(Target id _) <- targets, id /= target_id ]
426 -- Attempts to guess what Target a string refers to. This function implements
427 -- the --make/GHCi command-line syntax for filenames:
429 -- - if the string looks like a Haskell source filename, then interpret
431 -- - if adding a .hs or .lhs suffix yields the name of an existing file,
433 -- - otherwise interpret the string as a module name
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)
442 = do exists <- doesFileExist hs_file
444 then return (Target (TargetFile hs_file Nothing) Nothing)
446 exists <- doesFileExist lhs_file
448 then return (Target (TargetFile lhs_file Nothing) Nothing)
450 return (Target (TargetModule (mkModuleName file)) Nothing)
452 hs_file = file `joinFileExt` "hs"
453 lhs_file = file `joinFileExt` "lhs"
455 -- -----------------------------------------------------------------------------
456 -- Extending the program scope
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 }
464 setGlobalRdrScope :: Session -> [GlobalRdrElt] -> IO ()
465 setGlobalRdrScope session rdrElts
466 = modifySession session $ \hscEnv ->
467 hscEnv{ hsc_global_rdr_env = foldl extendGlobalRdrEnv emptyGlobalRdrEnv rdrElts }
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 }
475 setGlobalTypeScope :: Session -> [Id] -> IO ()
476 setGlobalTypeScope session ids
477 = modifySession session $ \hscEnv ->
478 hscEnv{ hsc_global_type_env = extendTypeEnvWithIds emptyTypeEnv ids }
480 -- -----------------------------------------------------------------------------
481 -- Parsing Haddock comments
483 parseHaddockComment :: String -> Either String (HsDoc RdrName)
484 parseHaddockComment string = parseHaddockParagraphs (tokenise string)
486 -- -----------------------------------------------------------------------------
487 -- Loading the program
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
495 dflags = hsc_dflags hsc_env
496 targets = hsc_targets hsc_env
497 old_graph = hsc_mod_graph hsc_env
499 showPass dflags "Chasing dependencies"
500 debugTraceMsg dflags 2 (hcat [
501 text "Chasing modules from: ",
502 hcat (punctuate comma (map pprTarget targets))])
504 r <- downsweep hsc_env old_graph excluded_mods allow_dup_roots
506 Just mod_graph -> writeIORef ref hsc_env{ hsc_mod_graph = mod_graph }
511 -- | The result of load.
513 = LoadOk Errors -- ^ all specified targets were loaded successfully.
514 | LoadFailed Errors -- ^ not all modules were loaded.
516 type Errors = [String]
518 data ErrMsg = ErrMsg {
519 errMsgSeverity :: Severity, -- warning, error, etc.
520 errMsgSpans :: [SrcSpan],
521 errMsgShortDoc :: Doc,
522 errMsgExtraInfo :: Doc
528 | LoadUpTo ModuleName
529 | LoadDependenciesOf ModuleName
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
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
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
550 writeIORef ref $! hsc_env{ hsc_IC = emptyInteractiveContext }
553 load2 s@(Session ref) how_much mod_graph = do
555 hsc_env <- readIORef ref
557 let hpt1 = hsc_HPT hsc_env
558 let dflags = hsc_dflags hsc_env
560 -- The "bad" boot modules are the ones for which we have
561 -- B.hs-boot in the module graph, but no B.hs
562 -- The downsweep should have ensured this does not happen
564 let all_home_mods = [ms_mod_name s
565 | 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)]
570 ASSERT( null bad_boot_mods ) return ()
572 -- mg2_with_srcimps drops the hi-boot nodes, returning a
573 -- graph with cycles. Among other things, it is used for
574 -- backing out partially complete cycles following a failed
575 -- upsweep, and for removing from hpt all the modules
576 -- not in strict downwards closure, during calls to compile.
577 let mg2_with_srcimps :: [SCC ModSummary]
578 mg2_with_srcimps = topSortModuleGraph True mod_graph Nothing
580 -- If we can determine that any of the {-# SOURCE #-} imports
581 -- are definitely unnecessary, then emit a warning.
582 warnUnnecessarySourceImports dflags mg2_with_srcimps
585 -- check the stability property for each module.
586 stable_mods@(stable_obj,stable_bco)
587 = checkStability hpt1 mg2_with_srcimps all_home_mods
589 -- prune bits of the HPT which are definitely redundant now,
591 pruned_hpt = pruneHomePackageTable hpt1
592 (flattenSCCs mg2_with_srcimps)
597 debugTraceMsg dflags 2 (text "Stable obj:" <+> ppr stable_obj $$
598 text "Stable BCO:" <+> ppr stable_bco)
600 -- Unload any modules which are going to be re-linked this time around.
601 let stable_linkables = [ linkable
602 | m <- stable_obj++stable_bco,
603 Just hmi <- [lookupUFM pruned_hpt m],
604 Just linkable <- [hm_linkable hmi] ]
605 unload hsc_env stable_linkables
607 -- We could at this point detect cycles which aren't broken by
608 -- a source-import, and complain immediately, but it seems better
609 -- to let upsweep_mods do this, so at least some useful work gets
610 -- done before the upsweep is abandoned.
611 --hPutStrLn stderr "after tsort:\n"
612 --hPutStrLn stderr (showSDoc (vcat (map ppr mg2)))
614 -- Now do the upsweep, calling compile for each module in
615 -- turn. Final result is version 3 of everything.
617 -- Topologically sort the module graph, this time including hi-boot
618 -- nodes, and possibly just including the portion of the graph
619 -- reachable from the module specified in the 2nd argument to load.
620 -- This graph should be cycle-free.
621 -- If we're restricting the upsweep to a portion of the graph, we
622 -- also want to retain everything that is still stable.
623 let full_mg :: [SCC ModSummary]
624 full_mg = topSortModuleGraph False mod_graph Nothing
626 maybe_top_mod = case how_much of
628 LoadDependenciesOf m -> Just m
631 partial_mg0 :: [SCC ModSummary]
632 partial_mg0 = topSortModuleGraph False mod_graph maybe_top_mod
634 -- LoadDependenciesOf m: we want the upsweep to stop just
635 -- short of the specified module (unless the specified module
638 | LoadDependenciesOf mod <- how_much
639 = ASSERT( case last partial_mg0 of
640 AcyclicSCC ms -> ms_mod_name ms == mod; _ -> False )
641 List.init partial_mg0
647 | AcyclicSCC ms <- full_mg,
648 ms_mod_name ms `elem` stable_obj++stable_bco,
649 ms_mod_name ms `notElem` [ ms_mod_name ms' |
650 AcyclicSCC ms' <- partial_mg ] ]
652 mg = stable_mg ++ partial_mg
654 -- clean up between compilations
655 let cleanup = cleanTempFilesExcept dflags
656 (ppFilesFromSummaries (flattenSCCs mg2_with_srcimps))
658 debugTraceMsg dflags 2 (hang (text "Ready for upsweep")
660 (upsweep_ok, hsc_env1, modsUpswept)
661 <- upsweep (hsc_env { hsc_HPT = emptyHomePackageTable })
662 pruned_hpt stable_mods cleanup mg
664 -- Make modsDone be the summaries for each home module now
665 -- available; this should equal the domain of hpt3.
666 -- Get in in a roughly top .. bottom order (hence reverse).
668 let modsDone = reverse modsUpswept
670 -- Try and do linking in some form, depending on whether the
671 -- upsweep was completely or only partially successful.
673 if succeeded upsweep_ok
676 -- Easy; just relink it all.
677 do debugTraceMsg dflags 2 (text "Upsweep completely successful.")
679 -- Clean up after ourselves
680 cleanTempFilesExcept dflags (ppFilesFromSummaries modsDone)
682 -- Issue a warning for the confusing case where the user
683 -- said '-o foo' but we're not going to do any linking.
684 -- We attempt linking if either (a) one of the modules is
685 -- called Main, or (b) the user said -no-hs-main, indicating
686 -- that main() is going to come from somewhere else.
688 let ofile = outputFile dflags
689 let no_hs_main = dopt Opt_NoHsMain dflags
691 main_mod = mainModIs dflags
692 a_root_is_Main = any ((==main_mod).ms_mod) mod_graph
693 do_linking = a_root_is_Main || no_hs_main
695 when (ghcLink dflags == LinkBinary
696 && isJust ofile && not do_linking) $
697 debugTraceMsg dflags 1 $
698 text ("Warning: output was redirected with -o, " ++
699 "but no output will be generated\n" ++
700 "because there is no " ++
701 moduleNameString (moduleName main_mod) ++ " module.")
703 -- link everything together
704 linkresult <- link (ghcLink dflags) dflags do_linking (hsc_HPT hsc_env1)
706 loadFinish Succeeded linkresult ref hsc_env1
709 -- Tricky. We need to back out the effects of compiling any
710 -- half-done cycles, both so as to clean up the top level envs
711 -- and to avoid telling the interactive linker to link them.
712 do debugTraceMsg dflags 2 (text "Upsweep partially successful.")
715 = map ms_mod modsDone
716 let mods_to_zap_names
717 = findPartiallyCompletedCycles modsDone_names
720 = filter ((`notElem` mods_to_zap_names).ms_mod)
723 let hpt4 = retainInTopLevelEnvs (map ms_mod_name mods_to_keep)
726 -- Clean up after ourselves
727 cleanTempFilesExcept dflags (ppFilesFromSummaries mods_to_keep)
729 -- there should be no Nothings where linkables should be, now
730 ASSERT(all (isJust.hm_linkable)
731 (eltsUFM (hsc_HPT hsc_env))) do
733 -- Link everything together
734 linkresult <- link (ghcLink dflags) dflags False hpt4
736 let hsc_env4 = hsc_env1{ hsc_HPT = hpt4 }
737 loadFinish Failed linkresult ref hsc_env4
739 -- Finish up after a load.
741 -- If the link failed, unload everything and return.
742 loadFinish all_ok Failed ref hsc_env
743 = do unload hsc_env []
744 writeIORef ref $! discardProg hsc_env
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 }
754 -- Forget the current program, but retain the persistent info in HscEnv
755 discardProg :: HscEnv -> HscEnv
757 = hsc_env { hsc_mod_graph = emptyMG,
758 hsc_IC = emptyInteractiveContext,
759 hsc_HPT = emptyHomePackageTable }
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 summaries = map ms_hspp_file summaries
766 -- -----------------------------------------------------------------------------
770 CheckedModule { parsedSource :: ParsedSource,
771 renamedSource :: Maybe RenamedSource,
772 typecheckedSource :: Maybe TypecheckedSource,
773 checkedModuleInfo :: Maybe ModuleInfo,
774 coreBinds :: Maybe [CoreBind]
776 -- ToDo: improvements that could be made here:
777 -- if the module succeeded renaming but not typechecking,
778 -- we can still get back the GlobalRdrEnv and exports, so
779 -- perhaps the ModuleInfo should be split up into separate
780 -- fields within CheckedModule.
782 type ParsedSource = Located (HsModule RdrName)
783 type RenamedSource = (HsGroup Name, [LImportDecl Name], Maybe [LIE Name],
784 Maybe (HsDoc Name), HaddockModInfo Name)
785 type TypecheckedSource = LHsBinds Id
788 -- - things that aren't in the output of the typechecker right now:
792 -- - type/data/newtype declarations
793 -- - class declarations
795 -- - extra things in the typechecker's output:
796 -- - default methods are turned into top-level decls.
797 -- - dictionary bindings
800 -- | This is the way to get access to parsed and typechecked source code
801 -- for a module. 'checkModule' attempts to typecheck the module. If
802 -- successful, it returns the abstract syntax for the module.
803 -- If compileToCore is true, it also desugars the module and returns the
804 -- resulting Core bindings as a component of the CheckedModule.
805 checkModule :: Session -> ModuleName -> Bool -> IO (Maybe CheckedModule)
806 checkModule session@(Session ref) mod compileToCore = do
807 -- parse & typecheck the module
808 hsc_env <- readIORef ref
809 let mg = hsc_mod_graph hsc_env
810 case [ ms | ms <- mg, ms_mod_name ms == mod ] of
813 mbChecked <- hscFileCheck
814 hsc_env{hsc_dflags=ms_hspp_opts ms}
817 Nothing -> return Nothing
818 Just (HscChecked parsed renamed Nothing _) ->
819 return (Just (CheckedModule {
820 parsedSource = parsed,
821 renamedSource = renamed,
822 typecheckedSource = Nothing,
823 checkedModuleInfo = Nothing,
824 coreBinds = Nothing }))
825 Just (HscChecked parsed renamed
826 (Just (tc_binds, rdr_env, details))
827 maybeCoreBinds) -> do
828 let minf = ModuleInfo {
829 minf_type_env = md_types details,
830 minf_exports = availsToNameSet $
832 minf_rdr_env = Just rdr_env,
833 minf_instances = md_insts details
835 ,minf_modBreaks = emptyModBreaks
838 return (Just (CheckedModule {
839 parsedSource = parsed,
840 renamedSource = renamed,
841 typecheckedSource = Just tc_binds,
842 checkedModuleInfo = Just minf,
843 coreBinds = maybeCoreBinds}))
845 -- | This is the way to get access to the Core bindings corresponding
846 -- to a module. 'compileToCore' invokes 'checkModule' to parse, typecheck, and
847 -- desugar the module, then returns the resulting list of Core bindings if
849 compileToCore :: Session -> FilePath -> IO (Maybe [CoreBind])
850 compileToCore session@(Session ref) fn = do
851 hsc_env <- readIORef ref
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
861 case find ((== fn) . msHsFilePath) modGraph of
862 Just modSummary -> do
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 -- ---------------------------------------------------------------------------
873 unload :: HscEnv -> [Linkable] -> IO ()
874 unload hsc_env stable_linkables -- Unload everthing *except* 'stable_linkables'
875 = case ghcLink (hsc_dflags hsc_env) of
877 LinkInMemory -> Linker.unload (hsc_dflags hsc_env) stable_linkables
879 LinkInMemory -> panic "unload: no interpreter"
883 -- -----------------------------------------------------------------------------
887 Stability tells us which modules definitely do not need to be recompiled.
888 There are two main reasons for having stability:
890 - avoid doing a complete upsweep of the module graph in GHCi when
891 modules near the bottom of the tree have not changed.
893 - to tell GHCi when it can load object code: we can only load object code
894 for a module when we also load object code fo all of the imports of the
895 module. So we need to know that we will definitely not be recompiling
896 any of these modules, and we can use the object code.
898 The stability check is as follows. Both stableObject and
899 stableBCO are used during the upsweep phase later.
902 stable m = stableObject m || stableBCO m
905 all stableObject (imports m)
906 && old linkable does not exist, or is == on-disk .o
907 && date(on-disk .o) > date(.hs)
910 all stable (imports m)
911 && date(BCO) > date(.hs)
914 These properties embody the following ideas:
916 - if a module is stable, then:
917 - if it has been compiled in a previous pass (present in HPT)
918 then it does not need to be compiled or re-linked.
919 - if it has not been compiled in a previous pass,
920 then we only need to read its .hi file from disk and
921 link it to produce a ModDetails.
923 - if a modules is not stable, we will definitely be at least
924 re-linking, and possibly re-compiling it during the upsweep.
925 All non-stable modules can (and should) therefore be unlinked
928 - Note that objects are only considered stable if they only depend
929 on other objects. We can't link object code against byte code.
933 :: HomePackageTable -- HPT from last compilation
934 -> [SCC ModSummary] -- current module graph (cyclic)
935 -> [ModuleName] -- all home modules
936 -> ([ModuleName], -- stableObject
937 [ModuleName]) -- stableBCO
939 checkStability hpt sccs all_home_mods = foldl checkSCC ([],[]) sccs
941 checkSCC (stable_obj, stable_bco) scc0
942 | stableObjects = (scc_mods ++ stable_obj, stable_bco)
943 | stableBCOs = (stable_obj, scc_mods ++ stable_bco)
944 | otherwise = (stable_obj, stable_bco)
946 scc = flattenSCC scc0
947 scc_mods = map ms_mod_name scc
948 home_module m = m `elem` all_home_mods && m `notElem` scc_mods
950 scc_allimps = nub (filter home_module (concatMap ms_allimps scc))
951 -- all imports outside the current SCC, but in the home pkg
953 stable_obj_imps = map (`elem` stable_obj) scc_allimps
954 stable_bco_imps = map (`elem` stable_bco) scc_allimps
961 and (zipWith (||) stable_obj_imps stable_bco_imps)
965 | Just t <- ms_obj_date ms = t >= ms_hs_date ms
969 same_as_prev t = case lookupUFM hpt (ms_mod_name ms) of
970 Just hmi | Just l <- hm_linkable hmi
971 -> isObjectLinkable l && t == linkableTime l
973 -- why '>=' rather than '>' above? If the filesystem stores
974 -- times to the nearset second, we may occasionally find that
975 -- the object & source have the same modification time,
976 -- especially if the source was automatically generated
977 -- and compiled. Using >= is slightly unsafe, but it matches
981 = case lookupUFM hpt (ms_mod_name ms) of
982 Just hmi | Just l <- hm_linkable hmi ->
983 not (isObjectLinkable l) &&
984 linkableTime l >= ms_hs_date ms
987 ms_allimps :: ModSummary -> [ModuleName]
988 ms_allimps ms = map unLoc (ms_srcimps ms ++ ms_imps ms)
990 -- -----------------------------------------------------------------------------
991 -- Prune the HomePackageTable
993 -- Before doing an upsweep, we can throw away:
995 -- - For non-stable modules:
996 -- - all ModDetails, all linked code
997 -- - all unlinked code that is out of date with respect to
1000 -- This is VERY IMPORTANT otherwise we'll end up requiring 2x the
1001 -- space at the end of the upsweep, because the topmost ModDetails of the
1002 -- old HPT holds on to the entire type environment from the previous
1005 pruneHomePackageTable
1008 -> ([ModuleName],[ModuleName])
1011 pruneHomePackageTable hpt summ (stable_obj, stable_bco)
1014 | is_stable modl = hmi'
1015 | otherwise = hmi'{ hm_details = emptyModDetails }
1017 modl = moduleName (mi_module (hm_iface hmi))
1018 hmi' | Just l <- hm_linkable hmi, linkableTime l < ms_hs_date ms
1019 = hmi{ hm_linkable = Nothing }
1022 where ms = expectJust "prune" (lookupUFM ms_map modl)
1024 ms_map = listToUFM [(ms_mod_name ms, ms) | ms <- summ]
1026 is_stable m = m `elem` stable_obj || m `elem` stable_bco
1028 -- -----------------------------------------------------------------------------
1030 -- Return (names of) all those in modsDone who are part of a cycle
1031 -- as defined by theGraph.
1032 findPartiallyCompletedCycles :: [Module] -> [SCC ModSummary] -> [Module]
1033 findPartiallyCompletedCycles modsDone theGraph
1037 chew ((AcyclicSCC v):rest) = chew rest -- acyclic? not interesting.
1038 chew ((CyclicSCC vs):rest)
1039 = let names_in_this_cycle = nub (map ms_mod vs)
1041 = nub ([done | done <- modsDone,
1042 done `elem` names_in_this_cycle])
1043 chewed_rest = chew rest
1045 if notNull mods_in_this_cycle
1046 && length mods_in_this_cycle < length names_in_this_cycle
1047 then mods_in_this_cycle ++ chewed_rest
1050 -- -----------------------------------------------------------------------------
1053 -- This is where we compile each module in the module graph, in a pass
1054 -- from the bottom to the top of the graph.
1056 -- There better had not be any cyclic groups here -- we check for them.
1059 :: HscEnv -- Includes initially-empty HPT
1060 -> HomePackageTable -- HPT from last time round (pruned)
1061 -> ([ModuleName],[ModuleName]) -- stable modules (see checkStability)
1062 -> IO () -- How to clean up unwanted tmp files
1063 -> [SCC ModSummary] -- Mods to do (the worklist)
1065 HscEnv, -- With an updated HPT
1066 [ModSummary]) -- Mods which succeeded
1068 upsweep hsc_env old_hpt stable_mods cleanup mods
1069 = upsweep' hsc_env old_hpt stable_mods cleanup mods 1 (length mods)
1071 upsweep' hsc_env old_hpt stable_mods cleanup
1073 = return (Succeeded, hsc_env, [])
1075 upsweep' hsc_env old_hpt stable_mods cleanup
1076 (CyclicSCC ms:_) _ _
1077 = do fatalErrorMsg (hsc_dflags hsc_env) (cyclicModuleErr ms)
1078 return (Failed, hsc_env, [])
1080 upsweep' hsc_env old_hpt stable_mods cleanup
1081 (AcyclicSCC mod:mods) mod_index nmods
1082 = do -- putStrLn ("UPSWEEP_MOD: hpt = " ++
1083 -- show (map (moduleUserString.moduleName.mi_module.hm_iface)
1084 -- (moduleEnvElts (hsc_HPT hsc_env)))
1086 mb_mod_info <- upsweep_mod hsc_env old_hpt stable_mods mod
1089 cleanup -- Remove unwanted tmp files between compilations
1092 Nothing -> return (Failed, hsc_env, [])
1094 { let this_mod = ms_mod_name mod
1096 -- Add new info to hsc_env
1097 hpt1 = addToUFM (hsc_HPT hsc_env) this_mod mod_info
1098 hsc_env1 = hsc_env { hsc_HPT = hpt1 }
1100 -- Space-saving: delete the old HPT entry
1101 -- for mod BUT if mod is a hs-boot
1102 -- node, don't delete it. For the
1103 -- interface, the HPT entry is probaby for the
1104 -- main Haskell source file. Deleting it
1105 -- would force .. (what?? --SDM)
1106 old_hpt1 | isBootSummary mod = old_hpt
1107 | otherwise = delFromUFM old_hpt this_mod
1109 ; (restOK, hsc_env2, modOKs)
1110 <- upsweep' hsc_env1 old_hpt1 stable_mods cleanup
1111 mods (mod_index+1) nmods
1112 ; return (restOK, hsc_env2, mod:modOKs)
1116 -- Compile a single module. Always produce a Linkable for it if
1117 -- successful. If no compilation happened, return the old Linkable.
1118 upsweep_mod :: HscEnv
1120 -> ([ModuleName],[ModuleName])
1122 -> Int -- index of module
1123 -> Int -- total number of modules
1124 -> IO (Maybe HomeModInfo) -- Nothing => Failed
1126 upsweep_mod hsc_env old_hpt (stable_obj, stable_bco) summary mod_index nmods
1128 this_mod_name = ms_mod_name summary
1129 this_mod = ms_mod summary
1130 mb_obj_date = ms_obj_date summary
1131 obj_fn = ml_obj_file (ms_location summary)
1132 hs_date = ms_hs_date summary
1134 is_stable_obj = this_mod_name `elem` stable_obj
1135 is_stable_bco = this_mod_name `elem` stable_bco
1137 old_hmi = lookupUFM old_hpt this_mod_name
1139 -- We're using the dflags for this module now, obtained by
1140 -- applying any options in its LANGUAGE & OPTIONS_GHC pragmas.
1141 dflags = ms_hspp_opts summary
1142 prevailing_target = hscTarget (hsc_dflags hsc_env)
1143 local_target = hscTarget dflags
1145 -- If OPTIONS_GHC contains -fasm or -fvia-C, be careful that
1146 -- we don't do anything dodgy: these should only work to change
1147 -- from -fvia-C to -fasm and vice-versa, otherwise we could
1148 -- end up trying to link object code to byte code.
1149 target = if prevailing_target /= local_target
1150 && (not (isObjectTarget prevailing_target)
1151 || not (isObjectTarget local_target))
1152 then prevailing_target
1155 -- store the corrected hscTarget into the summary
1156 summary' = summary{ ms_hspp_opts = dflags { hscTarget = target } }
1158 -- The old interface is ok if
1159 -- a) we're compiling a source file, and the old HPT
1160 -- entry is for a source file
1161 -- b) we're compiling a hs-boot file
1162 -- Case (b) allows an hs-boot file to get the interface of its
1163 -- real source file on the second iteration of the compilation
1164 -- manager, but that does no harm. Otherwise the hs-boot file
1165 -- will always be recompiled
1170 Just hm_info | isBootSummary summary -> Just iface
1171 | not (mi_boot iface) -> Just iface
1172 | otherwise -> Nothing
1174 iface = hm_iface hm_info
1176 compile_it :: Maybe Linkable -> IO (Maybe HomeModInfo)
1177 compile_it = upsweep_compile hsc_env old_hpt this_mod_name
1178 summary' mod_index nmods mb_old_iface
1180 compile_it_discard_iface
1181 = upsweep_compile hsc_env old_hpt this_mod_name
1182 summary' mod_index nmods Nothing
1188 -- Regardless of whether we're generating object code or
1189 -- byte code, we can always use an existing object file
1190 -- if it is *stable* (see checkStability).
1191 | is_stable_obj, isJust old_hmi ->
1193 -- object is stable, and we have an entry in the
1194 -- old HPT: nothing to do
1196 | is_stable_obj, isNothing old_hmi -> do
1197 linkable <- findObjectLinkable this_mod obj_fn
1198 (expectJust "upseep1" mb_obj_date)
1199 compile_it (Just linkable)
1200 -- object is stable, but we need to load the interface
1201 -- off disk to make a HMI.
1205 ASSERT(isJust old_hmi) -- must be in the old_hpt
1207 -- BCO is stable: nothing to do
1209 | Just hmi <- old_hmi,
1210 Just l <- hm_linkable hmi, not (isObjectLinkable l),
1211 linkableTime l >= ms_hs_date summary ->
1213 -- we have an old BCO that is up to date with respect
1214 -- to the source: do a recompilation check as normal.
1218 -- no existing code at all: we must recompile.
1220 -- When generating object code, if there's an up-to-date
1221 -- object file on the disk, then we can use it.
1222 -- However, if the object file is new (compared to any
1223 -- linkable we had from a previous compilation), then we
1224 -- must discard any in-memory interface, because this
1225 -- means the user has compiled the source file
1226 -- separately and generated a new interface, that we must
1227 -- read from the disk.
1229 obj | isObjectTarget obj,
1230 Just obj_date <- mb_obj_date, obj_date >= hs_date -> do
1233 | Just l <- hm_linkable hmi,
1234 isObjectLinkable l && linkableTime l == obj_date
1235 -> compile_it (Just l)
1237 linkable <- findObjectLinkable this_mod obj_fn obj_date
1238 compile_it_discard_iface (Just linkable)
1244 -- Run hsc to compile a module
1245 upsweep_compile hsc_env old_hpt this_mod summary
1250 compresult <- compile hsc_env summary mb_old_linkable mb_old_iface
1254 -- Compilation failed. Compile may still have updated the PCS, tho.
1255 CompErrs -> return Nothing
1257 -- Compilation "succeeded", and may or may not have returned a new
1258 -- linkable (depending on whether compilation was actually performed
1260 CompOK new_details new_iface new_linkable
1261 -> do let new_info = HomeModInfo { hm_iface = new_iface,
1262 hm_details = new_details,
1263 hm_linkable = new_linkable }
1264 return (Just new_info)
1267 -- Filter modules in the HPT
1268 retainInTopLevelEnvs :: [ModuleName] -> HomePackageTable -> HomePackageTable
1269 retainInTopLevelEnvs keep_these hpt
1270 = listToUFM [ (mod, expectJust "retain" mb_mod_info)
1272 , let mb_mod_info = lookupUFM hpt mod
1273 , isJust mb_mod_info ]
1275 -- ---------------------------------------------------------------------------
1276 -- Topological sort of the module graph
1279 :: Bool -- Drop hi-boot nodes? (see below)
1283 -- Calculate SCCs of the module graph, possibly dropping the hi-boot nodes
1284 -- The resulting list of strongly-connected-components is in topologically
1285 -- sorted order, starting with the module(s) at the bottom of the
1286 -- dependency graph (ie compile them first) and ending with the ones at
1289 -- Drop hi-boot nodes (first boolean arg)?
1291 -- False: treat the hi-boot summaries as nodes of the graph,
1292 -- so the graph must be acyclic
1294 -- True: eliminate the hi-boot nodes, and instead pretend
1295 -- the a source-import of Foo is an import of Foo
1296 -- The resulting graph has no hi-boot nodes, but can by cyclic
1298 topSortModuleGraph drop_hs_boot_nodes summaries Nothing
1299 = stronglyConnComp (fst (moduleGraphNodes drop_hs_boot_nodes summaries))
1300 topSortModuleGraph drop_hs_boot_nodes summaries (Just mod)
1301 = stronglyConnComp (map vertex_fn (reachable graph root))
1303 -- restrict the graph to just those modules reachable from
1304 -- the specified module. We do this by building a graph with
1305 -- the full set of nodes, and determining the reachable set from
1306 -- the specified node.
1307 (nodes, lookup_key) = moduleGraphNodes drop_hs_boot_nodes summaries
1308 (graph, vertex_fn, key_fn) = graphFromEdges' nodes
1310 | Just key <- lookup_key HsSrcFile mod, Just v <- key_fn key = v
1311 | otherwise = throwDyn (ProgramError "module does not exist")
1313 moduleGraphNodes :: Bool -> [ModSummary]
1314 -> ([(ModSummary, Int, [Int])], HscSource -> ModuleName -> Maybe Int)
1315 moduleGraphNodes drop_hs_boot_nodes summaries = (nodes, lookup_key)
1317 -- Drop hs-boot nodes by using HsSrcFile as the key
1318 hs_boot_key | drop_hs_boot_nodes = HsSrcFile
1319 | otherwise = HsBootFile
1321 -- We use integers as the keys for the SCC algorithm
1322 nodes :: [(ModSummary, Int, [Int])]
1323 nodes = [(s, expectJust "topSort" $
1324 lookup_key (ms_hsc_src s) (ms_mod_name s),
1325 out_edge_keys hs_boot_key (map unLoc (ms_srcimps s)) ++
1326 out_edge_keys HsSrcFile (map unLoc (ms_imps s)) ++
1327 (-- see [boot-edges] below
1328 if drop_hs_boot_nodes || ms_hsc_src s == HsBootFile
1330 else case lookup_key HsBootFile (ms_mod_name s) of
1335 , not (isBootSummary s && drop_hs_boot_nodes) ]
1336 -- Drop the hi-boot ones if told to do so
1338 -- [boot-edges] if this is a .hs and there is an equivalent
1339 -- .hs-boot, add a link from the former to the latter. This
1340 -- has the effect of detecting bogus cases where the .hs-boot
1341 -- depends on the .hs, by introducing a cycle. Additionally,
1342 -- it ensures that we will always process the .hs-boot before
1343 -- the .hs, and so the HomePackageTable will always have the
1344 -- most up to date information.
1346 key_map :: NodeMap Int
1347 key_map = listToFM ([(moduleName (ms_mod s), ms_hsc_src s)
1351 lookup_key :: HscSource -> ModuleName -> Maybe Int
1352 lookup_key hs_src mod = lookupFM key_map (mod, hs_src)
1354 out_edge_keys :: HscSource -> [ModuleName] -> [Int]
1355 out_edge_keys hi_boot ms = mapCatMaybes (lookup_key hi_boot) ms
1356 -- If we want keep_hi_boot_nodes, then we do lookup_key with
1357 -- the IsBootInterface parameter True; else False
1360 type NodeKey = (ModuleName, HscSource) -- The nodes of the graph are
1361 type NodeMap a = FiniteMap NodeKey a -- keyed by (mod, src_file_type) pairs
1363 msKey :: ModSummary -> NodeKey
1364 msKey (ModSummary { ms_mod = mod, ms_hsc_src = boot }) = (moduleName mod,boot)
1366 mkNodeMap :: [ModSummary] -> NodeMap ModSummary
1367 mkNodeMap summaries = listToFM [ (msKey s, s) | s <- summaries]
1369 nodeMapElts :: NodeMap a -> [a]
1370 nodeMapElts = eltsFM
1372 -- If there are {-# SOURCE #-} imports between strongly connected
1373 -- components in the topological sort, then those imports can
1374 -- definitely be replaced by ordinary non-SOURCE imports: if SOURCE
1375 -- were necessary, then the edge would be part of a cycle.
1376 warnUnnecessarySourceImports :: DynFlags -> [SCC ModSummary] -> IO ()
1377 warnUnnecessarySourceImports dflags sccs =
1378 printBagOfWarnings dflags (listToBag (concat (map (check.flattenSCC) sccs)))
1380 let mods_in_this_cycle = map ms_mod_name ms in
1381 [ warn m i | m <- ms, i <- ms_srcimps m,
1382 unLoc i `notElem` mods_in_this_cycle ]
1384 warn :: ModSummary -> Located ModuleName -> WarnMsg
1385 warn ms (L loc mod) =
1387 (ptext SLIT("Warning: {-# SOURCE #-} unnecessary in import of ")
1388 <+> quotes (ppr mod))
1390 -----------------------------------------------------------------------------
1391 -- Downsweep (dependency analysis)
1393 -- Chase downwards from the specified root set, returning summaries
1394 -- for all home modules encountered. Only follow source-import
1397 -- We pass in the previous collection of summaries, which is used as a
1398 -- cache to avoid recalculating a module summary if the source is
1401 -- The returned list of [ModSummary] nodes has one node for each home-package
1402 -- module, plus one for any hs-boot files. The imports of these nodes
1403 -- are all there, including the imports of non-home-package modules.
1406 -> [ModSummary] -- Old summaries
1407 -> [ModuleName] -- Ignore dependencies on these; treat
1408 -- them as if they were package modules
1409 -> Bool -- True <=> allow multiple targets to have
1410 -- the same module name; this is
1411 -- very useful for ghc -M
1412 -> IO (Maybe [ModSummary])
1413 -- The elts of [ModSummary] all have distinct
1414 -- (Modules, IsBoot) identifiers, unless the Bool is true
1415 -- in which case there can be repeats
1416 downsweep hsc_env old_summaries excl_mods allow_dup_roots
1417 = -- catch error messages and return them
1418 handleDyn (\err_msg -> printBagOfErrors (hsc_dflags hsc_env) (unitBag err_msg) >> return Nothing) $ do
1419 rootSummaries <- mapM getRootSummary roots
1420 let root_map = mkRootMap rootSummaries
1421 checkDuplicates root_map
1422 summs <- loop (concatMap msDeps rootSummaries) root_map
1425 roots = hsc_targets hsc_env
1427 old_summary_map :: NodeMap ModSummary
1428 old_summary_map = mkNodeMap old_summaries
1430 getRootSummary :: Target -> IO ModSummary
1431 getRootSummary (Target (TargetFile file mb_phase) maybe_buf)
1432 = do exists <- doesFileExist file
1434 then summariseFile hsc_env old_summaries file mb_phase maybe_buf
1435 else throwDyn $ mkPlainErrMsg noSrcSpan $
1436 text "can't find file:" <+> text file
1437 getRootSummary (Target (TargetModule modl) maybe_buf)
1438 = do maybe_summary <- summariseModule hsc_env old_summary_map False
1439 (L rootLoc modl) maybe_buf excl_mods
1440 case maybe_summary of
1441 Nothing -> packageModErr modl
1444 rootLoc = mkGeneralSrcSpan FSLIT("<command line>")
1446 -- In a root module, the filename is allowed to diverge from the module
1447 -- name, so we have to check that there aren't multiple root files
1448 -- defining the same module (otherwise the duplicates will be silently
1449 -- ignored, leading to confusing behaviour).
1450 checkDuplicates :: NodeMap [ModSummary] -> IO ()
1451 checkDuplicates root_map
1452 | allow_dup_roots = return ()
1453 | null dup_roots = return ()
1454 | otherwise = multiRootsErr (head dup_roots)
1456 dup_roots :: [[ModSummary]] -- Each at least of length 2
1457 dup_roots = filterOut isSingleton (nodeMapElts root_map)
1459 loop :: [(Located ModuleName,IsBootInterface)]
1460 -- Work list: process these modules
1461 -> NodeMap [ModSummary]
1462 -- Visited set; the range is a list because
1463 -- the roots can have the same module names
1464 -- if allow_dup_roots is True
1466 -- The result includes the worklist, except
1467 -- for those mentioned in the visited set
1468 loop [] done = return (concat (nodeMapElts done))
1469 loop ((wanted_mod, is_boot) : ss) done
1470 | Just summs <- lookupFM done key
1471 = if isSingleton summs then
1474 do { multiRootsErr summs; return [] }
1475 | otherwise = do { mb_s <- summariseModule hsc_env old_summary_map
1476 is_boot wanted_mod Nothing excl_mods
1478 Nothing -> loop ss done
1479 Just s -> loop (msDeps s ++ ss)
1480 (addToFM done key [s]) }
1482 key = (unLoc wanted_mod, if is_boot then HsBootFile else HsSrcFile)
1484 mkRootMap :: [ModSummary] -> NodeMap [ModSummary]
1485 mkRootMap summaries = addListToFM_C (++) emptyFM
1486 [ (msKey s, [s]) | s <- summaries ]
1488 msDeps :: ModSummary -> [(Located ModuleName, IsBootInterface)]
1489 -- (msDeps s) returns the dependencies of the ModSummary s.
1490 -- A wrinkle is that for a {-# SOURCE #-} import we return
1491 -- *both* the hs-boot file
1492 -- *and* the source file
1493 -- as "dependencies". That ensures that the list of all relevant
1494 -- modules always contains B.hs if it contains B.hs-boot.
1495 -- Remember, this pass isn't doing the topological sort. It's
1496 -- just gathering the list of all relevant ModSummaries
1498 concat [ [(m,True), (m,False)] | m <- ms_srcimps s ]
1499 ++ [ (m,False) | m <- ms_imps s ]
1501 -----------------------------------------------------------------------------
1502 -- Summarising modules
1504 -- We have two types of summarisation:
1506 -- * Summarise a file. This is used for the root module(s) passed to
1507 -- cmLoadModules. The file is read, and used to determine the root
1508 -- module name. The module name may differ from the filename.
1510 -- * Summarise a module. We are given a module name, and must provide
1511 -- a summary. The finder is used to locate the file in which the module
1516 -> [ModSummary] -- old summaries
1517 -> FilePath -- source file name
1518 -> Maybe Phase -- start phase
1519 -> Maybe (StringBuffer,ClockTime)
1522 summariseFile hsc_env old_summaries file mb_phase maybe_buf
1523 -- we can use a cached summary if one is available and the
1524 -- source file hasn't changed, But we have to look up the summary
1525 -- by source file, rather than module name as we do in summarise.
1526 | Just old_summary <- findSummaryBySourceFile old_summaries file
1528 let location = ms_location old_summary
1530 -- return the cached summary if the source didn't change
1531 src_timestamp <- case maybe_buf of
1532 Just (_,t) -> return t
1533 Nothing -> getModificationTime file
1534 -- The file exists; we checked in getRootSummary above.
1535 -- If it gets removed subsequently, then this
1536 -- getModificationTime may fail, but that's the right
1539 if ms_hs_date old_summary == src_timestamp
1540 then do -- update the object-file timestamp
1541 obj_timestamp <- getObjTimestamp location False
1542 return old_summary{ ms_obj_date = obj_timestamp }
1550 let dflags = hsc_dflags hsc_env
1552 (dflags', hspp_fn, buf)
1553 <- preprocessFile dflags file mb_phase maybe_buf
1555 (srcimps,the_imps, L _ mod_name) <- getImports dflags' buf hspp_fn
1557 -- Make a ModLocation for this file
1558 location <- mkHomeModLocation dflags mod_name file
1560 -- Tell the Finder cache where it is, so that subsequent calls
1561 -- to findModule will find it, even if it's not on any search path
1562 mod <- addHomeModuleToFinder hsc_env mod_name location
1564 src_timestamp <- case maybe_buf of
1565 Just (_,t) -> return t
1566 Nothing -> getModificationTime file
1567 -- getMofificationTime may fail
1569 obj_timestamp <- modificationTimeIfExists (ml_obj_file location)
1571 return (ModSummary { ms_mod = mod, ms_hsc_src = HsSrcFile,
1572 ms_location = location,
1573 ms_hspp_file = hspp_fn,
1574 ms_hspp_opts = dflags',
1575 ms_hspp_buf = Just buf,
1576 ms_srcimps = srcimps, ms_imps = the_imps,
1577 ms_hs_date = src_timestamp,
1578 ms_obj_date = obj_timestamp })
1580 findSummaryBySourceFile :: [ModSummary] -> FilePath -> Maybe ModSummary
1581 findSummaryBySourceFile summaries file
1582 = case [ ms | ms <- summaries, HsSrcFile <- [ms_hsc_src ms],
1583 expectJust "findSummaryBySourceFile" (ml_hs_file (ms_location ms)) == file ] of
1587 -- Summarise a module, and pick up source and timestamp.
1590 -> NodeMap ModSummary -- Map of old summaries
1591 -> IsBootInterface -- True <=> a {-# SOURCE #-} import
1592 -> Located ModuleName -- Imported module to be summarised
1593 -> Maybe (StringBuffer, ClockTime)
1594 -> [ModuleName] -- Modules to exclude
1595 -> IO (Maybe ModSummary) -- Its new summary
1597 summariseModule hsc_env old_summary_map is_boot (L loc wanted_mod) maybe_buf excl_mods
1598 | wanted_mod `elem` excl_mods
1601 | Just old_summary <- lookupFM old_summary_map (wanted_mod, hsc_src)
1602 = do -- Find its new timestamp; all the
1603 -- ModSummaries in the old map have valid ml_hs_files
1604 let location = ms_location old_summary
1605 src_fn = expectJust "summariseModule" (ml_hs_file location)
1607 -- check the modification time on the source file, and
1608 -- return the cached summary if it hasn't changed. If the
1609 -- file has disappeared, we need to call the Finder again.
1611 Just (_,t) -> check_timestamp old_summary location src_fn t
1613 m <- System.IO.Error.try (getModificationTime src_fn)
1615 Right t -> check_timestamp old_summary location src_fn t
1616 Left e | isDoesNotExistError e -> find_it
1617 | otherwise -> ioError e
1619 | otherwise = find_it
1621 dflags = hsc_dflags hsc_env
1623 hsc_src = if is_boot then HsBootFile else HsSrcFile
1625 check_timestamp old_summary location src_fn src_timestamp
1626 | ms_hs_date old_summary == src_timestamp = do
1627 -- update the object-file timestamp
1628 obj_timestamp <- getObjTimestamp location is_boot
1629 return (Just old_summary{ ms_obj_date = obj_timestamp })
1631 -- source changed: re-summarise.
1632 new_summary location (ms_mod old_summary) src_fn src_timestamp
1635 -- Don't use the Finder's cache this time. If the module was
1636 -- previously a package module, it may have now appeared on the
1637 -- search path, so we want to consider it to be a home module. If
1638 -- the module was previously a home module, it may have moved.
1639 uncacheModule hsc_env wanted_mod
1640 found <- findImportedModule hsc_env wanted_mod Nothing
1643 | isJust (ml_hs_file location) ->
1645 just_found location mod
1647 -- Drop external-pkg
1648 ASSERT(modulePackageId mod /= thisPackage dflags)
1652 err -> noModError dflags loc wanted_mod err
1655 just_found location mod = do
1656 -- Adjust location to point to the hs-boot source file,
1657 -- hi file, object file, when is_boot says so
1658 let location' | is_boot = addBootSuffixLocn location
1659 | otherwise = location
1660 src_fn = expectJust "summarise2" (ml_hs_file location')
1662 -- Check that it exists
1663 -- It might have been deleted since the Finder last found it
1664 maybe_t <- modificationTimeIfExists src_fn
1666 Nothing -> noHsFileErr loc src_fn
1667 Just t -> new_summary location' mod src_fn t
1670 new_summary location mod src_fn src_timestamp
1672 -- Preprocess the source file and get its imports
1673 -- The dflags' contains the OPTIONS pragmas
1674 (dflags', hspp_fn, buf) <- preprocessFile dflags src_fn Nothing maybe_buf
1675 (srcimps, the_imps, L mod_loc mod_name) <- getImports dflags' buf hspp_fn
1677 when (mod_name /= wanted_mod) $
1678 throwDyn $ mkPlainErrMsg mod_loc $
1679 text "file name does not match module name"
1680 <+> quotes (ppr mod_name)
1682 -- Find the object timestamp, and return the summary
1683 obj_timestamp <- getObjTimestamp location is_boot
1685 return (Just ( ModSummary { ms_mod = mod,
1686 ms_hsc_src = hsc_src,
1687 ms_location = location,
1688 ms_hspp_file = hspp_fn,
1689 ms_hspp_opts = dflags',
1690 ms_hspp_buf = Just buf,
1691 ms_srcimps = srcimps,
1693 ms_hs_date = src_timestamp,
1694 ms_obj_date = obj_timestamp }))
1697 getObjTimestamp location is_boot
1698 = if is_boot then return Nothing
1699 else modificationTimeIfExists (ml_obj_file location)
1702 preprocessFile :: DynFlags -> FilePath -> Maybe Phase -> Maybe (StringBuffer,ClockTime)
1703 -> IO (DynFlags, FilePath, StringBuffer)
1704 preprocessFile dflags src_fn mb_phase Nothing
1706 (dflags', hspp_fn) <- preprocess dflags (src_fn, mb_phase)
1707 buf <- hGetStringBuffer hspp_fn
1708 return (dflags', hspp_fn, buf)
1710 preprocessFile dflags src_fn mb_phase (Just (buf, time))
1712 -- case we bypass the preprocessing stage?
1714 local_opts = getOptions buf src_fn
1716 (dflags', errs) <- parseDynamicFlags dflags (map unLoc local_opts)
1720 | Just (Unlit _) <- mb_phase = True
1721 | Nothing <- mb_phase, Unlit _ <- startPhase src_fn = True
1722 -- note: local_opts is only required if there's no Unlit phase
1723 | dopt Opt_Cpp dflags' = True
1724 | dopt Opt_Pp dflags' = True
1727 when needs_preprocessing $
1728 ghcError (ProgramError "buffer needs preprocesing; interactive check disabled")
1730 return (dflags', src_fn, buf)
1733 -----------------------------------------------------------------------------
1735 -----------------------------------------------------------------------------
1737 noModError :: DynFlags -> SrcSpan -> ModuleName -> FindResult -> IO ab
1738 -- ToDo: we don't have a proper line number for this error
1739 noModError dflags loc wanted_mod err
1740 = throwDyn $ mkPlainErrMsg loc $ cannotFindModule dflags wanted_mod err
1742 noHsFileErr loc path
1743 = throwDyn $ mkPlainErrMsg loc $ text "Can't find" <+> text path
1746 = throwDyn $ mkPlainErrMsg noSrcSpan $
1747 text "module" <+> quotes (ppr mod) <+> text "is a package module"
1749 multiRootsErr :: [ModSummary] -> IO ()
1750 multiRootsErr summs@(summ1:_)
1751 = throwDyn $ mkPlainErrMsg noSrcSpan $
1752 text "module" <+> quotes (ppr mod) <+>
1753 text "is defined in multiple files:" <+>
1754 sep (map text files)
1757 files = map (expectJust "checkDup" . ml_hs_file . ms_location) summs
1759 cyclicModuleErr :: [ModSummary] -> SDoc
1761 = hang (ptext SLIT("Module imports form a cycle for modules:"))
1762 2 (vcat (map show_one ms))
1764 show_one ms = sep [ show_mod (ms_hsc_src ms) (ms_mod ms),
1765 nest 2 $ ptext SLIT("imports:") <+>
1766 (pp_imps HsBootFile (ms_srcimps ms)
1767 $$ pp_imps HsSrcFile (ms_imps ms))]
1768 show_mod hsc_src mod = ppr mod <> text (hscSourceString hsc_src)
1769 pp_imps src mods = fsep (map (show_mod src) mods)
1772 -- | Inform GHC that the working directory has changed. GHC will flush
1773 -- its cache of module locations, since it may no longer be valid.
1774 -- Note: if you change the working directory, you should also unload
1775 -- the current program (set targets to empty, followed by load).
1776 workingDirectoryChanged :: Session -> IO ()
1777 workingDirectoryChanged s = withSession s $ flushFinderCaches
1779 -- -----------------------------------------------------------------------------
1780 -- inspecting the session
1782 -- | Get the module dependency graph.
1783 getModuleGraph :: Session -> IO ModuleGraph -- ToDo: DiGraph ModSummary
1784 getModuleGraph s = withSession s (return . hsc_mod_graph)
1786 isLoaded :: Session -> ModuleName -> IO Bool
1787 isLoaded s m = withSession s $ \hsc_env ->
1788 return $! isJust (lookupUFM (hsc_HPT hsc_env) m)
1790 getBindings :: Session -> IO [TyThing]
1791 getBindings s = withSession s $ \hsc_env ->
1792 -- we have to implement the shadowing behaviour of ic_tmp_ids here
1793 -- (see InteractiveContext) and the quickest way is to use an OccEnv.
1795 tmp_ids = ic_tmp_ids (hsc_IC hsc_env)
1796 filtered = foldr f (const []) tmp_ids emptyUniqSet
1798 | uniq `elementOfUniqSet` set = rest set
1799 | otherwise = AnId id : rest (addOneToUniqSet set uniq)
1800 where uniq = getUnique (nameOccName (idName id))
1804 getPrintUnqual :: Session -> IO PrintUnqualified
1805 getPrintUnqual s = withSession s (return . icPrintUnqual . hsc_IC)
1807 -- | Container for information about a 'Module'.
1808 data ModuleInfo = ModuleInfo {
1809 minf_type_env :: TypeEnv,
1810 minf_exports :: NameSet, -- ToDo, [AvailInfo] like ModDetails?
1811 minf_rdr_env :: Maybe GlobalRdrEnv, -- Nothing for a compiled/package mod
1812 minf_instances :: [Instance]
1814 ,minf_modBreaks :: ModBreaks
1816 -- ToDo: this should really contain the ModIface too
1818 -- We don't want HomeModInfo here, because a ModuleInfo applies
1819 -- to package modules too.
1821 -- | Request information about a loaded 'Module'
1822 getModuleInfo :: Session -> Module -> IO (Maybe ModuleInfo)
1823 getModuleInfo s mdl = withSession s $ \hsc_env -> do
1824 let mg = hsc_mod_graph hsc_env
1825 if mdl `elem` map ms_mod mg
1826 then getHomeModuleInfo hsc_env (moduleName mdl)
1828 {- if isHomeModule (hsc_dflags hsc_env) mdl
1830 else -} getPackageModuleInfo hsc_env mdl
1831 -- getPackageModuleInfo will attempt to find the interface, so
1832 -- we don't want to call it for a home module, just in case there
1833 -- was a problem loading the module and the interface doesn't
1834 -- exist... hence the isHomeModule test here. (ToDo: reinstate)
1836 getPackageModuleInfo :: HscEnv -> Module -> IO (Maybe ModuleInfo)
1837 getPackageModuleInfo hsc_env mdl = do
1839 (_msgs, mb_avails) <- getModuleExports hsc_env mdl
1841 Nothing -> return Nothing
1843 eps <- readIORef (hsc_EPS hsc_env)
1845 names = availsToNameSet avails
1847 tys = [ ty | name <- concatMap availNames avails,
1848 Just ty <- [lookupTypeEnv pte name] ]
1850 return (Just (ModuleInfo {
1851 minf_type_env = mkTypeEnv tys,
1852 minf_exports = names,
1853 minf_rdr_env = Just $! nameSetToGlobalRdrEnv names (moduleName mdl),
1854 minf_instances = error "getModuleInfo: instances for package module unimplemented",
1855 minf_modBreaks = emptyModBreaks
1858 -- bogusly different for non-GHCI (ToDo)
1862 getHomeModuleInfo hsc_env mdl =
1863 case lookupUFM (hsc_HPT hsc_env) mdl of
1864 Nothing -> return Nothing
1866 let details = hm_details hmi
1867 return (Just (ModuleInfo {
1868 minf_type_env = md_types details,
1869 minf_exports = availsToNameSet (md_exports details),
1870 minf_rdr_env = mi_globals $! hm_iface hmi,
1871 minf_instances = md_insts details
1873 ,minf_modBreaks = md_modBreaks details
1877 -- | The list of top-level entities defined in a module
1878 modInfoTyThings :: ModuleInfo -> [TyThing]
1879 modInfoTyThings minf = typeEnvElts (minf_type_env minf)
1881 modInfoTopLevelScope :: ModuleInfo -> Maybe [Name]
1882 modInfoTopLevelScope minf
1883 = fmap (map gre_name . globalRdrEnvElts) (minf_rdr_env minf)
1885 modInfoExports :: ModuleInfo -> [Name]
1886 modInfoExports minf = nameSetToList $! minf_exports minf
1888 -- | Returns the instances defined by the specified module.
1889 -- Warning: currently unimplemented for package modules.
1890 modInfoInstances :: ModuleInfo -> [Instance]
1891 modInfoInstances = minf_instances
1893 modInfoIsExportedName :: ModuleInfo -> Name -> Bool
1894 modInfoIsExportedName minf name = elemNameSet name (minf_exports minf)
1896 modInfoPrintUnqualified :: ModuleInfo -> Maybe PrintUnqualified
1897 modInfoPrintUnqualified minf = fmap mkPrintUnqualified (minf_rdr_env minf)
1899 modInfoLookupName :: Session -> ModuleInfo -> Name -> IO (Maybe TyThing)
1900 modInfoLookupName s minf name = withSession s $ \hsc_env -> do
1901 case lookupTypeEnv (minf_type_env minf) name of
1902 Just tyThing -> return (Just tyThing)
1904 eps <- readIORef (hsc_EPS hsc_env)
1905 return $! lookupType (hsc_dflags hsc_env)
1906 (hsc_HPT hsc_env) (eps_PTE eps) name
1909 modInfoModBreaks = minf_modBreaks
1912 isDictonaryId :: Id -> Bool
1914 = case tcSplitSigmaTy (idType id) of { (tvs, theta, tau) -> isDictTy tau }
1916 -- | Looks up a global name: that is, any top-level name in any
1917 -- visible module. Unlike 'lookupName', lookupGlobalName does not use
1918 -- the interactive context, and therefore does not require a preceding
1920 lookupGlobalName :: Session -> Name -> IO (Maybe TyThing)
1921 lookupGlobalName s name = withSession s $ \hsc_env -> do
1922 eps <- readIORef (hsc_EPS hsc_env)
1923 return $! lookupType (hsc_dflags hsc_env)
1924 (hsc_HPT hsc_env) (eps_PTE eps) name
1926 -- -----------------------------------------------------------------------------
1927 -- Misc exported utils
1929 dataConType :: DataCon -> Type
1930 dataConType dc = idType (dataConWrapId dc)
1932 -- | print a 'NamedThing', adding parentheses if the name is an operator.
1933 pprParenSymName :: NamedThing a => a -> SDoc
1934 pprParenSymName a = parenSymOcc (getOccName a) (ppr (getName a))
1936 -- ----------------------------------------------------------------------------
1941 -- - Data and Typeable instances for HsSyn.
1943 -- ToDo: check for small transformations that happen to the syntax in
1944 -- the typechecker (eg. -e ==> negate e, perhaps for fromIntegral)
1946 -- ToDo: maybe use TH syntax instead of IfaceSyn? There's already a way
1947 -- to get from TyCons, Ids etc. to TH syntax (reify).
1949 -- :browse will use either lm_toplev or inspect lm_interface, depending
1950 -- on whether the module is interpreted or not.
1952 -- This is for reconstructing refactored source code
1953 -- Calls the lexer repeatedly.
1954 -- ToDo: add comment tokens to token stream
1955 getTokenStream :: Session -> Module -> IO [Located Token]
1958 -- -----------------------------------------------------------------------------
1959 -- Interactive evaluation
1961 -- | Takes a 'ModuleName' and possibly a 'PackageId', and consults the
1962 -- filesystem and package database to find the corresponding 'Module',
1963 -- using the algorithm that is used for an @import@ declaration.
1964 findModule :: Session -> ModuleName -> Maybe PackageId -> IO Module
1965 findModule s mod_name maybe_pkg = withSession s $ \hsc_env ->
1966 findModule' hsc_env mod_name maybe_pkg
1968 findModule' hsc_env mod_name maybe_pkg =
1970 dflags = hsc_dflags hsc_env
1971 hpt = hsc_HPT hsc_env
1972 this_pkg = thisPackage dflags
1974 case lookupUFM hpt mod_name of
1975 Just mod_info -> return (mi_module (hm_iface mod_info))
1976 _not_a_home_module -> do
1977 res <- findImportedModule hsc_env mod_name maybe_pkg
1979 Found _ m | modulePackageId m /= this_pkg -> return m
1980 | otherwise -> throwDyn (CmdLineError (showSDoc $
1981 text "module" <+> pprModule m <+>
1982 text "is not loaded"))
1983 err -> let msg = cannotFindModule dflags mod_name err in
1984 throwDyn (CmdLineError (showSDoc msg))
1987 getHistorySpan :: Session -> History -> IO SrcSpan
1988 getHistorySpan sess h = withSession sess $ \hsc_env ->
1989 return$ InteractiveEval.getHistorySpan hsc_env h
1991 obtainTerm :: Session -> Bool -> Id -> IO Term
1992 obtainTerm sess force id = withSession sess $ \hsc_env ->
1993 InteractiveEval.obtainTerm hsc_env force id
1995 obtainTerm1 :: Session -> Bool -> Maybe Type -> a -> IO Term
1996 obtainTerm1 sess force mb_ty a = withSession sess $ \hsc_env ->
1997 InteractiveEval.obtainTerm1 hsc_env force mb_ty a
1999 obtainTermB :: Session -> Int -> Bool -> Id -> IO Term
2000 obtainTermB sess bound force id = withSession sess $ \hsc_env ->
2001 InteractiveEval.obtainTermB hsc_env bound force id