UI.hs 147 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 GhcMonad ( modifySession )
dterei's avatar
dterei committed
47 48 49
import qualified GHC
import GHC ( LoadHowMuch(..), Target(..),  TargetId(..), InteractiveImport(..),
             TyThing(..), Phase, BreakIndex, Resume, SingleStep, Ghc,
50
             getModuleGraph, handleSourceError )
51
import HsImpExp
52
import HsSyn
53
import HscTypes ( tyThingParent_maybe, handleFlagWarnings, getSafeMode, hsc_IC,
54
                  setInteractivePrintName, hsc_dflags )
dterei's avatar
dterei committed
55
import Module
56
import Name
57 58
import Packages ( trusted, getPackageDetails, getInstalledPackageDetails,
                  listVisibleModuleNames, pprFlag )
59
import IfaceSyn ( showToHeader )
dterei's avatar
dterei committed
60
import PprTyThing
61
import PrelNames
62
import RdrName ( getGRE_NameQualifier_maybes, getRdrName )
63
import SrcLoc
dterei's avatar
dterei committed
64 65 66
import qualified Lexer

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

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

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

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

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

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

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

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

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

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

136 137
-----------------------------------------------------------------------------

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

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

156 157 158
ghciWelcomeMsg :: String
ghciWelcomeMsg = "GHCi, version " ++ cProjectVersion ++
                 ": http://www.haskell.org/ghc/  :? for help"
159

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

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

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

250
flagWordBreakChars :: String
251 252 253
flagWordBreakChars = " \t\n"


254 255 256 257 258
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
259

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

267 268
defShortHelpText :: String
defShortHelpText = "use :? for help.\n"
269

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

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

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

niksaz's avatar
niksaz committed
390
default_progname, default_stop :: String
Boris Lykah's avatar
Boris Lykah committed
391 392 393
default_progname = "<interactive>"
default_stop = ""

niksaz's avatar
niksaz committed
394 395 396 397
default_prompt, default_prompt_cont :: PromptFunction
default_prompt = generatePromptFunctionFromString "%s> "
default_prompt_cont = generatePromptFunctionFromString "%s| "

Simon Marlow's avatar
Simon Marlow committed
398 399 400
default_args :: [String]
default_args = []

401
interactiveUI :: GhciSettings -> [(FilePath, Maybe Phase)] -> Maybe [String]
402
              -> Ghc ()
403
interactiveUI config srcs maybe_exprs = do
404 405 406 407 408 409 410 411
   -- 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.
412 413 414
   _ <- liftIO $ newStablePtr stdin
   _ <- liftIO $ newStablePtr stdout
   _ <- liftIO $ newStablePtr stderr
415

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

419
   -- The initial set of DynFlags used for interactive evaluation is the same
420 421
   -- as the global DynFlags, plus -XExtendedDefaultRules and
   -- -XNoMonomorphismRestriction.
422
   dflags <- getDynFlags
423 424
   let dflags' = (`xopt_set` LangExt.ExtendedDefaultRules)
               . (`xopt_unset` LangExt.MonomorphismRestriction)
425 426
               $ dflags
   GHC.setInteractiveDynFlags dflags'
427

428 429 430 431 432
   lastErrLocationsRef <- liftIO $ newIORef []
   progDynFlags <- GHC.getProgramDynFlags
   _ <- GHC.setProgramDynFlags $
      progDynFlags { log_action = ghciLogAction lastErrLocationsRef }

433
   when (isNothing maybe_exprs) $ do
Ian Lynagh's avatar
Ian Lynagh committed
434 435 436
        -- Only for GHCi (not runghc and ghc -e):

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

452
   default_editor <- liftIO $ findEditor
453
   eval_wrapper <- mkEvalWrapper default_progname default_args
454
   let prelude_import = simpleImportDecl preludeModuleName
Ian Lynagh's avatar
Ian Lynagh committed
455
   startGHCi (runGHCi srcs maybe_exprs)
456
        GHCiState{ progname           = default_progname,
457
                   args               = default_args,
458
                   evalWrapper        = eval_wrapper,
niksaz's avatar
niksaz committed
459 460
                   prompt             = default_prompt,
                   prompt_cont        = default_prompt_cont,
461 462 463
                   stop               = default_stop,
                   editor             = default_editor,
                   options            = [],
464 465 466 467
                   -- 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,
468 469 470 471
                   break_ctr          = 0,
                   breaks             = [],
                   tickarrays         = emptyModuleEnv,
                   ghci_commands      = availableCommands config,
Ben Gamari's avatar
Ben Gamari committed
472
                   ghci_macros        = [],
473 474 475 476
                   last_command       = Nothing,
                   cmdqueue           = [],
                   remembered_ctx     = [],
                   transient_ctx      = [],
477 478
                   extra_imports      = [],
                   prelude_imports    = [prelude_import],
479 480 481
                   ghc_e              = isJust maybe_exprs,
                   short_help         = shortHelpText config,
                   long_help          = fullHelpText config,
482
                   lastErrorLocations = lastErrLocationsRef,
483
                   mod_infos          = M.empty,
484 485
                   flushStdHandles    = flush,
                   noBuffering        = nobuffering
mnislaih's avatar
mnislaih committed
486
                 }
487

488 489
   return ()

490 491 492 493 494 495
resetLastErrorLocations :: GHCi ()
resetLastErrorLocations = do
    st <- getGHCiState
    liftIO $ writeIORef (lastErrorLocations st) []

ghciLogAction :: IORef [(FastString, Int)] ->  LogAction
496 497
ghciLogAction lastErrLocations dflags flag severity srcSpan style msg = do
    defaultLogAction dflags flag severity srcSpan style msg
498 499 500 501 502 503 504
    case severity of
        SevError -> case srcSpan of
            RealSrcSpan rsp -> modifyIORef lastErrLocations
                (++ [(srcLocFile (realSrcSpanStart rsp), srcLocLine (realSrcSpanStart rsp))])
            _ -> return ()
        _ -> return ()

505 506
withGhcAppData :: (FilePath -> IO a) -> IO a -> IO a
withGhcAppData right left = do
507
    either_dir <- tryIO (getAppUserDataDirectory "ghc")
508 509 510 511 512
    case either_dir of
        Right dir ->
            do createDirectoryIfMissing False dir `catchIO` \_ -> return ()
               right dir
        _ -> left
513

Ian Lynagh's avatar
Ian Lynagh committed
514 515
runGHCi :: [(FilePath, Maybe Phase)] -> Maybe [String] -> GHCi ()
runGHCi paths maybe_exprs = do
516
  dflags <- getDynFlags
517
  let
518
   ignore_dot_ghci = gopt Opt_IgnoreDotGhci dflags
519

520 521
   current_dir = return (Just ".ghci")

Ian Lynagh's avatar
Ian Lynagh committed
522
   app_user_dir = liftIO $ withGhcAppData
523 524
                    (\dir -> return (Just (dir </> "ghci.conf")))
                    (return Nothing)
525 526

   home_dir = do
527
    either_dir <- liftIO $ tryIO (getEnv "HOME")
528 529 530 531
    case either_dir of
      Right home -> return (Just (home </> ".ghci"))
      _ -> return Nothing

532 533 534 535
   canonicalizePath' :: FilePath -> IO (Maybe FilePath)
   canonicalizePath' fp = liftM Just (canonicalizePath fp)
                `catchIO` \_ -> return Nothing

536 537
   sourceConfigFile :: FilePath -> GHCi ()
   sourceConfigFile file = do
Ian Lynagh's avatar
Ian Lynagh committed
538
     exists <- liftIO $ doesFileExist file
539
     when exists $ do
540 541 542 543 544 545 546 547 548 549
       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 ())
550 551 552 553 554
                -- 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)
555

556 557
  --

558
  setGHCContextFromGHCiState
Ian Lynagh's avatar
Ian Lynagh committed
559

560 561
  dot_cfgs <- if ignore_dot_ghci then return [] else do
    dot_files <- catMaybes <$> sequence [ current_dir, app_user_dir, home_dir ]
562
    liftIO $ filterM checkFileAndDirPerms dot_files
563 564
  mdot_cfgs <- liftIO $ mapM canonicalizePath' dot_cfgs

565 566 567 568
  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)
569
  mapM_ sourceConfigFile $ nub $ (catMaybes mdot_cfgs) ++ arg_cfgs
570
    -- nub, because we don't want to read .ghci twice if the CWD is $HOME.
571

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

583 584
  installInteractivePrint (interactivePrint dflags) (isJust maybe_exprs)

585 586
  -- 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
587
  is_tty <- liftIO (hIsTerminalDevice stdin)
588 589
  let show_prompt = verbosity dflags > 0 || is_tty

590
  -- reset line number
591
  modifyGHCiState $ \st -> st{line_number=0}
592

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

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

620 621
runGHCiInput :: InputT GHCi a -> GHCi a
runGHCiInput f = do
Ian Lynagh's avatar
Ian Lynagh committed
622
    dflags <- getDynFlags
623 624 625 626 627 628 629 630 631 632
    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
633 634 635
    runInputT
        (setComplete ghciCompleteWord $ defaultSettings {historyFile = histFile})
        f
636

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

649
-- NOTE: We only read .ghci files if they are owned by the current user,
650 651 652
-- 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.
653

rrt's avatar
rrt committed
654 655 656 657
-- 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.
658

659 660
checkFileAndDirPerms :: FilePath -> IO Bool
checkFileAndDirPerms file = do
661
  file_ok <- checkPerms file
thomie's avatar
thomie committed
662 663 664 665
  -- 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.
666
  if file_ok then checkPerms (getDirectory file) else return False
667 668 669 670 671 672
  where
  getDirectory f = case takeDirectory f of
    "" -> "."
    d -> d

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

692
incrementLineNo :: InputT GHCi ()
693 694 695
incrementLineNo = modifyGHCiState incLineNo
  where
    incLineNo st = st { line_number = line_number st + 1 }
vivian's avatar
vivian committed
696 697

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

niksaz's avatar
niksaz committed
718 719 720 721 722 723
formatCurrentTime :: String -> IO String
formatCurrentTime format =
  getZonedTime >>= return . (formatTime defaultTimeLocale format)

getUserName :: IO String
getUserName = do
Ben Gamari's avatar
Ben Gamari committed
724
#if defined(mingw32_HOST_OS)
niksaz's avatar
niksaz committed
725 726 727 728 729 730 731 732 733 734
  getEnv "USERNAME"
    `catchIO` \e -> do
      putStrLn $ show e
      return ""
#else
  getLoginName
#endif

getInfoForPrompt :: GHCi (SDoc, [String], Int)
getInfoForPrompt = do
735
  st <- getGHCiState
736
  imports <- GHC.getContext
737
  resumes <- GHC.getResumeContext
738 739 740 741

  context_bit <-
        case resumes of
            [] -> return empty
Simon Marlow's avatar
Simon Marlow committed
742
            r:_ -> do
743 744 745 746 747
                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
748 749 750
                        pan <- GHC.getHistorySpan hist
                        return (brackets (ppr (negate ix) <> char ':'
                                          <+> ppr pan) <> space)
niksaz's avatar
niksaz committed
751

752
  let
Simon Marlow's avatar
Simon Marlow committed
753
        dots | _:rs <- resumes, not (null rs) = text "... "
754 755
             | otherwise = empty

756 757
        rev_imports = reverse imports -- rightmost are the most recent

758
        myIdeclName d | Just m <- ideclAs d = unLoc m
759
                      | otherwise           = unLoc (ideclName d)
760

niksaz's avatar
niksaz committed
761 762 763 764 765 766
        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)
767

niksaz's avatar
niksaz committed
768 769 770 771 772 773 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 839 840 841 842 843 844 845 846