1 {-# OPTIONS_GHC -fno-cse -fno-warn-orphans #-}
2 -- -fno-cse is needed for GLOBAL_VAR's to behave properly
4 -----------------------------------------------------------------------------
6 -- Monadery code used in InteractiveUI
8 -- (c) The GHC Team 2005-2006
10 -----------------------------------------------------------------------------
12 module GhciMonad where
14 #include "HsVersions.h"
17 import GhcMonad hiding (liftIO)
18 import Outputable hiding (printForUser, printForUserPartWay)
19 import qualified Outputable
20 import Panic hiding (showException)
29 import qualified MonadUtils
34 import Data.Int ( Int64 )
37 import System.Environment
39 import Control.Monad as Monad
42 import System.Console.Haskeline (CompletionFunc, InputT)
43 import qualified System.Console.Haskeline as Haskeline
44 import Control.Monad.Trans as Trans
46 -----------------------------------------------------------------------------
49 type Command = (String, String -> InputT GHCi Bool, CompletionFunc GHCi)
51 data GHCiState = GHCiState
58 options :: [GHCiOption],
59 prelude :: GHC.Module,
61 breaks :: ![(Int, BreakLocation)],
62 tickarrays :: ModuleEnv TickArray,
63 -- tickarrays caches the TickArray for loaded modules,
64 -- so that we don't rebuild it each time the user sets
66 -- ":" at the GHCi prompt repeats the last command, so we
68 last_command :: Maybe Command,
70 remembered_ctx :: [CtxtCmd],
71 -- we remember the :module commands between :loads, so that
72 -- on a :reload we can replay them. See bugs #2049,
73 -- \#1873, #1360. Previously we tried to remember modules that
74 -- were supposed to be in the context but currently had errors,
75 -- but this was complicated. Just replaying the :module commands
76 -- seems to be the right thing.
77 ghc_e :: Bool -- True if this is 'ghc -e' (or runghc)
80 data CtxtCmd -- In each case, the first [String] are the starred modules
81 -- and the second are the unstarred ones
82 = SetContext [String] [String]
83 | AddModules [String] [String]
84 | RemModules [String] [String]
87 type TickArray = Array Int [(BreakIndex,SrcSpan)]
90 = ShowTiming -- show time/allocs after evaluation
91 | ShowType -- show the type of expressions
92 | RevertCAFs -- revert CAFs after every evaluation
97 { breakModule :: !GHC.Module
98 , breakLoc :: !SrcSpan
99 , breakTick :: {-# UNPACK #-} !Int
100 , onBreakCmd :: String
103 instance Eq BreakLocation where
104 loc1 == loc2 = breakModule loc1 == breakModule loc2 &&
105 breakTick loc1 == breakTick loc2
107 prettyLocations :: [(Int, BreakLocation)] -> SDoc
108 prettyLocations [] = text "No active breakpoints."
109 prettyLocations locs = vcat $ map (\(i, loc) -> brackets (int i) <+> ppr loc) $ reverse $ locs
111 instance Outputable BreakLocation where
112 ppr loc = (ppr $ breakModule loc) <+> ppr (breakLoc loc) <+>
113 if null (onBreakCmd loc)
115 else doubleQuotes (text (onBreakCmd loc))
117 recordBreak :: BreakLocation -> GHCi (Bool{- was already present -}, Int)
118 recordBreak brkLoc = do
120 let oldActiveBreaks = breaks st
121 -- don't store the same break point twice
122 case [ nm | (nm, loc) <- oldActiveBreaks, loc == brkLoc ] of
123 (nm:_) -> return (True, nm)
125 let oldCounter = break_ctr st
126 newCounter = oldCounter + 1
127 setGHCiState $ st { break_ctr = newCounter,
128 breaks = (oldCounter, brkLoc) : oldActiveBreaks
130 return (False, oldCounter)
132 newtype GHCi a = GHCi { unGHCi :: IORef GHCiState -> Ghc a }
134 reflectGHCi :: (Session, IORef GHCiState) -> GHCi a -> IO a
135 reflectGHCi (s, gs) m = unGhc (unGHCi m gs) s
137 reifyGHCi :: ((Session, IORef GHCiState) -> IO a) -> GHCi a
138 reifyGHCi f = GHCi f'
140 -- f' :: IORef GHCiState -> Ghc a
141 f' gs = reifyGhc (f'' gs)
142 -- f'' :: IORef GHCiState -> Session -> IO a
145 startGHCi :: GHCi a -> GHCiState -> Ghc a
146 startGHCi g state = do ref <- liftIO $ newIORef state; unGHCi g ref
148 instance Monad GHCi where
149 (GHCi m) >>= k = GHCi $ \s -> m s >>= \a -> unGHCi (k a) s
150 return a = GHCi $ \_ -> return a
152 instance Functor GHCi where
153 fmap f m = m >>= return . f
155 ghciHandleGhcException :: (GhcException -> GHCi a) -> GHCi a -> GHCi a
156 ghciHandleGhcException = handleGhcException
158 getGHCiState :: GHCi GHCiState
159 getGHCiState = GHCi $ \r -> liftIO $ readIORef r
160 setGHCiState :: GHCiState -> GHCi ()
161 setGHCiState s = GHCi $ \r -> liftIO $ writeIORef r s
163 liftGhc :: Ghc a -> GHCi a
164 liftGhc m = GHCi $ \_ -> m
166 instance MonadUtils.MonadIO GHCi where
167 liftIO = liftGhc . MonadUtils.liftIO
169 instance Trans.MonadIO Ghc where
170 liftIO = MonadUtils.liftIO
172 instance GhcMonad GHCi where
173 setSession s' = liftGhc $ setSession s'
174 getSession = liftGhc $ getSession
176 instance GhcMonad (InputT GHCi) where
177 setSession = lift . setSession
178 getSession = lift getSession
180 instance MonadUtils.MonadIO (InputT GHCi) where
181 liftIO = Trans.liftIO
183 instance ExceptionMonad GHCi where
184 gcatch m h = GHCi $ \r -> unGHCi m r `gcatch` (\e -> unGHCi (h e) r)
185 gblock (GHCi m) = GHCi $ \r -> gblock (m r)
186 gunblock (GHCi m) = GHCi $ \r -> gunblock (m r)
188 GHCi $ \s -> gmask $ \io_restore ->
190 g_restore (GHCi m) = GHCi $ \s' -> io_restore (m s')
192 unGHCi (f g_restore) s
194 instance MonadIO GHCi where
195 liftIO = MonadUtils.liftIO
197 instance Haskeline.MonadException GHCi where
201 -- XXX when Haskeline's MonadException changes, we can drop our
202 -- deprecated block/unblock methods
204 instance ExceptionMonad (InputT GHCi) where
205 gcatch = Haskeline.catch
206 gmask f = Haskeline.block (f Haskeline.unblock) -- slightly wrong
207 gblock = Haskeline.block
208 gunblock = Haskeline.unblock
210 -- for convenience...
211 getPrelude :: GHCi Module
212 getPrelude = getGHCiState >>= return . prelude
214 getDynFlags :: GhcMonad m => m DynFlags
216 GHC.getSessionDynFlags
218 setDynFlags :: DynFlags -> GHCi [PackageId]
219 setDynFlags dflags = do
220 GHC.setSessionDynFlags dflags
222 isOptionSet :: GHCiOption -> GHCi Bool
224 = do st <- getGHCiState
225 return (opt `elem` options st)
227 setOption :: GHCiOption -> GHCi ()
229 = do st <- getGHCiState
230 setGHCiState (st{ options = opt : filter (/= opt) (options st) })
232 unsetOption :: GHCiOption -> GHCi ()
234 = do st <- getGHCiState
235 setGHCiState (st{ options = filter (/= opt) (options st) })
237 printForUser :: GhcMonad m => SDoc -> m ()
238 printForUser doc = do
239 unqual <- GHC.getPrintUnqual
240 MonadUtils.liftIO $ Outputable.printForUser stdout unqual doc
242 printForUserPartWay :: SDoc -> GHCi ()
243 printForUserPartWay doc = do
244 unqual <- GHC.getPrintUnqual
245 liftIO $ Outputable.printForUserPartWay stdout opt_PprUserLength unqual doc
247 runStmt :: String -> GHC.SingleStep -> GHCi GHC.RunResult
248 runStmt expr step = do
251 withProgName (progname st) $
254 GHC.handleSourceError (\e -> do GHC.printException e
255 return GHC.RunFailed) $ do
256 GHC.runStmt expr step
258 resume :: (SrcSpan -> Bool) -> GHC.SingleStep -> GHCi GHC.RunResult
259 resume canLogSpan step = do
262 withProgName (progname st) $
265 GHC.resume canLogSpan step
267 -- --------------------------------------------------------------------------
268 -- timing & statistics
270 timeIt :: InputT GHCi a -> InputT GHCi a
272 = do b <- lift $ isOptionSet ShowTiming
275 else do allocs1 <- liftIO $ getAllocations
276 time1 <- liftIO $ getCPUTime
278 allocs2 <- liftIO $ getAllocations
279 time2 <- liftIO $ getCPUTime
280 liftIO $ printTimes (fromIntegral (allocs2 - allocs1))
284 foreign import ccall unsafe "getAllocations" getAllocations :: IO Int64
285 -- defined in ghc/rts/Stats.c
287 printTimes :: Integer -> Integer -> IO ()
288 printTimes allocs psecs
289 = do let secs = (fromIntegral psecs / (10^(12::Integer))) :: Float
290 secs_str = showFFloat (Just 2) secs
292 parens (text (secs_str "") <+> text "secs" <> comma <+>
293 text (show allocs) <+> text "bytes")))
295 -----------------------------------------------------------------------------
298 revertCAFs :: GHCi ()
300 liftIO rts_revertCAFs
302 when (not (ghc_e s)) $ liftIO turnOffBuffering
303 -- Have to turn off buffering again, because we just
304 -- reverted stdout, stderr & stdin to their defaults.
306 foreign import ccall "revertCAFs" rts_revertCAFs :: IO ()
307 -- Make it "safe", just in case
309 -----------------------------------------------------------------------------
310 -- To flush buffers for the *interpreted* computation we need
311 -- to refer to *its* stdout/stderr handles
313 GLOBAL_VAR(stdin_ptr, error "no stdin_ptr", Ptr ())
314 GLOBAL_VAR(stdout_ptr, error "no stdout_ptr", Ptr ())
315 GLOBAL_VAR(stderr_ptr, error "no stderr_ptr", Ptr ())
317 -- After various attempts, I believe this is the least bad way to do
318 -- what we want. We know look up the address of the static stdin,
319 -- stdout, and stderr closures in the loaded base package, and each
320 -- time we need to refer to them we cast the pointer to a Handle.
321 -- This avoids any problems with the CAF having been reverted, because
322 -- we'll always get the current value.
324 -- The previous attempt that didn't work was to compile an expression
325 -- like "hSetBuffering stdout NoBuffering" into an expression of type
326 -- IO () and run this expression each time we needed it, but the
327 -- problem is that evaluating the expression might cache the contents
328 -- of the Handle rather than referring to it from its static address
329 -- each time. There's no safe workaround for this.
331 initInterpBuffering :: Ghc ()
332 initInterpBuffering = do -- make sure these are linked
333 dflags <- GHC.getSessionDynFlags
337 -- ToDo: we should really look up these names properly, but
338 -- it's a fiddle and not all the bits are exposed via the GHC
340 mb_stdin_ptr <- ObjLink.lookupSymbol "base_GHCziIOziHandleziFD_stdin_closure"
341 mb_stdout_ptr <- ObjLink.lookupSymbol "base_GHCziIOziHandleziFD_stdout_closure"
342 mb_stderr_ptr <- ObjLink.lookupSymbol "base_GHCziIOziHandleziFD_stderr_closure"
344 let f ref (Just ptr) = writeIORef ref ptr
345 f _ Nothing = panic "interactiveUI:setBuffering2"
346 zipWithM_ f [stdin_ptr,stdout_ptr,stderr_ptr]
347 [mb_stdin_ptr,mb_stdout_ptr,mb_stderr_ptr]
349 flushInterpBuffers :: GHCi ()
351 = liftIO $ do getHandle stdout_ptr >>= hFlush
352 getHandle stderr_ptr >>= hFlush
354 turnOffBuffering :: IO ()
356 = do hdls <- mapM getHandle [stdin_ptr,stdout_ptr,stderr_ptr]
357 mapM_ (\h -> hSetBuffering h NoBuffering) hdls
359 getHandle :: IORef (Ptr ()) -> IO Handle
361 (Ptr addr) <- readIORef ref
362 case addrToHValue# addr of (# hval #) -> return (unsafeCoerce# hval)