InteractiveUI.hs 123 KB
Newer Older
1
{-# LANGUAGE CPP, MagicHash, NondecreasingIndentation, TupleSections #-}
2 3 4
{-# OPTIONS -fno-cse #-}
-- -fno-cse is needed for GLOBAL_VAR's to behave properly

5 6 7 8
-----------------------------------------------------------------------------
--
-- GHC Interactive User Interface
--
9
-- (c) The GHC Team 2005-2006
10 11
--
-----------------------------------------------------------------------------
12

13 14 15 16 17 18 19
module InteractiveUI (
        interactiveUI,
        GhciSettings(..),
        defaultGhciSettings,
        ghciCommands,
        ghciWelcomeMsg
    ) where
20

21 22
#include "HsVersions.h"

dterei's avatar
dterei committed
23 24 25
-- GHCi
import qualified GhciMonad ( args, runStmt )
import GhciMonad hiding ( args, runStmt )
26
import GhciTags
27
import Debugger
28

29
-- The GHC interface
dterei's avatar
dterei committed
30
import DynFlags
31
import ErrUtils
32
import GhcMonad ( modifySession )
dterei's avatar
dterei committed
33 34 35 36
import qualified GHC
import GHC ( LoadHowMuch(..), Target(..),  TargetId(..), InteractiveImport(..),
             TyThing(..), Phase, BreakIndex, Resume, SingleStep, Ghc,
             handleSourceError )
37
import HsImpExp
dterei's avatar
dterei committed
38
import HscTypes ( tyThingParent_maybe, handleFlagWarnings, getSafeMode, hsc_IC, 
39
                  setInteractivePrintName )
dterei's avatar
dterei committed
40
import Module
41
import Name
42 43
import Packages ( ModuleExport(..), trusted, getPackageDetails, exposed,
                  exposedModules, reexportedModules, pkgIdMap )
dterei's avatar
dterei committed
44 45
import PprTyThing
import RdrName ( getGRE_NameQualifier_maybes )
46
import SrcLoc
dterei's avatar
dterei committed
47 48 49 50 51
import qualified Lexer

import StringBuffer
import UniqFM ( eltsUFM )
import Outputable hiding ( printForUser, printForUserPartWay, bold )
52 53

-- Other random utilities
dterei's avatar
dterei committed
54
import BasicTypes hiding ( isTopLevel )
55
import Config
dterei's avatar
dterei committed
56 57 58
import Digraph
import Encoding
import FastString
59
import Linker
dterei's avatar
dterei committed
60
import Maybes ( orElse, expectJust )
dterei's avatar
dterei committed
61 62
import NameSet
import Panic hiding ( showException )
63
import Util
sof's avatar
sof committed
64

dterei's avatar
dterei committed
65
-- Haskell Libraries
66
import System.Console.Haskeline as Haskeline
67

dterei's avatar
dterei committed
68 69
import Control.Applicative hiding (empty)
import Control.Monad as Monad
70 71
import Control.Monad.Trans.Class
import Control.Monad.IO.Class
72

dterei's avatar
dterei committed
73
import Data.Array
Simon Marlow's avatar
Simon Marlow committed
74
import qualified Data.ByteString.Char8 as BS
dterei's avatar
dterei committed
75
import Data.Char
Ian Lynagh's avatar
Ian Lynagh committed
76
import Data.Function
77
import Data.IORef ( IORef, modifyIORef, newIORef, readIORef, writeIORef )
dterei's avatar
dterei committed
78 79
import Data.List ( find, group, intercalate, intersperse, isPrefixOf, nub,
                   partition, sort, sortBy )
80
import Data.Maybe
dterei's avatar
dterei committed
81

82
import Exception hiding (catch)
dterei's avatar
dterei committed
83 84 85 86 87

import Foreign.C
import Foreign.Safe

import System.Directory
88
import System.Environment
dterei's avatar
dterei committed
89
import System.Exit ( exitWith, ExitCode(..) )
dterei's avatar
dterei committed
90
import System.FilePath
ross's avatar
ross committed
91
import System.IO
92
import System.IO.Error
dterei's avatar
dterei committed
93
import System.IO.Unsafe ( unsafePerformIO )
94
import System.Process
Simon Marlow's avatar
Simon Marlow committed
95
import Text.Printf
96
import Text.Read ( readMaybe )
97

dterei's avatar
dterei committed
98 99 100 101 102 103 104
#ifndef mingw32_HOST_OS
import System.Posix hiding ( getEnv )
#else
import qualified System.Win32
#endif

import GHC.Exts ( unsafeCoerce# )
dterei's avatar
dterei committed
105 106
import GHC.IO.Exception ( IOErrorType(InvalidArgument) )
import GHC.IO.Handle ( hFlushAll )
dterei's avatar
dterei committed
107
import GHC.TopHandler ( topHandler )
108

109 110
-----------------------------------------------------------------------------

111 112 113 114
data GhciSettings = GhciSettings {
        availableCommands :: [Command],
        shortHelpText     :: String,
        fullHelpText      :: String,
115 116
        defPrompt         :: String,
        defPrompt2        :: String
117 118 119 120 121 122 123 124
    }

defaultGhciSettings :: GhciSettings
defaultGhciSettings =
    GhciSettings {
        availableCommands = ghciCommands,
        shortHelpText     = defShortHelpText,
        fullHelpText      = defFullHelpText,
125 126
        defPrompt         = default_prompt,
        defPrompt2        = default_prompt2
127 128
    }

129 130 131
ghciWelcomeMsg :: String
ghciWelcomeMsg = "GHCi, version " ++ cProjectVersion ++
                 ": http://www.haskell.org/ghc/  :? for help"
132

Simon Marlow's avatar
Simon Marlow committed
133
cmdName :: Command -> String
134
cmdName (n,_,_) = n
135

Simon Marlow's avatar
Simon Marlow committed
136
GLOBAL_VAR(macros_ref, [], [Command])
Simon Marlow's avatar
Simon Marlow committed
137

138 139
ghciCommands :: [Command]
ghciCommands = [
140 141 142 143 144 145 146 147 148 149 150
  -- Hugs users are accustomed to :e, so make sure it doesn't overlap
  ("?",         keepGoing help,                 noCompletion),
  ("add",       keepGoingPaths addModule,       completeFilename),
  ("abandon",   keepGoing abandonCmd,           noCompletion),
  ("break",     keepGoing breakCmd,             completeIdentifier),
  ("back",      keepGoing backCmd,              noCompletion),
  ("browse",    keepGoing' (browseCmd False),   completeModule),
  ("browse!",   keepGoing' (browseCmd True),    completeModule),
  ("cd",        keepGoing' changeDirectory,     completeFilename),
  ("check",     keepGoing' checkModule,         completeHomeModule),
  ("continue",  keepGoing continueCmd,          noCompletion),
151
  ("complete",  keepGoing completeCmd,          noCompletion),
152
  ("cmd",       keepGoing cmdCmd,               completeExpression),
153 154
  ("ctags",     keepGoing createCTagsWithLineNumbersCmd, completeFilename),
  ("ctags!",    keepGoing createCTagsWithRegExesCmd, completeFilename),
155 156 157
  ("def",       keepGoing (defineMacro False),  completeExpression),
  ("def!",      keepGoing (defineMacro True),   completeExpression),
  ("delete",    keepGoing deleteCmd,            noCompletion),
158
  ("edit",      keepGoing' editFile,            completeFilename),
159 160 161 162 163
  ("etags",     keepGoing createETagsFileCmd,   completeFilename),
  ("force",     keepGoing forceCmd,             completeExpression),
  ("forward",   keepGoing forwardCmd,           noCompletion),
  ("help",      keepGoing help,                 noCompletion),
  ("history",   keepGoing historyCmd,           noCompletion),
164 165
  ("info",      keepGoing' (info False),        completeIdentifier),
  ("info!",     keepGoing' (info True),         completeIdentifier),
166
  ("issafe",    keepGoing' isSafeCmd,           completeModule),
167 168
  ("kind",      keepGoing' (kindOfType False),  completeIdentifier),
  ("kind!",     keepGoing' (kindOfType True),   completeIdentifier),
169 170
  ("load",      keepGoingPaths loadModule_,     completeHomeModuleOrFile),
  ("list",      keepGoing' listCmd,             noCompletion),
171
  ("module",    keepGoing moduleCmd,            completeSetModule),
172 173 174 175 176
  ("main",      keepGoing runMain,              completeFilename),
  ("print",     keepGoing printCmd,             completeExpression),
  ("quit",      quit,                           noCompletion),
  ("reload",    keepGoing' reloadModule,        noCompletion),
  ("run",       keepGoing runRun,               completeFilename),
vivian's avatar
vivian committed
177
  ("script",    keepGoing' scriptCmd,           completeFilename),
178
  ("set",       keepGoing setCmd,               completeSetOptions),
179
  ("seti",      keepGoing setiCmd,              completeSeti),
180
  ("show",      keepGoing showCmd,              completeShowOptions),
181
  ("showi",     keepGoing showiCmd,             completeShowiOptions),
182 183 184 185 186 187 188 189
  ("sprint",    keepGoing sprintCmd,            completeExpression),
  ("step",      keepGoing stepCmd,              completeIdentifier),
  ("steplocal", keepGoing stepLocalCmd,         completeIdentifier),
  ("stepmodule",keepGoing stepModuleCmd,        completeIdentifier),
  ("type",      keepGoing' typeOfExpr,          completeExpression),
  ("trace",     keepGoing traceCmd,             completeExpression),
  ("undef",     keepGoing undefineMacro,        completeMacro),
  ("unset",     keepGoing unsetOptions,         completeSetOptions)
190 191
  ]

192

dterei's avatar
dterei committed
193
-- We initialize readline (in the interactiveUI function) to use
194 195 196 197
-- word_break_chars as the default set of completion word break characters.
-- This can be overridden for a particular command (for example, filename
-- expansion shouldn't consider '/' to be a word break) by setting the third
-- entry in the Command tuple above.
dterei's avatar
dterei committed
198
--
199 200
-- NOTE: in order for us to override the default correctly, any custom entry
-- must be a SUBSET of word_break_chars.
201
word_break_chars :: String
202 203 204 205
word_break_chars = let symbols = "!#$%&*+/<=>?@\\^|-~"
                       specials = "(),;[]`{}"
                       spaces = " \t\n"
                   in spaces ++ specials ++ symbols
206

207
flagWordBreakChars :: String
208 209 210
flagWordBreakChars = " \t\n"


211 212 213 214 215
keepGoing :: (String -> GHCi ()) -> (String -> InputT GHCi Bool)
keepGoing a str = keepGoing' (lift . a) str

keepGoing' :: Monad m => (String -> m ()) -> String -> m Bool
keepGoing' a str = a str >> return False
216

217
keepGoingPaths :: ([FilePath] -> InputT GHCi ()) -> (String -> InputT GHCi Bool)
Ian Lynagh's avatar
Ian Lynagh committed
218 219
keepGoingPaths a str
 = do case toArgs str of
Ian Lynagh's avatar
Ian Lynagh committed
220
          Left err -> liftIO $ hPutStrLn stderr err
Ian Lynagh's avatar
Ian Lynagh committed
221 222
          Right args -> a args
      return False
sof's avatar
sof committed
223

224 225
defShortHelpText :: String
defShortHelpText = "use :? for help.\n"
226

227 228
defFullHelpText :: String
defFullHelpText =
dterei's avatar
dterei committed
229 230 231 232 233 234 235 236 237 238
  " Commands available from the prompt:\n" ++
  "\n" ++
  "   <statement>                 evaluate/run <statement>\n" ++
  "   :                           repeat last command\n" ++
  "   :{\\n ..lines.. \\n:}\\n       multiline command\n" ++
  "   :add [*]<module> ...        add module(s) to the current target set\n" ++
  "   :browse[!] [[*]<mod>]       display the names defined by module <mod>\n" ++
  "                               (!: more details; *: all top-level names)\n" ++
  "   :cd <dir>                   change directory to <dir>\n" ++
  "   :cmd <expr>                 run the commands returned by <expr>::IO String\n" ++
239
  "   :complete <dom> [<rng>] <s> list completions for partial input string\n" ++
dterei's avatar
dterei committed
240 241
  "   :ctags[!] [<file>]          create tags file for Vi (default: \"tags\")\n" ++
  "                               (!: use regex instead of line number)\n" ++
242 243
  "   :def <cmd> <expr>           define command :<cmd> (later defined command has\n" ++
  "                               precedence, ::<cmd> is always a builtin command)\n" ++
dterei's avatar
dterei committed
244 245 246 247
  "   :edit <file>                edit file\n" ++
  "   :edit                       edit last module\n" ++
  "   :etags [<file>]             create tags file for Emacs (default: \"TAGS\")\n" ++
  "   :help, :?                   display this list of commands\n" ++
248 249
  "   :info[!] [<name> ...]       display information about the given names\n" ++
  "                               (!: do not filter instances)\n" ++
dterei's avatar
dterei committed
250
  "   :issafe [<mod>]             display safe haskell information of module <mod>\n" ++
251 252
  "   :kind[!] <type>             show the kind of <type>\n" ++
  "                               (!: also print the normalised type)\n" ++
dterei's avatar
dterei committed
253 254 255 256 257 258
  "   :load [*]<module> ...       load module(s) and their dependents\n" ++
  "   :main [<arguments> ...]     run the main function with the given arguments\n" ++
  "   :module [+/-] [*]<mod> ...  set the context for expression evaluation\n" ++
  "   :quit                       exit GHCi\n" ++
  "   :reload                     reload the current module set\n" ++
  "   :run function [<arguments> ...] run the function with the given arguments\n" ++
259
  "   :script <filename>          run the script <filename>\n" ++
dterei's avatar
dterei committed
260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276
  "   :type <expr>                show the type of <expr>\n" ++
  "   :undef <cmd>                undefine user-defined command :<cmd>\n" ++
  "   :!<command>                 run the shell command <command>\n" ++
  "\n" ++
  " -- Commands for debugging:\n" ++
  "\n" ++
  "   :abandon                    at a breakpoint, abandon current computation\n" ++
  "   :back                       go back in the history (after :trace)\n" ++
  "   :break [<mod>] <l> [<col>]  set a breakpoint at the specified location\n" ++
  "   :break <name>               set a breakpoint on the specified function\n" ++
  "   :continue                   resume after a breakpoint\n" ++
  "   :delete <number>            delete the specified breakpoint\n" ++
  "   :delete *                   delete all breakpoints\n" ++
  "   :force <expr>               print <expr>, forcing unevaluated parts\n" ++
  "   :forward                    go forward in the history (after :back)\n" ++
  "   :history [<n>]              after :trace, show the execution history\n" ++
  "   :list                       show the source code around current breakpoint\n" ++
277
  "   :list <identifier>          show the source code for <identifier>\n" ++
dterei's avatar
dterei committed
278 279 280 281 282 283 284 285 286
  "   :list [<module>] <line>     show the source code around line number <line>\n" ++
  "   :print [<name> ...]         prints a value without forcing its computation\n" ++
  "   :sprint [<name> ...]        simplifed version of :print\n" ++
  "   :step                       single-step after stopping at a breakpoint\n"++
  "   :step <expr>                single-step into <expr>\n"++
  "   :steplocal                  single-step within the current top-level binding\n"++
  "   :stepmodule                 single-step restricted to the current module\n"++
  "   :trace                      trace after stopping at a breakpoint\n"++
  "   :trace <expr>               evaluate <expr> with tracing on (see :history)\n"++
dterei's avatar
dterei committed
287

dterei's avatar
dterei committed
288 289 290 291
  "\n" ++
  " -- Commands for changing settings:\n" ++
  "\n" ++
  "   :set <option> ...           set options\n" ++
292
  "   :seti <option> ...          set options for interactive evaluation only\n" ++
dterei's avatar
dterei committed
293 294 295
  "   :set args <arg> ...         set the arguments returned by System.getArgs\n" ++
  "   :set prog <progname>        set the value returned by System.getProgName\n" ++
  "   :set prompt <prompt>        set the prompt used in GHCi\n" ++
296
  "   :set prompt2 <prompt>       set the continuation prompt used in GHCi\n" ++
dterei's avatar
dterei committed
297 298 299 300 301 302
  "   :set editor <cmd>           set the command used for :edit\n" ++
  "   :set stop [<n>] <cmd>       set the command to run when a breakpoint is hit\n" ++
  "   :unset <option> ...         unset options\n" ++
  "\n" ++
  "  Options for ':set' and ':unset':\n" ++
  "\n" ++
dterei's avatar
dterei committed
303
  "    +m            allow multiline commands\n" ++
dterei's avatar
dterei committed
304 305 306 307
  "    +r            revert top-level expressions after each evaluation\n" ++
  "    +s            print timing/memory stats after each evaluation\n" ++
  "    +t            print type after evaluation\n" ++
  "    -<flags>      most GHC command line flags can also be set here\n" ++
308
  "                         (eg. -v2, -XFlexibleInstances, etc.)\n" ++
dterei's avatar
dterei committed
309 310 311 312 313 314 315 316
  "                    for GHCi-specific flags, see User's Guide,\n"++
  "                    Flag reference, Interactive-mode options\n" ++
  "\n" ++
  " -- Commands for displaying information:\n" ++
  "\n" ++
  "   :show bindings              show the current bindings made at the prompt\n" ++
  "   :show breaks                show the active breakpoints\n" ++
  "   :show context               show the breakpoint context\n" ++
317
  "   :show imports               show the current imports\n" ++
318
  "   :show linker                show current linker state\n" ++
dterei's avatar
dterei committed
319 320
  "   :show modules               show the currently loaded modules\n" ++
  "   :show packages              show the currently active package flags\n" ++
321
  "   :show paths                 show the currently active search paths\n" ++
322
  "   :show language              show the currently active language flags\n" ++
dterei's avatar
dterei committed
323 324
  "   :show <setting>             show value of <setting>, which is one of\n" ++
  "                                  [args, prog, prompt, editor, stop]\n" ++
325
  "   :showi language             show language flags for interactive evaluation\n" ++
dterei's avatar
dterei committed
326
  "\n"
327

Simon Marlow's avatar
Simon Marlow committed
328
findEditor :: IO String
Simon Marlow's avatar
Simon Marlow committed
329
findEditor = do
dterei's avatar
dterei committed
330
  getEnv "EDITOR"
331
    `catchIO` \_ -> do
332
#if mingw32_HOST_OS
Ian Lynagh's avatar
Ian Lynagh committed
333 334
        win <- System.Win32.getWindowsDirectory
        return (win </> "notepad.exe")
Simon Marlow's avatar
Simon Marlow committed
335
#else
Ian Lynagh's avatar
Ian Lynagh committed
336
        return ""
Simon Marlow's avatar
Simon Marlow committed
337 338
#endif

Simon Marlow's avatar
Simon Marlow committed
339 340
foreign import ccall unsafe "rts_isProfiled" isProfiled :: IO CInt

341
default_progname, default_prompt, default_prompt2, default_stop :: String
boris's avatar
boris committed
342 343
default_progname = "<interactive>"
default_prompt = "%s> "
344
default_prompt2 = "%s| "
boris's avatar
boris committed
345 346
default_stop = ""

Simon Marlow's avatar
Simon Marlow committed
347 348 349
default_args :: [String]
default_args = []

350
interactiveUI :: GhciSettings -> [(FilePath, Maybe Phase)] -> Maybe [String]
351
              -> Ghc ()
352
interactiveUI config srcs maybe_exprs = do
353 354 355
   -- although GHCi compiles with -prof, it is not usable: the byte-code
   -- compiler and interpreter don't work with profiling.  So we check for
   -- this up front and emit a helpful error message (#2197)
Simon Marlow's avatar
Simon Marlow committed
356
   i <- liftIO $ isProfiled
dterei's avatar
dterei committed
357
   when (i /= 0) $
358
     throwGhcException (InstallationError "GHCi cannot be used when compiled with -prof")
359

360 361 362 363 364 365 366 367
   -- HACK! If we happen to get into an infinite loop (eg the user
   -- types 'let x=x in x' at the prompt), then the thread will block
   -- on a blackhole, and become unreachable during GC.  The GC will
   -- detect that it is unreachable and send it the NonTermination
   -- exception.  However, since the thread is unreachable, everything
   -- it refers to might be finalized, including the standard Handles.
   -- This sounds like a bug, but we don't have a good solution right
   -- now.
368 369 370
   _ <- liftIO $ newStablePtr stdin
   _ <- liftIO $ newStablePtr stdout
   _ <- liftIO $ newStablePtr stderr
371

Ian Lynagh's avatar
Ian Lynagh committed
372
    -- Initialise buffering for the *interpreted* I/O system
373
   initInterpBuffering
374

375
   -- The initial set of DynFlags used for interactive evaluation is the same
376 377
   -- as the global DynFlags, plus -XExtendedDefaultRules and
   -- -XNoMonomorphismRestriction.
378
   dflags <- getDynFlags
379 380 381 382
   let dflags' = (`xopt_set` Opt_ExtendedDefaultRules)
               . (`xopt_unset` Opt_MonomorphismRestriction)
               $ dflags
   GHC.setInteractiveDynFlags dflags'
383

384 385 386 387 388 389
   lastErrLocationsRef <- liftIO $ newIORef []
   progDynFlags <- GHC.getProgramDynFlags
   _ <- GHC.setProgramDynFlags $
      progDynFlags { log_action = ghciLogAction lastErrLocationsRef }

 
390
   liftIO $ when (isNothing maybe_exprs) $ do
Ian Lynagh's avatar
Ian Lynagh committed
391 392 393 394 395 396 397 398 399 400
        -- Only for GHCi (not runghc and ghc -e):

        -- Turn buffering off for the compiled program's stdout/stderr
        turnOffBuffering
        -- Turn buffering off for GHCi's stdout
        hFlush stdout
        hSetBuffering stdout NoBuffering
        -- We don't want the cmd line to buffer any input that might be
        -- intended for the program, so unbuffer stdin.
        hSetBuffering stdin NoBuffering
parcs's avatar
parcs committed
401
        hSetBuffering stderr NoBuffering
402
#if defined(mingw32_HOST_OS)
403 404 405 406 407
        -- On Unix, stdin will use the locale encoding.  The IO library
        -- doesn't do this on Windows (yet), so for now we use UTF-8,
        -- for consistency with GHC 6.10 and to make the tests work.
        hSetEncoding stdin utf8
#endif
Ian Lynagh's avatar
Ian Lynagh committed
408

409
   default_editor <- liftIO $ findEditor
Ian Lynagh's avatar
Ian Lynagh committed
410
   startGHCi (runGHCi srcs maybe_exprs)
411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430
        GHCiState{ progname           = default_progname,
                   GhciMonad.args     = default_args,
                   prompt             = defPrompt config,
                   prompt2            = defPrompt2 config,
                   stop               = default_stop,
                   editor             = default_editor,
                   options            = [],
                   line_number        = 1,
                   break_ctr          = 0,
                   breaks             = [],
                   tickarrays         = emptyModuleEnv,
                   ghci_commands      = availableCommands config,
                   last_command       = Nothing,
                   cmdqueue           = [],
                   remembered_ctx     = [],
                   transient_ctx      = [],
                   ghc_e              = isJust maybe_exprs,
                   short_help         = shortHelpText config,
                   long_help          = fullHelpText config,
                   lastErrorLocations = lastErrLocationsRef
mnislaih's avatar
mnislaih committed
431
                 }
432
    
433 434
   return ()

435 436 437 438 439 440 441 442 443 444 445 446 447 448 449
resetLastErrorLocations :: GHCi ()
resetLastErrorLocations = do
    st <- getGHCiState
    liftIO $ writeIORef (lastErrorLocations st) []

ghciLogAction :: IORef [(FastString, Int)] ->  LogAction
ghciLogAction lastErrLocations dflags severity srcSpan style msg = do
    defaultLogAction dflags severity srcSpan style msg
    case severity of
        SevError -> case srcSpan of
            RealSrcSpan rsp -> modifyIORef lastErrLocations
                (++ [(srcLocFile (realSrcSpanStart rsp), srcLocLine (realSrcSpanStart rsp))])
            _ -> return ()
        _ -> return ()

450 451
withGhcAppData :: (FilePath -> IO a) -> IO a -> IO a
withGhcAppData right left = do
452
    either_dir <- tryIO (getAppUserDataDirectory "ghc")
453 454 455 456 457
    case either_dir of
        Right dir ->
            do createDirectoryIfMissing False dir `catchIO` \_ -> return ()
               right dir
        _ -> left
458

Ian Lynagh's avatar
Ian Lynagh committed
459 460
runGHCi :: [(FilePath, Maybe Phase)] -> Maybe [String] -> GHCi ()
runGHCi paths maybe_exprs = do
461
  dflags <- getDynFlags
462
  let
ian@well-typed.com's avatar
ian@well-typed.com committed
463
   read_dot_files = not (gopt Opt_IgnoreDotGhci dflags)
464

465 466
   current_dir = return (Just ".ghci")

Ian Lynagh's avatar
Ian Lynagh committed
467
   app_user_dir = liftIO $ withGhcAppData
468 469
                    (\dir -> return (Just (dir </> "ghci.conf")))
                    (return Nothing)
470 471

   home_dir = do
472
    either_dir <- liftIO $ tryIO (getEnv "HOME")
473 474 475 476
    case either_dir of
      Right home -> return (Just (home </> ".ghci"))
      _ -> return Nothing

477 478 479 480
   canonicalizePath' :: FilePath -> IO (Maybe FilePath)
   canonicalizePath' fp = liftM Just (canonicalizePath fp)
                `catchIO` \_ -> return Nothing

481 482
   sourceConfigFile :: (FilePath, Bool) -> GHCi ()
   sourceConfigFile (file, check_perms) = do
Ian Lynagh's avatar
Ian Lynagh committed
483
     exists <- liftIO $ doesFileExist file
484
     when exists $ do
485 486 487 488 489 490 491 492
       perms_ok <-
         if not check_perms
            then return True
            else do
              dir_ok  <- liftIO $ checkPerms (getDirectory file)
              file_ok <- liftIO $ checkPerms file
              return (dir_ok && file_ok)
       when perms_ok $ do
493
         either_hdl <- liftIO $ tryIO (openFile file ReadMode)
494 495
         case either_hdl of
           Left _e   -> return ()
496 497 498
           -- NOTE: this assumes that runInputT won't affect the terminal;
           -- can we assume this will always be the case?
           -- This would be a good place for runFileInputT.
499 500
           Right hdl ->
               do runInputTWithPrefs defaultPrefs defaultSettings $
501
                            runCommands $ fileLoop hdl
502
                  liftIO (hClose hdl `catchIO` \_ -> return ())
503 504
     where
      getDirectory f = case takeDirectory f of "" -> "."; d -> d
505 506
  --

507
  setGHCContextFromGHCiState
Ian Lynagh's avatar
Ian Lynagh committed
508

509
  when (read_dot_files) $ do
510 511 512 513 514 515 516 517
    mcfgs0 <- catMaybes <$> sequence [ current_dir, app_user_dir, home_dir ]
    let mcfgs1 = zip mcfgs0 (repeat True)
              ++ zip (ghciScripts dflags) (repeat False)
         -- False says "don't check permissions".  We don't
         -- require that a script explicitly added by
         -- -ghci-script is owned by the current user. (#6017)
    mcfgs <- liftIO $ mapM (\(f, b) -> (,b) <$> canonicalizePath' f) mcfgs1
    mapM_ sourceConfigFile $ nub $ [ (f,b) | (Just f, b) <- mcfgs ]
518 519
        -- nub, because we don't want to read .ghci twice if the
        -- CWD is $HOME.
520

521
  -- Perform a :load for files given on the GHCi command line
522 523 524
  -- When in -e mode, if the load fails then we want to stop
  -- immediately rather than going on to evaluate the expression.
  when (not (null paths)) $ do
Ian Lynagh's avatar
Ian Lynagh committed
525
     ok <- ghciHandle (\e -> do showException e; return Failed) $
526
                -- TODO: this is a hack.
527 528
                runInputTWithPrefs defaultPrefs defaultSettings $
                    loadModule paths
Ian Lynagh's avatar
Ian Lynagh committed
529
     when (isJust maybe_exprs && failed ok) $
Ian Lynagh's avatar
Ian Lynagh committed
530
        liftIO (exitWith (ExitFailure 1))
531

532 533
  installInteractivePrint (interactivePrint dflags) (isJust maybe_exprs)

534 535
  -- if verbosity is greater than 0, or we are connected to a
  -- terminal, display the prompt in the interactive loop.
Ian Lynagh's avatar
Ian Lynagh committed
536
  is_tty <- liftIO (hIsTerminalDevice stdin)
537 538
  let show_prompt = verbosity dflags > 0 || is_tty

539 540 541
  -- reset line number
  getGHCiState >>= \st -> setGHCiState st{line_number=1}

Ian Lynagh's avatar
Ian Lynagh committed
542
  case maybe_exprs of
Ian Lynagh's avatar
Ian Lynagh committed
543
        Nothing ->
sof's avatar
sof committed
544
          do
Ian Lynagh's avatar
Ian Lynagh committed
545
            -- enter the interactive loop
546
            runGHCiInput $ runCommands $ nextInputLine show_prompt is_tty
Ian Lynagh's avatar
Ian Lynagh committed
547
        Just exprs -> do
Ian Lynagh's avatar
Ian Lynagh committed
548
            -- just evaluate the expression we were given
Ian Lynagh's avatar
Ian Lynagh committed
549
            enqueueCommands exprs
dterei's avatar
dterei committed
550 551 552 553 554 555 556 557
            let hdle e = do st <- getGHCiState
                            -- flush the interpreter's stdout/stderr on exit (#3890)
                            flushInterpBuffers
                            -- Jump through some hoops to get the
                            -- current progname in the exception text:
                            -- <progname>: <exception>
                            liftIO $ withProgName (progname st)
                                   $ topHandler e
558
                                   -- this used to be topHandlerFastExit, see #2228
559
            runInputTWithPrefs defaultPrefs defaultSettings $ do
560 561
                -- make `ghc -e` exit nonzero on invalid input, see Trac #7962
                runCommands' hdle (Just $ hdle (toException $ ExitFailure 1) >> return ()) (return Nothing)
562 563

  -- and finally, exit
Ian Lynagh's avatar
Ian Lynagh committed
564
  liftIO $ when (verbosity dflags > 0) $ putStrLn "Leaving GHCi."
565

566 567
runGHCiInput :: InputT GHCi a -> GHCi a
runGHCiInput f = do
Ian Lynagh's avatar
Ian Lynagh committed
568
    dflags <- getDynFlags
ian@well-typed.com's avatar
ian@well-typed.com committed
569
    histFile <- if gopt Opt_GhciHistory dflags
Ian Lynagh's avatar
Ian Lynagh committed
570 571 572
                then liftIO $ withGhcAppData (\dir -> return (Just (dir </> "ghci_history")))
                                             (return Nothing)
                else return Nothing
dterei's avatar
dterei committed
573 574 575
    runInputT
        (setComplete ghciCompleteWord $ defaultSettings {historyFile = histFile})
        f
576

577
-- | How to get the next input line from the user
578 579 580
nextInputLine :: Bool -> Bool -> InputT GHCi (Maybe String)
nextInputLine show_prompt is_tty
  | is_tty = do
dterei's avatar
dterei committed
581 582
    prmpt <- if show_prompt then lift mkPrompt else return ""
    r <- getInputLine prmpt
583 584
    incrementLineNo
    return r
585 586 587
  | otherwise = do
    when show_prompt $ lift mkPrompt >>= liftIO . putStr
    fileLoop stdin
588

589
-- NOTE: We only read .ghci files if they are owned by the current user,
590 591 592
-- and aren't world writable (files owned by root are ok, see #9324).
-- Otherwise, we could be accidentally running code planted by
-- a malicious third party.
593

rrt's avatar
rrt committed
594 595 596 597
-- Furthermore, We only read ./.ghci if . is owned by the current user
-- and isn't writable by anyone else.  I think this is sufficient: we
-- don't need to check .. and ../.. etc. because "."  always refers to
-- the same directory while a process is running.
598 599

checkPerms :: String -> IO Bool
600
#ifdef mingw32_HOST_OS
dterei's avatar
dterei committed
601
checkPerms _ = return True
sof's avatar
sof committed
602
#else
Simon Marlow's avatar
Simon Marlow committed
603
checkPerms name =
604
  handleIO (\_ -> return False) $ do
dterei's avatar
dterei committed
605 606
    st <- getFileStatus name
    me <- getRealUserID
607 608 609 610 611 612 613 614
    let mode = System.Posix.fileMode st
        ok = (fileOwner st == me || fileOwner st == 0) &&
             groupWriteMode /= mode `intersectFileModes` groupWriteMode &&
             otherWriteMode /= mode `intersectFileModes` otherWriteMode
    unless ok $
      putStrLn $ "*** WARNING: " ++ name ++
                 " is writable by someone else, IGNORING!"
    return ok
sof's avatar
sof committed
615
#endif
616

617 618
incrementLineNo :: InputT GHCi ()
incrementLineNo = do
vivian's avatar
vivian committed
619 620 621 622 623
   st <- lift $ getGHCiState
   let ln = 1+(line_number st)
   lift $ setGHCiState st{line_number=ln}

fileLoop :: Handle -> InputT GHCi (Maybe String)
624
fileLoop hdl = do
625
   l <- liftIO $ tryIO $ hGetLine hdl
626
   case l of
627
        Left e | isEOFError e              -> return Nothing
628 629 630 631 632
               | -- as we share stdin with the program, the program
                 -- might have already closed it, so we might get a
                 -- handle-closed exception. We therefore catch that
                 -- too.
                 isIllegalOperation e      -> return Nothing
633
               | InvalidArgument <- etype  -> return Nothing
634
               | otherwise                 -> liftIO $ ioError e
635 636 637 638 639
                where etype = ioeGetErrorType e
                -- treat InvalidArgument in the same way as EOF:
                -- this can happen if the user closed stdin, or
                -- perhaps did getContents which closes stdin at
                -- EOF.
dterei's avatar
dterei committed
640
        Right l' -> do
641
           incrementLineNo
dterei's avatar
dterei committed
642
           return (Just l')
643

Simon Marlow's avatar
Simon Marlow committed
644
mkPrompt :: GHCi String
645
mkPrompt = do
646
  st <- getGHCiState
647
  imports <- GHC.getContext
648
  resumes <- GHC.getResumeContext
649 650 651 652

  context_bit <-
        case resumes of
            [] -> return empty
Simon Marlow's avatar
Simon Marlow committed
653
            r:_ -> do
654 655 656 657 658
                let ix = GHC.resumeHistoryIx r
                if ix == 0
                   then return (brackets (ppr (GHC.resumeSpan r)) <> space)
                   else do
                        let hist = GHC.resumeHistory r !! (ix-1)
dterei's avatar
dterei committed
659 660 661
                        pan <- GHC.getHistorySpan hist
                        return (brackets (ppr (negate ix) <> char ':'
                                          <+> ppr pan) <> space)
662
  let
Simon Marlow's avatar
Simon Marlow committed
663
        dots | _:rs <- resumes, not (null rs) = text "... "
664 665
             | otherwise = empty

666 667
        rev_imports = reverse imports -- rightmost are the most recent
        modules_bit =
668
             hsep [ char '*' <> ppr m | IIModule m <- rev_imports ] <+>
669 670 671 672 673
             hsep (map ppr [ myIdeclName d | IIDecl d <- rev_imports ])

         --  use the 'as' name if there is one
        myIdeclName d | Just m <- ideclAs d = m
                      | otherwise           = unLoc (ideclName d)
674

675 676
        deflt_prompt = dots <> context_bit <> modules_bit

677
        f ('%':'l':xs) = ppr (1 + line_number st) <> f xs
678 679 680 681
        f ('%':'s':xs) = deflt_prompt <> f xs
        f ('%':'%':xs) = char '%' <> f xs
        f (x:xs) = char x <> f xs
        f [] = empty
dterei's avatar
dterei committed
682

Ian Lynagh's avatar
Ian Lynagh committed
683 684
  dflags <- getDynFlags
  return (showSDoc dflags (f (prompt st)))
685

686

687 688 689 690 691 692 693 694
queryQueue :: GHCi (Maybe String)
queryQueue = do
  st <- getGHCiState
  case cmdqueue st of
    []   -> return Nothing
    c:cs -> do setGHCiState st{ cmdqueue = cs }
               return (Just c)

695 696 697 698 699 700
-- Reconfigurable pretty-printing Ticket #5461
installInteractivePrint :: Maybe String -> Bool -> GHCi ()
installInteractivePrint Nothing _  = return ()
installInteractivePrint (Just ipFun) exprmode = do
  ok <- trySuccess $ do
                (name:_) <- GHC.parseName ipFun
701 702
                modifySession (\he -> let new_ic = setInteractivePrintName (hsc_IC he) name 
                                      in he{hsc_IC = new_ic})
703 704 705 706
                return Succeeded

  when (failed ok && exprmode) $ liftIO (exitWith (ExitFailure 1))

707
-- | The main read-eval-print loop
708
runCommands :: InputT GHCi (Maybe String) -> InputT GHCi ()
709
runCommands = runCommands' handler Nothing
710

dterei's avatar
dterei committed
711
runCommands' :: (SomeException -> GHCi Bool) -- ^ Exception handler
712
             -> Maybe (GHCi ()) -- ^ Source error handler
713
             -> InputT GHCi (Maybe String) -> InputT GHCi ()
714
runCommands' eh sourceErrorHandler gCmd = do
715
    b <- ghandle (\e -> case fromException e of
vivian's avatar
vivian committed
716
                          Just UserInterrupt -> return $ Just False
717
                          _ -> case fromException e of
dterei's avatar
dterei committed
718 719
                                 Just ghce ->
                                   do liftIO (print (ghce :: GhcException))
vivian's avatar
vivian committed
720
                                      return Nothing
721 722
                                 _other ->
                                   liftIO (Exception.throwIO e))
dterei's avatar
dterei committed
723
            (runOneCommand eh gCmd)
vivian's avatar
vivian committed
724 725
    case b of
      Nothing -> return ()
726
      Just success -> do
727 728
        when (not success) $ maybe (return ()) lift sourceErrorHandler
        runCommands' eh sourceErrorHandler gCmd
729

730
-- | Evaluate a single line of user input (either :<command> or Haskell code)
731
runOneCommand :: (SomeException -> GHCi Bool) -> InputT GHCi (Maybe String)
vivian's avatar
vivian committed
732
            -> InputT GHCi (Maybe Bool)
dterei's avatar
dterei committed
733
runOneCommand eh gCmd = do
734 735
  -- run a previously queued command if there is one, otherwise get new
  -- input from user
dterei's avatar
dterei committed
736 737 738
  mb_cmd0 <- noSpace (lift queryQueue)
  mb_cmd1 <- maybe (noSpace gCmd) (return . Just) mb_cmd0
  case mb_cmd1 of
vivian's avatar
vivian committed
739 740
    Nothing -> return Nothing
    Just c  -> ghciHandle (\e -> lift $ eh e >>= return . Just) $
741 742
             handleSourceError printErrorAndKeepGoing
               (doCommand c)
vivian's avatar
vivian committed
743 744
               -- source error's are handled by runStmt
               -- is the handler necessary here?
745
  where
746
    printErrorAndKeepGoing err = do
747
        GHC.printException err
vivian's avatar
vivian committed
748
        return $ Just True
749

750
    noSpace q = q >>= maybe (return Nothing)
dterei's avatar
dterei committed
751 752 753
                            (\c -> case removeSpaces c of
                                     ""   -> noSpace q
                                     ":{" -> multiLineCmd q
754
                                     _    -> return (Just c) )
755
    multiLineCmd q = do
756
      st <- lift getGHCiState
757
      let p = prompt st
758
      lift $ setGHCiState st{ prompt = prompt2 st }
759
      mb_cmd <- collectCommand q "" `GHC.gfinally` lift (getGHCiState >>= \st' -> setGHCiState st' { prompt = p })
760
      return mb_cmd
dterei's avatar
dterei committed
761
    -- we can't use removeSpaces for the sublines here, so
762
    -- multiline commands are somewhat more brittle against
dterei's avatar
dterei committed
763 764
    -- fileformat errors (such as \r in dos input on unix),
    -- we get rid of any extra spaces for the ":}" test;
765
    -- we also avoid silent failure if ":}" is not found;
dterei's avatar
dterei committed
766
    -- and since there is no (?) valid occurrence of \r (as
767 768
    -- opposed to its String representation, "\r") inside a
    -- ghci command, we replace any such with ' ' (argh:-(
dterei's avatar
dterei committed
769
    collectCommand q c = q >>=
770
      maybe (liftIO (ioError collectError))
dterei's avatar
dterei committed
771
            (\l->if removeSpaces l == ":}"
772
                 then return (Just c)
773
                 else collectCommand q (c ++ "\n" ++ map normSpace l))
774
      where normSpace '\r' = ' '
dterei's avatar
dterei committed
775
            normSpace   x  = x
dterei's avatar
dterei committed
776
    -- SDM (2007-11-07): is userError the one to use here?
777
    collectError = userError "unterminated multiline command :{ .. :}"
778 779 780 781 782

    -- | Handle a line of input
    doCommand :: String -> InputT GHCi (Maybe Bool)

    -- command
783
    doCommand stmt | (':' : cmd) <- removeSpaces stmt = do
vivian's avatar
vivian committed
784 785 786 787
      result <- specialCommand cmd
      case result of
        True -> return Nothing
        _    -> return $ Just True
788 789 790

    -- haskell
    doCommand stmt = do
791 792
      -- if 'stmt' was entered via ':{' it will contain '\n's
      let stmt_nl_cnt = length [ () | '\n' <- stmt ]
vivian's avatar
vivian committed
793
      ml <- lift $ isOptionSet Multiline
794
      if ml && stmt_nl_cnt == 0 -- don't trigger automatic multi-line mode for ':{'-multiline input
dterei's avatar
dterei committed
795
        then do
796
          fst_line_num <- lift (line_number <$> getGHCiState)
dterei's avatar
dterei committed
797
          mb_stmt <- checkInputForLayout stmt gCmd
vivian's avatar
vivian committed
798 799 800
          case mb_stmt of
            Nothing      -> return $ Just True
            Just ml_stmt -> do
801 802
              -- temporarily compensate line-number for multi-line input
              result <- timeIt $ lift $ runStmtWithLineNum fst_line_num ml_stmt GHC.RunToCompletion
vivian's avatar
vivian committed
803
              return $ Just result
804 805 806 807 808 809 810 811 812
        else do -- single line input and :{-multiline input
          last_line_num <- lift (line_number <$> getGHCiState)
          -- reconstruct first line num from last line num and stmt
          let fst_line_num | stmt_nl_cnt > 0 = last_line_num - (stmt_nl_cnt2 + 1)
                           | otherwise = last_line_num -- single line input
              stmt_nl_cnt2 = length [ () | '\n' <- stmt' ]
              stmt' = dropLeadingWhiteLines stmt -- runStmt doesn't like leading empty lines
          -- temporarily compensate line-number for multi-line input
          result <- timeIt $ lift $ runStmtWithLineNum fst_line_num stmt' GHC.RunToCompletion
vivian's avatar
vivian committed
813 814
          return $ Just result

815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830
    -- runStmt wrapper for temporarily overridden line-number
    runStmtWithLineNum :: Int -> String -> SingleStep -> GHCi Bool
    runStmtWithLineNum lnum stmt step = do
        st0 <- getGHCiState
        setGHCiState st0 { line_number = lnum }
        result <- runStmt stmt step
        -- restore original line_number
        getGHCiState >>= \st -> setGHCiState st { line_number = line_number st0 }
        return result

    -- note: this is subtly different from 'unlines . dropWhile (all isSpace) . lines'
    dropLeadingWhiteLines s | (l0,'\n':r) <- break (=='\n') s
                            , all isSpace l0 = dropLeadingWhiteLines r
                            | otherwise = s


vivian's avatar
vivian committed
831 832
-- #4316
-- lex the input.  If there is an unclosed layout context, request input
vivian's avatar
vivian committed
833
checkInputForLayout :: String -> InputT GHCi (Maybe String)
vivian's avatar
vivian committed
834
                    -> InputT GHCi (Maybe String)
vivian's avatar
vivian committed
835
checkInputForLayout stmt getStmt = do
vivian's avatar
vivian committed
836 837
   dflags' <- lift $ getDynFlags
   let dflags = xopt_set dflags' Opt_AlternativeLayoutRule
dterei's avatar
dterei committed
838 839 840 841
   st0 <- lift $ getGHCiState
   let buf'   =  stringToStringBuffer stmt
       loc    = mkRealSrcLoc (fsLit (progname st0)) (line_number st0) 1
       pstate = Lexer.mkPState dflags buf' loc
vivian's avatar
vivian committed
842 843 844
   case Lexer.unP goToEnd pstate of
     (Lexer.POk _ False) -> return $ Just stmt
     _other              -> do
dterei's avatar
dterei committed
845