[project @ 2001-12-05 19:24:53 by sof]
[ghc-hetmet.git] / ghc / compiler / ghci / InteractiveUI.hs
index e5a950a..06dc5e9 100644 (file)
@@ -1,14 +1,12 @@
+{-# OPTIONS -#include "Linker.h" -#include "SchedAPI.h" #-}
 -----------------------------------------------------------------------------
--- $Id: InteractiveUI.hs,v 1.84 2001/08/09 10:55:53 sewardj Exp $
+-- $Id: InteractiveUI.hs,v 1.103 2001/12/05 19:24:53 sof Exp $
 --
 -- GHC Interactive User Interface
 --
 -- (c) The GHC Team 2000
 --
 -----------------------------------------------------------------------------
-
-{-# OPTIONS -#include "Linker.h" #-}
-{-# OPTIONS -#include "SchedAPI.h" #-}
 module InteractiveUI ( interactiveUI, ghciWelcomeMsg ) where
 
 #include "../includes/config.h"
@@ -16,8 +14,8 @@ module InteractiveUI ( interactiveUI, ghciWelcomeMsg ) where
 
 import Packages
 import CompManager
-import HscTypes                ( GhciMode(..) )
-import MkIface          ( ifaceTyCls )
+import HscTypes                ( TyThing(..) )
+import MkIface
 import ByteCodeLink
 import DriverFlags
 import DriverState
@@ -25,10 +23,19 @@ import DriverUtil
 import Linker
 import Finder          ( flushPackageCache )
 import Util
-import Name            ( Name )
+import Id              ( isRecordSelector, recordSelectorFieldLabel, 
+                         isDataConWrapId, idName )
+import Class           ( className )
+import TyCon           ( tyConName, tyConClass_maybe, isPrimTyCon )
+import FieldLabel      ( fieldLabelTyCon )
+import SrcLoc          ( isGoodSrcLoc )
+import Name            ( Name, isHomePackageName, nameSrcLoc, nameOccName,
+                         NamedThing(..) )
+import OccName         ( isSymOcc )
+import BasicTypes      ( defaultFixity )
 import Outputable
 import CmdLineOpts     ( DynFlag(..), getDynFlags, saveDynFlags, restoreDynFlags, dopt_unset )
-import Panic           ( GhcException(..) )
+import Panic           ( GhcException(..), showGhcException )
 import Config
 
 #ifndef mingw32_TARGET_OS
@@ -40,7 +47,9 @@ import Dynamic
 #if HAVE_READLINE_HEADERS && HAVE_READLINE_LIBS
 import Readline 
 #endif
+import Concurrent
 import IOExts
+import SystemExts
 
 import Numeric
 import List
@@ -49,7 +58,7 @@ import CPUTime
 import Directory
 import IO
 import Char
-import Monad           ( when )
+import Monad           ( when, join )
 
 import PrelGHC                 ( unsafeCoerce# )
 import Foreign         ( nullPtr )
@@ -77,7 +86,7 @@ builtin_commands = [
   ("load",     keepGoing loadModule),
   ("module",   keepGoing setContext),
   ("reload",   keepGoing reloadModule),
-  ("set",      keepGoing setOptions),
+  ("set",      keepGoing setCmd),
   ("type",     keepGoing typeOfExpr),
   ("unset",    keepGoing unsetOptions),
   ("undef",     keepGoing undefineMacro),
@@ -97,12 +106,13 @@ helpText = "\
 \   :cd <dir>             change directory to <dir>\n\ 
 \   :def <cmd> <expr>      define a command :<cmd>\n\ 
 \   :help, :?             display this list of commands\n\ 
-\   :info [<name> ...]     display information about the given names, or\n\ 
-\                          about currently loaded files if no names given\n\ 
+\   :info [<name> ...]     display information about the given names\n\ 
 \   :load <filename> ...   load module(s) and their dependents\n\ 
 \   :module <mod>         set the context for expression evaluation to <mod>\n\ 
 \   :reload               reload the current module set\n\ 
 \   :set <option> ...     set options\n\ 
+\   :set args <arg> ...           set the arguments returned by System.getArgs\n\ 
+\   :set prog <progname>   set the value returned by System.getProgName\n\ 
 \   :undef <cmd>          undefine user-defined command :<cmd>\n\ 
 \   :type <expr>          show the type of <expr>\n\ 
 \   :unset <option> ...           unset options\n\ 
@@ -128,18 +138,15 @@ interactiveUI cmstate paths cmdline_libs = do
    initLinker
    linkPackages cmdline_libs pkgs
 
-   (cmstate, ok, mods) <-
-       case paths of
-            [] -> return (cmstate, True, [])
-            _  -> cmLoadModule cmstate paths
-
-#if HAVE_READLINE_HEADERS && HAVE_READLINE_LIBS
-   Readline.initialize
-#endif
-
    dflags <- getDynFlags
 
    (cmstate, maybe_hval) 
+       <- cmCompileExpr cmstate dflags "IO.hSetBuffering IO.stdout IO.NoBuffering Prelude.>> IO.hSetBuffering IO.stderr IO.NoBuffering"
+   case maybe_hval of
+       Just hval -> unsafeCoerce# hval :: IO ()
+       _ -> panic "interactiveUI:buffering"
+
+   (cmstate, maybe_hval)
        <- cmCompileExpr cmstate dflags "IO.hFlush PrelHandle.stderr"
    case maybe_hval of
        Just hval -> writeIORef flush_stderr (unsafeCoerce# hval :: IO ())
@@ -151,9 +158,16 @@ interactiveUI cmstate paths cmdline_libs = do
        Just hval -> writeIORef flush_stdout (unsafeCoerce# hval :: IO ())
        _ -> panic "interactiveUI:stdout"
 
-   startGHCi runGHCi GHCiState{ targets = paths,
-                               cmstate = cmstate,
-                               options = [] }
+#if HAVE_READLINE_HEADERS && HAVE_READLINE_LIBS
+   Readline.initialize
+#endif
+
+   startGHCi (runGHCi paths) 
+       GHCiState{ progname = "<interactive>",
+                  args = [],
+                  targets = paths,
+                  cmstate = cmstate,
+                  options = [] }
 
 #if HAVE_READLINE_HEADERS && HAVE_READLINE_LIBS
    Readline.resetTerminal Nothing
@@ -162,33 +176,55 @@ interactiveUI cmstate paths cmdline_libs = do
    return ()
 
 
-runGHCi :: GHCi ()
-runGHCi = do
-  -- Read in ./.ghci.
-  let file = "./.ghci"
-  exists <- io (doesFileExist file)
-  when exists $ do
-     dir_ok  <- io (checkPerms ".")
-     file_ok <- io (checkPerms file)
-     when (dir_ok && file_ok) $ do
-       either_hdl <- io (IO.try (openFile "./.ghci" ReadMode))
-       case either_hdl of
-          Left e    -> return ()
-          Right hdl -> fileLoop hdl False
-  
-  -- Read in $HOME/.ghci
-  either_dir <- io (IO.try (getEnv "HOME"))
-  case either_dir of
-     Left e -> return ()
-     Right dir -> do
-       cwd <- io (getCurrentDirectory)
-       when (dir /= cwd) $ do
-          let file = dir ++ "/.ghci"
-          ok <- io (checkPerms file)
-                  either_hdl <- io (IO.try (openFile file ReadMode))
-          case either_hdl of
-               Left e    -> return ()
-               Right hdl -> fileLoop hdl False
+runGHCi :: [FilePath] -> GHCi ()
+runGHCi paths = do
+  read_dot_files <- io (readIORef v_Read_DotGHCi)
+
+  when (read_dot_files) $ do
+    -- Read in ./.ghci.
+    let file = "./.ghci"
+    exists <- io (doesFileExist file)
+    when exists $ do
+       dir_ok  <- io (checkPerms ".")
+       file_ok <- io (checkPerms file)
+       when (dir_ok && file_ok) $ do
+         either_hdl <- io (IO.try (openFile "./.ghci" ReadMode))
+         case either_hdl of
+            Left e    -> return ()
+            Right hdl -> fileLoop hdl False
+    
+  when (read_dot_files) $ do
+    -- Read in $HOME/.ghci
+    either_dir <- io (IO.try (getEnv "HOME"))
+    case either_dir of
+       Left e -> return ()
+       Right dir -> do
+         cwd <- io (getCurrentDirectory)
+         when (dir /= cwd) $ do
+            let file = dir ++ "/.ghci"
+            ok <- io (checkPerms file)
+            when ok $ do
+              either_hdl <- io (IO.try (openFile file ReadMode))
+              case either_hdl of
+                 Left e    -> return ()
+                 Right hdl -> fileLoop hdl False
+
+  -- perform a :load for files given on the GHCi command line
+  when (not (null paths)) $
+     ghciHandle showException $
+       loadModule (unwords paths)
+
+  -- enter the interactive loop
+  interactiveLoop
+
+  -- and finally, exit
+  io $ do putStrLn "Leaving GHCi."
+
+
+interactiveLoop = do
+  -- ignore ^C exceptions caught here
+  ghciHandleDyn (\e -> case e of Interrupted -> ghciUnblock interactiveLoop
+                                _other      -> return ()) $ do
 
   -- read commands from stdin
 #if HAVE_READLINE_HEADERS && HAVE_READLINE_LIBS
@@ -197,9 +233,6 @@ runGHCi = do
   fileLoop stdin True
 #endif
 
-  -- and finally, exit
-  io $ do putStrLn "Leaving GHCi." 
-
 
 -- NOTE: We only read .ghci files if they are owned by the current user,
 -- and aren't world writable.  Otherwise, we could be accidentally 
@@ -261,6 +294,7 @@ readlineLoop :: GHCi ()
 readlineLoop = do
    st <- getGHCiState
    mod <- io (cmGetContext (cmstate st))
+   io yield
    l <- io (readline (mod ++ "> "))
    case l of
        Nothing -> return ()
@@ -286,42 +320,39 @@ runCommand c =
 
 showException (DynException dyn) =
   case fromDynamic dyn of
-    Nothing -> 
-       io (putStrLn ("*** Exception: (unknown)"))
-    Just (PhaseFailed phase code) ->
-       io (putStrLn ("Phase " ++ phase ++ " failed (code "
-                      ++ show code ++ ")"))
-    Just Interrupted ->
-       io (putStrLn "Interrupted.")
-    Just (CmdLineError s) -> 
-       io (putStrLn s)  -- omit the location for CmdLineError
-    Just other_ghc_ex ->
-       io (putStrLn (show other_ghc_ex))
+    Nothing               -> io (putStrLn ("*** Exception: (unknown)"))
+    Just Interrupted      -> io (putStrLn "Interrupted.")
+    Just (CmdLineError s) -> io (putStrLn s)    -- omit the location for CmdLineError
+    Just ph@PhaseFailed{} -> io (putStrLn (showGhcException ph "")) -- ditto
+    Just other_ghc_ex     -> io (print other_ghc_ex)
+
 showException other_exception
   = io (putStrLn ("*** Exception: " ++ show other_exception))
 
 doCommand (':' : command) = specialCommand command
 doCommand stmt
-   = do timeIt (do stuff <- runStmt stmt; finishEvalExpr stuff)
+   = do timeIt (do nms <- runStmt stmt; finishEvalExpr nms)
         return False
 
--- Returns True if the expr was successfully parsed, renamed and
--- typechecked.
-runStmt :: String -> GHCi (Maybe [Name])
+runStmt :: String -> GHCi [Name]
 runStmt stmt
- | null (filter (not.isSpace) stmt)
- = return Nothing
+ | null (filter (not.isSpace) stmt) = return []
  | otherwise
  = do st <- getGHCiState
       dflags <- io getDynFlags
       let dflags' = dopt_unset dflags Opt_WarnUnusedBinds
-      (new_cmstate, names) <- io (cmRunStmt (cmstate st) dflags' stmt)
+      (new_cmstate, result) <- 
+       io $ withProgName (progname st) $ withArgs (args st) $
+       cmRunStmt (cmstate st) dflags' stmt
       setGHCiState st{cmstate = new_cmstate}
-      return (Just names)
+      case result of
+       CmRunFailed      -> return []
+       CmRunException e -> showException e >> return []
+       CmRunDeadlocked  -> io (putStrLn "Deadlocked.") >> return []
+       CmRunOk names    -> return names
 
 -- possibly print the type and revert CAFs after evaluating an expression
-finishEvalExpr Nothing = return False
-finishEvalExpr (Just names)
+finishEvalExpr names
  = do b <- isOptionSet ShowType
       st <- getGHCiState
       when b (mapM_ (showTypeOfName (cmstate st)) names)
@@ -340,10 +371,8 @@ showTypeOfName cmstate n
 
 flushEverything :: GHCi ()
 flushEverything
-   = io $ do flush_so <- readIORef flush_stdout
-            flush_so
-            flush_se <- readIORef flush_stdout
-            flush_se
+   = io $ do Monad.join (readIORef flush_stdout)
+            Monad.join (readIORef flush_stderr)
              return ()
 
 specialCommand :: String -> GHCi Bool
@@ -372,14 +401,60 @@ info :: String -> GHCi ()
 info "" = throwDyn (CmdLineError "syntax: `:i <thing-you-want-info-about>'")
 info s = do
   let names = words s
-  st <- getGHCiState
-  let cmst = cmstate st
+  state <- getGHCiState
   dflags <- io getDynFlags
-  things <- io (mapM (cmInfoThing cmst dflags) names)
-  let real_things = [ x | Just x <- things ]
-  let descs = map (`ifaceTyCls` []) real_things
-  let strings = map (showSDoc . ppr) descs
-  io (mapM_ putStr strings)
+  let 
+    infoThings cms [] = return cms
+    infoThings cms (name:names) = do
+      (cms, unqual, stuff) <- io (cmInfoThing cms dflags name)
+      io (putStrLn (showSDocForUser unqual (
+           vcat (intersperse (text "") (map showThing stuff))))
+         )
+      infoThings cms names
+
+    showThing (ty_thing, fixity) 
+       = vcat [ text "-- " <> showTyThing ty_thing, 
+                showFixity fixity (getName ty_thing),
+                ppr (ifaceTyThing ty_thing) ]
+
+    showFixity fix name
+       | fix == defaultFixity = empty
+       | otherwise            = ppr fix <+> 
+                                (if isSymOcc (nameOccName name)
+                                       then ppr name
+                                       else char '`' <> ppr name <> char '`')
+
+    showTyThing (AClass cl)
+       = hcat [ppr cl, text " is a class", showSrcLoc (className cl)]
+    showTyThing (ATyCon ty)
+       | isPrimTyCon ty
+       = hcat [ppr ty, text " is a primitive type constructor"]
+       | otherwise
+       = hcat [ppr ty, text " is a type constructor", showSrcLoc (tyConName ty)]
+    showTyThing (AnId   id)
+       = hcat [ppr id, text " is a ", idDescr id, showSrcLoc (idName id)]
+
+    idDescr id
+       | isRecordSelector id = 
+               case tyConClass_maybe (fieldLabelTyCon (
+                               recordSelectorFieldLabel id)) of
+                       Nothing -> text "record selector"
+                       Just c  -> text "method in class " <> ppr c
+       | isDataConWrapId id  = text "data constructor"
+       | otherwise           = text "variable"
+
+       -- also print out the source location for home things
+    showSrcLoc name
+       | isHomePackageName name && isGoodSrcLoc loc
+       = hsep [ text ", defined at", ppr loc ]
+       | otherwise
+       = empty
+       where loc = nameSrcLoc name
+
+  cms <- infoThings (cmstate state) names
+  setGHCiState state{ cmstate = cms }
+  return ()
+
 
 addModule :: String -> GHCi ()
 addModule str = do
@@ -520,8 +595,8 @@ shellEscape str = io (system str >> return False)
 -- This is pretty fragile: most options won't work as expected.  ToDo:
 -- figure out which ones & disallow them.
 
-setOptions :: String -> GHCi ()
-setOptions ""
+setCmd :: String -> GHCi ()
+setCmd ""
   = do st <- getGHCiState
        let opts = options st
        io $ putStrLn (showSDoc (
@@ -530,9 +605,25 @@ setOptions ""
                   then text "none."
                   else hsep (map (\o -> char '+' <> text (optToStr o)) opts)
           ))
-setOptions str
-  = do -- first, deal with the GHCi opts (+s, +t, etc.)
-      let (plus_opts, minus_opts)  = partition isPlus (words str)
+setCmd str
+  = case words str of
+       ("args":args) -> setArgs args
+       ("prog":prog) -> setProg prog
+       wds -> setOptions wds
+
+setArgs args = do
+  st <- getGHCiState
+  setGHCiState st{ args = args }
+
+setProg [prog] = do
+  st <- getGHCiState
+  setGHCiState st{ progname = prog }
+setProg _ = do
+  io (hPutStrLn stderr "syntax: :set prog <progname>")
+
+setOptions wds =
+   do -- first, deal with the GHCi opts (+s, +t, etc.)
+      let (plus_opts, minus_opts)  = partition isPlus wds
       mapM setOpt plus_opts
 
       -- now, the GHC flags
@@ -612,13 +703,15 @@ newPackages new_pkgs = do
     flushPackageCache pkgs
    
     new_pkg_info <- getPackageDetails new_pkgs
-    mapM_ (linkPackage False) (reverse new_pkg_info)
+    mapM_ linkPackage (reverse new_pkg_info)
 
 -----------------------------------------------------------------------------
 -- GHCi monad
 
 data GHCiState = GHCiState
      { 
+       progname       :: String,
+       args           :: [String],
        targets        :: [FilePath],
        cmstate        :: CmState,
        options        :: [GHCiOption]
@@ -642,6 +735,10 @@ instance Monad GHCi where
   (GHCi m) >>= k  =  GHCi $ \s -> m s >>= \a -> unGHCi (k a) s
   return a  = GHCi $ \s -> return a
 
+ghciHandleDyn :: Typeable t => (t -> GHCi a) -> GHCi a -> GHCi a
+ghciHandleDyn h (GHCi m) = GHCi $ \s -> 
+   Exception.catchDyn (m s) (\e -> unGHCi (h e) s)
+
 getGHCiState   = GHCi $ \r -> readIORef r
 setGHCiState s = GHCi $ \r -> writeIORef r s
 
@@ -699,27 +796,23 @@ showLS (Right nm) = "(dynamic) " ++ nm
 
 linkPackages :: [LibrarySpec] -> [PackageConfig] -> IO ()
 linkPackages cmdline_lib_specs pkgs
-   = do sequence_ [ linkPackage (name p `elem` loaded) p | p <- reverse pkgs ]
+   = do mapM_ linkPackage (reverse pkgs)
         lib_paths <- readIORef v_Library_paths
         mapM_ (preloadLib lib_paths) cmdline_lib_specs
+       if (null cmdline_lib_specs)
+          then return ()
+          else do putStr "final link ... "
+                  ok <- resolveObjs
+                  if ok then putStrLn "done."
+                        else throwDyn (InstallationError "linking extra libraries/objects failed")
      where
-       -- Packages that are already linked into GHCi.  For mingw32, we only
-       -- skip gmp and rts, since std and after need to load the msvcrt.dll
-       -- library which std depends on.
-       loaded 
-#          ifndef mingw32_TARGET_OS
-           = [ "gmp", "rts", "std", "concurrent", "posix", "text", "util" ]
-#          else
-           = [ "gmp", "rts" ]
-#          endif
-
         preloadLib :: [String] -> LibrarySpec -> IO ()
         preloadLib lib_paths lib_spec
            = do putStr ("Loading object " ++ showLS lib_spec ++ " ... ")
                 case lib_spec of
                    Left static_ish
                       -> do b <- preload_static lib_paths static_ish
-                            putStrLn (if b then "done" else "not found")
+                            putStrLn (if b then "done." else "not found")
                    Right dll_unadorned
                       -> -- We add "" to the set of paths to try, so that
                          -- if none of the real paths match, we force addDLL
@@ -753,14 +846,25 @@ linkPackages cmdline_lib_specs pkgs
            = (throwDyn . CmdLineError)
                 "user specified .o/.so/.DLL could not be loaded."
 
+-- Packages that don't need loading, because the compiler shares them with
+-- the interpreted program.
+dont_load_these = [ "gmp", "rts" ]
+
+-- Packages that are already linked into GHCi.  For mingw32, we only
+-- skip gmp and rts, since std and after need to load the msvcrt.dll
+-- library which std depends on.
+loaded_in_ghci
+#          ifndef mingw32_TARGET_OS
+           = [ "std", "concurrent", "posix", "text", "util" ]
+#          else
+          = [ ]
+#          endif
 
-linkPackage :: Bool -> PackageConfig -> IO ()
--- ignore rts and gmp for now (ToDo; better?)
-linkPackage loaded_in_ghci pkg
-   | name pkg `elem` ["rts", "gmp"] 
-   = return ()
+linkPackage :: PackageConfig -> IO ()
+linkPackage pkg
+   | name pkg `elem` dont_load_these = return ()
    | otherwise
-   = do putStr ("Loading package " ++ name pkg ++ " ... ")
+   = do 
         -- 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
@@ -770,13 +874,15 @@ linkPackage loaded_in_ghci pkg
        -- Don't load the .so libs if this is a package GHCi is already
        -- linked against, because we'll already have the .so linked in.
        let (so_libs, obj_libs) = partition isRight classifieds
-        let sos_first | loaded_in_ghci = obj_libs
-                     | otherwise      = so_libs ++ obj_libs
+        let sos_first | name pkg `elem` loaded_in_ghci = obj_libs
+                     | otherwise                      = so_libs ++ obj_libs
 
+       putStr ("Loading package " ++ name pkg ++ " ... ")
         mapM loadClassified sos_first
         putStr "linking ... "
-        resolveObjs
-        putStrLn "done."
+        ok <- resolveObjs
+       if ok then putStrLn "done."
+             else panic ("can't load package `" ++ name pkg ++ "'")
      where
         isRight (Right _) = True
         isRight (Left _)  = False