UI.hs 149 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11
{-# LANGUAGE BangPatterns #-}
{-# LANGUAGE CPP #-}
{-# LANGUAGE LambdaCase #-}
{-# LANGUAGE MagicHash #-}
{-# LANGUAGE MultiWayIf #-}
{-# LANGUAGE NondecreasingIndentation #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE TupleSections #-}
{-# LANGUAGE ViewPatterns #-}

12 13 14
{-# OPTIONS -fno-cse #-}
-- -fno-cse is needed for GLOBAL_VAR's to behave properly

15 16 17 18
-----------------------------------------------------------------------------
--
-- GHC Interactive User Interface
--
19
-- (c) The GHC Team 2005-2006
20 21
--
-----------------------------------------------------------------------------
22

23
module GHCi.UI (
24 25 26 27 28 29
        interactiveUI,
        GhciSettings(..),
        defaultGhciSettings,
        ghciCommands,
        ghciWelcomeMsg
    ) where
30

31 32
#include "HsVersions.h"

dterei's avatar
dterei committed
33
-- GHCi
34 35 36 37
import qualified GHCi.UI.Monad as GhciMonad ( args, runStmt, runDecls )
import GHCi.UI.Monad hiding ( args, runStmt, runDecls )
import GHCi.UI.Tags
import GHCi.UI.Info
38
import Debugger
39

40
-- The GHC interface
41
import GHCi
42 43
import GHCi.RemoteTypes
import GHCi.BreakArray
dterei's avatar
dterei committed
44
import DynFlags
Douglas Wilson's avatar
Douglas Wilson committed
45
import ErrUtils hiding (traceCmd)
46
import Finder
47
import GhcMonad ( modifySession )
dterei's avatar
dterei committed
48 49 50
import qualified GHC
import GHC ( LoadHowMuch(..), Target(..),  TargetId(..), InteractiveImport(..),
             TyThing(..), Phase, BreakIndex, Resume, SingleStep, Ghc,
51
             getModuleGraph, handleSourceError )
52
import HsImpExp
53
import HsSyn
54
import HscTypes ( tyThingParent_maybe, handleFlagWarnings, getSafeMode, hsc_IC,
55
                  setInteractivePrintName, hsc_dflags, msObjFilePath )
dterei's avatar
dterei committed
56
import Module
57
import Name
58 59
import Packages ( trusted, getPackageDetails, getInstalledPackageDetails,
                  listVisibleModuleNames, pprFlag )
60
import IfaceSyn ( showToHeader )
dterei's avatar
dterei committed
61
import PprTyThing
62
import PrelNames
63
import RdrName ( getGRE_NameQualifier_maybes, getRdrName )
64
import SrcLoc
dterei's avatar
dterei committed
65 66 67
import qualified Lexer

import StringBuffer
Rufflewind's avatar
Rufflewind committed
68
import Outputable hiding ( printForUser, printForUserPartWay )
69 70

-- Other random utilities
dterei's avatar
dterei committed
71
import BasicTypes hiding ( isTopLevel )
72
import Config
dterei's avatar
dterei committed
73 74 75
import Digraph
import Encoding
import FastString
76
import Linker
dterei's avatar
dterei committed
77
import Maybes ( orElse, expectJust )
dterei's avatar
dterei committed
78 79
import NameSet
import Panic hiding ( showException )
80
import Util
81
import qualified GHC.LanguageExtensions as LangExt
sof's avatar
sof committed
82

dterei's avatar
dterei committed
83
-- Haskell Libraries
84
import System.Console.Haskeline as Haskeline
85

dterei's avatar
dterei committed
86
import Control.Applicative hiding (empty)
87 88
import Control.DeepSeq (deepseq)
import Control.Monad as Monad
89
import Control.Monad.IO.Class
90
import Control.Monad.Trans.Class
91
import Control.Monad.Trans.Except
92

dterei's avatar
dterei committed
93
import Data.Array
Simon Marlow's avatar
Simon Marlow committed
94
import qualified Data.ByteString.Char8 as BS
dterei's avatar
dterei committed
95
import Data.Char
Ian Lynagh's avatar
Ian Lynagh committed
96
import Data.Function
97
import Data.IORef ( IORef, modifyIORef, newIORef, readIORef, writeIORef )
dterei's avatar
dterei committed
98 99
import Data.List ( find, group, intercalate, intersperse, isPrefixOf, nub,
                   partition, sort, sortBy )
100
import qualified Data.Set as S
101
import Data.Maybe
102
import qualified Data.Map as M
niksaz's avatar
niksaz committed
103 104 105
import Data.Time.LocalTime ( getZonedTime )
import Data.Time.Format ( formatTime, defaultTimeLocale )
import Data.Version ( showVersion )
106
import Prelude hiding ((<>))
dterei's avatar
dterei committed
107

108
import Exception hiding (catch)
109
import Foreign hiding (void)
110
import GHC.Stack hiding (SrcLoc(..))
dterei's avatar
dterei committed
111 112

import System.Directory
113
import System.Environment
dterei's avatar
dterei committed
114
import System.Exit ( exitWith, ExitCode(..) )
dterei's avatar
dterei committed
115
import System.FilePath
niksaz's avatar
niksaz committed
116
import System.Info
ross's avatar
ross committed
117
import System.IO
118
import System.IO.Error
dterei's avatar
dterei committed
119
import System.IO.Unsafe ( unsafePerformIO )
120
import System.Process
Simon Marlow's avatar
Simon Marlow committed
121
import Text.Printf
122
import Text.Read ( readMaybe )
Geraldus's avatar
Geraldus committed
123
import Text.Read.Lex (isSymbolChar)
124

niksaz's avatar
niksaz committed
125 126
import Unsafe.Coerce

Ben Gamari's avatar
Ben Gamari committed
127
#if !defined(mingw32_HOST_OS)
dterei's avatar
dterei committed
128 129 130 131 132
import System.Posix hiding ( getEnv )
#else
import qualified System.Win32
#endif

dterei's avatar
dterei committed
133 134
import GHC.IO.Exception ( IOErrorType(InvalidArgument) )
import GHC.IO.Handle ( hFlushAll )
dterei's avatar
dterei committed
135
import GHC.TopHandler ( topHandler )
136

137 138
import GHCi.Leak

139 140
-----------------------------------------------------------------------------

141 142 143
data GhciSettings = GhciSettings {
        availableCommands :: [Command],
        shortHelpText     :: String,
144
        fullHelpText      :: String,
niksaz's avatar
niksaz committed
145 146
        defPrompt         :: PromptFunction,
        defPromptCont     :: PromptFunction
147 148 149 150 151 152 153
    }

defaultGhciSettings :: GhciSettings
defaultGhciSettings =
    GhciSettings {
        availableCommands = ghciCommands,
        shortHelpText     = defShortHelpText,
154
        defPrompt         = default_prompt,
niksaz's avatar
niksaz committed
155
        defPromptCont     = default_prompt_cont,
156
        fullHelpText      = defFullHelpText
157 158
    }

159 160 161
ghciWelcomeMsg :: String
ghciWelcomeMsg = "GHCi, version " ++ cProjectVersion ++
                 ": http://www.haskell.org/ghc/  :? for help"
162

163
ghciCommands :: [Command]
164
ghciCommands = map mkCmd [
165 166 167 168 169 170 171 172 173 174 175 176
  -- 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),
  ("cmd",       keepGoing cmdCmd,               completeExpression),
177 178
  ("ctags",     keepGoing createCTagsWithLineNumbersCmd, completeFilename),
  ("ctags!",    keepGoing createCTagsWithRegExesCmd, completeFilename),
179 180 181
  ("def",       keepGoing (defineMacro False),  completeExpression),
  ("def!",      keepGoing (defineMacro True),   completeExpression),
  ("delete",    keepGoing deleteCmd,            noCompletion),
182
  ("edit",      keepGoing' editFile,            completeFilename),
183 184 185 186 187
  ("etags",     keepGoing createETagsFileCmd,   completeFilename),
  ("force",     keepGoing forceCmd,             completeExpression),
  ("forward",   keepGoing forwardCmd,           noCompletion),
  ("help",      keepGoing help,                 noCompletion),
  ("history",   keepGoing historyCmd,           noCompletion),
188 189
  ("info",      keepGoing' (info False),        completeIdentifier),
  ("info!",     keepGoing' (info True),         completeIdentifier),
190
  ("issafe",    keepGoing' isSafeCmd,           completeModule),
191 192
  ("kind",      keepGoing' (kindOfType False),  completeIdentifier),
  ("kind!",     keepGoing' (kindOfType True),   completeIdentifier),
193 194
  ("load",      keepGoingPaths loadModule_,     completeHomeModuleOrFile),
  ("load!",     keepGoingPaths loadModuleDefer, completeHomeModuleOrFile),
195
  ("list",      keepGoing' listCmd,             noCompletion),
196
  ("module",    keepGoing moduleCmd,            completeSetModule),
197 198 199
  ("main",      keepGoing runMain,              completeFilename),
  ("print",     keepGoing printCmd,             completeExpression),
  ("quit",      quit,                           noCompletion),
200 201
  ("reload",    keepGoing' reloadModule,        noCompletion),
  ("reload!",   keepGoing' reloadModuleDefer,   noCompletion),
202
  ("run",       keepGoing runRun,               completeFilename),
vivian's avatar
vivian committed
203
  ("script",    keepGoing' scriptCmd,           completeFilename),
204
  ("set",       keepGoing setCmd,               completeSetOptions),
205
  ("seti",      keepGoing setiCmd,              completeSeti),
206
  ("show",      keepGoing showCmd,              completeShowOptions),
207
  ("showi",     keepGoing showiCmd,             completeShowiOptions),
208 209 210 211 212 213
  ("sprint",    keepGoing sprintCmd,            completeExpression),
  ("step",      keepGoing stepCmd,              completeIdentifier),
  ("steplocal", keepGoing stepLocalCmd,         completeIdentifier),
  ("stepmodule",keepGoing stepModuleCmd,        completeIdentifier),
  ("type",      keepGoing' typeOfExpr,          completeExpression),
  ("trace",     keepGoing traceCmd,             completeExpression),
214
  ("unadd",     keepGoingPaths unAddModule,     completeFilename),
215
  ("undef",     keepGoing undefineMacro,        completeMacro),
216 217
  ("unset",     keepGoing unsetOptions,         completeSetOptions),
  ("where",     keepGoing whereCmd,             noCompletion)
218
  ] ++ map mkCmdHidden [ -- hidden commands
219 220 221 222 223
  ("all-types", keepGoing' allTypesCmd),
  ("complete",  keepGoing completeCmd),
  ("loc-at",    keepGoing' locAtCmd),
  ("type-at",   keepGoing' typeAtCmd),
  ("uses",      keepGoing' usesCmd)
224
  ]
225 226 227 228 229 230 231 232 233 234 235 236
 where
  mkCmd (n,a,c) = Command { cmdName = n
                          , cmdAction = a
                          , cmdHidden = False
                          , cmdCompletionFunc = c
                          }

  mkCmdHidden (n,a) = Command { cmdName = n
                              , cmdAction = a
                              , cmdHidden = True
                              , cmdCompletionFunc = noCompletion
                              }
237

dterei's avatar
dterei committed
238
-- We initialize readline (in the interactiveUI function) to use
239 240 241 242
-- 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
243
--
244 245
-- NOTE: in order for us to override the default correctly, any custom entry
-- must be a SUBSET of word_break_chars.
246
word_break_chars :: String
Geraldus's avatar
Geraldus committed
247 248 249 250 251 252
word_break_chars = spaces ++ specials ++ symbols

symbols, specials, spaces :: String
symbols = "!#$%&*+/<=>?@\\^|-~"
specials = "(),;[]`{}"
spaces = " \t\n"
253

254
flagWordBreakChars :: String
255 256 257
flagWordBreakChars = " \t\n"


258 259 260 261 262
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
263

264
keepGoingPaths :: ([FilePath] -> InputT GHCi ()) -> (String -> InputT GHCi Bool)
Ian Lynagh's avatar
Ian Lynagh committed
265 266
keepGoingPaths a str
 = do case toArgs str of
Ian Lynagh's avatar
Ian Lynagh committed
267
          Left err -> liftIO $ hPutStrLn stderr err
Ian Lynagh's avatar
Ian Lynagh committed
268 269
          Right args -> a args
      return False
sof's avatar
sof committed
270

271 272
defShortHelpText :: String
defShortHelpText = "use :? for help.\n"
273

274 275
defFullHelpText :: String
defFullHelpText =
dterei's avatar
dterei committed
276 277 278 279 280 281 282 283 284 285
  " 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" ++
286
  "   :complete <dom> [<rng>] <s> list completions for partial input string\n" ++
287
  "   :ctags[!] [<file>]          create tags file <file> for Vi (default: \"tags\")\n" ++
dterei's avatar
dterei committed
288
  "                               (!: use regex instead of line number)\n" ++
289 290
  "   :def <cmd> <expr>           define command :<cmd> (later defined command has\n" ++
  "                               precedence, ::<cmd> is always a builtin command)\n" ++
dterei's avatar
dterei committed
291 292
  "   :edit <file>                edit file\n" ++
  "   :edit                       edit last module\n" ++
293
  "   :etags [<file>]             create tags file <file> for Emacs (default: \"TAGS\")\n" ++
dterei's avatar
dterei committed
294
  "   :help, :?                   display this list of commands\n" ++
295 296
  "   :info[!] [<name> ...]       display information about the given names\n" ++
  "                               (!: do not filter instances)\n" ++
dterei's avatar
dterei committed
297
  "   :issafe [<mod>]             display safe haskell information of module <mod>\n" ++
298 299
  "   :kind[!] <type>             show the kind of <type>\n" ++
  "                               (!: also print the normalised type)\n" ++
300 301
  "   :load[!] [*]<module> ...    load module(s) and their dependents\n" ++
  "                               (!: defer type errors)\n" ++
dterei's avatar
dterei committed
302 303 304
  "   :main [<arguments> ...]     run the main function with the given arguments\n" ++
  "   :module [+/-] [*]<mod> ...  set the context for expression evaluation\n" ++
  "   :quit                       exit GHCi\n" ++
305 306
  "   :reload[!]                  reload the current module set\n" ++
  "                               (!: defer type errors)\n" ++
dterei's avatar
dterei committed
307
  "   :run function [<arguments> ...] run the function with the given arguments\n" ++
308
  "   :script <file>              run the script <file>\n" ++
dterei's avatar
dterei committed
309
  "   :type <expr>                show the type of <expr>\n" ++
310 311
  "   :type +d <expr>             show the type of <expr>, defaulting type variables\n" ++
  "   :type +v <expr>             show the type of <expr>, with its specified tyvars\n" ++
312
  "   :unadd <module> ...         remove module(s) from the current target set\n" ++
dterei's avatar
dterei committed
313 314 315 316 317 318
  "   :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" ++
319
  "   :back [<n>]                 go back in the history N steps (after :trace)\n" ++
dterei's avatar
dterei committed
320 321 322 323 324 325
  "   :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" ++
326
  "   :forward [<n>]              go forward in the history N step s(after :back)\n" ++
dterei's avatar
dterei committed
327 328
  "   :history [<n>]              after :trace, show the execution history\n" ++
  "   :list                       show the source code around current breakpoint\n" ++
329
  "   :list <identifier>          show the source code for <identifier>\n" ++
dterei's avatar
dterei committed
330
  "   :list [<module>] <line>     show the source code around line number <line>\n" ++
Austin Seipp's avatar
Austin Seipp committed
331 332
  "   :print [<name> ...]         show a value without forcing its computation\n" ++
  "   :sprint [<name> ...]        simplified version of :print\n" ++
dterei's avatar
dterei committed
333 334 335 336 337 338
  "   :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
339

dterei's avatar
dterei committed
340 341 342 343
  "\n" ++
  " -- Commands for changing settings:\n" ++
  "\n" ++
  "   :set <option> ...           set options\n" ++
344
  "   :seti <option> ...          set options for interactive evaluation only\n" ++
dterei's avatar
dterei committed
345 346 347
  "   :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" ++
niksaz's avatar
niksaz committed
348 349 350 351
  "   :set prompt-cont <prompt>   set the continuation prompt used in GHCi\n" ++
  "   :set prompt-function <expr> set the function to handle the prompt\n" ++
  "   :set prompt-cont-function <expr>" ++
                     "set the function to handle the continuation prompt\n" ++
dterei's avatar
dterei committed
352 353 354 355 356 357
  "   :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
358
  "    +m            allow multiline commands\n" ++
dterei's avatar
dterei committed
359 360 361
  "    +r            revert top-level expressions after each evaluation\n" ++
  "    +s            print timing/memory stats after each evaluation\n" ++
  "    +t            print type after evaluation\n" ++
362
  "    +c            collect type/location info after loading modules\n" ++
dterei's avatar
dterei committed
363
  "    -<flags>      most GHC command line flags can also be set here\n" ++
364
  "                         (eg. -v2, -XFlexibleInstances, etc.)\n" ++
dterei's avatar
dterei committed
365 366 367 368 369 370 371 372
  "                    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" ++
373
  "   :show imports               show the current imports\n" ++
374
  "   :show linker                show current linker state\n" ++
dterei's avatar
dterei committed
375 376
  "   :show modules               show the currently loaded modules\n" ++
  "   :show packages              show the currently active package flags\n" ++
377
  "   :show paths                 show the currently active search paths\n" ++
378
  "   :show language              show the currently active language flags\n" ++
379
  "   :show targets               show the current set of targets\n" ++
dterei's avatar
dterei committed
380
  "   :show <setting>             show value of <setting>, which is one of\n" ++
niksaz's avatar
niksaz committed
381
  "                                  [args, prog, editor, stop]\n" ++
382
  "   :showi language             show language flags for interactive evaluation\n" ++
dterei's avatar
dterei committed
383
  "\n"
384

Simon Marlow's avatar
Simon Marlow committed
385
findEditor :: IO String
Simon Marlow's avatar
Simon Marlow committed
386
findEditor = do
dterei's avatar
dterei committed
387
  getEnv "EDITOR"
388
    `catchIO` \_ -> do
Ben Gamari's avatar
Ben Gamari committed
389
#if defined(mingw32_HOST_OS)
Ian Lynagh's avatar
Ian Lynagh committed
390 391
        win <- System.Win32.getWindowsDirectory
        return (win </> "notepad.exe")
Simon Marlow's avatar
Simon Marlow committed
392
#else
Ian Lynagh's avatar
Ian Lynagh committed
393
        return ""
Simon Marlow's avatar
Simon Marlow committed
394 395
#endif

niksaz's avatar
niksaz committed
396
default_progname, default_stop :: String
Boris Lykah's avatar
Boris Lykah committed
397 398 399
default_progname = "<interactive>"
default_stop = ""

niksaz's avatar
niksaz committed
400 401 402 403
default_prompt, default_prompt_cont :: PromptFunction
default_prompt = generatePromptFunctionFromString "%s> "
default_prompt_cont = generatePromptFunctionFromString "%s| "

Simon Marlow's avatar
Simon Marlow committed
404 405 406
default_args :: [String]
default_args = []

407
interactiveUI :: GhciSettings -> [(FilePath, Maybe Phase)] -> Maybe [String]
408
              -> Ghc ()
409
interactiveUI config srcs maybe_exprs = do
410 411 412 413 414 415 416 417
   -- 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.
418 419 420
   _ <- liftIO $ newStablePtr stdin
   _ <- liftIO $ newStablePtr stdout
   _ <- liftIO $ newStablePtr stderr
421

Ian Lynagh's avatar
Ian Lynagh committed
422
    -- Initialise buffering for the *interpreted* I/O system
423
   (nobuffering, flush) <- initInterpBuffering
424

425
   -- The initial set of DynFlags used for interactive evaluation is the same
426 427
   -- as the global DynFlags, plus -XExtendedDefaultRules and
   -- -XNoMonomorphismRestriction.
428
   dflags <- getDynFlags
429 430
   let dflags' = (`xopt_set` LangExt.ExtendedDefaultRules)
               . (`xopt_unset` LangExt.MonomorphismRestriction)
431 432
               $ dflags
   GHC.setInteractiveDynFlags dflags'
433

434 435 436 437 438
   lastErrLocationsRef <- liftIO $ newIORef []
   progDynFlags <- GHC.getProgramDynFlags
   _ <- GHC.setProgramDynFlags $
      progDynFlags { log_action = ghciLogAction lastErrLocationsRef }

439
   when (isNothing maybe_exprs) $ do
Ian Lynagh's avatar
Ian Lynagh committed
440 441 442
        -- Only for GHCi (not runghc and ghc -e):

        -- Turn buffering off for the compiled program's stdout/stderr
443
        turnOffBuffering_ nobuffering
Ian Lynagh's avatar
Ian Lynagh committed
444
        -- Turn buffering off for GHCi's stdout
445 446
        liftIO $ hFlush stdout
        liftIO $ hSetBuffering stdout NoBuffering
Ian Lynagh's avatar
Ian Lynagh committed
447 448
        -- We don't want the cmd line to buffer any input that might be
        -- intended for the program, so unbuffer stdin.
449 450
        liftIO $ hSetBuffering stdin NoBuffering
        liftIO $ hSetBuffering stderr NoBuffering
451
#if defined(mingw32_HOST_OS)
452 453 454
        -- 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.
455
        liftIO $ hSetEncoding stdin utf8
456
#endif
Ian Lynagh's avatar
Ian Lynagh committed
457

458
   default_editor <- liftIO $ findEditor
459
   eval_wrapper <- mkEvalWrapper default_progname default_args
460
   let prelude_import = simpleImportDecl preludeModuleName
Ian Lynagh's avatar
Ian Lynagh committed
461
   startGHCi (runGHCi srcs maybe_exprs)
462
        GHCiState{ progname           = default_progname,
463
                   args               = default_args,
464
                   evalWrapper        = eval_wrapper,
niksaz's avatar
niksaz committed
465 466
                   prompt             = default_prompt,
                   prompt_cont        = default_prompt_cont,
467 468 469
                   stop               = default_stop,
                   editor             = default_editor,
                   options            = [],
470 471 472 473
                   -- We initialize line number as 0, not 1, because we use
                   -- current line number while reporting errors which is
                   -- incremented after reading a line.
                   line_number        = 0,
474 475 476 477
                   break_ctr          = 0,
                   breaks             = [],
                   tickarrays         = emptyModuleEnv,
                   ghci_commands      = availableCommands config,
Ben Gamari's avatar
Ben Gamari committed
478
                   ghci_macros        = [],
479 480 481 482
                   last_command       = Nothing,
                   cmdqueue           = [],
                   remembered_ctx     = [],
                   transient_ctx      = [],
483 484
                   extra_imports      = [],
                   prelude_imports    = [prelude_import],
485 486 487
                   ghc_e              = isJust maybe_exprs,
                   short_help         = shortHelpText config,
                   long_help          = fullHelpText config,
488
                   lastErrorLocations = lastErrLocationsRef,
489
                   mod_infos          = M.empty,
490 491
                   flushStdHandles    = flush,
                   noBuffering        = nobuffering
mnislaih's avatar
mnislaih committed
492
                 }
493

494 495
   return ()

496 497 498 499 500 501
resetLastErrorLocations :: GHCi ()
resetLastErrorLocations = do
    st <- getGHCiState
    liftIO $ writeIORef (lastErrorLocations st) []

ghciLogAction :: IORef [(FastString, Int)] ->  LogAction
502 503
ghciLogAction lastErrLocations dflags flag severity srcSpan style msg = do
    defaultLogAction dflags flag severity srcSpan style msg
504 505 506 507 508 509 510
    case severity of
        SevError -> case srcSpan of
            RealSrcSpan rsp -> modifyIORef lastErrLocations
                (++ [(srcLocFile (realSrcSpanStart rsp), srcLocLine (realSrcSpanStart rsp))])
            _ -> return ()
        _ -> return ()

511 512
withGhcAppData :: (FilePath -> IO a) -> IO a -> IO a
withGhcAppData right left = do
513
    either_dir <- tryIO (getAppUserDataDirectory "ghc")
514 515 516 517 518
    case either_dir of
        Right dir ->
            do createDirectoryIfMissing False dir `catchIO` \_ -> return ()
               right dir
        _ -> left
519

Ian Lynagh's avatar
Ian Lynagh committed
520 521
runGHCi :: [(FilePath, Maybe Phase)] -> Maybe [String] -> GHCi ()
runGHCi paths maybe_exprs = do
522
  dflags <- getDynFlags
523
  let
524
   ignore_dot_ghci = gopt Opt_IgnoreDotGhci dflags
525

526 527
   current_dir = return (Just ".ghci")

Ian Lynagh's avatar
Ian Lynagh committed
528
   app_user_dir = liftIO $ withGhcAppData
529 530
                    (\dir -> return (Just (dir </> "ghci.conf")))
                    (return Nothing)
531 532

   home_dir = do
533
    either_dir <- liftIO $ tryIO (getEnv "HOME")
534 535 536 537
    case either_dir of
      Right home -> return (Just (home </> ".ghci"))
      _ -> return Nothing

538 539 540 541
   canonicalizePath' :: FilePath -> IO (Maybe FilePath)
   canonicalizePath' fp = liftM Just (canonicalizePath fp)
                `catchIO` \_ -> return Nothing

542 543
   sourceConfigFile :: FilePath -> GHCi ()
   sourceConfigFile file = do
Ian Lynagh's avatar
Ian Lynagh committed
544
     exists <- liftIO $ doesFileExist file
545
     when exists $ do
546 547 548 549 550 551 552 553 554 555
       either_hdl <- liftIO $ tryIO (openFile file ReadMode)
       case either_hdl of
         Left _e   -> return ()
         -- 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.
         Right hdl ->
             do runInputTWithPrefs defaultPrefs defaultSettings $
                          runCommands $ fileLoop hdl
                liftIO (hClose hdl `catchIO` \_ -> return ())
556 557 558 559 560
                -- Don't print a message if this is really ghc -e (#11478).
                -- Also, let the user silence the message with -v0
                -- (the default verbosity in GHCi is 1).
                when (isNothing maybe_exprs && verbosity dflags > 0) $
                  liftIO $ putStrLn ("Loaded GHCi configuration from " ++ file)
561

562 563
  --

564
  setGHCContextFromGHCiState
Ian Lynagh's avatar
Ian Lynagh committed
565

566 567
  dot_cfgs <- if ignore_dot_ghci then return [] else do
    dot_files <- catMaybes <$> sequence [ current_dir, app_user_dir, home_dir ]
568
    liftIO $ filterM checkFileAndDirPerms dot_files
569 570
  mdot_cfgs <- liftIO $ mapM canonicalizePath' dot_cfgs

571 572 573 574
  let arg_cfgs = reverse $ ghciScripts dflags
    -- -ghci-script are collected in reverse order
    -- We don't require that a script explicitly added by -ghci-script
    -- is owned by the current user. (#6017)
575
  mapM_ sourceConfigFile $ nub $ (catMaybes mdot_cfgs) ++ arg_cfgs
576
    -- nub, because we don't want to read .ghci twice if the CWD is $HOME.
577

578
  -- Perform a :load for files given on the GHCi command line
579 580 581
  -- 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
582
     ok <- ghciHandle (\e -> do showException e; return Failed) $
583
                -- TODO: this is a hack.
584 585
                runInputTWithPrefs defaultPrefs defaultSettings $
                    loadModule paths
Ian Lynagh's avatar
Ian Lynagh committed
586
     when (isJust maybe_exprs && failed ok) $
Ian Lynagh's avatar
Ian Lynagh committed
587
        liftIO (exitWith (ExitFailure 1))
588

589 590
  installInteractivePrint (interactivePrint dflags) (isJust maybe_exprs)

591 592
  -- 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
593
  is_tty <- liftIO (hIsTerminalDevice stdin)
594 595
  let show_prompt = verbosity dflags > 0 || is_tty

596
  -- reset line number
597
  modifyGHCiState $ \st -> st{line_number=0}
598

Ian Lynagh's avatar
Ian Lynagh committed
599
  case maybe_exprs of
Ian Lynagh's avatar
Ian Lynagh committed
600
        Nothing ->
sof's avatar
sof committed
601
          do
Ian Lynagh's avatar
Ian Lynagh committed
602
            -- enter the interactive loop
603
            runGHCiInput $ runCommands $ nextInputLine show_prompt is_tty
Ian Lynagh's avatar
Ian Lynagh committed
604
        Just exprs -> do
Ian Lynagh's avatar
Ian Lynagh committed
605
            -- just evaluate the expression we were given
Ian Lynagh's avatar
Ian Lynagh committed
606
            enqueueCommands exprs
dterei's avatar
dterei committed
607 608 609 610 611 612 613 614
            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
615
                                   -- this used to be topHandlerFastExit, see #2228
616
            runInputTWithPrefs defaultPrefs defaultSettings $ do
617
                -- make `ghc -e` exit nonzero on invalid input, see Trac #7962
618 619 620 621
                _ <- runCommands' hdle
                     (Just $ hdle (toException $ ExitFailure 1) >> return ())
                     (return Nothing)
                return ()
622 623

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

626 627
runGHCiInput :: InputT GHCi a -> GHCi a
runGHCiInput f = do
Ian Lynagh's avatar
Ian Lynagh committed
628
    dflags <- getDynFlags
629 630 631 632 633 634 635 636 637 638
    let ghciHistory = gopt Opt_GhciHistory dflags
    let localGhciHistory = gopt Opt_LocalGhciHistory dflags
    currentDirectory <- liftIO $ getCurrentDirectory

    histFile <- case (ghciHistory, localGhciHistory) of
      (True, True) -> return (Just (currentDirectory </> ".ghci_history"))
      (True, _) -> liftIO $ withGhcAppData
        (\dir -> return (Just (dir </> "ghci_history"))) (return Nothing)
      _ -> return Nothing

dterei's avatar
dterei committed
639 640 641
    runInputT
        (setComplete ghciCompleteWord $ defaultSettings {historyFile = histFile})
        f
642

643
-- | How to get the next input line from the user
644 645 646
nextInputLine :: Bool -> Bool -> InputT GHCi (Maybe String)
nextInputLine show_prompt is_tty
  | is_tty = do
dterei's avatar
dterei committed
647 648
    prmpt <- if show_prompt then lift mkPrompt else return ""
    r <- getInputLine prmpt
649 650
    incrementLineNo
    return r
651 652 653
  | otherwise = do
    when show_prompt $ lift mkPrompt >>= liftIO . putStr
    fileLoop stdin
654

655
-- NOTE: We only read .ghci files if they are owned by the current user,
656 657 658
-- 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.
659

rrt's avatar
rrt committed
660 661 662 663
-- 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.
664

665 666
checkFileAndDirPerms :: FilePath -> IO Bool
checkFileAndDirPerms file = do
667
  file_ok <- checkPerms file
thomie's avatar
thomie committed
668 669 670 671
  -- Do not check dir perms when .ghci doesn't exist, otherwise GHCi will
  -- print some confusing and useless warnings in some cases (e.g. in
  -- travis). Note that we can't add a test for this, as all ghci tests should
  -- run with -ignore-dot-ghci, which means we never get here.
672
  if file_ok then checkPerms (getDirectory file) else return False
673 674 675 676 677 678
  where
  getDirectory f = case takeDirectory f of
    "" -> "."
    d -> d

checkPerms :: FilePath -> IO Bool
Ben Gamari's avatar
Ben Gamari committed
679
#if defined(mingw32_HOST_OS)
dterei's avatar
dterei committed
680
checkPerms _ = return True
sof's avatar
sof committed
681
#else
682
checkPerms file =
683
  handleIO (\_ -> return False) $ do
684
    st <- getFileStatus file
dterei's avatar
dterei committed
685
    me <- getRealUserID
686 687 688 689 690
    let mode = System.Posix.fileMode st
        ok = (fileOwner st == me || fileOwner st == 0) &&
             groupWriteMode /= mode `intersectFileModes` groupWriteMode &&
             otherWriteMode /= mode `intersectFileModes` otherWriteMode
    unless ok $
691
      -- #8248: Improving warning to include a possible fix.
692
      putStrLn $ "*** WARNING: " ++ file ++
693
                 " is writable by someone else, IGNORING!" ++
Ben Gamari's avatar
Ben Gamari committed
694
                 "\nSuggested fix: execute 'chmod go-w " ++ file ++ "'"
695
    return ok
sof's avatar
sof committed
696
#endif
697

698
incrementLineNo :: InputT GHCi ()
699 700 701
incrementLineNo = modifyGHCiState incLineNo
  where
    incLineNo st = st { line_number = line_number st + 1 }
vivian's avatar
vivian committed
702 703

fileLoop :: Handle -> InputT GHCi (Maybe String)
704
fileLoop hdl = do
705
   l <- liftIO $ tryIO $ hGetLine hdl
706
   case l of
707
        Left e | isEOFError e              -> return Nothing
708 709 710 711 712
               | -- 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
713
               | InvalidArgument <- etype  -> return Nothing
714
               | otherwise                 -> liftIO $ ioError e
715 716 717 718 719
                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
720
        Right l' -> do
721
           incrementLineNo
dterei's avatar
dterei committed
722
           return (Just l')
723

niksaz's avatar
niksaz committed
724 725 726 727 728 729
formatCurrentTime :: String -> IO String
formatCurrentTime format =
  getZonedTime >>= return . (formatTime defaultTimeLocale format)

getUserName :: IO String
getUserName = do
Ben Gamari's avatar
Ben Gamari committed
730
#if defined(mingw32_HOST_OS)
niksaz's avatar
niksaz committed
731 732 733 734 735 736 737 738 739 740
  getEnv "USERNAME"
    `catchIO` \e -> do
      putStrLn $ show e
      return ""
#else
  getLoginName
#endif

getInfoForPrompt :: GHCi (SDoc, [String], Int)
getInfoForPrompt = do
741
  st <- getGHCiState
742
  imports <- GHC.getContext
743
  resumes <- GHC.getResumeContext
744 745 746 747

  context_bit <-
        case resumes of
            [] -> return empty
Simon Marlow's avatar
Simon Marlow committed
748
            r:_ -> do
749 750 751 752 753
                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
754 755 756
                        pan <- GHC.getHistorySpan hist
                        return (brackets (ppr (negate ix) <> char ':'
                                          <+> ppr pan) <> space)
niksaz's avatar
niksaz committed
757

758
  let
Simon Marlow's avatar
Simon Marlow committed
759
        dots | _:rs <- resumes, not (null rs) = text "... "
760 761
             | otherwise = empty

762 763
        rev_imports = reverse imports -- rightmost are the most recent

764
        myIdeclName d | Just m <- ideclAs d = unLoc m
765
                      | otherwise           = unLoc (ideclName d)
766

niksaz's avatar
niksaz committed
767 768 769 770 771 772
        modules_names =
             ['*':(moduleNameString m) | IIModule m <- rev_imports] ++
             [moduleNameString (myIdeclName d) | IIDecl d <- rev_imports]
        line = 1 + line_number st

  return (dots <> context_bit, modules_names, line)
773

niksaz's avatar
niksaz committed
774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838