1 {-# OPTIONS -#include "Linker.h" #-}
2 -----------------------------------------------------------------------------
4 -- GHC Interactive User Interface
6 -- (c) The GHC Team 2005-2006
8 -----------------------------------------------------------------------------
10 module InteractiveUI ( interactiveUI, ghciWelcomeMsg ) where
12 #include "HsVersions.h"
20 import GHC ( Session, LoadHowMuch(..), Target(..), TargetId(..),
21 Module, ModuleName, TyThing(..), Phase,
22 BreakIndex, SrcSpan, Resume, SingleStep )
32 import HscTypes ( implicitTyThings )
33 import qualified RdrName ( getGRE_NameQualifier_maybes ) -- should this come via GHC?
34 import Outputable hiding (printForUser, printForUserPartWay)
35 import Module -- for ModuleEnv
39 -- Other random utilities
41 import BasicTypes hiding (isTopLevel)
42 import Panic hiding (showException)
48 import Maybes ( orElse )
52 #ifndef mingw32_HOST_OS
53 import System.Posix hiding (getEnv)
55 import GHC.ConsoleHandler ( flushConsole )
56 import qualified System.Win32
57 import System.FilePath
61 import Control.Concurrent ( yield ) -- Used in readline loop
62 import System.Console.Readline as Readline
67 import Control.Exception as Exception
68 -- import Control.Concurrent
70 import qualified Data.ByteString.Char8 as BS
74 import System.Environment
75 import System.Exit ( exitWith, ExitCode(..) )
76 import System.Directory
78 import System.IO.Error as IO
82 import Control.Monad as Monad
86 import GHC.Exts ( unsafeCoerce# )
87 import GHC.IOBase ( IOErrorType(InvalidArgument) )
90 import Data.IORef ( IORef, readIORef, writeIORef )
93 import System.Posix.Internals ( setNonBlockingFD )
96 -----------------------------------------------------------------------------
98 ghciWelcomeMsg :: String
99 ghciWelcomeMsg = "GHCi, version " ++ cProjectVersion ++
100 ": http://www.haskell.org/ghc/ :? for help"
102 cmdName :: Command -> String
103 cmdName (n,_,_,_) = n
105 macros_ref :: IORef [Command]
106 GLOBAL_VAR(macros_ref, [], [Command])
108 builtin_commands :: [Command]
110 -- Hugs users are accustomed to :e, so make sure it doesn't overlap
111 ("?", keepGoing help, Nothing, completeNone),
112 ("add", keepGoingPaths addModule, Just filenameWordBreakChars, completeFilename),
113 ("abandon", keepGoing abandonCmd, Nothing, completeNone),
114 ("break", keepGoing breakCmd, Nothing, completeIdentifier),
115 ("back", keepGoing backCmd, Nothing, completeNone),
116 ("browse", keepGoing (browseCmd False), Nothing, completeModule),
117 ("browse!", keepGoing (browseCmd True), Nothing, completeModule),
118 ("cd", keepGoing changeDirectory, Just filenameWordBreakChars, completeFilename),
119 ("check", keepGoing checkModule, Nothing, completeHomeModule),
120 ("continue", keepGoing continueCmd, Nothing, completeNone),
121 ("cmd", keepGoing cmdCmd, Nothing, completeIdentifier),
122 ("ctags", keepGoing createCTagsFileCmd, Just filenameWordBreakChars, completeFilename),
123 ("def", keepGoing (defineMacro False), Nothing, completeIdentifier),
124 ("def!", keepGoing (defineMacro True), Nothing, completeIdentifier),
125 ("delete", keepGoing deleteCmd, Nothing, completeNone),
126 ("e", keepGoing editFile, Just filenameWordBreakChars, completeFilename),
127 ("edit", keepGoing editFile, Just filenameWordBreakChars, completeFilename),
128 ("etags", keepGoing createETagsFileCmd, Just filenameWordBreakChars, completeFilename),
129 ("force", keepGoing forceCmd, Nothing, completeIdentifier),
130 ("forward", keepGoing forwardCmd, Nothing, completeNone),
131 ("help", keepGoing help, Nothing, completeNone),
132 ("history", keepGoing historyCmd, Nothing, completeNone),
133 ("info", keepGoing info, Nothing, completeIdentifier),
134 ("kind", keepGoing kindOfType, Nothing, completeIdentifier),
135 ("load", keepGoingPaths loadModule_, Just filenameWordBreakChars, completeHomeModuleOrFile),
136 ("list", keepGoing listCmd, Nothing, completeNone),
137 ("module", keepGoing setContext, Nothing, completeModule),
138 ("main", keepGoing runMain, Nothing, completeIdentifier),
139 ("print", keepGoing printCmd, Nothing, completeIdentifier),
140 ("quit", quit, Nothing, completeNone),
141 ("reload", keepGoing reloadModule, Nothing, completeNone),
142 ("run", keepGoing runRun, Nothing, completeIdentifier),
143 ("set", keepGoing setCmd, Just flagWordBreakChars, completeSetOptions),
144 ("show", keepGoing showCmd, Nothing, completeNone),
145 ("sprint", keepGoing sprintCmd, Nothing, completeIdentifier),
146 ("step", keepGoing stepCmd, Nothing, completeIdentifier),
147 ("steplocal", keepGoing stepLocalCmd, Nothing, completeIdentifier),
148 ("stepmodule",keepGoing stepModuleCmd, Nothing, completeIdentifier),
149 ("type", keepGoing typeOfExpr, Nothing, completeIdentifier),
150 ("trace", keepGoing traceCmd, Nothing, completeIdentifier),
151 ("undef", keepGoing undefineMacro, Nothing, completeMacro),
152 ("unset", keepGoing unsetOptions, Just flagWordBreakChars, completeSetOptions)
156 -- We initialize readline (in the interactiveUI function) to use
157 -- word_break_chars as the default set of completion word break characters.
158 -- This can be overridden for a particular command (for example, filename
159 -- expansion shouldn't consider '/' to be a word break) by setting the third
160 -- entry in the Command tuple above.
162 -- NOTE: in order for us to override the default correctly, any custom entry
163 -- must be a SUBSET of word_break_chars.
165 word_break_chars :: String
166 word_break_chars = let symbols = "!#$%&*+/<=>?@\\^|-~"
167 specials = "(),;[]`{}"
169 in spaces ++ specials ++ symbols
172 flagWordBreakChars, filenameWordBreakChars :: String
173 flagWordBreakChars = " \t\n"
174 filenameWordBreakChars = " \t\n\\`@$><=;|&{(" -- bash defaults
177 keepGoing :: (String -> GHCi ()) -> (String -> GHCi Bool)
178 keepGoing a str = a str >> return False
180 keepGoingPaths :: ([FilePath] -> GHCi ()) -> (String -> GHCi Bool)
182 = do case toArgs str of
183 Left err -> io (hPutStrLn stderr err)
187 shortHelpText :: String
188 shortHelpText = "use :? for help.\n"
192 " Commands available from the prompt:\n" ++
194 " <statement> evaluate/run <statement>\n" ++
195 " : repeat last command\n" ++
196 " :{\\n ..lines.. \\n:}\\n multiline command\n" ++
197 " :add <filename> ... add module(s) to the current target set\n" ++
198 " :browse[!] [[*]<mod>] display the names defined by module <mod>\n" ++
199 " (!: more details; *: all top-level names)\n" ++
200 " :cd <dir> change directory to <dir>\n" ++
201 " :cmd <expr> run the commands returned by <expr>::IO String\n" ++
202 " :ctags [<file>] create tags file for Vi (default: \"tags\")\n" ++
203 " :def <cmd> <expr> define a command :<cmd>\n" ++
204 " :edit <file> edit file\n" ++
205 " :edit edit last module\n" ++
206 " :etags [<file>] create tags file for Emacs (default: \"TAGS\")\n" ++
207 " :help, :? display this list of commands\n" ++
208 " :info [<name> ...] display information about the given names\n" ++
209 " :kind <type> show the kind of <type>\n" ++
210 " :load <filename> ... load module(s) and their dependents\n" ++
211 " :main [<arguments> ...] run the main function with the given arguments\n" ++
212 " :module [+/-] [*]<mod> ... set the context for expression evaluation\n" ++
213 " :quit exit GHCi\n" ++
214 " :reload reload the current module set\n" ++
215 " :run function [<arguments> ...] run the function with the given arguments\n" ++
216 " :type <expr> show the type of <expr>\n" ++
217 " :undef <cmd> undefine user-defined command :<cmd>\n" ++
218 " :!<command> run the shell command <command>\n" ++
220 " -- Commands for debugging:\n" ++
222 " :abandon at a breakpoint, abandon current computation\n" ++
223 " :back go back in the history (after :trace)\n" ++
224 " :break [<mod>] <l> [<col>] set a breakpoint at the specified location\n" ++
225 " :break <name> set a breakpoint on the specified function\n" ++
226 " :continue resume after a breakpoint\n" ++
227 " :delete <number> delete the specified breakpoint\n" ++
228 " :delete * delete all breakpoints\n" ++
229 " :force <expr> print <expr>, forcing unevaluated parts\n" ++
230 " :forward go forward in the history (after :back)\n" ++
231 " :history [<n>] show the last <n> items in the history (after :trace)\n" ++
232 " :print [<name> ...] prints a value without forcing its computation\n" ++
233 " :sprint [<name> ...] simplifed version of :print\n" ++
234 " :step single-step after stopping at a breakpoint\n"++
235 " :step <expr> single-step into <expr>\n"++
236 " :steplocal single-step restricted to the current top level decl.\n"++
237 " :stepmodule single-step restricted to the current module\n"++
238 " :trace trace after stopping at a breakpoint\n"++
239 " :trace <expr> trace into <expr> (remembers breakpoints for :history)\n"++
242 " -- Commands for changing settings:\n" ++
244 " :set <option> ... set options\n" ++
245 " :set args <arg> ... set the arguments returned by System.getArgs\n" ++
246 " :set prog <progname> set the value returned by System.getProgName\n" ++
247 " :set prompt <prompt> set the prompt used in GHCi\n" ++
248 " :set editor <cmd> set the command used for :edit\n" ++
249 " :set stop <cmd> set the command to run when a breakpoint is hit\n" ++
250 " :unset <option> ... unset options\n" ++
252 " Options for ':set' and ':unset':\n" ++
254 " +r revert top-level expressions after each evaluation\n" ++
255 " +s print timing/memory stats after each evaluation\n" ++
256 " +t print type after evaluation\n" ++
257 " -<flags> most GHC command line flags can also be set here\n" ++
258 " (eg. -v2, -fglasgow-exts, etc.)\n" ++
259 " for GHCi-specific flags, see User's Guide,\n"++
260 " Flag reference, Interactive-mode options\n" ++
262 " -- Commands for displaying information:\n" ++
264 " :show bindings show the current bindings made at the prompt\n" ++
265 " :show breaks show the active breakpoints\n" ++
266 " :show context show the breakpoint context\n" ++
267 " :show modules show the currently loaded modules\n" ++
268 " :show packages show the currently active package flags\n" ++
269 " :show languages show the currently active language flags\n" ++
270 " :show <setting> show anything that can be set with :set (e.g. args)\n" ++
273 findEditor :: IO String
278 win <- System.Win32.getWindowsDirectory
279 return (win </> "notepad.exe")
284 interactiveUI :: Session -> [(FilePath, Maybe Phase)] -> Maybe [String]
286 interactiveUI session srcs maybe_exprs = do
287 -- HACK! If we happen to get into an infinite loop (eg the user
288 -- types 'let x=x in x' at the prompt), then the thread will block
289 -- on a blackhole, and become unreachable during GC. The GC will
290 -- detect that it is unreachable and send it the NonTermination
291 -- exception. However, since the thread is unreachable, everything
292 -- it refers to might be finalized, including the standard Handles.
293 -- This sounds like a bug, but we don't have a good solution right
299 -- Initialise buffering for the *interpreted* I/O system
300 initInterpBuffering session
302 when (isNothing maybe_exprs) $ do
303 -- Only for GHCi (not runghc and ghc -e):
305 -- Turn buffering off for the compiled program's stdout/stderr
307 -- Turn buffering off for GHCi's stdout
309 hSetBuffering stdout NoBuffering
310 -- We don't want the cmd line to buffer any input that might be
311 -- intended for the program, so unbuffer stdin.
312 hSetBuffering stdin NoBuffering
315 is_tty <- hIsTerminalDevice stdin
318 Readline.setAttemptedCompletionFunction (Just completeWord)
319 --Readline.parseAndBind "set show-all-if-ambiguous 1"
321 Readline.setBasicWordBreakCharacters word_break_chars
322 Readline.setCompleterWordBreakCharacters word_break_chars
323 Readline.setCompletionAppendCharacter Nothing
326 -- initial context is just the Prelude
327 prel_mod <- GHC.findModule session (GHC.mkModuleName "Prelude")
329 GHC.setContext session [] [prel_mod]
331 default_editor <- findEditor
333 startGHCi (runGHCi srcs maybe_exprs)
334 GHCiState{ progname = "<interactive>",
338 editor = default_editor,
344 tickarrays = emptyModuleEnv,
345 last_command = Nothing,
351 Readline.resetTerminal Nothing
356 runGHCi :: [(FilePath, Maybe Phase)] -> Maybe [String] -> GHCi ()
357 runGHCi paths maybe_exprs = do
358 let read_dot_files = not opt_IgnoreDotGhci
360 when (read_dot_files) $ do
363 exists <- io (doesFileExist file)
365 dir_ok <- io (checkPerms ".")
366 file_ok <- io (checkPerms file)
367 when (dir_ok && file_ok) $ do
368 either_hdl <- io (IO.try (openFile "./.ghci" ReadMode))
371 Right hdl -> runCommands (fileLoop hdl False False)
373 when (read_dot_files) $ do
374 -- Read in $HOME/.ghci
375 either_dir <- io (IO.try getHomeDirectory)
379 cwd <- io (getCurrentDirectory)
380 when (dir /= cwd) $ do
381 let file = dir ++ "/.ghci"
382 ok <- io (checkPerms file)
384 either_hdl <- io (IO.try (openFile file ReadMode))
387 Right hdl -> runCommands (fileLoop hdl False False)
389 -- Perform a :load for files given on the GHCi command line
390 -- When in -e mode, if the load fails then we want to stop
391 -- immediately rather than going on to evaluate the expression.
392 when (not (null paths)) $ do
393 ok <- ghciHandle (\e -> do showException e; return Failed) $
395 when (isJust maybe_exprs && failed ok) $
396 io (exitWith (ExitFailure 1))
398 -- if verbosity is greater than 0, or we are connected to a
399 -- terminal, display the prompt in the interactive loop.
400 is_tty <- io (hIsTerminalDevice stdin)
401 dflags <- getDynFlags
402 let show_prompt = verbosity dflags > 0 || is_tty
407 #if defined(mingw32_HOST_OS)
408 -- The win32 Console API mutates the first character of
409 -- type-ahead when reading from it in a non-buffered manner. Work
410 -- around this by flushing the input buffer of type-ahead characters,
411 -- but only if stdin is available.
412 flushed <- io (IO.try (GHC.ConsoleHandler.flushConsole stdin))
414 Left err | isDoesNotExistError err -> return ()
415 | otherwise -> io (ioError err)
416 Right () -> return ()
418 -- enter the interactive loop
419 interactiveLoop is_tty show_prompt
421 -- just evaluate the expression we were given
422 enqueueCommands exprs
423 let handle e = do st <- getGHCiState
424 -- Jump through some hoops to get the
425 -- current progname in the exception text:
426 -- <progname>: <exception>
427 io $ withProgName (progname st)
428 -- The "fast exit" part just calls exit()
429 -- directly instead of doing an orderly
430 -- runtime shutdown, otherwise the main
431 -- GHCi thread will complain about being
433 $ topHandlerFastExit e
434 runCommands' handle (return Nothing)
437 io $ do when (verbosity dflags > 0) $ putStrLn "Leaving GHCi."
439 interactiveLoop :: Bool -> Bool -> GHCi ()
440 interactiveLoop is_tty show_prompt =
441 -- Ignore ^C exceptions caught here
442 ghciHandleDyn (\e -> case e of
444 #if defined(mingw32_HOST_OS)
447 interactiveLoop is_tty show_prompt
448 _other -> return ()) $
450 ghciUnblock $ do -- unblock necessary if we recursed from the
451 -- exception handler above.
453 -- read commands from stdin
456 then runCommands readlineLoop
457 else runCommands (fileLoop stdin show_prompt is_tty)
459 runCommands (fileLoop stdin show_prompt is_tty)
463 -- NOTE: We only read .ghci files if they are owned by the current user,
464 -- and aren't world writable. Otherwise, we could be accidentally
465 -- running code planted by a malicious third party.
467 -- Furthermore, We only read ./.ghci if . is owned by the current user
468 -- and isn't writable by anyone else. I think this is sufficient: we
469 -- don't need to check .. and ../.. etc. because "." always refers to
470 -- the same directory while a process is running.
472 checkPerms :: String -> IO Bool
473 #ifdef mingw32_HOST_OS
478 Util.handle (\_ -> return False) $ do
479 st <- getFileStatus name
481 if fileOwner st /= me then do
482 putStrLn $ "WARNING: " ++ name ++ " is owned by someone else, IGNORING!"
485 let mode = fileMode st
486 if (groupWriteMode == (mode `intersectFileModes` groupWriteMode))
487 || (otherWriteMode == (mode `intersectFileModes` otherWriteMode))
489 putStrLn $ "*** WARNING: " ++ name ++
490 " is writable by someone else, IGNORING!"
495 fileLoop :: Handle -> Bool -> Bool -> GHCi (Maybe String)
496 fileLoop hdl show_prompt is_tty = do
497 when show_prompt $ do
500 l <- io (IO.try (hGetLine hdl))
502 Left e | isEOFError e -> return Nothing
503 | InvalidArgument <- etype -> return Nothing
504 | otherwise -> io (ioError e)
505 where etype = ioeGetErrorType e
506 -- treat InvalidArgument in the same way as EOF:
507 -- this can happen if the user closed stdin, or
508 -- perhaps did getContents which closes stdin at
511 str <- io $ consoleInputToUnicode is_tty l
514 #ifdef mingw32_HOST_OS
515 -- Convert the console input into Unicode according to the current code page.
516 -- The Windows console stores Unicode characters directly, so this is a
517 -- rather roundabout way of doing things... oh well.
518 -- See #782, #1483, #1649
519 consoleInputToUnicode :: Bool -> String -> IO String
520 consoleInputToUnicode is_tty str
522 cp <- System.Win32.getConsoleCP
523 System.Win32.stringToUnicode cp str
525 decodeStringAsUTF8 str
527 -- for Unix, assume the input is in UTF-8 and decode it to a Unicode String.
529 consoleInputToUnicode :: Bool -> String -> IO String
530 consoleInputToUnicode _is_tty str = decodeStringAsUTF8 str
533 decodeStringAsUTF8 :: String -> IO String
534 decodeStringAsUTF8 str =
535 withCStringLen str $ \(cstr,len) ->
536 utf8DecodeString (castPtr cstr :: Ptr Word8) len
538 mkPrompt :: GHCi String
540 session <- getSession
541 (toplevs,exports) <- io (GHC.getContext session)
542 resumes <- io $ GHC.getResumeContext session
543 -- st <- getGHCiState
549 let ix = GHC.resumeHistoryIx r
551 then return (brackets (ppr (GHC.resumeSpan r)) <> space)
553 let hist = GHC.resumeHistory r !! (ix-1)
554 span <- io$ GHC.getHistorySpan session hist
555 return (brackets (ppr (negate ix) <> char ':'
556 <+> ppr span) <> space)
558 dots | _:rs <- resumes, not (null rs) = text "... "
565 -- let (btoplevs, bexports) = fromMaybe ([],[]) (remembered_ctx st) in
566 -- hsep (map (\m -> text "!*" <> ppr (GHC.moduleName m)) btoplevs) <+>
567 -- hsep (map (\m -> char '!' <> ppr (GHC.moduleName m)) bexports) <+>
568 hsep (map (\m -> char '*' <> ppr (GHC.moduleName m)) toplevs) <+>
569 hsep (map (ppr . GHC.moduleName) exports)
571 deflt_prompt = dots <> context_bit <> modules_bit
573 f ('%':'s':xs) = deflt_prompt <> f xs
574 f ('%':'%':xs) = char '%' <> f xs
575 f (x:xs) = char x <> f xs
579 return (showSDoc (f (prompt st)))
583 readlineLoop :: GHCi (Maybe String)
586 saveSession -- for use by completion
588 l <- io (readline prompt `finally` setNonBlockingFD 0)
589 -- readline sometimes puts stdin into blocking mode,
590 -- so we need to put it back for the IO library
593 Nothing -> return Nothing
596 str <- io $ consoleInputToUnicode True l
600 queryQueue :: GHCi (Maybe String)
605 c:cs -> do setGHCiState st{ cmdqueue = cs }
608 runCommands :: GHCi (Maybe String) -> GHCi ()
609 runCommands = runCommands' handler
611 runCommands' :: (Exception -> GHCi Bool) -- Exception handler
612 -> GHCi (Maybe String) -> GHCi ()
613 runCommands' eh getCmd = do
614 mb_cmd <- noSpace queryQueue
615 mb_cmd <- maybe (noSpace getCmd) (return . Just) mb_cmd
619 b <- ghciHandle eh (doCommand c)
620 if b then return () else runCommands' eh getCmd
622 noSpace q = q >>= maybe (return Nothing)
623 (\c->case removeSpaces c of
625 ":{" -> multiLineCmd q
626 c -> return (Just c) )
630 setGHCiState st{ prompt = "%s| " }
631 mb_cmd <- collectCommand q ""
632 getGHCiState >>= \st->setGHCiState st{ prompt = p }
634 -- we can't use removeSpaces for the sublines here, so
635 -- multiline commands are somewhat more brittle against
636 -- fileformat errors (such as \r in dos input on unix),
637 -- we get rid of any extra spaces for the ":}" test;
638 -- we also avoid silent failure if ":}" is not found;
639 -- and since there is no (?) valid occurrence of \r (as
640 -- opposed to its String representation, "\r") inside a
641 -- ghci command, we replace any such with ' ' (argh:-(
642 collectCommand q c = q >>=
643 maybe (io (ioError collectError))
644 (\l->if removeSpaces l == ":}"
645 then return (Just $ removeSpaces c)
646 else collectCommand q (c++map normSpace l))
647 where normSpace '\r' = ' '
649 -- QUESTION: is userError the one to use here?
650 collectError = userError "unterminated multiline command :{ .. :}"
651 doCommand (':' : cmd) = specialCommand cmd
652 doCommand stmt = do timeIt $ runStmt stmt GHC.RunToCompletion
655 enqueueCommands :: [String] -> GHCi ()
656 enqueueCommands cmds = do
658 setGHCiState st{ cmdqueue = cmds ++ cmdqueue st }
661 runStmt :: String -> SingleStep -> GHCi Bool
663 | null (filter (not.isSpace) stmt) = return False
664 | ["import", mod] <- words stmt = keepGoing setContext ('+':mod)
666 = do st <- getGHCiState
667 session <- getSession
668 result <- io $ withProgName (progname st) $ withArgs (args st) $
669 GHC.runStmt session stmt step
670 afterRunStmt (const True) result
673 --afterRunStmt :: GHC.RunResult -> GHCi Bool
674 -- False <=> the statement failed to compile
675 afterRunStmt :: (SrcSpan -> Bool) -> GHC.RunResult -> GHCi Bool
676 afterRunStmt _ (GHC.RunException e) = throw e
677 afterRunStmt step_here run_result = do
678 session <- getSession
679 resumes <- io $ GHC.getResumeContext session
681 GHC.RunOk names -> do
682 show_types <- isOptionSet ShowType
683 when show_types $ printTypeOfNames session names
684 GHC.RunBreak _ names mb_info
685 | isNothing mb_info ||
686 step_here (GHC.resumeSpan $ head resumes) -> do
687 printForUser $ ptext SLIT("Stopped at") <+>
688 ppr (GHC.resumeSpan $ head resumes)
689 -- printTypeOfNames session names
690 let namesSorted = sortBy compareNames names
691 tythings <- catMaybes `liftM`
692 io (mapM (GHC.lookupName session) namesSorted)
693 docs <- io$ pprTypeAndContents session [id | AnId id <- tythings]
694 printForUserPartWay docs
695 maybe (return ()) runBreakCmd mb_info
696 -- run the command set with ":set stop <cmd>"
698 enqueueCommands [stop st]
700 | otherwise -> io(GHC.resume session GHC.SingleStep) >>=
701 afterRunStmt step_here >> return ()
705 io installSignalHandlers
706 b <- isOptionSet RevertCAFs
707 io (when b revertCAFs)
709 return (case run_result of GHC.RunOk _ -> True; _ -> False)
711 runBreakCmd :: GHC.BreakInfo -> GHCi ()
712 runBreakCmd info = do
713 let mod = GHC.breakInfo_module info
714 nm = GHC.breakInfo_number info
716 case [ loc | (_,loc) <- breaks st,
717 breakModule loc == mod, breakTick loc == nm ] of
719 loc:_ | null cmd -> return ()
720 | otherwise -> do enqueueCommands [cmd]; return ()
721 where cmd = onBreakCmd loc
723 printTypeOfNames :: Session -> [Name] -> GHCi ()
724 printTypeOfNames session names
725 = mapM_ (printTypeOfName session) $ sortBy compareNames names
727 compareNames :: Name -> Name -> Ordering
728 n1 `compareNames` n2 = compareWith n1 `compare` compareWith n2
729 where compareWith n = (getOccString n, getSrcSpan n)
731 printTypeOfName :: Session -> Name -> GHCi ()
732 printTypeOfName session n
733 = do maybe_tything <- io (GHC.lookupName session n)
734 case maybe_tything of
736 Just thing -> printTyThing thing
739 data MaybeCommand = GotCommand Command | BadCommand | NoLastCommand
741 specialCommand :: String -> GHCi Bool
742 specialCommand ('!':str) = shellEscape (dropWhile isSpace str)
743 specialCommand str = do
744 let (cmd,rest) = break isSpace str
745 maybe_cmd <- lookupCommand cmd
747 GotCommand (_,f,_,_) -> f (dropWhile isSpace rest)
749 do io $ hPutStr stdout ("unknown command ':" ++ cmd ++ "'\n"
753 do io $ hPutStr stdout ("there is no last command to perform\n"
757 lookupCommand :: String -> GHCi (MaybeCommand)
758 lookupCommand "" = do
760 case last_command st of
761 Just c -> return $ GotCommand c
762 Nothing -> return NoLastCommand
763 lookupCommand str = do
764 mc <- io $ lookupCommand' str
766 setGHCiState st{ last_command = mc }
768 Just c -> GotCommand c
769 Nothing -> BadCommand
771 lookupCommand' :: String -> IO (Maybe Command)
772 lookupCommand' str = do
773 macros <- readIORef macros_ref
774 let cmds = builtin_commands ++ macros
775 -- look for exact match first, then the first prefix match
776 return $ case [ c | c <- cmds, str == cmdName c ] of
778 [] -> case [ c | c@(s,_,_,_) <- cmds, str `isPrefixOf` s ] of
782 getCurrentBreakSpan :: GHCi (Maybe SrcSpan)
783 getCurrentBreakSpan = do
784 session <- getSession
785 resumes <- io $ GHC.getResumeContext session
789 let ix = GHC.resumeHistoryIx r
791 then return (Just (GHC.resumeSpan r))
793 let hist = GHC.resumeHistory r !! (ix-1)
794 span <- io $ GHC.getHistorySpan session hist
797 getCurrentBreakModule :: GHCi (Maybe Module)
798 getCurrentBreakModule = do
799 session <- getSession
800 resumes <- io $ GHC.getResumeContext session
804 let ix = GHC.resumeHistoryIx r
806 then return (GHC.breakInfo_module `liftM` GHC.resumeBreakInfo r)
808 let hist = GHC.resumeHistory r !! (ix-1)
809 return $ Just $ GHC.getHistoryModule hist
811 -----------------------------------------------------------------------------
814 noArgs :: GHCi () -> String -> GHCi ()
816 noArgs _ _ = io $ putStrLn "This command takes no arguments"
818 help :: String -> GHCi ()
819 help _ = io (putStr helpText)
821 info :: String -> GHCi ()
822 info "" = throwDyn (CmdLineError "syntax: ':i <thing-you-want-info-about>'")
823 info s = do { let names = words s
824 ; session <- getSession
825 ; dflags <- getDynFlags
826 ; let pefas = dopt Opt_PrintExplicitForalls dflags
827 ; mapM_ (infoThing pefas session) names }
829 infoThing pefas session str = io $ do
830 names <- GHC.parseName session str
831 mb_stuffs <- mapM (GHC.getInfo session) names
832 let filtered = filterOutChildren (\(t,_f,_i) -> t) (catMaybes mb_stuffs)
833 unqual <- GHC.getPrintUnqual session
834 putStrLn (showSDocForUser unqual $
835 vcat (intersperse (text "") $
836 map (pprInfo pefas) filtered))
838 -- Filter out names whose parent is also there Good
839 -- example is '[]', which is both a type and data
840 -- constructor in the same type
841 filterOutChildren :: (a -> TyThing) -> [a] -> [a]
842 filterOutChildren get_thing xs
843 = [x | x <- xs, not (getName (get_thing x) `elemNameSet` implicits)]
845 implicits = mkNameSet [getName t | x <- xs, t <- implicitTyThings (get_thing x)]
847 pprInfo :: PrintExplicitForalls -> (TyThing, Fixity, [GHC.Instance]) -> SDoc
848 pprInfo pefas (thing, fixity, insts)
849 = pprTyThingInContextLoc pefas thing
850 $$ show_fixity fixity
851 $$ vcat (map GHC.pprInstance insts)
854 | fix == GHC.defaultFixity = empty
855 | otherwise = ppr fix <+> ppr (GHC.getName thing)
857 runMain :: String -> GHCi ()
858 runMain s = case toArgs s of
859 Left err -> io (hPutStrLn stderr err)
861 do dflags <- getDynFlags
862 case mainFunIs dflags of
863 Nothing -> doWithArgs args "main"
864 Just f -> doWithArgs args f
866 runRun :: String -> GHCi ()
867 runRun s = case toCmdArgs s of
868 Left err -> io (hPutStrLn stderr err)
869 Right (cmd, args) -> doWithArgs args cmd
871 doWithArgs :: [String] -> String -> GHCi ()
872 doWithArgs args cmd = enqueueCommands ["System.Environment.withArgs " ++
873 show args ++ " (" ++ cmd ++ ")"]
875 addModule :: [FilePath] -> GHCi ()
877 io (revertCAFs) -- always revert CAFs on load/add.
878 files <- mapM expandPath files
879 targets <- mapM (\m -> io (GHC.guessTarget m Nothing)) files
880 session <- getSession
881 io (mapM_ (GHC.addTarget session) targets)
882 prev_context <- io $ GHC.getContext session
883 ok <- io (GHC.load session LoadAllTargets)
884 afterLoad ok session False prev_context
886 changeDirectory :: String -> GHCi ()
887 changeDirectory "" = do
888 -- :cd on its own changes to the user's home directory
889 either_dir <- io (IO.try getHomeDirectory)
892 Right dir -> changeDirectory dir
893 changeDirectory dir = do
894 session <- getSession
895 graph <- io (GHC.getModuleGraph session)
896 when (not (null graph)) $
897 io $ putStr "Warning: changing directory causes all loaded modules to be unloaded,\nbecause the search path has changed.\n"
898 prev_context <- io $ GHC.getContext session
899 io (GHC.setTargets session [])
900 io (GHC.load session LoadAllTargets)
901 setContextAfterLoad session prev_context False []
902 io (GHC.workingDirectoryChanged session)
903 dir <- expandPath dir
904 io (setCurrentDirectory dir)
906 editFile :: String -> GHCi ()
908 do file <- if null str then chooseEditFile else return str
912 $ throwDyn (CmdLineError "editor not set, use :set editor")
913 io $ system (cmd ++ ' ':file)
916 -- The user didn't specify a file so we pick one for them.
917 -- Our strategy is to pick the first module that failed to load,
918 -- or otherwise the first target.
920 -- XXX: Can we figure out what happened if the depndecy analysis fails
921 -- (e.g., because the porgrammeer mistyped the name of a module)?
922 -- XXX: Can we figure out the location of an error to pass to the editor?
923 -- XXX: if we could figure out the list of errors that occured during the
924 -- last load/reaload, then we could start the editor focused on the first
926 chooseEditFile :: GHCi String
928 do session <- getSession
929 let hasFailed x = io $ fmap not $ GHC.isLoaded session $ GHC.ms_mod_name x
931 graph <- io (GHC.getModuleGraph session)
932 failed_graph <- filterM hasFailed graph
933 let order g = flattenSCCs $ GHC.topSortModuleGraph True g Nothing
935 x : _ -> GHC.ml_hs_file (GHC.ms_location x)
938 case pick (order failed_graph) of
939 Just file -> return file
941 do targets <- io (GHC.getTargets session)
942 case msum (map fromTarget targets) of
943 Just file -> return file
944 Nothing -> throwDyn (CmdLineError "No files to edit.")
946 where fromTarget (GHC.Target (GHC.TargetFile f _) _) = Just f
947 fromTarget _ = Nothing -- when would we get a module target?
949 defineMacro :: Bool{-overwrite-} -> String -> GHCi ()
950 defineMacro overwrite s = do
951 let (macro_name, definition) = break isSpace s
952 macros <- io (readIORef macros_ref)
953 let defined = map cmdName macros
956 then io $ putStrLn "no macros defined"
957 else io $ putStr ("the following macros are defined:\n" ++
960 if (not overwrite && macro_name `elem` defined)
961 then throwDyn (CmdLineError
962 ("macro '" ++ macro_name ++ "' is already defined"))
965 let filtered = [ cmd | cmd <- macros, cmdName cmd /= macro_name ]
967 -- give the expression a type signature, so we can be sure we're getting
968 -- something of the right type.
969 let new_expr = '(' : definition ++ ") :: String -> IO String"
971 -- compile the expression
973 maybe_hv <- io (GHC.compileExpr cms new_expr)
976 Just hv -> io (writeIORef macros_ref --
977 (filtered ++ [(macro_name, runMacro hv, Nothing, completeNone)]))
979 runMacro :: GHC.HValue{-String -> IO String-} -> String -> GHCi Bool
981 str <- io ((unsafeCoerce# fun :: String -> IO String) s)
982 enqueueCommands (lines str)
985 undefineMacro :: String -> GHCi ()
986 undefineMacro str = mapM_ undef (words str)
987 where undef macro_name = do
988 cmds <- io (readIORef macros_ref)
989 if (macro_name `notElem` map cmdName cmds)
990 then throwDyn (CmdLineError
991 ("macro '" ++ macro_name ++ "' is not defined"))
993 io (writeIORef macros_ref (filter ((/= macro_name) . cmdName) cmds))
995 cmdCmd :: String -> GHCi ()
997 let expr = '(' : str ++ ") :: IO String"
998 session <- getSession
999 maybe_hv <- io (GHC.compileExpr session expr)
1001 Nothing -> return ()
1003 cmds <- io $ (unsafeCoerce# hv :: IO String)
1004 enqueueCommands (lines cmds)
1007 loadModule :: [(FilePath, Maybe Phase)] -> GHCi SuccessFlag
1008 loadModule fs = timeIt (loadModule' fs)
1010 loadModule_ :: [FilePath] -> GHCi ()
1011 loadModule_ fs = do loadModule (zip fs (repeat Nothing)); return ()
1013 loadModule' :: [(FilePath, Maybe Phase)] -> GHCi SuccessFlag
1014 loadModule' files = do
1015 session <- getSession
1016 prev_context <- io $ GHC.getContext session
1019 discardActiveBreakPoints
1020 io (GHC.setTargets session [])
1021 io (GHC.load session LoadAllTargets)
1024 let (filenames, phases) = unzip files
1025 exp_filenames <- mapM expandPath filenames
1026 let files' = zip exp_filenames phases
1027 targets <- io (mapM (uncurry GHC.guessTarget) files')
1029 -- NOTE: we used to do the dependency anal first, so that if it
1030 -- fails we didn't throw away the current set of modules. This would
1031 -- require some re-working of the GHC interface, so we'll leave it
1032 -- as a ToDo for now.
1034 io (GHC.setTargets session targets)
1035 doLoad session False prev_context LoadAllTargets
1037 checkModule :: String -> GHCi ()
1039 let modl = GHC.mkModuleName m
1040 session <- getSession
1041 prev_context <- io $ GHC.getContext session
1042 result <- io (GHC.checkModule session modl False)
1044 Nothing -> io $ putStrLn "Nothing"
1045 Just r -> io $ putStrLn (showSDoc (
1046 case GHC.checkedModuleInfo r of
1047 Just cm | Just scope <- GHC.modInfoTopLevelScope cm ->
1049 (local,global) = partition ((== modl) . GHC.moduleName . GHC.nameModule) scope
1051 (text "global names: " <+> ppr global) $$
1052 (text "local names: " <+> ppr local)
1054 afterLoad (successIf (isJust result)) session False prev_context
1056 reloadModule :: String -> GHCi ()
1058 session <- getSession
1059 prev_context <- io $ GHC.getContext session
1060 doLoad session True prev_context $
1061 if null m then LoadAllTargets
1062 else LoadUpTo (GHC.mkModuleName m)
1065 doLoad :: Session -> Bool -> ([Module],[Module]) -> LoadHowMuch -> GHCi SuccessFlag
1066 doLoad session retain_context prev_context howmuch = do
1067 -- turn off breakpoints before we load: we can't turn them off later, because
1068 -- the ModBreaks will have gone away.
1069 discardActiveBreakPoints
1070 ok <- io (GHC.load session howmuch)
1071 afterLoad ok session retain_context prev_context
1074 afterLoad :: SuccessFlag -> Session -> Bool -> ([Module],[Module]) -> GHCi ()
1075 afterLoad ok session retain_context prev_context = do
1076 io (revertCAFs) -- always revert CAFs on load.
1078 loaded_mod_summaries <- getLoadedModules session
1079 let loaded_mods = map GHC.ms_mod loaded_mod_summaries
1080 loaded_mod_names = map GHC.moduleName loaded_mods
1081 modulesLoadedMsg ok loaded_mod_names
1083 setContextAfterLoad session prev_context retain_context loaded_mod_summaries
1086 setContextAfterLoad :: Session -> ([Module],[Module]) -> Bool -> [GHC.ModSummary] -> GHCi ()
1087 setContextAfterLoad session prev keep_ctxt [] = do
1088 prel_mod <- getPrelude
1089 setContextKeepingPackageModules session prev keep_ctxt ([], [prel_mod])
1090 setContextAfterLoad session prev keep_ctxt ms = do
1091 -- load a target if one is available, otherwise load the topmost module.
1092 targets <- io (GHC.getTargets session)
1093 case [ m | Just m <- map (findTarget ms) targets ] of
1095 let graph' = flattenSCCs (GHC.topSortModuleGraph True ms Nothing) in
1096 load_this (last graph')
1101 = case filter (`matches` t) ms of
1105 summary `matches` Target (TargetModule m) _
1106 = GHC.ms_mod_name summary == m
1107 summary `matches` Target (TargetFile f _) _
1108 | Just f' <- GHC.ml_hs_file (GHC.ms_location summary) = f == f'
1112 load_this summary | m <- GHC.ms_mod summary = do
1113 b <- io (GHC.moduleIsInterpreted session m)
1114 if b then setContextKeepingPackageModules session prev keep_ctxt ([m], [])
1116 prel_mod <- getPrelude
1117 setContextKeepingPackageModules session prev keep_ctxt ([],[prel_mod,m])
1119 -- | Keep any package modules (except Prelude) when changing the context.
1120 setContextKeepingPackageModules
1122 -> ([Module],[Module]) -- previous context
1123 -> Bool -- re-execute :module commands
1124 -> ([Module],[Module]) -- new context
1126 setContextKeepingPackageModules session prev_context keep_ctxt (as,bs) = do
1127 let (_,bs0) = prev_context
1128 prel_mod <- getPrelude
1129 let pkg_modules = filter (\p -> not (isHomeModule p) && p /= prel_mod) bs0
1130 let bs1 = if null as then nub (prel_mod : bs) else bs
1131 io $ GHC.setContext session as (nub (bs1 ++ pkg_modules))
1135 mapM_ (playCtxtCmd False) (remembered_ctx st)
1138 setGHCiState st{ remembered_ctx = [] }
1140 isHomeModule :: Module -> Bool
1141 isHomeModule mod = GHC.modulePackageId mod == mainPackageId
1143 modulesLoadedMsg :: SuccessFlag -> [ModuleName] -> GHCi ()
1144 modulesLoadedMsg ok mods = do
1145 dflags <- getDynFlags
1146 when (verbosity dflags > 0) $ do
1148 | null mods = text "none."
1149 | otherwise = hsep (
1150 punctuate comma (map ppr mods)) <> text "."
1153 io (putStrLn (showSDoc (text "Failed, modules loaded: " <> mod_commas)))
1155 io (putStrLn (showSDoc (text "Ok, modules loaded: " <> mod_commas)))
1158 typeOfExpr :: String -> GHCi ()
1160 = do cms <- getSession
1161 maybe_ty <- io (GHC.exprType cms str)
1163 Nothing -> return ()
1164 Just ty -> do dflags <- getDynFlags
1165 let pefas = dopt Opt_PrintExplicitForalls dflags
1166 printForUser $ text str <+> dcolon
1167 <+> pprTypeForUser pefas ty
1169 kindOfType :: String -> GHCi ()
1171 = do cms <- getSession
1172 maybe_ty <- io (GHC.typeKind cms str)
1174 Nothing -> return ()
1175 Just ty -> printForUser $ text str <+> dcolon <+> ppr ty
1177 quit :: String -> GHCi Bool
1178 quit _ = return True
1180 shellEscape :: String -> GHCi Bool
1181 shellEscape str = io (system str >> return False)
1183 -----------------------------------------------------------------------------
1184 -- Browsing a module's contents
1186 browseCmd :: Bool -> String -> GHCi ()
1189 ['*':s] | looksLikeModuleName s -> do
1190 m <- wantInterpretedModule s
1191 browseModule bang m False
1192 [s] | looksLikeModuleName s -> do
1194 browseModule bang m True
1197 (as,bs) <- io $ GHC.getContext s
1198 -- Guess which module the user wants to browse. Pick
1199 -- modules that are interpreted first. The most
1200 -- recently-added module occurs last, it seems.
1202 (as@(_:_), _) -> browseModule bang (last as) True
1203 ([], bs@(_:_)) -> browseModule bang (last bs) True
1204 ([], []) -> throwDyn (CmdLineError ":browse: no current module")
1205 _ -> throwDyn (CmdLineError "syntax: :browse <module>")
1207 -- without bang, show items in context of their parents and omit children
1208 -- with bang, show class methods and data constructors separately, and
1209 -- indicate import modules, to aid qualifying unqualified names
1210 -- with sorted, sort items alphabetically
1211 browseModule :: Bool -> Module -> Bool -> GHCi ()
1212 browseModule bang modl exports_only = do
1214 -- :browse! reports qualifiers wrt current context
1215 current_unqual <- io (GHC.getPrintUnqual s)
1216 -- Temporarily set the context to the module we're interested in,
1217 -- just so we can get an appropriate PrintUnqualified
1218 (as,bs) <- io (GHC.getContext s)
1219 prel_mod <- getPrelude
1220 io (if exports_only then GHC.setContext s [] [prel_mod,modl]
1221 else GHC.setContext s [modl] [])
1222 target_unqual <- io (GHC.getPrintUnqual s)
1223 io (GHC.setContext s as bs)
1225 let unqual = if bang then current_unqual else target_unqual
1227 mb_mod_info <- io $ GHC.getModuleInfo s modl
1229 Nothing -> throwDyn (CmdLineError ("unknown module: " ++
1230 GHC.moduleNameString (GHC.moduleName modl)))
1232 dflags <- getDynFlags
1234 | exports_only = GHC.modInfoExports mod_info
1235 | otherwise = GHC.modInfoTopLevelScope mod_info
1238 -- sort alphabetically name, but putting
1239 -- locally-defined identifiers first.
1240 -- We would like to improve this; see #1799.
1241 sorted_names = loc_sort local ++ occ_sort external
1243 (local,external) = partition ((==modl) . nameModule) names
1244 occ_sort = sortBy (compare `on` nameOccName)
1245 -- try to sort by src location. If the first name in
1246 -- our list has a good source location, then they all should.
1248 | n:_ <- names, isGoodSrcSpan (nameSrcSpan n)
1249 = sortBy (compare `on` nameSrcSpan) names
1253 mb_things <- io $ mapM (GHC.lookupName s) sorted_names
1254 let filtered_things = filterOutChildren (\t -> t) (catMaybes mb_things)
1256 rdr_env <- io $ GHC.getGRE s
1258 let pefas = dopt Opt_PrintExplicitForalls dflags
1259 things | bang = catMaybes mb_things
1260 | otherwise = filtered_things
1261 pretty | bang = pprTyThing
1262 | otherwise = pprTyThingInContext
1264 labels [] = text "-- not currently imported"
1265 labels l = text $ intercalate "\n" $ map qualifier l
1266 qualifier = maybe "-- defined locally"
1267 (("-- imported via "++) . intercalate ", "
1268 . map GHC.moduleNameString)
1269 importInfo = RdrName.getGRE_NameQualifier_maybes rdr_env
1270 modNames = map (importInfo . GHC.getName) things
1272 -- annotate groups of imports with their import modules
1273 -- the default ordering is somewhat arbitrary, so we group
1274 -- by header and sort groups; the names themselves should
1275 -- really come in order of source appearance.. (trac #1799)
1276 annotate mts = concatMap (\(m,ts)->labels m:ts)
1277 $ sortBy cmpQualifiers $ group mts
1278 where cmpQualifiers =
1279 compare `on` (map (fmap (map moduleNameFS)) . fst)
1281 group mts@((m,_):_) = (m,map snd g) : group ng
1282 where (g,ng) = partition ((==m).fst) mts
1284 let prettyThings = map (pretty pefas) things
1285 prettyThings' | bang = annotate $ zip modNames prettyThings
1286 | otherwise = prettyThings
1287 io (putStrLn $ showSDocForUser unqual (vcat prettyThings'))
1288 -- ToDo: modInfoInstances currently throws an exception for
1289 -- package modules. When it works, we can do this:
1290 -- $$ vcat (map GHC.pprInstance (GHC.modInfoInstances mod_info))
1292 -----------------------------------------------------------------------------
1293 -- Setting the module context
1295 setContext :: String -> GHCi ()
1297 | all sensible strs = do
1298 playCtxtCmd True (cmd, as, bs)
1300 setGHCiState st{ remembered_ctx = remembered_ctx st ++ [(cmd,as,bs)] }
1301 | otherwise = throwDyn (CmdLineError "syntax: :module [+/-] [*]M1 ... [*]Mn")
1303 (cmd, strs, as, bs) =
1305 '+':stuff -> rest AddModules stuff
1306 '-':stuff -> rest RemModules stuff
1307 stuff -> rest SetContext stuff
1309 rest cmd stuff = (cmd, strs, as, bs)
1310 where strs = words stuff
1311 (as,bs) = partitionWith starred strs
1313 sensible ('*':m) = looksLikeModuleName m
1314 sensible m = looksLikeModuleName m
1316 starred ('*':m) = Left m
1319 playCtxtCmd :: Bool -> (CtxtCmd, [String], [String]) -> GHCi ()
1320 playCtxtCmd fail (cmd, as, bs)
1323 (as',bs') <- do_checks fail
1324 (prev_as,prev_bs) <- io $ GHC.getContext s
1328 prel_mod <- getPrelude
1329 let bs'' = if null as && prel_mod `notElem` bs' then prel_mod:bs'
1333 let as_to_add = as' \\ (prev_as ++ prev_bs)
1334 bs_to_add = bs' \\ (prev_as ++ prev_bs)
1335 return (prev_as ++ as_to_add, prev_bs ++ bs_to_add)
1337 let new_as = prev_as \\ (as' ++ bs')
1338 new_bs = prev_bs \\ (as' ++ bs')
1339 return (new_as, new_bs)
1340 io $ GHC.setContext s new_as new_bs
1343 as' <- mapM wantInterpretedModule as
1344 bs' <- mapM lookupModule bs
1346 do_checks False = do
1347 as' <- mapM (trymaybe . wantInterpretedModule) as
1348 bs' <- mapM (trymaybe . lookupModule) bs
1349 return (catMaybes as', catMaybes bs')
1354 Left _ -> return Nothing
1355 Right a -> return (Just a)
1357 ----------------------------------------------------------------------------
1360 -- set options in the interpreter. Syntax is exactly the same as the
1361 -- ghc command line, except that certain options aren't available (-C,
1364 -- This is pretty fragile: most options won't work as expected. ToDo:
1365 -- figure out which ones & disallow them.
1367 setCmd :: String -> GHCi ()
1369 = do st <- getGHCiState
1370 let opts = options st
1371 io $ putStrLn (showSDoc (
1372 text "options currently set: " <>
1375 else hsep (map (\o -> char '+' <> text (optToStr o)) opts)
1377 dflags <- getDynFlags
1378 io $ putStrLn (showSDoc (
1379 vcat (text "GHCi-specific dynamic flag settings:"
1380 :map (flagSetting dflags) ghciFlags)
1382 io $ putStrLn (showSDoc (
1383 vcat (text "other dynamic, non-language, flag settings:"
1384 :map (flagSetting dflags) nonLanguageDynFlags)
1386 where flagSetting dflags (str,f)
1387 | dopt f dflags = text " " <> text "-f" <> text str
1388 | otherwise = text " " <> text "-fno-" <> text str
1389 (ghciFlags,others) = partition (\(_,f)->f `elem` flags)
1391 nonLanguageDynFlags = filter (\(_,f)->not $ f `elem` map snd xFlags)
1393 flags = [Opt_PrintExplicitForalls
1394 ,Opt_PrintBindResult
1395 ,Opt_BreakOnException
1397 ,Opt_PrintEvldWithShow
1400 = case getCmd str of
1401 Right ("args", rest) ->
1403 Left err -> io (hPutStrLn stderr err)
1404 Right args -> setArgs args
1405 Right ("prog", rest) ->
1407 Right [prog] -> setProg prog
1408 _ -> io (hPutStrLn stderr "syntax: :set prog <progname>")
1409 Right ("prompt", rest) -> setPrompt $ dropWhile isSpace rest
1410 Right ("editor", rest) -> setEditor $ dropWhile isSpace rest
1411 Right ("stop", rest) -> setStop $ dropWhile isSpace rest
1412 _ -> case toArgs str of
1413 Left err -> io (hPutStrLn stderr err)
1414 Right wds -> setOptions wds
1416 setArgs, setOptions :: [String] -> GHCi ()
1417 setProg, setEditor, setStop, setPrompt :: String -> GHCi ()
1421 setGHCiState st{ args = args }
1425 setGHCiState st{ progname = prog }
1429 setGHCiState st{ editor = cmd }
1431 setStop str@(c:_) | isDigit c
1432 = do let (nm_str,rest) = break (not.isDigit) str
1435 let old_breaks = breaks st
1436 if all ((/= nm) . fst) old_breaks
1437 then printForUser (text "Breakpoint" <+> ppr nm <+>
1438 text "does not exist")
1440 let new_breaks = map fn old_breaks
1441 fn (i,loc) | i == nm = (i,loc { onBreakCmd = dropWhile isSpace rest })
1442 | otherwise = (i,loc)
1443 setGHCiState st{ breaks = new_breaks }
1446 setGHCiState st{ stop = cmd }
1448 setPrompt value = do
1451 then io $ hPutStrLn stderr $ "syntax: :set prompt <prompt>, currently \"" ++ prompt st ++ "\""
1452 else setGHCiState st{ prompt = remQuotes value }
1454 remQuotes ('\"':xs) | not (null xs) && last xs == '\"' = init xs
1458 do -- first, deal with the GHCi opts (+s, +t, etc.)
1459 let (plus_opts, minus_opts) = partitionWith isPlus wds
1460 mapM_ setOpt plus_opts
1461 -- then, dynamic flags
1462 newDynFlags minus_opts
1464 newDynFlags :: [String] -> GHCi ()
1465 newDynFlags minus_opts = do
1466 dflags <- getDynFlags
1467 let pkg_flags = packageFlags dflags
1468 (dflags',leftovers) <- io $ GHC.parseDynamicFlags dflags minus_opts
1470 if (not (null leftovers))
1471 then throwDyn (CmdLineError ("unrecognised flags: " ++
1475 new_pkgs <- setDynFlags dflags'
1477 -- if the package flags changed, we should reset the context
1478 -- and link the new packages.
1479 dflags <- getDynFlags
1480 when (packageFlags dflags /= pkg_flags) $ do
1481 io $ hPutStrLn stderr "package flags have changed, ressetting and loading new packages..."
1482 session <- getSession
1483 io (GHC.setTargets session [])
1484 io (GHC.load session LoadAllTargets)
1485 io (linkPackages dflags new_pkgs)
1486 -- package flags changed, we can't re-use any of the old context
1487 setContextAfterLoad session ([],[]) False []
1491 unsetOptions :: String -> GHCi ()
1493 = do -- first, deal with the GHCi opts (+s, +t, etc.)
1494 let opts = words str
1495 (minus_opts, rest1) = partition isMinus opts
1496 (plus_opts, rest2) = partitionWith isPlus rest1
1498 if (not (null rest2))
1499 then io (putStrLn ("unknown option: '" ++ head rest2 ++ "'"))
1502 mapM_ unsetOpt plus_opts
1504 let no_flag ('-':'f':rest) = return ("-fno-" ++ rest)
1505 no_flag f = throwDyn (ProgramError ("don't know how to reverse " ++ f))
1507 no_flags <- mapM no_flag minus_opts
1508 newDynFlags no_flags
1510 isMinus :: String -> Bool
1511 isMinus ('-':_) = True
1514 isPlus :: String -> Either String String
1515 isPlus ('+':opt) = Left opt
1516 isPlus other = Right other
1518 setOpt, unsetOpt :: String -> GHCi ()
1521 = case strToGHCiOpt str of
1522 Nothing -> io (putStrLn ("unknown option: '" ++ str ++ "'"))
1523 Just o -> setOption o
1526 = case strToGHCiOpt str of
1527 Nothing -> io (putStrLn ("unknown option: '" ++ str ++ "'"))
1528 Just o -> unsetOption o
1530 strToGHCiOpt :: String -> (Maybe GHCiOption)
1531 strToGHCiOpt "s" = Just ShowTiming
1532 strToGHCiOpt "t" = Just ShowType
1533 strToGHCiOpt "r" = Just RevertCAFs
1534 strToGHCiOpt _ = Nothing
1536 optToStr :: GHCiOption -> String
1537 optToStr ShowTiming = "s"
1538 optToStr ShowType = "t"
1539 optToStr RevertCAFs = "r"
1541 -- ---------------------------------------------------------------------------
1544 showCmd :: String -> GHCi ()
1548 ["args"] -> io $ putStrLn (show (args st))
1549 ["prog"] -> io $ putStrLn (show (progname st))
1550 ["prompt"] -> io $ putStrLn (show (prompt st))
1551 ["editor"] -> io $ putStrLn (show (editor st))
1552 ["stop"] -> io $ putStrLn (show (stop st))
1553 ["modules" ] -> showModules
1554 ["bindings"] -> showBindings
1555 ["linker"] -> io showLinkerState
1556 ["breaks"] -> showBkptTable
1557 ["context"] -> showContext
1558 ["packages"] -> showPackages
1559 ["languages"] -> showLanguages
1560 _ -> throwDyn (CmdLineError ("syntax: :show [ args | prog | prompt | editor | stop | modules | bindings\n"++
1561 " | breaks | context | packages | languages ]"))
1563 showModules :: GHCi ()
1565 session <- getSession
1566 loaded_mods <- getLoadedModules session
1567 -- we want *loaded* modules only, see #1734
1568 let show_one ms = do m <- io (GHC.showModule session ms); io (putStrLn m)
1569 mapM_ show_one loaded_mods
1571 getLoadedModules :: GHC.Session -> GHCi [GHC.ModSummary]
1572 getLoadedModules session = do
1573 graph <- io (GHC.getModuleGraph session)
1574 filterM (io . GHC.isLoaded session . GHC.ms_mod_name) graph
1576 showBindings :: GHCi ()
1579 bindings <- io (GHC.getBindings s)
1580 docs <- io$ pprTypeAndContents s
1581 [ id | AnId id <- sortBy compareTyThings bindings]
1582 printForUserPartWay docs
1584 compareTyThings :: TyThing -> TyThing -> Ordering
1585 t1 `compareTyThings` t2 = getName t1 `compareNames` getName t2
1587 printTyThing :: TyThing -> GHCi ()
1588 printTyThing tyth = do dflags <- getDynFlags
1589 let pefas = dopt Opt_PrintExplicitForalls dflags
1590 printForUser (pprTyThing pefas tyth)
1592 showBkptTable :: GHCi ()
1595 printForUser $ prettyLocations (breaks st)
1597 showContext :: GHCi ()
1599 session <- getSession
1600 resumes <- io $ GHC.getResumeContext session
1601 printForUser $ vcat (map pp_resume (reverse resumes))
1604 ptext SLIT("--> ") <> text (GHC.resumeStmt resume)
1605 $$ nest 2 (ptext SLIT("Stopped at") <+> ppr (GHC.resumeSpan resume))
1607 showPackages :: GHCi ()
1609 pkg_flags <- fmap packageFlags getDynFlags
1610 io $ putStrLn $ showSDoc $ vcat $
1611 text ("active package flags:"++if null pkg_flags then " none" else "")
1612 : map showFlag pkg_flags
1613 pkg_ids <- fmap (preloadPackages . pkgState) getDynFlags
1614 io $ putStrLn $ showSDoc $ vcat $
1615 text "packages currently loaded:"
1616 : map (nest 2 . text . packageIdString) pkg_ids
1617 where showFlag (ExposePackage p) = text $ " -package " ++ p
1618 showFlag (HidePackage p) = text $ " -hide-package " ++ p
1619 showFlag (IgnorePackage p) = text $ " -ignore-package " ++ p
1621 showLanguages :: GHCi ()
1623 dflags <- getDynFlags
1624 io $ putStrLn $ showSDoc $ vcat $
1625 text "active language flags:" :
1626 [text (" -X" ++ str) | (str,f) <- DynFlags.xFlags, dopt f dflags]
1628 -- -----------------------------------------------------------------------------
1631 completeNone :: String -> IO [String]
1632 completeNone _w = return []
1634 completeMacro, completeIdentifier, completeModule,
1635 completeHomeModule, completeSetOptions, completeFilename,
1636 completeHomeModuleOrFile
1637 :: String -> IO [String]
1640 completeWord :: String -> Int -> Int -> IO (Maybe (String, [String]))
1641 completeWord w start end = do
1642 line <- Readline.getLineBuffer
1643 let line_words = words (dropWhile isSpace line)
1645 ':':_ | all isSpace (take (start-1) line) -> wrapCompleter completeCmd w
1647 | ((':':c) : _) <- line_words -> do
1648 completionVars <- lookupCompletionVars c
1649 case completionVars of
1650 (Nothing,complete) -> wrapCompleter complete w
1651 (Just breakChars,complete)
1652 -> let (n,w') = selectWord
1653 (words' (`elem` breakChars) 0 line)
1654 complete' w = do rets <- complete w
1655 return (map (drop n) rets)
1656 in wrapCompleter complete' w'
1657 | ("import" : _) <- line_words ->
1658 wrapCompleter completeModule w
1660 --printf "complete %s, start = %d, end = %d\n" w start end
1661 wrapCompleter completeIdentifier w
1662 where words' _ _ [] = []
1663 words' isBreak n str = let (w,r) = break isBreak str
1664 (s,r') = span isBreak r
1665 in (n,w):words' isBreak (n+length w+length s) r'
1666 -- In a Haskell expression we want to parse 'a-b' as three words
1667 -- where a compiler flag (ie. -fno-monomorphism-restriction) should
1668 -- only be a single word.
1669 selectWord [] = (0,w)
1670 selectWord ((offset,x):xs)
1671 | offset+length x >= start = (start-offset,take (end-offset) x)
1672 | otherwise = selectWord xs
1674 lookupCompletionVars ('!':_) = return (Just filenameWordBreakChars,
1676 lookupCompletionVars c = do
1677 maybe_cmd <- lookupCommand' c
1679 Just (_,_,ws,f) -> return (ws,f)
1680 Nothing -> return (Just filenameWordBreakChars,
1684 completeCmd :: String -> IO [String]
1686 cmds <- readIORef macros_ref
1687 return (filter (w `isPrefixOf`) (map (':':)
1688 (map cmdName (builtin_commands ++ cmds))))
1690 completeMacro w = do
1691 cmds <- readIORef macros_ref
1692 return (filter (w `isPrefixOf`) (map cmdName cmds))
1694 completeIdentifier w = do
1696 rdrs <- GHC.getRdrNamesInScope s
1697 return (filter (w `isPrefixOf`) (map (showSDoc.ppr) rdrs))
1699 completeModule w = do
1701 dflags <- GHC.getSessionDynFlags s
1702 let pkg_mods = allExposedModules dflags
1703 return (filter (w `isPrefixOf`) (map (showSDoc.ppr) pkg_mods))
1705 completeHomeModule w = do
1707 g <- GHC.getModuleGraph s
1708 let home_mods = map GHC.ms_mod_name g
1709 return (filter (w `isPrefixOf`) (map (showSDoc.ppr) home_mods))
1711 completeSetOptions w = do
1712 return (filter (w `isPrefixOf`) options)
1713 where options = "args":"prog":allFlags
1715 completeFilename w = do
1716 ws <- Readline.filenameCompletionFunction w
1718 -- If we only found one result, and it's a directory,
1719 -- add a trailing slash.
1721 isDir <- expandPathIO file >>= doesDirectoryExist
1722 if isDir && last file /= '/'
1723 then return [file ++ "/"]
1728 completeHomeModuleOrFile = unionComplete completeHomeModule completeFilename
1730 unionComplete :: (String -> IO [String]) -> (String -> IO [String]) -> String -> IO [String]
1731 unionComplete f1 f2 w = do
1736 wrapCompleter :: (String -> IO [String]) -> String -> IO (Maybe (String,[String]))
1737 wrapCompleter fun w = do
1740 [] -> Readline.setAttemptedCompletionOver True >> return Nothing
1741 [x] -> -- Add a trailing space, unless it already has an appended slash.
1742 let appended = if last x == '/' then x else x ++ " "
1743 in return (Just (appended,[]))
1744 xs -> case getCommonPrefix xs of
1745 "" -> return (Just ("",xs))
1746 pref -> return (Just (pref,xs))
1748 getCommonPrefix :: [String] -> String
1749 getCommonPrefix [] = ""
1750 getCommonPrefix (s:ss) = foldl common s ss
1751 where common _s "" = ""
1753 common (c:cs) (d:ds)
1754 | c == d = c : common cs ds
1757 allExposedModules :: DynFlags -> [ModuleName]
1758 allExposedModules dflags
1759 = concat (map exposedModules (filter exposed (eltsUFM pkg_db)))
1761 pkg_db = pkgIdMap (pkgState dflags)
1763 completeMacro = completeNone
1764 completeIdentifier = completeNone
1765 completeModule = completeNone
1766 completeHomeModule = completeNone
1767 completeSetOptions = completeNone
1768 completeFilename = completeNone
1769 completeHomeModuleOrFile=completeNone
1772 -- ---------------------------------------------------------------------------
1773 -- User code exception handling
1775 -- This is the exception handler for exceptions generated by the
1776 -- user's code and exceptions coming from children sessions;
1777 -- it normally just prints out the exception. The
1778 -- handler must be recursive, in case showing the exception causes
1779 -- more exceptions to be raised.
1781 -- Bugfix: if the user closed stdout or stderr, the flushing will fail,
1782 -- raising another exception. We therefore don't put the recursive
1783 -- handler arond the flushing operation, so if stderr is closed
1784 -- GHCi will just die gracefully rather than going into an infinite loop.
1785 handler :: Exception -> GHCi Bool
1787 handler exception = do
1789 io installSignalHandlers
1790 ghciHandle handler (showException exception >> return False)
1792 showException :: Exception -> GHCi ()
1793 showException (DynException dyn) =
1794 case fromDynamic dyn of
1795 Nothing -> io (putStrLn ("*** Exception: (unknown)"))
1796 Just Interrupted -> io (putStrLn "Interrupted.")
1797 Just (CmdLineError s) -> io (putStrLn s) -- omit the location for CmdLineError
1798 Just ph@PhaseFailed{} -> io (putStrLn (showGhcException ph "")) -- ditto
1799 Just other_ghc_ex -> io (print other_ghc_ex)
1801 showException other_exception
1802 = io (putStrLn ("*** Exception: " ++ show other_exception))
1804 -----------------------------------------------------------------------------
1805 -- recursive exception handlers
1807 -- Don't forget to unblock async exceptions in the handler, or if we're
1808 -- in an exception loop (eg. let a = error a in a) the ^C exception
1809 -- may never be delivered. Thanks to Marcin for pointing out the bug.
1811 ghciHandle :: (Exception -> GHCi a) -> GHCi a -> GHCi a
1812 ghciHandle h (GHCi m) = GHCi $ \s ->
1813 Exception.catch (m s)
1814 (\e -> unGHCi (ghciUnblock (h e)) s)
1816 ghciUnblock :: GHCi a -> GHCi a
1817 ghciUnblock (GHCi a) = GHCi $ \s -> Exception.unblock (a s)
1819 ghciTry :: GHCi a -> GHCi (Either Exception a)
1820 ghciTry (GHCi m) = GHCi $ \s -> Exception.try (m s)
1822 -- ----------------------------------------------------------------------------
1825 expandPath :: String -> GHCi String
1826 expandPath path = io (expandPathIO path)
1828 expandPathIO :: String -> IO String
1830 case dropWhile isSpace path of
1832 tilde <- getHomeDirectory -- will fail if HOME not defined
1833 return (tilde ++ '/':d)
1837 wantInterpretedModule :: String -> GHCi Module
1838 wantInterpretedModule str = do
1839 session <- getSession
1840 modl <- lookupModule str
1841 is_interpreted <- io (GHC.moduleIsInterpreted session modl)
1842 when (not is_interpreted) $
1843 throwDyn (CmdLineError ("module '" ++ str ++ "' is not interpreted"))
1846 wantNameFromInterpretedModule :: (Name -> SDoc -> GHCi ()) -> String
1847 -> (Name -> GHCi ())
1849 wantNameFromInterpretedModule noCanDo str and_then = do
1850 session <- getSession
1851 names <- io $ GHC.parseName session str
1855 let modl = GHC.nameModule n
1856 if not (GHC.isExternalName n)
1857 then noCanDo n $ ppr n <>
1858 text " is not defined in an interpreted module"
1860 is_interpreted <- io (GHC.moduleIsInterpreted session modl)
1861 if not is_interpreted
1862 then noCanDo n $ text "module " <> ppr modl <>
1863 text " is not interpreted"
1866 -- -----------------------------------------------------------------------------
1867 -- commands for debugger
1869 sprintCmd, printCmd, forceCmd :: String -> GHCi ()
1870 sprintCmd = pprintCommand False False
1871 printCmd = pprintCommand True False
1872 forceCmd = pprintCommand False True
1874 pprintCommand :: Bool -> Bool -> String -> GHCi ()
1875 pprintCommand bind force str = do
1876 session <- getSession
1877 io $ pprintClosureCommand session bind force str
1879 stepCmd :: String -> GHCi ()
1880 stepCmd [] = doContinue (const True) GHC.SingleStep
1881 stepCmd expression = do runStmt expression GHC.SingleStep; return ()
1883 stepLocalCmd :: String -> GHCi ()
1884 stepLocalCmd [] = do
1885 mb_span <- getCurrentBreakSpan
1887 Nothing -> stepCmd []
1889 Just mod <- getCurrentBreakModule
1890 current_toplevel_decl <- enclosingTickSpan mod loc
1891 doContinue (`isSubspanOf` current_toplevel_decl) GHC.SingleStep
1893 stepLocalCmd expression = stepCmd expression
1895 stepModuleCmd :: String -> GHCi ()
1896 stepModuleCmd [] = do
1897 mb_span <- getCurrentBreakSpan
1899 Nothing -> stepCmd []
1901 Just span <- getCurrentBreakSpan
1902 let f some_span = optSrcSpanFileName span == optSrcSpanFileName some_span
1903 doContinue f GHC.SingleStep
1905 stepModuleCmd expression = stepCmd expression
1907 -- | Returns the span of the largest tick containing the srcspan given
1908 enclosingTickSpan :: Module -> SrcSpan -> GHCi SrcSpan
1909 enclosingTickSpan mod src = do
1910 ticks <- getTickArray mod
1911 let line = srcSpanStartLine src
1912 ASSERT (inRange (bounds ticks) line) do
1913 let enclosing_spans = [ span | (_,span) <- ticks ! line
1914 , srcSpanEnd span >= srcSpanEnd src]
1915 return . head . sortBy leftmost_largest $ enclosing_spans
1917 traceCmd :: String -> GHCi ()
1918 traceCmd [] = doContinue (const True) GHC.RunAndLogSteps
1919 traceCmd expression = do runStmt expression GHC.RunAndLogSteps; return ()
1921 continueCmd :: String -> GHCi ()
1922 continueCmd = noArgs $ doContinue (const True) GHC.RunToCompletion
1924 -- doContinue :: SingleStep -> GHCi ()
1925 doContinue :: (SrcSpan -> Bool) -> SingleStep -> GHCi ()
1926 doContinue pred step = do
1927 session <- getSession
1928 runResult <- io $ GHC.resume session step
1929 afterRunStmt pred runResult
1932 abandonCmd :: String -> GHCi ()
1933 abandonCmd = noArgs $ do
1935 b <- io $ GHC.abandon s -- the prompt will change to indicate the new context
1936 when (not b) $ io $ putStrLn "There is no computation running."
1939 deleteCmd :: String -> GHCi ()
1940 deleteCmd argLine = do
1941 deleteSwitch $ words argLine
1943 deleteSwitch :: [String] -> GHCi ()
1945 io $ putStrLn "The delete command requires at least one argument."
1946 -- delete all break points
1947 deleteSwitch ("*":_rest) = discardActiveBreakPoints
1948 deleteSwitch idents = do
1949 mapM_ deleteOneBreak idents
1951 deleteOneBreak :: String -> GHCi ()
1953 | all isDigit str = deleteBreak (read str)
1954 | otherwise = return ()
1956 historyCmd :: String -> GHCi ()
1958 | null arg = history 20
1959 | all isDigit arg = history (read arg)
1960 | otherwise = io $ putStrLn "Syntax: :history [num]"
1964 resumes <- io $ GHC.getResumeContext s
1966 [] -> io $ putStrLn "Not stopped at a breakpoint"
1968 let hist = GHC.resumeHistory r
1969 (took,rest) = splitAt num hist
1971 [] -> io $ putStrLn $
1972 "Empty history. Perhaps you forgot to use :trace?"
1974 spans <- mapM (io . GHC.getHistorySpan s) took
1975 let nums = map (printf "-%-3d:") [(1::Int)..]
1976 names = map GHC.historyEnclosingDecl took
1977 printForUser (vcat(zipWith3
1978 (\x y z -> x <+> y <+> z)
1980 (map (bold . ppr) names)
1981 (map (parens . ppr) spans)))
1982 io $ putStrLn $ if null rest then "<end of history>" else "..."
1984 bold :: SDoc -> SDoc
1985 bold c | do_bold = text start_bold <> c <> text end_bold
1988 backCmd :: String -> GHCi ()
1989 backCmd = noArgs $ do
1991 (names, _, span) <- io $ GHC.back s
1992 printForUser $ ptext SLIT("Logged breakpoint at") <+> ppr span
1993 printTypeOfNames s names
1994 -- run the command set with ":set stop <cmd>"
1996 enqueueCommands [stop st]
1998 forwardCmd :: String -> GHCi ()
1999 forwardCmd = noArgs $ do
2001 (names, ix, span) <- io $ GHC.forward s
2002 printForUser $ (if (ix == 0)
2003 then ptext SLIT("Stopped at")
2004 else ptext SLIT("Logged breakpoint at")) <+> ppr span
2005 printTypeOfNames s names
2006 -- run the command set with ":set stop <cmd>"
2008 enqueueCommands [stop st]
2010 -- handle the "break" command
2011 breakCmd :: String -> GHCi ()
2012 breakCmd argLine = do
2013 session <- getSession
2014 breakSwitch session $ words argLine
2016 breakSwitch :: Session -> [String] -> GHCi ()
2017 breakSwitch _session [] = do
2018 io $ putStrLn "The break command requires at least one argument."
2019 breakSwitch session (arg1:rest)
2020 | looksLikeModuleName arg1 = do
2021 mod <- wantInterpretedModule arg1
2022 breakByModule mod rest
2023 | all isDigit arg1 = do
2024 (toplevel, _) <- io $ GHC.getContext session
2026 (mod : _) -> breakByModuleLine mod (read arg1) rest
2028 io $ putStrLn "Cannot find default module for breakpoint."
2029 io $ putStrLn "Perhaps no modules are loaded for debugging?"
2030 | otherwise = do -- try parsing it as an identifier
2031 wantNameFromInterpretedModule noCanDo arg1 $ \name -> do
2032 let loc = GHC.srcSpanStart (GHC.nameSrcSpan name)
2033 if GHC.isGoodSrcLoc loc
2034 then findBreakAndSet (GHC.nameModule name) $
2035 findBreakByCoord (Just (GHC.srcLocFile loc))
2036 (GHC.srcLocLine loc,
2038 else noCanDo name $ text "can't find its location: " <> ppr loc
2040 noCanDo n why = printForUser $
2041 text "cannot set breakpoint on " <> ppr n <> text ": " <> why
2043 breakByModule :: Module -> [String] -> GHCi ()
2044 breakByModule mod (arg1:rest)
2045 | all isDigit arg1 = do -- looks like a line number
2046 breakByModuleLine mod (read arg1) rest
2050 breakByModuleLine :: Module -> Int -> [String] -> GHCi ()
2051 breakByModuleLine mod line args
2052 | [] <- args = findBreakAndSet mod $ findBreakByLine line
2053 | [col] <- args, all isDigit col =
2054 findBreakAndSet mod $ findBreakByCoord Nothing (line, read col)
2055 | otherwise = breakSyntax
2058 breakSyntax = throwDyn (CmdLineError "Syntax: :break [<mod>] <line> [<column>]")
2060 findBreakAndSet :: Module -> (TickArray -> Maybe (Int, SrcSpan)) -> GHCi ()
2061 findBreakAndSet mod lookupTickTree = do
2062 tickArray <- getTickArray mod
2063 (breakArray, _) <- getModBreak mod
2064 case lookupTickTree tickArray of
2065 Nothing -> io $ putStrLn $ "No breakpoints found at that location."
2066 Just (tick, span) -> do
2067 success <- io $ setBreakFlag True breakArray tick
2071 recordBreak $ BreakLocation
2078 text "Breakpoint " <> ppr nm <>
2080 then text " was already set at " <> ppr span
2081 else text " activated at " <> ppr span
2083 printForUser $ text "Breakpoint could not be activated at"
2086 -- When a line number is specified, the current policy for choosing
2087 -- the best breakpoint is this:
2088 -- - the leftmost complete subexpression on the specified line, or
2089 -- - the leftmost subexpression starting on the specified line, or
2090 -- - the rightmost subexpression enclosing the specified line
2092 findBreakByLine :: Int -> TickArray -> Maybe (BreakIndex,SrcSpan)
2093 findBreakByLine line arr
2094 | not (inRange (bounds arr) line) = Nothing
2096 listToMaybe (sortBy (leftmost_largest `on` snd) complete) `mplus`
2097 listToMaybe (sortBy (leftmost_smallest `on` snd) incomplete) `mplus`
2098 listToMaybe (sortBy (rightmost `on` snd) ticks)
2102 starts_here = [ tick | tick@(_,span) <- ticks,
2103 GHC.srcSpanStartLine span == line ]
2105 (complete,incomplete) = partition ends_here starts_here
2106 where ends_here (_,span) = GHC.srcSpanEndLine span == line
2108 findBreakByCoord :: Maybe FastString -> (Int,Int) -> TickArray
2109 -> Maybe (BreakIndex,SrcSpan)
2110 findBreakByCoord mb_file (line, col) arr
2111 | not (inRange (bounds arr) line) = Nothing
2113 listToMaybe (sortBy (rightmost `on` snd) contains ++
2114 sortBy (leftmost_smallest `on` snd) after_here)
2118 -- the ticks that span this coordinate
2119 contains = [ tick | tick@(_,span) <- ticks, span `spans` (line,col),
2120 is_correct_file span ]
2122 is_correct_file span
2123 | Just f <- mb_file = GHC.srcSpanFile span == f
2126 after_here = [ tick | tick@(_,span) <- ticks,
2127 GHC.srcSpanStartLine span == line,
2128 GHC.srcSpanStartCol span >= col ]
2130 -- For now, use ANSI bold on terminals that we know support it.
2131 -- Otherwise, we add a line of carets under the active expression instead.
2132 -- In particular, on Windows and when running the testsuite (which sets
2133 -- TERM to vt100 for other reasons) we get carets.
2134 -- We really ought to use a proper termcap/terminfo library.
2136 do_bold = (`isPrefixOf` unsafePerformIO mTerm) `any` ["xterm", "linux"]
2137 where mTerm = System.Environment.getEnv "TERM"
2138 `Exception.catch` \_ -> return "TERM not set"
2140 start_bold :: String
2141 start_bold = "\ESC[1m"
2143 end_bold = "\ESC[0m"
2145 listCmd :: String -> GHCi ()
2147 mb_span <- getCurrentBreakSpan
2150 printForUser $ text "Not stopped at a breakpoint; nothing to list"
2152 | GHC.isGoodSrcSpan span -> io $ listAround span True
2155 resumes <- io $ GHC.getResumeContext s
2157 [] -> panic "No resumes"
2159 do let traceIt = case GHC.resumeHistory r of
2160 [] -> text "rerunning with :trace,"
2162 doWhat = traceIt <+> text ":back then :list"
2163 printForUser (text "Unable to list source for" <+>
2165 $$ text "Try" <+> doWhat)
2166 listCmd str = list2 (words str)
2168 list2 :: [String] -> GHCi ()
2169 list2 [arg] | all isDigit arg = do
2170 session <- getSession
2171 (toplevel, _) <- io $ GHC.getContext session
2173 [] -> io $ putStrLn "No module to list"
2174 (mod : _) -> listModuleLine mod (read arg)
2175 list2 [arg1,arg2] | looksLikeModuleName arg1, all isDigit arg2 = do
2176 mod <- wantInterpretedModule arg1
2177 listModuleLine mod (read arg2)
2179 wantNameFromInterpretedModule noCanDo arg $ \name -> do
2180 let loc = GHC.srcSpanStart (GHC.nameSrcSpan name)
2181 if GHC.isGoodSrcLoc loc
2183 tickArray <- getTickArray (GHC.nameModule name)
2184 let mb_span = findBreakByCoord (Just (GHC.srcLocFile loc))
2185 (GHC.srcLocLine loc, GHC.srcLocCol loc)
2188 Nothing -> io $ listAround (GHC.srcLocSpan loc) False
2189 Just (_,span) -> io $ listAround span False
2191 noCanDo name $ text "can't find its location: " <>
2194 noCanDo n why = printForUser $
2195 text "cannot list source code for " <> ppr n <> text ": " <> why
2197 io $ putStrLn "syntax: :list [<line> | <module> <line> | <identifier>]"
2199 listModuleLine :: Module -> Int -> GHCi ()
2200 listModuleLine modl line = do
2201 session <- getSession
2202 graph <- io (GHC.getModuleGraph session)
2203 let this = filter ((== modl) . GHC.ms_mod) graph
2205 [] -> panic "listModuleLine"
2207 let filename = fromJust (ml_hs_file (GHC.ms_location summ))
2208 loc = GHC.mkSrcLoc (mkFastString (filename)) line 0
2209 io $ listAround (GHC.srcLocSpan loc) False
2211 -- | list a section of a source file around a particular SrcSpan.
2212 -- If the highlight flag is True, also highlight the span using
2213 -- start_bold/end_bold.
2214 listAround :: SrcSpan -> Bool -> IO ()
2215 listAround span do_highlight = do
2216 contents <- BS.readFile (unpackFS file)
2218 lines = BS.split '\n' contents
2219 these_lines = take (line2 - line1 + 1 + pad_before + pad_after) $
2220 drop (line1 - 1 - pad_before) $ lines
2221 fst_line = max 1 (line1 - pad_before)
2222 line_nos = [ fst_line .. ]
2224 highlighted | do_highlight = zipWith highlight line_nos these_lines
2225 | otherwise = [\p -> BS.concat[p,l] | l <- these_lines]
2227 bs_line_nos = [ BS.pack (show l ++ " ") | l <- line_nos ]
2228 prefixed = zipWith ($) highlighted bs_line_nos
2230 BS.putStrLn (BS.intercalate (BS.pack "\n") prefixed)
2232 file = GHC.srcSpanFile span
2233 line1 = GHC.srcSpanStartLine span
2234 col1 = GHC.srcSpanStartCol span
2235 line2 = GHC.srcSpanEndLine span
2236 col2 = GHC.srcSpanEndCol span
2238 pad_before | line1 == 1 = 0
2242 highlight | do_bold = highlight_bold
2243 | otherwise = highlight_carets
2245 highlight_bold no line prefix
2246 | no == line1 && no == line2
2247 = let (a,r) = BS.splitAt col1 line
2248 (b,c) = BS.splitAt (col2-col1) r
2250 BS.concat [prefix, a,BS.pack start_bold,b,BS.pack end_bold,c]
2252 = let (a,b) = BS.splitAt col1 line in
2253 BS.concat [prefix, a, BS.pack start_bold, b]
2255 = let (a,b) = BS.splitAt col2 line in
2256 BS.concat [prefix, a, BS.pack end_bold, b]
2257 | otherwise = BS.concat [prefix, line]
2259 highlight_carets no line prefix
2260 | no == line1 && no == line2
2261 = BS.concat [prefix, line, nl, indent, BS.replicate col1 ' ',
2262 BS.replicate (col2-col1) '^']
2264 = BS.concat [indent, BS.replicate (col1 - 2) ' ', BS.pack "vv", nl,
2267 = BS.concat [prefix, line, nl, indent, BS.replicate col2 ' ',
2269 | otherwise = BS.concat [prefix, line]
2271 indent = BS.pack (" " ++ replicate (length (show no)) ' ')
2272 nl = BS.singleton '\n'
2274 -- --------------------------------------------------------------------------
2277 getTickArray :: Module -> GHCi TickArray
2278 getTickArray modl = do
2280 let arrmap = tickarrays st
2281 case lookupModuleEnv arrmap modl of
2282 Just arr -> return arr
2284 (_breakArray, ticks) <- getModBreak modl
2285 let arr = mkTickArray (assocs ticks)
2286 setGHCiState st{tickarrays = extendModuleEnv arrmap modl arr}
2289 discardTickArrays :: GHCi ()
2290 discardTickArrays = do
2292 setGHCiState st{tickarrays = emptyModuleEnv}
2294 mkTickArray :: [(BreakIndex,SrcSpan)] -> TickArray
2296 = accumArray (flip (:)) [] (1, max_line)
2297 [ (line, (nm,span)) | (nm,span) <- ticks,
2298 line <- srcSpanLines span ]
2300 max_line = foldr max 0 (map GHC.srcSpanEndLine (map snd ticks))
2301 srcSpanLines span = [ GHC.srcSpanStartLine span ..
2302 GHC.srcSpanEndLine span ]
2304 lookupModule :: String -> GHCi Module
2305 lookupModule modName
2306 = do session <- getSession
2307 io (GHC.findModule session (GHC.mkModuleName modName) Nothing)
2309 -- don't reset the counter back to zero?
2310 discardActiveBreakPoints :: GHCi ()
2311 discardActiveBreakPoints = do
2313 mapM (turnOffBreak.snd) (breaks st)
2314 setGHCiState $ st { breaks = [] }
2316 deleteBreak :: Int -> GHCi ()
2317 deleteBreak identity = do
2319 let oldLocations = breaks st
2320 (this,rest) = partition (\loc -> fst loc == identity) oldLocations
2322 then printForUser (text "Breakpoint" <+> ppr identity <+>
2323 text "does not exist")
2325 mapM (turnOffBreak.snd) this
2326 setGHCiState $ st { breaks = rest }
2328 turnOffBreak :: BreakLocation -> GHCi Bool
2329 turnOffBreak loc = do
2330 (arr, _) <- getModBreak (breakModule loc)
2331 io $ setBreakFlag False arr (breakTick loc)
2333 getModBreak :: Module -> GHCi (GHC.BreakArray, Array Int SrcSpan)
2334 getModBreak mod = do
2335 session <- getSession
2336 Just mod_info <- io $ GHC.getModuleInfo session mod
2337 let modBreaks = GHC.modInfoModBreaks mod_info
2338 let array = GHC.modBreaks_flags modBreaks
2339 let ticks = GHC.modBreaks_locs modBreaks
2340 return (array, ticks)
2342 setBreakFlag :: Bool -> GHC.BreakArray -> Int -> IO Bool
2343 setBreakFlag toggle array index
2344 | toggle = GHC.setBreakOn array index
2345 | otherwise = GHC.setBreakOff array index