ghc/InteractiveUI.hs

   1 {-# OPTIONS -fno-cse #-}
   2 -- -fno-cse is needed for GLOBAL_VAR's to behave properly
   3
   4 {-# OPTIONS_GHC -fno-warn-name-shadowing #-}
   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                           TyThing(..), Phase,
  26                           BreakIndex, Resume, SingleStep,
  27                           Ghc, handleSourceError )
  28 import PprTyThing
  29 import DynFlags
  30
  31 import Packages
  32 -- import PackageConfig
  33 import UniqFM
  34
  35 import HscTypes ( handleFlagWarnings )
  36 import HsImpExp
  37 import qualified RdrName ( getGRE_NameQualifier_maybes ) -- should this come via GHC?
  38 import RdrName (RdrName)
  39 import Outputable       hiding (printForUser, printForUserPartWay)
  40 import Module           -- for ModuleEnv
  41 import Name
  42 import SrcLoc
  43
  44 -- Other random utilities
  45 import CmdLineParser
  46 import Digraph
  47 import BasicTypes hiding (isTopLevel)
  48 import Panic      hiding (showException)
  49 import Config
  50 import StaticFlags
  51 import Linker
  52 import Util
  53 import NameSet
  54 import Maybes           ( orElse, expectJust )
  55 import FastString
  56 import Encoding
  57 import Foreign.C
  58
  59 #ifndef mingw32_HOST_OS
  60 import System.Posix hiding (getEnv)
  61 #else
  62 import qualified System.Win32
  63 #endif
  64
  65 import System.Console.Haskeline as Haskeline
  66 import qualified System.Console.Haskeline.Encoding as Encoding
  67 import Control.Monad.Trans
  68
  69 --import SystemExts
  70
  71 import Exception hiding (catch, block, unblock)
  72
  73 -- import Control.Concurrent
  74
  75 import System.FilePath
  76 import qualified Data.ByteString.Char8 as BS
  77 import Data.List
  78 import Data.Maybe
  79 import System.Cmd
  80 import System.Environment
  81 import System.Exit      ( exitWith, ExitCode(..) )
  82 import System.Directory
  83 import System.IO
  84 import System.IO.Error as IO
  85 import Data.Char
  86 import Data.Array
  87 import Control.Monad as Monad
  88 import Text.Printf
  89 import Foreign
  90 import GHC.Exts         ( unsafeCoerce# )
  91
  92 #if __GLASGOW_HASKELL__ >= 611
  93 import GHC.IO.Exception ( IOErrorType(InvalidArgument) )
  94 import GHC.IO.Handle    ( hFlushAll )
  95 #else
  96 import GHC.IOBase       ( IOErrorType(InvalidArgument) )
  97 #endif
  98
  99 import GHC.TopHandler
 100
 101 import Data.IORef       ( IORef, readIORef, writeIORef )
 102
 103 -----------------------------------------------------------------------------
 104
 105 ghciWelcomeMsg :: String
 106 ghciWelcomeMsg = "GHCi, version " ++ cProjectVersion ++
 107                  ": http://www.haskell.org/ghc/  :? for help"
 108
 109 cmdName :: Command -> String
 110 cmdName (n,_,_) = n
 111
 112 GLOBAL_VAR(macros_ref, [], [Command])
 113
 114 builtin_commands :: [Command]
 115 builtin_commands = [
 116   -- Hugs users are accustomed to :e, so make sure it doesn't overlap
 117   ("?",         keepGoing help,                 noCompletion),
 118   ("add",       keepGoingPaths addModule,       completeFilename),
 119   ("abandon",   keepGoing abandonCmd,           noCompletion),
 120   ("break",     keepGoing breakCmd,             completeIdentifier),
 121   ("back",      keepGoing backCmd,              noCompletion),
 122   ("browse",    keepGoing' (browseCmd False),   completeModule),
 123   ("browse!",   keepGoing' (browseCmd True),    completeModule),
 124   ("cd",        keepGoing' changeDirectory,     completeFilename),
 125   ("check",     keepGoing' checkModule,         completeHomeModule),
 126   ("continue",  keepGoing continueCmd,          noCompletion),
 127   ("cmd",       keepGoing cmdCmd,               completeExpression),
 128   ("ctags",     keepGoing createCTagsWithLineNumbersCmd, completeFilename),
 129   ("ctags!",    keepGoing createCTagsWithRegExesCmd, completeFilename),
 130   ("def",       keepGoing (defineMacro False),  completeExpression),
 131   ("def!",      keepGoing (defineMacro True),   completeExpression),
 132   ("delete",    keepGoing deleteCmd,            noCompletion),
 133   ("edit",      keepGoing editFile,             completeFilename),
 134   ("etags",     keepGoing createETagsFileCmd,   completeFilename),
 135   ("force",     keepGoing forceCmd,             completeExpression),
 136   ("forward",   keepGoing forwardCmd,           noCompletion),
 137   ("help",      keepGoing help,                 noCompletion),
 138   ("history",   keepGoing historyCmd,           noCompletion),
 139   ("info",      keepGoing' info,                completeIdentifier),
 140   ("kind",      keepGoing' kindOfType,          completeIdentifier),
 141   ("load",      keepGoingPaths loadModule_,     completeHomeModuleOrFile),
 142   ("list",      keepGoing' listCmd,             noCompletion),
 143   ("module",    keepGoing setContext,           completeModule),
 144   ("main",      keepGoing runMain,              completeFilename),
 145   ("print",     keepGoing printCmd,             completeExpression),
 146   ("quit",      quit,                           noCompletion),
 147   ("reload",    keepGoing' reloadModule,        noCompletion),
 148   ("run",       keepGoing runRun,               completeFilename),
 149   ("set",       keepGoing setCmd,               completeSetOptions),
 150   ("show",      keepGoing showCmd,              completeShowOptions),
 151   ("sprint",    keepGoing sprintCmd,            completeExpression),
 152   ("step",      keepGoing stepCmd,              completeIdentifier),
 153   ("steplocal", keepGoing stepLocalCmd,         completeIdentifier),
 154   ("stepmodule",keepGoing stepModuleCmd,        completeIdentifier),
 155   ("type",      keepGoing' typeOfExpr,          completeExpression),
 156   ("trace",     keepGoing traceCmd,             completeExpression),
 157   ("undef",     keepGoing undefineMacro,        completeMacro),
 158   ("unset",     keepGoing unsetOptions,         completeSetOptions)
 159   ]
 160
 161
 162 -- We initialize readline (in the interactiveUI function) to use
 163 -- word_break_chars as the default set of completion word break characters.
 164 -- This can be overridden for a particular command (for example, filename
 165 -- expansion shouldn't consider '/' to be a word break) by setting the third
 166 -- entry in the Command tuple above.
 167 --
 168 -- NOTE: in order for us to override the default correctly, any custom entry
 169 -- must be a SUBSET of word_break_chars.
 170 word_break_chars :: String
 171 word_break_chars = let symbols = "!#$%&*+/<=>?@\\^|-~"
 172                        specials = "(),;[]`{}"
 173                        spaces = " \t\n"
 174                    in spaces ++ specials ++ symbols
 175
 176 flagWordBreakChars :: String
 177 flagWordBreakChars = " \t\n"
 178
 179
 180 keepGoing :: (String -> GHCi ()) -> (String -> InputT GHCi Bool)
 181 keepGoing a str = keepGoing' (lift . a) str
 182
 183 keepGoing' :: Monad m => (String -> m ()) -> String -> m Bool
 184 keepGoing' a str = a str >> return False
 185
 186 keepGoingPaths :: ([FilePath] -> InputT GHCi ()) -> (String -> InputT GHCi Bool)
 187 keepGoingPaths a str
 188  = do case toArgs str of
 189           Left err -> Encoding.encode err >>= liftIO . BS.hPutStrLn stderr
 190           Right args -> a args
 191       return False
 192
 193 shortHelpText :: String
 194 shortHelpText = "use :? for help.\n"
 195
 196 helpText :: String
 197 helpText =
 198  " Commands available from the prompt:\n" ++
 199  "\n" ++
 200  "   <statement>                 evaluate/run <statement>\n" ++
 201  "   :                           repeat last command\n" ++
 202  "   :{\\n ..lines.. \\n:}\\n       multiline command\n" ++
 203  "   :add [*]<module> ...        add module(s) to the current target set\n" ++
 204  "   :browse[!] [[*]<mod>]       display the names defined by module <mod>\n" ++
 205  "                               (!: more details; *: all top-level names)\n" ++
 206  "   :cd <dir>                   change directory to <dir>\n" ++
 207  "   :cmd <expr>                 run the commands returned by <expr>::IO String\n" ++
 208  "   :ctags[!] [<file>]          create tags file for Vi (default: \"tags\")\n" ++
 209  "                               (!: use regex instead of line number)\n" ++
 210  "   :def <cmd> <expr>           define a command :<cmd>\n" ++
 211  "   :edit <file>                edit file\n" ++
 212  "   :edit                       edit last module\n" ++
 213  "   :etags [<file>]             create tags file for Emacs (default: \"TAGS\")\n" ++
 214  "   :help, :?                   display this list of commands\n" ++
 215  "   :info [<name> ...]          display information about the given names\n" ++
 216  "   :kind <type>                show the kind of <type>\n" ++
 217  "   :load [*]<module> ...       load module(s) and their dependents\n" ++
 218  "   :main [<arguments> ...]     run the main function with the given arguments\n" ++
 219  "   :module [+/-] [*]<mod> ...  set the context for expression evaluation\n" ++
 220  "   :quit                       exit GHCi\n" ++
 221  "   :reload                     reload the current module set\n" ++
 222  "   :run function [<arguments> ...] run the function with the given arguments\n" ++
 223  "   :type <expr>                show the type of <expr>\n" ++
 224  "   :undef <cmd>                undefine user-defined command :<cmd>\n" ++
 225  "   :!<command>                 run the shell command <command>\n" ++
 226  "\n" ++
 227  " -- Commands for debugging:\n" ++
 228  "\n" ++
 229  "   :abandon                    at a breakpoint, abandon current computation\n" ++
 230  "   :back                       go back in the history (after :trace)\n" ++
 231  "   :break [<mod>] <l> [<col>]  set a breakpoint at the specified location\n" ++
 232  "   :break <name>               set a breakpoint on the specified function\n" ++
 233  "   :continue                   resume after a breakpoint\n" ++
 234  "   :delete <number>            delete the specified breakpoint\n" ++
 235  "   :delete *                   delete all breakpoints\n" ++
 236  "   :force <expr>               print <expr>, forcing unevaluated parts\n" ++
 237  "   :forward                    go forward in the history (after :back)\n" ++
 238  "   :history [<n>]              after :trace, show the execution history\n" ++
 239  "   :list                       show the source code around current breakpoint\n" ++
 240  "   :list identifier            show the source code for <identifier>\n" ++
 241  "   :list [<module>] <line>     show the source code around line number <line>\n" ++
 242  "   :print [<name> ...]         prints a value without forcing its computation\n" ++
 243  "   :sprint [<name> ...]        simplifed version of :print\n" ++
 244  "   :step                       single-step after stopping at a breakpoint\n"++
 245  "   :step <expr>                single-step into <expr>\n"++
 246  "   :steplocal                  single-step within the current top-level binding\n"++
 247  "   :stepmodule                 single-step restricted to the current module\n"++
 248  "   :trace                      trace after stopping at a breakpoint\n"++
 249  "   :trace <expr>               evaluate <expr> with tracing on (see :history)\n"++
 250
 251  "\n" ++
 252  " -- Commands for changing settings:\n" ++
 253  "\n" ++
 254  "   :set <option> ...           set options\n" ++
 255  "   :set args <arg> ...         set the arguments returned by System.getArgs\n" ++
 256  "   :set prog <progname>        set the value returned by System.getProgName\n" ++
 257  "   :set prompt <prompt>        set the prompt used in GHCi\n" ++
 258  "   :set editor <cmd>           set the command used for :edit\n" ++
 259  "   :set stop [<n>] <cmd>       set the command to run when a breakpoint is hit\n" ++
 260  "   :unset <option> ...         unset options\n" ++
 261  "\n" ++
 262  "  Options for ':set' and ':unset':\n" ++
 263  "\n" ++
 264  "    +r            revert top-level expressions after each evaluation\n" ++
 265  "    +s            print timing/memory stats after each evaluation\n" ++
 266  "    +t            print type after evaluation\n" ++
 267  "    -<flags>      most GHC command line flags can also be set here\n" ++
 268  "                         (eg. -v2, -fglasgow-exts, etc.)\n" ++
 269  "                    for GHCi-specific flags, see User's Guide,\n"++
 270  "                    Flag reference, Interactive-mode options\n" ++
 271  "\n" ++
 272  " -- Commands for displaying information:\n" ++
 273  "\n" ++
 274  "   :show bindings              show the current bindings made at the prompt\n" ++
 275  "   :show breaks                show the active breakpoints\n" ++
 276  "   :show context               show the breakpoint context\n" ++
 277  "   :show modules               show the currently loaded modules\n" ++
 278  "   :show packages              show the currently active package flags\n" ++
 279  "   :show languages             show the currently active language flags\n" ++
 280  "   :show <setting>             show value of <setting>, which is one of\n" ++
 281  "                                  [args, prog, prompt, editor, stop]\n" ++
 282  "\n"
 283
 284 findEditor :: IO String
 285 findEditor = do
 286   getEnv "EDITOR"
 287     `IO.catch` \_ -> do
 288 #if mingw32_HOST_OS
 289         win <- System.Win32.getWindowsDirectory
 290         return (win </> "notepad.exe")
 291 #else
 292         return ""
 293 #endif
 294
 295 foreign import ccall unsafe "rts_isProfiled" isProfiled :: IO CInt
 296
 297 interactiveUI :: [(FilePath, Maybe Phase)] -> Maybe [String]
 298               -> Ghc ()
 299 interactiveUI srcs maybe_exprs = do
 300    -- although GHCi compiles with -prof, it is not usable: the byte-code
 301    -- compiler and interpreter don't work with profiling.  So we check for
 302    -- this up front and emit a helpful error message (#2197)
 303    i <- liftIO $ isProfiled
 304    when (i /= 0) $
 305      ghcError (InstallationError "GHCi cannot be used when compiled with -prof")
 306
 307    -- HACK! If we happen to get into an infinite loop (eg the user
 308    -- types 'let x=x in x' at the prompt), then the thread will block
 309    -- on a blackhole, and become unreachable during GC.  The GC will
 310    -- detect that it is unreachable and send it the NonTermination
 311    -- exception.  However, since the thread is unreachable, everything
 312    -- it refers to might be finalized, including the standard Handles.
 313    -- This sounds like a bug, but we don't have a good solution right
 314    -- now.
 315    _ <- liftIO $ newStablePtr stdin
 316    _ <- liftIO $ newStablePtr stdout
 317    _ <- liftIO $ newStablePtr stderr
 318
 319     -- Initialise buffering for the *interpreted* I/O system
 320    initInterpBuffering
 321
 322    liftIO $ when (isNothing maybe_exprs) $ do
 323         -- Only for GHCi (not runghc and ghc -e):
 324
 325         -- Turn buffering off for the compiled program's stdout/stderr
 326         turnOffBuffering
 327         -- Turn buffering off for GHCi's stdout
 328         hFlush stdout
 329         hSetBuffering stdout NoBuffering
 330         -- We don't want the cmd line to buffer any input that might be
 331         -- intended for the program, so unbuffer stdin.
 332         hSetBuffering stdin NoBuffering
 333 #if defined(mingw32_HOST_OS) && __GLASGOW_HASKELL__ >= 611
 334         -- On Unix, stdin will use the locale encoding.  The IO library
 335         -- doesn't do this on Windows (yet), so for now we use UTF-8,
 336         -- for consistency with GHC 6.10 and to make the tests work.
 337         hSetEncoding stdin utf8
 338 #endif
 339
 340    -- initial context is just the Prelude
 341    prel_mod <- GHC.lookupModule (GHC.mkModuleName "Prelude") Nothing
 342    GHC.setContext [] [(prel_mod, Nothing)]
 343
 344    default_editor <- liftIO $ findEditor
 345
 346    startGHCi (runGHCi srcs maybe_exprs)
 347         GHCiState{ progname = "<interactive>",
 348                    args = [],
 349                    prompt = "%s> ",
 350                    stop = "",
 351                    editor = default_editor,
 352 --                   session = session,
 353                    options = [],
 354                    prelude = prel_mod,
 355                    break_ctr = 0,
 356                    breaks = [],
 357                    tickarrays = emptyModuleEnv,
 358                    last_command = Nothing,
 359                    cmdqueue = [],
 360                    remembered_ctx = [],
 361                    ghc_e = isJust maybe_exprs
 362                  }
 363
 364    return ()
 365
 366 withGhcAppData :: (FilePath -> IO a) -> IO a -> IO a
 367 withGhcAppData right left = do
 368    either_dir <- IO.try (getAppUserDataDirectory "ghc")
 369    case either_dir of
 370       Right dir -> right dir
 371       _ -> left
 372
 373 runGHCi :: [(FilePath, Maybe Phase)] -> Maybe [String] -> GHCi ()
 374 runGHCi paths maybe_exprs = do
 375   let
 376    read_dot_files = not opt_IgnoreDotGhci
 377
 378    current_dir = return (Just ".ghci")
 379
 380    app_user_dir = io $ withGhcAppData
 381                     (\dir -> return (Just (dir </> "ghci.conf")))
 382                     (return Nothing)
 383
 384    home_dir = do
 385     either_dir <- io $ IO.try (getEnv "HOME")
 386     case either_dir of
 387       Right home -> return (Just (home </> ".ghci"))
 388       _ -> return Nothing
 389
 390    canonicalizePath' :: FilePath -> IO (Maybe FilePath)
 391    canonicalizePath' fp = liftM Just (canonicalizePath fp)
 392                 `catchIO` \_ -> return Nothing
 393
 394    sourceConfigFile :: FilePath -> GHCi ()
 395    sourceConfigFile file = do
 396      exists <- io $ doesFileExist file
 397      when exists $ do
 398        dir_ok  <- io $ checkPerms (getDirectory file)
 399        file_ok <- io $ checkPerms file
 400        when (dir_ok && file_ok) $ do
 401          either_hdl <- io $ IO.try (openFile file ReadMode)
 402          case either_hdl of
 403            Left _e   -> return ()
 404            -- NOTE: this assumes that runInputT won't affect the terminal;
 405            -- can we assume this will always be the case?
 406            -- This would be a good place for runFileInputT.
 407            Right hdl -> runInputTWithPrefs defaultPrefs defaultSettings $ do
 408                             runCommands $ fileLoop hdl
 409      where
 410       getDirectory f = case takeDirectory f of "" -> "."; d -> d
 411
 412   when (read_dot_files) $ do
 413     mcfgs0 <- sequence [ current_dir, app_user_dir, home_dir ]
 414     mcfgs <- io $ mapM canonicalizePath' (catMaybes mcfgs0)
 415     mapM_ sourceConfigFile $ nub $ catMaybes mcfgs
 416         -- nub, because we don't want to read .ghci twice if the
 417         -- CWD is $HOME.
 418
 419   -- Perform a :load for files given on the GHCi command line
 420   -- When in -e mode, if the load fails then we want to stop
 421   -- immediately rather than going on to evaluate the expression.
 422   when (not (null paths)) $ do
 423      ok <- ghciHandle (\e -> do showException e; return Failed) $
 424                 -- TODO: this is a hack.
 425                 runInputTWithPrefs defaultPrefs defaultSettings $ do
 426                     let (filePaths, phases) = unzip paths
 427                     filePaths' <- mapM (Encoding.decode . BS.pack) filePaths
 428                     loadModule (zip filePaths' phases)
 429      when (isJust maybe_exprs && failed ok) $
 430         io (exitWith (ExitFailure 1))
 431
 432   -- if verbosity is greater than 0, or we are connected to a
 433   -- terminal, display the prompt in the interactive loop.
 434   is_tty <- io (hIsTerminalDevice stdin)
 435   dflags <- getDynFlags
 436   let show_prompt = verbosity dflags > 0 || is_tty
 437
 438   case maybe_exprs of
 439         Nothing ->
 440           do
 441             -- enter the interactive loop
 442             runGHCiInput $ runCommands $ nextInputLine show_prompt is_tty
 443         Just exprs -> do
 444             -- just evaluate the expression we were given
 445             enqueueCommands exprs
 446             let handle e = do st <- getGHCiState
 447                               -- flush the interpreter's stdout/stderr on exit (#3890)
 448                               flushInterpBuffers
 449                                    -- Jump through some hoops to get the
 450                                    -- current progname in the exception text:
 451                                    -- <progname>: <exception>
 452                               io $ withProgName (progname st)
 453                                    -- this used to be topHandlerFastExit, see #2228
 454                                  $ topHandler e
 455             runInputTWithPrefs defaultPrefs defaultSettings $ do
 456                 runCommands' handle (return Nothing)
 457
 458   -- and finally, exit
 459   io $ do when (verbosity dflags > 0) $ putStrLn "Leaving GHCi."
 460
 461 runGHCiInput :: InputT GHCi a -> GHCi a
 462 runGHCiInput f = do
 463     histFile <- io $ withGhcAppData (\dir -> return (Just (dir </> "ghci_history")))
 464                         (return Nothing)
 465     let settings = setComplete ghciCompleteWord
 466                     $ defaultSettings {historyFile = histFile}
 467     runInputT settings f
 468
 469 nextInputLine :: Bool -> Bool -> InputT GHCi (Maybe String)
 470 nextInputLine show_prompt is_tty
 471   | is_tty = do
 472     prompt <- if show_prompt then lift mkPrompt else return ""
 473     getInputLine prompt
 474   | otherwise = do
 475     when show_prompt $ lift mkPrompt >>= liftIO . putStr
 476     fileLoop stdin
 477
 478 -- NOTE: We only read .ghci files if they are owned by the current user,
 479 -- and aren't world writable.  Otherwise, we could be accidentally
 480 -- running code planted by a malicious third party.
 481
 482 -- Furthermore, We only read ./.ghci if . is owned by the current user
 483 -- and isn't writable by anyone else.  I think this is sufficient: we
 484 -- don't need to check .. and ../.. etc. because "."  always refers to
 485 -- the same directory while a process is running.
 486
 487 checkPerms :: String -> IO Bool
 488 #ifdef mingw32_HOST_OS
 489 checkPerms _ =
 490   return True
 491 #else
 492 checkPerms name =
 493   handleIO (\_ -> return False) $ do
 494      st <- getFileStatus name
 495      me <- getRealUserID
 496      if fileOwner st /= me then do
 497         putStrLn $ "WARNING: " ++ name ++ " is owned by someone else, IGNORING!"
 498         return False
 499       else do
 500         let mode =  fileMode st
 501         if (groupWriteMode == (mode `intersectFileModes` groupWriteMode))
 502            || (otherWriteMode == (mode `intersectFileModes` otherWriteMode))
 503            then do
 504                putStrLn $ "*** WARNING: " ++ name ++
 505                           " is writable by someone else, IGNORING!"
 506                return False
 507           else return True
 508 #endif
 509
 510 fileLoop :: MonadIO m => Handle -> InputT m (Maybe String)
 511 fileLoop hdl = do
 512    l <- liftIO $ IO.try $ hGetLine hdl
 513    case l of
 514         Left e | isEOFError e              -> return Nothing
 515                | InvalidArgument <- etype  -> return Nothing
 516                | otherwise                 -> liftIO $ ioError e
 517                 where etype = ioeGetErrorType e
 518                 -- treat InvalidArgument in the same way as EOF:
 519                 -- this can happen if the user closed stdin, or
 520                 -- perhaps did getContents which closes stdin at
 521                 -- EOF.
 522         Right l -> return (Just l)
 523
 524 mkPrompt :: GHCi String
 525 mkPrompt = do
 526   (toplevs,exports) <- GHC.getContext
 527   resumes <- GHC.getResumeContext
 528   -- st <- getGHCiState
 529
 530   context_bit <-
 531         case resumes of
 532             [] -> return empty
 533             r:_ -> do
 534                 let ix = GHC.resumeHistoryIx r
 535                 if ix == 0
 536                    then return (brackets (ppr (GHC.resumeSpan r)) <> space)
 537                    else do
 538                         let hist = GHC.resumeHistory r !! (ix-1)
 539                         span <- GHC.getHistorySpan hist
 540                         return (brackets (ppr (negate ix) <> char ':'
 541                                           <+> ppr span) <> space)
 542   let
 543         dots | _:rs <- resumes, not (null rs) = text "... "
 544              | otherwise = empty
 545
 546         modules_bit =
 547        -- ToDo: maybe...
 548        --  let (btoplevs, bexports) = fromMaybe ([],[]) (remembered_ctx st) in
 549        --  hsep (map (\m -> text "!*" <> ppr (GHC.moduleName m)) btoplevs) <+>
 550        --  hsep (map (\m -> char '!'  <> ppr (GHC.moduleName m)) bexports) <+>
 551              hsep (map (\m -> char '*'  <> ppr (GHC.moduleName m)) toplevs) <+>
 552              hsep (map (ppr . GHC.moduleName) (nub (map fst exports)))
 553
 554         deflt_prompt = dots <> context_bit <> modules_bit
 555
 556         f ('%':'s':xs) = deflt_prompt <> f xs
 557         f ('%':'%':xs) = char '%' <> f xs
 558         f (x:xs) = char x <> f xs
 559         f [] = empty
 560    --
 561   st <- getGHCiState
 562   return (showSDoc (f (prompt st)))
 563
 564
 565 queryQueue :: GHCi (Maybe String)
 566 queryQueue = do
 567   st <- getGHCiState
 568   case cmdqueue st of
 569     []   -> return Nothing
 570     c:cs -> do setGHCiState st{ cmdqueue = cs }
 571                return (Just c)
 572
 573 runCommands :: InputT GHCi (Maybe String) -> InputT GHCi ()
 574 runCommands = runCommands' handler
 575
 576 runCommands' :: (SomeException -> GHCi Bool) -- Exception handler
 577              -> InputT GHCi (Maybe String) -> InputT GHCi ()
 578 runCommands' eh getCmd = do
 579     b <- ghandle (\e -> case fromException e of
 580                           Just UserInterrupt -> return False
 581                           _ -> case fromException e of
 582                                  Just ghc_e ->
 583                                    do liftIO (print (ghc_e :: GhcException))
 584                                       return True
 585                                  _other ->
 586                                    liftIO (Exception.throwIO e))
 587             (runOneCommand eh getCmd)
 588     if b then return () else runCommands' eh getCmd
 589
 590 runOneCommand :: (SomeException -> GHCi Bool) -> InputT GHCi (Maybe String)
 591             -> InputT GHCi Bool
 592 runOneCommand eh getCmd = do
 593   mb_cmd <- noSpace (lift queryQueue)
 594   mb_cmd <- maybe (noSpace getCmd) (return . Just) mb_cmd
 595   case mb_cmd of
 596     Nothing -> return True
 597     Just c  -> ghciHandle (lift . eh) $
 598              handleSourceError printErrorAndKeepGoing
 599                (doCommand c)
 600   where
 601     printErrorAndKeepGoing err = do
 602         GHC.printExceptionAndWarnings err
 603         return False
 604
 605     noSpace q = q >>= maybe (return Nothing)
 606                             (\c->case removeSpaces c of
 607                                    ""   -> noSpace q
 608                                    ":{" -> multiLineCmd q
 609                                    c    -> return (Just c) )
 610     multiLineCmd q = do
 611       st <- lift getGHCiState
 612       let p = prompt st
 613       lift $ setGHCiState st{ prompt = "%s| " }
 614       mb_cmd <- collectCommand q ""
 615       lift $ getGHCiState >>= \st->setGHCiState st{ prompt = p }
 616       return mb_cmd
 617     -- we can't use removeSpaces for the sublines here, so
 618     -- multiline commands are somewhat more brittle against
 619     -- fileformat errors (such as \r in dos input on unix),
 620     -- we get rid of any extra spaces for the ":}" test;
 621     -- we also avoid silent failure if ":}" is not found;
 622     -- and since there is no (?) valid occurrence of \r (as
 623     -- opposed to its String representation, "\r") inside a
 624     -- ghci command, we replace any such with ' ' (argh:-(
 625     collectCommand q c = q >>=
 626       maybe (liftIO (ioError collectError))
 627             (\l->if removeSpaces l == ":}"
 628                  then return (Just $ removeSpaces c)
 629                  else collectCommand q (c ++ "\n" ++ map normSpace l))
 630       where normSpace '\r' = ' '
 631             normSpace   c  = c
 632     -- QUESTION: is userError the one to use here?
 633     collectError = userError "unterminated multiline command :{ .. :}"
 634     doCommand (':' : cmd) = specialCommand cmd
 635     doCommand stmt        = do _ <- timeIt $ lift $ runStmt stmt GHC.RunToCompletion
 636                                return False
 637
 638 enqueueCommands :: [String] -> GHCi ()
 639 enqueueCommands cmds = do
 640   st <- getGHCiState
 641   setGHCiState st{ cmdqueue = cmds ++ cmdqueue st }
 642
 643
 644 runStmt :: String -> SingleStep -> GHCi Bool
 645 runStmt stmt step
 646  | null (filter (not.isSpace) stmt)
 647  = return False
 648  | "import " `isPrefixOf` stmt
 649  = do newContextCmd (Import stmt); return False
 650  | otherwise
 651  = do
 652 #if __GLASGOW_HASKELL__ >= 611
 653       -- In the new IO library, read handles buffer data even if the Handle
 654       -- is set to NoBuffering.  This causes problems for GHCi where there
 655       -- are really two stdin Handles.  So we flush any bufferred data in
 656       -- GHCi's stdin Handle here (only relevant if stdin is attached to
 657       -- a file, otherwise the read buffer can't be flushed).
 658       _ <- liftIO $ IO.try $ hFlushAll stdin
 659 #endif
 660       result <- GhciMonad.runStmt stmt step
 661       afterRunStmt (const True) result
 662
 663 --afterRunStmt :: GHC.RunResult -> GHCi Bool
 664                                  -- False <=> the statement failed to compile
 665 afterRunStmt :: (SrcSpan -> Bool) -> GHC.RunResult -> GHCi Bool
 666 afterRunStmt _ (GHC.RunException e) = throw e
 667 afterRunStmt step_here run_result = do
 668   resumes <- GHC.getResumeContext
 669   case run_result of
 670      GHC.RunOk names -> do
 671         show_types <- isOptionSet ShowType
 672         when show_types $ printTypeOfNames names
 673      GHC.RunBreak _ names mb_info
 674          | isNothing  mb_info ||
 675            step_here (GHC.resumeSpan $ head resumes) -> do
 676                mb_id_loc <- toBreakIdAndLocation mb_info
 677                let breakCmd = maybe "" ( \(_,l) -> onBreakCmd l ) mb_id_loc
 678                if (null breakCmd)
 679                  then printStoppedAtBreakInfo (head resumes) names
 680                  else enqueueCommands [breakCmd]
 681                -- run the command set with ":set stop <cmd>"
 682                st <- getGHCiState
 683                enqueueCommands [stop st]
 684                return ()
 685          | otherwise -> resume step_here GHC.SingleStep >>=
 686                         afterRunStmt step_here >> return ()
 687      _ -> return ()
 688
 689   flushInterpBuffers
 690   io installSignalHandlers
 691   b <- isOptionSet RevertCAFs
 692   when b revertCAFs
 693
 694   return (case run_result of GHC.RunOk _ -> True; _ -> False)
 695
 696 toBreakIdAndLocation ::
 697   Maybe GHC.BreakInfo -> GHCi (Maybe (Int, BreakLocation))
 698 toBreakIdAndLocation Nothing = return Nothing
 699 toBreakIdAndLocation (Just info) = do
 700   let mod = GHC.breakInfo_module info
 701       nm  = GHC.breakInfo_number info
 702   st <- getGHCiState
 703   return $ listToMaybe [ id_loc | id_loc@(_,loc) <- breaks st,
 704                                   breakModule loc == mod,
 705                                   breakTick loc == nm ]
 706
 707 printStoppedAtBreakInfo :: Resume -> [Name] -> GHCi ()
 708 printStoppedAtBreakInfo resume names = do
 709   printForUser $ ptext (sLit "Stopped at") <+>
 710     ppr (GHC.resumeSpan resume)
 711   --  printTypeOfNames session names
 712   let namesSorted = sortBy compareNames names
 713   tythings <- catMaybes `liftM` mapM GHC.lookupName namesSorted
 714   docs <- pprTypeAndContents [id | AnId id <- tythings]
 715   printForUserPartWay docs
 716
 717 printTypeOfNames :: [Name] -> GHCi ()
 718 printTypeOfNames names
 719  = mapM_ (printTypeOfName ) $ sortBy compareNames names
 720
 721 compareNames :: Name -> Name -> Ordering
 722 n1 `compareNames` n2 = compareWith n1 `compare` compareWith n2
 723     where compareWith n = (getOccString n, getSrcSpan n)
 724
 725 printTypeOfName :: Name -> GHCi ()
 726 printTypeOfName n
 727    = do maybe_tything <- GHC.lookupName n
 728         case maybe_tything of
 729             Nothing    -> return ()
 730             Just thing -> printTyThing thing
 731
 732
 733 data MaybeCommand = GotCommand Command | BadCommand | NoLastCommand
 734
 735 specialCommand :: String -> InputT GHCi Bool
 736 specialCommand ('!':str) = lift $ shellEscape (dropWhile isSpace str)
 737 specialCommand str = do
 738   let (cmd,rest) = break isSpace str
 739   maybe_cmd <- lift $ lookupCommand cmd
 740   case maybe_cmd of
 741     GotCommand (_,f,_) -> f (dropWhile isSpace rest)
 742     BadCommand ->
 743       do liftIO $ hPutStr stdout ("unknown command ':" ++ cmd ++ "'\n"
 744                            ++ shortHelpText)
 745          return False
 746     NoLastCommand ->
 747       do liftIO $ hPutStr stdout ("there is no last command to perform\n"
 748                            ++ shortHelpText)
 749          return False
 750
 751 lookupCommand :: String -> GHCi (MaybeCommand)
 752 lookupCommand "" = do
 753   st <- getGHCiState
 754   case last_command st of
 755       Just c -> return $ GotCommand c
 756       Nothing -> return NoLastCommand
 757 lookupCommand str = do
 758   mc <- io $ lookupCommand' str
 759   st <- getGHCiState
 760   setGHCiState st{ last_command = mc }
 761   return $ case mc of
 762            Just c -> GotCommand c
 763            Nothing -> BadCommand
 764
 765 lookupCommand' :: String -> IO (Maybe Command)
 766 lookupCommand' ":" = return Nothing
 767 lookupCommand' str' = do
 768   macros <- readIORef macros_ref
 769   let{ (str, cmds) = case str' of
 770       ':' : rest -> (rest, builtin_commands)
 771       _ -> (str', macros ++ builtin_commands) }
 772   -- look for exact match first, then the first prefix match
 773   return $ case [ c | c <- cmds, str == cmdName c ] of
 774            c:_ -> Just c
 775            [] -> case [ c | c@(s,_,_) <- cmds, str `isPrefixOf` s ] of
 776                  [] -> Nothing
 777                  c:_ -> Just c
 778
 779 getCurrentBreakSpan :: GHCi (Maybe SrcSpan)
 780 getCurrentBreakSpan = do
 781   resumes <- GHC.getResumeContext
 782   case resumes of
 783     [] -> return Nothing
 784     (r:_) -> do
 785         let ix = GHC.resumeHistoryIx r
 786         if ix == 0
 787            then return (Just (GHC.resumeSpan r))
 788            else do
 789                 let hist = GHC.resumeHistory r !! (ix-1)
 790                 span <- GHC.getHistorySpan hist
 791                 return (Just span)
 792
 793 getCurrentBreakModule :: GHCi (Maybe Module)
 794 getCurrentBreakModule = do
 795   resumes <- GHC.getResumeContext
 796   case resumes of
 797     [] -> return Nothing
 798     (r:_) -> do
 799         let ix = GHC.resumeHistoryIx r
 800         if ix == 0
 801            then return (GHC.breakInfo_module `liftM` GHC.resumeBreakInfo r)
 802            else do
 803                 let hist = GHC.resumeHistory r !! (ix-1)
 804                 return $ Just $ GHC.getHistoryModule  hist
 805
 806 -----------------------------------------------------------------------------
 807 -- Commands
 808
 809 noArgs :: GHCi () -> String -> GHCi ()
 810 noArgs m "" = m
 811 noArgs _ _  = io $ putStrLn "This command takes no arguments"
 812
 813 help :: String -> GHCi ()
 814 help _ = io (putStr helpText)
 815
 816 info :: String -> InputT GHCi ()
 817 info "" = ghcError (CmdLineError "syntax: ':i <thing-you-want-info-about>'")
 818 info s  = handleSourceError GHC.printExceptionAndWarnings $ do
 819              { let names = words s
 820              ; dflags <- getDynFlags
 821              ; let pefas = dopt Opt_PrintExplicitForalls dflags
 822              ; mapM_ (infoThing pefas) names }
 823   where
 824     infoThing pefas str = do
 825         names     <- GHC.parseName str
 826         mb_stuffs <- mapM GHC.getInfo names
 827         let filtered = filterOutChildren (\(t,_f,_i) -> t) (catMaybes mb_stuffs)
 828         unqual <- GHC.getPrintUnqual
 829         outputStrLn $ showSDocForUser unqual $
 830                      vcat (intersperse (text "") $
 831                            map (pprInfo pefas) filtered)
 832
 833   -- Filter out names whose parent is also there Good
 834   -- example is '[]', which is both a type and data
 835   -- constructor in the same type
 836 filterOutChildren :: (a -> TyThing) -> [a] -> [a]
 837 filterOutChildren get_thing xs
 838   = filterOut has_parent xs
 839   where
 840     all_names = mkNameSet (map (getName . get_thing) xs)
 841     has_parent x = case pprTyThingParent_maybe (get_thing x) of
 842                      Just p  -> getName p `elemNameSet` all_names
 843                      Nothing -> False
 844
 845 pprInfo :: PrintExplicitForalls -> (TyThing, Fixity, [GHC.Instance]) -> SDoc
 846 pprInfo pefas (thing, fixity, insts)
 847   =  pprTyThingInContextLoc pefas thing
 848   $$ show_fixity fixity
 849   $$ vcat (map GHC.pprInstance insts)
 850   where
 851     show_fixity fix
 852         | fix == GHC.defaultFixity = empty
 853         | otherwise                = ppr fix <+> ppr (GHC.getName thing)
 854
 855 runMain :: String -> GHCi ()
 856 runMain s = case toArgs s of
 857             Left err   -> io (hPutStrLn stderr err)
 858             Right args ->
 859                 do dflags <- getDynFlags
 860                    case mainFunIs dflags of
 861                        Nothing -> doWithArgs args "main"
 862                        Just f  -> doWithArgs args f
 863
 864 runRun :: String -> GHCi ()
 865 runRun s = case toCmdArgs s of
 866            Left err          -> io (hPutStrLn stderr err)
 867            Right (cmd, args) -> doWithArgs args cmd
 868
 869 doWithArgs :: [String] -> String -> GHCi ()
 870 doWithArgs args cmd = enqueueCommands ["System.Environment.withArgs " ++
 871                                        show args ++ " (" ++ cmd ++ ")"]
 872
 873 addModule :: [FilePath] -> InputT GHCi ()
 874 addModule files = do
 875   lift revertCAFs -- always revert CAFs on load/add.
 876   files <- mapM expandPath files
 877   targets <- mapM (\m -> GHC.guessTarget m Nothing) files
 878   -- remove old targets with the same id; e.g. for :add *M
 879   mapM_ GHC.removeTarget [ tid | Target tid _ _ <- targets ]
 880   mapM_ GHC.addTarget targets
 881   prev_context <- GHC.getContext
 882   ok <- trySuccess $ GHC.load LoadAllTargets
 883   afterLoad ok False prev_context
 884
 885 changeDirectory :: String -> InputT GHCi ()
 886 changeDirectory "" = do
 887   -- :cd on its own changes to the user's home directory
 888   either_dir <- liftIO $ IO.try getHomeDirectory
 889   case either_dir of
 890      Left _e -> return ()
 891      Right dir -> changeDirectory dir
 892 changeDirectory dir = do
 893   graph <- GHC.getModuleGraph
 894   when (not (null graph)) $
 895         outputStr "Warning: changing directory causes all loaded modules to be unloaded,\nbecause the search path has changed.\n"
 896   prev_context <- GHC.getContext
 897   GHC.setTargets []
 898   _ <- GHC.load LoadAllTargets
 899   lift $ setContextAfterLoad prev_context False []
 900   GHC.workingDirectoryChanged
 901   dir <- expandPath dir
 902   liftIO $ setCurrentDirectory dir
 903
 904 trySuccess :: GHC.GhcMonad m => m SuccessFlag -> m SuccessFlag
 905 trySuccess act =
 906     handleSourceError (\e -> do GHC.printExceptionAndWarnings e
 907                                 return Failed) $ do
 908       act
 909
 910 editFile :: String -> GHCi ()
 911 editFile str =
 912   do file <- if null str then chooseEditFile else return str
 913      st <- getGHCiState
 914      let cmd = editor st
 915      when (null cmd)
 916        $ ghcError (CmdLineError "editor not set, use :set editor")
 917      _ <- io $ system (cmd ++ ' ':file)
 918      return ()
 919
 920 -- The user didn't specify a file so we pick one for them.
 921 -- Our strategy is to pick the first module that failed to load,
 922 -- or otherwise the first target.
 923 --
 924 -- XXX: Can we figure out what happened if the depndecy analysis fails
 925 --      (e.g., because the porgrammeer mistyped the name of a module)?
 926 -- XXX: Can we figure out the location of an error to pass to the editor?
 927 -- XXX: if we could figure out the list of errors that occured during the
 928 -- last load/reaload, then we could start the editor focused on the first
 929 -- of those.
 930 chooseEditFile :: GHCi String
 931 chooseEditFile =
 932   do let hasFailed x = fmap not $ GHC.isLoaded $ GHC.ms_mod_name x
 933
 934      graph <- GHC.getModuleGraph
 935      failed_graph <- filterM hasFailed graph
 936      let order g  = flattenSCCs $ GHC.topSortModuleGraph True g Nothing
 937          pick xs  = case xs of
 938                       x : _ -> GHC.ml_hs_file (GHC.ms_location x)
 939                       _     -> Nothing
 940
 941      case pick (order failed_graph) of
 942        Just file -> return file
 943        Nothing   ->
 944          do targets <- GHC.getTargets
 945             case msum (map fromTarget targets) of
 946               Just file -> return file
 947               Nothing   -> ghcError (CmdLineError "No files to edit.")
 948
 949   where fromTarget (GHC.Target (GHC.TargetFile f _) _ _) = Just f
 950         fromTarget _ = Nothing -- when would we get a module target?
 951
 952 defineMacro :: Bool{-overwrite-} -> String -> GHCi ()
 953 defineMacro _ (':':_) =
 954   io $ putStrLn "macro name cannot start with a colon"
 955 defineMacro overwrite s = do
 956   let (macro_name, definition) = break isSpace s
 957   macros <- io (readIORef macros_ref)
 958   let defined = map cmdName macros
 959   if (null macro_name)
 960         then if null defined
 961                 then io $ putStrLn "no macros defined"
 962                 else io $ putStr ("the following macros are defined:\n" ++
 963                                   unlines defined)
 964         else do
 965   if (not overwrite && macro_name `elem` defined)
 966         then ghcError (CmdLineError
 967                 ("macro '" ++ macro_name ++ "' is already defined"))
 968         else do
 969
 970   let filtered = [ cmd | cmd <- macros, cmdName cmd /= macro_name ]
 971
 972   -- give the expression a type signature, so we can be sure we're getting
 973   -- something of the right type.
 974   let new_expr = '(' : definition ++ ") :: String -> IO String"
 975
 976   -- compile the expression
 977   handleSourceError (\e -> GHC.printExceptionAndWarnings e) $ do
 978     hv <- GHC.compileExpr new_expr
 979     io (writeIORef macros_ref --
 980         (filtered ++ [(macro_name, lift . runMacro hv, noCompletion)]))
 981
 982 runMacro :: GHC.HValue{-String -> IO String-} -> String -> GHCi Bool
 983 runMacro fun s = do
 984   str <- io ((unsafeCoerce# fun :: String -> IO String) s)
 985   -- make sure we force any exceptions in the result, while we are still
 986   -- inside the exception handler for commands:
 987   seqList str (return ())
 988   enqueueCommands (lines str)
 989   return False
 990
 991 undefineMacro :: String -> GHCi ()
 992 undefineMacro str = mapM_ undef (words str)
 993  where undef macro_name = do
 994         cmds <- io (readIORef macros_ref)
 995         if (macro_name `notElem` map cmdName cmds)
 996            then ghcError (CmdLineError
 997                 ("macro '" ++ macro_name ++ "' is not defined"))
 998            else do
 999             io (writeIORef macros_ref (filter ((/= macro_name) . cmdName) cmds))
1000
1001 cmdCmd :: String -> GHCi ()
1002 cmdCmd str = do
1003   let expr = '(' : str ++ ") :: IO String"
1004   handleSourceError (\e -> GHC.printExceptionAndWarnings e) $ do
1005     hv <- GHC.compileExpr expr
1006     cmds <- io $ (unsafeCoerce# hv :: IO String)
1007     enqueueCommands (lines cmds)
1008     return ()
1009
1010 loadModuleName :: GHC.GhcMonad m => ImportDecl RdrName -> m Module
1011 loadModuleName = flip GHC.findModule Nothing . unLoc . ideclName
1012
1013 loadModule :: [(FilePath, Maybe Phase)] -> InputT GHCi SuccessFlag
1014 loadModule fs = timeIt (loadModule' fs)
1015
1016 loadModule_ :: [FilePath] -> InputT GHCi ()
1017 loadModule_ fs = loadModule (zip fs (repeat Nothing)) >> return ()
1018
1019 loadModule' :: [(FilePath, Maybe Phase)] -> InputT GHCi SuccessFlag
1020 loadModule' files = do
1021   prev_context <- GHC.getContext
1022
1023   -- unload first
1024   _ <- GHC.abandonAll
1025   lift discardActiveBreakPoints
1026   GHC.setTargets []
1027   _ <- GHC.load LoadAllTargets
1028
1029   let (filenames, phases) = unzip files
1030   exp_filenames <- mapM expandPath filenames
1031   let files' = zip exp_filenames phases
1032   targets <- mapM (uncurry GHC.guessTarget) files'
1033
1034   -- NOTE: we used to do the dependency anal first, so that if it
1035   -- fails we didn't throw away the current set of modules.  This would
1036   -- require some re-working of the GHC interface, so we'll leave it
1037   -- as a ToDo for now.
1038
1039   GHC.setTargets targets
1040   doLoad False prev_context LoadAllTargets
1041
1042 checkModule :: String -> InputT GHCi ()
1043 checkModule m = do
1044   let modl = GHC.mkModuleName m
1045   prev_context <- GHC.getContext
1046   ok <- handleSourceError (\e -> GHC.printExceptionAndWarnings e >> return False) $ do
1047           r <- GHC.typecheckModule =<< GHC.parseModule =<< GHC.getModSummary modl
1048           outputStrLn (showSDoc (
1049            case GHC.moduleInfo r of
1050              cm | Just scope <- GHC.modInfoTopLevelScope cm ->
1051                 let
1052                     (local,global) = ASSERT( all isExternalName scope )
1053                                      partition ((== modl) . GHC.moduleName . GHC.nameModule) scope
1054                 in
1055                         (text "global names: " <+> ppr global) $$
1056                         (text "local  names: " <+> ppr local)
1057              _ -> empty))
1058           return True
1059   afterLoad (successIf ok) False prev_context
1060
1061 reloadModule :: String -> InputT GHCi ()
1062 reloadModule m = do
1063   prev_context <- GHC.getContext
1064   _ <- doLoad True prev_context $
1065         if null m then LoadAllTargets
1066                   else LoadUpTo (GHC.mkModuleName m)
1067   return ()
1068
1069 doLoad :: Bool -> ([Module],[(Module, Maybe (ImportDecl RdrName))]) -> LoadHowMuch -> InputT GHCi SuccessFlag
1070 doLoad retain_context prev_context howmuch = do
1071   -- turn off breakpoints before we load: we can't turn them off later, because
1072   -- the ModBreaks will have gone away.
1073   lift discardActiveBreakPoints
1074   ok <- trySuccess $ GHC.load howmuch
1075   afterLoad ok retain_context prev_context
1076   return ok
1077
1078 afterLoad :: SuccessFlag -> Bool -> ([Module],[(Module, Maybe (ImportDecl RdrName))]) -> InputT GHCi ()
1079 afterLoad ok retain_context prev_context = do
1080   lift revertCAFs  -- always revert CAFs on load.
1081   lift discardTickArrays
1082   loaded_mod_summaries <- getLoadedModules
1083   let loaded_mods = map GHC.ms_mod loaded_mod_summaries
1084       loaded_mod_names = map GHC.moduleName loaded_mods
1085   modulesLoadedMsg ok loaded_mod_names
1086
1087   lift $ setContextAfterLoad prev_context retain_context loaded_mod_summaries
1088
1089
1090 setContextAfterLoad :: ([Module],[(Module, Maybe (ImportDecl RdrName))]) -> Bool -> [GHC.ModSummary] -> GHCi ()
1091 setContextAfterLoad prev keep_ctxt [] = do
1092   prel_mod <- getPrelude
1093   setContextKeepingPackageModules prev keep_ctxt ([], [(prel_mod, Nothing)])
1094 setContextAfterLoad prev keep_ctxt ms = do
1095   -- load a target if one is available, otherwise load the topmost module.
1096   targets <- GHC.getTargets
1097   case [ m | Just m <- map (findTarget ms) targets ] of
1098         []    ->
1099           let graph' = flattenSCCs (GHC.topSortModuleGraph True ms Nothing) in
1100           load_this (last graph')
1101         (m:_) ->
1102           load_this m
1103  where
1104    findTarget ms t
1105     = case filter (`matches` t) ms of
1106         []    -> Nothing
1107         (m:_) -> Just m
1108
1109    summary `matches` Target (TargetModule m) _ _
1110         = GHC.ms_mod_name summary == m
1111    summary `matches` Target (TargetFile f _) _ _
1112         | Just f' <- GHC.ml_hs_file (GHC.ms_location summary)   = f == f'
1113    _ `matches` _
1114         = False
1115
1116    load_this summary | m <- GHC.ms_mod summary = do
1117         b <- GHC.moduleIsInterpreted m
1118         if b then setContextKeepingPackageModules prev keep_ctxt ([m], [])
1119              else do
1120                 prel_mod <- getPrelude
1121                 setContextKeepingPackageModules prev keep_ctxt ([],[(prel_mod,Nothing),(m,Nothing)])
1122
1123 -- | Keep any package modules (except Prelude) when changing the context.
1124 setContextKeepingPackageModules
1125         :: ([Module],[(Module, Maybe (ImportDecl RdrName))])          -- previous context
1126         -> Bool                         -- re-execute :module commands
1127         -> ([Module],[(Module, Maybe (ImportDecl RdrName))])          -- new context
1128         -> GHCi ()
1129 setContextKeepingPackageModules prev_context keep_ctxt (as,bs) = do
1130   let (_,bs0) = prev_context
1131   prel_mod <- getPrelude
1132   -- filter everything, not just lefts
1133   let pkg_modules = filter ((\p -> not (isHomeModule p) && p /= prel_mod) . fst) bs0
1134   let bs1 = if null as then nubBy sameFst ((prel_mod,Nothing) : bs) else bs
1135   GHC.setContext as (nubBy sameFst (bs1 ++ pkg_modules))
1136   if keep_ctxt
1137      then do
1138           st <- getGHCiState
1139           mapM_ (playCtxtCmd False) (remembered_ctx st)
1140      else do
1141           st <- getGHCiState
1142           setGHCiState st{ remembered_ctx = [] }
1143
1144 isHomeModule :: Module -> Bool
1145 isHomeModule mod = GHC.modulePackageId mod == mainPackageId
1146
1147 sameFst :: (Module, Maybe (ImportDecl RdrName)) -> (Module, Maybe (ImportDecl RdrName)) -> Bool
1148 sameFst x y = fst x == fst y
1149
1150 modulesLoadedMsg :: SuccessFlag -> [ModuleName] -> InputT GHCi ()
1151 modulesLoadedMsg ok mods = do
1152   dflags <- getDynFlags
1153   when (verbosity dflags > 0) $ do
1154    let mod_commas
1155         | null mods = text "none."
1156         | otherwise = hsep (
1157             punctuate comma (map ppr mods)) <> text "."
1158    case ok of
1159     Failed ->
1160        outputStrLn (showSDoc (text "Failed, modules loaded: " <> mod_commas))
1161     Succeeded  ->
1162        outputStrLn (showSDoc (text "Ok, modules loaded: " <> mod_commas))
1163
1164
1165 typeOfExpr :: String -> InputT GHCi ()
1166 typeOfExpr str
1167   = handleSourceError (\e -> GHC.printExceptionAndWarnings e) $ do
1168        ty <- GHC.exprType str
1169        dflags <- getDynFlags
1170        let pefas = dopt Opt_PrintExplicitForalls dflags
1171        printForUser $ sep [text str, nest 2 (dcolon <+> pprTypeForUser pefas ty)]
1172
1173 kindOfType :: String -> InputT GHCi ()
1174 kindOfType str
1175   = handleSourceError (\e -> GHC.printExceptionAndWarnings e) $ do
1176        ty <- GHC.typeKind str
1177        printForUser $ text str <+> dcolon <+> ppr ty
1178
1179 quit :: String -> InputT GHCi Bool
1180 quit _ = return True
1181
1182 shellEscape :: String -> GHCi Bool
1183 shellEscape str = io (system str >> return False)
1184
1185 -----------------------------------------------------------------------------
1186 -- Browsing a module's contents
1187
1188 browseCmd :: Bool -> String -> InputT GHCi ()
1189 browseCmd bang m =
1190   case words m of
1191     ['*':s] | looksLikeModuleName s -> do
1192         m <- lift $ wantInterpretedModule s
1193         browseModule bang m False
1194     [s] | looksLikeModuleName s -> do
1195         m <- lift $ lookupModule s
1196         browseModule bang m True
1197     [] -> do
1198         (as,bs) <- GHC.getContext
1199                 -- Guess which module the user wants to browse.  Pick
1200                 -- modules that are interpreted first.  The most
1201                 -- recently-added module occurs last, it seems.
1202         case (as,bs) of
1203           (as@(_:_), _)   -> browseModule bang (last as) True
1204           ([],  bs@(_:_)) -> browseModule bang (fst (last bs)) True
1205           ([], [])  -> ghcError (CmdLineError ":browse: no current module")
1206     _ -> ghcError (CmdLineError "syntax:  :browse <module>")
1207
1208 -- without bang, show items in context of their parents and omit children
1209 -- with bang, show class methods and data constructors separately, and
1210 --            indicate import modules, to aid qualifying unqualified names
1211 -- with sorted, sort items alphabetically
1212 browseModule :: Bool -> Module -> Bool -> InputT GHCi ()
1213 browseModule bang modl exports_only = do
1214   -- :browse! reports qualifiers wrt current context
1215   current_unqual <- GHC.getPrintUnqual
1216   -- Temporarily set the context to the module we're interested in,
1217   -- just so we can get an appropriate PrintUnqualified
1218   (as,bs) <- GHC.getContext
1219   prel_mod <- lift getPrelude
1220   if exports_only then GHC.setContext [] [(prel_mod,Nothing), (modl,Nothing)]
1221                   else GHC.setContext [modl] []
1222   target_unqual <- GHC.getPrintUnqual
1223   GHC.setContext as bs
1224
1225   let unqual = if bang then current_unqual else target_unqual
1226
1227   mb_mod_info <- GHC.getModuleInfo modl
1228   case mb_mod_info of
1229     Nothing -> ghcError (CmdLineError ("unknown module: " ++
1230                                 GHC.moduleNameString (GHC.moduleName modl)))
1231     Just mod_info -> do
1232         dflags <- getDynFlags
1233         let names
1234                | exports_only = GHC.modInfoExports mod_info
1235                | otherwise    = GHC.modInfoTopLevelScope mod_info
1236                                 `orElse` []
1237
1238                 -- sort alphabetically name, but putting
1239                 -- locally-defined identifiers first.
1240                 -- We would like to improve this; see #1799.
1241             sorted_names = loc_sort local ++ occ_sort external
1242                 where
1243                 (local,external) = ASSERT( all isExternalName names )
1244                                    partition ((==modl) . nameModule) names
1245                 occ_sort = sortBy (compare `on` nameOccName)
1246                 -- try to sort by src location.  If the first name in
1247                 -- our list has a good source location, then they all should.
1248                 loc_sort names
1249                       | n:_ <- names, isGoodSrcSpan (nameSrcSpan n)
1250                       = sortBy (compare `on` nameSrcSpan) names
1251                       | otherwise
1252                       = occ_sort names
1253
1254         mb_things <- mapM GHC.lookupName sorted_names
1255         let filtered_things = filterOutChildren (\t -> t) (catMaybes mb_things)
1256
1257         rdr_env <- GHC.getGRE
1258
1259         let pefas              = dopt Opt_PrintExplicitForalls dflags
1260             things | bang      = catMaybes mb_things
1261                    | otherwise = filtered_things
1262             pretty | bang      = pprTyThing
1263                    | otherwise = pprTyThingInContext
1264
1265             labels  [] = text "-- not currently imported"
1266             labels  l  = text $ intercalate "\n" $ map qualifier l
1267             qualifier  = maybe "-- defined locally"
1268                              (("-- imported via "++) . intercalate ", "
1269                                . map GHC.moduleNameString)
1270             importInfo = RdrName.getGRE_NameQualifier_maybes rdr_env
1271             modNames   = map (importInfo . GHC.getName) things
1272
1273             -- annotate groups of imports with their import modules
1274             -- the default ordering is somewhat arbitrary, so we group
1275             -- by header and sort groups; the names themselves should
1276             -- really come in order of source appearance.. (trac #1799)
1277             annotate mts = concatMap (\(m,ts)->labels m:ts)
1278                          $ sortBy cmpQualifiers $ group mts
1279               where cmpQualifiers =
1280                       compare `on` (map (fmap (map moduleNameFS)) . fst)
1281             group []            = []
1282             group mts@((m,_):_) = (m,map snd g) : group ng
1283               where (g,ng) = partition ((==m).fst) mts
1284
1285         let prettyThings = map (pretty pefas) things
1286             prettyThings' | bang      = annotate $ zip modNames prettyThings
1287                           | otherwise = prettyThings
1288         outputStrLn $ showSDocForUser unqual (vcat prettyThings')
1289         -- ToDo: modInfoInstances currently throws an exception for
1290         -- package modules.  When it works, we can do this:
1291         --        $$ vcat (map GHC.pprInstance (GHC.modInfoInstances mod_info))
1292
1293 -----------------------------------------------------------------------------
1294 -- Setting the module context
1295
1296 newContextCmd :: CtxtCmd -> GHCi ()
1297 newContextCmd cmd = do
1298   playCtxtCmd True cmd
1299   st <- getGHCiState
1300   let cmds = remembered_ctx st
1301   setGHCiState st{ remembered_ctx = cmds ++ [cmd] }
1302
1303 setContext :: String -> GHCi ()
1304 setContext str
1305   | all sensible strs = newContextCmd cmd
1306   | otherwise = ghcError (CmdLineError "syntax:  :module [+/-] [*]M1 ... [*]Mn")
1307   where
1308     (cmd, strs) =
1309         case str of
1310                 '+':stuff -> rest AddModules stuff
1311                 '-':stuff -> rest RemModules stuff
1312                 stuff     -> rest SetContext stuff
1313
1314     rest cmd stuff = (cmd as bs, strs)
1315        where strs = words stuff
1316              (as,bs) = partitionWith starred strs
1317
1318     sensible ('*':m) = looksLikeModuleName m
1319     sensible m       = looksLikeModuleName m
1320
1321     starred ('*':m) = Left m
1322     starred m       = Right m
1323
1324 playCtxtCmd:: Bool -> CtxtCmd -> GHCi ()
1325 playCtxtCmd fail cmd = do
1326     (prev_as,prev_bs) <- GHC.getContext
1327     case cmd of
1328         SetContext as bs -> do
1329           (as',bs') <- do_checks as bs
1330           prel_mod <- getPrelude
1331           let bs'' = if null as && prel_mod `notElem` (map fst bs')
1332                         then (prel_mod,Nothing):bs'
1333                         else bs'
1334           GHC.setContext as' bs''
1335
1336         AddModules as bs -> do
1337           (as',bs') <- do_checks as bs
1338           -- it should replace the old stuff, not the other way around
1339           -- need deleteAllBy, not deleteFirstsBy for sameFst
1340           let remaining_as = prev_as \\ (as' ++ map fst bs')
1341               remaining_bs = deleteAllBy sameFst prev_bs (bs' ++ map contextualize as')
1342           GHC.setContext (remaining_as ++ as') (remaining_bs ++ bs')
1343
1344         RemModules as bs -> do
1345           (as',bs') <- do_checks as bs
1346           let new_as = prev_as \\ (as' ++ map fst bs')
1347               new_bs = deleteAllBy sameFst prev_bs (map contextualize as' ++ bs')
1348           GHC.setContext new_as new_bs
1349
1350         Import str -> do
1351           m_idecl <- maybe_fail $ GHC.parseImportDecl str
1352           case m_idecl of
1353             Nothing    -> return ()
1354             Just idecl -> do
1355               m_mdl <- maybe_fail $ loadModuleName idecl
1356               case m_mdl of
1357                 Nothing -> return ()
1358                 Just m -> GHC.setContext prev_as (prev_bs ++ [(m, Just idecl)])
1359
1360   where
1361     maybe_fail | fail      = liftM Just
1362                | otherwise = trymaybe
1363
1364     do_checks as bs = do
1365          as' <- mapM (maybe_fail . wantInterpretedModule) as
1366          bs' <- mapM (maybe_fail . lookupModule) bs
1367          return (catMaybes as', map contextualize (catMaybes bs'))
1368
1369     contextualize x = (x,Nothing)
1370     deleteAllBy f a b = filter (\x->(not (any (f x) b))) a
1371
1372 trymaybe ::GHCi a -> GHCi (Maybe a)
1373 trymaybe m = do
1374     r <- ghciTry m
1375     case r of
1376       Left _  -> return Nothing
1377       Right a -> return (Just a)
1378
1379 ----------------------------------------------------------------------------
1380 -- Code for `:set'
1381
1382 -- set options in the interpreter.  Syntax is exactly the same as the
1383 -- ghc command line, except that certain options aren't available (-C,
1384 -- -E etc.)
1385 --
1386 -- This is pretty fragile: most options won't work as expected.  ToDo:
1387 -- figure out which ones & disallow them.
1388
1389 setCmd :: String -> GHCi ()
1390 setCmd ""
1391   = do st <- getGHCiState
1392        let opts = options st
1393        io $ putStrLn (showSDoc (
1394               text "options currently set: " <>
1395               if null opts
1396                    then text "none."
1397                    else hsep (map (\o -> char '+' <> text (optToStr o)) opts)
1398            ))
1399        dflags <- getDynFlags
1400        io $ putStrLn (showSDoc (
1401           vcat (text "GHCi-specific dynamic flag settings:"
1402                :map (flagSetting dflags) ghciFlags)
1403           ))
1404        io $ putStrLn (showSDoc (
1405           vcat (text "other dynamic, non-language, flag settings:"
1406                :map (flagSetting dflags) nonLanguageDynFlags)
1407           ))
1408   where flagSetting dflags (str, f, _)
1409           | dopt f dflags = text "  " <> text "-f"    <> text str
1410           | otherwise     = text "  " <> text "-fno-" <> text str
1411         (ghciFlags,others)  = partition (\(_, f, _) -> f `elem` flags)
1412                                         DynFlags.fFlags
1413         nonLanguageDynFlags = filterOut (\(_, f, _) -> f `elem` languageOptions)
1414                                         others
1415         flags = [Opt_PrintExplicitForalls
1416                 ,Opt_PrintBindResult
1417                 ,Opt_BreakOnException
1418                 ,Opt_BreakOnError
1419                 ,Opt_PrintEvldWithShow
1420                 ]
1421 setCmd str
1422   = case getCmd str of
1423     Right ("args",   rest) ->
1424         case toArgs rest of
1425             Left err -> io (hPutStrLn stderr err)
1426             Right args -> setArgs args
1427     Right ("prog",   rest) ->
1428         case toArgs rest of
1429             Right [prog] -> setProg prog
1430             _ -> io (hPutStrLn stderr "syntax: :set prog <progname>")
1431     Right ("prompt", rest) -> setPrompt $ dropWhile isSpace rest
1432     Right ("editor", rest) -> setEditor $ dropWhile isSpace rest
1433     Right ("stop",   rest) -> setStop   $ dropWhile isSpace rest
1434     _ -> case toArgs str of
1435          Left err -> io (hPutStrLn stderr err)
1436          Right wds -> setOptions wds
1437
1438 setArgs, setOptions :: [String] -> GHCi ()
1439 setProg, setEditor, setStop, setPrompt :: String -> GHCi ()
1440
1441 setArgs args = do
1442   st <- getGHCiState
1443   setGHCiState st{ args = args }
1444
1445 setProg prog = do
1446   st <- getGHCiState
1447   setGHCiState st{ progname = prog }
1448
1449 setEditor cmd = do
1450   st <- getGHCiState
1451   setGHCiState st{ editor = cmd }
1452
1453 setStop str@(c:_) | isDigit c
1454   = do let (nm_str,rest) = break (not.isDigit) str
1455            nm = read nm_str
1456        st <- getGHCiState
1457        let old_breaks = breaks st
1458        if all ((/= nm) . fst) old_breaks
1459               then printForUser (text "Breakpoint" <+> ppr nm <+>
1460                                  text "does not exist")
1461               else do
1462        let new_breaks = map fn old_breaks
1463            fn (i,loc) | i == nm   = (i,loc { onBreakCmd = dropWhile isSpace rest })
1464                       | otherwise = (i,loc)
1465        setGHCiState st{ breaks = new_breaks }
1466 setStop cmd = do
1467   st <- getGHCiState
1468   setGHCiState st{ stop = cmd }
1469
1470 setPrompt value = do
1471   st <- getGHCiState
1472   if null value
1473       then io $ hPutStrLn stderr $ "syntax: :set prompt <prompt>, currently \"" ++ prompt st ++ "\""
1474       else case value of
1475            '\"' : _ -> case reads value of
1476                        [(value', xs)] | all isSpace xs ->
1477                            setGHCiState (st { prompt = value' })
1478                        _ ->
1479                            io $ hPutStrLn stderr "Can't parse prompt string. Use Haskell syntax."
1480            _ -> setGHCiState (st { prompt = value })
1481
1482 setOptions wds =
1483    do -- first, deal with the GHCi opts (+s, +t, etc.)
1484       let (plus_opts, minus_opts)  = partitionWith isPlus wds
1485       mapM_ setOpt plus_opts
1486       -- then, dynamic flags
1487       newDynFlags minus_opts
1488
1489 newDynFlags :: [String] -> GHCi ()
1490 newDynFlags minus_opts = do
1491       dflags <- getDynFlags
1492       let pkg_flags = packageFlags dflags
1493       (dflags', leftovers, warns) <- io $ GHC.parseDynamicFlags dflags $ map noLoc minus_opts
1494       handleFlagWarnings dflags' warns
1495
1496       if (not (null leftovers))
1497         then ghcError $ errorsToGhcException leftovers
1498         else return ()
1499
1500       new_pkgs <- setDynFlags dflags'
1501
1502       -- if the package flags changed, we should reset the context
1503       -- and link the new packages.
1504       dflags <- getDynFlags
1505       when (packageFlags dflags /= pkg_flags) $ do
1506         io $ hPutStrLn stderr "package flags have changed, resetting and loading new packages..."
1507         GHC.setTargets []
1508         _ <- GHC.load LoadAllTargets
1509         io (linkPackages dflags new_pkgs)
1510         -- package flags changed, we can't re-use any of the old context
1511         setContextAfterLoad ([],[]) False []
1512       return ()
1513
1514
1515 unsetOptions :: String -> GHCi ()
1516 unsetOptions str
1517   = do -- first, deal with the GHCi opts (+s, +t, etc.)
1518        let opts = words str
1519            (minus_opts, rest1) = partition isMinus opts
1520            (plus_opts, rest2)  = partitionWith isPlus rest1
1521
1522        if (not (null rest2))
1523           then io (putStrLn ("unknown option: '" ++ head rest2 ++ "'"))
1524           else do
1525
1526        mapM_ unsetOpt plus_opts
1527
1528        let no_flag ('-':'f':rest) = return ("-fno-" ++ rest)
1529            no_flag f = ghcError (ProgramError ("don't know how to reverse " ++ f))
1530
1531        no_flags <- mapM no_flag minus_opts
1532        newDynFlags no_flags
1533
1534 isMinus :: String -> Bool
1535 isMinus ('-':_) = True
1536 isMinus _ = False
1537
1538 isPlus :: String -> Either String String
1539 isPlus ('+':opt) = Left opt
1540 isPlus other     = Right other
1541
1542 setOpt, unsetOpt :: String -> GHCi ()
1543
1544 setOpt str
1545   = case strToGHCiOpt str of
1546         Nothing -> io (putStrLn ("unknown option: '" ++ str ++ "'"))
1547         Just o  -> setOption o
1548
1549 unsetOpt str
1550   = case strToGHCiOpt str of
1551         Nothing -> io (putStrLn ("unknown option: '" ++ str ++ "'"))
1552         Just o  -> unsetOption o
1553
1554 strToGHCiOpt :: String -> (Maybe GHCiOption)
1555 strToGHCiOpt "s" = Just ShowTiming
1556 strToGHCiOpt "t" = Just ShowType
1557 strToGHCiOpt "r" = Just RevertCAFs
1558 strToGHCiOpt _   = Nothing
1559
1560 optToStr :: GHCiOption -> String
1561 optToStr ShowTiming = "s"
1562 optToStr ShowType   = "t"
1563 optToStr RevertCAFs = "r"
1564
1565 -- ---------------------------------------------------------------------------
1566 -- code for `:show'
1567
1568 showCmd :: String -> GHCi ()
1569 showCmd str = do
1570   st <- getGHCiState
1571   case words str of
1572         ["args"]     -> io $ putStrLn (show (args st))
1573         ["prog"]     -> io $ putStrLn (show (progname st))
1574         ["prompt"]   -> io $ putStrLn (show (prompt st))
1575         ["editor"]   -> io $ putStrLn (show (editor st))
1576         ["stop"]     -> io $ putStrLn (show (stop st))
1577         ["modules" ] -> showModules
1578         ["bindings"] -> showBindings
1579         ["linker"]   -> io showLinkerState
1580         ["breaks"]   -> showBkptTable
1581         ["context"]  -> showContext
1582         ["packages"]  -> showPackages
1583         ["languages"]  -> showLanguages
1584         _ -> ghcError (CmdLineError ("syntax:  :show [ args | prog | prompt | editor | stop | modules | bindings\n"++
1585                                      "               | breaks | context | packages | languages ]"))
1586
1587 showModules :: GHCi ()
1588 showModules = do
1589   loaded_mods <- getLoadedModules
1590         -- we want *loaded* modules only, see #1734
1591   let show_one ms = do m <- GHC.showModule ms; io (putStrLn m)
1592   mapM_ show_one loaded_mods
1593
1594 getLoadedModules :: GHC.GhcMonad m => m [GHC.ModSummary]
1595 getLoadedModules = do
1596   graph <- GHC.getModuleGraph
1597   filterM (GHC.isLoaded . GHC.ms_mod_name) graph
1598
1599 showBindings :: GHCi ()
1600 showBindings = do
1601   bindings <- GHC.getBindings
1602   docs     <- pprTypeAndContents
1603                   [ id | AnId id <- sortBy compareTyThings bindings]
1604   printForUserPartWay docs
1605
1606 compareTyThings :: TyThing -> TyThing -> Ordering
1607 t1 `compareTyThings` t2 = getName t1 `compareNames` getName t2
1608
1609 printTyThing :: TyThing -> GHCi ()
1610 printTyThing tyth = do dflags <- getDynFlags
1611                        let pefas = dopt Opt_PrintExplicitForalls dflags
1612                        printForUser (pprTyThing pefas tyth)
1613
1614 showBkptTable :: GHCi ()
1615 showBkptTable = do
1616   st <- getGHCiState
1617   printForUser $ prettyLocations (breaks st)
1618
1619 showContext :: GHCi ()
1620 showContext = do
1621    resumes <- GHC.getResumeContext
1622    printForUser $ vcat (map pp_resume (reverse resumes))
1623   where
1624    pp_resume resume =
1625         ptext (sLit "--> ") <> text (GHC.resumeStmt resume)
1626         $$ nest 2 (ptext (sLit "Stopped at") <+> ppr (GHC.resumeSpan resume))
1627
1628 showPackages :: GHCi ()
1629 showPackages = do
1630   pkg_flags <- fmap packageFlags getDynFlags
1631   io $ putStrLn $ showSDoc $ vcat $
1632     text ("active package flags:"++if null pkg_flags then " none" else "")
1633     : map showFlag pkg_flags
1634   pkg_ids <- fmap (preloadPackages . pkgState) getDynFlags
1635   io $ putStrLn $ showSDoc $ vcat $
1636     text "packages currently loaded:"
1637     : map (nest 2 . text . packageIdString)
1638                (sortBy (compare `on` packageIdFS) pkg_ids)
1639   where showFlag (ExposePackage p) = text $ "  -package " ++ p
1640         showFlag (HidePackage p)   = text $ "  -hide-package " ++ p
1641         showFlag (IgnorePackage p) = text $ "  -ignore-package " ++ p
1642         showFlag (ExposePackageId p) = text $ "  -package-id " ++ p
1643
1644 showLanguages :: GHCi ()
1645 showLanguages = do
1646    dflags <- getDynFlags
1647    io $ putStrLn $ showSDoc $ vcat $
1648       text "active language flags:" :
1649       [text ("  -X" ++ str) | (str, f, _) <- DynFlags.xFlags, dopt f dflags]
1650
1651 -- -----------------------------------------------------------------------------
1652 -- Completion
1653
1654 completeCmd, completeMacro, completeIdentifier, completeModule,
1655     completeHomeModule, completeSetOptions, completeShowOptions,
1656     completeHomeModuleOrFile, completeExpression
1657     :: CompletionFunc GHCi
1658
1659 ghciCompleteWord :: CompletionFunc GHCi
1660 ghciCompleteWord line@(left,_) = case firstWord of
1661     ':':cmd     | null rest     -> completeCmd line
1662                 | otherwise     -> do
1663                         completion <- lookupCompletion cmd
1664                         completion line
1665     "import"    -> completeModule line
1666     _           -> completeExpression line
1667   where
1668     (firstWord,rest) = break isSpace $ dropWhile isSpace $ reverse left
1669     lookupCompletion ('!':_) = return completeFilename
1670     lookupCompletion c = do
1671         maybe_cmd <- liftIO $ lookupCommand' c
1672         case maybe_cmd of
1673             Just (_,_,f) -> return f
1674             Nothing -> return completeFilename
1675
1676 completeCmd = wrapCompleter " " $ \w -> do
1677   macros <- liftIO $ readIORef macros_ref
1678   let macro_names = map (':':) . map cmdName $ macros
1679   let command_names = map (':':) . map cmdName $ builtin_commands
1680   let{ candidates = case w of
1681       ':' : ':' : _ -> map (':':) command_names
1682       _ -> nub $ macro_names ++ command_names }
1683   return $ filter (w `isPrefixOf`) candidates
1684
1685 completeMacro = wrapIdentCompleter $ \w -> do
1686   cmds <- liftIO $ readIORef macros_ref
1687   return (filter (w `isPrefixOf`) (map cmdName cmds))
1688
1689 completeIdentifier = wrapIdentCompleter $ \w -> do
1690   rdrs <- GHC.getRdrNamesInScope
1691   return (filter (w `isPrefixOf`) (map (showSDoc.ppr) rdrs))
1692
1693 completeModule = wrapIdentCompleter $ \w -> do
1694   dflags <- GHC.getSessionDynFlags
1695   let pkg_mods = allExposedModules dflags
1696   loaded_mods <- liftM (map GHC.ms_mod_name) getLoadedModules
1697   return $ filter (w `isPrefixOf`)
1698         $ map (showSDoc.ppr) $ loaded_mods ++ pkg_mods
1699
1700 completeHomeModule = wrapIdentCompleter listHomeModules
1701
1702 listHomeModules :: String -> GHCi [String]
1703 listHomeModules w = do
1704     g <- GHC.getModuleGraph
1705     let home_mods = map GHC.ms_mod_name g
1706     return $ sort $ filter (w `isPrefixOf`)
1707             $ map (showSDoc.ppr) home_mods
1708
1709 completeSetOptions = wrapCompleter flagWordBreakChars $ \w -> do
1710   return (filter (w `isPrefixOf`) options)
1711     where options = "args":"prog":"prompt":"editor":"stop":flagList
1712           flagList = map head $ group $ sort allFlags
1713
1714 completeShowOptions = wrapCompleter flagWordBreakChars $ \w -> do
1715   return (filter (w `isPrefixOf`) options)
1716     where options = ["args", "prog", "prompt", "editor", "stop",
1717                      "modules", "bindings", "linker", "breaks",
1718                      "context", "packages", "languages"]
1719
1720 completeHomeModuleOrFile = completeWord Nothing filenameWordBreakChars
1721                 $ unionComplete (fmap (map simpleCompletion) . listHomeModules)
1722                             listFiles
1723
1724 unionComplete :: Monad m => (a -> m [b]) -> (a -> m [b]) -> a -> m [b]
1725 unionComplete f1 f2 line = do
1726   cs1 <- f1 line
1727   cs2 <- f2 line
1728   return (cs1 ++ cs2)
1729
1730 wrapCompleter :: String -> (String -> GHCi [String]) -> CompletionFunc GHCi
1731 wrapCompleter breakChars fun = completeWord Nothing breakChars
1732     $ fmap (map simpleCompletion) . fmap sort . fun
1733
1734 wrapIdentCompleter :: (String -> GHCi [String]) -> CompletionFunc GHCi
1735 wrapIdentCompleter = wrapCompleter word_break_chars
1736
1737 allExposedModules :: DynFlags -> [ModuleName]
1738 allExposedModules dflags
1739  = concat (map exposedModules (filter exposed (eltsUFM pkg_db)))
1740  where
1741   pkg_db = pkgIdMap (pkgState dflags)
1742
1743 completeExpression = completeQuotedWord (Just '\\') "\"" listFiles
1744                         completeIdentifier
1745
1746 -- ---------------------------------------------------------------------------
1747 -- User code exception handling
1748
1749 -- This is the exception handler for exceptions generated by the
1750 -- user's code and exceptions coming from children sessions;
1751 -- it normally just prints out the exception.  The
1752 -- handler must be recursive, in case showing the exception causes
1753 -- more exceptions to be raised.
1754 --
1755 -- Bugfix: if the user closed stdout or stderr, the flushing will fail,
1756 -- raising another exception.  We therefore don't put the recursive
1757 -- handler arond the flushing operation, so if stderr is closed
1758 -- GHCi will just die gracefully rather than going into an infinite loop.
1759 handler :: SomeException -> GHCi Bool
1760
1761 handler exception = do
1762   flushInterpBuffers
1763   io installSignalHandlers
1764   ghciHandle handler (showException exception >> return False)
1765
1766 showException :: SomeException -> GHCi ()
1767 showException se =
1768   io $ case fromException se of
1769        -- omit the location for CmdLineError:
1770        Just (CmdLineError s)    -> putStrLn s
1771        -- ditto:
1772        Just ph@(PhaseFailed {}) -> putStrLn (showGhcException ph "")
1773        Just other_ghc_ex        -> print other_ghc_ex
1774        Nothing                  ->
1775          case fromException se of
1776            Just UserInterrupt -> putStrLn "Interrupted."
1777            _other             -> putStrLn ("*** Exception: " ++ show se)
1778
1779 -----------------------------------------------------------------------------
1780 -- recursive exception handlers
1781
1782 -- Don't forget to unblock async exceptions in the handler, or if we're
1783 -- in an exception loop (eg. let a = error a in a) the ^C exception
1784 -- may never be delivered.  Thanks to Marcin for pointing out the bug.
1785
1786 ghciHandle :: MonadException m => (SomeException -> m a) -> m a -> m a
1787 ghciHandle h m = Haskeline.catch m $ \e -> unblock (h e)
1788
1789 ghciTry :: GHCi a -> GHCi (Either SomeException a)
1790 ghciTry (GHCi m) = GHCi $ \s -> gtry (m s)
1791
1792 -- ----------------------------------------------------------------------------
1793 -- Utils
1794
1795 -- TODO: won't work if home dir is encoded.
1796 -- (changeDirectory may not work either in that case.)
1797 expandPath :: MonadIO m => String -> InputT m String
1798 expandPath path = do
1799     exp_path <- liftIO $ expandPathIO path
1800     enc <- fmap BS.unpack $ Encoding.encode exp_path
1801     return enc
1802
1803 expandPathIO :: String -> IO String
1804 expandPathIO path =
1805   case dropWhile isSpace path of
1806    ('~':d) -> do
1807         tilde <- getHomeDirectory -- will fail if HOME not defined
1808         return (tilde ++ '/':d)
1809    other ->
1810         return other
1811
1812 wantInterpretedModule :: GHC.GhcMonad m => String -> m Module
1813 wantInterpretedModule str = do
1814    modl <- lookupModule str
1815    dflags <- getDynFlags
1816    when (GHC.modulePackageId modl /= thisPackage dflags) $
1817       ghcError (CmdLineError ("module '" ++ str ++ "' is from another package;\nthis command requires an interpreted module"))
1818    is_interpreted <- GHC.moduleIsInterpreted modl
1819    when (not is_interpreted) $
1820        ghcError (CmdLineError ("module '" ++ str ++ "' is not interpreted; try \':add *" ++ str ++ "' first"))
1821    return modl
1822
1823 wantNameFromInterpretedModule :: GHC.GhcMonad m
1824                               => (Name -> SDoc -> m ())
1825                               -> String
1826                               -> (Name -> m ())
1827                               -> m ()
1828 wantNameFromInterpretedModule noCanDo str and_then =
1829   handleSourceError (GHC.printExceptionAndWarnings) $ do
1830    names <- GHC.parseName str
1831    case names of
1832       []    -> return ()
1833       (n:_) -> do
1834             let modl = ASSERT( isExternalName n ) GHC.nameModule n
1835             if not (GHC.isExternalName n)
1836                then noCanDo n $ ppr n <>
1837                                 text " is not defined in an interpreted module"
1838                else do
1839             is_interpreted <- GHC.moduleIsInterpreted modl
1840             if not is_interpreted
1841                then noCanDo n $ text "module " <> ppr modl <>
1842                                 text " is not interpreted"
1843                else and_then n
1844
1845 -- -----------------------------------------------------------------------------
1846 -- commands for debugger
1847
1848 sprintCmd, printCmd, forceCmd :: String -> GHCi ()
1849 sprintCmd = pprintCommand False False
1850 printCmd  = pprintCommand True False
1851 forceCmd  = pprintCommand False True
1852
1853 pprintCommand :: Bool -> Bool -> String -> GHCi ()
1854 pprintCommand bind force str = do
1855   pprintClosureCommand bind force str
1856
1857 stepCmd :: String -> GHCi ()
1858 stepCmd []         = doContinue (const True) GHC.SingleStep
1859 stepCmd expression = runStmt expression GHC.SingleStep >> return ()
1860
1861 stepLocalCmd :: String -> GHCi ()
1862 stepLocalCmd  [] = do
1863   mb_span <- getCurrentBreakSpan
1864   case mb_span of
1865     Nothing  -> stepCmd []
1866     Just loc -> do
1867        Just mod <- getCurrentBreakModule
1868        current_toplevel_decl <- enclosingTickSpan mod loc
1869        doContinue (`isSubspanOf` current_toplevel_decl) GHC.SingleStep
1870
1871 stepLocalCmd expression = stepCmd expression
1872
1873 stepModuleCmd :: String -> GHCi ()
1874 stepModuleCmd  [] = do
1875   mb_span <- getCurrentBreakSpan
1876   case mb_span of
1877     Nothing  -> stepCmd []
1878     Just _ -> do
1879        Just span <- getCurrentBreakSpan
1880        let f some_span = srcSpanFileName_maybe span == srcSpanFileName_maybe some_span
1881        doContinue f GHC.SingleStep
1882
1883 stepModuleCmd expression = stepCmd expression
1884
1885 -- | Returns the span of the largest tick containing the srcspan given
1886 enclosingTickSpan :: Module -> SrcSpan -> GHCi SrcSpan
1887 enclosingTickSpan mod src = do
1888   ticks <- getTickArray mod
1889   let line = srcSpanStartLine src
1890   ASSERT (inRange (bounds ticks) line) do
1891   let enclosing_spans = [ span | (_,span) <- ticks ! line
1892                                , srcSpanEnd span >= srcSpanEnd src]
1893   return . head . sortBy leftmost_largest $ enclosing_spans
1894
1895 traceCmd :: String -> GHCi ()
1896 traceCmd []         = doContinue (const True) GHC.RunAndLogSteps
1897 traceCmd expression = runStmt expression GHC.RunAndLogSteps >> return ()
1898
1899 continueCmd :: String -> GHCi ()
1900 continueCmd = noArgs $ doContinue (const True) GHC.RunToCompletion
1901
1902 -- doContinue :: SingleStep -> GHCi ()
1903 doContinue :: (SrcSpan -> Bool) -> SingleStep -> GHCi ()
1904 doContinue pred step = do
1905   runResult <- resume pred step
1906   _ <- afterRunStmt pred runResult
1907   return ()
1908
1909 abandonCmd :: String -> GHCi ()
1910 abandonCmd = noArgs $ do
1911   b <- GHC.abandon -- the prompt will change to indicate the new context
1912   when (not b) $ io $ putStrLn "There is no computation running."
1913   return ()
1914
1915 deleteCmd :: String -> GHCi ()
1916 deleteCmd argLine = do
1917    deleteSwitch $ words argLine
1918    where
1919    deleteSwitch :: [String] -> GHCi ()
1920    deleteSwitch [] =
1921       io $ putStrLn "The delete command requires at least one argument."
1922    -- delete all break points
1923    deleteSwitch ("*":_rest) = discardActiveBreakPoints
1924    deleteSwitch idents = do
1925       mapM_ deleteOneBreak idents
1926       where
1927       deleteOneBreak :: String -> GHCi ()
1928       deleteOneBreak str
1929          | all isDigit str = deleteBreak (read str)
1930          | otherwise = return ()
1931
1932 historyCmd :: String -> GHCi ()
1933 historyCmd arg
1934   | null arg        = history 20
1935   | all isDigit arg = history (read arg)
1936   | otherwise       = io $ putStrLn "Syntax:  :history [num]"
1937   where
1938   history num = do
1939     resumes <- GHC.getResumeContext
1940     case resumes of
1941       [] -> io $ putStrLn "Not stopped at a breakpoint"
1942       (r:_) -> do
1943         let hist = GHC.resumeHistory r
1944             (took,rest) = splitAt num hist
1945         case hist of
1946           [] -> io $ putStrLn $
1947                    "Empty history. Perhaps you forgot to use :trace?"
1948           _  -> do
1949                  spans <- mapM GHC.getHistorySpan took
1950                  let nums  = map (printf "-%-3d:") [(1::Int)..]
1951                      names = map GHC.historyEnclosingDecl took
1952                  printForUser (vcat(zipWith3
1953                                  (\x y z -> x <+> y <+> z)
1954                                  (map text nums)
1955                                  (map (bold . ppr) names)
1956                                  (map (parens . ppr) spans)))
1957                  io $ putStrLn $ if null rest then "<end of history>" else "..."
1958
1959 bold :: SDoc -> SDoc
1960 bold c | do_bold   = text start_bold <> c <> text end_bold
1961        | otherwise = c
1962
1963 backCmd :: String -> GHCi ()
1964 backCmd = noArgs $ do
1965   (names, _, span) <- GHC.back
1966   printForUser $ ptext (sLit "Logged breakpoint at") <+> ppr span
1967   printTypeOfNames names
1968    -- run the command set with ":set stop <cmd>"
1969   st <- getGHCiState
1970   enqueueCommands [stop st]
1971
1972 forwardCmd :: String -> GHCi ()
1973 forwardCmd = noArgs $ do
1974   (names, ix, span) <- GHC.forward
1975   printForUser $ (if (ix == 0)
1976                     then ptext (sLit "Stopped at")
1977                     else ptext (sLit "Logged breakpoint at")) <+> ppr span
1978   printTypeOfNames names
1979    -- run the command set with ":set stop <cmd>"
1980   st <- getGHCiState
1981   enqueueCommands [stop st]
1982
1983 -- handle the "break" command
1984 breakCmd :: String -> GHCi ()
1985 breakCmd argLine = do
1986    breakSwitch $ words argLine
1987
1988 breakSwitch :: [String] -> GHCi ()
1989 breakSwitch [] = do
1990    io $ putStrLn "The break command requires at least one argument."
1991 breakSwitch (arg1:rest)
1992    | looksLikeModuleName arg1 && not (null rest) = do
1993         mod <- wantInterpretedModule arg1
1994         breakByModule mod rest
1995    | all isDigit arg1 = do
1996         (toplevel, _) <- GHC.getContext
1997         case toplevel of
1998            (mod : _) -> breakByModuleLine mod (read arg1) rest
1999            [] -> do
2000               io $ putStrLn "Cannot find default module for breakpoint."
2001               io $ putStrLn "Perhaps no modules are loaded for debugging?"
2002    | otherwise = do -- try parsing it as an identifier
2003         wantNameFromInterpretedModule noCanDo arg1 $ \name -> do
2004         let loc = GHC.srcSpanStart (GHC.nameSrcSpan name)
2005         if GHC.isGoodSrcLoc loc
2006                then ASSERT( isExternalName name )
2007                     findBreakAndSet (GHC.nameModule name) $
2008                          findBreakByCoord (Just (GHC.srcLocFile loc))
2009                                           (GHC.srcLocLine loc,
2010                                            GHC.srcLocCol loc)
2011                else noCanDo name $ text "can't find its location: " <> ppr loc
2012        where
2013           noCanDo n why = printForUser $
2014                 text "cannot set breakpoint on " <> ppr n <> text ": " <> why
2015
2016 breakByModule :: Module -> [String] -> GHCi ()
2017 breakByModule mod (arg1:rest)
2018    | all isDigit arg1 = do  -- looks like a line number
2019         breakByModuleLine mod (read arg1) rest
2020 breakByModule _ _
2021    = breakSyntax
2022
2023 breakByModuleLine :: Module -> Int -> [String] -> GHCi ()
2024 breakByModuleLine mod line args
2025    | [] <- args = findBreakAndSet mod $ findBreakByLine line
2026    | [col] <- args, all isDigit col =
2027         findBreakAndSet mod $ findBreakByCoord Nothing (line, read col)
2028    | otherwise = breakSyntax
2029
2030 breakSyntax :: a
2031 breakSyntax = ghcError (CmdLineError "Syntax: :break [<mod>] <line> [<column>]")
2032
2033 findBreakAndSet :: Module -> (TickArray -> Maybe (Int, SrcSpan)) -> GHCi ()
2034 findBreakAndSet mod lookupTickTree = do
2035    tickArray <- getTickArray mod
2036    (breakArray, _) <- getModBreak mod
2037    case lookupTickTree tickArray of
2038       Nothing  -> io $ putStrLn $ "No breakpoints found at that location."
2039       Just (tick, span) -> do
2040          success <- io $ setBreakFlag True breakArray tick
2041          if success
2042             then do
2043                (alreadySet, nm) <-
2044                      recordBreak $ BreakLocation
2045                              { breakModule = mod
2046                              , breakLoc = span
2047                              , breakTick = tick
2048                              , onBreakCmd = ""
2049                              }
2050                printForUser $
2051                   text "Breakpoint " <> ppr nm <>
2052                   if alreadySet
2053                      then text " was already set at " <> ppr span
2054                      else text " activated at " <> ppr span
2055             else do
2056             printForUser $ text "Breakpoint could not be activated at"
2057                                  <+> ppr span
2058
2059 -- When a line number is specified, the current policy for choosing
2060 -- the best breakpoint is this:
2061 --    - the leftmost complete subexpression on the specified line, or
2062 --    - the leftmost subexpression starting on the specified line, or
2063 --    - the rightmost subexpression enclosing the specified line
2064 --
2065 findBreakByLine :: Int -> TickArray -> Maybe (BreakIndex,SrcSpan)
2066 findBreakByLine line arr
2067   | not (inRange (bounds arr) line) = Nothing
2068   | otherwise =
2069     listToMaybe (sortBy (leftmost_largest `on` snd)  complete)   `mplus`
2070     listToMaybe (sortBy (leftmost_smallest `on` snd) incomplete) `mplus`
2071     listToMaybe (sortBy (rightmost `on` snd) ticks)
2072   where
2073         ticks = arr ! line
2074
2075         starts_here = [ tick | tick@(_,span) <- ticks,
2076                                GHC.srcSpanStartLine span == line ]
2077
2078         (complete,incomplete) = partition ends_here starts_here
2079             where ends_here (_,span) = GHC.srcSpanEndLine span == line
2080
2081 findBreakByCoord :: Maybe FastString -> (Int,Int) -> TickArray
2082                  -> Maybe (BreakIndex,SrcSpan)
2083 findBreakByCoord mb_file (line, col) arr
2084   | not (inRange (bounds arr) line) = Nothing
2085   | otherwise =
2086     listToMaybe (sortBy (rightmost `on` snd) contains ++
2087                  sortBy (leftmost_smallest `on` snd) after_here)
2088   where
2089         ticks = arr ! line
2090
2091         -- the ticks that span this coordinate
2092         contains = [ tick | tick@(_,span) <- ticks, span `spans` (line,col),
2093                             is_correct_file span ]
2094
2095         is_correct_file span
2096                  | Just f <- mb_file = GHC.srcSpanFile span == f
2097                  | otherwise         = True
2098
2099         after_here = [ tick | tick@(_,span) <- ticks,
2100                               GHC.srcSpanStartLine span == line,
2101                               GHC.srcSpanStartCol span >= col ]
2102
2103 -- For now, use ANSI bold on terminals that we know support it.
2104 -- Otherwise, we add a line of carets under the active expression instead.
2105 -- In particular, on Windows and when running the testsuite (which sets
2106 -- TERM to vt100 for other reasons) we get carets.
2107 -- We really ought to use a proper termcap/terminfo library.
2108 do_bold :: Bool
2109 do_bold = (`isPrefixOf` unsafePerformIO mTerm) `any` ["xterm", "linux"]
2110     where mTerm = System.Environment.getEnv "TERM"
2111                   `catchIO` \_ -> return "TERM not set"
2112
2113 start_bold :: String
2114 start_bold = "\ESC[1m"
2115 end_bold :: String
2116 end_bold   = "\ESC[0m"
2117
2118 listCmd :: String -> InputT GHCi ()
2119 listCmd "" = do
2120    mb_span <- lift getCurrentBreakSpan
2121    case mb_span of
2122       Nothing ->
2123           printForUser $ text "Not stopped at a breakpoint; nothing to list"
2124       Just span
2125        | GHC.isGoodSrcSpan span -> listAround span True
2126        | otherwise ->
2127           do resumes <- GHC.getResumeContext
2128              case resumes of
2129                  [] -> panic "No resumes"
2130                  (r:_) ->
2131                      do let traceIt = case GHC.resumeHistory r of
2132                                       [] -> text "rerunning with :trace,"
2133                                       _ -> empty
2134                             doWhat = traceIt <+> text ":back then :list"
2135                         printForUser (text "Unable to list source for" <+>
2136                                       ppr span
2137                                    $$ text "Try" <+> doWhat)
2138 listCmd str = list2 (words str)
2139
2140 list2 :: [String] -> InputT GHCi ()
2141 list2 [arg] | all isDigit arg = do
2142     (toplevel, _) <- GHC.getContext
2143     case toplevel of
2144         [] -> outputStrLn "No module to list"
2145         (mod : _) -> listModuleLine mod (read arg)
2146 list2 [arg1,arg2] | looksLikeModuleName arg1, all isDigit arg2 = do
2147         mod <- wantInterpretedModule arg1
2148         listModuleLine mod (read arg2)
2149 list2 [arg] = do
2150         wantNameFromInterpretedModule noCanDo arg $ \name -> do
2151         let loc = GHC.srcSpanStart (GHC.nameSrcSpan name)
2152         if GHC.isGoodSrcLoc loc
2153                then do
2154                   tickArray <- ASSERT( isExternalName name )
2155                                lift $ getTickArray (GHC.nameModule name)
2156                   let mb_span = findBreakByCoord (Just (GHC.srcLocFile loc))
2157                                         (GHC.srcLocLine loc, GHC.srcLocCol loc)
2158                                         tickArray
2159                   case mb_span of
2160                     Nothing       -> listAround (GHC.srcLocSpan loc) False
2161                     Just (_,span) -> listAround span False
2162                else
2163                   noCanDo name $ text "can't find its location: " <>
2164                                  ppr loc
2165     where
2166         noCanDo n why = printForUser $
2167             text "cannot list source code for " <> ppr n <> text ": " <> why
2168 list2  _other =
2169         outputStrLn "syntax:  :list [<line> | <module> <line> | <identifier>]"
2170
2171 listModuleLine :: Module -> Int -> InputT GHCi ()
2172 listModuleLine modl line = do
2173    graph <- GHC.getModuleGraph
2174    let this = filter ((== modl) . GHC.ms_mod) graph
2175    case this of
2176      [] -> panic "listModuleLine"
2177      summ:_ -> do
2178            let filename = expectJust "listModuleLine" (ml_hs_file (GHC.ms_location summ))
2179                loc = GHC.mkSrcLoc (mkFastString (filename)) line 0
2180            listAround (GHC.srcLocSpan loc) False
2181
2182 -- | list a section of a source file around a particular SrcSpan.
2183 -- If the highlight flag is True, also highlight the span using
2184 -- start_bold\/end_bold.
2185
2186 -- GHC files are UTF-8, so we can implement this by:
2187 -- 1) read the file in as a BS and syntax highlight it as before
2188 -- 2) convert the BS to String using utf-string, and write it out.
2189 -- It would be better if we could convert directly between UTF-8 and the
2190 -- console encoding, of course.
2191 listAround :: MonadIO m => SrcSpan -> Bool -> InputT m ()
2192 listAround span do_highlight = do
2193       contents <- liftIO $ BS.readFile (unpackFS file)
2194       let
2195           lines = BS.split '\n' contents
2196           these_lines = take (line2 - line1 + 1 + pad_before + pad_after) $
2197                         drop (line1 - 1 - pad_before) $ lines
2198           fst_line = max 1 (line1 - pad_before)
2199           line_nos = [ fst_line .. ]
2200
2201           highlighted | do_highlight = zipWith highlight line_nos these_lines
2202                       | otherwise    = [\p -> BS.concat[p,l] | l <- these_lines]
2203
2204           bs_line_nos = [ BS.pack (show l ++ "  ") | l <- line_nos ]
2205           prefixed = zipWith ($) highlighted bs_line_nos
2206       --
2207       let output = BS.intercalate (BS.pack "\n") prefixed
2208       utf8Decoded <- liftIO $ BS.useAsCStringLen output
2209                         $ \(p,n) -> utf8DecodeString (castPtr p) n
2210       outputStrLn utf8Decoded
2211   where
2212         file  = GHC.srcSpanFile span
2213         line1 = GHC.srcSpanStartLine span
2214         col1  = GHC.srcSpanStartCol span - 1
2215         line2 = GHC.srcSpanEndLine span
2216         col2  = GHC.srcSpanEndCol span - 1
2217
2218         pad_before | line1 == 1 = 0
2219                    | otherwise  = 1
2220         pad_after = 1
2221
2222         highlight | do_bold   = highlight_bold
2223                   | otherwise = highlight_carets
2224
2225         highlight_bold no line prefix
2226           | no == line1 && no == line2
2227           = let (a,r) = BS.splitAt col1 line
2228                 (b,c) = BS.splitAt (col2-col1) r
2229             in
2230             BS.concat [prefix, a,BS.pack start_bold,b,BS.pack end_bold,c]
2231           | no == line1
2232           = let (a,b) = BS.splitAt col1 line in
2233             BS.concat [prefix, a, BS.pack start_bold, b]
2234           | no == line2
2235           = let (a,b) = BS.splitAt col2 line in
2236             BS.concat [prefix, a, BS.pack end_bold, b]
2237           | otherwise   = BS.concat [prefix, line]
2238
2239         highlight_carets no line prefix
2240           | no == line1 && no == line2
2241           = BS.concat [prefix, line, nl, indent, BS.replicate col1 ' ',
2242                                          BS.replicate (col2-col1) '^']
2243           | no == line1
2244           = BS.concat [indent, BS.replicate (col1 - 2) ' ', BS.pack "vv", nl,
2245                                          prefix, line]
2246           | no == line2
2247           = BS.concat [prefix, line, nl, indent, BS.replicate col2 ' ',
2248                                          BS.pack "^^"]
2249           | otherwise   = BS.concat [prefix, line]
2250          where
2251            indent = BS.pack ("  " ++ replicate (length (show no)) ' ')
2252            nl = BS.singleton '\n'
2253
2254 -- --------------------------------------------------------------------------
2255 -- Tick arrays
2256
2257 getTickArray :: Module -> GHCi TickArray
2258 getTickArray modl = do
2259    st <- getGHCiState
2260    let arrmap = tickarrays st
2261    case lookupModuleEnv arrmap modl of
2262       Just arr -> return arr
2263       Nothing  -> do
2264         (_breakArray, ticks) <- getModBreak modl
2265         let arr = mkTickArray (assocs ticks)
2266         setGHCiState st{tickarrays = extendModuleEnv arrmap modl arr}
2267         return arr
2268
2269 discardTickArrays :: GHCi ()
2270 discardTickArrays = do
2271    st <- getGHCiState
2272    setGHCiState st{tickarrays = emptyModuleEnv}
2273
2274 mkTickArray :: [(BreakIndex,SrcSpan)] -> TickArray
2275 mkTickArray ticks
2276   = accumArray (flip (:)) [] (1, max_line)
2277         [ (line, (nm,span)) | (nm,span) <- ticks,
2278                               line <- srcSpanLines span ]
2279     where
2280         max_line = foldr max 0 (map GHC.srcSpanEndLine (map snd ticks))
2281         srcSpanLines span = [ GHC.srcSpanStartLine span ..
2282                               GHC.srcSpanEndLine span ]
2283
2284 lookupModule :: GHC.GhcMonad m => String -> m Module
2285 lookupModule modName
2286    = GHC.lookupModule (GHC.mkModuleName modName) Nothing
2287
2288 -- don't reset the counter back to zero?
2289 discardActiveBreakPoints :: GHCi ()
2290 discardActiveBreakPoints = do
2291    st <- getGHCiState
2292    mapM_ (turnOffBreak.snd) (breaks st)
2293    setGHCiState $ st { breaks = [] }
2294
2295 deleteBreak :: Int -> GHCi ()
2296 deleteBreak identity = do
2297    st <- getGHCiState
2298    let oldLocations    = breaks st
2299        (this,rest)     = partition (\loc -> fst loc == identity) oldLocations
2300    if null this
2301       then printForUser (text "Breakpoint" <+> ppr identity <+>
2302                          text "does not exist")
2303       else do
2304            mapM_ (turnOffBreak.snd) this
2305            setGHCiState $ st { breaks = rest }
2306
2307 turnOffBreak :: BreakLocation -> GHCi Bool
2308 turnOffBreak loc = do
2309   (arr, _) <- getModBreak (breakModule loc)
2310   io $ setBreakFlag False arr (breakTick loc)
2311
2312 getModBreak :: Module -> GHCi (GHC.BreakArray, Array Int SrcSpan)
2313 getModBreak mod = do
2314    Just mod_info <- GHC.getModuleInfo mod
2315    let modBreaks  = GHC.modInfoModBreaks mod_info
2316    let array      = GHC.modBreaks_flags modBreaks
2317    let ticks      = GHC.modBreaks_locs  modBreaks
2318    return (array, ticks)
2319
2320 setBreakFlag :: Bool -> GHC.BreakArray -> Int -> IO Bool
2321 setBreakFlag toggle array index
2322    | toggle    = GHC.setBreakOn array index
2323    | otherwise = GHC.setBreakOff array index