1 {-# OPTIONS -#include "Linker.h" #-}
2 -----------------------------------------------------------------------------
4 -- GHC Interactive User Interface
6 -- (c) The GHC Team 2005-2006
8 -----------------------------------------------------------------------------
14 #include "HsVersions.h"
22 import GHC ( Session, LoadHowMuch(..), Target(..), TargetId(..),
23 Type, Module, ModuleName, TyThing(..), Phase,
24 BreakIndex, Name, SrcSpan, Resume, SingleStep )
30 import Outputable hiding (printForUser)
31 import Module -- for ModuleEnv
33 -- Other random utilities
35 import BasicTypes hiding (isTopLevel)
36 import Panic hiding (showException)
43 #ifndef mingw32_HOST_OS
45 #if __GLASGOW_HASKELL__ > 504
49 import GHC.ConsoleHandler ( flushConsole )
50 import System.Win32 ( setConsoleCP, setConsoleOutputCP )
51 import qualified System.Win32
55 import Control.Concurrent ( yield ) -- Used in readline loop
56 import System.Console.Readline as Readline
61 import Control.Exception as Exception
62 -- import Control.Concurrent
64 import qualified Data.ByteString.Char8 as BS
68 import System.Environment
69 import System.Exit ( exitWith, ExitCode(..) )
70 import System.Directory
72 import System.IO.Error as IO
76 import Control.Monad as Monad
79 import Foreign.StablePtr ( newStablePtr )
80 import GHC.Exts ( unsafeCoerce# )
81 import GHC.IOBase ( IOErrorType(InvalidArgument) )
83 import Data.IORef ( IORef, readIORef, writeIORef )
85 import System.Posix.Internals ( setNonBlockingFD )
87 -----------------------------------------------------------------------------
91 " / _ \\ /\\ /\\/ __(_)\n"++
92 " / /_\\// /_/ / / | | GHC Interactive, version " ++ cProjectVersion ++ ", for Haskell 98.\n"++
93 "/ /_\\\\/ __ / /___| | http://www.haskell.org/ghc/\n"++
94 "\\____/\\/ /_/\\____/|_| Type :? for help.\n"
96 type Command = (String, String -> GHCi Bool, Bool, String -> IO [String])
99 GLOBAL_VAR(commands, builtin_commands, [Command])
101 builtin_commands :: [Command]
103 -- Hugs users are accustomed to :e, so make sure it doesn't overlap
104 ("?", keepGoing help, False, completeNone),
105 ("add", keepGoingPaths addModule, False, completeFilename),
106 ("abandon", keepGoing abandonCmd, False, completeNone),
107 ("break", keepGoing breakCmd, False, completeIdentifier),
108 ("back", keepGoing backCmd, False, completeNone),
109 ("browse", keepGoing browseCmd, False, completeModule),
110 ("cd", keepGoing changeDirectory, False, completeFilename),
111 ("check", keepGoing checkModule, False, completeHomeModule),
112 ("continue", continueCmd, False, completeNone),
113 ("ctags", keepGoing createCTagsFileCmd, False, completeFilename),
114 ("def", keepGoing defineMacro, False, completeIdentifier),
115 ("delete", keepGoing deleteCmd, False, completeNone),
116 ("e", keepGoing editFile, False, completeFilename),
117 ("edit", keepGoing editFile, False, completeFilename),
118 ("etags", keepGoing createETagsFileCmd, False, completeFilename),
119 ("force", keepGoing forceCmd, False, completeIdentifier),
120 ("forward", keepGoing forwardCmd, False, completeNone),
121 ("help", keepGoing help, False, completeNone),
122 ("history", keepGoing historyCmd, False, completeNone),
123 ("info", keepGoing info, False, completeIdentifier),
124 ("kind", keepGoing kindOfType, False, completeIdentifier),
125 ("load", keepGoingPaths loadModule_, False, completeHomeModuleOrFile),
126 ("list", keepGoing listCmd, False, completeNone),
127 ("module", keepGoing setContext, False, completeModule),
128 ("main", keepGoing runMain, False, completeIdentifier),
129 ("print", keepGoing printCmd, False, completeIdentifier),
130 ("quit", quit, False, completeNone),
131 ("reload", keepGoing reloadModule, False, completeNone),
132 ("set", keepGoing setCmd, True, completeSetOptions),
133 ("show", keepGoing showCmd, False, completeNone),
134 ("sprint", keepGoing sprintCmd, False, completeIdentifier),
135 ("step", stepCmd, False, completeIdentifier),
136 ("type", keepGoing typeOfExpr, False, completeIdentifier),
137 ("trace", traceCmd, False, completeIdentifier),
138 ("undef", keepGoing undefineMacro, False, completeMacro),
139 ("unset", keepGoing unsetOptions, True, completeSetOptions)
142 keepGoing :: (String -> GHCi ()) -> (String -> GHCi Bool)
143 keepGoing a str = a str >> return False
145 keepGoingPaths :: ([FilePath] -> GHCi ()) -> (String -> GHCi Bool)
146 keepGoingPaths a str = a (toArgs str) >> return False
148 shortHelpText = "use :? for help.\n"
151 " Commands available from the prompt:\n" ++
153 " <statement> evaluate/run <statement>\n" ++
154 " :add <filename> ... add module(s) to the current target set\n" ++
155 " :browse [*]<module> display the names defined by <module>\n" ++
156 " :cd <dir> change directory to <dir>\n" ++
157 " :ctags [<file>] create tags file for Vi (default: \"tags\")\n" ++
158 " :def <cmd> <expr> define a command :<cmd>\n" ++
159 " :edit <file> edit file\n" ++
160 " :edit edit last module\n" ++
161 " :etags [<file>] create tags file for Emacs (default: \"TAGS\")\n" ++
162 " :help, :? display this list of commands\n" ++
163 " :info [<name> ...] display information about the given names\n" ++
164 " :kind <type> show the kind of <type>\n" ++
165 " :load <filename> ... load module(s) and their dependents\n" ++
166 " :module [+/-] [*]<mod> ... set the context for expression evaluation\n" ++
167 " :main [<arguments> ...] run the main function with the given arguments\n" ++
168 " :quit exit GHCi\n" ++
169 " :reload reload the current module set\n" ++
170 " :type <expr> show the type of <expr>\n" ++
171 " :undef <cmd> undefine user-defined command :<cmd>\n" ++
172 " :!<command> run the shell command <command>\n" ++
174 " -- Commands for debugging:\n" ++
176 " :abandon at a breakpoint, abandon current computation\n" ++
177 " :back go back in the history (after :trace)\n" ++
178 " :break [<mod>] <l> [<col>] set a breakpoint at the specified location\n" ++
179 " :break <name> set a breakpoint on the specified function\n" ++
180 " :continue resume after a breakpoint\n" ++
181 " :delete <number> delete the specified breakpoint\n" ++
182 " :delete * delete all breakpoints\n" ++
183 " :force <expr> print <expr>, forcing unevaluated parts\n" ++
184 " :forward go forward in the history (after :back)\n" ++
185 " :history [<n>] show the last <n> items in the history (after :trace)\n" ++
186 " :print [<name> ...] prints a value without forcing its computation\n" ++
187 " :step single-step after stopping at a breakpoint\n"++
188 " :step <expr> single-step into <expr>\n"++
189 " :trace trace after stopping at a breakpoint\n"++
190 " :trace <expr> trace into <expr> (remembers breakpoints for :history)\n"++
191 " :sprint [<name> ...] simplifed version of :print\n" ++
194 " -- Commands for changing settings:\n" ++
196 " :set <option> ... set options\n" ++
197 " :set args <arg> ... set the arguments returned by System.getArgs\n" ++
198 " :set prog <progname> set the value returned by System.getProgName\n" ++
199 " :set prompt <prompt> set the prompt used in GHCi\n" ++
200 " :set editor <cmd> set the command used for :edit\n" ++
201 " :set stop <cmd> set the command to run when a breakpoint is hit\n" ++
202 " :unset <option> ... unset options\n" ++
204 " Options for ':set' and ':unset':\n" ++
206 " +r revert top-level expressions after each evaluation\n" ++
207 " +s print timing/memory stats after each evaluation\n" ++
208 " +t print type after evaluation\n" ++
209 " -<flags> most GHC command line flags can also be set here\n" ++
210 " (eg. -v2, -fglasgow-exts, etc.)\n" ++
212 " -- Commands for displaying information:\n" ++
214 " :show bindings show the current bindings made at the prompt\n" ++
215 " :show breaks show the active breakpoints\n" ++
216 " :show context show the breakpoint context\n" ++
217 " :show modules show the currently loaded modules\n" ++
218 " :show <setting> show anything that can be set with :set (e.g. args)\n" ++
225 win <- System.Win32.getWindowsDirectory
226 return (win `joinFileName` "notepad.exe")
231 interactiveUI :: Session -> [(FilePath, Maybe Phase)] -> Maybe String -> IO ()
232 interactiveUI session srcs maybe_expr = do
233 -- HACK! If we happen to get into an infinite loop (eg the user
234 -- types 'let x=x in x' at the prompt), then the thread will block
235 -- on a blackhole, and become unreachable during GC. The GC will
236 -- detect that it is unreachable and send it the NonTermination
237 -- exception. However, since the thread is unreachable, everything
238 -- it refers to might be finalized, including the standard Handles.
239 -- This sounds like a bug, but we don't have a good solution right
245 -- Initialise buffering for the *interpreted* I/O system
246 initInterpBuffering session
248 when (isNothing maybe_expr) $ do
249 -- Only for GHCi (not runghc and ghc -e):
250 -- Turn buffering off for the compiled program's stdout/stderr
252 -- Turn buffering off for GHCi's stdout
254 hSetBuffering stdout NoBuffering
255 -- We don't want the cmd line to buffer any input that might be
256 -- intended for the program, so unbuffer stdin.
257 hSetBuffering stdin NoBuffering
259 -- initial context is just the Prelude
260 prel_mod <- GHC.findModule session prel_name (Just basePackageId)
261 GHC.setContext session [] [prel_mod]
265 Readline.setAttemptedCompletionFunction (Just completeWord)
266 --Readline.parseAndBind "set show-all-if-ambiguous 1"
268 let symbols = "!#$%&*+/<=>?@\\^|-~"
269 specials = "(),;[]`{}"
271 word_break_chars = spaces ++ specials ++ symbols
273 Readline.setBasicWordBreakCharacters word_break_chars
274 Readline.setCompleterWordBreakCharacters word_break_chars
277 default_editor <- findEditor
279 startGHCi (runGHCi srcs maybe_expr)
280 GHCiState{ progname = "<interactive>",
284 editor = default_editor,
290 tickarrays = emptyModuleEnv
294 Readline.resetTerminal Nothing
299 prel_name = GHC.mkModuleName "Prelude"
301 runGHCi :: [(FilePath, Maybe Phase)] -> Maybe String -> GHCi ()
302 runGHCi paths maybe_expr = do
303 let read_dot_files = not opt_IgnoreDotGhci
305 when (read_dot_files) $ do
308 exists <- io (doesFileExist file)
310 dir_ok <- io (checkPerms ".")
311 file_ok <- io (checkPerms file)
312 when (dir_ok && file_ok) $ do
313 either_hdl <- io (IO.try (openFile "./.ghci" ReadMode))
316 Right hdl -> fileLoop hdl False
318 when (read_dot_files) $ do
319 -- Read in $HOME/.ghci
320 either_dir <- io (IO.try (getEnv "HOME"))
324 cwd <- io (getCurrentDirectory)
325 when (dir /= cwd) $ do
326 let file = dir ++ "/.ghci"
327 ok <- io (checkPerms file)
329 either_hdl <- io (IO.try (openFile file ReadMode))
332 Right hdl -> fileLoop hdl False
334 -- Perform a :load for files given on the GHCi command line
335 -- When in -e mode, if the load fails then we want to stop
336 -- immediately rather than going on to evaluate the expression.
337 when (not (null paths)) $ do
338 ok <- ghciHandle (\e -> do showException e; return Failed) $
340 when (isJust maybe_expr && failed ok) $
341 io (exitWith (ExitFailure 1))
343 -- if verbosity is greater than 0, or we are connected to a
344 -- terminal, display the prompt in the interactive loop.
345 is_tty <- io (hIsTerminalDevice stdin)
346 dflags <- getDynFlags
347 let show_prompt = verbosity dflags > 0 || is_tty
352 #if defined(mingw32_HOST_OS)
353 -- The win32 Console API mutates the first character of
354 -- type-ahead when reading from it in a non-buffered manner. Work
355 -- around this by flushing the input buffer of type-ahead characters,
356 -- but only if stdin is available.
357 flushed <- io (IO.try (GHC.ConsoleHandler.flushConsole stdin))
359 Left err | isDoesNotExistError err -> return ()
360 | otherwise -> io (ioError err)
361 Right () -> return ()
363 -- initialise the console if necessary
366 -- enter the interactive loop
367 interactiveLoop is_tty show_prompt
369 -- just evaluate the expression we were given
374 io $ do when (verbosity dflags > 0) $ putStrLn "Leaving GHCi."
377 interactiveLoop is_tty show_prompt =
378 -- Ignore ^C exceptions caught here
379 ghciHandleDyn (\e -> case e of
381 #if defined(mingw32_HOST_OS)
384 interactiveLoop is_tty show_prompt
385 _other -> return ()) $
387 ghciUnblock $ do -- unblock necessary if we recursed from the
388 -- exception handler above.
390 -- read commands from stdin
394 else fileLoop stdin show_prompt
396 fileLoop stdin show_prompt
400 -- NOTE: We only read .ghci files if they are owned by the current user,
401 -- and aren't world writable. Otherwise, we could be accidentally
402 -- running code planted by a malicious third party.
404 -- Furthermore, We only read ./.ghci if . is owned by the current user
405 -- and isn't writable by anyone else. I think this is sufficient: we
406 -- don't need to check .. and ../.. etc. because "." always refers to
407 -- the same directory while a process is running.
409 checkPerms :: String -> IO Bool
411 #ifdef mingw32_HOST_OS
414 Util.handle (\_ -> return False) $ do
415 st <- getFileStatus name
417 if fileOwner st /= me then do
418 putStrLn $ "WARNING: " ++ name ++ " is owned by someone else, IGNORING!"
421 let mode = fileMode st
422 if (groupWriteMode == (mode `intersectFileModes` groupWriteMode))
423 || (otherWriteMode == (mode `intersectFileModes` otherWriteMode))
425 putStrLn $ "*** WARNING: " ++ name ++
426 " is writable by someone else, IGNORING!"
431 fileLoop :: Handle -> Bool -> GHCi ()
432 fileLoop hdl show_prompt = do
433 when show_prompt $ do
436 l <- io (IO.try (hGetLine hdl))
438 Left e | isEOFError e -> return ()
439 | InvalidArgument <- etype -> return ()
440 | otherwise -> io (ioError e)
441 where etype = ioeGetErrorType e
442 -- treat InvalidArgument in the same way as EOF:
443 -- this can happen if the user closed stdin, or
444 -- perhaps did getContents which closes stdin at
447 case removeSpaces l of
448 "" -> fileLoop hdl show_prompt
449 l -> do quit <- runCommand l
450 if quit then return () else fileLoop hdl show_prompt
452 stringLoop :: [String] -> GHCi Bool{-True: we quit-}
453 stringLoop [] = return False
454 stringLoop (s:ss) = do
455 case removeSpaces s of
457 l -> do quit <- runCommand l
458 if quit then return True else stringLoop ss
461 session <- getSession
462 (toplevs,exports) <- io (GHC.getContext session)
463 resumes <- io $ GHC.getResumeContext session
469 let ix = GHC.resumeHistoryIx r
471 then return (brackets (ppr (GHC.resumeSpan r)) <> space)
473 let hist = GHC.resumeHistory r !! (ix-1)
474 span <- io $ GHC.getHistorySpan session hist
475 return (brackets (ppr (negate ix) <> char ':'
476 <+> ppr span) <> space)
478 dots | r:rs <- resumes, not (null rs) = text "... "
482 hsep (map (\m -> char '*' <> ppr (GHC.moduleName m)) toplevs) <+>
483 hsep (map (ppr . GHC.moduleName) exports)
485 deflt_prompt = dots <> context_bit <> modules_bit
487 f ('%':'s':xs) = deflt_prompt <> f xs
488 f ('%':'%':xs) = char '%' <> f xs
489 f (x:xs) = char x <> f xs
493 return (showSDoc (f (prompt st)))
497 readlineLoop :: GHCi ()
499 session <- getSession
500 (mod,imports) <- io (GHC.getContext session)
502 saveSession -- for use by completion
504 mb_span <- getCurrentBreakSpan
506 l <- io (readline prompt `finally` setNonBlockingFD 0)
507 -- readline sometimes puts stdin into blocking mode,
508 -- so we need to put it back for the IO library
513 case removeSpaces l of
518 if quit then return () else readlineLoop
521 runCommand :: String -> GHCi Bool
522 runCommand c = ghciHandle handler (doCommand c)
524 doCommand (':' : command) = specialCommand command
526 = do timeIt $ runStmt stmt GHC.RunToCompletion
529 -- This version is for the GHC command-line option -e. The only difference
530 -- from runCommand is that it catches the ExitException exception and
531 -- exits, rather than printing out the exception.
532 runCommandEval c = ghciHandle handleEval (doCommand c)
534 handleEval (ExitException code) = io (exitWith code)
535 handleEval e = do handler e
536 io (exitWith (ExitFailure 1))
538 doCommand (':' : command) = specialCommand command
540 = do r <- runStmt stmt GHC.RunToCompletion
542 False -> io (exitWith (ExitFailure 1))
543 -- failure to run the command causes exit(1) for ghc -e.
546 runStmt :: String -> SingleStep -> GHCi Bool
548 | null (filter (not.isSpace) stmt) = return False
550 = do st <- getGHCiState
551 session <- getSession
552 result <- io $ withProgName (progname st) $ withArgs (args st) $
553 GHC.runStmt session stmt step
555 return (isRunResultOk result)
558 afterRunStmt :: GHC.RunResult -> GHCi (Maybe (Bool,[Name]))
559 afterRunStmt run_result = do
560 mb_result <- switchOnRunResult run_result
561 -- possibly print the type and revert CAFs after evaluating an expression
562 show_types <- isOptionSet ShowType
563 session <- getSession
566 Just (is_break,names) ->
567 when (is_break || show_types) $
568 mapM_ (showTypeOfName session) names
571 io installSignalHandlers
572 b <- isOptionSet RevertCAFs
573 io (when b revertCAFs)
578 switchOnRunResult :: GHC.RunResult -> GHCi (Maybe (Bool,[Name]))
579 switchOnRunResult GHC.RunFailed = return Nothing
580 switchOnRunResult (GHC.RunException e) = throw e
581 switchOnRunResult (GHC.RunOk names) = return $ Just (False,names)
582 switchOnRunResult (GHC.RunBreak threadId names info) = do
583 session <- getSession
584 Just mod_info <- io $ GHC.getModuleInfo session (GHC.breakInfo_module info)
585 let modBreaks = GHC.modInfoModBreaks mod_info
586 let ticks = GHC.modBreaks_locs modBreaks
588 -- display information about the breakpoint
589 let location = ticks ! GHC.breakInfo_number info
590 printForUser $ ptext SLIT("Stopped at") <+> ppr location
592 -- run the command set with ":set stop <cmd>"
596 return (Just (True,names))
599 isRunResultOk :: GHC.RunResult -> Bool
600 isRunResultOk (GHC.RunOk _) = True
601 isRunResultOk _ = False
604 showTypeOfName :: Session -> Name -> GHCi ()
605 showTypeOfName session n
606 = do maybe_tything <- io (GHC.lookupName session n)
607 case maybe_tything of
609 Just thing -> showTyThing thing
611 specialCommand :: String -> GHCi Bool
612 specialCommand ('!':str) = shellEscape (dropWhile isSpace str)
613 specialCommand str = do
614 let (cmd,rest) = break isSpace str
615 maybe_cmd <- io (lookupCommand cmd)
617 Nothing -> io (hPutStr stdout ("unknown command ':" ++ cmd ++ "'\n"
618 ++ shortHelpText) >> return False)
619 Just (_,f,_,_) -> f (dropWhile isSpace rest)
621 lookupCommand :: String -> IO (Maybe Command)
622 lookupCommand str = do
623 cmds <- readIORef commands
624 -- look for exact match first, then the first prefix match
625 case [ c | c <- cmds, str == cmdName c ] of
626 c:_ -> return (Just c)
627 [] -> case [ c | c@(s,_,_,_) <- cmds, prefixMatch str s ] of
629 c:_ -> return (Just c)
632 getCurrentBreakSpan :: GHCi (Maybe SrcSpan)
633 getCurrentBreakSpan = do
634 session <- getSession
635 resumes <- io $ GHC.getResumeContext session
639 let ix = GHC.resumeHistoryIx r
641 then return (Just (GHC.resumeSpan r))
643 let hist = GHC.resumeHistory r !! (ix-1)
644 span <- io $ GHC.getHistorySpan session hist
647 -----------------------------------------------------------------------------
650 noArgs :: GHCi () -> String -> GHCi ()
652 noArgs m _ = io $ putStrLn "This command takes no arguments"
654 help :: String -> GHCi ()
655 help _ = io (putStr helpText)
657 info :: String -> GHCi ()
658 info "" = throwDyn (CmdLineError "syntax: ':i <thing-you-want-info-about>'")
659 info s = do { let names = words s
660 ; session <- getSession
661 ; dflags <- getDynFlags
662 ; let exts = dopt Opt_GlasgowExts dflags
663 ; mapM_ (infoThing exts session) names }
665 infoThing exts session str = io $ do
666 names <- GHC.parseName session str
667 let filtered = filterOutChildren names
668 mb_stuffs <- mapM (GHC.getInfo session) filtered
669 unqual <- GHC.getPrintUnqual session
670 putStrLn (showSDocForUser unqual $
671 vcat (intersperse (text "") $
672 [ pprInfo exts stuff | Just stuff <- mb_stuffs ]))
674 -- Filter out names whose parent is also there Good
675 -- example is '[]', which is both a type and data
676 -- constructor in the same type
677 filterOutChildren :: [Name] -> [Name]
678 filterOutChildren names = filter (not . parent_is_there) names
679 where parent_is_there n
680 -- | Just p <- GHC.nameParent_maybe n = p `elem` names
684 pprInfo exts (thing, fixity, insts)
685 = pprTyThingInContextLoc exts thing
686 $$ show_fixity fixity
687 $$ vcat (map GHC.pprInstance insts)
690 | fix == GHC.defaultFixity = empty
691 | otherwise = ppr fix <+> ppr (GHC.getName thing)
693 runMain :: String -> GHCi ()
695 let ss = concat $ intersperse "," (map (\ s -> ('"':s)++"\"") (toArgs args))
696 runCommand $ '[': ss ++ "] `System.Environment.withArgs` main"
699 addModule :: [FilePath] -> GHCi ()
701 io (revertCAFs) -- always revert CAFs on load/add.
702 files <- mapM expandPath files
703 targets <- mapM (\m -> io (GHC.guessTarget m Nothing)) files
704 session <- getSession
705 io (mapM_ (GHC.addTarget session) targets)
706 ok <- io (GHC.load session LoadAllTargets)
709 changeDirectory :: String -> GHCi ()
710 changeDirectory dir = do
711 session <- getSession
712 graph <- io (GHC.getModuleGraph session)
713 when (not (null graph)) $
714 io $ putStr "Warning: changing directory causes all loaded modules to be unloaded,\nbecause the search path has changed.\n"
715 io (GHC.setTargets session [])
716 io (GHC.load session LoadAllTargets)
717 setContextAfterLoad session []
718 io (GHC.workingDirectoryChanged session)
719 dir <- expandPath dir
720 io (setCurrentDirectory dir)
722 editFile :: String -> GHCi ()
725 -- find the name of the "topmost" file loaded
726 session <- getSession
727 graph0 <- io (GHC.getModuleGraph session)
728 graph1 <- filterM (io . GHC.isLoaded session . GHC.ms_mod_name) graph0
729 let graph2 = flattenSCCs (GHC.topSortModuleGraph True graph1 Nothing)
730 case GHC.ml_hs_file (GHC.ms_location (last graph2)) of
731 Just file -> do_edit file
732 Nothing -> throwDyn (CmdLineError "unknown file name")
733 | otherwise = do_edit str
739 throwDyn (CmdLineError "editor not set, use :set editor")
740 io $ system (cmd ++ ' ':file)
743 defineMacro :: String -> GHCi ()
745 let (macro_name, definition) = break isSpace s
746 cmds <- io (readIORef commands)
748 then throwDyn (CmdLineError "invalid macro name")
750 if (macro_name `elem` map cmdName cmds)
751 then throwDyn (CmdLineError
752 ("command '" ++ macro_name ++ "' is already defined"))
755 -- give the expression a type signature, so we can be sure we're getting
756 -- something of the right type.
757 let new_expr = '(' : definition ++ ") :: String -> IO String"
759 -- compile the expression
761 maybe_hv <- io (GHC.compileExpr cms new_expr)
764 Just hv -> io (writeIORef commands --
765 (cmds ++ [(macro_name, runMacro hv, False, completeNone)]))
767 runMacro :: GHC.HValue{-String -> IO String-} -> String -> GHCi Bool
769 str <- io ((unsafeCoerce# fun :: String -> IO String) s)
770 stringLoop (lines str)
772 undefineMacro :: String -> GHCi ()
773 undefineMacro macro_name = do
774 cmds <- io (readIORef commands)
775 if (macro_name `elem` map cmdName builtin_commands)
776 then throwDyn (CmdLineError
777 ("command '" ++ macro_name ++ "' cannot be undefined"))
779 if (macro_name `notElem` map cmdName cmds)
780 then throwDyn (CmdLineError
781 ("command '" ++ macro_name ++ "' not defined"))
783 io (writeIORef commands (filter ((/= macro_name) . cmdName) cmds))
786 loadModule :: [(FilePath, Maybe Phase)] -> GHCi SuccessFlag
787 loadModule fs = timeIt (loadModule' fs)
789 loadModule_ :: [FilePath] -> GHCi ()
790 loadModule_ fs = do loadModule (zip fs (repeat Nothing)); return ()
792 loadModule' :: [(FilePath, Maybe Phase)] -> GHCi SuccessFlag
793 loadModule' files = do
794 session <- getSession
797 io (GHC.setTargets session [])
798 io (GHC.load session LoadAllTargets)
801 let (filenames, phases) = unzip files
802 exp_filenames <- mapM expandPath filenames
803 let files' = zip exp_filenames phases
804 targets <- io (mapM (uncurry GHC.guessTarget) files')
806 -- NOTE: we used to do the dependency anal first, so that if it
807 -- fails we didn't throw away the current set of modules. This would
808 -- require some re-working of the GHC interface, so we'll leave it
809 -- as a ToDo for now.
811 io (GHC.setTargets session targets)
812 ok <- io (GHC.load session LoadAllTargets)
816 checkModule :: String -> GHCi ()
818 let modl = GHC.mkModuleName m
819 session <- getSession
820 result <- io (GHC.checkModule session modl)
822 Nothing -> io $ putStrLn "Nothing"
823 Just r -> io $ putStrLn (showSDoc (
824 case GHC.checkedModuleInfo r of
825 Just cm | Just scope <- GHC.modInfoTopLevelScope cm ->
827 (local,global) = partition ((== modl) . GHC.moduleName . GHC.nameModule) scope
829 (text "global names: " <+> ppr global) $$
830 (text "local names: " <+> ppr local)
832 afterLoad (successIf (isJust result)) session
834 reloadModule :: String -> GHCi ()
836 io (revertCAFs) -- always revert CAFs on reload.
837 session <- getSession
838 ok <- io (GHC.load session LoadAllTargets)
841 io (revertCAFs) -- always revert CAFs on reload.
842 session <- getSession
843 ok <- io (GHC.load session (LoadUpTo (GHC.mkModuleName m)))
846 afterLoad ok session = do
847 io (revertCAFs) -- always revert CAFs on load.
849 discardActiveBreakPoints
850 graph <- io (GHC.getModuleGraph session)
851 graph' <- filterM (io . GHC.isLoaded session . GHC.ms_mod_name) graph
852 setContextAfterLoad session graph'
853 modulesLoadedMsg ok (map GHC.ms_mod_name graph')
855 setContextAfterLoad session [] = do
856 prel_mod <- getPrelude
857 io (GHC.setContext session [] [prel_mod])
858 setContextAfterLoad session ms = do
859 -- load a target if one is available, otherwise load the topmost module.
860 targets <- io (GHC.getTargets session)
861 case [ m | Just m <- map (findTarget ms) targets ] of
863 let graph' = flattenSCCs (GHC.topSortModuleGraph True ms Nothing) in
864 load_this (last graph')
869 = case filter (`matches` t) ms of
873 summary `matches` Target (TargetModule m) _
874 = GHC.ms_mod_name summary == m
875 summary `matches` Target (TargetFile f _) _
876 | Just f' <- GHC.ml_hs_file (GHC.ms_location summary) = f == f'
877 summary `matches` target
880 load_this summary | m <- GHC.ms_mod summary = do
881 b <- io (GHC.moduleIsInterpreted session m)
882 if b then io (GHC.setContext session [m] [])
884 prel_mod <- getPrelude
885 io (GHC.setContext session [] [prel_mod,m])
888 modulesLoadedMsg :: SuccessFlag -> [ModuleName] -> GHCi ()
889 modulesLoadedMsg ok mods = do
890 dflags <- getDynFlags
891 when (verbosity dflags > 0) $ do
893 | null mods = text "none."
895 punctuate comma (map ppr mods)) <> text "."
898 io (putStrLn (showSDoc (text "Failed, modules loaded: " <> mod_commas)))
900 io (putStrLn (showSDoc (text "Ok, modules loaded: " <> mod_commas)))
903 typeOfExpr :: String -> GHCi ()
905 = do cms <- getSession
906 maybe_ty <- io (GHC.exprType cms str)
909 Just ty -> do ty' <- cleanType ty
910 printForUser $ text str <> text " :: " <> ppr ty'
912 kindOfType :: String -> GHCi ()
914 = do cms <- getSession
915 maybe_ty <- io (GHC.typeKind cms str)
918 Just ty -> printForUser $ text str <> text " :: " <> ppr ty
920 quit :: String -> GHCi Bool
923 shellEscape :: String -> GHCi Bool
924 shellEscape str = io (system str >> return False)
926 -----------------------------------------------------------------------------
927 -- Browsing a module's contents
929 browseCmd :: String -> GHCi ()
932 ['*':m] | looksLikeModuleName m -> browseModule m False
933 [m] | looksLikeModuleName m -> browseModule m True
934 _ -> throwDyn (CmdLineError "syntax: :browse <module>")
936 browseModule m exports_only = do
938 modl <- if exports_only then lookupModule m
939 else wantInterpretedModule m
941 -- Temporarily set the context to the module we're interested in,
942 -- just so we can get an appropriate PrintUnqualified
943 (as,bs) <- io (GHC.getContext s)
944 prel_mod <- getPrelude
945 io (if exports_only then GHC.setContext s [] [prel_mod,modl]
946 else GHC.setContext s [modl] [])
947 unqual <- io (GHC.getPrintUnqual s)
948 io (GHC.setContext s as bs)
950 mb_mod_info <- io $ GHC.getModuleInfo s modl
952 Nothing -> throwDyn (CmdLineError ("unknown module: " ++ m))
955 | exports_only = GHC.modInfoExports mod_info
956 | otherwise = fromMaybe [] (GHC.modInfoTopLevelScope mod_info)
958 filtered = filterOutChildren names
960 things <- io $ mapM (GHC.lookupName s) filtered
962 dflags <- getDynFlags
963 let exts = dopt Opt_GlasgowExts dflags
964 io (putStrLn (showSDocForUser unqual (
965 vcat (map (pprTyThingInContext exts) (catMaybes things))
967 -- ToDo: modInfoInstances currently throws an exception for
968 -- package modules. When it works, we can do this:
969 -- $$ vcat (map GHC.pprInstance (GHC.modInfoInstances mod_info))
971 -----------------------------------------------------------------------------
972 -- Setting the module context
975 | all sensible mods = fn mods
976 | otherwise = throwDyn (CmdLineError "syntax: :module [+/-] [*]M1 ... [*]Mn")
978 (fn, mods) = case str of
979 '+':stuff -> (addToContext, words stuff)
980 '-':stuff -> (removeFromContext, words stuff)
981 stuff -> (newContext, words stuff)
983 sensible ('*':m) = looksLikeModuleName m
984 sensible m = looksLikeModuleName m
986 separate :: Session -> [String] -> [Module] -> [Module]
987 -> GHCi ([Module],[Module])
988 separate session [] as bs = return (as,bs)
989 separate session (('*':str):ms) as bs = do
990 m <- io $ GHC.findModule session (GHC.mkModuleName str) Nothing
991 b <- io $ GHC.moduleIsInterpreted session m
992 if b then separate session ms (m:as) bs
993 else throwDyn (CmdLineError ("module '"
994 ++ GHC.moduleNameString (GHC.moduleName m)
995 ++ "' is not interpreted"))
996 separate session (str:ms) as bs = do
997 m <- io $ GHC.findModule session (GHC.mkModuleName str) Nothing
998 separate session ms as (m:bs)
1000 newContext :: [String] -> GHCi ()
1001 newContext strs = do
1003 (as,bs) <- separate s strs [] []
1004 prel_mod <- getPrelude
1005 let bs' = if null as && prel_mod `notElem` bs then prel_mod:bs else bs
1006 io $ GHC.setContext s as bs'
1009 addToContext :: [String] -> GHCi ()
1010 addToContext strs = do
1012 (as,bs) <- io $ GHC.getContext s
1014 (new_as,new_bs) <- separate s strs [] []
1016 let as_to_add = new_as \\ (as ++ bs)
1017 bs_to_add = new_bs \\ (as ++ bs)
1019 io $ GHC.setContext s (as ++ as_to_add) (bs ++ bs_to_add)
1022 removeFromContext :: [String] -> GHCi ()
1023 removeFromContext strs = do
1025 (as,bs) <- io $ GHC.getContext s
1027 (as_to_remove,bs_to_remove) <- separate s strs [] []
1029 let as' = as \\ (as_to_remove ++ bs_to_remove)
1030 bs' = bs \\ (as_to_remove ++ bs_to_remove)
1032 io $ GHC.setContext s as' bs'
1034 ----------------------------------------------------------------------------
1037 -- set options in the interpreter. Syntax is exactly the same as the
1038 -- ghc command line, except that certain options aren't available (-C,
1041 -- This is pretty fragile: most options won't work as expected. ToDo:
1042 -- figure out which ones & disallow them.
1044 setCmd :: String -> GHCi ()
1046 = do st <- getGHCiState
1047 let opts = options st
1048 io $ putStrLn (showSDoc (
1049 text "options currently set: " <>
1052 else hsep (map (\o -> char '+' <> text (optToStr o)) opts)
1055 = case toArgs str of
1056 ("args":args) -> setArgs args
1057 ("prog":prog) -> setProg prog
1058 ("prompt":prompt) -> setPrompt (after 6)
1059 ("editor":cmd) -> setEditor (after 6)
1060 ("stop":cmd) -> setStop (after 4)
1061 wds -> setOptions wds
1062 where after n = dropWhile isSpace $ drop n $ dropWhile isSpace str
1066 setGHCiState st{ args = args }
1070 setGHCiState st{ progname = prog }
1072 io (hPutStrLn stderr "syntax: :set prog <progname>")
1076 setGHCiState st{ editor = cmd }
1080 setGHCiState st{ stop = cmd }
1082 setPrompt value = do
1085 then io $ hPutStrLn stderr $ "syntax: :set prompt <prompt>, currently \"" ++ prompt st ++ "\""
1086 else setGHCiState st{ prompt = remQuotes value }
1088 remQuotes ('\"':xs) | not (null xs) && last xs == '\"' = init xs
1092 do -- first, deal with the GHCi opts (+s, +t, etc.)
1093 let (plus_opts, minus_opts) = partition isPlus wds
1094 mapM_ setOpt plus_opts
1095 -- then, dynamic flags
1096 newDynFlags minus_opts
1098 newDynFlags minus_opts = do
1099 dflags <- getDynFlags
1100 let pkg_flags = packageFlags dflags
1101 (dflags',leftovers) <- io $ GHC.parseDynamicFlags dflags minus_opts
1103 if (not (null leftovers))
1104 then throwDyn (CmdLineError ("unrecognised flags: " ++
1108 new_pkgs <- setDynFlags dflags'
1110 -- if the package flags changed, we should reset the context
1111 -- and link the new packages.
1112 dflags <- getDynFlags
1113 when (packageFlags dflags /= pkg_flags) $ do
1114 io $ hPutStrLn stderr "package flags have changed, ressetting and loading new packages..."
1115 session <- getSession
1116 io (GHC.setTargets session [])
1117 io (GHC.load session LoadAllTargets)
1118 io (linkPackages dflags new_pkgs)
1119 setContextAfterLoad session []
1123 unsetOptions :: String -> GHCi ()
1125 = do -- first, deal with the GHCi opts (+s, +t, etc.)
1126 let opts = words str
1127 (minus_opts, rest1) = partition isMinus opts
1128 (plus_opts, rest2) = partition isPlus rest1
1130 if (not (null rest2))
1131 then io (putStrLn ("unknown option: '" ++ head rest2 ++ "'"))
1134 mapM_ unsetOpt plus_opts
1136 let no_flag ('-':'f':rest) = return ("-fno-" ++ rest)
1137 no_flag f = throwDyn (ProgramError ("don't know how to reverse " ++ f))
1139 no_flags <- mapM no_flag minus_opts
1140 newDynFlags no_flags
1142 isMinus ('-':s) = True
1145 isPlus ('+':s) = True
1149 = case strToGHCiOpt str of
1150 Nothing -> io (putStrLn ("unknown option: '" ++ str ++ "'"))
1151 Just o -> setOption o
1154 = case strToGHCiOpt str of
1155 Nothing -> io (putStrLn ("unknown option: '" ++ str ++ "'"))
1156 Just o -> unsetOption o
1158 strToGHCiOpt :: String -> (Maybe GHCiOption)
1159 strToGHCiOpt "s" = Just ShowTiming
1160 strToGHCiOpt "t" = Just ShowType
1161 strToGHCiOpt "r" = Just RevertCAFs
1162 strToGHCiOpt _ = Nothing
1164 optToStr :: GHCiOption -> String
1165 optToStr ShowTiming = "s"
1166 optToStr ShowType = "t"
1167 optToStr RevertCAFs = "r"
1169 -- ---------------------------------------------------------------------------
1175 ["args"] -> io $ putStrLn (show (args st))
1176 ["prog"] -> io $ putStrLn (show (progname st))
1177 ["prompt"] -> io $ putStrLn (show (prompt st))
1178 ["editor"] -> io $ putStrLn (show (editor st))
1179 ["stop"] -> io $ putStrLn (show (stop st))
1180 ["modules" ] -> showModules
1181 ["bindings"] -> showBindings
1182 ["linker"] -> io showLinkerState
1183 ["breaks"] -> showBkptTable
1184 ["context"] -> showContext
1185 _ -> throwDyn (CmdLineError "syntax: :show [args|prog|prompt|editor|stop|modules|bindings|breaks|context]")
1188 session <- getSession
1189 let show_one ms = do m <- io (GHC.showModule session ms)
1191 graph <- io (GHC.getModuleGraph session)
1192 mapM_ show_one graph
1196 unqual <- io (GHC.getPrintUnqual s)
1197 bindings <- io (GHC.getBindings s)
1198 mapM_ showTyThing bindings
1201 showTyThing (AnId id) = do
1202 ty' <- cleanType (GHC.idType id)
1203 printForUser $ ppr id <> text " :: " <> ppr ty'
1204 showTyThing _ = return ()
1206 -- if -fglasgow-exts is on we show the foralls, otherwise we don't.
1207 cleanType :: Type -> GHCi Type
1209 dflags <- getDynFlags
1210 if dopt Opt_GlasgowExts dflags
1212 else return $! GHC.dropForAlls ty
1214 showBkptTable :: GHCi ()
1217 printForUser $ prettyLocations (breaks st)
1219 showContext :: GHCi ()
1221 session <- getSession
1222 resumes <- io $ GHC.getResumeContext session
1223 printForUser $ vcat (map pp_resume (reverse resumes))
1226 ptext SLIT("--> ") <> text (GHC.resumeStmt resume)
1227 $$ nest 2 (ptext SLIT("Stopped at") <+> ppr (GHC.resumeSpan resume))
1230 -- -----------------------------------------------------------------------------
1233 completeNone :: String -> IO [String]
1234 completeNone w = return []
1237 completeWord :: String -> Int -> Int -> IO (Maybe (String, [String]))
1238 completeWord w start end = do
1239 line <- Readline.getLineBuffer
1241 ':':_ | all isSpace (take (start-1) line) -> wrapCompleter completeCmd w
1243 | Just c <- is_cmd line -> do
1244 maybe_cmd <- lookupCommand c
1245 let (n,w') = selectWord (words' 0 line)
1247 Nothing -> return Nothing
1248 Just (_,_,False,complete) -> wrapCompleter complete w
1249 Just (_,_,True,complete) -> let complete' w = do rets <- complete w
1250 return (map (drop n) rets)
1251 in wrapCompleter complete' w'
1253 --printf "complete %s, start = %d, end = %d\n" w start end
1254 wrapCompleter completeIdentifier w
1255 where words' _ [] = []
1256 words' n str = let (w,r) = break isSpace str
1257 (s,r') = span isSpace r
1258 in (n,w):words' (n+length w+length s) r'
1259 -- In a Haskell expression we want to parse 'a-b' as three words
1260 -- where a compiler flag (ie. -fno-monomorphism-restriction) should
1261 -- only be a single word.
1262 selectWord [] = (0,w)
1263 selectWord ((offset,x):xs)
1264 | offset+length x >= start = (start-offset,take (end-offset) x)
1265 | otherwise = selectWord xs
1268 | ((':':w) : _) <- words (dropWhile isSpace line) = Just w
1269 | otherwise = Nothing
1272 cmds <- readIORef commands
1273 return (filter (w `isPrefixOf`) (map (':':) (map cmdName cmds)))
1275 completeMacro w = do
1276 cmds <- readIORef commands
1277 let cmds' = [ cmd | cmd <- map cmdName cmds, cmd `elem` map cmdName builtin_commands ]
1278 return (filter (w `isPrefixOf`) cmds')
1280 completeIdentifier w = do
1282 rdrs <- GHC.getRdrNamesInScope s
1283 return (filter (w `isPrefixOf`) (map (showSDoc.ppr) rdrs))
1285 completeModule w = do
1287 dflags <- GHC.getSessionDynFlags s
1288 let pkg_mods = allExposedModules dflags
1289 return (filter (w `isPrefixOf`) (map (showSDoc.ppr) pkg_mods))
1291 completeHomeModule w = do
1293 g <- GHC.getModuleGraph s
1294 let home_mods = map GHC.ms_mod_name g
1295 return (filter (w `isPrefixOf`) (map (showSDoc.ppr) home_mods))
1297 completeSetOptions w = do
1298 return (filter (w `isPrefixOf`) options)
1299 where options = "args":"prog":allFlags
1301 completeFilename = Readline.filenameCompletionFunction
1303 completeHomeModuleOrFile = unionComplete completeHomeModule completeFilename
1305 unionComplete :: (String -> IO [String]) -> (String -> IO [String]) -> String -> IO [String]
1306 unionComplete f1 f2 w = do
1311 wrapCompleter :: (String -> IO [String]) -> String -> IO (Maybe (String,[String]))
1312 wrapCompleter fun w = do
1315 [] -> return Nothing
1316 [x] -> return (Just (x,[]))
1317 xs -> case getCommonPrefix xs of
1318 "" -> return (Just ("",xs))
1319 pref -> return (Just (pref,xs))
1321 getCommonPrefix :: [String] -> String
1322 getCommonPrefix [] = ""
1323 getCommonPrefix (s:ss) = foldl common s ss
1324 where common s "" = ""
1326 common (c:cs) (d:ds)
1327 | c == d = c : common cs ds
1330 allExposedModules :: DynFlags -> [ModuleName]
1331 allExposedModules dflags
1332 = map GHC.mkModuleName (concat (map exposedModules (filter exposed (eltsUFM pkg_db))))
1334 pkg_db = pkgIdMap (pkgState dflags)
1336 completeCmd = completeNone
1337 completeMacro = completeNone
1338 completeIdentifier = completeNone
1339 completeModule = completeNone
1340 completeHomeModule = completeNone
1341 completeSetOptions = completeNone
1342 completeFilename = completeNone
1343 completeHomeModuleOrFile=completeNone
1344 completeBkpt = completeNone
1347 -- ---------------------------------------------------------------------------
1348 -- User code exception handling
1350 -- This is the exception handler for exceptions generated by the
1351 -- user's code and exceptions coming from children sessions;
1352 -- it normally just prints out the exception. The
1353 -- handler must be recursive, in case showing the exception causes
1354 -- more exceptions to be raised.
1356 -- Bugfix: if the user closed stdout or stderr, the flushing will fail,
1357 -- raising another exception. We therefore don't put the recursive
1358 -- handler arond the flushing operation, so if stderr is closed
1359 -- GHCi will just die gracefully rather than going into an infinite loop.
1360 handler :: Exception -> GHCi Bool
1362 handler exception = do
1364 io installSignalHandlers
1365 ghciHandle handler (showException exception >> return False)
1367 showException (DynException dyn) =
1368 case fromDynamic dyn of
1369 Nothing -> io (putStrLn ("*** Exception: (unknown)"))
1370 Just Interrupted -> io (putStrLn "Interrupted.")
1371 Just (CmdLineError s) -> io (putStrLn s) -- omit the location for CmdLineError
1372 Just ph@PhaseFailed{} -> io (putStrLn (showGhcException ph "")) -- ditto
1373 Just other_ghc_ex -> io (print other_ghc_ex)
1375 showException other_exception
1376 = io (putStrLn ("*** Exception: " ++ show other_exception))
1378 -----------------------------------------------------------------------------
1379 -- recursive exception handlers
1381 -- Don't forget to unblock async exceptions in the handler, or if we're
1382 -- in an exception loop (eg. let a = error a in a) the ^C exception
1383 -- may never be delivered. Thanks to Marcin for pointing out the bug.
1385 ghciHandle :: (Exception -> GHCi a) -> GHCi a -> GHCi a
1386 ghciHandle h (GHCi m) = GHCi $ \s ->
1387 Exception.catch (m s)
1388 (\e -> unGHCi (ghciUnblock (h e)) s)
1390 ghciUnblock :: GHCi a -> GHCi a
1391 ghciUnblock (GHCi a) = GHCi $ \s -> Exception.unblock (a s)
1394 -- ----------------------------------------------------------------------------
1397 expandPath :: String -> GHCi String
1399 case dropWhile isSpace path of
1401 tilde <- io (getEnv "HOME") -- will fail if HOME not defined
1402 return (tilde ++ '/':d)
1406 wantInterpretedModule :: String -> GHCi Module
1407 wantInterpretedModule str = do
1408 session <- getSession
1409 modl <- lookupModule str
1410 is_interpreted <- io (GHC.moduleIsInterpreted session modl)
1411 when (not is_interpreted) $
1412 throwDyn (CmdLineError ("module '" ++ str ++ "' is not interpreted"))
1415 wantNameFromInterpretedModule noCanDo str and_then = do
1416 session <- getSession
1417 names <- io $ GHC.parseName session str
1421 let modl = GHC.nameModule n
1422 is_interpreted <- io (GHC.moduleIsInterpreted session modl)
1423 if not is_interpreted
1424 then noCanDo n $ text "module " <> ppr modl <>
1425 text " is not interpreted"
1428 -- ----------------------------------------------------------------------------
1429 -- Windows console setup
1431 setUpConsole :: IO ()
1433 #ifdef mingw32_HOST_OS
1434 -- On Windows we need to set a known code page, otherwise the characters
1435 -- we read from the console will be be in some strange encoding, and
1436 -- similarly for characters we write to the console.
1438 -- At the moment, GHCi pretends all input is Latin-1. In the
1439 -- future we should support UTF-8, but for now we set the code pages
1442 -- It seems you have to set the font in the console window to
1443 -- a Unicode font in order for output to work properly,
1444 -- otherwise non-ASCII characters are mapped wrongly. sigh.
1445 -- (see MSDN for SetConsoleOutputCP()).
1447 setConsoleCP 28591 -- ISO Latin-1
1448 setConsoleOutputCP 28591 -- ISO Latin-1
1452 -- -----------------------------------------------------------------------------
1453 -- commands for debugger
1455 sprintCmd = pprintCommand False False
1456 printCmd = pprintCommand True False
1457 forceCmd = pprintCommand False True
1459 pprintCommand bind force str = do
1460 session <- getSession
1461 io $ pprintClosureCommand session bind force str
1463 stepCmd :: String -> GHCi Bool
1464 stepCmd [] = doContinue GHC.SingleStep
1465 stepCmd expression = runStmt expression GHC.SingleStep
1467 traceCmd :: String -> GHCi Bool
1468 traceCmd [] = doContinue GHC.RunAndLogSteps
1469 traceCmd expression = runStmt expression GHC.RunAndLogSteps
1471 continueCmd :: String -> GHCi Bool
1472 continueCmd [] = doContinue GHC.RunToCompletion
1473 continueCmd other = do
1474 io $ putStrLn "The continue command accepts no arguments."
1477 doContinue :: SingleStep -> GHCi Bool
1478 doContinue step = do
1479 session <- getSession
1480 runResult <- io $ GHC.resume session step
1481 afterRunStmt runResult
1484 abandonCmd :: String -> GHCi ()
1485 abandonCmd = noArgs $ do
1487 b <- io $ GHC.abandon s -- the prompt will change to indicate the new context
1488 when (not b) $ io $ putStrLn "There is no computation running."
1491 deleteCmd :: String -> GHCi ()
1492 deleteCmd argLine = do
1493 deleteSwitch $ words argLine
1495 deleteSwitch :: [String] -> GHCi ()
1497 io $ putStrLn "The delete command requires at least one argument."
1498 -- delete all break points
1499 deleteSwitch ("*":_rest) = discardActiveBreakPoints
1500 deleteSwitch idents = do
1501 mapM_ deleteOneBreak idents
1503 deleteOneBreak :: String -> GHCi ()
1505 | all isDigit str = deleteBreak (read str)
1506 | otherwise = return ()
1508 historyCmd :: String -> GHCi ()
1510 | null arg = history 20
1511 | all isDigit arg = history (read arg)
1512 | otherwise = io $ putStrLn "Syntax: :history [num]"
1516 resumes <- io $ GHC.getResumeContext s
1518 [] -> io $ putStrLn "Not stopped at a breakpoint"
1520 let hist = GHC.resumeHistory r
1521 (took,rest) = splitAt num hist
1522 spans <- mapM (io . GHC.getHistorySpan s) took
1523 let nums = map (printf "-%-3d:") [(1::Int)..]
1524 printForUser (vcat (zipWith (<+>) (map text nums) (map ppr spans)))
1525 io $ putStrLn $ if null rest then "<end of history>" else "..."
1527 backCmd :: String -> GHCi ()
1528 backCmd = noArgs $ do
1530 (names, ix, span) <- io $ GHC.back s
1531 printForUser $ ptext SLIT("Logged breakpoint at") <+> ppr span
1532 mapM_ (showTypeOfName s) names
1533 -- run the command set with ":set stop <cmd>"
1535 runCommand (stop st)
1538 forwardCmd :: String -> GHCi ()
1539 forwardCmd = noArgs $ do
1541 (names, ix, span) <- io $ GHC.forward s
1542 printForUser $ (if (ix == 0)
1543 then ptext SLIT("Stopped at")
1544 else ptext SLIT("Logged breakpoint at")) <+> ppr span
1545 mapM_ (showTypeOfName s) names
1546 -- run the command set with ":set stop <cmd>"
1548 runCommand (stop st)
1551 -- handle the "break" command
1552 breakCmd :: String -> GHCi ()
1553 breakCmd argLine = do
1554 session <- getSession
1555 breakSwitch session $ words argLine
1557 breakSwitch :: Session -> [String] -> GHCi ()
1558 breakSwitch _session [] = do
1559 io $ putStrLn "The break command requires at least one argument."
1560 breakSwitch session args@(arg1:rest)
1561 | looksLikeModuleName arg1 = do
1562 mod <- wantInterpretedModule arg1
1563 breakByModule session mod rest
1564 | all isDigit arg1 = do
1565 (toplevel, _) <- io $ GHC.getContext session
1567 (mod : _) -> breakByModuleLine mod (read arg1) rest
1569 io $ putStrLn "Cannot find default module for breakpoint."
1570 io $ putStrLn "Perhaps no modules are loaded for debugging?"
1571 | otherwise = do -- try parsing it as an identifier
1572 wantNameFromInterpretedModule noCanDo arg1 $ \name -> do
1573 let loc = GHC.nameSrcLoc name
1574 if GHC.isGoodSrcLoc loc
1575 then findBreakAndSet (GHC.nameModule name) $
1576 findBreakByCoord (Just (GHC.srcLocFile loc))
1577 (GHC.srcLocLine loc,
1579 else noCanDo name $ text "can't find its location: " <> ppr loc
1581 noCanDo n why = printForUser $
1582 text "cannot set breakpoint on " <> ppr n <> text ": " <> why
1584 breakByModule :: Session -> Module -> [String] -> GHCi ()
1585 breakByModule session mod args@(arg1:rest)
1586 | all isDigit arg1 = do -- looks like a line number
1587 breakByModuleLine mod (read arg1) rest
1588 | otherwise = io $ putStrLn "Invalid arguments to :break"
1590 breakByModuleLine :: Module -> Int -> [String] -> GHCi ()
1591 breakByModuleLine mod line args
1592 | [] <- args = findBreakAndSet mod $ findBreakByLine line
1593 | [col] <- args, all isDigit col =
1594 findBreakAndSet mod $ findBreakByCoord Nothing (line, read col)
1595 | otherwise = io $ putStrLn "Invalid arguments to :break"
1597 findBreakAndSet :: Module -> (TickArray -> Maybe (Int, SrcSpan)) -> GHCi ()
1598 findBreakAndSet mod lookupTickTree = do
1599 tickArray <- getTickArray mod
1600 (breakArray, _) <- getModBreak mod
1601 case lookupTickTree tickArray of
1602 Nothing -> io $ putStrLn $ "No breakpoints found at that location."
1603 Just (tick, span) -> do
1604 success <- io $ setBreakFlag True breakArray tick
1605 session <- getSession
1609 recordBreak $ BreakLocation
1615 text "Breakpoint " <> ppr nm <>
1617 then text " was already set at " <> ppr span
1618 else text " activated at " <> ppr span
1620 printForUser $ text "Breakpoint could not be activated at"
1623 -- When a line number is specified, the current policy for choosing
1624 -- the best breakpoint is this:
1625 -- - the leftmost complete subexpression on the specified line, or
1626 -- - the leftmost subexpression starting on the specified line, or
1627 -- - the rightmost subexpression enclosing the specified line
1629 findBreakByLine :: Int -> TickArray -> Maybe (BreakIndex,SrcSpan)
1630 findBreakByLine line arr
1631 | not (inRange (bounds arr) line) = Nothing
1633 listToMaybe (sortBy leftmost_largest complete) `mplus`
1634 listToMaybe (sortBy leftmost_smallest incomplete) `mplus`
1635 listToMaybe (sortBy rightmost ticks)
1639 starts_here = [ tick | tick@(nm,span) <- ticks,
1640 GHC.srcSpanStartLine span == line ]
1642 (complete,incomplete) = partition ends_here starts_here
1643 where ends_here (nm,span) = GHC.srcSpanEndLine span == line
1645 findBreakByCoord :: Maybe FastString -> (Int,Int) -> TickArray
1646 -> Maybe (BreakIndex,SrcSpan)
1647 findBreakByCoord mb_file (line, col) arr
1648 | not (inRange (bounds arr) line) = Nothing
1650 listToMaybe (sortBy rightmost contains)
1654 -- the ticks that span this coordinate
1655 contains = [ tick | tick@(nm,span) <- ticks, span `spans` (line,col),
1656 is_correct_file span ]
1658 is_correct_file span
1659 | Just f <- mb_file = GHC.srcSpanFile span == f
1663 leftmost_smallest (_,a) (_,b) = a `compare` b
1664 leftmost_largest (_,a) (_,b) = (GHC.srcSpanStart a `compare` GHC.srcSpanStart b)
1666 (GHC.srcSpanEnd b `compare` GHC.srcSpanEnd a)
1667 rightmost (_,a) (_,b) = b `compare` a
1669 spans :: SrcSpan -> (Int,Int) -> Bool
1670 spans span (l,c) = GHC.srcSpanStart span <= loc && loc <= GHC.srcSpanEnd span
1671 where loc = GHC.mkSrcLoc (GHC.srcSpanFile span) l c
1673 start_bold = BS.pack "\ESC[1m"
1674 end_bold = BS.pack "\ESC[0m"
1676 listCmd :: String -> GHCi ()
1678 mb_span <- getCurrentBreakSpan
1680 Nothing -> printForUser $ text "not stopped at a breakpoint; nothing to list"
1681 Just span -> io $ listAround span True
1682 listCmd str = list2 (words str)
1684 list2 [arg] | all isDigit arg = do
1685 session <- getSession
1686 (toplevel, _) <- io $ GHC.getContext session
1688 [] -> io $ putStrLn "No module to list"
1689 (mod : _) -> listModuleLine mod (read arg)
1690 list2 [arg1,arg2] | looksLikeModuleName arg1, all isDigit arg2 = do
1691 mod <- wantInterpretedModule arg1
1692 listModuleLine mod (read arg2)
1694 wantNameFromInterpretedModule noCanDo arg $ \name -> do
1695 let loc = GHC.nameSrcLoc name
1696 if GHC.isGoodSrcLoc loc
1698 tickArray <- getTickArray (GHC.nameModule name)
1699 let mb_span = findBreakByCoord (Just (GHC.srcLocFile loc))
1700 (GHC.srcLocLine loc, GHC.srcLocCol loc)
1703 Nothing -> io $ listAround (GHC.srcLocSpan loc) False
1704 Just (_,span) -> io $ listAround span False
1706 noCanDo name $ text "can't find its location: " <>
1709 noCanDo n why = printForUser $
1710 text "cannot list source code for " <> ppr n <> text ": " <> why
1712 io $ putStrLn "syntax: :list [<line> | <module> <line> | <identifier>]"
1714 listModuleLine :: Module -> Int -> GHCi ()
1715 listModuleLine modl line = do
1716 session <- getSession
1717 graph <- io (GHC.getModuleGraph session)
1718 let this = filter ((== modl) . GHC.ms_mod) graph
1720 [] -> panic "listModuleLine"
1722 let filename = fromJust (ml_hs_file (GHC.ms_location summ))
1723 loc = GHC.mkSrcLoc (mkFastString (filename)) line 0
1724 io $ listAround (GHC.srcLocSpan loc) False
1726 -- | list a section of a source file around a particular SrcSpan.
1727 -- If the highlight flag is True, also highlight the span using
1728 -- start_bold/end_bold.
1729 listAround span do_highlight = do
1730 contents <- BS.readFile (unpackFS file)
1732 lines = BS.split '\n' contents
1733 these_lines = take (line2 - line1 + 1 + pad_before + pad_after) $
1734 drop (line1 - 1 - pad_before) $ lines
1735 fst_line = max 1 (line1 - pad_before)
1736 line_nos = [ fst_line .. ]
1738 highlighted | do_highlight = zipWith highlight line_nos these_lines
1739 | otherwise = these_lines
1741 bs_line_nos = [ BS.pack (show l ++ " ") | l <- line_nos ]
1742 prefixed = zipWith BS.append bs_line_nos highlighted
1744 BS.putStrLn (BS.join (BS.pack "\n") prefixed)
1746 file = GHC.srcSpanFile span
1747 line1 = GHC.srcSpanStartLine span
1748 col1 = GHC.srcSpanStartCol span
1749 line2 = GHC.srcSpanEndLine span
1750 col2 = GHC.srcSpanEndCol span
1752 pad_before | line1 == 1 = 0
1757 | no == line1 && no == line2
1758 = let (a,r) = BS.splitAt col1 line
1759 (b,c) = BS.splitAt (col2-col1) r
1761 BS.concat [a,start_bold,b,end_bold,c]
1763 = let (a,b) = BS.splitAt col1 line in
1764 BS.concat [a, start_bold, b]
1766 = let (a,b) = BS.splitAt col2 line in
1767 BS.concat [a, end_bold, b]
1770 -- --------------------------------------------------------------------------
1773 getTickArray :: Module -> GHCi TickArray
1774 getTickArray modl = do
1776 let arrmap = tickarrays st
1777 case lookupModuleEnv arrmap modl of
1778 Just arr -> return arr
1780 (breakArray, ticks) <- getModBreak modl
1781 let arr = mkTickArray (assocs ticks)
1782 setGHCiState st{tickarrays = extendModuleEnv arrmap modl arr}
1785 discardTickArrays :: GHCi ()
1786 discardTickArrays = do
1788 setGHCiState st{tickarrays = emptyModuleEnv}
1790 mkTickArray :: [(BreakIndex,SrcSpan)] -> TickArray
1792 = accumArray (flip (:)) [] (1, max_line)
1793 [ (line, (nm,span)) | (nm,span) <- ticks,
1794 line <- srcSpanLines span ]
1796 max_line = maximum (map GHC.srcSpanEndLine (map snd ticks))
1797 srcSpanLines span = [ GHC.srcSpanStartLine span ..
1798 GHC.srcSpanEndLine span ]
1800 lookupModule :: String -> GHCi Module
1801 lookupModule modName
1802 = do session <- getSession
1803 io (GHC.findModule session (GHC.mkModuleName modName) Nothing)
1805 -- don't reset the counter back to zero?
1806 discardActiveBreakPoints :: GHCi ()
1807 discardActiveBreakPoints = do
1809 mapM (turnOffBreak.snd) (breaks st)
1810 setGHCiState $ st { breaks = [] }
1812 deleteBreak :: Int -> GHCi ()
1813 deleteBreak identity = do
1815 let oldLocations = breaks st
1816 (this,rest) = partition (\loc -> fst loc == identity) oldLocations
1818 then printForUser (text "Breakpoint" <+> ppr identity <+>
1819 text "does not exist")
1821 mapM (turnOffBreak.snd) this
1822 setGHCiState $ st { breaks = rest }
1824 turnOffBreak loc = do
1825 (arr, _) <- getModBreak (breakModule loc)
1826 io $ setBreakFlag False arr (breakTick loc)
1828 getModBreak :: Module -> GHCi (GHC.BreakArray, Array Int SrcSpan)
1829 getModBreak mod = do
1830 session <- getSession
1831 Just mod_info <- io $ GHC.getModuleInfo session mod
1832 let modBreaks = GHC.modInfoModBreaks mod_info
1833 let array = GHC.modBreaks_flags modBreaks
1834 let ticks = GHC.modBreaks_locs modBreaks
1835 return (array, ticks)
1837 setBreakFlag :: Bool -> GHC.BreakArray -> Int -> IO Bool
1838 setBreakFlag toggle array index
1839 | toggle = GHC.setBreakOn array index
1840 | otherwise = GHC.setBreakOff array index