1 {-# OPTIONS -#include "Linker.h" #-}
2 -----------------------------------------------------------------------------
3 -- $Id: InteractiveUI.hs,v 1.185 2005/01/28 12:55:23 simonmar Exp $
5 -- GHC Interactive User Interface
7 -- (c) The GHC Team 2004
9 -----------------------------------------------------------------------------
10 module InteractiveUI (
11 interactiveUI, -- :: CmState -> [FilePath] -> IO ()
15 #include "HsVersions.h"
18 import HscTypes ( HomeModInfo(hm_linkable), HomePackageTable,
19 isObjectLinkable, GhciMode(..) )
20 import IfaceSyn ( IfaceDecl(..), IfaceClassOp(..), IfaceConDecls(..), IfaceConDecl(..),
21 IfaceInst(..), pprIfaceDeclHead, pprParendIfaceType, pprIfaceForAllPart )
22 import FunDeps ( pprFundeps )
25 import DriverUtil ( remove_spaces )
26 import Linker ( showLinkerState, linkPackages )
28 import Name ( Name, NamedThing(..) )
29 import OccName ( OccName, isSymOcc, occNameUserString )
30 import BasicTypes ( StrictnessMark(..), defaultFixity, SuccessFlag(..) )
32 import CmdLineOpts ( DynFlag(..), DynFlags(..), dopt_unset )
33 import Panic hiding ( showException )
35 import SrcLoc ( SrcLoc, isGoodSrcLoc )
37 #ifndef mingw32_HOST_OS
38 import DriverUtil( handle )
40 #if __GLASGOW_HASKELL__ > 504
46 import Control.Concurrent ( yield ) -- Used in readline loop
47 import System.Console.Readline as Readline
52 import Control.Exception as Exception
54 import Control.Concurrent
58 import Data.Int ( Int64 )
61 import System.Environment
62 import System.Directory
64 import System.IO.Error as IO
66 import Control.Monad as Monad
67 import Foreign.StablePtr ( newStablePtr )
69 import GHC.Exts ( unsafeCoerce# )
70 import GHC.IOBase ( IOErrorType(InvalidArgument) )
72 import Data.IORef ( IORef, newIORef, readIORef, writeIORef )
74 import System.Posix.Internals ( setNonBlockingFD )
76 -----------------------------------------------------------------------------
80 " / _ \\ /\\ /\\/ __(_)\n"++
81 " / /_\\// /_/ / / | | GHC Interactive, version " ++ cProjectVersion ++ ", for Haskell 98.\n"++
82 "/ /_\\\\/ __ / /___| | http://www.haskell.org/ghc/\n"++
83 "\\____/\\/ /_/\\____/|_| Type :? for help.\n"
85 GLOBAL_VAR(commands, builtin_commands, [(String, String -> GHCi Bool)])
87 builtin_commands :: [(String, String -> GHCi Bool)]
89 ("add", keepGoingPaths addModule),
90 ("browse", keepGoing browseCmd),
91 ("cd", keepGoing changeDirectory),
92 ("def", keepGoing defineMacro),
93 ("help", keepGoing help),
94 ("?", keepGoing help),
95 ("info", keepGoing info),
96 ("load", keepGoingPaths loadModule),
97 ("module", keepGoing setContext),
98 ("reload", keepGoing reloadModule),
99 ("set", keepGoing setCmd),
100 ("show", keepGoing showCmd),
101 ("type", keepGoing typeOfExpr),
102 ("kind", keepGoing kindOfType),
103 ("unset", keepGoing unsetOptions),
104 ("undef", keepGoing undefineMacro),
108 keepGoing :: (String -> GHCi ()) -> (String -> GHCi Bool)
109 keepGoing a str = a str >> return False
111 keepGoingPaths :: ([FilePath] -> GHCi ()) -> (String -> GHCi Bool)
112 keepGoingPaths a str = a (toArgs str) >> return False
114 shortHelpText = "use :? for help.\n"
116 -- NOTE: spaces at the end of each line to workaround CPP/string gap bug.
118 " Commands available from the prompt:\n" ++
120 " <stmt> evaluate/run <stmt>\n" ++
121 " :add <filename> ... add module(s) to the current target set\n" ++
122 " :browse [*]<module> display the names defined by <module>\n" ++
123 " :cd <dir> change directory to <dir>\n" ++
124 " :def <cmd> <expr> define a command :<cmd>\n" ++
125 " :help, :? display this list of commands\n" ++
126 " :info [<name> ...] display information about the given names\n" ++
127 " :load <filename> ... load module(s) and their dependents\n" ++
128 " :module [+/-] [*]<mod> ... set the context for expression evaluation\n" ++
129 " :reload reload the current module set\n" ++
131 " :set <option> ... set options\n" ++
132 " :set args <arg> ... set the arguments returned by System.getArgs\n" ++
133 " :set prog <progname> set the value returned by System.getProgName\n" ++
135 " :show modules show the currently loaded modules\n" ++
136 " :show bindings show the current bindings made at the prompt\n" ++
138 " :type <expr> show the type of <expr>\n" ++
139 " :kind <type> show the kind of <type>\n" ++
140 " :undef <cmd> undefine user-defined command :<cmd>\n" ++
141 " :unset <option> ... unset options\n" ++
142 " :quit exit GHCi\n" ++
143 " :!<command> run the shell command <command>\n" ++
145 " Options for ':set' and ':unset':\n" ++
147 " +r revert top-level expressions after each evaluation\n" ++
148 " +s print timing/memory stats after each evaluation\n" ++
149 " +t print type after evaluation\n" ++
150 " -<flags> most GHC command line flags can also be set here\n" ++
151 " (eg. -v2, -fglasgow-exts, etc.)\n"
154 interactiveUI :: DynFlags -> [FilePath] -> Maybe String -> IO ()
155 interactiveUI dflags srcs maybe_expr = do
157 cmstate <- cmInit Interactive dflags;
159 -- HACK! If we happen to get into an infinite loop (eg the user
160 -- types 'let x=x in x' at the prompt), then the thread will block
161 -- on a blackhole, and become unreachable during GC. The GC will
162 -- detect that it is unreachable and send it the NonTermination
163 -- exception. However, since the thread is unreachable, everything
164 -- it refers to might be finalized, including the standard Handles.
165 -- This sounds like a bug, but we don't have a good solution right
172 hSetBuffering stdout NoBuffering
174 -- Initialise buffering for the *interpreted* I/O system
175 initInterpBuffering cmstate
177 -- We don't want the cmd line to buffer any input that might be
178 -- intended for the program, so unbuffer stdin.
179 hSetBuffering stdin NoBuffering
181 -- initial context is just the Prelude
182 cmstate <- cmSetContext cmstate [] ["Prelude"]
188 startGHCi (runGHCi srcs dflags maybe_expr)
189 GHCiState{ progname = "<interactive>",
196 Readline.resetTerminal Nothing
201 runGHCi :: [FilePath] -> DynFlags -> Maybe String -> GHCi ()
202 runGHCi paths dflags maybe_expr = do
203 read_dot_files <- io (readIORef v_Read_DotGHCi)
205 when (read_dot_files) $ do
208 exists <- io (doesFileExist file)
210 dir_ok <- io (checkPerms ".")
211 file_ok <- io (checkPerms file)
212 when (dir_ok && file_ok) $ do
213 either_hdl <- io (IO.try (openFile "./.ghci" ReadMode))
216 Right hdl -> fileLoop hdl False
218 when (read_dot_files) $ do
219 -- Read in $HOME/.ghci
220 either_dir <- io (IO.try (getEnv "HOME"))
224 cwd <- io (getCurrentDirectory)
225 when (dir /= cwd) $ do
226 let file = dir ++ "/.ghci"
227 ok <- io (checkPerms file)
229 either_hdl <- io (IO.try (openFile file ReadMode))
232 Right hdl -> fileLoop hdl False
234 -- Perform a :load for files given on the GHCi command line
235 when (not (null paths)) $
236 ghciHandle showException $
239 -- if verbosity is greater than 0, or we are connected to a
240 -- terminal, display the prompt in the interactive loop.
241 is_tty <- io (hIsTerminalDevice stdin)
242 let show_prompt = verbosity dflags > 0 || is_tty
246 -- enter the interactive loop
247 interactiveLoop is_tty show_prompt
249 -- just evaluate the expression we were given
254 io $ do when (verbosity dflags > 0) $ putStrLn "Leaving GHCi."
257 interactiveLoop is_tty show_prompt = do
258 -- Ignore ^C exceptions caught here
259 ghciHandleDyn (\e -> case e of
260 Interrupted -> ghciUnblock (interactiveLoop is_tty show_prompt)
261 _other -> return ()) $ do
263 -- read commands from stdin
267 else fileLoop stdin show_prompt
269 fileLoop stdin show_prompt
273 -- NOTE: We only read .ghci files if they are owned by the current user,
274 -- and aren't world writable. Otherwise, we could be accidentally
275 -- running code planted by a malicious third party.
277 -- Furthermore, We only read ./.ghci if . is owned by the current user
278 -- and isn't writable by anyone else. I think this is sufficient: we
279 -- don't need to check .. and ../.. etc. because "." always refers to
280 -- the same directory while a process is running.
282 checkPerms :: String -> IO Bool
284 #ifdef mingw32_HOST_OS
287 DriverUtil.handle (\_ -> return False) $ do
288 st <- getFileStatus name
290 if fileOwner st /= me then do
291 putStrLn $ "WARNING: " ++ name ++ " is owned by someone else, IGNORING!"
294 let mode = fileMode st
295 if (groupWriteMode == (mode `intersectFileModes` groupWriteMode))
296 || (otherWriteMode == (mode `intersectFileModes` otherWriteMode))
298 putStrLn $ "*** WARNING: " ++ name ++
299 " is writable by someone else, IGNORING!"
304 fileLoop :: Handle -> Bool -> GHCi ()
305 fileLoop hdl prompt = do
306 cmstate <- getCmState
307 (mod,imports) <- io (cmGetContext cmstate)
308 when prompt (io (putStr (mkPrompt mod imports)))
309 l <- io (IO.try (hGetLine hdl))
311 Left e | isEOFError e -> return ()
312 | InvalidArgument <- etype -> return ()
313 | otherwise -> io (ioError e)
314 where etype = ioeGetErrorType e
315 -- treat InvalidArgument in the same way as EOF:
316 -- this can happen if the user closed stdin, or
317 -- perhaps did getContents which closes stdin at
320 case remove_spaces l of
321 "" -> fileLoop hdl prompt
322 l -> do quit <- runCommand l
323 if quit then return () else fileLoop hdl prompt
325 stringLoop :: [String] -> GHCi ()
326 stringLoop [] = return ()
327 stringLoop (s:ss) = do
328 case remove_spaces s of
330 l -> do quit <- runCommand l
331 if quit then return () else stringLoop ss
333 mkPrompt toplevs exports
334 = concat (intersperse " " (map ('*':) toplevs ++ exports)) ++ "> "
337 readlineLoop :: GHCi ()
339 cmstate <- getCmState
340 (mod,imports) <- io (cmGetContext cmstate)
342 l <- io (readline (mkPrompt mod imports)
343 `finally` setNonBlockingFD 0)
344 -- readline sometimes puts stdin into blocking mode,
345 -- so we need to put it back for the IO library
349 case remove_spaces l of
354 if quit then return () else readlineLoop
357 runCommand :: String -> GHCi Bool
358 runCommand c = ghciHandle handler (doCommand c)
360 -- This is the exception handler for exceptions generated by the
361 -- user's code; it normally just prints out the exception. The
362 -- handler must be recursive, in case showing the exception causes
363 -- more exceptions to be raised.
365 -- Bugfix: if the user closed stdout or stderr, the flushing will fail,
366 -- raising another exception. We therefore don't put the recursive
367 -- handler arond the flushing operation, so if stderr is closed
368 -- GHCi will just die gracefully rather than going into an infinite loop.
369 handler :: Exception -> GHCi Bool
370 handler exception = do
372 io installSignalHandlers
373 ghciHandle handler (showException exception >> return False)
375 showException (DynException dyn) =
376 case fromDynamic dyn of
377 Nothing -> io (putStrLn ("*** Exception: (unknown)"))
378 Just Interrupted -> io (putStrLn "Interrupted.")
379 Just (CmdLineError s) -> io (putStrLn s) -- omit the location for CmdLineError
380 Just ph@PhaseFailed{} -> io (putStrLn (showGhcException ph "")) -- ditto
381 Just other_ghc_ex -> io (print other_ghc_ex)
383 showException other_exception
384 = io (putStrLn ("*** Exception: " ++ show other_exception))
386 doCommand (':' : command) = specialCommand command
388 = do timeIt (do nms <- runStmt stmt; finishEvalExpr nms)
391 runStmt :: String -> GHCi [Name]
393 | null (filter (not.isSpace) stmt) = return []
395 = do st <- getGHCiState
396 cmstate <- getCmState
397 (new_cmstate, result) <-
398 io $ withProgName (progname st) $ withArgs (args st) $
399 cmRunStmt cmstate stmt
400 setGHCiState st{cmstate = new_cmstate}
402 CmRunFailed -> return []
403 CmRunException e -> showException e >> return []
404 CmRunOk names -> return names
406 -- possibly print the type and revert CAFs after evaluating an expression
408 = do b <- isOptionSet ShowType
409 cmstate <- getCmState
410 when b (mapM_ (showTypeOfName cmstate) names)
413 io installSignalHandlers
414 b <- isOptionSet RevertCAFs
415 io (when b revertCAFs)
418 showTypeOfName :: CmState -> Name -> GHCi ()
419 showTypeOfName cmstate n
420 = do maybe_str <- io (cmTypeOfName cmstate n)
423 Just str -> io (putStrLn (showSDoc (ppr n) ++ " :: " ++ str))
425 specialCommand :: String -> GHCi Bool
426 specialCommand ('!':str) = shellEscape (dropWhile isSpace str)
427 specialCommand str = do
428 let (cmd,rest) = break isSpace str
429 cmds <- io (readIORef commands)
430 case [ (s,f) | (s,f) <- cmds, prefixMatch cmd s ] of
431 [] -> io (hPutStr stdout ("unknown command ':" ++ cmd ++ "'\n"
432 ++ shortHelpText) >> return False)
433 [(_,f)] -> f (dropWhile isSpace rest)
434 cs -> io (hPutStrLn stdout ("prefix " ++ cmd ++
435 " matches multiple commands (" ++
436 foldr1 (\a b -> a ++ ',':b) (map fst cs)
437 ++ ")") >> return False)
439 noArgs c = throwDyn (CmdLineError ("command '" ++ c ++ "' takes no arguments"))
442 -----------------------------------------------------------------------------
443 -- To flush buffers for the *interpreted* computation we need
444 -- to refer to *its* stdout/stderr handles
446 GLOBAL_VAR(flush_interp, error "no flush_interp", IO ())
447 GLOBAL_VAR(turn_off_buffering, error "no flush_stdout", IO ())
449 no_buf_cmd = "IO.hSetBuffering IO.stdout IO.NoBuffering" ++
450 " Prelude.>> IO.hSetBuffering IO.stderr IO.NoBuffering"
451 flush_cmd = "IO.hFlush IO.stdout Prelude.>> IO.hFlush IO.stderr"
453 initInterpBuffering :: CmState -> IO ()
454 initInterpBuffering cmstate
455 = do maybe_hval <- cmCompileExpr cmstate no_buf_cmd
458 Just hval -> writeIORef turn_off_buffering (unsafeCoerce# hval :: IO ())
459 other -> panic "interactiveUI:setBuffering"
461 maybe_hval <- cmCompileExpr cmstate flush_cmd
463 Just hval -> writeIORef flush_interp (unsafeCoerce# hval :: IO ())
464 _ -> panic "interactiveUI:flush"
466 turnOffBuffering -- Turn it off right now
471 flushInterpBuffers :: GHCi ()
473 = io $ do Monad.join (readIORef flush_interp)
476 turnOffBuffering :: IO ()
478 = do Monad.join (readIORef turn_off_buffering)
481 -----------------------------------------------------------------------------
484 help :: String -> GHCi ()
485 help _ = io (putStr helpText)
487 info :: String -> GHCi ()
488 info "" = throwDyn (CmdLineError "syntax: ':i <thing-you-want-info-about>'")
489 info s = do { let names = words s
490 ; init_cms <- getCmState
491 ; mapM_ (infoThing init_cms) names }
494 = do { stuff <- io (cmGetInfo cms name)
495 ; io (putStrLn (showSDocForUser (cmGetPrintUnqual cms) $
496 vcat (intersperse (text "") (map showThing stuff)))) }
498 showThing :: GetInfoResult -> SDoc
499 showThing (wanted_str, (thing, fixity, src_loc, insts))
500 = vcat [ showDecl want_name thing,
503 vcat (map show_inst insts)]
505 want_name occ = wanted_str == occNameUserString occ
508 | fix == defaultFixity = empty
509 | otherwise = ppr fix <+> text wanted_str
511 show_loc loc -- The ppr function for SrcLocs is a bit wonky
512 | isGoodSrcLoc loc = comment <+> ptext SLIT("Defined at") <+> ppr loc
513 | otherwise = comment <+> ppr loc
514 comment = ptext SLIT("--")
516 show_inst (iface_inst, loc)
517 = hang (ptext SLIT("instance") <+> ppr (ifInstHead iface_inst))
518 2 (char '\t' <> show_loc loc)
519 -- The tab tries to make them line up a bit
521 -- Now there is rather a lot of goop just to print declarations in a
522 -- civilised way with "..." for the parts we are less interested in.
524 showDecl :: (OccName -> Bool) -> IfaceDecl -> SDoc
525 showDecl want_name (IfaceForeign {ifName = tc})
526 = ppr tc <+> ptext SLIT("is a foreign type")
528 showDecl want_name (IfaceId {ifName = var, ifType = ty})
529 = ppr var <+> dcolon <+> ppr ty
531 showDecl want_name (IfaceSyn {ifName = tycon, ifTyVars = tyvars, ifSynRhs = mono_ty})
532 = hang (ptext SLIT("type") <+> pprIfaceDeclHead [] tycon tyvars)
533 2 (equals <+> ppr mono_ty)
535 showDecl want_name (IfaceData {ifName = tycon,
536 ifTyVars = tyvars, ifCons = condecls})
537 = hang (pp_nd <+> pprIfaceDeclHead context tycon tyvars)
538 2 (add_bars (ppr_trim show_con cs))
540 show_con (IfVanillaCon { ifConOcc = con_name, ifConInfix = is_infix, ifConArgTys = tys,
541 ifConStricts = strs, ifConFields = flds})
542 | want_name tycon || want_name con_name || any want_name flds
543 = Just (show_guts con_name is_infix tys_w_strs flds)
544 | otherwise = Nothing
546 tys_w_strs = tys `zip` (strs ++ repeat NotMarkedStrict)
547 show_con (IfGadtCon { ifConOcc = con_name, ifConTyVars = tvs, ifConCtxt = theta,
548 ifConArgTys = arg_tys, ifConResTys = res_tys, ifConStricts = strs })
549 | want_name tycon || want_name con_name
550 = Just (ppr_bndr con_name <+> colon <+> pprIfaceForAllPart tvs theta pp_tau)
551 | otherwise = Nothing
553 tys_w_strs = arg_tys `zip` (strs ++ repeat NotMarkedStrict)
554 pp_tau = foldr add pp_res_ty tys_w_strs
555 pp_res_ty = ppr_bndr tycon <+> hsep (map pprParendIfaceType res_tys)
556 add bty pp_ty = ppr_bangty bty <+> arrow <+> pp_ty
558 show_guts con True [ty1, ty2] flds = sep [ppr_bangty ty1, ppr con, ppr_bangty ty2]
559 show_guts con _ tys [] = ppr_bndr con <+> sep (map ppr_bangty tys)
560 show_guts con _ tys flds
561 = ppr_bndr con <+> braces (sep (punctuate comma (ppr_trim show_fld (tys `zip` flds))))
563 show_fld (bty, fld) | want_name tycon || want_name con || want_name fld
564 = Just (ppr_bndr fld <+> dcolon <+> ppr_bangty bty)
565 | otherwise = Nothing
567 (pp_nd, context, cs) = case condecls of
568 IfAbstractTyCon -> (ptext SLIT("data"), [], [])
569 IfDataTyCon (Just cxt) cs -> (ptext SLIT("data"), cxt, cs)
570 IfDataTyCon Nothing cs -> (ptext SLIT("data"), [], cs)
571 IfNewTyCon c -> (ptext SLIT("newtype"), [], [c])
574 add_bars [c] = equals <+> c
575 add_bars (c:cs) = equals <+> sep (c : map (char '|' <+>) cs)
577 ppr_bangty (ty, str) = ppr_str str <> pprParendIfaceType ty
578 ppr_str MarkedStrict = char '!'
579 ppr_str MarkedUnboxed = ptext SLIT("!!")
580 ppr_str NotMarkedStrict = empty
582 showDecl want_name (IfaceClass {ifCtxt = context, ifName = clas, ifTyVars = tyvars,
583 ifFDs = fds, ifSigs = sigs})
584 = hang (ptext SLIT("class") <+> pprIfaceDeclHead context clas tyvars
585 <+> pprFundeps fds <+> ptext SLIT("where"))
586 2 (vcat (ppr_trim show_op sigs))
588 show_op (IfaceClassOp op dm ty)
589 | want_name clas || want_name op = Just (ppr_bndr op <+> dcolon <+> ppr ty)
590 | otherwise = Nothing
592 ppr_trim :: (a -> Maybe SDoc) -> [a] -> [SDoc]
594 = snd (foldr go (False, []) xs)
596 go x (eliding, so_far)
597 | Just doc <- show x = (False, doc : so_far)
598 | otherwise = if eliding then (True, so_far)
599 else (True, ptext SLIT("...") : so_far)
601 ppr_bndr :: OccName -> SDoc
602 -- Wrap operators in ()
603 ppr_bndr occ | isSymOcc occ = parens (ppr occ)
604 | otherwise = ppr occ
607 -----------------------------------------------------------------------------
610 addModule :: [FilePath] -> GHCi ()
612 state <- getGHCiState
613 io (revertCAFs) -- always revert CAFs on load/add.
614 files <- mapM expandPath files
615 let new_targets = files ++ targets state
616 graph <- io (cmDepAnal (cmstate state) new_targets)
617 (cmstate1, ok, mods) <- io (cmLoadModules (cmstate state) graph)
618 setGHCiState state{ cmstate = cmstate1, targets = new_targets }
619 setContextAfterLoad mods
620 dflags <- getDynFlags
621 modulesLoadedMsg ok mods dflags
623 changeDirectory :: String -> GHCi ()
624 changeDirectory dir = do
625 state <- getGHCiState
626 when (targets state /= []) $
627 io $ putStr "Warning: changing directory causes all loaded modules to be unloaded,\nbecause the search path has changed.\n"
628 cmstate1 <- io (cmUnload (cmstate state))
629 setGHCiState state{ cmstate = cmstate1, targets = [] }
630 setContextAfterLoad []
631 dir <- expandPath dir
632 io (setCurrentDirectory dir)
634 defineMacro :: String -> GHCi ()
636 let (macro_name, definition) = break isSpace s
637 cmds <- io (readIORef commands)
639 then throwDyn (CmdLineError "invalid macro name")
641 if (macro_name `elem` map fst cmds)
642 then throwDyn (CmdLineError
643 ("command '" ++ macro_name ++ "' is already defined"))
646 -- give the expression a type signature, so we can be sure we're getting
647 -- something of the right type.
648 let new_expr = '(' : definition ++ ") :: String -> IO String"
650 -- compile the expression
652 maybe_hv <- io (cmCompileExpr cms new_expr)
655 Just hv -> io (writeIORef commands --
656 ((macro_name, keepGoing (runMacro hv)) : cmds))
658 runMacro :: HValue{-String -> IO String-} -> String -> GHCi ()
660 str <- io ((unsafeCoerce# fun :: String -> IO String) s)
661 stringLoop (lines str)
663 undefineMacro :: String -> GHCi ()
664 undefineMacro macro_name = do
665 cmds <- io (readIORef commands)
666 if (macro_name `elem` map fst builtin_commands)
667 then throwDyn (CmdLineError
668 ("command '" ++ macro_name ++ "' cannot be undefined"))
670 if (macro_name `notElem` map fst cmds)
671 then throwDyn (CmdLineError
672 ("command '" ++ macro_name ++ "' not defined"))
674 io (writeIORef commands (filter ((/= macro_name) . fst) cmds))
677 loadModule :: [FilePath] -> GHCi ()
678 loadModule fs = timeIt (loadModule' fs)
680 loadModule' :: [FilePath] -> GHCi ()
681 loadModule' files = do
682 state <- getGHCiState
685 files <- mapM expandPath files
687 -- do the dependency anal first, so that if it fails we don't throw
688 -- away the current set of modules.
689 graph <- io (cmDepAnal (cmstate state) files)
691 -- Dependency anal ok, now unload everything
692 cmstate1 <- io (cmUnload (cmstate state))
693 setGHCiState state{ cmstate = cmstate1, targets = [] }
695 io (revertCAFs) -- always revert CAFs on load.
696 (cmstate2, ok, mods) <- io (cmLoadModules cmstate1 graph)
697 setGHCiState state{ cmstate = cmstate2, targets = files }
699 setContextAfterLoad mods
700 dflags <- getDynFlags
701 modulesLoadedMsg ok mods dflags
704 reloadModule :: String -> GHCi ()
706 state <- getGHCiState
707 case targets state of
708 [] -> io (putStr "no current target\n")
710 -- do the dependency anal first, so that if it fails we don't throw
711 -- away the current set of modules.
712 graph <- io (cmDepAnal (cmstate state) paths)
714 io (revertCAFs) -- always revert CAFs on reload.
716 <- io (cmLoadModules (cmstate state) graph)
717 setGHCiState state{ cmstate=cmstate1 }
718 setContextAfterLoad mods
719 dflags <- getDynFlags
720 modulesLoadedMsg ok mods dflags
722 reloadModule _ = noArgs ":reload"
724 setContextAfterLoad [] = setContext prel
725 setContextAfterLoad (m:_) = do
726 cmstate <- getCmState
727 b <- io (cmModuleIsInterpreted cmstate m)
728 if b then setContext ('*':m) else setContext m
730 modulesLoadedMsg ok mods dflags =
731 when (verbosity dflags > 0) $ do
733 | null mods = text "none."
735 punctuate comma (map text mods)) <> text "."
738 io (putStrLn (showSDoc (text "Failed, modules loaded: " <> mod_commas)))
740 io (putStrLn (showSDoc (text "Ok, modules loaded: " <> mod_commas)))
743 typeOfExpr :: String -> GHCi ()
745 = do cms <- getCmState
746 maybe_tystr <- io (cmTypeOfExpr cms str)
749 Just tystr -> io (putStrLn tystr)
751 kindOfType :: String -> GHCi ()
753 = do cms <- getCmState
754 maybe_tystr <- io (cmKindOfType cms str)
757 Just tystr -> io (putStrLn tystr)
759 quit :: String -> GHCi Bool
762 shellEscape :: String -> GHCi Bool
763 shellEscape str = io (system str >> return False)
765 -----------------------------------------------------------------------------
766 -- Browsing a module's contents
768 browseCmd :: String -> GHCi ()
771 ['*':m] | looksLikeModuleName m -> browseModule m False
772 [m] | looksLikeModuleName m -> browseModule m True
773 _ -> throwDyn (CmdLineError "syntax: :browse <module>")
775 browseModule m exports_only = do
778 is_interpreted <- io (cmModuleIsInterpreted cms m)
779 when (not is_interpreted && not exports_only) $
780 throwDyn (CmdLineError ("module '" ++ m ++ "' is not interpreted"))
782 -- Temporarily set the context to the module we're interested in,
783 -- just so we can get an appropriate PrintUnqualified
784 (as,bs) <- io (cmGetContext cms)
785 cms1 <- io (if exports_only then cmSetContext cms [] [prel,m]
786 else cmSetContext cms [m] [])
787 cms2 <- io (cmSetContext cms1 as bs)
789 things <- io (cmBrowseModule cms2 m exports_only)
791 let unqual = cmGetPrintUnqual cms1 -- NOTE: cms1 with the new context
793 io (putStrLn (showSDocForUser unqual (
794 vcat (map (showDecl (const True)) things)
797 -----------------------------------------------------------------------------
798 -- Setting the module context
801 | all sensible mods = fn mods
802 | otherwise = throwDyn (CmdLineError "syntax: :module [+/-] [*]M1 ... [*]Mn")
804 (fn, mods) = case str of
805 '+':stuff -> (addToContext, words stuff)
806 '-':stuff -> (removeFromContext, words stuff)
807 stuff -> (newContext, words stuff)
809 sensible ('*':m) = looksLikeModuleName m
810 sensible m = looksLikeModuleName m
814 (as,bs) <- separate cms mods [] []
815 let bs' = if null as && prel `notElem` bs then prel:bs else bs
816 cms' <- io (cmSetContext cms as bs')
819 separate cmstate [] as bs = return (as,bs)
820 separate cmstate (('*':m):ms) as bs = do
821 b <- io (cmModuleIsInterpreted cmstate m)
822 if b then separate cmstate ms (m:as) bs
823 else throwDyn (CmdLineError ("module '" ++ m ++ "' is not interpreted"))
824 separate cmstate (m:ms) as bs = separate cmstate ms as (m:bs)
829 addToContext mods = do
831 (as,bs) <- io (cmGetContext cms)
833 (as',bs') <- separate cms mods [] []
835 let as_to_add = as' \\ (as ++ bs)
836 bs_to_add = bs' \\ (as ++ bs)
838 cms' <- io (cmSetContext cms
839 (as ++ as_to_add) (bs ++ bs_to_add))
843 removeFromContext mods = do
845 (as,bs) <- io (cmGetContext cms)
847 (as_to_remove,bs_to_remove) <- separate cms mods [] []
849 let as' = as \\ (as_to_remove ++ bs_to_remove)
850 bs' = bs \\ (as_to_remove ++ bs_to_remove)
852 cms' <- io (cmSetContext cms as' bs')
855 ----------------------------------------------------------------------------
858 -- set options in the interpreter. Syntax is exactly the same as the
859 -- ghc command line, except that certain options aren't available (-C,
862 -- This is pretty fragile: most options won't work as expected. ToDo:
863 -- figure out which ones & disallow them.
865 setCmd :: String -> GHCi ()
867 = do st <- getGHCiState
868 let opts = options st
869 io $ putStrLn (showSDoc (
870 text "options currently set: " <>
873 else hsep (map (\o -> char '+' <> text (optToStr o)) opts)
877 ("args":args) -> setArgs args
878 ("prog":prog) -> setProg prog
879 wds -> setOptions wds
883 setGHCiState st{ args = args }
887 setGHCiState st{ progname = prog }
889 io (hPutStrLn stderr "syntax: :set prog <progname>")
892 do -- first, deal with the GHCi opts (+s, +t, etc.)
893 let (plus_opts, minus_opts) = partition isPlus wds
894 mapM_ setOpt plus_opts
896 -- now, the GHC flags
897 leftovers <- io $ processStaticFlags minus_opts
899 -- then, dynamic flags
900 dflags <- getDynFlags
901 (dflags',leftovers) <- io $ processDynamicFlags leftovers dflags
904 -- update things if the users wants more packages
906 let new_packages = pkgs_after \\ pkgs_before
907 when (not (null new_packages)) $
908 newPackages new_packages
911 if (not (null leftovers))
912 then throwDyn (CmdLineError ("unrecognised flags: " ++
917 unsetOptions :: String -> GHCi ()
919 = do -- first, deal with the GHCi opts (+s, +t, etc.)
921 (minus_opts, rest1) = partition isMinus opts
922 (plus_opts, rest2) = partition isPlus rest1
924 if (not (null rest2))
925 then io (putStrLn ("unknown option: '" ++ head rest2 ++ "'"))
928 mapM_ unsetOpt plus_opts
930 -- can't do GHC flags for now
931 if (not (null minus_opts))
932 then throwDyn (CmdLineError "can't unset GHC command-line flags")
935 isMinus ('-':s) = True
938 isPlus ('+':s) = True
942 = case strToGHCiOpt str of
943 Nothing -> io (putStrLn ("unknown option: '" ++ str ++ "'"))
944 Just o -> setOption o
947 = case strToGHCiOpt str of
948 Nothing -> io (putStrLn ("unknown option: '" ++ str ++ "'"))
949 Just o -> unsetOption o
951 strToGHCiOpt :: String -> (Maybe GHCiOption)
952 strToGHCiOpt "s" = Just ShowTiming
953 strToGHCiOpt "t" = Just ShowType
954 strToGHCiOpt "r" = Just RevertCAFs
955 strToGHCiOpt _ = Nothing
957 optToStr :: GHCiOption -> String
958 optToStr ShowTiming = "s"
959 optToStr ShowType = "t"
960 optToStr RevertCAFs = "r"
962 newPackages new_pkgs = do -- The new packages are already in v_Packages
963 state <- getGHCiState
964 cmstate1 <- io (cmUnload (cmstate state))
965 setGHCiState state{ cmstate = cmstate1, targets = [] }
966 dflags <- getDynFlags
967 io (linkPackages dflags new_pkgs)
968 setContextAfterLoad []
970 -- ---------------------------------------------------------------------------
975 ["modules" ] -> showModules
976 ["bindings"] -> showBindings
977 ["linker"] -> io showLinkerState
978 _ -> throwDyn (CmdLineError "syntax: :show [modules|bindings]")
981 = do { cms <- getCmState
982 ; let show_one ms = io (putStrLn (cmShowModule cms ms))
983 ; mapM_ show_one (cmGetModuleGraph cms) }
988 unqual = cmGetPrintUnqual cms
989 -- showBinding b = putStrLn (showSDocForUser unqual (ppr (ifaceTyThing b)))
990 showBinding b = putStrLn (showSDocForUser unqual (ppr (getName b)))
992 io (mapM_ showBinding (cmGetBindings cms))
996 -----------------------------------------------------------------------------
999 data GHCiState = GHCiState
1003 targets :: [FilePath],
1005 options :: [GHCiOption]
1009 = ShowTiming -- show time/allocs after evaluation
1010 | ShowType -- show the type of expressions
1011 | RevertCAFs -- revert CAFs after every evaluation
1014 newtype GHCi a = GHCi { unGHCi :: IORef GHCiState -> IO a }
1016 startGHCi :: GHCi a -> GHCiState -> IO a
1017 startGHCi g state = do ref <- newIORef state; unGHCi g ref
1019 instance Monad GHCi where
1020 (GHCi m) >>= k = GHCi $ \s -> m s >>= \a -> unGHCi (k a) s
1021 return a = GHCi $ \s -> return a
1023 ghciHandleDyn :: Typeable t => (t -> GHCi a) -> GHCi a -> GHCi a
1024 ghciHandleDyn h (GHCi m) = GHCi $ \s ->
1025 Exception.catchDyn (m s) (\e -> unGHCi (h e) s)
1027 getGHCiState = GHCi $ \r -> readIORef r
1028 setGHCiState s = GHCi $ \r -> writeIORef r s
1030 -- for convenience...
1031 getCmState = getGHCiState >>= return . cmstate
1032 setCmState cms = do s <- getGHCiState; setGHCiState s{cmstate=cms}
1034 getDynFlags = getCmState >>= return . cmGetDFlags
1036 setDynFlags dflags = do s <- getCmState; setCmState (cmSetDFlags s dflags)
1038 isOptionSet :: GHCiOption -> GHCi Bool
1040 = do st <- getGHCiState
1041 return (opt `elem` options st)
1043 setOption :: GHCiOption -> GHCi ()
1045 = do st <- getGHCiState
1046 setGHCiState (st{ options = opt : filter (/= opt) (options st) })
1048 unsetOption :: GHCiOption -> GHCi ()
1050 = do st <- getGHCiState
1051 setGHCiState (st{ options = filter (/= opt) (options st) })
1053 io :: IO a -> GHCi a
1054 io m = GHCi { unGHCi = \s -> m >>= return }
1056 -----------------------------------------------------------------------------
1057 -- recursive exception handlers
1059 -- Don't forget to unblock async exceptions in the handler, or if we're
1060 -- in an exception loop (eg. let a = error a in a) the ^C exception
1061 -- may never be delivered. Thanks to Marcin for pointing out the bug.
1063 ghciHandle :: (Exception -> GHCi a) -> GHCi a -> GHCi a
1064 ghciHandle h (GHCi m) = GHCi $ \s ->
1065 Exception.catch (m s)
1066 (\e -> unGHCi (ghciUnblock (h e)) s)
1068 ghciUnblock :: GHCi a -> GHCi a
1069 ghciUnblock (GHCi a) = GHCi $ \s -> Exception.unblock (a s)
1071 -----------------------------------------------------------------------------
1072 -- timing & statistics
1074 timeIt :: GHCi a -> GHCi a
1076 = do b <- isOptionSet ShowTiming
1079 else do allocs1 <- io $ getAllocations
1080 time1 <- io $ getCPUTime
1082 allocs2 <- io $ getAllocations
1083 time2 <- io $ getCPUTime
1084 io $ printTimes (fromIntegral (allocs2 - allocs1))
1088 foreign import ccall unsafe "getAllocations" getAllocations :: IO Int64
1089 -- defined in ghc/rts/Stats.c
1091 printTimes :: Integer -> Integer -> IO ()
1092 printTimes allocs psecs
1093 = do let secs = (fromIntegral psecs / (10^12)) :: Float
1094 secs_str = showFFloat (Just 2) secs
1095 putStrLn (showSDoc (
1096 parens (text (secs_str "") <+> text "secs" <> comma <+>
1097 text (show allocs) <+> text "bytes")))
1099 -----------------------------------------------------------------------------
1106 -- Have to turn off buffering again, because we just
1107 -- reverted stdout, stderr & stdin to their defaults.
1109 foreign import ccall "revertCAFs" rts_revertCAFs :: IO ()
1110 -- Make it "safe", just in case
1112 -- -----------------------------------------------------------------------------
1115 expandPath :: String -> GHCi String
1117 case dropWhile isSpace path of
1119 tilde <- io (getEnv "HOME") -- will fail if HOME not defined
1120 return (tilde ++ '/':d)