[project @ 2001-02-13 13:09:36 by sewardj]
[ghc-hetmet.git] / ghc / compiler / ghci / InteractiveUI.hs
index b2ec5c1..1944d97 100644 (file)
@@ -1,5 +1,5 @@
 -----------------------------------------------------------------------------
--- $Id: InteractiveUI.hs,v 1.30 2001/01/19 15:26:37 simonmar Exp $
+-- $Id: InteractiveUI.hs,v 1.45 2001/02/13 13:09:36 sewardj Exp $
 --
 -- GHC Interactive User Interface
 --
@@ -7,23 +7,29 @@
 --
 -----------------------------------------------------------------------------
 
+{-# OPTIONS -#include "Linker.h" #-}
 module InteractiveUI (interactiveUI) where
 
 #include "HsVersions.h"
 
 import CompManager
 import CmStaticInfo
+import ByteCodeLink
 import DriverFlags
 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 PprType         {- instance Outputable Type; do not delete -}
+import Panic           ( GhcException(..) )
+import Config
 
 import Exception
+import Dynamic
 #ifndef NO_READLINE
 import Readline
 #endif
@@ -36,23 +42,29 @@ import CPUTime
 import Directory
 import IO
 import Char
-import Monad ( when )
+import Monad           ( when )
 
+import PrelGHC                 ( unsafeCoerce# )
+import PrelPack        ( packString )
+import PrelByteArr
+import Foreign         ( Ptr, nullPtr )
 
 -----------------------------------------------------------------------------
 
 ghciWelcomeMsg = "\ 
-\ _____  __   __  ____         _________________________________________________\n\ 
-\(|     ||   || (|  |)        GHC Interactive, version 5.00                    \n\ 
-\||  __  ||___|| ||     ()     For Haskell 98.                                 \n\ 
-\||   |) ||---|| ||     ||     http://www.haskell.org/ghc                      \n\ 
-\||   || ||   || ||     (|     Bug reports to: glasgow-haskell-bugs@haskell.org \n\ 
-\(|___|| ||   || (|__|) \\\\______________________________________________________\n"
-
-commands :: [(String, String -> GHCi Bool)]
-commands = [
+\   ___         ___ _\n\ 
+\  / _ \\ /\\  /\\/ __(_)\n\ 
+\ / /_\\// /_/ / /  | |      GHC Interactive, version " ++ cProjectVersion ++ ", For Haskell 98.\n\ 
+\/ /_\\\\/ __  / /___| |      http://www.haskell.org/ghc/\n\ 
+\\\____/\\/ /_/\\____/|_|      Type :? for help.\n"
+
+GLOBAL_VAR(commands, builtin_commands, [(String, String -> GHCi Bool)])
+
+builtin_commands :: [(String, String -> GHCi Bool)]
+builtin_commands = [
   ("add",      keepGoing addModule),
   ("cd",       keepGoing changeDirectory),
+  ("def",      keepGoing defineMacro),
   ("help",     keepGoing help),
   ("?",                keepGoing help),
   ("load",     keepGoing loadModule),
@@ -61,6 +73,7 @@ commands = [
   ("set",      keepGoing setOptions),
   ("type",     keepGoing typeOfExpr),
   ("unset",    keepGoing unsetOptions),
+  ("undef",     keepGoing undefineMacro),
   ("quit",     quit)
   ]
 
@@ -89,6 +102,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\ 
 \"
@@ -101,9 +115,10 @@ interactiveUI cmstate mod = do
 
    -- link in the available packages
    pkgs <- getPackageInfo
+   initLinker
    linkPackages (reverse pkgs)
 
-   (cmstate', ok, mods) <-
+   (cmstate, ok, mods) <-
        case mod of
             Nothing  -> return (cmstate, True, [])
             Just m -> cmLoadModule cmstate m
@@ -115,103 +130,175 @@ interactiveUI cmstate mod = do
    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 
                      []   -> prel
                      m:ms -> m
 
-   (unGHCi uiLoop) GHCiState{ modules = mods,
+   (unGHCi runGHCi) GHCiState{ modules = mods,
                              current_module = this_mod,
                              target = mod,
-                             cmstate = cmstate',
+                             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 (moduleUserString (current_module st) ++ "> "))
+  readlineLoop
 #else
-  l_ok <- io (hGetLine stdin)
-  let l = Just l_ok
+  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
+
+stringLoop :: [String] -> GHCi ()
+stringLoop [] = return ()
+stringLoop (s:ss) = do
+   st <- getGHCiState
+   case remove_spaces s of
+       "" -> stringLoop ss
+       l  -> do quit <- runCommand l
+                 if quit then return () else stringLoop ss
+
 #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.
 runCommand :: String -> GHCi Bool
 runCommand c = 
-  ghciHandle ( 
-     \other_exception 
-        -> io (putStrLn (show other_exception)) >> return False
-  ) $
-  ghciHandleDyn
-    (\dyn -> case dyn of
-               PhaseFailed phase code ->
+  ghciHandle ( \exception -> 
+       (case exception of
+          DynException dyn -> 
+             case fromDynamic dyn of
+               Nothing -> io (putStrLn ("*** Exception: (unknown)"))
+               Just ghc_ex -> 
+                 case ghc_ex of
+                   PhaseFailed phase code ->
                        io ( putStrLn ("Phase " ++ phase ++ " failed (code "
                                        ++ show code ++ ")"))
-               Interrupted -> io (putStrLn "Interrupted.")
-               _ -> io (putStrLn (show (dyn :: GhcException)))
-             >> return False
-    ) $
+                   Interrupted -> io (putStrLn "Interrupted.")
+                   other -> io (putStrLn (show (ghc_ex :: GhcException)))
+
+          other -> io (putStrLn ("*** Exception: " ++ show exception))
+
+       ) >> return False
+     ) $
+
    doCommand c
 
 doCommand (':' : command) = specialCommand command
+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 ok <- evalExpr expr_expanded
-                              when ok (evalExpr "PrelHandle.hFlush PrelHandle.stdout" >> return ())
-                              when ok (evalExpr "PrelHandle.hFlush PrelHandle.stderr" >> return ())
-                              return ok)
+        expr_ok <- timeIt (do stuff <- evalExpr expr_expanded
+                             finishEvalExpr stuff)
         when expr_ok (rememberExpr expr_expanded)
         return False
 
--- Returned Bool indicates whether or not the expr was successfully
+-- 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 Maybe indicates whether or not the expr was successfully
 -- parsed, renamed and typechecked.
-evalExpr :: String -> GHCi Bool
+evalExpr :: String -> GHCi (Maybe (PrintUnqualified,Type))
 evalExpr expr
  | null (filter (not.isSpace) expr)
- = return False
+ = return Nothing
  | otherwise
  = do st <- getGHCiState
       dflags <- io (getDynFlags)
       (new_cmstate, maybe_stuff) <- 
-        io (cmGetExpr (cmstate st) dflags (current_module st) expr True)
+        io (cmGetExpr (cmstate st) dflags True (current_module st) expr)
       setGHCiState st{cmstate = new_cmstate}
       case maybe_stuff of
-        Nothing -> return False
-        Just (hv, unqual, ty)
-          -> do io (cmRunExpr hv)
-                b <- isOptionSet ShowType
-                io (when b (printForUser stdout unqual (text "::" <+> ppr ty)))
-                 return True
-       
-{-
-  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
+  cmds <- io (readIORef commands)
+  case [ (s,f) | (s,f) <- cmds, prefixMatch cmd s ] of
      []      -> io (hPutStr stdout ("unknown command `:" ++ cmd ++ "'\n" 
                                    ++ shortHelpText) >> return False)
      [(_,f)] -> f (dropWhile isSpace rest)
@@ -239,7 +326,10 @@ setContext m | not (isUpper (head m)) || not (all isAlphaNum (tail m))
 setContext mn
   = do m <- io (moduleNameToModule (mkModuleName mn))
        st <- getGHCiState
-       setGHCiState st{current_module = m}
+       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
@@ -252,12 +342,59 @@ moduleNameToModule mn
 changeDirectory :: String -> GHCi ()
 changeDirectory d = io (setCurrentDirectory d)
 
+defineMacro :: String -> GHCi ()
+defineMacro s = do
+  let (macro_name, definition) = break isSpace s
+  cmds <- io (readIORef commands)
+  if (null macro_name) 
+       then throwDyn (OtherError "invalid macro name") 
+       else do
+  if (macro_name `elem` map fst cmds) 
+       then throwDyn (OtherError 
+               ("command `" ++ macro_name ++ "' already defined"))
+       else do
+
+  -- give the expression a type signature, so we can be sure we're getting
+  -- something of the right type.
+  let new_expr = '(' : definition ++ ") :: String -> IO String"
+
+  -- compile the expression
+  st <- getGHCiState
+  dflags <- io (getDynFlags)
+  (new_cmstate, maybe_stuff) <- 
+        io (cmGetExpr (cmstate st) dflags False (current_module st) new_expr)
+  setGHCiState st{cmstate = new_cmstate}
+  case maybe_stuff of
+     Nothing -> return ()
+     Just (hv, unqual, ty) 
+       -> io (writeIORef commands 
+                ((macro_name, keepGoing (runMacro hv)) : cmds))
+
+runMacro :: HValue{-String -> IO String-} -> String -> GHCi ()
+runMacro fun s = do
+  str <- io ((unsafeCoerce# fun :: String -> IO String) s)
+  stringLoop (lines str)
+
+undefineMacro :: String -> GHCi ()
+undefineMacro macro_name = do
+  cmds <- io (readIORef commands)
+  if (macro_name `elem` map fst builtin_commands) 
+       then throwDyn (OtherError
+               ("command `" ++ macro_name ++ "' cannot be undefined"))
+       else do
+  if (macro_name `notElem` map fst cmds) 
+       then throwDyn (OtherError 
+               ("command `" ++ macro_name ++ "' not defined"))
+       else do
+  io (writeIORef commands (filter ((/= macro_name) . fst) cmds))
+
 loadModule :: String -> GHCi ()
 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)
@@ -288,7 +425,8 @@ 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,
@@ -298,15 +436,14 @@ reloadModule "" = do
                                          xs -> head xs
                     }
 
-
 reloadModule _ = noArgs ":reload"
 
 typeOfExpr :: String -> GHCi ()
 typeOfExpr str 
   = do st <- getGHCiState
        dflags <- io (getDynFlags)
-       (new_cmstate, maybe_ty) <- io (cmGetExpr (cmstate st) dflags 
-                               (current_module st) str False)
+       (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 ()
@@ -404,12 +541,13 @@ 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)
@@ -462,11 +600,18 @@ data GHCiState = GHCiState
         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)
 
+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) }
 
 instance Monad GHCi where
@@ -501,10 +646,20 @@ setLastExpr last_expr
 
 io m = GHCi $ \s -> m >>= \a -> return (s,a)
 
+-----------------------------------------------------------------------------
+-- recursive exception handlers
+
+-- Don't forget to unblock async exceptions in the handler, or if we're
+-- in an exception loop (eg. let a = error a in a) the ^C exception
+-- may never be delivered.  Thanks to Marcin for pointing out the bug.
+
+ghciHandle :: (Exception -> GHCi a) -> GHCi a -> GHCi a
 ghciHandle h (GHCi m) = GHCi $ \s -> 
-   Exception.catch (m s) (\e -> unGHCi (h e) s)
-ghciHandleDyn h (GHCi m) = GHCi $ \s -> 
-   Exception.catchDyn (m s) (\e -> unGHCi (h e) s)
+   Exception.catch (m s) 
+       (\e -> unGHCi (ghciHandle h (ghciUnblock (h e))) s)
+
+ghciUnblock :: GHCi a -> GHCi a
+ghciUnblock (GHCi a) = GHCi $ \s -> Exception.unblock (a s)
 
 -----------------------------------------------------------------------------
 -- package loader
@@ -514,25 +669,50 @@ linkPackages pkgs = mapM_ linkPackage pkgs
 
 linkPackage :: Package -> IO ()
 -- ignore rts and gmp for now (ToDo; better?)
-linkPackage pkg | name pkg `elem` ["rts", "gmp"] = return ()
-linkPackage pkg = do
-  putStr ("Loading package " ++ name pkg ++ " ... ")
-  let dirs = library_dirs pkg
-  let objs = map (++".o") (hs_libraries pkg ++ extra_libraries pkg)
-  mapM (linkOneObj dirs) objs
-  putStr "resolving ... "
-  resolveObjs
-  putStrLn "done."
-
-linkOneObj dirs obj = do
-  filename <- findFile dirs obj
-  loadObj filename
-
-findFile [] obj = throwDyn (OtherError ("can't find " ++ obj))
-findFile (d:ds) obj = do
-  let path = d ++ '/':obj
-  b <- doesFileExist path
-  if b then return path else findFile ds obj
+linkPackage pkg 
+   | name pkg `elem` ["rts", "gmp"] 
+   = return ()
+   | otherwise
+   = do putStr ("Loading package " ++ name pkg ++ " ... ")
+        -- For each obj, try obj.o and if that fails, obj.so.
+        -- Complication: all the .so's must be loaded before any of the .o's.  
+        let dirs      =  library_dirs pkg
+        let objs      =  hs_libraries pkg ++ extra_libraries pkg
+        classifieds   <- mapM (locateOneObj dirs) objs
+        let sos_first = filter isRight classifieds 
+                        ++ filter (not.isRight) classifieds
+        mapM loadClassified sos_first
+        putStr "linking ... "
+        resolveObjs
+        putStrLn "done."
+     where
+        isRight (Right _) = True
+        isRight (Left _)  = False
+
+
+loadClassified :: Either FilePath String -> IO ()
+loadClassified (Left obj_absolute_filename)
+   = do --putStr ("Left  " ++ obj_absolute_filename ++ "\n")
+        loadObj obj_absolute_filename
+loadClassified (Right dll_unadorned)
+   = do --putStr ("Right " ++ dll_unadorned ++ "\n")
+        dll_ok <- ocAddDLL (packString dll_unadorned)
+        if    dll_ok /= 1
+         then throwDyn (OtherError ("can't find .o or .so/.DLL for: " 
+                                    ++ dll_unadorned))
+         else return ()
+
+locateOneObj :: [FilePath] -> String -> IO (Either FilePath String)
+locateOneObj []     obj 
+   = return (Right obj) -- we assume
+locateOneObj (d:ds) obj 
+   = do let path = d ++ '/':obj ++ ".o"
+        b <- doesFileExist path
+        if b then return (Left path) else locateOneObj ds obj
+
+
+type PackedString = ByteArray Int
+foreign import "ocAddDLL" unsafe ocAddDLL :: PackedString -> IO Int
 
 -----------------------------------------------------------------------------
 -- timing & statistics
@@ -559,3 +739,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