compiler/ghci/InteractiveUI.hs

   1 {-# OPTIONS -fno-cse #-}
   2 -- -fno-cse is needed for GLOBAL_VAR's to behave properly
   3
   4 {-# OPTIONS -#include "Linker.h" #-}
   5 -----------------------------------------------------------------------------
   6 --
   7 -- GHC Interactive User Interface
   8 --
   9 -- (c) The GHC Team 2005-2006
  10 --
  11 -----------------------------------------------------------------------------
  12
  13 module InteractiveUI ( interactiveUI, ghciWelcomeMsg ) where
  14
  15 #include "HsVersions.h"
  16
  17 import qualified GhciMonad
  18 import GhciMonad hiding (runStmt)
  19 import GhciTags
  20 import Debugger
  21
  22 -- The GHC interface
  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 )
  28 import PprTyThing
  29 import DynFlags
  30
  31 import Packages
  32 #ifdef USE_EDITLINE
  33 import PackageConfig
  34 import UniqFM
  35 #endif
  36
  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
  42 import Name
  43 import SrcLoc
  44
  45 -- Other random utilities
  46 import CmdLineParser
  47 import Digraph
  48 import BasicTypes hiding (isTopLevel)
  49 import Panic      hiding (showException)
  50 import Config
  51 import StaticFlags
  52 import Linker
  53 import Util
  54 import NameSet
  55 import Maybes           ( orElse, expectJust )
  56 import FastString
  57 import Encoding
  58 import MonadUtils       ( liftIO )
  59
  60 #ifndef mingw32_HOST_OS
  61 import System.Posix hiding (getEnv)
  62 #else
  63 import GHC.ConsoleHandler ( flushConsole )
  64 import qualified System.Win32
  65 #endif
  66
  67 #ifdef USE_EDITLINE
  68 import Control.Concurrent       ( yield )       -- Used in readline loop
  69 import System.Console.Editline.Readline as Readline
  70 #endif
  71
  72 --import SystemExts
  73
  74 import Exception
  75 -- import Control.Concurrent
  76
  77 import System.FilePath
  78 import qualified Data.ByteString.Char8 as BS
  79 import Data.List
  80 import Data.Maybe
  81 import System.Cmd
  82 import System.Environment
  83 import System.Exit      ( exitWith, ExitCode(..) )
  84 import System.Directory
  85 import System.IO
  86 import System.IO.Error as IO
  87 import Data.Char
  88 import Data.Array
  89 import Control.Monad as Monad
  90 import Text.Printf
  91 import Foreign
  92 import Foreign.C
  93 import GHC.Exts         ( unsafeCoerce# )
  94 import GHC.IOBase       ( IOErrorType(InvalidArgument) )
  95 import GHC.TopHandler
  96
  97 import Data.IORef       ( IORef, readIORef, writeIORef )
  98
  99 -----------------------------------------------------------------------------
 100
 101 ghciWelcomeMsg :: String
 102 ghciWelcomeMsg = "GHCi, version " ++ cProjectVersion ++
 103                  ": http://www.haskell.org/ghc/  :? for help"
 104
 105 cmdName :: Command -> String
 106 cmdName (n,_,_,_) = n
 107
 108 GLOBAL_VAR(macros_ref, [], [Command])
 109
 110 builtin_commands :: [Command]
 111 builtin_commands = [
 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)
 155   ]
 156
 157
 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.
 163 --
 164 -- NOTE: in order for us to override the default correctly, any custom entry
 165 -- must be a SUBSET of word_break_chars.
 166 #ifdef USE_EDITLINE
 167 word_break_chars :: String
 168 word_break_chars = let symbols = "!#$%&*+/<=>?@\\^|-~"
 169                        specials = "(),;[]`{}"
 170                        spaces = " \t\n"
 171                    in spaces ++ specials ++ symbols
 172 #endif
 173
 174 flagWordBreakChars, filenameWordBreakChars :: String
 175 flagWordBreakChars = " \t\n"
 176 filenameWordBreakChars = " \t\n\\`@$><=;|&{(" -- bash defaults
 177
 178
 179 keepGoing :: (String -> GHCi ()) -> (String -> GHCi Bool)
 180 keepGoing a str = a str >> return False
 181
 182 keepGoingPaths :: ([FilePath] -> GHCi ()) -> (String -> GHCi Bool)
 183 keepGoingPaths a str
 184  = do case toArgs str of
 185           Left err -> io (hPutStrLn stderr err)
 186           Right args -> a args
 187       return False
 188
 189 shortHelpText :: String
 190 shortHelpText = "use :? for help.\n"
 191
 192 helpText :: String
 193 helpText =
 194  " Commands available from the prompt:\n" ++
 195  "\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" ++
 221  "\n" ++
 222  " -- Commands for debugging:\n" ++
 223  "\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"++
 245
 246  "\n" ++
 247  " -- Commands for changing settings:\n" ++
 248  "\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" ++
 256  "\n" ++
 257  "  Options for ':set' and ':unset':\n" ++
 258  "\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" ++
 266  "\n" ++
 267  " -- Commands for displaying information:\n" ++
 268  "\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" ++
 277  "\n"
 278
 279 findEditor :: IO String
 280 findEditor = do
 281   getEnv "EDITOR"
 282     `IO.catch` \_ -> do
 283 #if mingw32_HOST_OS
 284         win <- System.Win32.getWindowsDirectory
 285         return (win </> "notepad.exe")
 286 #else
 287         return ""
 288 #endif
 289
 290 interactiveUI :: [(FilePath, Maybe Phase)] -> Maybe [String]
 291               -> Ghc ()
 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
 300    -- now.
 301    liftIO $ newStablePtr stdin
 302    liftIO $ newStablePtr stdout
 303    liftIO $ newStablePtr stderr
 304
 305     -- Initialise buffering for the *interpreted* I/O system
 306    initInterpBuffering
 307
 308    liftIO $ when (isNothing maybe_exprs) $ do
 309         -- Only for GHCi (not runghc and ghc -e):
 310
 311         -- Turn buffering off for the compiled program's stdout/stderr
 312         turnOffBuffering
 313         -- Turn buffering off for GHCi's stdout
 314         hFlush 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
 319
 320 #ifdef USE_EDITLINE
 321         is_tty <- hIsTerminalDevice stdin
 322         when is_tty $ withReadline $ do
 323             Readline.initialize
 324
 325             withGhcAppData
 326                  (\dir -> Readline.readHistory (dir </> "ghci_history"))
 327                  (return True)
 328
 329             Readline.setAttemptedCompletionFunction (Just completeWord)
 330             --Readline.parseAndBind "set show-all-if-ambiguous 1"
 331
 332             Readline.setBasicWordBreakCharacters word_break_chars
 333             Readline.setCompleterWordBreakCharacters word_break_chars
 334             Readline.setCompletionAppendCharacter Nothing
 335 #endif
 336
 337    -- initial context is just the Prelude
 338    prel_mod <- GHC.findModule (GHC.mkModuleName "Prelude") Nothing
 339    GHC.setContext [] [prel_mod]
 340
 341    default_editor <- liftIO $ findEditor
 342
 343    startGHCi (runGHCi srcs maybe_exprs)
 344         GHCiState{ progname = "<interactive>",
 345                    args = [],
 346                    prompt = "%s> ",
 347                    stop = "",
 348                    editor = default_editor,
 349 --                   session = session,
 350                    options = [],
 351                    prelude = prel_mod,
 352                    break_ctr = 0,
 353                    breaks = [],
 354                    tickarrays = emptyModuleEnv,
 355                    last_command = Nothing,
 356                    cmdqueue = [],
 357                    remembered_ctx = [],
 358                    ghc_e = isJust maybe_exprs
 359                  }
 360
 361 #ifdef USE_EDITLINE
 362    liftIO $ do
 363      Readline.stifleHistory 100
 364      withGhcAppData (\dir -> Readline.writeHistory (dir </> "ghci_history"))
 365                     (return True)
 366      Readline.resetTerminal Nothing
 367 #endif
 368
 369    return ()
 370
 371 withGhcAppData :: (FilePath -> IO a) -> IO a -> IO a
 372 withGhcAppData right left = do
 373    either_dir <- IO.try (getAppUserDataDirectory "ghc")
 374    case either_dir of
 375       Right dir -> right dir
 376       _ -> left
 377
 378 -- libedit doesn't always restore the terminal settings correctly (as of at
 379 -- least 07/12/2008); see trac #2691.  Work around this by manually resetting
 380 -- the terminal outselves.
 381 withTerminalReset :: Ghc () -> Ghc ()
 382 #ifdef mingw32_HOST_OS
 383 withTerminalReset = id
 384 #else
 385 withTerminalReset f = do
 386     isTTY <- liftIO $ hIsTerminalDevice stdout
 387     if not isTTY
 388         then f
 389         else gbracket (liftIO $ getTerminalAttributes stdOutput)
 390                 (\attrs -> liftIO $ setTerminalAttributes stdOutput attrs Immediately)
 391                 (const f)
 392 #endif
 393
 394 runGHCi :: [(FilePath, Maybe Phase)] -> Maybe [String] -> GHCi ()
 395 runGHCi paths maybe_exprs = do
 396   let
 397    read_dot_files = not opt_IgnoreDotGhci
 398
 399    current_dir = return (Just ".ghci")
 400
 401    app_user_dir = io $ withGhcAppData
 402                     (\dir -> return (Just (dir </> "ghci.conf")))
 403                     (return Nothing)
 404
 405    home_dir = do
 406     either_dir <- io $ IO.try (getEnv "HOME")
 407     case either_dir of
 408       Right home -> return (Just (home </> ".ghci"))
 409       _ -> return Nothing
 410
 411    sourceConfigFile :: FilePath -> GHCi ()
 412    sourceConfigFile file = do
 413      exists <- io $ doesFileExist file
 414      when exists $ do
 415        dir_ok  <- io $ checkPerms (getDirectory file)
 416        file_ok <- io $ checkPerms file
 417        when (dir_ok && file_ok) $ do
 418          either_hdl <- io $ IO.try (openFile file ReadMode)
 419          case either_hdl of
 420            Left _e   -> return ()
 421            Right hdl -> runCommands (fileLoop hdl False False)
 422      where
 423       getDirectory f = case takeDirectory f of "" -> "."; d -> d
 424
 425   when (read_dot_files) $ do
 426     cfgs0 <- sequence [ current_dir, app_user_dir, home_dir ]
 427     cfgs <- io $ mapM canonicalizePath (catMaybes cfgs0)
 428     mapM_ sourceConfigFile (nub cfgs)
 429         -- nub, because we don't want to read .ghci twice if the
 430         -- CWD is $HOME.
 431
 432   -- Perform a :load for files given on the GHCi command line
 433   -- When in -e mode, if the load fails then we want to stop
 434   -- immediately rather than going on to evaluate the expression.
 435   when (not (null paths)) $ do
 436      ok <- ghciHandle (\e -> do showException e; return Failed) $
 437                 loadModule paths
 438      when (isJust maybe_exprs && failed ok) $
 439         io (exitWith (ExitFailure 1))
 440
 441   -- if verbosity is greater than 0, or we are connected to a
 442   -- terminal, display the prompt in the interactive loop.
 443   is_tty <- io (hIsTerminalDevice stdin)
 444   dflags <- getDynFlags
 445   let show_prompt = verbosity dflags > 0 || is_tty
 446
 447   case maybe_exprs of
 448         Nothing ->
 449           do
 450 #if defined(mingw32_HOST_OS)
 451             -- The win32 Console API mutates the first character of
 452             -- type-ahead when reading from it in a non-buffered manner. Work
 453             -- around this by flushing the input buffer of type-ahead characters,
 454             -- but only if stdin is available.
 455             flushed <- io (IO.try (GHC.ConsoleHandler.flushConsole stdin))
 456             case flushed of
 457              Left err | isDoesNotExistError err -> return ()
 458                       | otherwise -> io (ioError err)
 459              Right () -> return ()
 460 #endif
 461             -- enter the interactive loop
 462             interactiveLoop is_tty show_prompt
 463         Just exprs -> do
 464             -- just evaluate the expression we were given
 465             enqueueCommands exprs
 466             let handle e = do st <- getGHCiState
 467                                    -- Jump through some hoops to get the
 468                                    -- current progname in the exception text:
 469                                    -- <progname>: <exception>
 470                               io $ withProgName (progname st)
 471                                    -- this used to be topHandlerFastExit, see #2228
 472                                  $ topHandler e
 473             runCommands' handle (return Nothing)
 474
 475   -- and finally, exit
 476   io $ do when (verbosity dflags > 0) $ putStrLn "Leaving GHCi."
 477
 478 interactiveLoop :: Bool -> Bool -> GHCi ()
 479 interactiveLoop is_tty show_prompt =
 480   -- Ignore ^C exceptions caught here
 481   ghciHandleGhcException (\e -> case e of
 482                         Interrupted -> do
 483 #if defined(mingw32_HOST_OS)
 484                                 io (putStrLn "")
 485 #endif
 486                                 interactiveLoop is_tty show_prompt
 487                         _other      -> return ()) $
 488
 489   ghciUnblock $ do -- unblock necessary if we recursed from the
 490                    -- exception handler above.
 491
 492   -- read commands from stdin
 493 #ifdef USE_EDITLINE
 494   if (is_tty)
 495         then runCommands readlineLoop
 496         else runCommands (fileLoop stdin show_prompt is_tty)
 497 #else
 498   runCommands (fileLoop stdin show_prompt is_tty)
 499 #endif
 500
 501
 502 -- NOTE: We only read .ghci files if they are owned by the current user,
 503 -- and aren't world writable.  Otherwise, we could be accidentally
 504 -- running code planted by a malicious third party.
 505
 506 -- Furthermore, We only read ./.ghci if . is owned by the current user
 507 -- and isn't writable by anyone else.  I think this is sufficient: we
 508 -- don't need to check .. and ../.. etc. because "."  always refers to
 509 -- the same directory while a process is running.
 510
 511 checkPerms :: String -> IO Bool
 512 #ifdef mingw32_HOST_OS
 513 checkPerms _ =
 514   return True
 515 #else
 516 checkPerms name =
 517   handleIO (\_ -> return False) $ do
 518      st <- getFileStatus name
 519      me <- getRealUserID
 520      if fileOwner st /= me then do
 521         putStrLn $ "WARNING: " ++ name ++ " is owned by someone else, IGNORING!"
 522         return False
 523       else do
 524         let mode =  fileMode st
 525         if (groupWriteMode == (mode `intersectFileModes` groupWriteMode))
 526            || (otherWriteMode == (mode `intersectFileModes` otherWriteMode))
 527            then do
 528                putStrLn $ "*** WARNING: " ++ name ++
 529                           " is writable by someone else, IGNORING!"
 530                return False
 531           else return True
 532 #endif
 533
 534 fileLoop :: Handle -> Bool -> Bool -> GHCi (Maybe String)
 535 fileLoop hdl show_prompt is_tty = do
 536    when show_prompt $ do
 537         prompt <- mkPrompt
 538         (io (putStr prompt))
 539    l <- io (IO.try (hGetLine hdl))
 540    case l of
 541         Left e | isEOFError e              -> return Nothing
 542                | InvalidArgument <- etype  -> return Nothing
 543                | otherwise                 -> io (ioError e)
 544                 where etype = ioeGetErrorType e
 545                 -- treat InvalidArgument in the same way as EOF:
 546                 -- this can happen if the user closed stdin, or
 547                 -- perhaps did getContents which closes stdin at
 548                 -- EOF.
 549         Right l -> do
 550                    str <- io $ consoleInputToUnicode is_tty l
 551                    return (Just str)
 552
 553 #ifdef mingw32_HOST_OS
 554 -- Convert the console input into Unicode according to the current code page.
 555 -- The Windows console stores Unicode characters directly, so this is a
 556 -- rather roundabout way of doing things... oh well.
 557 -- See #782, #1483, #1649
 558 consoleInputToUnicode :: Bool -> String -> IO String
 559 consoleInputToUnicode is_tty str
 560   | is_tty = do
 561     cp <- System.Win32.getConsoleCP
 562     System.Win32.stringToUnicode cp str
 563   | otherwise =
 564     decodeStringAsUTF8 str
 565 #else
 566 -- for Unix, assume the input is in UTF-8 and decode it to a Unicode String.
 567 -- See #782.
 568 consoleInputToUnicode :: Bool -> String -> IO String
 569 consoleInputToUnicode _is_tty str = decodeStringAsUTF8 str
 570 #endif
 571
 572 decodeStringAsUTF8 :: String -> IO String
 573 decodeStringAsUTF8 str =
 574   withCStringLen str $ \(cstr,len) ->
 575     utf8DecodeString (castPtr cstr :: Ptr Word8) len
 576
 577 mkPrompt :: GHCi String
 578 mkPrompt = do
 579   (toplevs,exports) <- GHC.getContext
 580   resumes <- GHC.getResumeContext
 581   -- st <- getGHCiState
 582
 583   context_bit <-
 584         case resumes of
 585             [] -> return empty
 586             r:_ -> do
 587                 let ix = GHC.resumeHistoryIx r
 588                 if ix == 0
 589                    then return (brackets (ppr (GHC.resumeSpan r)) <> space)
 590                    else do
 591                         let hist = GHC.resumeHistory r !! (ix-1)
 592                         span <- GHC.getHistorySpan hist
 593                         return (brackets (ppr (negate ix) <> char ':'
 594                                           <+> ppr span) <> space)
 595   let
 596         dots | _:rs <- resumes, not (null rs) = text "... "
 597              | otherwise = empty
 598
 599
 600
 601         modules_bit =
 602        -- ToDo: maybe...
 603        --  let (btoplevs, bexports) = fromMaybe ([],[]) (remembered_ctx st) in
 604        --  hsep (map (\m -> text "!*" <> ppr (GHC.moduleName m)) btoplevs) <+>
 605        --  hsep (map (\m -> char '!'  <> ppr (GHC.moduleName m)) bexports) <+>
 606              hsep (map (\m -> char '*'  <> ppr (GHC.moduleName m)) toplevs) <+>
 607              hsep (map (ppr . GHC.moduleName) exports)
 608
 609         deflt_prompt = dots <> context_bit <> modules_bit
 610
 611         f ('%':'s':xs) = deflt_prompt <> f xs
 612         f ('%':'%':xs) = char '%' <> f xs
 613         f (x:xs) = char x <> f xs
 614         f [] = empty
 615    --
 616   st <- getGHCiState
 617   return (showSDoc (f (prompt st)))
 618
 619
 620 #ifdef USE_EDITLINE
 621 readlineLoop :: GHCi (Maybe String)
 622 readlineLoop = do
 623    io yield
 624    saveSession -- for use by completion
 625    prompt <- mkPrompt
 626    l <- io $ withReadline (readline prompt)
 627    splatSavedSession
 628    case l of
 629         Nothing -> return Nothing
 630         Just "" -> return (Just "") -- Don't put empty lines in the history
 631         Just l  -> do
 632                    io (addHistory l)
 633                    str <- io $ consoleInputToUnicode True l
 634                    return (Just str)
 635
 636 withReadline :: IO a -> IO a
 637 withReadline = bracket_ stopTimer startTimer
 638      --    editline doesn't handle some of its system calls returning
 639      --    EINTR, so our timer signal confuses it, hence we turn off
 640      --    the timer signal when making calls to editline. (#2277)
 641      --    If editline is ever fixed, we can remove this.
 642
 643 -- These come from the RTS
 644 foreign import ccall unsafe startTimer :: IO ()
 645 foreign import ccall unsafe stopTimer  :: IO ()
 646 #endif
 647
 648 queryQueue :: GHCi (Maybe String)
 649 queryQueue = do
 650   st <- getGHCiState
 651   case cmdqueue st of
 652     []   -> return Nothing
 653     c:cs -> do setGHCiState st{ cmdqueue = cs }
 654                return (Just c)
 655
 656 runCommands :: GHCi (Maybe String) -> GHCi ()
 657 runCommands = runCommands' handler
 658
 659 runCommands' :: (SomeException -> GHCi Bool) -- Exception handler
 660              -> GHCi (Maybe String) -> GHCi ()
 661 runCommands' eh getCmd = do
 662   mb_cmd <- noSpace queryQueue
 663   mb_cmd <- maybe (noSpace getCmd) (return . Just) mb_cmd
 664   case mb_cmd of
 665     Nothing -> return ()
 666     Just c  -> do
 667       b <- ghciHandle eh $
 668              handleSourceError printErrorAndKeepGoing
 669                (doCommand c)
 670       if b then return () else runCommands' eh getCmd
 671   where
 672     printErrorAndKeepGoing err = do
 673         GHC.printExceptionAndWarnings err
 674         return False
 675
 676     noSpace q = q >>= maybe (return Nothing)
 677                             (\c->case removeSpaces c of
 678                                    ""   -> noSpace q
 679                                    ":{" -> multiLineCmd q
 680                                    c    -> return (Just c) )
 681     multiLineCmd q = do
 682       st <- getGHCiState
 683       let p = prompt st
 684       setGHCiState st{ prompt = "%s| " }
 685       mb_cmd <- collectCommand q ""
 686       getGHCiState >>= \st->setGHCiState st{ prompt = p }
 687       return mb_cmd
 688     -- we can't use removeSpaces for the sublines here, so
 689     -- multiline commands are somewhat more brittle against
 690     -- fileformat errors (such as \r in dos input on unix),
 691     -- we get rid of any extra spaces for the ":}" test;
 692     -- we also avoid silent failure if ":}" is not found;
 693     -- and since there is no (?) valid occurrence of \r (as
 694     -- opposed to its String representation, "\r") inside a
 695     -- ghci command, we replace any such with ' ' (argh:-(
 696     collectCommand q c = q >>=
 697       maybe (io (ioError collectError))
 698             (\l->if removeSpaces l == ":}"
 699                  then return (Just $ removeSpaces c)
 700                  else collectCommand q (c++map normSpace l))
 701       where normSpace '\r' = ' '
 702             normSpace   c  = c
 703     -- QUESTION: is userError the one to use here?
 704     collectError = userError "unterminated multiline command :{ .. :}"
 705     doCommand (':' : cmd) = specialCommand cmd
 706     doCommand stmt        = do timeIt $ runStmt stmt GHC.RunToCompletion
 707                                return False
 708
 709 enqueueCommands :: [String] -> GHCi ()
 710 enqueueCommands cmds = do
 711   st <- getGHCiState
 712   setGHCiState st{ cmdqueue = cmds ++ cmdqueue st }
 713
 714
 715 runStmt :: String -> SingleStep -> GHCi Bool
 716 runStmt stmt step
 717  | null (filter (not.isSpace) stmt) = return False
 718  | ["import", mod] <- words stmt    = keepGoing setContext ('+':mod)
 719  | otherwise
 720  = do result <- GhciMonad.runStmt stmt step
 721       afterRunStmt (const True) result
 722
 723 --afterRunStmt :: GHC.RunResult -> GHCi Bool
 724                                  -- False <=> the statement failed to compile
 725 afterRunStmt :: (SrcSpan -> Bool) -> GHC.RunResult -> GHCi Bool
 726 afterRunStmt _ (GHC.RunException e) = throw e
 727 afterRunStmt step_here run_result = do
 728   resumes <- GHC.getResumeContext
 729   case run_result of
 730      GHC.RunOk names -> do
 731         show_types <- isOptionSet ShowType
 732         when show_types $ printTypeOfNames names
 733      GHC.RunBreak _ names mb_info
 734          | isNothing  mb_info ||
 735            step_here (GHC.resumeSpan $ head resumes) -> do
 736                printForUser $ ptext (sLit "Stopped at") <+>
 737                        ppr (GHC.resumeSpan $ head resumes)
 738 --               printTypeOfNames session names
 739                let namesSorted = sortBy compareNames names
 740                tythings <- catMaybes `liftM`
 741                               mapM GHC.lookupName namesSorted
 742                docs <- pprTypeAndContents [id | AnId id <- tythings]
 743                printForUserPartWay docs
 744                maybe (return ()) runBreakCmd mb_info
 745                -- run the command set with ":set stop <cmd>"
 746                st <- getGHCiState
 747                enqueueCommands [stop st]
 748                return ()
 749          | otherwise -> resume GHC.SingleStep >>=
 750                         afterRunStmt step_here >> return ()
 751      _ -> return ()
 752
 753   flushInterpBuffers
 754   io installSignalHandlers
 755   b <- isOptionSet RevertCAFs
 756   when b revertCAFs
 757
 758   return (case run_result of GHC.RunOk _ -> True; _ -> False)
 759
 760 runBreakCmd :: GHC.BreakInfo -> GHCi ()
 761 runBreakCmd info = do
 762   let mod = GHC.breakInfo_module info
 763       nm  = GHC.breakInfo_number info
 764   st <- getGHCiState
 765   case  [ loc | (_,loc) <- breaks st,
 766                 breakModule loc == mod, breakTick loc == nm ] of
 767         []  -> return ()
 768         loc:_ | null cmd  -> return ()
 769               | otherwise -> do enqueueCommands [cmd]; return ()
 770               where cmd = onBreakCmd loc
 771
 772 printTypeOfNames :: [Name] -> GHCi ()
 773 printTypeOfNames names
 774  = mapM_ (printTypeOfName ) $ sortBy compareNames names
 775
 776 compareNames :: Name -> Name -> Ordering
 777 n1 `compareNames` n2 = compareWith n1 `compare` compareWith n2
 778     where compareWith n = (getOccString n, getSrcSpan n)
 779
 780 printTypeOfName :: Name -> GHCi ()
 781 printTypeOfName n
 782    = do maybe_tything <- GHC.lookupName n
 783         case maybe_tything of
 784             Nothing    -> return ()
 785             Just thing -> printTyThing thing
 786
 787
 788 data MaybeCommand = GotCommand Command | BadCommand | NoLastCommand
 789
 790 specialCommand :: String -> GHCi Bool
 791 specialCommand ('!':str) = shellEscape (dropWhile isSpace str)
 792 specialCommand str = do
 793   let (cmd,rest) = break isSpace str
 794   maybe_cmd <- lookupCommand cmd
 795   case maybe_cmd of
 796     GotCommand (_,f,_,_) -> f (dropWhile isSpace rest)
 797     BadCommand ->
 798       do io $ hPutStr stdout ("unknown command ':" ++ cmd ++ "'\n"
 799                            ++ shortHelpText)
 800          return False
 801     NoLastCommand ->
 802       do io $ hPutStr stdout ("there is no last command to perform\n"
 803                            ++ shortHelpText)
 804          return False
 805
 806 lookupCommand :: String -> GHCi (MaybeCommand)
 807 lookupCommand "" = do
 808   st <- getGHCiState
 809   case last_command st of
 810       Just c -> return $ GotCommand c
 811       Nothing -> return NoLastCommand
 812 lookupCommand str = do
 813   mc <- io $ lookupCommand' str
 814   st <- getGHCiState
 815   setGHCiState st{ last_command = mc }
 816   return $ case mc of
 817            Just c -> GotCommand c
 818            Nothing -> BadCommand
 819
 820 lookupCommand' :: String -> IO (Maybe Command)
 821 lookupCommand' str = do
 822   macros <- readIORef macros_ref
 823   let cmds = builtin_commands ++ macros
 824   -- look for exact match first, then the first prefix match
 825   return $ case [ c | c <- cmds, str == cmdName c ] of
 826            c:_ -> Just c
 827            [] -> case [ c | c@(s,_,_,_) <- cmds, str `isPrefixOf` s ] of
 828                  [] -> Nothing
 829                  c:_ -> Just c
 830
 831 getCurrentBreakSpan :: GHCi (Maybe SrcSpan)
 832 getCurrentBreakSpan = do
 833   resumes <- GHC.getResumeContext
 834   case resumes of
 835     [] -> return Nothing
 836     (r:_) -> do
 837         let ix = GHC.resumeHistoryIx r
 838         if ix == 0
 839            then return (Just (GHC.resumeSpan r))
 840            else do
 841                 let hist = GHC.resumeHistory r !! (ix-1)
 842                 span <- GHC.getHistorySpan hist
 843                 return (Just span)
 844
 845 getCurrentBreakModule :: GHCi (Maybe Module)
 846 getCurrentBreakModule = do
 847   resumes <- GHC.getResumeContext
 848   case resumes of
 849     [] -> return Nothing
 850     (r:_) -> do
 851         let ix = GHC.resumeHistoryIx r
 852         if ix == 0
 853            then return (GHC.breakInfo_module `liftM` GHC.resumeBreakInfo r)
 854            else do
 855                 let hist = GHC.resumeHistory r !! (ix-1)
 856                 return $ Just $ GHC.getHistoryModule  hist
 857
 858 -----------------------------------------------------------------------------
 859 -- Commands
 860
 861 noArgs :: GHCi () -> String -> GHCi ()
 862 noArgs m "" = m
 863 noArgs _ _  = io $ putStrLn "This command takes no arguments"
 864
 865 help :: String -> GHCi ()
 866 help _ = io (putStr helpText)
 867
 868 info :: String -> GHCi ()
 869 info "" = ghcError (CmdLineError "syntax: ':i <thing-you-want-info-about>'")
 870 info s  = handleSourceError GHC.printExceptionAndWarnings $ do
 871              { let names = words s
 872              ; dflags <- getDynFlags
 873              ; let pefas = dopt Opt_PrintExplicitForalls dflags
 874              ; mapM_ (infoThing pefas) names }
 875   where
 876     infoThing pefas str = do
 877         names     <- GHC.parseName str
 878         mb_stuffs <- mapM GHC.getInfo names
 879         let filtered = filterOutChildren (\(t,_f,_i) -> t) (catMaybes mb_stuffs)
 880         unqual <- GHC.getPrintUnqual
 881         liftIO $
 882           putStrLn (showSDocForUser unqual $
 883                      vcat (intersperse (text "") $
 884                            map (pprInfo pefas) filtered))
 885
 886   -- Filter out names whose parent is also there Good
 887   -- example is '[]', which is both a type and data
 888   -- constructor in the same type
 889 filterOutChildren :: (a -> TyThing) -> [a] -> [a]
 890 filterOutChildren get_thing xs
 891   = [x | x <- xs, not (getName (get_thing x) `elemNameSet` implicits)]
 892   where
 893     implicits = mkNameSet [getName t | x <- xs, t <- implicitTyThings (get_thing x)]
 894
 895 pprInfo :: PrintExplicitForalls -> (TyThing, Fixity, [GHC.Instance]) -> SDoc
 896 pprInfo pefas (thing, fixity, insts)
 897   =  pprTyThingInContextLoc pefas thing
 898   $$ show_fixity fixity
 899   $$ vcat (map GHC.pprInstance insts)
 900   where
 901     show_fixity fix
 902         | fix == GHC.defaultFixity = empty
 903         | otherwise                = ppr fix <+> ppr (GHC.getName thing)
 904
 905 runMain :: String -> GHCi ()
 906 runMain s = case toArgs s of
 907             Left err   -> io (hPutStrLn stderr err)
 908             Right args ->
 909                 do dflags <- getDynFlags
 910                    case mainFunIs dflags of
 911                        Nothing -> doWithArgs args "main"
 912                        Just f  -> doWithArgs args f
 913
 914 runRun :: String -> GHCi ()
 915 runRun s = case toCmdArgs s of
 916            Left err          -> io (hPutStrLn stderr err)
 917            Right (cmd, args) -> doWithArgs args cmd
 918
 919 doWithArgs :: [String] -> String -> GHCi ()
 920 doWithArgs args cmd = enqueueCommands ["System.Environment.withArgs " ++
 921                                        show args ++ " (" ++ cmd ++ ")"]
 922
 923 addModule :: [FilePath] -> GHCi ()
 924 addModule files = do
 925   revertCAFs                    -- always revert CAFs on load/add.
 926   files <- mapM expandPath files
 927   targets <- mapM (\m -> GHC.guessTarget m Nothing) files
 928   -- remove old targets with the same id; e.g. for :add *M
 929   mapM_ GHC.removeTarget [ tid | Target tid _ _ <- targets ]
 930   mapM_ GHC.addTarget targets
 931   prev_context <- GHC.getContext
 932   ok <- trySuccess $ GHC.load LoadAllTargets
 933   afterLoad ok False prev_context
 934
 935 changeDirectory :: String -> GHCi ()
 936 changeDirectory "" = do
 937   -- :cd on its own changes to the user's home directory
 938   either_dir <- io (IO.try getHomeDirectory)
 939   case either_dir of
 940      Left _e -> return ()
 941      Right dir -> changeDirectory dir
 942 changeDirectory dir = do
 943   graph <- GHC.getModuleGraph
 944   when (not (null graph)) $
 945         io $ putStr "Warning: changing directory causes all loaded modules to be unloaded,\nbecause the search path has changed.\n"
 946   prev_context <- GHC.getContext
 947   GHC.setTargets []
 948   GHC.load LoadAllTargets
 949   setContextAfterLoad prev_context False []
 950   GHC.workingDirectoryChanged
 951   dir <- expandPath dir
 952   io (setCurrentDirectory dir)
 953
 954 trySuccess :: GHC.GhcMonad m => m SuccessFlag -> m SuccessFlag
 955 trySuccess act =
 956     handleSourceError (\e -> do GHC.printExceptionAndWarnings e
 957                                 return Failed) $ do
 958       act
 959
 960 editFile :: String -> GHCi ()
 961 editFile str =
 962   do file <- if null str then chooseEditFile else return str
 963      st <- getGHCiState
 964      let cmd = editor st
 965      when (null cmd)
 966        $ ghcError (CmdLineError "editor not set, use :set editor")
 967      io $ system (cmd ++ ' ':file)
 968      return ()
 969
 970 -- The user didn't specify a file so we pick one for them.
 971 -- Our strategy is to pick the first module that failed to load,
 972 -- or otherwise the first target.
 973 --
 974 -- XXX: Can we figure out what happened if the depndecy analysis fails
 975 --      (e.g., because the porgrammeer mistyped the name of a module)?
 976 -- XXX: Can we figure out the location of an error to pass to the editor?
 977 -- XXX: if we could figure out the list of errors that occured during the
 978 -- last load/reaload, then we could start the editor focused on the first
 979 -- of those.
 980 chooseEditFile :: GHCi String
 981 chooseEditFile =
 982   do let hasFailed x = fmap not $ GHC.isLoaded $ GHC.ms_mod_name x
 983
 984      graph <- GHC.getModuleGraph
 985      failed_graph <- filterM hasFailed graph
 986      let order g  = flattenSCCs $ GHC.topSortModuleGraph True g Nothing
 987          pick xs  = case xs of
 988                       x : _ -> GHC.ml_hs_file (GHC.ms_location x)
 989                       _     -> Nothing
 990
 991      case pick (order failed_graph) of
 992        Just file -> return file
 993        Nothing   ->
 994          do targets <- GHC.getTargets
 995             case msum (map fromTarget targets) of
 996               Just file -> return file
 997               Nothing   -> ghcError (CmdLineError "No files to edit.")
 998
 999   where fromTarget (GHC.Target (GHC.TargetFile f _) _ _) = Just f
1000         fromTarget _ = Nothing -- when would we get a module target?
1001
1002 defineMacro :: Bool{-overwrite-} -> String -> GHCi ()
1003 defineMacro overwrite s = do
1004   let (macro_name, definition) = break isSpace s
1005   macros <- io (readIORef macros_ref)
1006   let defined = map cmdName macros
1007   if (null macro_name)
1008         then if null defined
1009                 then io $ putStrLn "no macros defined"
1010                 else io $ putStr ("the following macros are defined:\n" ++
1011                                   unlines defined)
1012         else do
1013   if (not overwrite && macro_name `elem` defined)
1014         then ghcError (CmdLineError
1015                 ("macro '" ++ macro_name ++ "' is already defined"))
1016         else do
1017
1018   let filtered = [ cmd | cmd <- macros, cmdName cmd /= macro_name ]
1019
1020   -- give the expression a type signature, so we can be sure we're getting
1021   -- something of the right type.
1022   let new_expr = '(' : definition ++ ") :: String -> IO String"
1023
1024   -- compile the expression
1025   handleSourceError (\e -> GHC.printExceptionAndWarnings e) $ do
1026     hv <- GHC.compileExpr new_expr
1027     io (writeIORef macros_ref --
1028         (filtered ++ [(macro_name, runMacro hv, Nothing, completeNone)]))
1029
1030 runMacro :: GHC.HValue{-String -> IO String-} -> String -> GHCi Bool
1031 runMacro fun s = do
1032   str <- io ((unsafeCoerce# fun :: String -> IO String) s)
1033   -- make sure we force any exceptions in the result, while we are still
1034   -- inside the exception handler for commands:
1035   seqList str (return ())
1036   enqueueCommands (lines str)
1037   return False
1038
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"))
1046            else do
1047             io (writeIORef macros_ref (filter ((/= macro_name) . cmdName) cmds))
1048
1049 cmdCmd :: String -> GHCi ()
1050 cmdCmd str = do
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)
1056     return ()
1057
1058 loadModule :: [(FilePath, Maybe Phase)] -> GHCi SuccessFlag
1059 loadModule fs = timeIt (loadModule' fs)
1060
1061 loadModule_ :: [FilePath] -> GHCi ()
1062 loadModule_ fs = do loadModule (zip fs (repeat Nothing)); return ()
1063
1064 loadModule' :: [(FilePath, Maybe Phase)] -> GHCi SuccessFlag
1065 loadModule' files = do
1066   prev_context <- GHC.getContext
1067
1068   -- unload first
1069   GHC.abandonAll
1070   discardActiveBreakPoints
1071   GHC.setTargets []
1072   GHC.load LoadAllTargets
1073
1074   -- expand tildes
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'
1079
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.
1084
1085   GHC.setTargets targets
1086   doLoad False prev_context LoadAllTargets
1087
1088 checkModule :: String -> GHCi ()
1089 checkModule m = do
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 ->
1097                 let
1098                     (local,global) = ASSERT( all isExternalName scope )
1099                                      partition ((== modl) . GHC.moduleName . GHC.nameModule) scope
1100                 in
1101                         (text "global names: " <+> ppr global) $$
1102                         (text "local  names: " <+> ppr local)
1103              _ -> empty))
1104           return True
1105   afterLoad (successIf ok) False prev_context
1106
1107 reloadModule :: String -> GHCi ()
1108 reloadModule m = do
1109   prev_context <- GHC.getContext
1110   doLoad True prev_context $
1111         if null m then LoadAllTargets
1112                   else LoadUpTo (GHC.mkModuleName m)
1113   return ()
1114
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
1122   return ok
1123
1124 afterLoad :: SuccessFlag -> Bool -> ([Module],[Module]) -> GHCi ()
1125 afterLoad ok retain_context prev_context = do
1126   revertCAFs  -- always revert CAFs on load.
1127   discardTickArrays
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
1132
1133   setContextAfterLoad prev_context retain_context loaded_mod_summaries
1134
1135
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
1144         []    ->
1145           let graph' = flattenSCCs (GHC.topSortModuleGraph True ms Nothing) in
1146           load_this (last graph')
1147         (m:_) ->
1148           load_this m
1149  where
1150    findTarget ms t
1151     = case filter (`matches` t) ms of
1152         []    -> Nothing
1153         (m:_) -> Just m
1154
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'
1159    _ `matches` _
1160         = False
1161
1162    load_this summary | m <- GHC.ms_mod summary = do
1163         b <- GHC.moduleIsInterpreted m
1164         if b then setContextKeepingPackageModules prev keep_ctxt ([m], [])
1165              else do
1166                 prel_mod <- getPrelude
1167                 setContextKeepingPackageModules prev keep_ctxt ([],[prel_mod,m])
1168
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
1174         -> GHCi ()
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))
1181   if keep_ctxt
1182      then do
1183           st <- getGHCiState
1184           mapM_ (playCtxtCmd False) (remembered_ctx st)
1185      else do
1186           st <- getGHCiState
1187           setGHCiState st{ remembered_ctx = [] }
1188
1189 isHomeModule :: Module -> Bool
1190 isHomeModule mod = GHC.modulePackageId mod == mainPackageId
1191
1192 modulesLoadedMsg :: SuccessFlag -> [ModuleName] -> GHCi ()
1193 modulesLoadedMsg ok mods = do
1194   dflags <- getDynFlags
1195   when (verbosity dflags > 0) $ do
1196    let mod_commas
1197         | null mods = text "none."
1198         | otherwise = hsep (
1199             punctuate comma (map ppr mods)) <> text "."
1200    case ok of
1201     Failed ->
1202        io (putStrLn (showSDoc (text "Failed, modules loaded: " <> mod_commas)))
1203     Succeeded  ->
1204        io (putStrLn (showSDoc (text "Ok, modules loaded: " <> mod_commas)))
1205
1206
1207 typeOfExpr :: String -> GHCi ()
1208 typeOfExpr str
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)]
1214
1215 kindOfType :: String -> GHCi ()
1216 kindOfType str
1217   = handleSourceError (\e -> GHC.printExceptionAndWarnings e) $ do
1218        ty <- GHC.typeKind str
1219        printForUser $ text str <+> dcolon <+> ppr ty
1220
1221 quit :: String -> GHCi Bool
1222 quit _ = return True
1223
1224 shellEscape :: String -> GHCi Bool
1225 shellEscape str = io (system str >> return False)
1226
1227 -----------------------------------------------------------------------------
1228 -- Browsing a module's contents
1229
1230 browseCmd :: Bool -> String -> GHCi ()
1231 browseCmd bang m =
1232   case words m of
1233     ['*':s] | looksLikeModuleName s -> do
1234         m <-  wantInterpretedModule s
1235         browseModule bang m False
1236     [s] | looksLikeModuleName s -> do
1237         m <- lookupModule s
1238         browseModule bang m True
1239     [] -> do
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.
1244         case (as,bs) of
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>")
1249
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
1266
1267   let unqual = if bang then current_unqual else target_unqual
1268
1269   mb_mod_info <- GHC.getModuleInfo modl
1270   case mb_mod_info of
1271     Nothing -> ghcError (CmdLineError ("unknown module: " ++
1272                                 GHC.moduleNameString (GHC.moduleName modl)))
1273     Just mod_info -> do
1274         dflags <- getDynFlags
1275         let names
1276                | exports_only = GHC.modInfoExports mod_info
1277                | otherwise    = GHC.modInfoTopLevelScope mod_info
1278                                 `orElse` []
1279
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
1284                 where
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.
1290                 loc_sort names
1291                       | n:_ <- names, isGoodSrcSpan (nameSrcSpan n)
1292                       = sortBy (compare `on` nameSrcSpan) names
1293                       | otherwise
1294                       = occ_sort names
1295
1296         mb_things <- mapM GHC.lookupName sorted_names
1297         let filtered_things = filterOutChildren (\t -> t) (catMaybes mb_things)
1298
1299         rdr_env <- GHC.getGRE
1300
1301         let pefas              = dopt Opt_PrintExplicitForalls dflags
1302             things | bang      = catMaybes mb_things
1303                    | otherwise = filtered_things
1304             pretty | bang      = pprTyThing
1305                    | otherwise = pprTyThingInContext
1306
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
1314
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)
1323             group []            = []
1324             group mts@((m,_):_) = (m,map snd g) : group ng
1325               where (g,ng) = partition ((==m).fst) mts
1326
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))
1334
1335 -----------------------------------------------------------------------------
1336 -- Setting the module context
1337
1338 setContext :: String -> GHCi ()
1339 setContext str
1340   | all sensible strs = do
1341        playCtxtCmd True (cmd, as, bs)
1342        st <- getGHCiState
1343        setGHCiState st{ remembered_ctx = remembered_ctx st ++ [(cmd,as,bs)] }
1344   | otherwise = ghcError (CmdLineError "syntax:  :module [+/-] [*]M1 ... [*]Mn")
1345   where
1346     (cmd, strs, as, bs) =
1347         case str of
1348                 '+':stuff -> rest AddModules stuff
1349                 '-':stuff -> rest RemModules stuff
1350                 stuff     -> rest SetContext stuff
1351
1352     rest cmd stuff = (cmd, strs, as, bs)
1353        where strs = words stuff
1354              (as,bs) = partitionWith starred strs
1355
1356     sensible ('*':m) = looksLikeModuleName m
1357     sensible m       = looksLikeModuleName m
1358
1359     starred ('*':m) = Left m
1360     starred m       = Right m
1361
1362 playCtxtCmd :: Bool -> (CtxtCmd, [String], [String]) -> GHCi ()
1363 playCtxtCmd fail (cmd, as, bs)
1364   = do
1365     (as',bs') <- do_checks fail
1366     (prev_as,prev_bs) <- GHC.getContext
1367     (new_as, new_bs) <-
1368       case cmd of
1369         SetContext -> do
1370           prel_mod <- getPrelude
1371           let bs'' = if null as && prel_mod `notElem` bs' then prel_mod:bs'
1372                                                           else bs'
1373           return (as',bs'')
1374         AddModules -> do
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)
1378         RemModules -> do
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
1383   where
1384     do_checks True = do
1385       as' <- mapM wantInterpretedModule as
1386       bs' <- mapM lookupModule bs
1387       return (as',bs')
1388     do_checks False = do
1389       as' <- mapM (trymaybe . wantInterpretedModule) as
1390       bs' <- mapM (trymaybe . lookupModule) bs
1391       return (catMaybes as', catMaybes bs')
1392
1393     trymaybe m = do
1394         r <- ghciTry m
1395         case r of
1396           Left _  -> return Nothing
1397           Right a -> return (Just a)
1398
1399 ----------------------------------------------------------------------------
1400 -- Code for `:set'
1401
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,
1404 -- -E etc.)
1405 --
1406 -- This is pretty fragile: most options won't work as expected.  ToDo:
1407 -- figure out which ones & disallow them.
1408
1409 setCmd :: String -> GHCi ()
1410 setCmd ""
1411   = do st <- getGHCiState
1412        let opts = options st
1413        io $ putStrLn (showSDoc (
1414               text "options currently set: " <>
1415               if null opts
1416                    then text "none."
1417                    else hsep (map (\o -> char '+' <> text (optToStr o)) opts)
1418            ))
1419        dflags <- getDynFlags
1420        io $ putStrLn (showSDoc (
1421           vcat (text "GHCi-specific dynamic flag settings:"
1422                :map (flagSetting dflags) ghciFlags)
1423           ))
1424        io $ putStrLn (showSDoc (
1425           vcat (text "other dynamic, non-language, flag settings:"
1426                :map (flagSetting dflags) nonLanguageDynFlags)
1427           ))
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)
1432                                         DynFlags.fFlags
1433         nonLanguageDynFlags = filterOut (\(_, f, _) -> f `elem` languageOptions)
1434                                         others
1435         flags = [Opt_PrintExplicitForalls
1436                 ,Opt_PrintBindResult
1437                 ,Opt_BreakOnException
1438                 ,Opt_BreakOnError
1439                 ,Opt_PrintEvldWithShow
1440                 ]
1441 setCmd str
1442   = case getCmd str of
1443     Right ("args",   rest) ->
1444         case toArgs rest of
1445             Left err -> io (hPutStrLn stderr err)
1446             Right args -> setArgs args
1447     Right ("prog",   rest) ->
1448         case toArgs rest of
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
1457
1458 setArgs, setOptions :: [String] -> GHCi ()
1459 setProg, setEditor, setStop, setPrompt :: String -> GHCi ()
1460
1461 setArgs args = do
1462   st <- getGHCiState
1463   setGHCiState st{ args = args }
1464
1465 setProg prog = do
1466   st <- getGHCiState
1467   setGHCiState st{ progname = prog }
1468
1469 setEditor cmd = do
1470   st <- getGHCiState
1471   setGHCiState st{ editor = cmd }
1472
1473 setStop str@(c:_) | isDigit c
1474   = do let (nm_str,rest) = break (not.isDigit) str
1475            nm = read nm_str
1476        st <- getGHCiState
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")
1481               else do
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 }
1486 setStop cmd = do
1487   st <- getGHCiState
1488   setGHCiState st{ stop = cmd }
1489
1490 setPrompt value = do
1491   st <- getGHCiState
1492   if null value
1493       then io $ hPutStrLn stderr $ "syntax: :set prompt <prompt>, currently \"" ++ prompt st ++ "\""
1494       else case value of
1495            '\"' : _ -> case reads value of
1496                        [(value', xs)] | all isSpace xs ->
1497                            setGHCiState (st { prompt = value' })
1498                        _ ->
1499                            io $ hPutStrLn stderr "Can't parse prompt string. Use Haskell syntax."
1500            _ -> setGHCiState (st { prompt = value })
1501
1502 setOptions wds =
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
1508
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
1515
1516       if (not (null leftovers))
1517         then ghcError $ errorsToGhcException leftovers
1518         else return ()
1519
1520       new_pkgs <- setDynFlags dflags'
1521
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..."
1527         GHC.setTargets []
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 []
1532       return ()
1533
1534
1535 unsetOptions :: String -> GHCi ()
1536 unsetOptions str
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
1541
1542        if (not (null rest2))
1543           then io (putStrLn ("unknown option: '" ++ head rest2 ++ "'"))
1544           else do
1545
1546        mapM_ unsetOpt plus_opts
1547
1548        let no_flag ('-':'f':rest) = return ("-fno-" ++ rest)
1549            no_flag f = ghcError (ProgramError ("don't know how to reverse " ++ f))
1550
1551        no_flags <- mapM no_flag minus_opts
1552        newDynFlags no_flags
1553
1554 isMinus :: String -> Bool
1555 isMinus ('-':_) = True
1556 isMinus _ = False
1557
1558 isPlus :: String -> Either String String
1559 isPlus ('+':opt) = Left opt
1560 isPlus other     = Right other
1561
1562 setOpt, unsetOpt :: String -> GHCi ()
1563
1564 setOpt str
1565   = case strToGHCiOpt str of
1566         Nothing -> io (putStrLn ("unknown option: '" ++ str ++ "'"))
1567         Just o  -> setOption o
1568
1569 unsetOpt str
1570   = case strToGHCiOpt str of
1571         Nothing -> io (putStrLn ("unknown option: '" ++ str ++ "'"))
1572         Just o  -> unsetOption o
1573
1574 strToGHCiOpt :: String -> (Maybe GHCiOption)
1575 strToGHCiOpt "s" = Just ShowTiming
1576 strToGHCiOpt "t" = Just ShowType
1577 strToGHCiOpt "r" = Just RevertCAFs
1578 strToGHCiOpt _   = Nothing
1579
1580 optToStr :: GHCiOption -> String
1581 optToStr ShowTiming = "s"
1582 optToStr ShowType   = "t"
1583 optToStr RevertCAFs = "r"
1584
1585 -- ---------------------------------------------------------------------------
1586 -- code for `:show'
1587
1588 showCmd :: String -> GHCi ()
1589 showCmd str = do
1590   st <- getGHCiState
1591   case words str of
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 ]"))
1606
1607 showModules :: GHCi ()
1608 showModules = do
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
1613
1614 getLoadedModules :: GHCi [GHC.ModSummary]
1615 getLoadedModules = do
1616   graph <- GHC.getModuleGraph
1617   filterM (GHC.isLoaded . GHC.ms_mod_name) graph
1618
1619 showBindings :: GHCi ()
1620 showBindings = do
1621   bindings <- GHC.getBindings
1622   docs     <- pprTypeAndContents
1623                   [ id | AnId id <- sortBy compareTyThings bindings]
1624   printForUserPartWay docs
1625
1626 compareTyThings :: TyThing -> TyThing -> Ordering
1627 t1 `compareTyThings` t2 = getName t1 `compareNames` getName t2
1628
1629 printTyThing :: TyThing -> GHCi ()
1630 printTyThing tyth = do dflags <- getDynFlags
1631                        let pefas = dopt Opt_PrintExplicitForalls dflags
1632                        printForUser (pprTyThing pefas tyth)
1633
1634 showBkptTable :: GHCi ()
1635 showBkptTable = do
1636   st <- getGHCiState
1637   printForUser $ prettyLocations (breaks st)
1638
1639 showContext :: GHCi ()
1640 showContext = do
1641    resumes <- GHC.getResumeContext
1642    printForUser $ vcat (map pp_resume (reverse resumes))
1643   where
1644    pp_resume resume =
1645         ptext (sLit "--> ") <> text (GHC.resumeStmt resume)
1646         $$ nest 2 (ptext (sLit "Stopped at") <+> ppr (GHC.resumeSpan resume))
1647
1648 showPackages :: GHCi ()
1649 showPackages = do
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
1662
1663 showLanguages :: GHCi ()
1664 showLanguages = do
1665    dflags <- getDynFlags
1666    io $ putStrLn $ showSDoc $ vcat $
1667       text "active language flags:" :
1668       [text ("  -X" ++ str) | (str, f, _) <- DynFlags.xFlags, dopt f dflags]
1669
1670 -- -----------------------------------------------------------------------------
1671 -- Completion
1672
1673 completeNone :: String -> IO [String]
1674 completeNone _w = return []
1675
1676 completeMacro, completeIdentifier, completeModule,
1677     completeHomeModule, completeSetOptions, completeShowOptions,
1678     completeFilename, completeHomeModuleOrFile
1679     :: String -> IO [String]
1680
1681 #ifdef USE_EDITLINE
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)
1686   case w of
1687      ':':_ | all isSpace (take (start-1) line) -> wrapCompleter completeCmd w
1688      _other
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
1701         | otherwise     -> do
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
1715
1716           lookupCompletionVars ('!':_) = return (Just filenameWordBreakChars,
1717                                             completeFilename)
1718           lookupCompletionVars c = do
1719               maybe_cmd <- lookupCommand' c
1720               case maybe_cmd of
1721                   Just (_,_,ws,f) -> return (ws,f)
1722                   Nothing -> return (Just filenameWordBreakChars,
1723                                         completeFilename)
1724
1725
1726 completeCmd :: String -> IO [String]
1727 completeCmd w = do
1728   cmds <- readIORef macros_ref
1729   return (filter (w `isPrefixOf`) (map (':':)
1730              (map cmdName (builtin_commands ++ cmds))))
1731
1732 completeMacro w = do
1733   cmds <- readIORef macros_ref
1734   return (filter (w `isPrefixOf`) (map cmdName cmds))
1735
1736 completeIdentifier w = do
1737   rdrs <- withRestoredSession GHC.getRdrNamesInScope
1738   return (filter (w `isPrefixOf`) (map (showSDoc.ppr) rdrs))
1739
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))
1744
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))
1749
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
1754
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"]
1760
1761 completeFilename w = do
1762     ws <- Readline.filenameCompletionFunction w
1763     case ws of
1764         -- If we only found one result, and it's a directory,
1765         -- add a trailing slash.
1766         [file] -> do
1767                 isDir <- expandPathIO file >>= doesDirectoryExist
1768                 if isDir && last file /= '/'
1769                     then return [file ++ "/"]
1770                     else return [file]
1771         _ -> return ws
1772
1773
1774 completeHomeModuleOrFile = unionComplete completeHomeModule completeFilename
1775
1776 unionComplete :: (String -> IO [String]) -> (String -> IO [String]) -> String -> IO [String]
1777 unionComplete f1 f2 w = do
1778   s1 <- f1 w
1779   s2 <- f2 w
1780   return (s1 ++ s2)
1781
1782 wrapCompleter :: (String -> IO [String]) -> String -> IO (Maybe (String,[String]))
1783 wrapCompleter fun w =  do
1784   strs <- fun w
1785   case strs of
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))
1793
1794 getCommonPrefix :: [String] -> String
1795 getCommonPrefix [] = ""
1796 getCommonPrefix (s:ss) = foldl common s ss
1797   where common _s "" = ""
1798         common "" _s = ""
1799         common (c:cs) (d:ds)
1800            | c == d = c : common cs ds
1801            | otherwise = ""
1802
1803 allExposedModules :: DynFlags -> [ModuleName]
1804 allExposedModules dflags
1805  = concat (map exposedModules (filter exposed (eltsUFM pkg_db)))
1806  where
1807   pkg_db = pkgIdMap (pkgState dflags)
1808 #else
1809 completeMacro       = completeNone
1810 completeIdentifier  = completeNone
1811 completeModule      = completeNone
1812 completeHomeModule  = completeNone
1813 completeSetOptions  = completeNone
1814 completeShowOptions = completeNone
1815 completeFilename    = completeNone
1816 completeHomeModuleOrFile=completeNone
1817 #endif
1818
1819 -- ---------------------------------------------------------------------------
1820 -- User code exception handling
1821
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.
1827 --
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
1833
1834 handler exception = do
1835   flushInterpBuffers
1836   io installSignalHandlers
1837   ghciHandle handler (showException exception >> return False)
1838
1839 showException :: SomeException -> GHCi ()
1840 showException se =
1841   io $ case fromException se of
1842        Just Interrupted         -> putStrLn "Interrupted."
1843        -- omit the location for CmdLineError:
1844        Just (CmdLineError s)    -> putStrLn s
1845        -- ditto:
1846        Just ph@(PhaseFailed {}) -> putStrLn (showGhcException ph "")
1847        Just other_ghc_ex        -> print other_ghc_ex
1848        Nothing                  -> putStrLn ("*** Exception: " ++ show se)
1849
1850 -----------------------------------------------------------------------------
1851 -- recursive exception handlers
1852
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.
1856
1857 ghciHandle :: (SomeException -> GHCi a) -> GHCi a -> GHCi a
1858 ghciHandle h (GHCi m) = GHCi $ \s ->
1859    gcatch (m s)
1860         (\e -> unGHCi (ghciUnblock (h e)) s)
1861
1862 ghciUnblock :: GHCi a -> GHCi a
1863 ghciUnblock (GHCi a) =
1864     GHCi $ \s -> reifyGhc $ \gs ->
1865                    Exception.unblock (reflectGhc (a s) gs)
1866
1867 ghciTry :: GHCi a -> GHCi (Either SomeException a)
1868 ghciTry (GHCi m) = GHCi $ \s -> gtry (m s)
1869
1870 -- ----------------------------------------------------------------------------
1871 -- Utils
1872
1873 expandPath :: String -> GHCi String
1874 expandPath path = io (expandPathIO path)
1875
1876 expandPathIO :: String -> IO String
1877 expandPathIO path =
1878   case dropWhile isSpace path of
1879    ('~':d) -> do
1880         tilde <- getHomeDirectory -- will fail if HOME not defined
1881         return (tilde ++ '/':d)
1882    other ->
1883         return other
1884
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"))
1894    return modl
1895
1896 wantNameFromInterpretedModule :: (Name -> SDoc -> GHCi ()) -> String
1897                               -> (Name -> GHCi ())
1898                               -> GHCi ()
1899 wantNameFromInterpretedModule noCanDo str and_then =
1900   handleSourceError (GHC.printExceptionAndWarnings) $ do
1901    names <- GHC.parseName str
1902    case names of
1903       []    -> return ()
1904       (n:_) -> do
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"
1909                else do
1910             is_interpreted <- GHC.moduleIsInterpreted modl
1911             if not is_interpreted
1912                then noCanDo n $ text "module " <> ppr modl <>
1913                                 text " is not interpreted"
1914                else and_then n
1915
1916 -- -----------------------------------------------------------------------------
1917 -- commands for debugger
1918
1919 sprintCmd, printCmd, forceCmd :: String -> GHCi ()
1920 sprintCmd = pprintCommand False False
1921 printCmd  = pprintCommand True False
1922 forceCmd  = pprintCommand False True
1923
1924 pprintCommand :: Bool -> Bool -> String -> GHCi ()
1925 pprintCommand bind force str = do
1926   pprintClosureCommand bind force str
1927
1928 stepCmd :: String -> GHCi ()
1929 stepCmd []         = doContinue (const True) GHC.SingleStep
1930 stepCmd expression = do runStmt expression GHC.SingleStep; return ()
1931
1932 stepLocalCmd :: String -> GHCi ()
1933 stepLocalCmd  [] = do
1934   mb_span <- getCurrentBreakSpan
1935   case mb_span of
1936     Nothing  -> stepCmd []
1937     Just loc -> do
1938        Just mod <- getCurrentBreakModule
1939        current_toplevel_decl <- enclosingTickSpan mod loc
1940        doContinue (`isSubspanOf` current_toplevel_decl) GHC.SingleStep
1941
1942 stepLocalCmd expression = stepCmd expression
1943
1944 stepModuleCmd :: String -> GHCi ()
1945 stepModuleCmd  [] = do
1946   mb_span <- getCurrentBreakSpan
1947   case mb_span of
1948     Nothing  -> stepCmd []
1949     Just _ -> do
1950        Just span <- getCurrentBreakSpan
1951        let f some_span = srcSpanFileName_maybe span == srcSpanFileName_maybe some_span
1952        doContinue f GHC.SingleStep
1953
1954 stepModuleCmd expression = stepCmd expression
1955
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
1965
1966 traceCmd :: String -> GHCi ()
1967 traceCmd []         = doContinue (const True) GHC.RunAndLogSteps
1968 traceCmd expression = do runStmt expression GHC.RunAndLogSteps; return ()
1969
1970 continueCmd :: String -> GHCi ()
1971 continueCmd = noArgs $ doContinue (const True) GHC.RunToCompletion
1972
1973 -- doContinue :: SingleStep -> GHCi ()
1974 doContinue :: (SrcSpan -> Bool) -> SingleStep -> GHCi ()
1975 doContinue pred step = do
1976   runResult <- resume step
1977   afterRunStmt pred runResult
1978   return ()
1979
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."
1984   return ()
1985
1986 deleteCmd :: String -> GHCi ()
1987 deleteCmd argLine = do
1988    deleteSwitch $ words argLine
1989    where
1990    deleteSwitch :: [String] -> GHCi ()
1991    deleteSwitch [] =
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
1997       where
1998       deleteOneBreak :: String -> GHCi ()
1999       deleteOneBreak str
2000          | all isDigit str = deleteBreak (read str)
2001          | otherwise = return ()
2002
2003 historyCmd :: String -> GHCi ()
2004 historyCmd arg
2005   | null arg        = history 20
2006   | all isDigit arg = history (read arg)
2007   | otherwise       = io $ putStrLn "Syntax:  :history [num]"
2008   where
2009   history num = do
2010     resumes <- GHC.getResumeContext
2011     case resumes of
2012       [] -> io $ putStrLn "Not stopped at a breakpoint"
2013       (r:_) -> do
2014         let hist = GHC.resumeHistory r
2015             (took,rest) = splitAt num hist
2016         case hist of
2017           [] -> io $ putStrLn $
2018                    "Empty history. Perhaps you forgot to use :trace?"
2019           _  -> do
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)
2025                                  (map text nums)
2026                                  (map (bold . ppr) names)
2027                                  (map (parens . ppr) spans)))
2028                  io $ putStrLn $ if null rest then "<end of history>" else "..."
2029
2030 bold :: SDoc -> SDoc
2031 bold c | do_bold   = text start_bold <> c <> text end_bold
2032        | otherwise = c
2033
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>"
2040   st <- getGHCiState
2041   enqueueCommands [stop st]
2042
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>"
2051   st <- getGHCiState
2052   enqueueCommands [stop st]
2053
2054 -- handle the "break" command
2055 breakCmd :: String -> GHCi ()
2056 breakCmd argLine = do
2057    breakSwitch $ words argLine
2058
2059 breakSwitch :: [String] -> GHCi ()
2060 breakSwitch [] = do
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
2068         case toplevel of
2069            (mod : _) -> breakByModuleLine mod (read arg1) rest
2070            [] -> do
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,
2081                                            GHC.srcLocCol loc)
2082                else noCanDo name $ text "can't find its location: " <> ppr loc
2083        where
2084           noCanDo n why = printForUser $
2085                 text "cannot set breakpoint on " <> ppr n <> text ": " <> why
2086
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
2091 breakByModule _ _
2092    = breakSyntax
2093
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
2100
2101 breakSyntax :: a
2102 breakSyntax = ghcError (CmdLineError "Syntax: :break [<mod>] <line> [<column>]")
2103
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
2112          if success
2113             then do
2114                (alreadySet, nm) <-
2115                      recordBreak $ BreakLocation
2116                              { breakModule = mod
2117                              , breakLoc = span
2118                              , breakTick = tick
2119                              , onBreakCmd = ""
2120                              }
2121                printForUser $
2122                   text "Breakpoint " <> ppr nm <>
2123                   if alreadySet
2124                      then text " was already set at " <> ppr span
2125                      else text " activated at " <> ppr span
2126             else do
2127             printForUser $ text "Breakpoint could not be activated at"
2128                                  <+> ppr span
2129
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
2135 --
2136 findBreakByLine :: Int -> TickArray -> Maybe (BreakIndex,SrcSpan)
2137 findBreakByLine line arr
2138   | not (inRange (bounds arr) line) = Nothing
2139   | otherwise =
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)
2143   where
2144         ticks = arr ! line
2145
2146         starts_here = [ tick | tick@(_,span) <- ticks,
2147                                GHC.srcSpanStartLine span == line ]
2148
2149         (complete,incomplete) = partition ends_here starts_here
2150             where ends_here (_,span) = GHC.srcSpanEndLine span == line
2151
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
2156   | otherwise =
2157     listToMaybe (sortBy (rightmost `on` snd) contains ++
2158                  sortBy (leftmost_smallest `on` snd) after_here)
2159   where
2160         ticks = arr ! line
2161
2162         -- the ticks that span this coordinate
2163         contains = [ tick | tick@(_,span) <- ticks, span `spans` (line,col),
2164                             is_correct_file span ]
2165
2166         is_correct_file span
2167                  | Just f <- mb_file = GHC.srcSpanFile span == f
2168                  | otherwise         = True
2169
2170         after_here = [ tick | tick@(_,span) <- ticks,
2171                               GHC.srcSpanStartLine span == line,
2172                               GHC.srcSpanStartCol span >= col ]
2173
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.
2179 do_bold :: Bool
2180 do_bold = (`isPrefixOf` unsafePerformIO mTerm) `any` ["xterm", "linux"]
2181     where mTerm = System.Environment.getEnv "TERM"
2182                   `catchIO` \_ -> return "TERM not set"
2183
2184 start_bold :: String
2185 start_bold = "\ESC[1m"
2186 end_bold :: String
2187 end_bold   = "\ESC[0m"
2188
2189 listCmd :: String -> GHCi ()
2190 listCmd "" = do
2191    mb_span <- getCurrentBreakSpan
2192    case mb_span of
2193       Nothing ->
2194           printForUser $ text "Not stopped at a breakpoint; nothing to list"
2195       Just span
2196        | GHC.isGoodSrcSpan span -> io $ listAround span True
2197        | otherwise ->
2198           do resumes <- GHC.getResumeContext
2199              case resumes of
2200                  [] -> panic "No resumes"
2201                  (r:_) ->
2202                      do let traceIt = case GHC.resumeHistory r of
2203                                       [] -> text "rerunning with :trace,"
2204                                       _ -> empty
2205                             doWhat = traceIt <+> text ":back then :list"
2206                         printForUser (text "Unable to list source for" <+>
2207                                       ppr span
2208                                    $$ text "Try" <+> doWhat)
2209 listCmd str = list2 (words str)
2210
2211 list2 :: [String] -> GHCi ()
2212 list2 [arg] | all isDigit arg = do
2213     (toplevel, _) <- GHC.getContext
2214     case toplevel of
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)
2220 list2 [arg] = do
2221         wantNameFromInterpretedModule noCanDo arg $ \name -> do
2222         let loc = GHC.srcSpanStart (GHC.nameSrcSpan name)
2223         if GHC.isGoodSrcLoc loc
2224                then do
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)
2229                                         tickArray
2230                   case mb_span of
2231                     Nothing       -> io $ listAround (GHC.srcLocSpan loc) False
2232                     Just (_,span) -> io $ listAround span False
2233                else
2234                   noCanDo name $ text "can't find its location: " <>
2235                                  ppr loc
2236     where
2237         noCanDo n why = printForUser $
2238             text "cannot list source code for " <> ppr n <> text ": " <> why
2239 list2  _other =
2240         io $ putStrLn "syntax:  :list [<line> | <module> <line> | <identifier>]"
2241
2242 listModuleLine :: Module -> Int -> GHCi ()
2243 listModuleLine modl line = do
2244    graph <- GHC.getModuleGraph
2245    let this = filter ((== modl) . GHC.ms_mod) graph
2246    case this of
2247      [] -> panic "listModuleLine"
2248      summ:_ -> do
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
2252
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)
2259       let
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 .. ]
2265
2266           highlighted | do_highlight = zipWith highlight line_nos these_lines
2267                       | otherwise    = [\p -> BS.concat[p,l] | l <- these_lines]
2268
2269           bs_line_nos = [ BS.pack (show l ++ "  ") | l <- line_nos ]
2270           prefixed = zipWith ($) highlighted bs_line_nos
2271       --
2272       BS.putStrLn (BS.intercalate (BS.pack "\n") prefixed)
2273   where
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
2279
2280         pad_before | line1 == 1 = 0
2281                    | otherwise  = 1
2282         pad_after = 1
2283
2284         highlight | do_bold   = highlight_bold
2285                   | otherwise = highlight_carets
2286
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
2291             in
2292             BS.concat [prefix, a,BS.pack start_bold,b,BS.pack end_bold,c]
2293           | no == line1
2294           = let (a,b) = BS.splitAt col1 line in
2295             BS.concat [prefix, a, BS.pack start_bold, b]
2296           | no == line2
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]
2300
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) '^']
2305           | no == line1
2306           = BS.concat [indent, BS.replicate (col1 - 2) ' ', BS.pack "vv", nl,
2307                                          prefix, line]
2308           | no == line2
2309           = BS.concat [prefix, line, nl, indent, BS.replicate col2 ' ',
2310                                          BS.pack "^^"]
2311           | otherwise   = BS.concat [prefix, line]
2312          where
2313            indent = BS.pack ("  " ++ replicate (length (show no)) ' ')
2314            nl = BS.singleton '\n'
2315
2316 -- --------------------------------------------------------------------------
2317 -- Tick arrays
2318
2319 getTickArray :: Module -> GHCi TickArray
2320 getTickArray modl = do
2321    st <- getGHCiState
2322    let arrmap = tickarrays st
2323    case lookupModuleEnv arrmap modl of
2324       Just arr -> return arr
2325       Nothing  -> do
2326         (_breakArray, ticks) <- getModBreak modl
2327         let arr = mkTickArray (assocs ticks)
2328         setGHCiState st{tickarrays = extendModuleEnv arrmap modl arr}
2329         return arr
2330
2331 discardTickArrays :: GHCi ()
2332 discardTickArrays = do
2333    st <- getGHCiState
2334    setGHCiState st{tickarrays = emptyModuleEnv}
2335
2336 mkTickArray :: [(BreakIndex,SrcSpan)] -> TickArray
2337 mkTickArray ticks
2338   = accumArray (flip (:)) [] (1, max_line)
2339         [ (line, (nm,span)) | (nm,span) <- ticks,
2340                               line <- srcSpanLines span ]
2341     where
2342         max_line = foldr max 0 (map GHC.srcSpanEndLine (map snd ticks))
2343         srcSpanLines span = [ GHC.srcSpanStartLine span ..
2344                               GHC.srcSpanEndLine span ]
2345
2346 lookupModule :: String -> GHCi Module
2347 lookupModule modName
2348    = GHC.findModule (GHC.mkModuleName modName) Nothing
2349
2350 -- don't reset the counter back to zero?
2351 discardActiveBreakPoints :: GHCi ()
2352 discardActiveBreakPoints = do
2353    st <- getGHCiState
2354    mapM (turnOffBreak.snd) (breaks st)
2355    setGHCiState $ st { breaks = [] }
2356
2357 deleteBreak :: Int -> GHCi ()
2358 deleteBreak identity = do
2359    st <- getGHCiState
2360    let oldLocations    = breaks st
2361        (this,rest)     = partition (\loc -> fst loc == identity) oldLocations
2362    if null this
2363       then printForUser (text "Breakpoint" <+> ppr identity <+>
2364                          text "does not exist")
2365       else do
2366            mapM (turnOffBreak.snd) this
2367            setGHCiState $ st { breaks = rest }
2368
2369 turnOffBreak :: BreakLocation -> GHCi Bool
2370 turnOffBreak loc = do
2371   (arr, _) <- getModBreak (breakModule loc)
2372   io $ setBreakFlag False arr (breakTick loc)
2373
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)
2381
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