1 {-# OPTIONS -fno-cse #-}
2 -- -fno-cse is needed for GLOBAL_VAR's to behave properly
4 {-# OPTIONS_GHC -fno-warn-name-shadowing #-}
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(..),
26 BreakIndex, Resume, SingleStep,
27 Ghc, handleSourceError )
32 -- import PackageConfig
35 import HscTypes ( handleFlagWarnings )
37 import qualified RdrName ( getGRE_NameQualifier_maybes ) -- should this come via GHC?
38 import RdrName (RdrName)
39 import Outputable hiding (printForUser, printForUserPartWay)
40 import Module -- for ModuleEnv
44 -- Other random utilities
47 import BasicTypes hiding (isTopLevel)
48 import Panic hiding (showException)
54 import Maybes ( orElse, expectJust )
59 #ifndef mingw32_HOST_OS
60 import System.Posix hiding (getEnv)
62 import qualified System.Win32
65 import System.Console.Haskeline as Haskeline
66 import qualified System.Console.Haskeline.Encoding as Encoding
67 import Control.Monad.Trans
71 import Exception hiding (catch, block, unblock)
73 -- import Control.Concurrent
75 import System.FilePath
76 import qualified Data.ByteString.Char8 as BS
80 import System.Environment
81 import System.Exit ( exitWith, ExitCode(..) )
82 import System.Directory
84 import System.IO.Error as IO
87 import Control.Monad as Monad
90 import GHC.Exts ( unsafeCoerce# )
92 #if __GLASGOW_HASKELL__ >= 611
93 import GHC.IO.Exception ( IOErrorType(InvalidArgument) )
94 import GHC.IO.Handle ( hFlushAll )
96 import GHC.IOBase ( IOErrorType(InvalidArgument) )
101 import Data.IORef ( IORef, readIORef, writeIORef )
103 -----------------------------------------------------------------------------
105 ghciWelcomeMsg :: String
106 ghciWelcomeMsg = "GHCi, version " ++ cProjectVersion ++
107 ": http://www.haskell.org/ghc/ :? for help"
109 cmdName :: Command -> String
112 GLOBAL_VAR(macros_ref, [], [Command])
114 builtin_commands :: [Command]
116 -- Hugs users are accustomed to :e, so make sure it doesn't overlap
117 ("?", keepGoing help, noCompletion),
118 ("add", keepGoingPaths addModule, completeFilename),
119 ("abandon", keepGoing abandonCmd, noCompletion),
120 ("break", keepGoing breakCmd, completeIdentifier),
121 ("back", keepGoing backCmd, noCompletion),
122 ("browse", keepGoing' (browseCmd False), completeModule),
123 ("browse!", keepGoing' (browseCmd True), completeModule),
124 ("cd", keepGoing' changeDirectory, completeFilename),
125 ("check", keepGoing' checkModule, completeHomeModule),
126 ("continue", keepGoing continueCmd, noCompletion),
127 ("cmd", keepGoing cmdCmd, completeExpression),
128 ("ctags", keepGoing createCTagsWithLineNumbersCmd, completeFilename),
129 ("ctags!", keepGoing createCTagsWithRegExesCmd, completeFilename),
130 ("def", keepGoing (defineMacro False), completeExpression),
131 ("def!", keepGoing (defineMacro True), completeExpression),
132 ("delete", keepGoing deleteCmd, noCompletion),
133 ("edit", keepGoing editFile, completeFilename),
134 ("etags", keepGoing createETagsFileCmd, completeFilename),
135 ("force", keepGoing forceCmd, completeExpression),
136 ("forward", keepGoing forwardCmd, noCompletion),
137 ("help", keepGoing help, noCompletion),
138 ("history", keepGoing historyCmd, noCompletion),
139 ("info", keepGoing' info, completeIdentifier),
140 ("kind", keepGoing' kindOfType, completeIdentifier),
141 ("load", keepGoingPaths loadModule_, completeHomeModuleOrFile),
142 ("list", keepGoing' listCmd, noCompletion),
143 ("module", keepGoing setContext, completeModule),
144 ("main", keepGoing runMain, completeFilename),
145 ("print", keepGoing printCmd, completeExpression),
146 ("quit", quit, noCompletion),
147 ("reload", keepGoing' reloadModule, noCompletion),
148 ("run", keepGoing runRun, completeFilename),
149 ("set", keepGoing setCmd, completeSetOptions),
150 ("show", keepGoing showCmd, completeShowOptions),
151 ("sprint", keepGoing sprintCmd, completeExpression),
152 ("step", keepGoing stepCmd, completeIdentifier),
153 ("steplocal", keepGoing stepLocalCmd, completeIdentifier),
154 ("stepmodule",keepGoing stepModuleCmd, completeIdentifier),
155 ("type", keepGoing' typeOfExpr, completeExpression),
156 ("trace", keepGoing traceCmd, completeExpression),
157 ("undef", keepGoing undefineMacro, completeMacro),
158 ("unset", keepGoing unsetOptions, completeSetOptions)
162 -- We initialize readline (in the interactiveUI function) to use
163 -- word_break_chars as the default set of completion word break characters.
164 -- This can be overridden for a particular command (for example, filename
165 -- expansion shouldn't consider '/' to be a word break) by setting the third
166 -- entry in the Command tuple above.
168 -- NOTE: in order for us to override the default correctly, any custom entry
169 -- must be a SUBSET of word_break_chars.
170 word_break_chars :: String
171 word_break_chars = let symbols = "!#$%&*+/<=>?@\\^|-~"
172 specials = "(),;[]`{}"
174 in spaces ++ specials ++ symbols
176 flagWordBreakChars :: String
177 flagWordBreakChars = " \t\n"
180 keepGoing :: (String -> GHCi ()) -> (String -> InputT GHCi Bool)
181 keepGoing a str = keepGoing' (lift . a) str
183 keepGoing' :: Monad m => (String -> m ()) -> String -> m Bool
184 keepGoing' a str = a str >> return False
186 keepGoingPaths :: ([FilePath] -> InputT GHCi ()) -> (String -> InputT GHCi Bool)
188 = do case toArgs str of
189 Left err -> Encoding.encode err >>= liftIO . BS.hPutStrLn stderr
193 shortHelpText :: String
194 shortHelpText = "use :? for help.\n"
198 " Commands available from the prompt:\n" ++
200 " <statement> evaluate/run <statement>\n" ++
201 " : repeat last command\n" ++
202 " :{\\n ..lines.. \\n:}\\n multiline command\n" ++
203 " :add [*]<module> ... add module(s) to the current target set\n" ++
204 " :browse[!] [[*]<mod>] display the names defined by module <mod>\n" ++
205 " (!: more details; *: all top-level names)\n" ++
206 " :cd <dir> change directory to <dir>\n" ++
207 " :cmd <expr> run the commands returned by <expr>::IO String\n" ++
208 " :ctags[!] [<file>] create tags file for Vi (default: \"tags\")\n" ++
209 " (!: use regex instead of line number)\n" ++
210 " :def <cmd> <expr> define a command :<cmd>\n" ++
211 " :edit <file> edit file\n" ++
212 " :edit edit last module\n" ++
213 " :etags [<file>] create tags file for Emacs (default: \"TAGS\")\n" ++
214 " :help, :? display this list of commands\n" ++
215 " :info [<name> ...] display information about the given names\n" ++
216 " :kind <type> show the kind of <type>\n" ++
217 " :load [*]<module> ... load module(s) and their dependents\n" ++
218 " :main [<arguments> ...] run the main function with the given arguments\n" ++
219 " :module [+/-] [*]<mod> ... set the context for expression evaluation\n" ++
220 " :quit exit GHCi\n" ++
221 " :reload reload the current module set\n" ++
222 " :run function [<arguments> ...] run the function with the given arguments\n" ++
223 " :type <expr> show the type of <expr>\n" ++
224 " :undef <cmd> undefine user-defined command :<cmd>\n" ++
225 " :!<command> run the shell command <command>\n" ++
227 " -- Commands for debugging:\n" ++
229 " :abandon at a breakpoint, abandon current computation\n" ++
230 " :back go back in the history (after :trace)\n" ++
231 " :break [<mod>] <l> [<col>] set a breakpoint at the specified location\n" ++
232 " :break <name> set a breakpoint on the specified function\n" ++
233 " :continue resume after a breakpoint\n" ++
234 " :delete <number> delete the specified breakpoint\n" ++
235 " :delete * delete all breakpoints\n" ++
236 " :force <expr> print <expr>, forcing unevaluated parts\n" ++
237 " :forward go forward in the history (after :back)\n" ++
238 " :history [<n>] after :trace, show the execution history\n" ++
239 " :list show the source code around current breakpoint\n" ++
240 " :list identifier show the source code for <identifier>\n" ++
241 " :list [<module>] <line> show the source code around line number <line>\n" ++
242 " :print [<name> ...] prints a value without forcing its computation\n" ++
243 " :sprint [<name> ...] simplifed version of :print\n" ++
244 " :step single-step after stopping at a breakpoint\n"++
245 " :step <expr> single-step into <expr>\n"++
246 " :steplocal single-step within the current top-level binding\n"++
247 " :stepmodule single-step restricted to the current module\n"++
248 " :trace trace after stopping at a breakpoint\n"++
249 " :trace <expr> evaluate <expr> with tracing on (see :history)\n"++
252 " -- Commands for changing settings:\n" ++
254 " :set <option> ... set options\n" ++
255 " :set args <arg> ... set the arguments returned by System.getArgs\n" ++
256 " :set prog <progname> set the value returned by System.getProgName\n" ++
257 " :set prompt <prompt> set the prompt used in GHCi\n" ++
258 " :set editor <cmd> set the command used for :edit\n" ++
259 " :set stop [<n>] <cmd> set the command to run when a breakpoint is hit\n" ++
260 " :unset <option> ... unset options\n" ++
262 " Options for ':set' and ':unset':\n" ++
264 " +r revert top-level expressions after each evaluation\n" ++
265 " +s print timing/memory stats after each evaluation\n" ++
266 " +t print type after evaluation\n" ++
267 " -<flags> most GHC command line flags can also be set here\n" ++
268 " (eg. -v2, -fglasgow-exts, etc.)\n" ++
269 " for GHCi-specific flags, see User's Guide,\n"++
270 " Flag reference, Interactive-mode options\n" ++
272 " -- Commands for displaying information:\n" ++
274 " :show bindings show the current bindings made at the prompt\n" ++
275 " :show breaks show the active breakpoints\n" ++
276 " :show context show the breakpoint context\n" ++
277 " :show modules show the currently loaded modules\n" ++
278 " :show packages show the currently active package flags\n" ++
279 " :show languages show the currently active language flags\n" ++
280 " :show <setting> show value of <setting>, which is one of\n" ++
281 " [args, prog, prompt, editor, stop]\n" ++
284 findEditor :: IO String
289 win <- System.Win32.getWindowsDirectory
290 return (win </> "notepad.exe")
295 foreign import ccall unsafe "rts_isProfiled" isProfiled :: IO CInt
297 interactiveUI :: [(FilePath, Maybe Phase)] -> Maybe [String]
299 interactiveUI srcs maybe_exprs = do
300 -- although GHCi compiles with -prof, it is not usable: the byte-code
301 -- compiler and interpreter don't work with profiling. So we check for
302 -- this up front and emit a helpful error message (#2197)
303 i <- liftIO $ isProfiled
305 ghcError (InstallationError "GHCi cannot be used when compiled with -prof")
307 -- HACK! If we happen to get into an infinite loop (eg the user
308 -- types 'let x=x in x' at the prompt), then the thread will block
309 -- on a blackhole, and become unreachable during GC. The GC will
310 -- detect that it is unreachable and send it the NonTermination
311 -- exception. However, since the thread is unreachable, everything
312 -- it refers to might be finalized, including the standard Handles.
313 -- This sounds like a bug, but we don't have a good solution right
315 _ <- liftIO $ newStablePtr stdin
316 _ <- liftIO $ newStablePtr stdout
317 _ <- liftIO $ newStablePtr stderr
319 -- Initialise buffering for the *interpreted* I/O system
322 liftIO $ when (isNothing maybe_exprs) $ do
323 -- Only for GHCi (not runghc and ghc -e):
325 -- Turn buffering off for the compiled program's stdout/stderr
327 -- Turn buffering off for GHCi's stdout
329 hSetBuffering stdout NoBuffering
330 -- We don't want the cmd line to buffer any input that might be
331 -- intended for the program, so unbuffer stdin.
332 hSetBuffering stdin NoBuffering
333 #if defined(mingw32_HOST_OS) && __GLASGOW_HASKELL__ >= 611
334 -- On Unix, stdin will use the locale encoding. The IO library
335 -- doesn't do this on Windows (yet), so for now we use UTF-8,
336 -- for consistency with GHC 6.10 and to make the tests work.
337 hSetEncoding stdin utf8
340 -- initial context is just the Prelude
341 prel_mod <- GHC.lookupModule (GHC.mkModuleName "Prelude") Nothing
342 GHC.setContext [] [(prel_mod, Nothing)]
344 default_editor <- liftIO $ findEditor
346 startGHCi (runGHCi srcs maybe_exprs)
347 GHCiState{ progname = "<interactive>",
351 editor = default_editor,
352 -- session = session,
357 tickarrays = emptyModuleEnv,
358 last_command = Nothing,
361 ghc_e = isJust maybe_exprs
366 withGhcAppData :: (FilePath -> IO a) -> IO a -> IO a
367 withGhcAppData right left = do
368 either_dir <- IO.try (getAppUserDataDirectory "ghc")
370 Right dir -> right dir
373 runGHCi :: [(FilePath, Maybe Phase)] -> Maybe [String] -> GHCi ()
374 runGHCi paths maybe_exprs = do
376 read_dot_files = not opt_IgnoreDotGhci
378 current_dir = return (Just ".ghci")
380 app_user_dir = io $ withGhcAppData
381 (\dir -> return (Just (dir </> "ghci.conf")))
385 either_dir <- io $ IO.try (getEnv "HOME")
387 Right home -> return (Just (home </> ".ghci"))
390 canonicalizePath' :: FilePath -> IO (Maybe FilePath)
391 canonicalizePath' fp = liftM Just (canonicalizePath fp)
392 `catchIO` \_ -> return Nothing
394 sourceConfigFile :: FilePath -> GHCi ()
395 sourceConfigFile file = do
396 exists <- io $ doesFileExist file
398 dir_ok <- io $ checkPerms (getDirectory file)
399 file_ok <- io $ checkPerms file
400 when (dir_ok && file_ok) $ do
401 either_hdl <- io $ IO.try (openFile file ReadMode)
404 -- NOTE: this assumes that runInputT won't affect the terminal;
405 -- can we assume this will always be the case?
406 -- This would be a good place for runFileInputT.
407 Right hdl -> runInputTWithPrefs defaultPrefs defaultSettings $ do
408 runCommands $ fileLoop hdl
410 getDirectory f = case takeDirectory f of "" -> "."; d -> d
412 when (read_dot_files) $ do
413 mcfgs0 <- sequence [ current_dir, app_user_dir, home_dir ]
414 mcfgs <- io $ mapM canonicalizePath' (catMaybes mcfgs0)
415 mapM_ sourceConfigFile $ nub $ catMaybes mcfgs
416 -- nub, because we don't want to read .ghci twice if the
419 -- Perform a :load for files given on the GHCi command line
420 -- When in -e mode, if the load fails then we want to stop
421 -- immediately rather than going on to evaluate the expression.
422 when (not (null paths)) $ do
423 ok <- ghciHandle (\e -> do showException e; return Failed) $
424 -- TODO: this is a hack.
425 runInputTWithPrefs defaultPrefs defaultSettings $ do
426 let (filePaths, phases) = unzip paths
427 filePaths' <- mapM (Encoding.decode . BS.pack) filePaths
428 loadModule (zip filePaths' phases)
429 when (isJust maybe_exprs && failed ok) $
430 io (exitWith (ExitFailure 1))
432 -- if verbosity is greater than 0, or we are connected to a
433 -- terminal, display the prompt in the interactive loop.
434 is_tty <- io (hIsTerminalDevice stdin)
435 dflags <- getDynFlags
436 let show_prompt = verbosity dflags > 0 || is_tty
441 -- enter the interactive loop
442 runGHCiInput $ runCommands $ nextInputLine show_prompt is_tty
444 -- just evaluate the expression we were given
445 enqueueCommands exprs
446 let handle e = do st <- getGHCiState
447 -- flush the interpreter's stdout/stderr on exit (#3890)
449 -- Jump through some hoops to get the
450 -- current progname in the exception text:
451 -- <progname>: <exception>
452 io $ withProgName (progname st)
453 -- this used to be topHandlerFastExit, see #2228
455 runInputTWithPrefs defaultPrefs defaultSettings $ do
456 runCommands' handle (return Nothing)
459 io $ do when (verbosity dflags > 0) $ putStrLn "Leaving GHCi."
461 runGHCiInput :: InputT GHCi a -> GHCi a
463 histFile <- io $ withGhcAppData (\dir -> return (Just (dir </> "ghci_history")))
465 let settings = setComplete ghciCompleteWord
466 $ defaultSettings {historyFile = histFile}
469 nextInputLine :: Bool -> Bool -> InputT GHCi (Maybe String)
470 nextInputLine show_prompt is_tty
472 prompt <- if show_prompt then lift mkPrompt else return ""
475 when show_prompt $ lift mkPrompt >>= liftIO . putStr
478 -- NOTE: We only read .ghci files if they are owned by the current user,
479 -- and aren't world writable. Otherwise, we could be accidentally
480 -- running code planted by a malicious third party.
482 -- Furthermore, We only read ./.ghci if . is owned by the current user
483 -- and isn't writable by anyone else. I think this is sufficient: we
484 -- don't need to check .. and ../.. etc. because "." always refers to
485 -- the same directory while a process is running.
487 checkPerms :: String -> IO Bool
488 #ifdef mingw32_HOST_OS
493 handleIO (\_ -> return False) $ do
494 st <- getFileStatus name
496 if fileOwner st /= me then do
497 putStrLn $ "WARNING: " ++ name ++ " is owned by someone else, IGNORING!"
500 let mode = fileMode st
501 if (groupWriteMode == (mode `intersectFileModes` groupWriteMode))
502 || (otherWriteMode == (mode `intersectFileModes` otherWriteMode))
504 putStrLn $ "*** WARNING: " ++ name ++
505 " is writable by someone else, IGNORING!"
510 fileLoop :: MonadIO m => Handle -> InputT m (Maybe String)
512 l <- liftIO $ IO.try $ hGetLine hdl
514 Left e | isEOFError e -> return Nothing
515 | InvalidArgument <- etype -> return Nothing
516 | otherwise -> liftIO $ ioError e
517 where etype = ioeGetErrorType e
518 -- treat InvalidArgument in the same way as EOF:
519 -- this can happen if the user closed stdin, or
520 -- perhaps did getContents which closes stdin at
522 Right l -> return (Just l)
524 mkPrompt :: GHCi String
526 (toplevs,exports) <- GHC.getContext
527 resumes <- GHC.getResumeContext
528 -- st <- getGHCiState
534 let ix = GHC.resumeHistoryIx r
536 then return (brackets (ppr (GHC.resumeSpan r)) <> space)
538 let hist = GHC.resumeHistory r !! (ix-1)
539 span <- GHC.getHistorySpan hist
540 return (brackets (ppr (negate ix) <> char ':'
541 <+> ppr span) <> space)
543 dots | _:rs <- resumes, not (null rs) = text "... "
548 -- let (btoplevs, bexports) = fromMaybe ([],[]) (remembered_ctx st) in
549 -- hsep (map (\m -> text "!*" <> ppr (GHC.moduleName m)) btoplevs) <+>
550 -- hsep (map (\m -> char '!' <> ppr (GHC.moduleName m)) bexports) <+>
551 hsep (map (\m -> char '*' <> ppr (GHC.moduleName m)) toplevs) <+>
552 hsep (map (ppr . GHC.moduleName) (nub (map fst exports)))
554 deflt_prompt = dots <> context_bit <> modules_bit
556 f ('%':'s':xs) = deflt_prompt <> f xs
557 f ('%':'%':xs) = char '%' <> f xs
558 f (x:xs) = char x <> f xs
562 return (showSDoc (f (prompt st)))
565 queryQueue :: GHCi (Maybe String)
570 c:cs -> do setGHCiState st{ cmdqueue = cs }
573 runCommands :: InputT GHCi (Maybe String) -> InputT GHCi ()
574 runCommands = runCommands' handler
576 runCommands' :: (SomeException -> GHCi Bool) -- Exception handler
577 -> InputT GHCi (Maybe String) -> InputT GHCi ()
578 runCommands' eh getCmd = do
579 b <- ghandle (\e -> case fromException e of
580 Just UserInterrupt -> return False
581 _ -> case fromException e of
583 do liftIO (print (ghc_e :: GhcException))
586 liftIO (Exception.throwIO e))
587 (runOneCommand eh getCmd)
588 if b then return () else runCommands' eh getCmd
590 runOneCommand :: (SomeException -> GHCi Bool) -> InputT GHCi (Maybe String)
592 runOneCommand eh getCmd = do
593 mb_cmd <- noSpace (lift queryQueue)
594 mb_cmd <- maybe (noSpace getCmd) (return . Just) mb_cmd
596 Nothing -> return True
597 Just c -> ghciHandle (lift . eh) $
598 handleSourceError printErrorAndKeepGoing
601 printErrorAndKeepGoing err = do
602 GHC.printExceptionAndWarnings err
605 noSpace q = q >>= maybe (return Nothing)
606 (\c->case removeSpaces c of
608 ":{" -> multiLineCmd q
609 c -> return (Just c) )
611 st <- lift getGHCiState
613 lift $ setGHCiState st{ prompt = "%s| " }
614 mb_cmd <- collectCommand q ""
615 lift $ getGHCiState >>= \st->setGHCiState st{ prompt = p }
617 -- we can't use removeSpaces for the sublines here, so
618 -- multiline commands are somewhat more brittle against
619 -- fileformat errors (such as \r in dos input on unix),
620 -- we get rid of any extra spaces for the ":}" test;
621 -- we also avoid silent failure if ":}" is not found;
622 -- and since there is no (?) valid occurrence of \r (as
623 -- opposed to its String representation, "\r") inside a
624 -- ghci command, we replace any such with ' ' (argh:-(
625 collectCommand q c = q >>=
626 maybe (liftIO (ioError collectError))
627 (\l->if removeSpaces l == ":}"
628 then return (Just $ removeSpaces c)
629 else collectCommand q (c ++ "\n" ++ map normSpace l))
630 where normSpace '\r' = ' '
632 -- QUESTION: is userError the one to use here?
633 collectError = userError "unterminated multiline command :{ .. :}"
634 doCommand (':' : cmd) = specialCommand cmd
635 doCommand stmt = do _ <- timeIt $ lift $ runStmt stmt GHC.RunToCompletion
638 enqueueCommands :: [String] -> GHCi ()
639 enqueueCommands cmds = do
641 setGHCiState st{ cmdqueue = cmds ++ cmdqueue st }
644 runStmt :: String -> SingleStep -> GHCi Bool
646 | null (filter (not.isSpace) stmt)
648 | "import " `isPrefixOf` stmt
649 = do newContextCmd (Import stmt); return False
652 #if __GLASGOW_HASKELL__ >= 611
653 -- In the new IO library, read handles buffer data even if the Handle
654 -- is set to NoBuffering. This causes problems for GHCi where there
655 -- are really two stdin Handles. So we flush any bufferred data in
656 -- GHCi's stdin Handle here (only relevant if stdin is attached to
657 -- a file, otherwise the read buffer can't be flushed).
658 _ <- liftIO $ IO.try $ hFlushAll stdin
660 result <- withFlattenedDynflags $ GhciMonad.runStmt stmt step
661 afterRunStmt (const True) result
663 --afterRunStmt :: GHC.RunResult -> GHCi Bool
664 -- False <=> the statement failed to compile
665 afterRunStmt :: (SrcSpan -> Bool) -> GHC.RunResult -> GHCi Bool
666 afterRunStmt _ (GHC.RunException e) = throw e
667 afterRunStmt step_here run_result = do
668 resumes <- GHC.getResumeContext
670 GHC.RunOk names -> do
671 show_types <- isOptionSet ShowType
672 when show_types $ printTypeOfNames names
673 GHC.RunBreak _ names mb_info
674 | isNothing mb_info ||
675 step_here (GHC.resumeSpan $ head resumes) -> do
676 mb_id_loc <- toBreakIdAndLocation mb_info
677 let breakCmd = maybe "" ( \(_,l) -> onBreakCmd l ) mb_id_loc
679 then printStoppedAtBreakInfo (head resumes) names
680 else enqueueCommands [breakCmd]
681 -- run the command set with ":set stop <cmd>"
683 enqueueCommands [stop st]
685 | otherwise -> resume step_here GHC.SingleStep >>=
686 afterRunStmt step_here >> return ()
690 io installSignalHandlers
691 b <- isOptionSet RevertCAFs
694 return (case run_result of GHC.RunOk _ -> True; _ -> False)
696 toBreakIdAndLocation ::
697 Maybe GHC.BreakInfo -> GHCi (Maybe (Int, BreakLocation))
698 toBreakIdAndLocation Nothing = return Nothing
699 toBreakIdAndLocation (Just info) = do
700 let mod = GHC.breakInfo_module info
701 nm = GHC.breakInfo_number info
703 return $ listToMaybe [ id_loc | id_loc@(_,loc) <- breaks st,
704 breakModule loc == mod,
705 breakTick loc == nm ]
707 printStoppedAtBreakInfo :: Resume -> [Name] -> GHCi ()
708 printStoppedAtBreakInfo resume names = do
709 printForUser $ ptext (sLit "Stopped at") <+>
710 ppr (GHC.resumeSpan resume)
711 -- printTypeOfNames session names
712 let namesSorted = sortBy compareNames names
713 tythings <- catMaybes `liftM` mapM GHC.lookupName namesSorted
714 docs <- pprTypeAndContents [id | AnId id <- tythings]
715 printForUserPartWay docs
717 printTypeOfNames :: [Name] -> GHCi ()
718 printTypeOfNames names
719 = mapM_ (printTypeOfName ) $ sortBy compareNames names
721 compareNames :: Name -> Name -> Ordering
722 n1 `compareNames` n2 = compareWith n1 `compare` compareWith n2
723 where compareWith n = (getOccString n, getSrcSpan n)
725 printTypeOfName :: Name -> GHCi ()
727 = do maybe_tything <- GHC.lookupName n
728 case maybe_tything of
730 Just thing -> printTyThing thing
733 data MaybeCommand = GotCommand Command | BadCommand | NoLastCommand
735 specialCommand :: String -> InputT GHCi Bool
736 specialCommand ('!':str) = lift $ shellEscape (dropWhile isSpace str)
737 specialCommand str = do
738 let (cmd,rest) = break isSpace str
739 maybe_cmd <- lift $ lookupCommand cmd
741 GotCommand (_,f,_) -> f (dropWhile isSpace rest)
743 do liftIO $ hPutStr stdout ("unknown command ':" ++ cmd ++ "'\n"
747 do liftIO $ hPutStr stdout ("there is no last command to perform\n"
751 lookupCommand :: String -> GHCi (MaybeCommand)
752 lookupCommand "" = do
754 case last_command st of
755 Just c -> return $ GotCommand c
756 Nothing -> return NoLastCommand
757 lookupCommand str = do
758 mc <- io $ lookupCommand' str
760 setGHCiState st{ last_command = mc }
762 Just c -> GotCommand c
763 Nothing -> BadCommand
765 lookupCommand' :: String -> IO (Maybe Command)
766 lookupCommand' ":" = return Nothing
767 lookupCommand' str' = do
768 macros <- readIORef macros_ref
769 let{ (str, cmds) = case str' of
770 ':' : rest -> (rest, builtin_commands)
771 _ -> (str', macros ++ builtin_commands) }
772 -- look for exact match first, then the first prefix match
773 return $ case [ c | c <- cmds, str == cmdName c ] of
775 [] -> case [ c | c@(s,_,_) <- cmds, str `isPrefixOf` s ] of
779 getCurrentBreakSpan :: GHCi (Maybe SrcSpan)
780 getCurrentBreakSpan = do
781 resumes <- GHC.getResumeContext
785 let ix = GHC.resumeHistoryIx r
787 then return (Just (GHC.resumeSpan r))
789 let hist = GHC.resumeHistory r !! (ix-1)
790 span <- GHC.getHistorySpan hist
793 getCurrentBreakModule :: GHCi (Maybe Module)
794 getCurrentBreakModule = do
795 resumes <- GHC.getResumeContext
799 let ix = GHC.resumeHistoryIx r
801 then return (GHC.breakInfo_module `liftM` GHC.resumeBreakInfo r)
803 let hist = GHC.resumeHistory r !! (ix-1)
804 return $ Just $ GHC.getHistoryModule hist
806 -----------------------------------------------------------------------------
809 noArgs :: GHCi () -> String -> GHCi ()
811 noArgs _ _ = io $ putStrLn "This command takes no arguments"
813 help :: String -> GHCi ()
814 help _ = io (putStr helpText)
816 info :: String -> InputT GHCi ()
817 info "" = ghcError (CmdLineError "syntax: ':i <thing-you-want-info-about>'")
818 info s = handleSourceError GHC.printExceptionAndWarnings $
819 withFlattenedDynflags $ do
820 { let names = words s
821 ; dflags <- getDynFlags
822 ; let pefas = dopt Opt_PrintExplicitForalls dflags
823 ; mapM_ (infoThing pefas) names }
825 infoThing pefas str = do
826 names <- GHC.parseName str
827 mb_stuffs <- mapM GHC.getInfo names
828 let filtered = filterOutChildren (\(t,_f,_i) -> t) (catMaybes mb_stuffs)
829 unqual <- GHC.getPrintUnqual
830 outputStrLn $ showSDocForUser unqual $
831 vcat (intersperse (text "") $
832 map (pprInfo pefas) filtered)
834 -- Filter out names whose parent is also there Good
835 -- example is '[]', which is both a type and data
836 -- constructor in the same type
837 filterOutChildren :: (a -> TyThing) -> [a] -> [a]
838 filterOutChildren get_thing xs
839 = filterOut has_parent xs
841 all_names = mkNameSet (map (getName . get_thing) xs)
842 has_parent x = case pprTyThingParent_maybe (get_thing x) of
843 Just p -> getName p `elemNameSet` all_names
846 pprInfo :: PrintExplicitForalls -> (TyThing, Fixity, [GHC.Instance]) -> SDoc
847 pprInfo pefas (thing, fixity, insts)
848 = pprTyThingInContextLoc pefas thing
849 $$ show_fixity fixity
850 $$ vcat (map GHC.pprInstance insts)
853 | fix == GHC.defaultFixity = empty
854 | otherwise = ppr fix <+> ppr (GHC.getName thing)
856 runMain :: String -> GHCi ()
857 runMain s = case toArgs s of
858 Left err -> io (hPutStrLn stderr err)
860 withFlattenedDynflags $ do
861 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] -> InputT GHCi ()
877 lift revertCAFs -- always revert CAFs on load/add.
878 files <- mapM expandPath files
879 targets <- mapM (\m -> GHC.guessTarget m Nothing) files
880 -- remove old targets with the same id; e.g. for :add *M
881 mapM_ GHC.removeTarget [ tid | Target tid _ _ <- targets ]
882 mapM_ GHC.addTarget targets
883 prev_context <- GHC.getContext
884 ok <- trySuccess $ GHC.load LoadAllTargets
885 afterLoad ok False prev_context
887 changeDirectory :: String -> InputT GHCi ()
888 changeDirectory "" = do
889 -- :cd on its own changes to the user's home directory
890 either_dir <- liftIO $ IO.try getHomeDirectory
893 Right dir -> changeDirectory dir
894 changeDirectory dir = do
895 graph <- GHC.getModuleGraph
896 when (not (null graph)) $
897 outputStr "Warning: changing directory causes all loaded modules to be unloaded,\nbecause the search path has changed.\n"
898 prev_context <- GHC.getContext
900 _ <- GHC.load LoadAllTargets
901 lift $ setContextAfterLoad prev_context False []
902 GHC.workingDirectoryChanged
903 dir <- expandPath dir
904 liftIO $ setCurrentDirectory dir
906 trySuccess :: GHC.GhcMonad m => m SuccessFlag -> m SuccessFlag
908 handleSourceError (\e -> do GHC.printExceptionAndWarnings e
912 editFile :: String -> GHCi ()
914 do file <- if null str then chooseEditFile else return str
918 $ ghcError (CmdLineError "editor not set, use :set editor")
919 _ <- io $ system (cmd ++ ' ':file)
922 -- The user didn't specify a file so we pick one for them.
923 -- Our strategy is to pick the first module that failed to load,
924 -- or otherwise the first target.
926 -- XXX: Can we figure out what happened if the depndecy analysis fails
927 -- (e.g., because the porgrammeer mistyped the name of a module)?
928 -- XXX: Can we figure out the location of an error to pass to the editor?
929 -- XXX: if we could figure out the list of errors that occured during the
930 -- last load/reaload, then we could start the editor focused on the first
932 chooseEditFile :: GHCi String
934 do let hasFailed x = fmap not $ GHC.isLoaded $ GHC.ms_mod_name x
936 graph <- GHC.getModuleGraph
937 failed_graph <- filterM hasFailed graph
938 let order g = flattenSCCs $ GHC.topSortModuleGraph True g Nothing
940 x : _ -> GHC.ml_hs_file (GHC.ms_location x)
943 case pick (order failed_graph) of
944 Just file -> return file
946 do targets <- GHC.getTargets
947 case msum (map fromTarget targets) of
948 Just file -> return file
949 Nothing -> ghcError (CmdLineError "No files to edit.")
951 where fromTarget (GHC.Target (GHC.TargetFile f _) _ _) = Just f
952 fromTarget _ = Nothing -- when would we get a module target?
954 defineMacro :: Bool{-overwrite-} -> String -> GHCi ()
955 defineMacro _ (':':_) =
956 io $ putStrLn "macro name cannot start with a colon"
957 defineMacro overwrite s = do
958 let (macro_name, definition) = break isSpace s
959 macros <- io (readIORef macros_ref)
960 let defined = map cmdName macros
963 then io $ putStrLn "no macros defined"
964 else io $ putStr ("the following macros are defined:\n" ++
967 if (not overwrite && macro_name `elem` defined)
968 then ghcError (CmdLineError
969 ("macro '" ++ macro_name ++ "' is already defined"))
972 let filtered = [ cmd | cmd <- macros, cmdName cmd /= macro_name ]
974 -- give the expression a type signature, so we can be sure we're getting
975 -- something of the right type.
976 let new_expr = '(' : definition ++ ") :: String -> IO String"
978 -- compile the expression
979 handleSourceError (\e -> GHC.printExceptionAndWarnings e) $
980 withFlattenedDynflags $ do
981 hv <- GHC.compileExpr new_expr
982 io (writeIORef macros_ref --
983 (filtered ++ [(macro_name, lift . runMacro hv, noCompletion)]))
985 runMacro :: GHC.HValue{-String -> IO String-} -> String -> GHCi Bool
987 str <- io ((unsafeCoerce# fun :: String -> IO String) s)
988 -- make sure we force any exceptions in the result, while we are still
989 -- inside the exception handler for commands:
990 seqList str (return ())
991 enqueueCommands (lines str)
994 undefineMacro :: String -> GHCi ()
995 undefineMacro str = mapM_ undef (words str)
996 where undef macro_name = do
997 cmds <- io (readIORef macros_ref)
998 if (macro_name `notElem` map cmdName cmds)
999 then ghcError (CmdLineError
1000 ("macro '" ++ macro_name ++ "' is not defined"))
1002 io (writeIORef macros_ref (filter ((/= macro_name) . cmdName) cmds))
1004 cmdCmd :: String -> GHCi ()
1006 let expr = '(' : str ++ ") :: IO String"
1007 handleSourceError (\e -> GHC.printExceptionAndWarnings e) $
1008 withFlattenedDynflags $ do
1009 hv <- GHC.compileExpr expr
1010 cmds <- io $ (unsafeCoerce# hv :: IO String)
1011 enqueueCommands (lines cmds)
1014 loadModuleName :: GHC.GhcMonad m => ImportDecl RdrName -> m Module
1015 loadModuleName = flip GHC.findModule Nothing . unLoc . ideclName
1017 loadModule :: [(FilePath, Maybe Phase)] -> InputT GHCi SuccessFlag
1018 loadModule fs = timeIt (loadModule' fs)
1020 loadModule_ :: [FilePath] -> InputT GHCi ()
1021 loadModule_ fs = loadModule (zip fs (repeat Nothing)) >> return ()
1023 loadModule' :: [(FilePath, Maybe Phase)] -> InputT GHCi SuccessFlag
1024 loadModule' files = do
1025 prev_context <- GHC.getContext
1029 lift discardActiveBreakPoints
1031 _ <- GHC.load LoadAllTargets
1033 let (filenames, phases) = unzip files
1034 exp_filenames <- mapM expandPath filenames
1035 let files' = zip exp_filenames phases
1036 targets <- mapM (uncurry GHC.guessTarget) files'
1038 -- NOTE: we used to do the dependency anal first, so that if it
1039 -- fails we didn't throw away the current set of modules. This would
1040 -- require some re-working of the GHC interface, so we'll leave it
1041 -- as a ToDo for now.
1043 GHC.setTargets targets
1044 doLoad False prev_context LoadAllTargets
1046 checkModule :: String -> InputT GHCi ()
1048 let modl = GHC.mkModuleName m
1049 prev_context <- GHC.getContext
1050 ok <- handleSourceError (\e -> GHC.printExceptionAndWarnings e >> return False) $ do
1051 r <- GHC.typecheckModule =<< GHC.parseModule =<< GHC.getModSummary modl
1052 outputStrLn (showSDoc (
1053 case GHC.moduleInfo r of
1054 cm | Just scope <- GHC.modInfoTopLevelScope cm ->
1056 (local,global) = ASSERT( all isExternalName scope )
1057 partition ((== modl) . GHC.moduleName . GHC.nameModule) scope
1059 (text "global names: " <+> ppr global) $$
1060 (text "local names: " <+> ppr local)
1063 afterLoad (successIf ok) False prev_context
1065 reloadModule :: String -> InputT GHCi ()
1067 prev_context <- GHC.getContext
1068 _ <- doLoad True prev_context $
1069 if null m then LoadAllTargets
1070 else LoadUpTo (GHC.mkModuleName m)
1073 doLoad :: Bool -> ([Module],[(Module, Maybe (ImportDecl RdrName))]) -> LoadHowMuch -> InputT GHCi SuccessFlag
1074 doLoad retain_context prev_context howmuch = do
1075 -- turn off breakpoints before we load: we can't turn them off later, because
1076 -- the ModBreaks will have gone away.
1077 lift discardActiveBreakPoints
1078 ok <- trySuccess $ GHC.load howmuch
1079 afterLoad ok retain_context prev_context
1082 afterLoad :: SuccessFlag -> Bool -> ([Module],[(Module, Maybe (ImportDecl RdrName))]) -> InputT GHCi ()
1083 afterLoad ok retain_context prev_context = do
1084 lift revertCAFs -- always revert CAFs on load.
1085 lift discardTickArrays
1086 loaded_mod_summaries <- getLoadedModules
1087 let loaded_mods = map GHC.ms_mod loaded_mod_summaries
1088 loaded_mod_names = map GHC.moduleName loaded_mods
1089 modulesLoadedMsg ok loaded_mod_names
1091 withFlattenedDynflags $ lift $ setContextAfterLoad prev_context retain_context loaded_mod_summaries
1094 setContextAfterLoad :: ([Module],[(Module, Maybe (ImportDecl RdrName))]) -> Bool -> [GHC.ModSummary] -> GHCi ()
1095 setContextAfterLoad prev keep_ctxt [] = do
1096 prel_mod <- getPrelude
1097 setContextKeepingPackageModules prev keep_ctxt ([], [(prel_mod, Nothing)])
1098 setContextAfterLoad prev keep_ctxt ms = do
1099 -- load a target if one is available, otherwise load the topmost module.
1100 targets <- GHC.getTargets
1101 case [ m | Just m <- map (findTarget ms) targets ] of
1103 let graph' = flattenSCCs (GHC.topSortModuleGraph True ms Nothing) in
1104 load_this (last graph')
1109 = case filter (`matches` t) ms of
1113 summary `matches` Target (TargetModule m) _ _
1114 = GHC.ms_mod_name summary == m
1115 summary `matches` Target (TargetFile f _) _ _
1116 | Just f' <- GHC.ml_hs_file (GHC.ms_location summary) = f == f'
1120 load_this summary | m <- GHC.ms_mod summary = do
1121 b <- GHC.moduleIsInterpreted m
1122 if b then setContextKeepingPackageModules prev keep_ctxt ([m], [])
1124 prel_mod <- getPrelude
1125 setContextKeepingPackageModules prev keep_ctxt ([],[(prel_mod,Nothing),(m,Nothing)])
1127 -- | Keep any package modules (except Prelude) when changing the context.
1128 setContextKeepingPackageModules
1129 :: ([Module],[(Module, Maybe (ImportDecl RdrName))]) -- previous context
1130 -> Bool -- re-execute :module commands
1131 -> ([Module],[(Module, Maybe (ImportDecl RdrName))]) -- new context
1133 setContextKeepingPackageModules prev_context keep_ctxt (as,bs) = do
1134 let (_,bs0) = prev_context
1135 prel_mod <- getPrelude
1136 -- filter everything, not just lefts
1137 let pkg_modules = filter ((\p -> not (isHomeModule p) && p /= prel_mod) . fst) bs0
1138 let bs1 = if null as then nubBy sameFst ((prel_mod,Nothing) : bs) else bs
1139 GHC.setContext as (nubBy sameFst (bs1 ++ pkg_modules))
1143 mapM_ (playCtxtCmd False) (remembered_ctx st)
1146 setGHCiState st{ remembered_ctx = [] }
1148 isHomeModule :: Module -> Bool
1149 isHomeModule mod = GHC.modulePackageId mod == mainPackageId
1151 sameFst :: (Module, Maybe (ImportDecl RdrName)) -> (Module, Maybe (ImportDecl RdrName)) -> Bool
1152 sameFst x y = fst x == fst y
1154 modulesLoadedMsg :: SuccessFlag -> [ModuleName] -> InputT GHCi ()
1155 modulesLoadedMsg ok mods = do
1156 dflags <- getDynFlags
1157 when (verbosity dflags > 0) $ do
1159 | null mods = text "none."
1160 | otherwise = hsep (
1161 punctuate comma (map ppr mods)) <> text "."
1164 outputStrLn (showSDoc (text "Failed, modules loaded: " <> mod_commas))
1166 outputStrLn (showSDoc (text "Ok, modules loaded: " <> mod_commas))
1169 typeOfExpr :: String -> InputT GHCi ()
1171 = handleSourceError (\e -> GHC.printExceptionAndWarnings e)
1172 $ withFlattenedDynflags
1174 ty <- GHC.exprType str
1175 dflags <- getDynFlags
1176 let pefas = dopt Opt_PrintExplicitForalls dflags
1177 printForUser $ sep [text str, nest 2 (dcolon <+> pprTypeForUser pefas ty)]
1179 kindOfType :: String -> InputT GHCi ()
1181 = handleSourceError (\e -> GHC.printExceptionAndWarnings e)
1182 $ withFlattenedDynflags
1184 ty <- GHC.typeKind str
1185 printForUser $ text str <+> dcolon <+> ppr ty
1187 quit :: String -> InputT GHCi Bool
1188 quit _ = return True
1190 shellEscape :: String -> GHCi Bool
1191 shellEscape str = io (system str >> return False)
1193 withFlattenedDynflags :: GHC.GhcMonad m => m a -> m a
1194 withFlattenedDynflags m
1195 = do dflags <- GHC.getSessionDynFlags
1196 gbracket (GHC.setSessionDynFlags (ensureFlattenedExtensionFlags dflags))
1197 (\_ -> GHC.setSessionDynFlags dflags)
1200 -----------------------------------------------------------------------------
1201 -- Browsing a module's contents
1203 browseCmd :: Bool -> String -> InputT GHCi ()
1206 ['*':s] | looksLikeModuleName s -> do
1207 m <- lift $ wantInterpretedModule s
1208 browseModule bang m False
1209 [s] | looksLikeModuleName s -> do
1210 m <- lift $ lookupModule s
1211 browseModule bang m True
1213 (as,bs) <- GHC.getContext
1214 -- Guess which module the user wants to browse. Pick
1215 -- modules that are interpreted first. The most
1216 -- recently-added module occurs last, it seems.
1218 (as@(_:_), _) -> browseModule bang (last as) True
1219 ([], bs@(_:_)) -> browseModule bang (fst (last bs)) True
1220 ([], []) -> ghcError (CmdLineError ":browse: no current module")
1221 _ -> ghcError (CmdLineError "syntax: :browse <module>")
1223 -- without bang, show items in context of their parents and omit children
1224 -- with bang, show class methods and data constructors separately, and
1225 -- indicate import modules, to aid qualifying unqualified names
1226 -- with sorted, sort items alphabetically
1227 browseModule :: Bool -> Module -> Bool -> InputT GHCi ()
1228 browseModule bang modl exports_only = withFlattenedDynflags $ do
1229 -- :browse! reports qualifiers wrt current context
1230 current_unqual <- GHC.getPrintUnqual
1231 -- Temporarily set the context to the module we're interested in,
1232 -- just so we can get an appropriate PrintUnqualified
1233 (as,bs) <- GHC.getContext
1234 prel_mod <- lift getPrelude
1235 if exports_only then GHC.setContext [] [(prel_mod,Nothing), (modl,Nothing)]
1236 else GHC.setContext [modl] []
1237 target_unqual <- GHC.getPrintUnqual
1238 GHC.setContext as bs
1240 let unqual = if bang then current_unqual else target_unqual
1242 mb_mod_info <- GHC.getModuleInfo modl
1244 Nothing -> ghcError (CmdLineError ("unknown module: " ++
1245 GHC.moduleNameString (GHC.moduleName modl)))
1247 dflags <- getDynFlags
1249 | exports_only = GHC.modInfoExports mod_info
1250 | otherwise = GHC.modInfoTopLevelScope mod_info
1253 -- sort alphabetically name, but putting
1254 -- locally-defined identifiers first.
1255 -- We would like to improve this; see #1799.
1256 sorted_names = loc_sort local ++ occ_sort external
1258 (local,external) = ASSERT( all isExternalName names )
1259 partition ((==modl) . nameModule) names
1260 occ_sort = sortBy (compare `on` nameOccName)
1261 -- try to sort by src location. If the first name in
1262 -- our list has a good source location, then they all should.
1264 | n:_ <- names, isGoodSrcSpan (nameSrcSpan n)
1265 = sortBy (compare `on` nameSrcSpan) names
1269 mb_things <- mapM GHC.lookupName sorted_names
1270 let filtered_things = filterOutChildren (\t -> t) (catMaybes mb_things)
1272 rdr_env <- GHC.getGRE
1274 let pefas = dopt Opt_PrintExplicitForalls dflags
1275 things | bang = catMaybes mb_things
1276 | otherwise = filtered_things
1277 pretty | bang = pprTyThing
1278 | otherwise = pprTyThingInContext
1280 labels [] = text "-- not currently imported"
1281 labels l = text $ intercalate "\n" $ map qualifier l
1282 qualifier = maybe "-- defined locally"
1283 (("-- imported via "++) . intercalate ", "
1284 . map GHC.moduleNameString)
1285 importInfo = RdrName.getGRE_NameQualifier_maybes rdr_env
1286 modNames = map (importInfo . GHC.getName) things
1288 -- annotate groups of imports with their import modules
1289 -- the default ordering is somewhat arbitrary, so we group
1290 -- by header and sort groups; the names themselves should
1291 -- really come in order of source appearance.. (trac #1799)
1292 annotate mts = concatMap (\(m,ts)->labels m:ts)
1293 $ sortBy cmpQualifiers $ group mts
1294 where cmpQualifiers =
1295 compare `on` (map (fmap (map moduleNameFS)) . fst)
1297 group mts@((m,_):_) = (m,map snd g) : group ng
1298 where (g,ng) = partition ((==m).fst) mts
1300 let prettyThings = map (pretty pefas) things
1301 prettyThings' | bang = annotate $ zip modNames prettyThings
1302 | otherwise = prettyThings
1303 outputStrLn $ showSDocForUser unqual (vcat prettyThings')
1304 -- ToDo: modInfoInstances currently throws an exception for
1305 -- package modules. When it works, we can do this:
1306 -- $$ vcat (map GHC.pprInstance (GHC.modInfoInstances mod_info))
1308 -----------------------------------------------------------------------------
1309 -- Setting the module context
1311 newContextCmd :: CtxtCmd -> GHCi ()
1312 newContextCmd cmd = do
1313 playCtxtCmd True cmd
1315 let cmds = remembered_ctx st
1316 setGHCiState st{ remembered_ctx = cmds ++ [cmd] }
1318 setContext :: String -> GHCi ()
1320 | all sensible strs = newContextCmd cmd
1321 | otherwise = ghcError (CmdLineError "syntax: :module [+/-] [*]M1 ... [*]Mn")
1325 '+':stuff -> rest AddModules stuff
1326 '-':stuff -> rest RemModules stuff
1327 stuff -> rest SetContext stuff
1329 rest cmd stuff = (cmd as bs, strs)
1330 where strs = words stuff
1331 (as,bs) = partitionWith starred strs
1333 sensible ('*':m) = looksLikeModuleName m
1334 sensible m = looksLikeModuleName m
1336 starred ('*':m) = Left m
1339 playCtxtCmd:: Bool -> CtxtCmd -> GHCi ()
1340 playCtxtCmd fail cmd = do
1341 withFlattenedDynflags $ do
1342 (prev_as,prev_bs) <- GHC.getContext
1344 SetContext as bs -> do
1345 (as',bs') <- do_checks as bs
1346 prel_mod <- getPrelude
1347 let bs'' = if null as && prel_mod `notElem` (map fst bs')
1348 then (prel_mod,Nothing):bs'
1350 GHC.setContext as' bs''
1352 AddModules as bs -> do
1353 (as',bs') <- do_checks as bs
1354 -- it should replace the old stuff, not the other way around
1355 -- need deleteAllBy, not deleteFirstsBy for sameFst
1356 let remaining_as = prev_as \\ (as' ++ map fst bs')
1357 remaining_bs = deleteAllBy sameFst prev_bs (bs' ++ map contextualize as')
1358 GHC.setContext (remaining_as ++ as') (remaining_bs ++ bs')
1360 RemModules as bs -> do
1361 (as',bs') <- do_checks as bs
1362 let new_as = prev_as \\ (as' ++ map fst bs')
1363 new_bs = deleteAllBy sameFst prev_bs (map contextualize as' ++ bs')
1364 GHC.setContext new_as new_bs
1367 m_idecl <- maybe_fail $ GHC.parseImportDecl str
1369 Nothing -> return ()
1371 m_mdl <- maybe_fail $ loadModuleName idecl
1373 Nothing -> return ()
1374 Just m -> GHC.setContext prev_as (prev_bs ++ [(m, Just idecl)])
1377 maybe_fail | fail = liftM Just
1378 | otherwise = trymaybe
1380 do_checks as bs = do
1381 as' <- mapM (maybe_fail . wantInterpretedModule) as
1382 bs' <- mapM (maybe_fail . lookupModule) bs
1383 return (catMaybes as', map contextualize (catMaybes bs'))
1385 contextualize x = (x,Nothing)
1386 deleteAllBy f a b = filter (\x->(not (any (f x) b))) a
1388 trymaybe ::GHCi a -> GHCi (Maybe a)
1392 Left _ -> return Nothing
1393 Right a -> return (Just a)
1395 ----------------------------------------------------------------------------
1398 -- set options in the interpreter. Syntax is exactly the same as the
1399 -- ghc command line, except that certain options aren't available (-C,
1402 -- This is pretty fragile: most options won't work as expected. ToDo:
1403 -- figure out which ones & disallow them.
1405 setCmd :: String -> GHCi ()
1407 = do st <- getGHCiState
1408 let opts = options st
1409 io $ putStrLn (showSDoc (
1410 text "options currently set: " <>
1413 else hsep (map (\o -> char '+' <> text (optToStr o)) opts)
1415 dflags <- getDynFlags
1416 io $ putStrLn (showSDoc (
1417 vcat (text "GHCi-specific dynamic flag settings:"
1418 :map (flagSetting dflags) ghciFlags)
1420 io $ putStrLn (showSDoc (
1421 vcat (text "other dynamic, non-language, flag settings:"
1422 :map (flagSetting dflags) others)
1424 where flagSetting dflags (str, f, _)
1425 | dopt f dflags = text " " <> text "-f" <> text str
1426 | otherwise = text " " <> text "-fno-" <> text str
1427 (ghciFlags,others) = partition (\(_, f, _) -> f `elem` flags)
1429 flags = [Opt_PrintExplicitForalls
1430 ,Opt_PrintBindResult
1431 ,Opt_BreakOnException
1433 ,Opt_PrintEvldWithShow
1436 = case getCmd str of
1437 Right ("args", rest) ->
1439 Left err -> io (hPutStrLn stderr err)
1440 Right args -> setArgs args
1441 Right ("prog", rest) ->
1443 Right [prog] -> setProg prog
1444 _ -> io (hPutStrLn stderr "syntax: :set prog <progname>")
1445 Right ("prompt", rest) -> setPrompt $ dropWhile isSpace rest
1446 Right ("editor", rest) -> setEditor $ dropWhile isSpace rest
1447 Right ("stop", rest) -> setStop $ dropWhile isSpace rest
1448 _ -> case toArgs str of
1449 Left err -> io (hPutStrLn stderr err)
1450 Right wds -> setOptions wds
1452 setArgs, setOptions :: [String] -> GHCi ()
1453 setProg, setEditor, setStop, setPrompt :: String -> GHCi ()
1457 setGHCiState st{ args = args }
1461 setGHCiState st{ progname = prog }
1465 setGHCiState st{ editor = cmd }
1467 setStop str@(c:_) | isDigit c
1468 = do let (nm_str,rest) = break (not.isDigit) str
1471 let old_breaks = breaks st
1472 if all ((/= nm) . fst) old_breaks
1473 then printForUser (text "Breakpoint" <+> ppr nm <+>
1474 text "does not exist")
1476 let new_breaks = map fn old_breaks
1477 fn (i,loc) | i == nm = (i,loc { onBreakCmd = dropWhile isSpace rest })
1478 | otherwise = (i,loc)
1479 setGHCiState st{ breaks = new_breaks }
1482 setGHCiState st{ stop = cmd }
1484 setPrompt value = do
1487 then io $ hPutStrLn stderr $ "syntax: :set prompt <prompt>, currently \"" ++ prompt st ++ "\""
1489 '\"' : _ -> case reads value of
1490 [(value', xs)] | all isSpace xs ->
1491 setGHCiState (st { prompt = value' })
1493 io $ hPutStrLn stderr "Can't parse prompt string. Use Haskell syntax."
1494 _ -> setGHCiState (st { prompt = value })
1497 do -- first, deal with the GHCi opts (+s, +t, etc.)
1498 let (plus_opts, minus_opts) = partitionWith isPlus wds
1499 mapM_ setOpt plus_opts
1500 -- then, dynamic flags
1501 newDynFlags minus_opts
1503 newDynFlags :: [String] -> GHCi ()
1504 newDynFlags minus_opts = do
1505 dflags <- getDynFlags
1506 let pkg_flags = packageFlags dflags
1507 (dflags', leftovers, warns) <- io $ GHC.parseDynamicFlags dflags $ map noLoc minus_opts
1508 handleFlagWarnings dflags' warns
1510 if (not (null leftovers))
1511 then ghcError $ errorsToGhcException leftovers
1514 new_pkgs <- setDynFlags dflags'
1516 -- if the package flags changed, we should reset the context
1517 -- and link the new packages.
1518 dflags <- getDynFlags
1519 when (packageFlags dflags /= pkg_flags) $ do
1520 io $ hPutStrLn stderr "package flags have changed, resetting and loading new packages..."
1522 _ <- GHC.load LoadAllTargets
1523 io (linkPackages dflags new_pkgs)
1524 -- package flags changed, we can't re-use any of the old context
1525 setContextAfterLoad ([],[]) False []
1529 unsetOptions :: String -> GHCi ()
1531 = do -- first, deal with the GHCi opts (+s, +t, etc.)
1532 let opts = words str
1533 (minus_opts, rest1) = partition isMinus opts
1534 (plus_opts, rest2) = partitionWith isPlus rest1
1536 if (not (null rest2))
1537 then io (putStrLn ("unknown option: '" ++ head rest2 ++ "'"))
1540 mapM_ unsetOpt plus_opts
1542 let no_flag ('-':'f':rest) = return ("-fno-" ++ rest)
1543 no_flag f = ghcError (ProgramError ("don't know how to reverse " ++ f))
1545 no_flags <- mapM no_flag minus_opts
1546 newDynFlags no_flags
1548 isMinus :: String -> Bool
1549 isMinus ('-':_) = True
1552 isPlus :: String -> Either String String
1553 isPlus ('+':opt) = Left opt
1554 isPlus other = Right other
1556 setOpt, unsetOpt :: String -> GHCi ()
1559 = case strToGHCiOpt str of
1560 Nothing -> io (putStrLn ("unknown option: '" ++ str ++ "'"))
1561 Just o -> setOption o
1564 = case strToGHCiOpt str of
1565 Nothing -> io (putStrLn ("unknown option: '" ++ str ++ "'"))
1566 Just o -> unsetOption o
1568 strToGHCiOpt :: String -> (Maybe GHCiOption)
1569 strToGHCiOpt "s" = Just ShowTiming
1570 strToGHCiOpt "t" = Just ShowType
1571 strToGHCiOpt "r" = Just RevertCAFs
1572 strToGHCiOpt _ = Nothing
1574 optToStr :: GHCiOption -> String
1575 optToStr ShowTiming = "s"
1576 optToStr ShowType = "t"
1577 optToStr RevertCAFs = "r"
1579 -- ---------------------------------------------------------------------------
1582 showCmd :: String -> GHCi ()
1583 showCmd str = withFlattenedDynflags $ do
1586 ["args"] -> io $ putStrLn (show (args st))
1587 ["prog"] -> io $ putStrLn (show (progname st))
1588 ["prompt"] -> io $ putStrLn (show (prompt st))
1589 ["editor"] -> io $ putStrLn (show (editor st))
1590 ["stop"] -> io $ putStrLn (show (stop st))
1591 ["modules" ] -> showModules
1592 ["bindings"] -> showBindings
1593 ["linker"] -> io showLinkerState
1594 ["breaks"] -> showBkptTable
1595 ["context"] -> showContext
1596 ["packages"] -> showPackages
1597 ["languages"] -> showLanguages
1598 _ -> ghcError (CmdLineError ("syntax: :show [ args | prog | prompt | editor | stop | modules | bindings\n"++
1599 " | breaks | context | packages | languages ]"))
1601 showModules :: GHCi ()
1603 loaded_mods <- getLoadedModules
1604 -- we want *loaded* modules only, see #1734
1605 let show_one ms = do m <- GHC.showModule ms; io (putStrLn m)
1606 mapM_ show_one loaded_mods
1608 getLoadedModules :: GHC.GhcMonad m => m [GHC.ModSummary]
1609 getLoadedModules = do
1610 graph <- GHC.getModuleGraph
1611 filterM (GHC.isLoaded . GHC.ms_mod_name) graph
1613 showBindings :: GHCi ()
1615 bindings <- GHC.getBindings
1616 docs <- pprTypeAndContents
1617 [ id | AnId id <- sortBy compareTyThings bindings]
1618 printForUserPartWay docs
1620 compareTyThings :: TyThing -> TyThing -> Ordering
1621 t1 `compareTyThings` t2 = getName t1 `compareNames` getName t2
1623 printTyThing :: TyThing -> GHCi ()
1624 printTyThing tyth = do dflags <- getDynFlags
1625 let pefas = dopt Opt_PrintExplicitForalls dflags
1626 printForUser (pprTyThing pefas tyth)
1628 showBkptTable :: GHCi ()
1631 printForUser $ prettyLocations (breaks st)
1633 showContext :: GHCi ()
1635 resumes <- GHC.getResumeContext
1636 printForUser $ vcat (map pp_resume (reverse resumes))
1639 ptext (sLit "--> ") <> text (GHC.resumeStmt resume)
1640 $$ nest 2 (ptext (sLit "Stopped at") <+> ppr (GHC.resumeSpan resume))
1642 showPackages :: GHCi ()
1644 pkg_flags <- fmap packageFlags getDynFlags
1645 io $ putStrLn $ showSDoc $ vcat $
1646 text ("active package flags:"++if null pkg_flags then " none" else "")
1647 : map showFlag pkg_flags
1648 pkg_ids <- fmap (preloadPackages . pkgState) getDynFlags
1649 io $ putStrLn $ showSDoc $ vcat $
1650 text "packages currently loaded:"
1651 : map (nest 2 . text . packageIdString)
1652 (sortBy (compare `on` packageIdFS) pkg_ids)
1653 where showFlag (ExposePackage p) = text $ " -package " ++ p
1654 showFlag (HidePackage p) = text $ " -hide-package " ++ p
1655 showFlag (IgnorePackage p) = text $ " -ignore-package " ++ p
1656 showFlag (ExposePackageId p) = text $ " -package-id " ++ p
1658 showLanguages :: GHCi ()
1660 dflags <- getDynFlags
1661 io $ putStrLn $ showSDoc $ vcat $
1662 text "active language flags:" :
1663 [text (" -X" ++ str) | (str, f, _) <- DynFlags.xFlags, dopt f dflags]
1665 -- -----------------------------------------------------------------------------
1668 completeCmd, completeMacro, completeIdentifier, completeModule,
1669 completeHomeModule, completeSetOptions, completeShowOptions,
1670 completeHomeModuleOrFile, completeExpression
1671 :: CompletionFunc GHCi
1673 ghciCompleteWord :: CompletionFunc GHCi
1674 ghciCompleteWord line@(left,_) = case firstWord of
1675 ':':cmd | null rest -> completeCmd line
1677 completion <- lookupCompletion cmd
1679 "import" -> completeModule line
1680 _ -> completeExpression line
1682 (firstWord,rest) = break isSpace $ dropWhile isSpace $ reverse left
1683 lookupCompletion ('!':_) = return completeFilename
1684 lookupCompletion c = do
1685 maybe_cmd <- liftIO $ lookupCommand' c
1687 Just (_,_,f) -> return f
1688 Nothing -> return completeFilename
1690 completeCmd = wrapCompleter " " $ \w -> do
1691 macros <- liftIO $ readIORef macros_ref
1692 let macro_names = map (':':) . map cmdName $ macros
1693 let command_names = map (':':) . map cmdName $ builtin_commands
1694 let{ candidates = case w of
1695 ':' : ':' : _ -> map (':':) command_names
1696 _ -> nub $ macro_names ++ command_names }
1697 return $ filter (w `isPrefixOf`) candidates
1699 completeMacro = wrapIdentCompleter $ \w -> do
1700 cmds <- liftIO $ readIORef macros_ref
1701 return (filter (w `isPrefixOf`) (map cmdName cmds))
1703 completeIdentifier = wrapIdentCompleter $ \w -> do
1704 rdrs <- GHC.getRdrNamesInScope
1705 return (filter (w `isPrefixOf`) (map (showSDoc.ppr) rdrs))
1707 completeModule = wrapIdentCompleter $ \w -> do
1708 dflags <- GHC.getSessionDynFlags
1709 let pkg_mods = allExposedModules dflags
1710 loaded_mods <- liftM (map GHC.ms_mod_name) getLoadedModules
1711 return $ filter (w `isPrefixOf`)
1712 $ map (showSDoc.ppr) $ loaded_mods ++ pkg_mods
1714 completeHomeModule = wrapIdentCompleter listHomeModules
1716 listHomeModules :: String -> GHCi [String]
1717 listHomeModules w = do
1718 g <- GHC.getModuleGraph
1719 let home_mods = map GHC.ms_mod_name g
1720 return $ sort $ filter (w `isPrefixOf`)
1721 $ map (showSDoc.ppr) home_mods
1723 completeSetOptions = wrapCompleter flagWordBreakChars $ \w -> do
1724 return (filter (w `isPrefixOf`) options)
1725 where options = "args":"prog":"prompt":"editor":"stop":flagList
1726 flagList = map head $ group $ sort allFlags
1728 completeShowOptions = wrapCompleter flagWordBreakChars $ \w -> do
1729 return (filter (w `isPrefixOf`) options)
1730 where options = ["args", "prog", "prompt", "editor", "stop",
1731 "modules", "bindings", "linker", "breaks",
1732 "context", "packages", "languages"]
1734 completeHomeModuleOrFile = completeWord Nothing filenameWordBreakChars
1735 $ unionComplete (fmap (map simpleCompletion) . listHomeModules)
1738 unionComplete :: Monad m => (a -> m [b]) -> (a -> m [b]) -> a -> m [b]
1739 unionComplete f1 f2 line = do
1744 wrapCompleter :: String -> (String -> GHCi [String]) -> CompletionFunc GHCi
1745 wrapCompleter breakChars fun = completeWord Nothing breakChars
1746 $ fmap (map simpleCompletion) . fmap sort . fun
1748 wrapIdentCompleter :: (String -> GHCi [String]) -> CompletionFunc GHCi
1749 wrapIdentCompleter = wrapCompleter word_break_chars
1751 allExposedModules :: DynFlags -> [ModuleName]
1752 allExposedModules dflags
1753 = concat (map exposedModules (filter exposed (eltsUFM pkg_db)))
1755 pkg_db = pkgIdMap (pkgState dflags)
1757 completeExpression = completeQuotedWord (Just '\\') "\"" listFiles
1760 -- ---------------------------------------------------------------------------
1761 -- User code exception handling
1763 -- This is the exception handler for exceptions generated by the
1764 -- user's code and exceptions coming from children sessions;
1765 -- it normally just prints out the exception. The
1766 -- handler must be recursive, in case showing the exception causes
1767 -- more exceptions to be raised.
1769 -- Bugfix: if the user closed stdout or stderr, the flushing will fail,
1770 -- raising another exception. We therefore don't put the recursive
1771 -- handler arond the flushing operation, so if stderr is closed
1772 -- GHCi will just die gracefully rather than going into an infinite loop.
1773 handler :: SomeException -> GHCi Bool
1775 handler exception = do
1777 io installSignalHandlers
1778 ghciHandle handler (showException exception >> return False)
1780 showException :: SomeException -> GHCi ()
1782 io $ case fromException se of
1783 -- omit the location for CmdLineError:
1784 Just (CmdLineError s) -> putStrLn s
1786 Just ph@(PhaseFailed {}) -> putStrLn (showGhcException ph "")
1787 Just other_ghc_ex -> print other_ghc_ex
1789 case fromException se of
1790 Just UserInterrupt -> putStrLn "Interrupted."
1791 _other -> putStrLn ("*** Exception: " ++ show se)
1793 -----------------------------------------------------------------------------
1794 -- recursive exception handlers
1796 -- Don't forget to unblock async exceptions in the handler, or if we're
1797 -- in an exception loop (eg. let a = error a in a) the ^C exception
1798 -- may never be delivered. Thanks to Marcin for pointing out the bug.
1800 ghciHandle :: MonadException m => (SomeException -> m a) -> m a -> m a
1801 ghciHandle h m = Haskeline.catch m $ \e -> unblock (h e)
1803 ghciTry :: GHCi a -> GHCi (Either SomeException a)
1804 ghciTry (GHCi m) = GHCi $ \s -> gtry (m s)
1806 -- ----------------------------------------------------------------------------
1809 -- TODO: won't work if home dir is encoded.
1810 -- (changeDirectory may not work either in that case.)
1811 expandPath :: MonadIO m => String -> InputT m String
1812 expandPath path = do
1813 exp_path <- liftIO $ expandPathIO path
1814 enc <- fmap BS.unpack $ Encoding.encode exp_path
1817 expandPathIO :: String -> IO String
1819 case dropWhile isSpace path of
1821 tilde <- getHomeDirectory -- will fail if HOME not defined
1822 return (tilde ++ '/':d)
1826 wantInterpretedModule :: GHC.GhcMonad m => String -> m Module
1827 wantInterpretedModule str = do
1828 modl <- lookupModule str
1829 dflags <- getDynFlags
1830 when (GHC.modulePackageId modl /= thisPackage dflags) $
1831 ghcError (CmdLineError ("module '" ++ str ++ "' is from another package;\nthis command requires an interpreted module"))
1832 is_interpreted <- GHC.moduleIsInterpreted modl
1833 when (not is_interpreted) $
1834 ghcError (CmdLineError ("module '" ++ str ++ "' is not interpreted; try \':add *" ++ str ++ "' first"))
1837 wantNameFromInterpretedModule :: GHC.GhcMonad m
1838 => (Name -> SDoc -> m ())
1842 wantNameFromInterpretedModule noCanDo str and_then =
1843 handleSourceError (GHC.printExceptionAndWarnings) $ do
1844 names <- GHC.parseName str
1848 let modl = ASSERT( isExternalName n ) GHC.nameModule n
1849 if not (GHC.isExternalName n)
1850 then noCanDo n $ ppr n <>
1851 text " is not defined in an interpreted module"
1853 is_interpreted <- GHC.moduleIsInterpreted modl
1854 if not is_interpreted
1855 then noCanDo n $ text "module " <> ppr modl <>
1856 text " is not interpreted"
1859 -- -----------------------------------------------------------------------------
1860 -- commands for debugger
1862 sprintCmd, printCmd, forceCmd :: String -> GHCi ()
1863 sprintCmd = pprintCommand False False
1864 printCmd = pprintCommand True False
1865 forceCmd = pprintCommand False True
1867 pprintCommand :: Bool -> Bool -> String -> GHCi ()
1868 pprintCommand bind force str = do
1869 withFlattenedDynflags $ pprintClosureCommand bind force str
1871 stepCmd :: String -> GHCi ()
1872 stepCmd [] = doContinue (const True) GHC.SingleStep
1873 stepCmd expression = runStmt expression GHC.SingleStep >> return ()
1875 stepLocalCmd :: String -> GHCi ()
1876 stepLocalCmd [] = do
1877 mb_span <- getCurrentBreakSpan
1879 Nothing -> stepCmd []
1881 Just mod <- getCurrentBreakModule
1882 current_toplevel_decl <- enclosingTickSpan mod loc
1883 doContinue (`isSubspanOf` current_toplevel_decl) GHC.SingleStep
1885 stepLocalCmd expression = stepCmd expression
1887 stepModuleCmd :: String -> GHCi ()
1888 stepModuleCmd [] = do
1889 mb_span <- getCurrentBreakSpan
1891 Nothing -> stepCmd []
1893 Just span <- getCurrentBreakSpan
1894 let f some_span = srcSpanFileName_maybe span == srcSpanFileName_maybe some_span
1895 doContinue f GHC.SingleStep
1897 stepModuleCmd expression = stepCmd expression
1899 -- | Returns the span of the largest tick containing the srcspan given
1900 enclosingTickSpan :: Module -> SrcSpan -> GHCi SrcSpan
1901 enclosingTickSpan mod src = do
1902 ticks <- getTickArray mod
1903 let line = srcSpanStartLine src
1904 ASSERT (inRange (bounds ticks) line) do
1905 let enclosing_spans = [ span | (_,span) <- ticks ! line
1906 , srcSpanEnd span >= srcSpanEnd src]
1907 return . head . sortBy leftmost_largest $ enclosing_spans
1909 traceCmd :: String -> GHCi ()
1910 traceCmd [] = doContinue (const True) GHC.RunAndLogSteps
1911 traceCmd expression = runStmt expression GHC.RunAndLogSteps >> return ()
1913 continueCmd :: String -> GHCi ()
1914 continueCmd = noArgs $ doContinue (const True) GHC.RunToCompletion
1916 -- doContinue :: SingleStep -> GHCi ()
1917 doContinue :: (SrcSpan -> Bool) -> SingleStep -> GHCi ()
1918 doContinue pred step = do
1919 runResult <- resume pred step
1920 _ <- afterRunStmt pred runResult
1923 abandonCmd :: String -> GHCi ()
1924 abandonCmd = noArgs $ do
1925 b <- GHC.abandon -- the prompt will change to indicate the new context
1926 when (not b) $ io $ putStrLn "There is no computation running."
1929 deleteCmd :: String -> GHCi ()
1930 deleteCmd argLine = do
1931 deleteSwitch $ words argLine
1933 deleteSwitch :: [String] -> GHCi ()
1935 io $ putStrLn "The delete command requires at least one argument."
1936 -- delete all break points
1937 deleteSwitch ("*":_rest) = discardActiveBreakPoints
1938 deleteSwitch idents = do
1939 mapM_ deleteOneBreak idents
1941 deleteOneBreak :: String -> GHCi ()
1943 | all isDigit str = deleteBreak (read str)
1944 | otherwise = return ()
1946 historyCmd :: String -> GHCi ()
1948 | null arg = history 20
1949 | all isDigit arg = history (read arg)
1950 | otherwise = io $ putStrLn "Syntax: :history [num]"
1953 resumes <- GHC.getResumeContext
1955 [] -> io $ putStrLn "Not stopped at a breakpoint"
1957 let hist = GHC.resumeHistory r
1958 (took,rest) = splitAt num hist
1960 [] -> io $ putStrLn $
1961 "Empty history. Perhaps you forgot to use :trace?"
1963 spans <- mapM GHC.getHistorySpan took
1964 let nums = map (printf "-%-3d:") [(1::Int)..]
1965 names = map GHC.historyEnclosingDecl took
1966 printForUser (vcat(zipWith3
1967 (\x y z -> x <+> y <+> z)
1969 (map (bold . ppr) names)
1970 (map (parens . ppr) spans)))
1971 io $ putStrLn $ if null rest then "<end of history>" else "..."
1973 bold :: SDoc -> SDoc
1974 bold c | do_bold = text start_bold <> c <> text end_bold
1977 backCmd :: String -> GHCi ()
1978 backCmd = noArgs $ do
1979 (names, _, span) <- GHC.back
1980 printForUser $ ptext (sLit "Logged breakpoint at") <+> ppr span
1981 printTypeOfNames names
1982 -- run the command set with ":set stop <cmd>"
1984 enqueueCommands [stop st]
1986 forwardCmd :: String -> GHCi ()
1987 forwardCmd = noArgs $ do
1988 (names, ix, span) <- GHC.forward
1989 printForUser $ (if (ix == 0)
1990 then ptext (sLit "Stopped at")
1991 else ptext (sLit "Logged breakpoint at")) <+> ppr span
1992 printTypeOfNames names
1993 -- run the command set with ":set stop <cmd>"
1995 enqueueCommands [stop st]
1997 -- handle the "break" command
1998 breakCmd :: String -> GHCi ()
1999 breakCmd argLine = do
2000 withFlattenedDynflags $ breakSwitch $ words argLine
2002 breakSwitch :: [String] -> GHCi ()
2004 io $ putStrLn "The break command requires at least one argument."
2005 breakSwitch (arg1:rest)
2006 | looksLikeModuleName arg1 && not (null rest) = do
2007 mod <- wantInterpretedModule arg1
2008 breakByModule mod rest
2009 | all isDigit arg1 = do
2010 (toplevel, _) <- GHC.getContext
2012 (mod : _) -> breakByModuleLine mod (read arg1) rest
2014 io $ putStrLn "Cannot find default module for breakpoint."
2015 io $ putStrLn "Perhaps no modules are loaded for debugging?"
2016 | otherwise = do -- try parsing it as an identifier
2017 wantNameFromInterpretedModule noCanDo arg1 $ \name -> do
2018 let loc = GHC.srcSpanStart (GHC.nameSrcSpan name)
2019 if GHC.isGoodSrcLoc loc
2020 then ASSERT( isExternalName name )
2021 findBreakAndSet (GHC.nameModule name) $
2022 findBreakByCoord (Just (GHC.srcLocFile loc))
2023 (GHC.srcLocLine loc,
2025 else noCanDo name $ text "can't find its location: " <> ppr loc
2027 noCanDo n why = printForUser $
2028 text "cannot set breakpoint on " <> ppr n <> text ": " <> why
2030 breakByModule :: Module -> [String] -> GHCi ()
2031 breakByModule mod (arg1:rest)
2032 | all isDigit arg1 = do -- looks like a line number
2033 breakByModuleLine mod (read arg1) rest
2037 breakByModuleLine :: Module -> Int -> [String] -> GHCi ()
2038 breakByModuleLine mod line args
2039 | [] <- args = findBreakAndSet mod $ findBreakByLine line
2040 | [col] <- args, all isDigit col =
2041 findBreakAndSet mod $ findBreakByCoord Nothing (line, read col)
2042 | otherwise = breakSyntax
2045 breakSyntax = ghcError (CmdLineError "Syntax: :break [<mod>] <line> [<column>]")
2047 findBreakAndSet :: Module -> (TickArray -> Maybe (Int, SrcSpan)) -> GHCi ()
2048 findBreakAndSet mod lookupTickTree = do
2049 tickArray <- getTickArray mod
2050 (breakArray, _) <- getModBreak mod
2051 case lookupTickTree tickArray of
2052 Nothing -> io $ putStrLn $ "No breakpoints found at that location."
2053 Just (tick, span) -> do
2054 success <- io $ setBreakFlag True breakArray tick
2058 recordBreak $ BreakLocation
2065 text "Breakpoint " <> ppr nm <>
2067 then text " was already set at " <> ppr span
2068 else text " activated at " <> ppr span
2070 printForUser $ text "Breakpoint could not be activated at"
2073 -- When a line number is specified, the current policy for choosing
2074 -- the best breakpoint is this:
2075 -- - the leftmost complete subexpression on the specified line, or
2076 -- - the leftmost subexpression starting on the specified line, or
2077 -- - the rightmost subexpression enclosing the specified line
2079 findBreakByLine :: Int -> TickArray -> Maybe (BreakIndex,SrcSpan)
2080 findBreakByLine line arr
2081 | not (inRange (bounds arr) line) = Nothing
2083 listToMaybe (sortBy (leftmost_largest `on` snd) complete) `mplus`
2084 listToMaybe (sortBy (leftmost_smallest `on` snd) incomplete) `mplus`
2085 listToMaybe (sortBy (rightmost `on` snd) ticks)
2089 starts_here = [ tick | tick@(_,span) <- ticks,
2090 GHC.srcSpanStartLine span == line ]
2092 (complete,incomplete) = partition ends_here starts_here
2093 where ends_here (_,span) = GHC.srcSpanEndLine span == line
2095 findBreakByCoord :: Maybe FastString -> (Int,Int) -> TickArray
2096 -> Maybe (BreakIndex,SrcSpan)
2097 findBreakByCoord mb_file (line, col) arr
2098 | not (inRange (bounds arr) line) = Nothing
2100 listToMaybe (sortBy (rightmost `on` snd) contains ++
2101 sortBy (leftmost_smallest `on` snd) after_here)
2105 -- the ticks that span this coordinate
2106 contains = [ tick | tick@(_,span) <- ticks, span `spans` (line,col),
2107 is_correct_file span ]
2109 is_correct_file span
2110 | Just f <- mb_file = GHC.srcSpanFile span == f
2113 after_here = [ tick | tick@(_,span) <- ticks,
2114 GHC.srcSpanStartLine span == line,
2115 GHC.srcSpanStartCol span >= col ]
2117 -- For now, use ANSI bold on terminals that we know support it.
2118 -- Otherwise, we add a line of carets under the active expression instead.
2119 -- In particular, on Windows and when running the testsuite (which sets
2120 -- TERM to vt100 for other reasons) we get carets.
2121 -- We really ought to use a proper termcap/terminfo library.
2123 do_bold = (`isPrefixOf` unsafePerformIO mTerm) `any` ["xterm", "linux"]
2124 where mTerm = System.Environment.getEnv "TERM"
2125 `catchIO` \_ -> return "TERM not set"
2127 start_bold :: String
2128 start_bold = "\ESC[1m"
2130 end_bold = "\ESC[0m"
2132 listCmd :: String -> InputT GHCi ()
2133 listCmd c = withFlattenedDynflags $ listCmd' c
2135 listCmd' :: String -> InputT GHCi ()
2137 mb_span <- lift getCurrentBreakSpan
2140 printForUser $ text "Not stopped at a breakpoint; nothing to list"
2142 | GHC.isGoodSrcSpan span -> listAround span True
2144 do resumes <- GHC.getResumeContext
2146 [] -> panic "No resumes"
2148 do let traceIt = case GHC.resumeHistory r of
2149 [] -> text "rerunning with :trace,"
2151 doWhat = traceIt <+> text ":back then :list"
2152 printForUser (text "Unable to list source for" <+>
2154 $$ text "Try" <+> doWhat)
2155 listCmd' str = list2 (words str)
2157 list2 :: [String] -> InputT GHCi ()
2158 list2 [arg] | all isDigit arg = do
2159 (toplevel, _) <- GHC.getContext
2161 [] -> outputStrLn "No module to list"
2162 (mod : _) -> listModuleLine mod (read arg)
2163 list2 [arg1,arg2] | looksLikeModuleName arg1, all isDigit arg2 = do
2164 mod <- wantInterpretedModule arg1
2165 listModuleLine mod (read arg2)
2167 wantNameFromInterpretedModule noCanDo arg $ \name -> do
2168 let loc = GHC.srcSpanStart (GHC.nameSrcSpan name)
2169 if GHC.isGoodSrcLoc loc
2171 tickArray <- ASSERT( isExternalName name )
2172 lift $ getTickArray (GHC.nameModule name)
2173 let mb_span = findBreakByCoord (Just (GHC.srcLocFile loc))
2174 (GHC.srcLocLine loc, GHC.srcLocCol loc)
2177 Nothing -> listAround (GHC.srcLocSpan loc) False
2178 Just (_,span) -> listAround span False
2180 noCanDo name $ text "can't find its location: " <>
2183 noCanDo n why = printForUser $
2184 text "cannot list source code for " <> ppr n <> text ": " <> why
2186 outputStrLn "syntax: :list [<line> | <module> <line> | <identifier>]"
2188 listModuleLine :: Module -> Int -> InputT GHCi ()
2189 listModuleLine modl line = do
2190 graph <- GHC.getModuleGraph
2191 let this = filter ((== modl) . GHC.ms_mod) graph
2193 [] -> panic "listModuleLine"
2195 let filename = expectJust "listModuleLine" (ml_hs_file (GHC.ms_location summ))
2196 loc = GHC.mkSrcLoc (mkFastString (filename)) line 0
2197 listAround (GHC.srcLocSpan loc) False
2199 -- | list a section of a source file around a particular SrcSpan.
2200 -- If the highlight flag is True, also highlight the span using
2201 -- start_bold\/end_bold.
2203 -- GHC files are UTF-8, so we can implement this by:
2204 -- 1) read the file in as a BS and syntax highlight it as before
2205 -- 2) convert the BS to String using utf-string, and write it out.
2206 -- It would be better if we could convert directly between UTF-8 and the
2207 -- console encoding, of course.
2208 listAround :: MonadIO m => SrcSpan -> Bool -> InputT m ()
2209 listAround span do_highlight = do
2210 contents <- liftIO $ BS.readFile (unpackFS file)
2212 lines = BS.split '\n' contents
2213 these_lines = take (line2 - line1 + 1 + pad_before + pad_after) $
2214 drop (line1 - 1 - pad_before) $ lines
2215 fst_line = max 1 (line1 - pad_before)
2216 line_nos = [ fst_line .. ]
2218 highlighted | do_highlight = zipWith highlight line_nos these_lines
2219 | otherwise = [\p -> BS.concat[p,l] | l <- these_lines]
2221 bs_line_nos = [ BS.pack (show l ++ " ") | l <- line_nos ]
2222 prefixed = zipWith ($) highlighted bs_line_nos
2224 let output = BS.intercalate (BS.pack "\n") prefixed
2225 utf8Decoded <- liftIO $ BS.useAsCStringLen output
2226 $ \(p,n) -> utf8DecodeString (castPtr p) n
2227 outputStrLn utf8Decoded
2229 file = GHC.srcSpanFile span
2230 line1 = GHC.srcSpanStartLine span
2231 col1 = GHC.srcSpanStartCol span - 1
2232 line2 = GHC.srcSpanEndLine span
2233 col2 = GHC.srcSpanEndCol span - 1
2235 pad_before | line1 == 1 = 0
2239 highlight | do_bold = highlight_bold
2240 | otherwise = highlight_carets
2242 highlight_bold no line prefix
2243 | no == line1 && no == line2
2244 = let (a,r) = BS.splitAt col1 line
2245 (b,c) = BS.splitAt (col2-col1) r
2247 BS.concat [prefix, a,BS.pack start_bold,b,BS.pack end_bold,c]
2249 = let (a,b) = BS.splitAt col1 line in
2250 BS.concat [prefix, a, BS.pack start_bold, b]
2252 = let (a,b) = BS.splitAt col2 line in
2253 BS.concat [prefix, a, BS.pack end_bold, b]
2254 | otherwise = BS.concat [prefix, line]
2256 highlight_carets no line prefix
2257 | no == line1 && no == line2
2258 = BS.concat [prefix, line, nl, indent, BS.replicate col1 ' ',
2259 BS.replicate (col2-col1) '^']
2261 = BS.concat [indent, BS.replicate (col1 - 2) ' ', BS.pack "vv", nl,
2264 = BS.concat [prefix, line, nl, indent, BS.replicate col2 ' ',
2266 | otherwise = BS.concat [prefix, line]
2268 indent = BS.pack (" " ++ replicate (length (show no)) ' ')
2269 nl = BS.singleton '\n'
2271 -- --------------------------------------------------------------------------
2274 getTickArray :: Module -> GHCi TickArray
2275 getTickArray modl = do
2277 let arrmap = tickarrays st
2278 case lookupModuleEnv arrmap modl of
2279 Just arr -> return arr
2281 (_breakArray, ticks) <- getModBreak modl
2282 let arr = mkTickArray (assocs ticks)
2283 setGHCiState st{tickarrays = extendModuleEnv arrmap modl arr}
2286 discardTickArrays :: GHCi ()
2287 discardTickArrays = do
2289 setGHCiState st{tickarrays = emptyModuleEnv}
2291 mkTickArray :: [(BreakIndex,SrcSpan)] -> TickArray
2293 = accumArray (flip (:)) [] (1, max_line)
2294 [ (line, (nm,span)) | (nm,span) <- ticks,
2295 line <- srcSpanLines span ]
2297 max_line = foldr max 0 (map GHC.srcSpanEndLine (map snd ticks))
2298 srcSpanLines span = [ GHC.srcSpanStartLine span ..
2299 GHC.srcSpanEndLine span ]
2301 lookupModule :: GHC.GhcMonad m => String -> m Module
2302 lookupModule modName
2303 = GHC.lookupModule (GHC.mkModuleName modName) Nothing
2305 -- don't reset the counter back to zero?
2306 discardActiveBreakPoints :: GHCi ()
2307 discardActiveBreakPoints = do
2309 mapM_ (turnOffBreak.snd) (breaks st)
2310 setGHCiState $ st { breaks = [] }
2312 deleteBreak :: Int -> GHCi ()
2313 deleteBreak identity = do
2315 let oldLocations = breaks st
2316 (this,rest) = partition (\loc -> fst loc == identity) oldLocations
2318 then printForUser (text "Breakpoint" <+> ppr identity <+>
2319 text "does not exist")
2321 mapM_ (turnOffBreak.snd) this
2322 setGHCiState $ st { breaks = rest }
2324 turnOffBreak :: BreakLocation -> GHCi Bool
2325 turnOffBreak loc = do
2326 (arr, _) <- getModBreak (breakModule loc)
2327 io $ setBreakFlag False arr (breakTick loc)
2329 getModBreak :: Module -> GHCi (GHC.BreakArray, Array Int SrcSpan)
2330 getModBreak mod = do
2331 Just mod_info <- GHC.getModuleInfo mod
2332 let modBreaks = GHC.modInfoModBreaks mod_info
2333 let array = GHC.modBreaks_flags modBreaks
2334 let ticks = GHC.modBreaks_locs modBreaks
2335 return (array, ticks)
2337 setBreakFlag :: Bool -> GHC.BreakArray -> Int -> IO Bool
2338 setBreakFlag toggle array index
2339 | toggle = GHC.setBreakOn array index
2340 | otherwise = GHC.setBreakOff array index