[project @ 2001-10-16 14:44:51 by simonmar]
[ghc-hetmet.git] / ghc / compiler / ghci / InteractiveUI.hs
index 685cf84..79b619c 100644 (file)
@@ -1,5 +1,5 @@
 -----------------------------------------------------------------------------
--- $Id: InteractiveUI.hs,v 1.81 2001/07/17 14:53:48 rrt Exp $
+-- $Id: InteractiveUI.hs,v 1.95 2001/10/16 14:44:51 simonmar Exp $
 --
 -- GHC Interactive User Interface
 --
@@ -8,6 +8,7 @@
 -----------------------------------------------------------------------------
 
 {-# OPTIONS -#include "Linker.h" #-}
+{-# OPTIONS -#include "SchedAPI.h" #-}
 module InteractiveUI ( interactiveUI, ghciWelcomeMsg ) where
 
 #include "../includes/config.h"
@@ -15,7 +16,8 @@ module InteractiveUI ( interactiveUI, ghciWelcomeMsg ) where
 
 import Packages
 import CompManager
-import HscTypes                ( GhciMode(..) )
+import HscTypes                ( TyThing(..) )
+import MkIface
 import ByteCodeLink
 import DriverFlags
 import DriverState
@@ -23,7 +25,16 @@ 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(..) )
@@ -38,6 +49,7 @@ import Dynamic
 #if HAVE_READLINE_HEADERS && HAVE_READLINE_LIBS
 import Readline 
 #endif
+import Concurrent
 import IOExts
 
 import Numeric
@@ -71,6 +83,7 @@ builtin_commands = [
   ("def",      keepGoing defineMacro),
   ("help",     keepGoing help),
   ("?",                keepGoing help),
+  ("info",      keepGoing info),
   ("load",     keepGoing loadModule),
   ("module",   keepGoing setContext),
   ("reload",   keepGoing reloadModule),
@@ -88,12 +101,13 @@ shortHelpText = "use :? for help.\n"
 
 helpText = "\ 
 \ Commands available from the prompt:\n\ 
-\\  
+\\
 \   <stmt>                evaluate/run <stmt>\n\ 
 \   :add <filename> ...    add module(s) to the current target set\n\ 
 \   :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\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\ 
@@ -135,6 +149,12 @@ interactiveUI cmstate paths cmdline_libs = do
    dflags <- getDynFlags
 
    (cmstate, maybe_hval) 
+       <- cmCompileExpr cmstate dflags "IO.hSetBuffering IO.stdout IO.NoBuffering >> 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 ())
@@ -159,32 +179,47 @@ interactiveUI cmstate paths cmdline_libs = do
 
 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
+  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
+
+  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
   readlineLoop
@@ -192,19 +227,15 @@ 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 
 -- running code planted by a malicious third party.
 
--- Furthermore, We only read ./.ghci if both . and ./.ghci are
--- owned by the current user and aren'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.
+-- 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.
 
 checkPerms :: String -> IO Bool
 checkPerms name =
@@ -257,6 +288,7 @@ readlineLoop :: GHCi ()
 readlineLoop = do
    st <- getGHCiState
    mod <- io (cmGetContext (cmstate st))
+   io yield
    l <- io (readline (mod ++ "> "))
    case l of
        Nothing -> return ()
@@ -364,6 +396,65 @@ noArgs c = throwDyn (CmdLineError ("command `" ++ c ++ "' takes no arguments"))
 help :: String -> GHCi ()
 help _ = io (putStr helpText)
 
+info :: String -> GHCi ()
+info "" = throwDyn (CmdLineError "syntax: `:i <thing-you-want-info-about>'")
+info s = do
+  let names = words s
+  state <- getGHCiState
+  dflags <- io getDynFlags
+  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
   let files = words str
@@ -595,7 +686,7 @@ 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
@@ -625,6 +716,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
 
@@ -643,7 +738,8 @@ unsetOption opt
  = do st <- getGHCiState
       setGHCiState (st{ options = filter (/= opt) (options st) })
 
-io m = GHCi $ \s -> m >>= \a -> return a
+io :: IO a -> GHCi a
+io m = GHCi { unGHCi = \s -> m >>= return }
 
 -----------------------------------------------------------------------------
 -- recursive exception handlers
@@ -681,27 +777,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
@@ -735,14 +827,19 @@ linkPackages cmdline_lib_specs pkgs
            = (throwDyn . CmdLineError)
                 "user specified .o/.so/.DLL could not be loaded."
 
+-- 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
+           = [ "gmp", "rts", "std", "concurrent", "posix", "text", "util" ]
+#          else
+           = [ "gmp", "rts" ]
+#          endif
 
-linkPackage :: Bool -> PackageConfig -> IO ()
--- ignore rts and gmp for now (ToDo; better?)
-linkPackage loaded_in_ghci pkg
-   | name pkg `elem` ["rts", "gmp"] 
-   = return ()
-   | otherwise
-   = do putStr ("Loading package " ++ name pkg ++ " ... ")
+linkPackage :: PackageConfig -> IO ()
+linkPackage 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
@@ -752,13 +849,18 @@ 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
+
+       -- nothing to do?
+       if null sos_first then return () else do
 
+       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