1 {-# OPTIONS -fno-cse #-}
2 -- -fno-cse is needed for GLOBAL_VAR's to behave properly
4 {-# OPTIONS -#include "Linker.h" #-}
5 -----------------------------------------------------------------------------
7 -- GHC Interactive User Interface
9 -- (c) The GHC Team 2005-2006
11 -----------------------------------------------------------------------------
13 module InteractiveUI ( interactiveUI, ghciWelcomeMsg ) where
15 #include "HsVersions.h"
17 import qualified GhciMonad
18 import GhciMonad hiding (runStmt)
23 import qualified GHC hiding (resume, runStmt)
24 import GHC ( LoadHowMuch(..), Target(..), TargetId(..),
25 Module, ModuleName, TyThing(..), Phase,
26 BreakIndex, SrcSpan, Resume, SingleStep,
27 Ghc, handleSourceError )
37 import HscTypes ( implicitTyThings, reflectGhc, reifyGhc
38 , handleFlagWarnings )
39 import qualified RdrName ( getGRE_NameQualifier_maybes ) -- should this come via GHC?
40 import Outputable hiding (printForUser, printForUserPartWay)
41 import Module -- for ModuleEnv
45 -- Other random utilities
48 import BasicTypes hiding (isTopLevel)
49 import Panic hiding (showException)
55 import Maybes ( orElse, expectJust )
58 import MonadUtils ( liftIO )
60 #ifndef mingw32_HOST_OS
61 import System.Posix hiding (getEnv)
63 import GHC.ConsoleHandler ( flushConsole )
64 import qualified System.Win32
68 import Control.Concurrent ( yield ) -- Used in readline loop
69 import System.Console.Editline.Readline as Readline
75 -- import Control.Concurrent
77 import System.FilePath
78 import qualified Data.ByteString.Char8 as BS
82 import System.Environment
83 import System.Exit ( exitWith, ExitCode(..) )
84 import System.Directory
86 import System.IO.Error as IO
89 import Control.Monad as Monad
93 import GHC.Exts ( unsafeCoerce# )
94 import GHC.IOBase ( IOErrorType(InvalidArgument) )
97 import Data.IORef ( IORef, readIORef, writeIORef )
99 -----------------------------------------------------------------------------
101 ghciWelcomeMsg :: String
102 ghciWelcomeMsg = "GHCi, version " ++ cProjectVersion ++
103 ": http://www.haskell.org/ghc/ :? for help"
105 cmdName :: Command -> String
106 cmdName (n,_,_,_) = n
108 GLOBAL_VAR(macros_ref, [], [Command])
110 builtin_commands :: [Command]
112 -- Hugs users are accustomed to :e, so make sure it doesn't overlap
113 ("?", keepGoing help, Nothing, completeNone),
114 ("add", keepGoingPaths addModule, Just filenameWordBreakChars, completeFilename),
115 ("abandon", keepGoing abandonCmd, Nothing, completeNone),
116 ("break", keepGoing breakCmd, Nothing, completeIdentifier),
117 ("back", keepGoing backCmd, Nothing, completeNone),
118 ("browse", keepGoing (browseCmd False), Nothing, completeModule),
119 ("browse!", keepGoing (browseCmd True), Nothing, completeModule),
120 ("cd", keepGoing changeDirectory, Just filenameWordBreakChars, completeFilename),
121 ("check", keepGoing checkModule, Nothing, completeHomeModule),
122 ("continue", keepGoing continueCmd, Nothing, completeNone),
123 ("cmd", keepGoing cmdCmd, Nothing, completeIdentifier),
124 ("ctags", keepGoing createCTagsFileCmd, Just filenameWordBreakChars, completeFilename),
125 ("def", keepGoing (defineMacro False), Nothing, completeIdentifier),
126 ("def!", keepGoing (defineMacro True), Nothing, completeIdentifier),
127 ("delete", keepGoing deleteCmd, Nothing, completeNone),
128 ("e", keepGoing editFile, Just filenameWordBreakChars, completeFilename),
129 ("edit", keepGoing editFile, Just filenameWordBreakChars, completeFilename),
130 ("etags", keepGoing createETagsFileCmd, Just filenameWordBreakChars, completeFilename),
131 ("force", keepGoing forceCmd, Nothing, completeIdentifier),
132 ("forward", keepGoing forwardCmd, Nothing, completeNone),
133 ("help", keepGoing help, Nothing, completeNone),
134 ("history", keepGoing historyCmd, Nothing, completeNone),
135 ("info", keepGoing info, Nothing, completeIdentifier),
136 ("kind", keepGoing kindOfType, Nothing, completeIdentifier),
137 ("load", keepGoingPaths loadModule_, Just filenameWordBreakChars, completeHomeModuleOrFile),
138 ("list", keepGoing listCmd, Nothing, completeNone),
139 ("module", keepGoing setContext, Nothing, completeModule),
140 ("main", keepGoing runMain, Nothing, completeIdentifier),
141 ("print", keepGoing printCmd, Nothing, completeIdentifier),
142 ("quit", quit, Nothing, completeNone),
143 ("reload", keepGoing reloadModule, Nothing, completeNone),
144 ("run", keepGoing runRun, Nothing, completeIdentifier),
145 ("set", keepGoing setCmd, Just flagWordBreakChars, completeSetOptions),
146 ("show", keepGoing showCmd, Nothing, completeShowOptions),
147 ("sprint", keepGoing sprintCmd, Nothing, completeIdentifier),
148 ("step", keepGoing stepCmd, Nothing, completeIdentifier),
149 ("steplocal", keepGoing stepLocalCmd, Nothing, completeIdentifier),
150 ("stepmodule",keepGoing stepModuleCmd, Nothing, completeIdentifier),
151 ("type", keepGoing typeOfExpr, Nothing, completeIdentifier),
152 ("trace", keepGoing traceCmd, Nothing, completeIdentifier),
153 ("undef", keepGoing undefineMacro, Nothing, completeMacro),
154 ("unset", keepGoing unsetOptions, Just flagWordBreakChars, completeSetOptions)
158 -- We initialize readline (in the interactiveUI function) to use
159 -- word_break_chars as the default set of completion word break characters.
160 -- This can be overridden for a particular command (for example, filename
161 -- expansion shouldn't consider '/' to be a word break) by setting the third
162 -- entry in the Command tuple above.
164 -- NOTE: in order for us to override the default correctly, any custom entry
165 -- must be a SUBSET of word_break_chars.
167 word_break_chars :: String
168 word_break_chars = let symbols = "!#$%&*+/<=>?@\\^|-~"
169 specials = "(),;[]`{}"
171 in spaces ++ specials ++ symbols
174 flagWordBreakChars, filenameWordBreakChars :: String
175 flagWordBreakChars = " \t\n"
176 filenameWordBreakChars = " \t\n\\`@$><=;|&{(" -- bash defaults
179 keepGoing :: (String -> GHCi ()) -> (String -> GHCi Bool)
180 keepGoing a str = a str >> return False
182 keepGoingPaths :: ([FilePath] -> GHCi ()) -> (String -> GHCi Bool)
184 = do case toArgs str of
185 Left err -> io (hPutStrLn stderr err)
189 shortHelpText :: String
190 shortHelpText = "use :? for help.\n"
194 " Commands available from the prompt:\n" ++
196 " <statement> evaluate/run <statement>\n" ++
197 " : repeat last command\n" ++
198 " :{\\n ..lines.. \\n:}\\n multiline command\n" ++
199 " :add [*]<module> ... add module(s) to the current target set\n" ++
200 " :browse[!] [[*]<mod>] display the names defined by module <mod>\n" ++
201 " (!: more details; *: all top-level names)\n" ++
202 " :cd <dir> change directory to <dir>\n" ++
203 " :cmd <expr> run the commands returned by <expr>::IO String\n" ++
204 " :ctags [<file>] create tags file for Vi (default: \"tags\")\n" ++
205 " :def <cmd> <expr> define a command :<cmd>\n" ++
206 " :edit <file> edit file\n" ++
207 " :edit edit last module\n" ++
208 " :etags [<file>] create tags file for Emacs (default: \"TAGS\")\n" ++
209 " :help, :? display this list of commands\n" ++
210 " :info [<name> ...] display information about the given names\n" ++
211 " :kind <type> show the kind of <type>\n" ++
212 " :load [*]<module> ... load module(s) and their dependents\n" ++
213 " :main [<arguments> ...] run the main function with the given arguments\n" ++
214 " :module [+/-] [*]<mod> ... set the context for expression evaluation\n" ++
215 " :quit exit GHCi\n" ++
216 " :reload reload the current module set\n" ++
217 " :run function [<arguments> ...] run the function with the given arguments\n" ++
218 " :type <expr> show the type of <expr>\n" ++
219 " :undef <cmd> undefine user-defined command :<cmd>\n" ++
220 " :!<command> run the shell command <command>\n" ++
222 " -- Commands for debugging:\n" ++
224 " :abandon at a breakpoint, abandon current computation\n" ++
225 " :back go back in the history (after :trace)\n" ++
226 " :break [<mod>] <l> [<col>] set a breakpoint at the specified location\n" ++
227 " :break <name> set a breakpoint on the specified function\n" ++
228 " :continue resume after a breakpoint\n" ++
229 " :delete <number> delete the specified breakpoint\n" ++
230 " :delete * delete all breakpoints\n" ++
231 " :force <expr> print <expr>, forcing unevaluated parts\n" ++
232 " :forward go forward in the history (after :back)\n" ++
233 " :history [<n>] after :trace, show the execution history\n" ++
234 " :list show the source code around current breakpoint\n" ++
235 " :list identifier show the source code for <identifier>\n" ++
236 " :list [<module>] <line> show the source code around line number <line>\n" ++
237 " :print [<name> ...] prints a value without forcing its computation\n" ++
238 " :sprint [<name> ...] simplifed version of :print\n" ++
239 " :step single-step after stopping at a breakpoint\n"++
240 " :step <expr> single-step into <expr>\n"++
241 " :steplocal single-step within the current top-level binding\n"++
242 " :stepmodule single-step restricted to the current module\n"++
243 " :trace trace after stopping at a breakpoint\n"++
244 " :trace <expr> evaluate <expr> with tracing on (see :history)\n"++
247 " -- Commands for changing settings:\n" ++
249 " :set <option> ... set options\n" ++
250 " :set args <arg> ... set the arguments returned by System.getArgs\n" ++
251 " :set prog <progname> set the value returned by System.getProgName\n" ++
252 " :set prompt <prompt> set the prompt used in GHCi\n" ++
253 " :set editor <cmd> set the command used for :edit\n" ++
254 " :set stop [<n>] <cmd> set the command to run when a breakpoint is hit\n" ++
255 " :unset <option> ... unset options\n" ++
257 " Options for ':set' and ':unset':\n" ++
259 " +r revert top-level expressions after each evaluation\n" ++
260 " +s print timing/memory stats after each evaluation\n" ++
261 " +t print type after evaluation\n" ++
262 " -<flags> most GHC command line flags can also be set here\n" ++
263 " (eg. -v2, -fglasgow-exts, etc.)\n" ++
264 " for GHCi-specific flags, see User's Guide,\n"++
265 " Flag reference, Interactive-mode options\n" ++
267 " -- Commands for displaying information:\n" ++
269 " :show bindings show the current bindings made at the prompt\n" ++
270 " :show breaks show the active breakpoints\n" ++
271 " :show context show the breakpoint context\n" ++
272 " :show modules show the currently loaded modules\n" ++
273 " :show packages show the currently active package flags\n" ++
274 " :show languages show the currently active language flags\n" ++
275 " :show <setting> show value of <setting>, which is one of\n" ++
276 " [args, prog, prompt, editor, stop]\n" ++
279 findEditor :: IO String
284 win <- System.Win32.getWindowsDirectory
285 return (win </> "notepad.exe")
290 interactiveUI :: [(FilePath, Maybe Phase)] -> Maybe [String]
292 interactiveUI srcs maybe_exprs = withTerminalReset $ do
293 -- HACK! If we happen to get into an infinite loop (eg the user
294 -- types 'let x=x in x' at the prompt), then the thread will block
295 -- on a blackhole, and become unreachable during GC. The GC will
296 -- detect that it is unreachable and send it the NonTermination
297 -- exception. However, since the thread is unreachable, everything
298 -- it refers to might be finalized, including the standard Handles.
299 -- This sounds like a bug, but we don't have a good solution right
301 liftIO $ newStablePtr stdin
302 liftIO $ newStablePtr stdout
303 liftIO $ newStablePtr stderr
305 -- Initialise buffering for the *interpreted* I/O system
308 liftIO $ when (isNothing maybe_exprs) $ do
309 -- Only for GHCi (not runghc and ghc -e):
311 -- Turn buffering off for the compiled program's stdout/stderr
313 -- Turn buffering off for GHCi's stdout
315 hSetBuffering stdout NoBuffering
316 -- We don't want the cmd line to buffer any input that might be
317 -- intended for the program, so unbuffer stdin.
318 hSetBuffering stdin NoBuffering
321 is_tty <- hIsTerminalDevice stdin
322 when is_tty $ withReadline $ do
326 (\dir -> Readline.readHistory (dir </> "ghci_history"))
329 Readline.setAttemptedCompletionFunction (Just completeWord)
330 --Readline.parseAndBind "set show-all-if-ambiguous 1"
332 Readline.setBasicWordBreakCharacters word_break_chars
333 Readline.setCompleterWordBreakCharacters word_break_chars
334 Readline.setCompletionAppendCharacter Nothing
337 -- initial context is just the Prelude
338 prel_mod <- GHC.findModule (GHC.mkModuleName "Prelude") Nothing
339 GHC.setContext [] [prel_mod]
341 default_editor <- liftIO $ findEditor
343 cwd <- liftIO $ getCurrentDirectory
345 startGHCi (runGHCi srcs maybe_exprs)
346 GHCiState{ progname = "<interactive>",
350 editor = default_editor,
351 -- session = session,
356 tickarrays = emptyModuleEnv,
357 last_command = Nothing,
361 ghc_e = isJust maybe_exprs
366 Readline.stifleHistory 100
367 withGhcAppData (\dir -> Readline.writeHistory (dir </> "ghci_history"))
369 Readline.resetTerminal Nothing
374 withGhcAppData :: (FilePath -> IO a) -> IO a -> IO a
375 withGhcAppData right left = do
376 either_dir <- IO.try (getAppUserDataDirectory "ghc")
378 Right dir -> right dir
381 -- libedit doesn't always restore the terminal settings correctly (as of at
382 -- least 07/12/2008); see trac #2691. Work around this by manually resetting
383 -- the terminal outselves.
384 withTerminalReset :: Ghc () -> Ghc ()
385 #ifdef mingw32_HOST_OS
386 withTerminalReset = id
388 withTerminalReset f = do
389 isTTY <- liftIO $ hIsTerminalDevice stdout
392 else gbracket (liftIO $ getTerminalAttributes stdOutput)
393 (\attrs -> liftIO $ setTerminalAttributes stdOutput attrs Immediately)
397 runGHCi :: [(FilePath, Maybe Phase)] -> Maybe [String] -> GHCi ()
398 runGHCi paths maybe_exprs = do
400 read_dot_files = not opt_IgnoreDotGhci
402 current_dir = return (Just ".ghci")
404 app_user_dir = io $ withGhcAppData
405 (\dir -> return (Just (dir </> "ghci.conf")))
409 either_dir <- io $ IO.try (getEnv "HOME")
411 Right home -> return (Just (home </> ".ghci"))
414 sourceConfigFile :: FilePath -> GHCi ()
415 sourceConfigFile file = do
416 exists <- io $ doesFileExist file
418 dir_ok <- io $ checkPerms (getDirectory file)
419 file_ok <- io $ checkPerms file
420 when (dir_ok && file_ok) $ do
421 either_hdl <- io $ IO.try (openFile file ReadMode)
424 Right hdl -> runCommands (fileLoop hdl False False)
426 getDirectory f = case takeDirectory f of "" -> "."; d -> d
428 when (read_dot_files) $ do
429 cfgs0 <- sequence [ current_dir, app_user_dir, home_dir ]
430 cfgs <- io $ mapM canonicalizePath (catMaybes cfgs0)
431 mapM_ sourceConfigFile (nub cfgs)
432 -- nub, because we don't want to read .ghci twice if the
435 -- Perform a :load for files given on the GHCi command line
436 -- When in -e mode, if the load fails then we want to stop
437 -- immediately rather than going on to evaluate the expression.
438 when (not (null paths)) $ do
439 ok <- ghciHandle (\e -> do showException e; return Failed) $
441 when (isJust maybe_exprs && failed ok) $
442 io (exitWith (ExitFailure 1))
444 -- if verbosity is greater than 0, or we are connected to a
445 -- terminal, display the prompt in the interactive loop.
446 is_tty <- io (hIsTerminalDevice stdin)
447 dflags <- getDynFlags
448 let show_prompt = verbosity dflags > 0 || is_tty
453 #if defined(mingw32_HOST_OS)
454 -- The win32 Console API mutates the first character of
455 -- type-ahead when reading from it in a non-buffered manner. Work
456 -- around this by flushing the input buffer of type-ahead characters,
457 -- but only if stdin is available.
458 flushed <- io (IO.try (GHC.ConsoleHandler.flushConsole stdin))
460 Left err | isDoesNotExistError err -> return ()
461 | otherwise -> io (ioError err)
462 Right () -> return ()
464 -- enter the interactive loop
465 interactiveLoop is_tty show_prompt
467 -- just evaluate the expression we were given
468 enqueueCommands exprs
469 let handle e = do st <- getGHCiState
470 -- Jump through some hoops to get the
471 -- current progname in the exception text:
472 -- <progname>: <exception>
473 io $ withProgName (progname st)
474 -- this used to be topHandlerFastExit, see #2228
476 runCommands' handle (return Nothing)
479 io $ do when (verbosity dflags > 0) $ putStrLn "Leaving GHCi."
481 interactiveLoop :: Bool -> Bool -> GHCi ()
482 interactiveLoop is_tty show_prompt =
483 -- Ignore ^C exceptions caught here
484 ghciHandleGhcException (\e -> case e of
486 #if defined(mingw32_HOST_OS)
489 interactiveLoop is_tty show_prompt
490 _other -> return ()) $
492 ghciUnblock $ do -- unblock necessary if we recursed from the
493 -- exception handler above.
495 -- read commands from stdin
498 then runCommands readlineLoop
499 else runCommands (fileLoop stdin show_prompt is_tty)
501 runCommands (fileLoop stdin show_prompt is_tty)
505 -- NOTE: We only read .ghci files if they are owned by the current user,
506 -- and aren't world writable. Otherwise, we could be accidentally
507 -- running code planted by a malicious third party.
509 -- Furthermore, We only read ./.ghci if . is owned by the current user
510 -- and isn't writable by anyone else. I think this is sufficient: we
511 -- don't need to check .. and ../.. etc. because "." always refers to
512 -- the same directory while a process is running.
514 checkPerms :: String -> IO Bool
515 #ifdef mingw32_HOST_OS
520 handleIO (\_ -> return False) $ do
521 st <- getFileStatus name
523 if fileOwner st /= me then do
524 putStrLn $ "WARNING: " ++ name ++ " is owned by someone else, IGNORING!"
527 let mode = fileMode st
528 if (groupWriteMode == (mode `intersectFileModes` groupWriteMode))
529 || (otherWriteMode == (mode `intersectFileModes` otherWriteMode))
531 putStrLn $ "*** WARNING: " ++ name ++
532 " is writable by someone else, IGNORING!"
537 fileLoop :: Handle -> Bool -> Bool -> GHCi (Maybe String)
538 fileLoop hdl show_prompt is_tty = do
539 when show_prompt $ do
542 l <- io (IO.try (hGetLine hdl))
544 Left e | isEOFError e -> return Nothing
545 | InvalidArgument <- etype -> return Nothing
546 | otherwise -> io (ioError e)
547 where etype = ioeGetErrorType e
548 -- treat InvalidArgument in the same way as EOF:
549 -- this can happen if the user closed stdin, or
550 -- perhaps did getContents which closes stdin at
553 str <- io $ consoleInputToUnicode is_tty l
556 #ifdef mingw32_HOST_OS
557 -- Convert the console input into Unicode according to the current code page.
558 -- The Windows console stores Unicode characters directly, so this is a
559 -- rather roundabout way of doing things... oh well.
560 -- See #782, #1483, #1649
561 consoleInputToUnicode :: Bool -> String -> IO String
562 consoleInputToUnicode is_tty str
564 cp <- System.Win32.getConsoleCP
565 System.Win32.stringToUnicode cp str
567 decodeStringAsUTF8 str
569 -- for Unix, assume the input is in UTF-8 and decode it to a Unicode String.
571 consoleInputToUnicode :: Bool -> String -> IO String
572 consoleInputToUnicode _is_tty str = decodeStringAsUTF8 str
575 decodeStringAsUTF8 :: String -> IO String
576 decodeStringAsUTF8 str =
577 withCStringLen str $ \(cstr,len) ->
578 utf8DecodeString (castPtr cstr :: Ptr Word8) len
580 mkPrompt :: GHCi String
582 (toplevs,exports) <- GHC.getContext
583 resumes <- GHC.getResumeContext
584 -- st <- getGHCiState
590 let ix = GHC.resumeHistoryIx r
592 then return (brackets (ppr (GHC.resumeSpan r)) <> space)
594 let hist = GHC.resumeHistory r !! (ix-1)
595 span <- GHC.getHistorySpan hist
596 return (brackets (ppr (negate ix) <> char ':'
597 <+> ppr span) <> space)
599 dots | _:rs <- resumes, not (null rs) = text "... "
606 -- let (btoplevs, bexports) = fromMaybe ([],[]) (remembered_ctx st) in
607 -- hsep (map (\m -> text "!*" <> ppr (GHC.moduleName m)) btoplevs) <+>
608 -- hsep (map (\m -> char '!' <> ppr (GHC.moduleName m)) bexports) <+>
609 hsep (map (\m -> char '*' <> ppr (GHC.moduleName m)) toplevs) <+>
610 hsep (map (ppr . GHC.moduleName) exports)
612 deflt_prompt = dots <> context_bit <> modules_bit
614 f ('%':'s':xs) = deflt_prompt <> f xs
615 f ('%':'%':xs) = char '%' <> f xs
616 f (x:xs) = char x <> f xs
620 return (showSDoc (f (prompt st)))
624 readlineLoop :: GHCi (Maybe String)
627 saveSession -- for use by completion
629 l <- io $ withReadline (readline prompt)
632 Nothing -> return Nothing
633 Just "" -> return (Just "") -- Don't put empty lines in the history
636 str <- io $ consoleInputToUnicode True l
639 withReadline :: IO a -> IO a
640 withReadline = bracket_ stopTimer startTimer
641 -- editline doesn't handle some of its system calls returning
642 -- EINTR, so our timer signal confuses it, hence we turn off
643 -- the timer signal when making calls to editline. (#2277)
644 -- If editline is ever fixed, we can remove this.
646 -- These come from the RTS
647 foreign import ccall unsafe startTimer :: IO ()
648 foreign import ccall unsafe stopTimer :: IO ()
651 queryQueue :: GHCi (Maybe String)
656 c:cs -> do setGHCiState st{ cmdqueue = cs }
659 runCommands :: GHCi (Maybe String) -> GHCi ()
660 runCommands = runCommands' handler
662 runCommands' :: (SomeException -> GHCi Bool) -- Exception handler
663 -> GHCi (Maybe String) -> GHCi ()
664 runCommands' eh getCmd = do
665 mb_cmd <- noSpace queryQueue
666 mb_cmd <- maybe (noSpace getCmd) (return . Just) mb_cmd
671 handleSourceError printErrorAndKeepGoing
673 if b then return () else runCommands' eh getCmd
675 printErrorAndKeepGoing err = do
676 GHC.printExceptionAndWarnings err
679 noSpace q = q >>= maybe (return Nothing)
680 (\c->case removeSpaces c of
682 ":{" -> multiLineCmd q
683 c -> return (Just c) )
687 setGHCiState st{ prompt = "%s| " }
688 mb_cmd <- collectCommand q ""
689 getGHCiState >>= \st->setGHCiState st{ prompt = p }
691 -- we can't use removeSpaces for the sublines here, so
692 -- multiline commands are somewhat more brittle against
693 -- fileformat errors (such as \r in dos input on unix),
694 -- we get rid of any extra spaces for the ":}" test;
695 -- we also avoid silent failure if ":}" is not found;
696 -- and since there is no (?) valid occurrence of \r (as
697 -- opposed to its String representation, "\r") inside a
698 -- ghci command, we replace any such with ' ' (argh:-(
699 collectCommand q c = q >>=
700 maybe (io (ioError collectError))
701 (\l->if removeSpaces l == ":}"
702 then return (Just $ removeSpaces c)
703 else collectCommand q (c++map normSpace l))
704 where normSpace '\r' = ' '
706 -- QUESTION: is userError the one to use here?
707 collectError = userError "unterminated multiline command :{ .. :}"
708 doCommand (':' : cmd) = specialCommand cmd
709 doCommand stmt = do timeIt $ runStmt stmt GHC.RunToCompletion
712 enqueueCommands :: [String] -> GHCi ()
713 enqueueCommands cmds = do
715 setGHCiState st{ cmdqueue = cmds ++ cmdqueue st }
718 runStmt :: String -> SingleStep -> GHCi Bool
720 | null (filter (not.isSpace) stmt) = return False
721 | ["import", mod] <- words stmt = keepGoing setContext ('+':mod)
723 = do result <- GhciMonad.runStmt stmt step
724 afterRunStmt (const True) result
726 --afterRunStmt :: GHC.RunResult -> GHCi Bool
727 -- False <=> the statement failed to compile
728 afterRunStmt :: (SrcSpan -> Bool) -> GHC.RunResult -> GHCi Bool
729 afterRunStmt _ (GHC.RunException e) = throw e
730 afterRunStmt step_here run_result = do
731 resumes <- GHC.getResumeContext
733 GHC.RunOk names -> do
734 show_types <- isOptionSet ShowType
735 when show_types $ printTypeOfNames names
736 GHC.RunBreak _ names mb_info
737 | isNothing mb_info ||
738 step_here (GHC.resumeSpan $ head resumes) -> do
739 printForUser $ ptext (sLit "Stopped at") <+>
740 ppr (GHC.resumeSpan $ head resumes)
741 -- printTypeOfNames session names
742 let namesSorted = sortBy compareNames names
743 tythings <- catMaybes `liftM`
744 mapM GHC.lookupName namesSorted
745 docs <- pprTypeAndContents [id | AnId id <- tythings]
746 printForUserPartWay docs
747 maybe (return ()) runBreakCmd mb_info
748 -- run the command set with ":set stop <cmd>"
750 enqueueCommands [stop st]
752 | otherwise -> resume GHC.SingleStep >>=
753 afterRunStmt step_here >> return ()
757 io installSignalHandlers
758 b <- isOptionSet RevertCAFs
761 return (case run_result of GHC.RunOk _ -> True; _ -> False)
763 runBreakCmd :: GHC.BreakInfo -> GHCi ()
764 runBreakCmd info = do
765 let mod = GHC.breakInfo_module info
766 nm = GHC.breakInfo_number info
768 case [ loc | (_,loc) <- breaks st,
769 breakModule loc == mod, breakTick loc == nm ] of
771 loc:_ | null cmd -> return ()
772 | otherwise -> do enqueueCommands [cmd]; return ()
773 where cmd = onBreakCmd loc
775 printTypeOfNames :: [Name] -> GHCi ()
776 printTypeOfNames names
777 = mapM_ (printTypeOfName ) $ sortBy compareNames names
779 compareNames :: Name -> Name -> Ordering
780 n1 `compareNames` n2 = compareWith n1 `compare` compareWith n2
781 where compareWith n = (getOccString n, getSrcSpan n)
783 printTypeOfName :: Name -> GHCi ()
785 = do maybe_tything <- GHC.lookupName n
786 case maybe_tything of
788 Just thing -> printTyThing thing
791 data MaybeCommand = GotCommand Command | BadCommand | NoLastCommand
793 specialCommand :: String -> GHCi Bool
794 specialCommand ('!':str) = shellEscape (dropWhile isSpace str)
795 specialCommand str = do
796 let (cmd,rest) = break isSpace str
797 maybe_cmd <- lookupCommand cmd
799 GotCommand (_,f,_,_) -> f (dropWhile isSpace rest)
801 do io $ hPutStr stdout ("unknown command ':" ++ cmd ++ "'\n"
805 do io $ hPutStr stdout ("there is no last command to perform\n"
809 lookupCommand :: String -> GHCi (MaybeCommand)
810 lookupCommand "" = do
812 case last_command st of
813 Just c -> return $ GotCommand c
814 Nothing -> return NoLastCommand
815 lookupCommand str = do
816 mc <- io $ lookupCommand' str
818 setGHCiState st{ last_command = mc }
820 Just c -> GotCommand c
821 Nothing -> BadCommand
823 lookupCommand' :: String -> IO (Maybe Command)
824 lookupCommand' str = do
825 macros <- readIORef macros_ref
826 let cmds = builtin_commands ++ macros
827 -- look for exact match first, then the first prefix match
828 return $ case [ c | c <- cmds, str == cmdName c ] of
830 [] -> case [ c | c@(s,_,_,_) <- cmds, str `isPrefixOf` s ] of
834 getCurrentBreakSpan :: GHCi (Maybe SrcSpan)
835 getCurrentBreakSpan = do
836 resumes <- GHC.getResumeContext
840 let ix = GHC.resumeHistoryIx r
842 then return (Just (GHC.resumeSpan r))
844 let hist = GHC.resumeHistory r !! (ix-1)
845 span <- GHC.getHistorySpan hist
848 getCurrentBreakModule :: GHCi (Maybe Module)
849 getCurrentBreakModule = do
850 resumes <- GHC.getResumeContext
854 let ix = GHC.resumeHistoryIx r
856 then return (GHC.breakInfo_module `liftM` GHC.resumeBreakInfo r)
858 let hist = GHC.resumeHistory r !! (ix-1)
859 return $ Just $ GHC.getHistoryModule hist
861 -----------------------------------------------------------------------------
864 noArgs :: GHCi () -> String -> GHCi ()
866 noArgs _ _ = io $ putStrLn "This command takes no arguments"
868 help :: String -> GHCi ()
869 help _ = io (putStr helpText)
871 info :: String -> GHCi ()
872 info "" = ghcError (CmdLineError "syntax: ':i <thing-you-want-info-about>'")
873 info s = handleSourceError GHC.printExceptionAndWarnings $ do
874 { let names = words s
875 ; dflags <- getDynFlags
876 ; let pefas = dopt Opt_PrintExplicitForalls dflags
877 ; mapM_ (infoThing pefas) names }
879 infoThing pefas str = do
880 names <- GHC.parseName str
881 mb_stuffs <- mapM GHC.getInfo names
882 let filtered = filterOutChildren (\(t,_f,_i) -> t) (catMaybes mb_stuffs)
883 unqual <- GHC.getPrintUnqual
885 putStrLn (showSDocForUser unqual $
886 vcat (intersperse (text "") $
887 map (pprInfo pefas) filtered))
889 -- Filter out names whose parent is also there Good
890 -- example is '[]', which is both a type and data
891 -- constructor in the same type
892 filterOutChildren :: (a -> TyThing) -> [a] -> [a]
893 filterOutChildren get_thing xs
894 = [x | x <- xs, not (getName (get_thing x) `elemNameSet` implicits)]
896 implicits = mkNameSet [getName t | x <- xs, t <- implicitTyThings (get_thing x)]
898 pprInfo :: PrintExplicitForalls -> (TyThing, Fixity, [GHC.Instance]) -> SDoc
899 pprInfo pefas (thing, fixity, insts)
900 = pprTyThingInContextLoc pefas thing
901 $$ show_fixity fixity
902 $$ vcat (map GHC.pprInstance insts)
905 | fix == GHC.defaultFixity = empty
906 | otherwise = ppr fix <+> ppr (GHC.getName thing)
908 runMain :: String -> GHCi ()
909 runMain s = case toArgs s of
910 Left err -> io (hPutStrLn stderr err)
912 do dflags <- getDynFlags
913 case mainFunIs dflags of
914 Nothing -> doWithArgs args "main"
915 Just f -> doWithArgs args f
917 runRun :: String -> GHCi ()
918 runRun s = case toCmdArgs s of
919 Left err -> io (hPutStrLn stderr err)
920 Right (cmd, args) -> doWithArgs args cmd
922 doWithArgs :: [String] -> String -> GHCi ()
923 doWithArgs args cmd = enqueueCommands ["System.Environment.withArgs " ++
924 show args ++ " (" ++ cmd ++ ")"]
926 addModule :: [FilePath] -> GHCi ()
928 revertCAFs -- always revert CAFs on load/add.
929 files <- mapM expandPath files
930 targets <- mapM (\m -> GHC.guessTarget m Nothing) files
931 -- remove old targets with the same id; e.g. for :add *M
932 mapM_ GHC.removeTarget [ tid | Target tid _ _ <- targets ]
933 mapM_ GHC.addTarget targets
934 prev_context <- GHC.getContext
935 ok <- trySuccess $ GHC.load LoadAllTargets
936 afterLoad ok False prev_context
938 changeDirectory :: String -> GHCi ()
939 changeDirectory "" = do
940 -- :cd on its own changes to the user's home directory
941 either_dir <- io (IO.try getHomeDirectory)
944 Right dir -> changeDirectory dir
945 changeDirectory dir = do
946 graph <- GHC.getModuleGraph
947 when (not (null graph)) $
948 io $ putStr "Warning: changing directory causes all loaded modules to be unloaded,\nbecause the search path has changed.\n"
949 prev_context <- GHC.getContext
951 GHC.load LoadAllTargets
952 setContextAfterLoad prev_context False []
953 GHC.workingDirectoryChanged
954 dir <- expandPath dir
955 io (setCurrentDirectory dir)
957 trySuccess :: GHC.GhcMonad m => m SuccessFlag -> m SuccessFlag
959 handleSourceError (\e -> do GHC.printExceptionAndWarnings e
963 editFile :: String -> GHCi ()
965 do file <- if null str then chooseEditFile else return str
969 $ ghcError (CmdLineError "editor not set, use :set editor")
970 io $ system (cmd ++ ' ':file)
973 -- The user didn't specify a file so we pick one for them.
974 -- Our strategy is to pick the first module that failed to load,
975 -- or otherwise the first target.
977 -- XXX: Can we figure out what happened if the depndecy analysis fails
978 -- (e.g., because the porgrammeer mistyped the name of a module)?
979 -- XXX: Can we figure out the location of an error to pass to the editor?
980 -- XXX: if we could figure out the list of errors that occured during the
981 -- last load/reaload, then we could start the editor focused on the first
983 chooseEditFile :: GHCi String
985 do let hasFailed x = fmap not $ GHC.isLoaded $ GHC.ms_mod_name x
987 graph <- GHC.getModuleGraph
988 failed_graph <- filterM hasFailed graph
989 let order g = flattenSCCs $ GHC.topSortModuleGraph True g Nothing
991 x : _ -> GHC.ml_hs_file (GHC.ms_location x)
994 case pick (order failed_graph) of
995 Just file -> return file
997 do targets <- GHC.getTargets
998 case msum (map fromTarget targets) of
999 Just file -> return file
1000 Nothing -> ghcError (CmdLineError "No files to edit.")
1002 where fromTarget (GHC.Target (GHC.TargetFile f _) _ _) = Just f
1003 fromTarget _ = Nothing -- when would we get a module target?
1005 defineMacro :: Bool{-overwrite-} -> String -> GHCi ()
1006 defineMacro overwrite s = do
1007 let (macro_name, definition) = break isSpace s
1008 macros <- io (readIORef macros_ref)
1009 let defined = map cmdName macros
1010 if (null macro_name)
1011 then if null defined
1012 then io $ putStrLn "no macros defined"
1013 else io $ putStr ("the following macros are defined:\n" ++
1016 if (not overwrite && macro_name `elem` defined)
1017 then ghcError (CmdLineError
1018 ("macro '" ++ macro_name ++ "' is already defined"))
1021 let filtered = [ cmd | cmd <- macros, cmdName cmd /= macro_name ]
1023 -- give the expression a type signature, so we can be sure we're getting
1024 -- something of the right type.
1025 let new_expr = '(' : definition ++ ") :: String -> IO String"
1027 -- compile the expression
1028 handleSourceError (\e -> GHC.printExceptionAndWarnings e) $ do
1029 hv <- GHC.compileExpr new_expr
1030 io (writeIORef macros_ref --
1031 (filtered ++ [(macro_name, runMacro hv, Nothing, completeNone)]))
1033 runMacro :: GHC.HValue{-String -> IO String-} -> String -> GHCi Bool
1035 str <- io ((unsafeCoerce# fun :: String -> IO String) s)
1036 enqueueCommands (lines str)
1039 undefineMacro :: String -> GHCi ()
1040 undefineMacro str = mapM_ undef (words str)
1041 where undef macro_name = do
1042 cmds <- io (readIORef macros_ref)
1043 if (macro_name `notElem` map cmdName cmds)
1044 then ghcError (CmdLineError
1045 ("macro '" ++ macro_name ++ "' is not defined"))
1047 io (writeIORef macros_ref (filter ((/= macro_name) . cmdName) cmds))
1049 cmdCmd :: String -> GHCi ()
1051 let expr = '(' : str ++ ") :: IO String"
1052 handleSourceError (\e -> GHC.printExceptionAndWarnings e) $ do
1053 hv <- GHC.compileExpr expr
1054 cmds <- io $ (unsafeCoerce# hv :: IO String)
1055 enqueueCommands (lines cmds)
1058 loadModule :: [(FilePath, Maybe Phase)] -> GHCi SuccessFlag
1059 loadModule fs = timeIt (loadModule' fs)
1061 loadModule_ :: [FilePath] -> GHCi ()
1062 loadModule_ fs = do loadModule (zip fs (repeat Nothing)); return ()
1064 loadModule' :: [(FilePath, Maybe Phase)] -> GHCi SuccessFlag
1065 loadModule' files = do
1066 prev_context <- GHC.getContext
1070 discardActiveBreakPoints
1072 GHC.load LoadAllTargets
1075 let (filenames, phases) = unzip files
1076 exp_filenames <- mapM expandPath filenames
1077 let files' = zip exp_filenames phases
1078 targets <- mapM (uncurry GHC.guessTarget) files'
1080 -- NOTE: we used to do the dependency anal first, so that if it
1081 -- fails we didn't throw away the current set of modules. This would
1082 -- require some re-working of the GHC interface, so we'll leave it
1083 -- as a ToDo for now.
1085 GHC.setTargets targets
1086 doLoad False prev_context LoadAllTargets
1088 checkModule :: String -> GHCi ()
1090 let modl = GHC.mkModuleName m
1091 prev_context <- GHC.getContext
1092 ok <- handleSourceError (\e -> GHC.printExceptionAndWarnings e >> return False) $ do
1093 r <- GHC.typecheckModule =<< GHC.parseModule =<< GHC.getModSummary modl
1094 io $ putStrLn (showSDoc (
1095 case GHC.moduleInfo r of
1096 cm | Just scope <- GHC.modInfoTopLevelScope cm ->
1098 (local,global) = ASSERT( all isExternalName scope )
1099 partition ((== modl) . GHC.moduleName . GHC.nameModule) scope
1101 (text "global names: " <+> ppr global) $$
1102 (text "local names: " <+> ppr local)
1105 afterLoad (successIf ok) False prev_context
1107 reloadModule :: String -> GHCi ()
1109 prev_context <- GHC.getContext
1110 doLoad True prev_context $
1111 if null m then LoadAllTargets
1112 else LoadUpTo (GHC.mkModuleName m)
1115 doLoad :: Bool -> ([Module],[Module]) -> LoadHowMuch -> GHCi SuccessFlag
1116 doLoad retain_context prev_context howmuch = do
1117 -- turn off breakpoints before we load: we can't turn them off later, because
1118 -- the ModBreaks will have gone away.
1119 discardActiveBreakPoints
1120 ok <- trySuccess $ GHC.load howmuch
1121 afterLoad ok retain_context prev_context
1124 afterLoad :: SuccessFlag -> Bool -> ([Module],[Module]) -> GHCi ()
1125 afterLoad ok retain_context prev_context = do
1126 revertCAFs -- always revert CAFs on load.
1128 loaded_mod_summaries <- getLoadedModules
1129 let loaded_mods = map GHC.ms_mod loaded_mod_summaries
1130 loaded_mod_names = map GHC.moduleName loaded_mods
1131 modulesLoadedMsg ok loaded_mod_names
1133 setContextAfterLoad prev_context retain_context loaded_mod_summaries
1136 setContextAfterLoad :: ([Module],[Module]) -> Bool -> [GHC.ModSummary] -> GHCi ()
1137 setContextAfterLoad prev keep_ctxt [] = do
1138 prel_mod <- getPrelude
1139 setContextKeepingPackageModules prev keep_ctxt ([], [prel_mod])
1140 setContextAfterLoad prev keep_ctxt ms = do
1141 -- load a target if one is available, otherwise load the topmost module.
1142 targets <- GHC.getTargets
1143 case [ m | Just m <- map (findTarget ms) targets ] of
1145 let graph' = flattenSCCs (GHC.topSortModuleGraph True ms Nothing) in
1146 load_this (last graph')
1151 = case filter (`matches` t) ms of
1155 summary `matches` Target (TargetModule m) _ _
1156 = GHC.ms_mod_name summary == m
1157 summary `matches` Target (TargetFile f _) _ _
1158 | Just f' <- GHC.ml_hs_file (GHC.ms_location summary) = f == f'
1162 load_this summary | m <- GHC.ms_mod summary = do
1163 b <- GHC.moduleIsInterpreted m
1164 if b then setContextKeepingPackageModules prev keep_ctxt ([m], [])
1166 prel_mod <- getPrelude
1167 setContextKeepingPackageModules prev keep_ctxt ([],[prel_mod,m])
1169 -- | Keep any package modules (except Prelude) when changing the context.
1170 setContextKeepingPackageModules
1171 :: ([Module],[Module]) -- previous context
1172 -> Bool -- re-execute :module commands
1173 -> ([Module],[Module]) -- new context
1175 setContextKeepingPackageModules prev_context keep_ctxt (as,bs) = do
1176 let (_,bs0) = prev_context
1177 prel_mod <- getPrelude
1178 let pkg_modules = filter (\p -> not (isHomeModule p) && p /= prel_mod) bs0
1179 let bs1 = if null as then nub (prel_mod : bs) else bs
1180 GHC.setContext as (nub (bs1 ++ pkg_modules))
1184 mapM_ (playCtxtCmd False) (remembered_ctx st)
1187 setGHCiState st{ remembered_ctx = [] }
1189 isHomeModule :: Module -> Bool
1190 isHomeModule mod = GHC.modulePackageId mod == mainPackageId
1192 modulesLoadedMsg :: SuccessFlag -> [ModuleName] -> GHCi ()
1193 modulesLoadedMsg ok mods = do
1194 dflags <- getDynFlags
1195 when (verbosity dflags > 0) $ do
1197 | null mods = text "none."
1198 | otherwise = hsep (
1199 punctuate comma (map ppr mods)) <> text "."
1202 io (putStrLn (showSDoc (text "Failed, modules loaded: " <> mod_commas)))
1204 io (putStrLn (showSDoc (text "Ok, modules loaded: " <> mod_commas)))
1207 typeOfExpr :: String -> GHCi ()
1209 = handleSourceError (\e -> GHC.printExceptionAndWarnings e) $ do
1210 ty <- GHC.exprType str
1211 dflags <- getDynFlags
1212 let pefas = dopt Opt_PrintExplicitForalls dflags
1213 printForUser $ sep [text str, nest 2 (dcolon <+> pprTypeForUser pefas ty)]
1215 kindOfType :: String -> GHCi ()
1217 = handleSourceError (\e -> GHC.printExceptionAndWarnings e) $ do
1218 ty <- GHC.typeKind str
1219 printForUser $ text str <+> dcolon <+> ppr ty
1221 quit :: String -> GHCi Bool
1222 quit _ = return True
1224 shellEscape :: String -> GHCi Bool
1225 shellEscape str = io (system str >> return False)
1227 -----------------------------------------------------------------------------
1228 -- Browsing a module's contents
1230 browseCmd :: Bool -> String -> GHCi ()
1233 ['*':s] | looksLikeModuleName s -> do
1234 m <- wantInterpretedModule s
1235 browseModule bang m False
1236 [s] | looksLikeModuleName s -> do
1238 browseModule bang m True
1240 (as,bs) <- GHC.getContext
1241 -- Guess which module the user wants to browse. Pick
1242 -- modules that are interpreted first. The most
1243 -- recently-added module occurs last, it seems.
1245 (as@(_:_), _) -> browseModule bang (last as) True
1246 ([], bs@(_:_)) -> browseModule bang (last bs) True
1247 ([], []) -> ghcError (CmdLineError ":browse: no current module")
1248 _ -> ghcError (CmdLineError "syntax: :browse <module>")
1250 -- without bang, show items in context of their parents and omit children
1251 -- with bang, show class methods and data constructors separately, and
1252 -- indicate import modules, to aid qualifying unqualified names
1253 -- with sorted, sort items alphabetically
1254 browseModule :: Bool -> Module -> Bool -> GHCi ()
1255 browseModule bang modl exports_only = do
1256 -- :browse! reports qualifiers wrt current context
1257 current_unqual <- GHC.getPrintUnqual
1258 -- Temporarily set the context to the module we're interested in,
1259 -- just so we can get an appropriate PrintUnqualified
1260 (as,bs) <- GHC.getContext
1261 prel_mod <- getPrelude
1262 if exports_only then GHC.setContext [] [prel_mod,modl]
1263 else GHC.setContext [modl] []
1264 target_unqual <- GHC.getPrintUnqual
1265 GHC.setContext as bs
1267 let unqual = if bang then current_unqual else target_unqual
1269 mb_mod_info <- GHC.getModuleInfo modl
1271 Nothing -> ghcError (CmdLineError ("unknown module: " ++
1272 GHC.moduleNameString (GHC.moduleName modl)))
1274 dflags <- getDynFlags
1276 | exports_only = GHC.modInfoExports mod_info
1277 | otherwise = GHC.modInfoTopLevelScope mod_info
1280 -- sort alphabetically name, but putting
1281 -- locally-defined identifiers first.
1282 -- We would like to improve this; see #1799.
1283 sorted_names = loc_sort local ++ occ_sort external
1285 (local,external) = ASSERT( all isExternalName names )
1286 partition ((==modl) . nameModule) names
1287 occ_sort = sortBy (compare `on` nameOccName)
1288 -- try to sort by src location. If the first name in
1289 -- our list has a good source location, then they all should.
1291 | n:_ <- names, isGoodSrcSpan (nameSrcSpan n)
1292 = sortBy (compare `on` nameSrcSpan) names
1296 mb_things <- mapM GHC.lookupName sorted_names
1297 let filtered_things = filterOutChildren (\t -> t) (catMaybes mb_things)
1299 rdr_env <- GHC.getGRE
1301 let pefas = dopt Opt_PrintExplicitForalls dflags
1302 things | bang = catMaybes mb_things
1303 | otherwise = filtered_things
1304 pretty | bang = pprTyThing
1305 | otherwise = pprTyThingInContext
1307 labels [] = text "-- not currently imported"
1308 labels l = text $ intercalate "\n" $ map qualifier l
1309 qualifier = maybe "-- defined locally"
1310 (("-- imported via "++) . intercalate ", "
1311 . map GHC.moduleNameString)
1312 importInfo = RdrName.getGRE_NameQualifier_maybes rdr_env
1313 modNames = map (importInfo . GHC.getName) things
1315 -- annotate groups of imports with their import modules
1316 -- the default ordering is somewhat arbitrary, so we group
1317 -- by header and sort groups; the names themselves should
1318 -- really come in order of source appearance.. (trac #1799)
1319 annotate mts = concatMap (\(m,ts)->labels m:ts)
1320 $ sortBy cmpQualifiers $ group mts
1321 where cmpQualifiers =
1322 compare `on` (map (fmap (map moduleNameFS)) . fst)
1324 group mts@((m,_):_) = (m,map snd g) : group ng
1325 where (g,ng) = partition ((==m).fst) mts
1327 let prettyThings = map (pretty pefas) things
1328 prettyThings' | bang = annotate $ zip modNames prettyThings
1329 | otherwise = prettyThings
1330 io (putStrLn $ showSDocForUser unqual (vcat prettyThings'))
1331 -- ToDo: modInfoInstances currently throws an exception for
1332 -- package modules. When it works, we can do this:
1333 -- $$ vcat (map GHC.pprInstance (GHC.modInfoInstances mod_info))
1335 -----------------------------------------------------------------------------
1336 -- Setting the module context
1338 setContext :: String -> GHCi ()
1340 | all sensible strs = do
1341 playCtxtCmd True (cmd, as, bs)
1343 setGHCiState st{ remembered_ctx = remembered_ctx st ++ [(cmd,as,bs)] }
1344 | otherwise = ghcError (CmdLineError "syntax: :module [+/-] [*]M1 ... [*]Mn")
1346 (cmd, strs, as, bs) =
1348 '+':stuff -> rest AddModules stuff
1349 '-':stuff -> rest RemModules stuff
1350 stuff -> rest SetContext stuff
1352 rest cmd stuff = (cmd, strs, as, bs)
1353 where strs = words stuff
1354 (as,bs) = partitionWith starred strs
1356 sensible ('*':m) = looksLikeModuleName m
1357 sensible m = looksLikeModuleName m
1359 starred ('*':m) = Left m
1362 playCtxtCmd :: Bool -> (CtxtCmd, [String], [String]) -> GHCi ()
1363 playCtxtCmd fail (cmd, as, bs)
1365 (as',bs') <- do_checks fail
1366 (prev_as,prev_bs) <- GHC.getContext
1370 prel_mod <- getPrelude
1371 let bs'' = if null as && prel_mod `notElem` bs' then prel_mod:bs'
1375 let as_to_add = as' \\ (prev_as ++ prev_bs)
1376 bs_to_add = bs' \\ (prev_as ++ prev_bs)
1377 return (prev_as ++ as_to_add, prev_bs ++ bs_to_add)
1379 let new_as = prev_as \\ (as' ++ bs')
1380 new_bs = prev_bs \\ (as' ++ bs')
1381 return (new_as, new_bs)
1382 GHC.setContext new_as new_bs
1385 as' <- mapM wantInterpretedModule as
1386 bs' <- mapM lookupModule bs
1388 do_checks False = do
1389 as' <- mapM (trymaybe . wantInterpretedModule) as
1390 bs' <- mapM (trymaybe . lookupModule) bs
1391 return (catMaybes as', catMaybes bs')
1396 Left _ -> return Nothing
1397 Right a -> return (Just a)
1399 ----------------------------------------------------------------------------
1402 -- set options in the interpreter. Syntax is exactly the same as the
1403 -- ghc command line, except that certain options aren't available (-C,
1406 -- This is pretty fragile: most options won't work as expected. ToDo:
1407 -- figure out which ones & disallow them.
1409 setCmd :: String -> GHCi ()
1411 = do st <- getGHCiState
1412 let opts = options st
1413 io $ putStrLn (showSDoc (
1414 text "options currently set: " <>
1417 else hsep (map (\o -> char '+' <> text (optToStr o)) opts)
1419 dflags <- getDynFlags
1420 io $ putStrLn (showSDoc (
1421 vcat (text "GHCi-specific dynamic flag settings:"
1422 :map (flagSetting dflags) ghciFlags)
1424 io $ putStrLn (showSDoc (
1425 vcat (text "other dynamic, non-language, flag settings:"
1426 :map (flagSetting dflags) nonLanguageDynFlags)
1428 where flagSetting dflags (str, f, _)
1429 | dopt f dflags = text " " <> text "-f" <> text str
1430 | otherwise = text " " <> text "-fno-" <> text str
1431 (ghciFlags,others) = partition (\(_, f, _) -> f `elem` flags)
1433 nonLanguageDynFlags = filterOut (\(_, f, _) -> f `elem` languageOptions)
1435 flags = [Opt_PrintExplicitForalls
1436 ,Opt_PrintBindResult
1437 ,Opt_BreakOnException
1439 ,Opt_PrintEvldWithShow
1442 = case getCmd str of
1443 Right ("args", rest) ->
1445 Left err -> io (hPutStrLn stderr err)
1446 Right args -> setArgs args
1447 Right ("prog", rest) ->
1449 Right [prog] -> setProg prog
1450 _ -> io (hPutStrLn stderr "syntax: :set prog <progname>")
1451 Right ("prompt", rest) -> setPrompt $ dropWhile isSpace rest
1452 Right ("editor", rest) -> setEditor $ dropWhile isSpace rest
1453 Right ("stop", rest) -> setStop $ dropWhile isSpace rest
1454 _ -> case toArgs str of
1455 Left err -> io (hPutStrLn stderr err)
1456 Right wds -> setOptions wds
1458 setArgs, setOptions :: [String] -> GHCi ()
1459 setProg, setEditor, setStop, setPrompt :: String -> GHCi ()
1463 setGHCiState st{ args = args }
1467 setGHCiState st{ progname = prog }
1471 setGHCiState st{ editor = cmd }
1473 setStop str@(c:_) | isDigit c
1474 = do let (nm_str,rest) = break (not.isDigit) str
1477 let old_breaks = breaks st
1478 if all ((/= nm) . fst) old_breaks
1479 then printForUser (text "Breakpoint" <+> ppr nm <+>
1480 text "does not exist")
1482 let new_breaks = map fn old_breaks
1483 fn (i,loc) | i == nm = (i,loc { onBreakCmd = dropWhile isSpace rest })
1484 | otherwise = (i,loc)
1485 setGHCiState st{ breaks = new_breaks }
1488 setGHCiState st{ stop = cmd }
1490 setPrompt value = do
1493 then io $ hPutStrLn stderr $ "syntax: :set prompt <prompt>, currently \"" ++ prompt st ++ "\""
1495 '\"' : _ -> case reads value of
1496 [(value', xs)] | all isSpace xs ->
1497 setGHCiState (st { prompt = value' })
1499 io $ hPutStrLn stderr "Can't parse prompt string. Use Haskell syntax."
1500 _ -> setGHCiState (st { prompt = value })
1503 do -- first, deal with the GHCi opts (+s, +t, etc.)
1504 let (plus_opts, minus_opts) = partitionWith isPlus wds
1505 mapM_ setOpt plus_opts
1506 -- then, dynamic flags
1507 newDynFlags minus_opts
1509 newDynFlags :: [String] -> GHCi ()
1510 newDynFlags minus_opts = do
1511 dflags <- getDynFlags
1512 let pkg_flags = packageFlags dflags
1513 (dflags', leftovers, warns) <- io $ GHC.parseDynamicFlags dflags $ map noLoc minus_opts
1514 handleFlagWarnings dflags' warns
1516 if (not (null leftovers))
1517 then ghcError $ errorsToGhcException leftovers
1520 new_pkgs <- setDynFlags dflags'
1522 -- if the package flags changed, we should reset the context
1523 -- and link the new packages.
1524 dflags <- getDynFlags
1525 when (packageFlags dflags /= pkg_flags) $ do
1526 io $ hPutStrLn stderr "package flags have changed, resetting and loading new packages..."
1528 GHC.load LoadAllTargets
1529 io (linkPackages dflags new_pkgs)
1530 -- package flags changed, we can't re-use any of the old context
1531 setContextAfterLoad ([],[]) False []
1535 unsetOptions :: String -> GHCi ()
1537 = do -- first, deal with the GHCi opts (+s, +t, etc.)
1538 let opts = words str
1539 (minus_opts, rest1) = partition isMinus opts
1540 (plus_opts, rest2) = partitionWith isPlus rest1
1542 if (not (null rest2))
1543 then io (putStrLn ("unknown option: '" ++ head rest2 ++ "'"))
1546 mapM_ unsetOpt plus_opts
1548 let no_flag ('-':'f':rest) = return ("-fno-" ++ rest)
1549 no_flag f = ghcError (ProgramError ("don't know how to reverse " ++ f))
1551 no_flags <- mapM no_flag minus_opts
1552 newDynFlags no_flags
1554 isMinus :: String -> Bool
1555 isMinus ('-':_) = True
1558 isPlus :: String -> Either String String
1559 isPlus ('+':opt) = Left opt
1560 isPlus other = Right other
1562 setOpt, unsetOpt :: String -> GHCi ()
1565 = case strToGHCiOpt str of
1566 Nothing -> io (putStrLn ("unknown option: '" ++ str ++ "'"))
1567 Just o -> setOption o
1570 = case strToGHCiOpt str of
1571 Nothing -> io (putStrLn ("unknown option: '" ++ str ++ "'"))
1572 Just o -> unsetOption o
1574 strToGHCiOpt :: String -> (Maybe GHCiOption)
1575 strToGHCiOpt "s" = Just ShowTiming
1576 strToGHCiOpt "t" = Just ShowType
1577 strToGHCiOpt "r" = Just RevertCAFs
1578 strToGHCiOpt _ = Nothing
1580 optToStr :: GHCiOption -> String
1581 optToStr ShowTiming = "s"
1582 optToStr ShowType = "t"
1583 optToStr RevertCAFs = "r"
1585 -- ---------------------------------------------------------------------------
1588 showCmd :: String -> GHCi ()
1592 ["args"] -> io $ putStrLn (show (args st))
1593 ["prog"] -> io $ putStrLn (show (progname st))
1594 ["prompt"] -> io $ putStrLn (show (prompt st))
1595 ["editor"] -> io $ putStrLn (show (editor st))
1596 ["stop"] -> io $ putStrLn (show (stop st))
1597 ["modules" ] -> showModules
1598 ["bindings"] -> showBindings
1599 ["linker"] -> io showLinkerState
1600 ["breaks"] -> showBkptTable
1601 ["context"] -> showContext
1602 ["packages"] -> showPackages
1603 ["languages"] -> showLanguages
1604 _ -> ghcError (CmdLineError ("syntax: :show [ args | prog | prompt | editor | stop | modules | bindings\n"++
1605 " | breaks | context | packages | languages ]"))
1607 showModules :: GHCi ()
1609 loaded_mods <- getLoadedModules
1610 -- we want *loaded* modules only, see #1734
1611 let show_one ms = do m <- GHC.showModule ms; io (putStrLn m)
1612 mapM_ show_one loaded_mods
1614 getLoadedModules :: GHCi [GHC.ModSummary]
1615 getLoadedModules = do
1616 graph <- GHC.getModuleGraph
1617 filterM (GHC.isLoaded . GHC.ms_mod_name) graph
1619 showBindings :: GHCi ()
1621 bindings <- GHC.getBindings
1622 docs <- pprTypeAndContents
1623 [ id | AnId id <- sortBy compareTyThings bindings]
1624 printForUserPartWay docs
1626 compareTyThings :: TyThing -> TyThing -> Ordering
1627 t1 `compareTyThings` t2 = getName t1 `compareNames` getName t2
1629 printTyThing :: TyThing -> GHCi ()
1630 printTyThing tyth = do dflags <- getDynFlags
1631 let pefas = dopt Opt_PrintExplicitForalls dflags
1632 printForUser (pprTyThing pefas tyth)
1634 showBkptTable :: GHCi ()
1637 printForUser $ prettyLocations (breaks st)
1639 showContext :: GHCi ()
1641 resumes <- GHC.getResumeContext
1642 printForUser $ vcat (map pp_resume (reverse resumes))
1645 ptext (sLit "--> ") <> text (GHC.resumeStmt resume)
1646 $$ nest 2 (ptext (sLit "Stopped at") <+> ppr (GHC.resumeSpan resume))
1648 showPackages :: GHCi ()
1650 pkg_flags <- fmap packageFlags getDynFlags
1651 io $ putStrLn $ showSDoc $ vcat $
1652 text ("active package flags:"++if null pkg_flags then " none" else "")
1653 : map showFlag pkg_flags
1654 pkg_ids <- fmap (preloadPackages . pkgState) getDynFlags
1655 io $ putStrLn $ showSDoc $ vcat $
1656 text "packages currently loaded:"
1657 : map (nest 2 . text . packageIdString)
1658 (sortBy (compare `on` packageIdFS) pkg_ids)
1659 where showFlag (ExposePackage p) = text $ " -package " ++ p
1660 showFlag (HidePackage p) = text $ " -hide-package " ++ p
1661 showFlag (IgnorePackage p) = text $ " -ignore-package " ++ p
1663 showLanguages :: GHCi ()
1665 dflags <- getDynFlags
1666 io $ putStrLn $ showSDoc $ vcat $
1667 text "active language flags:" :
1668 [text (" -X" ++ str) | (str, f, _) <- DynFlags.xFlags, dopt f dflags]
1670 -- -----------------------------------------------------------------------------
1673 completeNone :: String -> IO [String]
1674 completeNone _w = return []
1676 completeMacro, completeIdentifier, completeModule,
1677 completeHomeModule, completeSetOptions, completeShowOptions,
1678 completeFilename, completeHomeModuleOrFile
1679 :: String -> IO [String]
1682 completeWord :: String -> Int -> Int -> IO (Maybe (String, [String]))
1683 completeWord w start end = do
1684 line <- Readline.getLineBuffer
1685 let line_words = words (dropWhile isSpace line)
1687 ':':_ | all isSpace (take (start-1) line) -> wrapCompleter completeCmd w
1689 | ((':':c) : _) <- line_words -> do
1690 completionVars <- lookupCompletionVars c
1691 case completionVars of
1692 (Nothing,complete) -> wrapCompleter complete w
1693 (Just breakChars,complete)
1694 -> let (n,w') = selectWord
1695 (words' (`elem` breakChars) 0 line)
1696 complete' w = do rets <- complete w
1697 return (map (drop n) rets)
1698 in wrapCompleter complete' w'
1699 | ("import" : _) <- line_words ->
1700 wrapCompleter completeModule w
1702 --printf "complete %s, start = %d, end = %d\n" w start end
1703 wrapCompleter completeIdentifier w
1704 where words' _ _ [] = []
1705 words' isBreak n str = let (w,r) = break isBreak str
1706 (s,r') = span isBreak r
1707 in (n,w):words' isBreak (n+length w+length s) r'
1708 -- In a Haskell expression we want to parse 'a-b' as three words
1709 -- where a compiler flag (e.g. -ddump-simpl) should
1710 -- only be a single word.
1711 selectWord [] = (0,w)
1712 selectWord ((offset,x):xs)
1713 | offset+length x >= start = (start-offset,take (end-offset) x)
1714 | otherwise = selectWord xs
1716 lookupCompletionVars ('!':_) = return (Just filenameWordBreakChars,
1718 lookupCompletionVars c = do
1719 maybe_cmd <- lookupCommand' c
1721 Just (_,_,ws,f) -> return (ws,f)
1722 Nothing -> return (Just filenameWordBreakChars,
1726 completeCmd :: String -> IO [String]
1728 cmds <- readIORef macros_ref
1729 return (filter (w `isPrefixOf`) (map (':':)
1730 (map cmdName (builtin_commands ++ cmds))))
1732 completeMacro w = do
1733 cmds <- readIORef macros_ref
1734 return (filter (w `isPrefixOf`) (map cmdName cmds))
1736 completeIdentifier w = do
1737 rdrs <- withRestoredSession GHC.getRdrNamesInScope
1738 return (filter (w `isPrefixOf`) (map (showSDoc.ppr) rdrs))
1740 completeModule w = do
1741 dflags <- withRestoredSession GHC.getSessionDynFlags
1742 let pkg_mods = allExposedModules dflags
1743 return (filter (w `isPrefixOf`) (map (showSDoc.ppr) pkg_mods))
1745 completeHomeModule w = do
1746 g <- withRestoredSession GHC.getModuleGraph
1747 let home_mods = map GHC.ms_mod_name g
1748 return (filter (w `isPrefixOf`) (map (showSDoc.ppr) home_mods))
1750 completeSetOptions w = do
1751 return (filter (w `isPrefixOf`) options)
1752 where options = "args":"prog":"prompt":"editor":"stop":flagList
1753 flagList = map head $ group $ sort allFlags
1755 completeShowOptions w = do
1756 return (filter (w `isPrefixOf`) options)
1757 where options = ["args", "prog", "prompt", "editor", "stop",
1758 "modules", "bindings", "linker", "breaks",
1759 "context", "packages", "languages"]
1761 completeFilename w = do
1762 ws <- Readline.filenameCompletionFunction w
1764 -- If we only found one result, and it's a directory,
1765 -- add a trailing slash.
1767 isDir <- expandPathIO file >>= doesDirectoryExist
1768 if isDir && last file /= '/'
1769 then return [file ++ "/"]
1774 completeHomeModuleOrFile = unionComplete completeHomeModule completeFilename
1776 unionComplete :: (String -> IO [String]) -> (String -> IO [String]) -> String -> IO [String]
1777 unionComplete f1 f2 w = do
1782 wrapCompleter :: (String -> IO [String]) -> String -> IO (Maybe (String,[String]))
1783 wrapCompleter fun w = do
1786 [] -> Readline.setAttemptedCompletionOver True >> return Nothing
1787 [x] -> -- Add a trailing space, unless it already has an appended slash.
1788 let appended = if last x == '/' then x else x ++ " "
1789 in return (Just (appended,[]))
1790 xs -> case getCommonPrefix xs of
1791 "" -> return (Just ("",xs))
1792 pref -> return (Just (pref,xs))
1794 getCommonPrefix :: [String] -> String
1795 getCommonPrefix [] = ""
1796 getCommonPrefix (s:ss) = foldl common s ss
1797 where common _s "" = ""
1799 common (c:cs) (d:ds)
1800 | c == d = c : common cs ds
1803 allExposedModules :: DynFlags -> [ModuleName]
1804 allExposedModules dflags
1805 = concat (map exposedModules (filter exposed (eltsUFM pkg_db)))
1807 pkg_db = pkgIdMap (pkgState dflags)
1809 completeMacro = completeNone
1810 completeIdentifier = completeNone
1811 completeModule = completeNone
1812 completeHomeModule = completeNone
1813 completeSetOptions = completeNone
1814 completeShowOptions = completeNone
1815 completeFilename = completeNone
1816 completeHomeModuleOrFile=completeNone
1819 -- ---------------------------------------------------------------------------
1820 -- User code exception handling
1822 -- This is the exception handler for exceptions generated by the
1823 -- user's code and exceptions coming from children sessions;
1824 -- it normally just prints out the exception. The
1825 -- handler must be recursive, in case showing the exception causes
1826 -- more exceptions to be raised.
1828 -- Bugfix: if the user closed stdout or stderr, the flushing will fail,
1829 -- raising another exception. We therefore don't put the recursive
1830 -- handler arond the flushing operation, so if stderr is closed
1831 -- GHCi will just die gracefully rather than going into an infinite loop.
1832 handler :: SomeException -> GHCi Bool
1834 handler exception = do
1836 io installSignalHandlers
1837 ghciHandle handler (showException exception >> return False)
1839 showException :: SomeException -> GHCi ()
1841 io $ case fromException se of
1842 Just Interrupted -> putStrLn "Interrupted."
1843 -- omit the location for CmdLineError:
1844 Just (CmdLineError s) -> putStrLn s
1846 Just ph@(PhaseFailed {}) -> putStrLn (showGhcException ph "")
1847 Just other_ghc_ex -> print other_ghc_ex
1848 Nothing -> putStrLn ("*** Exception: " ++ show se)
1850 -----------------------------------------------------------------------------
1851 -- recursive exception handlers
1853 -- Don't forget to unblock async exceptions in the handler, or if we're
1854 -- in an exception loop (eg. let a = error a in a) the ^C exception
1855 -- may never be delivered. Thanks to Marcin for pointing out the bug.
1857 ghciHandle :: (SomeException -> GHCi a) -> GHCi a -> GHCi a
1858 ghciHandle h (GHCi m) = GHCi $ \s ->
1860 (\e -> unGHCi (ghciUnblock (h e)) s)
1862 ghciUnblock :: GHCi a -> GHCi a
1863 ghciUnblock (GHCi a) =
1864 GHCi $ \s -> reifyGhc $ \gs ->
1865 Exception.unblock (reflectGhc (a s) gs)
1867 ghciTry :: GHCi a -> GHCi (Either SomeException a)
1868 ghciTry (GHCi m) = GHCi $ \s -> gtry (m s)
1870 -- ----------------------------------------------------------------------------
1873 expandPath :: String -> GHCi String
1874 expandPath path = io (expandPathIO path)
1876 expandPathIO :: String -> IO String
1878 case dropWhile isSpace path of
1880 tilde <- getHomeDirectory -- will fail if HOME not defined
1881 return (tilde ++ '/':d)
1885 wantInterpretedModule :: String -> GHCi Module
1886 wantInterpretedModule str = do
1887 modl <- lookupModule str
1888 dflags <- getDynFlags
1889 when (GHC.modulePackageId modl /= thisPackage dflags) $
1890 ghcError (CmdLineError ("module '" ++ str ++ "' is from another package;\nthis command requires an interpreted module"))
1891 is_interpreted <- GHC.moduleIsInterpreted modl
1892 when (not is_interpreted) $
1893 ghcError (CmdLineError ("module '" ++ str ++ "' is not interpreted; try \':add *" ++ str ++ "' first"))
1896 wantNameFromInterpretedModule :: (Name -> SDoc -> GHCi ()) -> String
1897 -> (Name -> GHCi ())
1899 wantNameFromInterpretedModule noCanDo str and_then =
1900 handleSourceError (GHC.printExceptionAndWarnings) $ do
1901 names <- GHC.parseName str
1905 let modl = ASSERT( isExternalName n ) GHC.nameModule n
1906 if not (GHC.isExternalName n)
1907 then noCanDo n $ ppr n <>
1908 text " is not defined in an interpreted module"
1910 is_interpreted <- GHC.moduleIsInterpreted modl
1911 if not is_interpreted
1912 then noCanDo n $ text "module " <> ppr modl <>
1913 text " is not interpreted"
1916 -- -----------------------------------------------------------------------------
1917 -- commands for debugger
1919 sprintCmd, printCmd, forceCmd :: String -> GHCi ()
1920 sprintCmd = pprintCommand False False
1921 printCmd = pprintCommand True False
1922 forceCmd = pprintCommand False True
1924 pprintCommand :: Bool -> Bool -> String -> GHCi ()
1925 pprintCommand bind force str = do
1926 pprintClosureCommand bind force str
1928 stepCmd :: String -> GHCi ()
1929 stepCmd [] = doContinue (const True) GHC.SingleStep
1930 stepCmd expression = do runStmt expression GHC.SingleStep; return ()
1932 stepLocalCmd :: String -> GHCi ()
1933 stepLocalCmd [] = do
1934 mb_span <- getCurrentBreakSpan
1936 Nothing -> stepCmd []
1938 Just mod <- getCurrentBreakModule
1939 current_toplevel_decl <- enclosingTickSpan mod loc
1940 doContinue (`isSubspanOf` current_toplevel_decl) GHC.SingleStep
1942 stepLocalCmd expression = stepCmd expression
1944 stepModuleCmd :: String -> GHCi ()
1945 stepModuleCmd [] = do
1946 mb_span <- getCurrentBreakSpan
1948 Nothing -> stepCmd []
1950 Just span <- getCurrentBreakSpan
1951 let f some_span = srcSpanFileName_maybe span == srcSpanFileName_maybe some_span
1952 doContinue f GHC.SingleStep
1954 stepModuleCmd expression = stepCmd expression
1956 -- | Returns the span of the largest tick containing the srcspan given
1957 enclosingTickSpan :: Module -> SrcSpan -> GHCi SrcSpan
1958 enclosingTickSpan mod src = do
1959 ticks <- getTickArray mod
1960 let line = srcSpanStartLine src
1961 ASSERT (inRange (bounds ticks) line) do
1962 let enclosing_spans = [ span | (_,span) <- ticks ! line
1963 , srcSpanEnd span >= srcSpanEnd src]
1964 return . head . sortBy leftmost_largest $ enclosing_spans
1966 traceCmd :: String -> GHCi ()
1967 traceCmd [] = doContinue (const True) GHC.RunAndLogSteps
1968 traceCmd expression = do runStmt expression GHC.RunAndLogSteps; return ()
1970 continueCmd :: String -> GHCi ()
1971 continueCmd = noArgs $ doContinue (const True) GHC.RunToCompletion
1973 -- doContinue :: SingleStep -> GHCi ()
1974 doContinue :: (SrcSpan -> Bool) -> SingleStep -> GHCi ()
1975 doContinue pred step = do
1976 runResult <- resume step
1977 afterRunStmt pred runResult
1980 abandonCmd :: String -> GHCi ()
1981 abandonCmd = noArgs $ do
1982 b <- GHC.abandon -- the prompt will change to indicate the new context
1983 when (not b) $ io $ putStrLn "There is no computation running."
1986 deleteCmd :: String -> GHCi ()
1987 deleteCmd argLine = do
1988 deleteSwitch $ words argLine
1990 deleteSwitch :: [String] -> GHCi ()
1992 io $ putStrLn "The delete command requires at least one argument."
1993 -- delete all break points
1994 deleteSwitch ("*":_rest) = discardActiveBreakPoints
1995 deleteSwitch idents = do
1996 mapM_ deleteOneBreak idents
1998 deleteOneBreak :: String -> GHCi ()
2000 | all isDigit str = deleteBreak (read str)
2001 | otherwise = return ()
2003 historyCmd :: String -> GHCi ()
2005 | null arg = history 20
2006 | all isDigit arg = history (read arg)
2007 | otherwise = io $ putStrLn "Syntax: :history [num]"
2010 resumes <- GHC.getResumeContext
2012 [] -> io $ putStrLn "Not stopped at a breakpoint"
2014 let hist = GHC.resumeHistory r
2015 (took,rest) = splitAt num hist
2017 [] -> io $ putStrLn $
2018 "Empty history. Perhaps you forgot to use :trace?"
2020 spans <- mapM GHC.getHistorySpan took
2021 let nums = map (printf "-%-3d:") [(1::Int)..]
2022 names = map GHC.historyEnclosingDecl took
2023 printForUser (vcat(zipWith3
2024 (\x y z -> x <+> y <+> z)
2026 (map (bold . ppr) names)
2027 (map (parens . ppr) spans)))
2028 io $ putStrLn $ if null rest then "<end of history>" else "..."
2030 bold :: SDoc -> SDoc
2031 bold c | do_bold = text start_bold <> c <> text end_bold
2034 backCmd :: String -> GHCi ()
2035 backCmd = noArgs $ do
2036 (names, _, span) <- GHC.back
2037 printForUser $ ptext (sLit "Logged breakpoint at") <+> ppr span
2038 printTypeOfNames names
2039 -- run the command set with ":set stop <cmd>"
2041 enqueueCommands [stop st]
2043 forwardCmd :: String -> GHCi ()
2044 forwardCmd = noArgs $ do
2045 (names, ix, span) <- GHC.forward
2046 printForUser $ (if (ix == 0)
2047 then ptext (sLit "Stopped at")
2048 else ptext (sLit "Logged breakpoint at")) <+> ppr span
2049 printTypeOfNames names
2050 -- run the command set with ":set stop <cmd>"
2052 enqueueCommands [stop st]
2054 -- handle the "break" command
2055 breakCmd :: String -> GHCi ()
2056 breakCmd argLine = do
2057 breakSwitch $ words argLine
2059 breakSwitch :: [String] -> GHCi ()
2061 io $ putStrLn "The break command requires at least one argument."
2062 breakSwitch (arg1:rest)
2063 | looksLikeModuleName arg1 && not (null rest) = do
2064 mod <- wantInterpretedModule arg1
2065 breakByModule mod rest
2066 | all isDigit arg1 = do
2067 (toplevel, _) <- GHC.getContext
2069 (mod : _) -> breakByModuleLine mod (read arg1) rest
2071 io $ putStrLn "Cannot find default module for breakpoint."
2072 io $ putStrLn "Perhaps no modules are loaded for debugging?"
2073 | otherwise = do -- try parsing it as an identifier
2074 wantNameFromInterpretedModule noCanDo arg1 $ \name -> do
2075 let loc = GHC.srcSpanStart (GHC.nameSrcSpan name)
2076 if GHC.isGoodSrcLoc loc
2077 then ASSERT( isExternalName name )
2078 findBreakAndSet (GHC.nameModule name) $
2079 findBreakByCoord (Just (GHC.srcLocFile loc))
2080 (GHC.srcLocLine loc,
2082 else noCanDo name $ text "can't find its location: " <> ppr loc
2084 noCanDo n why = printForUser $
2085 text "cannot set breakpoint on " <> ppr n <> text ": " <> why
2087 breakByModule :: Module -> [String] -> GHCi ()
2088 breakByModule mod (arg1:rest)
2089 | all isDigit arg1 = do -- looks like a line number
2090 breakByModuleLine mod (read arg1) rest
2094 breakByModuleLine :: Module -> Int -> [String] -> GHCi ()
2095 breakByModuleLine mod line args
2096 | [] <- args = findBreakAndSet mod $ findBreakByLine line
2097 | [col] <- args, all isDigit col =
2098 findBreakAndSet mod $ findBreakByCoord Nothing (line, read col)
2099 | otherwise = breakSyntax
2102 breakSyntax = ghcError (CmdLineError "Syntax: :break [<mod>] <line> [<column>]")
2104 findBreakAndSet :: Module -> (TickArray -> Maybe (Int, SrcSpan)) -> GHCi ()
2105 findBreakAndSet mod lookupTickTree = do
2106 tickArray <- getTickArray mod
2107 (breakArray, _) <- getModBreak mod
2108 case lookupTickTree tickArray of
2109 Nothing -> io $ putStrLn $ "No breakpoints found at that location."
2110 Just (tick, span) -> do
2111 success <- io $ setBreakFlag True breakArray tick
2115 recordBreak $ BreakLocation
2122 text "Breakpoint " <> ppr nm <>
2124 then text " was already set at " <> ppr span
2125 else text " activated at " <> ppr span
2127 printForUser $ text "Breakpoint could not be activated at"
2130 -- When a line number is specified, the current policy for choosing
2131 -- the best breakpoint is this:
2132 -- - the leftmost complete subexpression on the specified line, or
2133 -- - the leftmost subexpression starting on the specified line, or
2134 -- - the rightmost subexpression enclosing the specified line
2136 findBreakByLine :: Int -> TickArray -> Maybe (BreakIndex,SrcSpan)
2137 findBreakByLine line arr
2138 | not (inRange (bounds arr) line) = Nothing
2140 listToMaybe (sortBy (leftmost_largest `on` snd) complete) `mplus`
2141 listToMaybe (sortBy (leftmost_smallest `on` snd) incomplete) `mplus`
2142 listToMaybe (sortBy (rightmost `on` snd) ticks)
2146 starts_here = [ tick | tick@(_,span) <- ticks,
2147 GHC.srcSpanStartLine span == line ]
2149 (complete,incomplete) = partition ends_here starts_here
2150 where ends_here (_,span) = GHC.srcSpanEndLine span == line
2152 findBreakByCoord :: Maybe FastString -> (Int,Int) -> TickArray
2153 -> Maybe (BreakIndex,SrcSpan)
2154 findBreakByCoord mb_file (line, col) arr
2155 | not (inRange (bounds arr) line) = Nothing
2157 listToMaybe (sortBy (rightmost `on` snd) contains ++
2158 sortBy (leftmost_smallest `on` snd) after_here)
2162 -- the ticks that span this coordinate
2163 contains = [ tick | tick@(_,span) <- ticks, span `spans` (line,col),
2164 is_correct_file span ]
2166 is_correct_file span
2167 | Just f <- mb_file = GHC.srcSpanFile span == f
2170 after_here = [ tick | tick@(_,span) <- ticks,
2171 GHC.srcSpanStartLine span == line,
2172 GHC.srcSpanStartCol span >= col ]
2174 -- For now, use ANSI bold on terminals that we know support it.
2175 -- Otherwise, we add a line of carets under the active expression instead.
2176 -- In particular, on Windows and when running the testsuite (which sets
2177 -- TERM to vt100 for other reasons) we get carets.
2178 -- We really ought to use a proper termcap/terminfo library.
2180 do_bold = (`isPrefixOf` unsafePerformIO mTerm) `any` ["xterm", "linux"]
2181 where mTerm = System.Environment.getEnv "TERM"
2182 `catchIO` \_ -> return "TERM not set"
2184 start_bold :: String
2185 start_bold = "\ESC[1m"
2187 end_bold = "\ESC[0m"
2189 listCmd :: String -> GHCi ()
2191 mb_span <- getCurrentBreakSpan
2194 printForUser $ text "Not stopped at a breakpoint; nothing to list"
2196 | GHC.isGoodSrcSpan span -> io $ listAround span True
2198 do resumes <- GHC.getResumeContext
2200 [] -> panic "No resumes"
2202 do let traceIt = case GHC.resumeHistory r of
2203 [] -> text "rerunning with :trace,"
2205 doWhat = traceIt <+> text ":back then :list"
2206 printForUser (text "Unable to list source for" <+>
2208 $$ text "Try" <+> doWhat)
2209 listCmd str = list2 (words str)
2211 list2 :: [String] -> GHCi ()
2212 list2 [arg] | all isDigit arg = do
2213 (toplevel, _) <- GHC.getContext
2215 [] -> io $ putStrLn "No module to list"
2216 (mod : _) -> listModuleLine mod (read arg)
2217 list2 [arg1,arg2] | looksLikeModuleName arg1, all isDigit arg2 = do
2218 mod <- wantInterpretedModule arg1
2219 listModuleLine mod (read arg2)
2221 wantNameFromInterpretedModule noCanDo arg $ \name -> do
2222 let loc = GHC.srcSpanStart (GHC.nameSrcSpan name)
2223 if GHC.isGoodSrcLoc loc
2225 tickArray <- ASSERT( isExternalName name )
2226 getTickArray (GHC.nameModule name)
2227 let mb_span = findBreakByCoord (Just (GHC.srcLocFile loc))
2228 (GHC.srcLocLine loc, GHC.srcLocCol loc)
2231 Nothing -> io $ listAround (GHC.srcLocSpan loc) False
2232 Just (_,span) -> io $ listAround span False
2234 noCanDo name $ text "can't find its location: " <>
2237 noCanDo n why = printForUser $
2238 text "cannot list source code for " <> ppr n <> text ": " <> why
2240 io $ putStrLn "syntax: :list [<line> | <module> <line> | <identifier>]"
2242 listModuleLine :: Module -> Int -> GHCi ()
2243 listModuleLine modl line = do
2244 graph <- GHC.getModuleGraph
2245 let this = filter ((== modl) . GHC.ms_mod) graph
2247 [] -> panic "listModuleLine"
2249 let filename = expectJust "listModuleLine" (ml_hs_file (GHC.ms_location summ))
2250 loc = GHC.mkSrcLoc (mkFastString (filename)) line 0
2251 io $ listAround (GHC.srcLocSpan loc) False
2253 -- | list a section of a source file around a particular SrcSpan.
2254 -- If the highlight flag is True, also highlight the span using
2255 -- start_bold\/end_bold.
2256 listAround :: SrcSpan -> Bool -> IO ()
2257 listAround span do_highlight = do
2258 contents <- BS.readFile (unpackFS file)
2260 lines = BS.split '\n' contents
2261 these_lines = take (line2 - line1 + 1 + pad_before + pad_after) $
2262 drop (line1 - 1 - pad_before) $ lines
2263 fst_line = max 1 (line1 - pad_before)
2264 line_nos = [ fst_line .. ]
2266 highlighted | do_highlight = zipWith highlight line_nos these_lines
2267 | otherwise = [\p -> BS.concat[p,l] | l <- these_lines]
2269 bs_line_nos = [ BS.pack (show l ++ " ") | l <- line_nos ]
2270 prefixed = zipWith ($) highlighted bs_line_nos
2272 BS.putStrLn (BS.intercalate (BS.pack "\n") prefixed)
2274 file = GHC.srcSpanFile span
2275 line1 = GHC.srcSpanStartLine span
2276 col1 = GHC.srcSpanStartCol span
2277 line2 = GHC.srcSpanEndLine span
2278 col2 = GHC.srcSpanEndCol span
2280 pad_before | line1 == 1 = 0
2284 highlight | do_bold = highlight_bold
2285 | otherwise = highlight_carets
2287 highlight_bold no line prefix
2288 | no == line1 && no == line2
2289 = let (a,r) = BS.splitAt col1 line
2290 (b,c) = BS.splitAt (col2-col1) r
2292 BS.concat [prefix, a,BS.pack start_bold,b,BS.pack end_bold,c]
2294 = let (a,b) = BS.splitAt col1 line in
2295 BS.concat [prefix, a, BS.pack start_bold, b]
2297 = let (a,b) = BS.splitAt col2 line in
2298 BS.concat [prefix, a, BS.pack end_bold, b]
2299 | otherwise = BS.concat [prefix, line]
2301 highlight_carets no line prefix
2302 | no == line1 && no == line2
2303 = BS.concat [prefix, line, nl, indent, BS.replicate col1 ' ',
2304 BS.replicate (col2-col1) '^']
2306 = BS.concat [indent, BS.replicate (col1 - 2) ' ', BS.pack "vv", nl,
2309 = BS.concat [prefix, line, nl, indent, BS.replicate col2 ' ',
2311 | otherwise = BS.concat [prefix, line]
2313 indent = BS.pack (" " ++ replicate (length (show no)) ' ')
2314 nl = BS.singleton '\n'
2316 -- --------------------------------------------------------------------------
2319 getTickArray :: Module -> GHCi TickArray
2320 getTickArray modl = do
2322 let arrmap = tickarrays st
2323 case lookupModuleEnv arrmap modl of
2324 Just arr -> return arr
2326 (_breakArray, ticks) <- getModBreak modl
2327 let arr = mkTickArray (assocs ticks)
2328 setGHCiState st{tickarrays = extendModuleEnv arrmap modl arr}
2331 discardTickArrays :: GHCi ()
2332 discardTickArrays = do
2334 setGHCiState st{tickarrays = emptyModuleEnv}
2336 mkTickArray :: [(BreakIndex,SrcSpan)] -> TickArray
2338 = accumArray (flip (:)) [] (1, max_line)
2339 [ (line, (nm,span)) | (nm,span) <- ticks,
2340 line <- srcSpanLines span ]
2342 max_line = foldr max 0 (map GHC.srcSpanEndLine (map snd ticks))
2343 srcSpanLines span = [ GHC.srcSpanStartLine span ..
2344 GHC.srcSpanEndLine span ]
2346 lookupModule :: String -> GHCi Module
2347 lookupModule modName
2348 = GHC.findModule (GHC.mkModuleName modName) Nothing
2350 -- don't reset the counter back to zero?
2351 discardActiveBreakPoints :: GHCi ()
2352 discardActiveBreakPoints = do
2354 mapM (turnOffBreak.snd) (breaks st)
2355 setGHCiState $ st { breaks = [] }
2357 deleteBreak :: Int -> GHCi ()
2358 deleteBreak identity = do
2360 let oldLocations = breaks st
2361 (this,rest) = partition (\loc -> fst loc == identity) oldLocations
2363 then printForUser (text "Breakpoint" <+> ppr identity <+>
2364 text "does not exist")
2366 mapM (turnOffBreak.snd) this
2367 setGHCiState $ st { breaks = rest }
2369 turnOffBreak :: BreakLocation -> GHCi Bool
2370 turnOffBreak loc = do
2371 (arr, _) <- getModBreak (breakModule loc)
2372 io $ setBreakFlag False arr (breakTick loc)
2374 getModBreak :: Module -> GHCi (GHC.BreakArray, Array Int SrcSpan)
2375 getModBreak mod = do
2376 Just mod_info <- GHC.getModuleInfo mod
2377 let modBreaks = GHC.modInfoModBreaks mod_info
2378 let array = GHC.modBreaks_flags modBreaks
2379 let ticks = GHC.modBreaks_locs modBreaks
2380 return (array, ticks)
2382 setBreakFlag :: Bool -> GHC.BreakArray -> Int -> IO Bool
2383 setBreakFlag toggle array index
2384 | toggle = GHC.setBreakOn array index
2385 | otherwise = GHC.setBreakOff array index