[project @ 2001-02-07 10:45:43 by simonmar]
[ghc-hetmet.git] / ghc / compiler / ghci / InteractiveUI.hs
index 534a715..f4e0800 100644 (file)
@@ -1,5 +1,5 @@
 -----------------------------------------------------------------------------
--- $Id: InteractiveUI.hs,v 1.20 2000/11/28 14:41:54 sewardj Exp $
+-- $Id: InteractiveUI.hs,v 1.34 2001/02/07 10:45:43 simonmar Exp $
 --
 -- GHC Interactive User Interface
 --
@@ -13,16 +13,23 @@ module InteractiveUI (interactiveUI) where
 
 import CompManager
 import CmStaticInfo
+import ByteCodeLink
 import DriverFlags
-import DriverUtil
 import DriverState
+import DriverUtil
+import Type
 import Linker
+import Finder
 import Module
 import Outputable
 import Util
+import PprType         {- instance Outputable Type; do not delete -}
+import Panic           ( GhcException(..) )
 
 import Exception
+#ifndef NO_READLINE
 import Readline
+#endif
 import IOExts
 
 import Numeric
@@ -32,6 +39,8 @@ import CPUTime
 import Directory
 import IO
 import Char
+import Monad ( when )
+
 
 -----------------------------------------------------------------------------
 
@@ -83,6 +92,7 @@ helpText = "\
 \\ 
 \    +s                 print timing/memory stats after each evaluation\n\ 
 \    +t                        print type after evaluation\n\ 
+\    +r                        revert top-level expressions after each evaluation\n\ 
 \    -<flags>          most GHC command line flags can also be set here\n\ 
 \                         (eg. -v2, -fglasgow-exts, etc.)\n\ 
 \"
@@ -97,7 +107,7 @@ interactiveUI cmstate mod = do
    pkgs <- getPackageInfo
    linkPackages (reverse pkgs)
 
-   (cmstate', ok, mods) <-
+   (cmstate, ok, mods) <-
        case mod of
             Nothing  -> return (cmstate, True, [])
             Just m -> cmLoadModule cmstate m
@@ -105,36 +115,95 @@ interactiveUI cmstate mod = do
 #ifndef NO_READLINE
    Readline.initialize
 #endif
+
+   prel <- moduleNameToModule defaultCurrentModuleName
+   writeIORef defaultCurrentModule prel
+
+   dflags <- getDynFlags
+
+   (cmstate, maybe_stuff) <- cmGetExpr cmstate dflags False prel 
+                               "PrelHandle.hFlush PrelHandle.stdout"
+   case maybe_stuff of
+       Nothing -> return ()
+       Just (hv,_,_) -> writeIORef flush_stdout hv
+   
+   (cmstate, maybe_stuff) <- cmGetExpr cmstate dflags False prel 
+                               "PrelHandle.hFlush PrelHandle.stdout"
+   case maybe_stuff of
+       Nothing -> return ()
+       Just (hv,_,_) -> writeIORef flush_stderr hv
+   
    let this_mod = case mods of 
-                       [] -> defaultCurrentModule
-                       m:ms -> m
+                     []   -> prel
+                     m:ms -> m
 
-   (unGHCi uiLoop) GHCiState{ modules = mods,
+   (unGHCi runGHCi) GHCiState{ modules = mods,
                              current_module = this_mod,
                              target = mod,
-                             cmstate = cmstate',
-                             options = [ShowTiming]}
+                             cmstate = cmstate,
+                             options = [ShowTiming],
+                              last_expr = Nothing}
    return ()
 
-uiLoop :: GHCi ()
-uiLoop = do
-  st <- getGHCiState
+
+runGHCi :: GHCi ()
+runGHCi = do
+  -- read in ./.ghci
+  dot_ghci <- io (IO.try (openFile "./.ghci" ReadMode))
+  case dot_ghci of
+       Left e -> return ()
+       Right hdl -> fileLoop hdl False
+  
+  -- read in ~/.ghci
+  home <- io (IO.try (getEnv "HOME"))
+  case home of
+   Left e  -> return ()
+   Right dir -> do
+       dot_ghci <- io (IO.try (openFile (dir ++ "/.ghci") ReadMode))
+       case dot_ghci of
+          Left e -> return ()
+          Right hdl -> fileLoop hdl False
+
+  -- read commands from stdin
 #ifndef NO_READLINE
-  l <- io (readline (moduleNameUserString (current_module st) ++ "> "))
+  readlineLoop
 #else
-  l <- io (hGetLine stdin)
+  fileLoop stdin True
 #endif
-  case l of
-    Nothing -> exitGHCi
-    Just "" -> uiLoop
-    Just l  -> do
+
+  -- and finally, exit
+  io $ do putStrLn "Leaving GHCi." 
+
+
+fileLoop :: Handle -> Bool -> GHCi ()
+fileLoop hdl prompt = do
+   st <- getGHCiState
+   when prompt (io (hPutStr hdl (moduleUserString (current_module st) ++ "> ")))
+   l <- io (IO.try (hGetLine hdl))
+   case l of
+       Left e | isEOFError e -> return ()
+              | otherwise    -> throw e
+       Right l -> 
+         case remove_spaces l of
+           "" -> fileLoop hdl prompt
+           l  -> do quit <- runCommand l
+                    if quit then return () else fileLoop hdl prompt
+
 #ifndef NO_READLINE
-          io (addHistory l)
+readlineLoop :: GHCi ()
+readlineLoop = do
+   st <- getGHCiState
+   l <- io (readline (moduleUserString (current_module st) ++ "> "))
+   case l of
+       Nothing -> return ()
+       Just l  ->
+         case remove_spaces l of
+           "" -> readlineLoop
+           l  -> do
+                 io (addHistory l)
+                 quit <- runCommand l
+                 if quit then return () else readlineLoop
 #endif
-         quit <- runCommand l
-          if quit then exitGHCi else uiLoop
-
-exitGHCi = io $ do putStrLn "Leaving GHCi." 
 
 -- Top level exception handler, just prints out the exception 
 -- and carries on.
@@ -150,38 +219,57 @@ runCommand c =
                        io ( putStrLn ("Phase " ++ phase ++ " failed (code "
                                        ++ show code ++ ")"))
                Interrupted -> io (putStrLn "Interrupted.")
-               _ -> io (putStrLn (show (dyn :: BarfKind)))
+               _ -> io (putStrLn (show (dyn :: GhcException)))
              >> return False
     ) $
    doCommand c
 
 doCommand (':' : command) = specialCommand command
-doCommand expr            = timeIt (evalExpr expr) >> return False
-
+doCommand ('-':'-':_) = return False   -- comments, useful in scripts
+doCommand expr
+   = do expr_expanded <- expandExpr expr
+        -- io (putStrLn ( "Before: " ++ expr ++ "\nAfter:  " ++ expr_expanded))
+        expr_ok <- timeIt (do stuff <- evalExpr expr_expanded
+                             finishEvalExpr stuff)
+        when expr_ok (rememberExpr expr_expanded)
+        return False
+
+-- possibly print the type and revert CAFs after evaluating an expression
+finishEvalExpr Nothing = return False
+finishEvalExpr (Just (unqual,ty))
+ = do b <- isOptionSet ShowType
+      io (when b (printForUser stdout unqual (text "::" <+> ppr ty)))
+      b <- isOptionSet RevertCAFs
+      io (when b revertCAFs)
+      return True
+
+-- Returned Bool indicates whether or not the expr was successfully
+-- parsed, renamed and typechecked.
+evalExpr :: String -> GHCi (Maybe (PrintUnqualified,Type))
 evalExpr expr
+ | null (filter (not.isSpace) expr)
+ = return Nothing
+ | otherwise
  = do st <- getGHCiState
       dflags <- io (getDynFlags)
       (new_cmstate, maybe_stuff) <- 
-        io (cmGetExpr (cmstate st) dflags (current_module st) expr)
+        io (cmGetExpr (cmstate st) dflags True (current_module st) expr)
       setGHCiState st{cmstate = new_cmstate}
       case maybe_stuff of
-        Nothing -> return ()
-        Just (hv, unqual, ty)
-          -> do io (cmRunExpr hv)
-                b <- isOptionSet ShowType
-                if b then io (printForUser stdout unqual (text "::" <+> ppr ty))
-                     else return ()
-       
-{-
-  let (mod,'.':str) = break (=='.') expr
-  case cmLookupSymbol (mkOrig varName (mkModuleName mod) (_PK_ str)) (cmstate st) of
-       Nothing -> io (putStrLn "nothing.")
-       Just e  -> io (
-  return ()
--}
+        Nothing -> return Nothing
+        Just (hv, unqual, ty) -> do io (cmRunExpr hv)
+                                    flushEverything
+                                    return (Just (unqual,ty))
+
+flushEverything :: GHCi ()
+flushEverything
+   = io $ do flush_so <- readIORef flush_stdout
+            cmRunExpr flush_so
+            flush_se <- readIORef flush_stdout
+            cmRunExpr flush_se
 
 specialCommand :: String -> GHCi Bool
-specialCommand ('!':str) = shellEscape (dropWhile isSpace str) 
+specialCommand ('!':str) = shellEscape (dropWhile isSpace str)
 specialCommand str = do
   let (cmd,rest) = break isSpace str
   case [ (s,f) | (s,f) <- commands, prefixMatch cmd s ] of
@@ -209,9 +297,21 @@ setContext ""
   = throwDyn (OtherError "syntax: `:m <module>'")
 setContext m | not (isUpper (head m)) || not (all isAlphaNum (tail m))
   = throwDyn (OtherError ("strange looking module name: `" ++ m ++ "'"))
-setContext m
-  = do st <- getGHCiState
-       setGHCiState st{current_module = mkModuleName m}
+setContext mn
+  = do m <- io (moduleNameToModule (mkModuleName mn))
+       st <- getGHCiState
+       if (isHomeModule m && m `notElem` modules st)
+         then throwDyn (OtherError (showSDoc (quotes (ppr (moduleName m))
+                               <+> text "is not currently loaded, use :load")))
+         else setGHCiState st{current_module = m}
+
+moduleNameToModule :: ModuleName -> IO Module
+moduleNameToModule mn
+ = do maybe_stuff <- findModule mn
+      case maybe_stuff of
+        Nothing -> throwDyn (OtherError ("can't find module `"
+                                           ++ moduleNameUserString mn ++ "'"))
+        Just (m,_) -> return m
 
 changeDirectory :: String -> GHCi ()
 changeDirectory d = io (setCurrentDirectory d)
@@ -222,13 +322,16 @@ loadModule path = timeIt (loadModule' path)
 loadModule' path = do
   state <- getGHCiState
   cmstate1 <- io (cmUnload (cmstate state))
+  io (revertCAFs)                      -- always revert CAFs on load.
   (cmstate2, ok, mods) <- io (cmLoadModule cmstate1 path)
 
+  def_mod <- io (readIORef defaultCurrentModule)
+
   let new_state = state{
                        cmstate = cmstate2,
                        modules = mods,
                        current_module = case mods of 
-                                          [] -> defaultCurrentModule
+                                          [] -> def_mod
                                           xs -> head xs,
                        target = Just path
                   }
@@ -237,7 +340,7 @@ loadModule' path = do
   let mod_commas 
        | null mods = text "none."
        | otherwise = hsep (
-           punctuate comma (map (text.moduleNameUserString) mods)) <> text "."
+           punctuate comma (map (text.moduleUserString) mods)) <> text "."
   case ok of
     False -> 
        io (putStrLn (showSDoc (text "Failed, modules loaded: " <> mod_commas)))
@@ -250,24 +353,26 @@ reloadModule "" = do
   case target state of
    Nothing -> io (putStr "no current target\n")
    Just path
-      -> do (new_cmstate, ok, mods) <- io (cmLoadModule (cmstate state) path)
+      -> do io (revertCAFs)            -- always revert CAFs on reload.
+           (new_cmstate, ok, mods) <- io (cmLoadModule (cmstate state) path)
+           def_mod <- io (readIORef defaultCurrentModule)
             setGHCiState 
                state{cmstate=new_cmstate,
                      modules = mods,
                      current_module = case mods of 
-                                         [] -> defaultCurrentModule
+                                         [] -> def_mod
                                          xs -> head xs
                     }
 
-
 reloadModule _ = noArgs ":reload"
 
 typeOfExpr :: String -> GHCi ()
 typeOfExpr str 
   = do st <- getGHCiState
        dflags <- io (getDynFlags)
-       (st, maybe_ty) <- io (cmGetExpr (cmstate st) dflags 
-                               (current_module st) str)
+       (new_cmstate, maybe_ty) <- io (cmGetExpr (cmstate st) dflags False
+                                        (current_module st) str)
+       setGHCiState st{cmstate = new_cmstate}
        case maybe_ty of
         Nothing -> return ()
         Just (_, unqual, ty) -> io (printForUser stdout unqual (ppr ty)) 
@@ -311,12 +416,16 @@ setOptions str
        mapM setOpt plus_opts
 
        -- now, the GHC flags
-       io (do leftovers <- processArgs static_flags minus_opts []
+       io (do -- first, static flags
+             leftovers <- processArgs static_flags minus_opts []
+
+             -- then, dynamic flags
              dyn_flags <- readIORef v_InitDynFlags
              writeIORef v_DynFlags dyn_flags
              leftovers <- processArgs dynamic_flags leftovers []
              dyn_flags <- readIORef v_DynFlags
              writeIORef v_InitDynFlags dyn_flags
+
               if (not (null leftovers))
                 then throwDyn (OtherError ("unrecognised flags: " ++ 
                                                unwords leftovers))
@@ -360,27 +469,76 @@ unsetOpt ('+':str)
 strToGHCiOpt :: String -> (Maybe GHCiOption)
 strToGHCiOpt "s" = Just ShowTiming
 strToGHCiOpt "t" = Just ShowType
+strToGHCiOpt "r" = Just RevertCAFs
 strToGHCiOpt _   = Nothing
 
 optToStr :: GHCiOption -> String
 optToStr ShowTiming = "s"
 optToStr ShowType   = "t"
+optToStr RevertCAFs = "r"
+
+-----------------------------------------------------------------------------
+-- Code to do last-expression-entered stuff.  (a.k.a the $$ facility)
+
+-- Take a string and replace $$s in it with the last expr, if any.
+expandExpr :: String -> GHCi String
+expandExpr str
+   = do mle <- getLastExpr
+        return (outside mle str)
+     where
+        outside mle ('$':'$':cs)
+           = case mle of
+                Just le -> " (" ++ le ++ ") " ++ outside mle cs
+                Nothing -> outside mle cs
+
+        outside mle []           = []
+        outside mle ('"':str)    = '"' : inside2 mle str   -- "
+        outside mle ('\'':str)   = '\'' : inside1 mle str   -- '
+        outside mle (c:cs)       = c : outside mle cs
+
+        inside2 mle ('"':cs)  = '"' : outside mle cs   -- "
+        inside2 mle (c:cs)    = c : inside2 mle cs
+        inside2 mle []        = []
+
+        inside1 mle ('\'':cs) = '\'': outside mle cs
+        inside1 mle (c:cs)    = c : inside1 mle cs
+        inside1 mle []        = []
+
+
+rememberExpr :: String -> GHCi ()
+rememberExpr str
+   = do let cleaned = (clean . reverse . clean . reverse) str
+        let forget_me_not | null cleaned = Nothing
+                          | otherwise    = Just cleaned
+        setLastExpr forget_me_not
+     where
+        clean = dropWhile isSpace
+
 
 -----------------------------------------------------------------------------
 -- GHCi monad
 
 data GHCiState = GHCiState
      { 
-       modules        :: [ModuleName],
-       current_module :: ModuleName,
+       modules        :: [Module],
+       current_module :: Module,
        target         :: Maybe FilePath,
        cmstate        :: CmState,
-       options        :: [GHCiOption]
+       options        :: [GHCiOption],
+        last_expr      :: Maybe String
      }
 
-data GHCiOption = ShowTiming | ShowType deriving Eq
+data GHCiOption 
+       = ShowTiming            -- show time/allocs after evaluation
+       | ShowType              -- show the type of expressions
+       | RevertCAFs            -- revert CAFs after every evaluation
+       deriving Eq
+
+defaultCurrentModuleName = mkModuleName "Prelude"
+GLOBAL_VAR(defaultCurrentModule, error "no defaultCurrentModule", Module)
 
-defaultCurrentModule = mkModuleName "Prelude"
+GLOBAL_VAR(flush_stdout, error "no flush_stdout", HValue)
+GLOBAL_VAR(flush_stderr, error "no flush_stdout", HValue)
 
 newtype GHCi a = GHCi { unGHCi :: GHCiState -> IO (GHCiState, a) }
 
@@ -406,6 +564,14 @@ unsetOption opt
  = do st <- getGHCiState
       setGHCiState (st{ options = filter (/= opt) (options st) })
 
+getLastExpr :: GHCi (Maybe String)
+getLastExpr
+ = do st <- getGHCiState ; return (last_expr st)
+
+setLastExpr :: Maybe String -> GHCi ()
+setLastExpr last_expr
+ = do st <- getGHCiState ; setGHCiState (st{last_expr = last_expr})
+
 io m = GHCi $ \s -> m >>= \a -> return (s,a)
 
 ghciHandle h (GHCi m) = GHCi $ \s -> 
@@ -466,3 +632,8 @@ printTimes allocs psecs
        putStrLn (showSDoc (
                 parens (text (secs_str "") <+> text "secs" <> comma <+> 
                         int allocs <+> text "bytes")))
+
+-----------------------------------------------------------------------------
+-- reverting CAFs
+       
+foreign import revertCAFs :: IO ()     -- make it "safe", just in case