[project @ 2001-08-16 10:54:22 by simonmar]
[ghc-hetmet.git] / ghc / compiler / ghci / InteractiveUI.hs
index e64323c..af0faad 100644 (file)
@@ -1,5 +1,5 @@
 -----------------------------------------------------------------------------
--- $Id: InteractiveUI.hs,v 1.77 2001/06/18 09:09:28 simonmar Exp $
+-- $Id: InteractiveUI.hs,v 1.90 2001/08/16 10:54:22 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                ( GhciMode(..), TyThing(..) )
+import MkIface          ( ifaceTyCls )
 import ByteCodeLink
 import DriverFlags
 import DriverState
@@ -23,7 +25,14 @@ 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 )
+import FieldLabel      ( fieldLabelTyCon )
+import SrcLoc          ( isGoodSrcLoc )
+import Name            ( Name, isHomePackageName, nameSrcLoc, NamedThing(..) )
+import BasicTypes      ( defaultFixity )
 import Outputable
 import CmdLineOpts     ( DynFlag(..), getDynFlags, saveDynFlags, restoreDynFlags, dopt_unset )
 import Panic           ( GhcException(..) )
@@ -71,6 +80,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 +98,14 @@ 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\ 
-\   :load <filename>       load a module (and its dependents)\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\ 
@@ -111,10 +123,9 @@ helpText = "\
 \    -<flags>          most GHC command line flags can also be set here\n\ 
 \                         (eg. -v2, -fglasgow-exts, etc.)\n\ 
 \"
- --ToDo   :add <filename>     add a module to the current set\n\ 
 
-interactiveUI :: CmState -> Maybe FilePath -> [LibrarySpec] -> IO ()
-interactiveUI cmstate mod cmdline_libs = do
+interactiveUI :: CmState -> [FilePath] -> [LibrarySpec] -> IO ()
+interactiveUI cmstate paths cmdline_libs = do
    hFlush stdout
    hSetBuffering stdout NoBuffering
 
@@ -124,9 +135,9 @@ interactiveUI cmstate mod cmdline_libs = do
    linkPackages cmdline_libs pkgs
 
    (cmstate, ok, mods) <-
-       case mod of
-            Nothing  -> return (cmstate, True, [])
-            Just m -> cmLoadModule cmstate m
+       case paths of
+            [] -> return (cmstate, True, [])
+            _  -> cmLoadModule cmstate paths
 
 #if HAVE_READLINE_HEADERS && HAVE_READLINE_LIBS
    Readline.initialize
@@ -146,39 +157,49 @@ interactiveUI cmstate mod cmdline_libs = do
        Just hval -> writeIORef flush_stdout (unsafeCoerce# hval :: IO ())
        _ -> panic "interactiveUI:stdout"
 
-   startGHCi runGHCi GHCiState{ target = mod,
+   startGHCi runGHCi GHCiState{ targets = paths,
                                cmstate = cmstate,
                                options = [] }
+
+#if HAVE_READLINE_HEADERS && HAVE_READLINE_LIBS
+   Readline.resetTerminal Nothing
+#endif
+
    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
+  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
 
   -- read commands from stdin
 #if HAVE_READLINE_HEADERS && HAVE_READLINE_LIBS
@@ -195,11 +216,10 @@ runGHCi = do
 -- 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 =
@@ -359,8 +379,69 @@ 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 (ifaceTyCls ty_thing) ]
+
+    showFixity fix name
+       | fix == defaultFixity = empty
+       | otherwise            = ppr fix <+> ppr name
+
+    showTyThing (AClass cl) 
+       = hcat [ppr cl, text " is a class", showSrcLoc (className cl)]
+    showTyThing (ATyCon ty)
+       = 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 _ = throwDyn (InstallationError ":add not implemented")
+addModule str = do
+  let files = words str
+  state <- getGHCiState
+  dflags <- io (getDynFlags)
+  io (revertCAFs)                      -- always revert CAFs on load/add.
+  let new_targets = files ++ targets state 
+  (cmstate1, ok, mods) <- io (cmLoadModule (cmstate state) new_targets)
+  setGHCiState state{ cmstate = cmstate1, targets = new_targets }
+  modulesLoadedMsg ok mods
 
 setContext :: String -> GHCi ()
 setContext ""
@@ -425,26 +506,27 @@ undefineMacro macro_name = do
   io (writeIORef commands (filter ((/= macro_name) . fst) cmds))
 
 loadModule :: String -> GHCi ()
-loadModule path = timeIt (loadModule' path)
+loadModule str = timeIt (loadModule' str)
 
-loadModule' path = do
+loadModule' str = do
+  let files = words str
   state <- getGHCiState
   dflags <- io getDynFlags
   cmstate1 <- io (cmUnload (cmstate state) dflags)
-  setGHCiState state{ cmstate = cmstate1, target = Nothing }
+  setGHCiState state{ cmstate = cmstate1, targets = [] }
   io (revertCAFs)                      -- always revert CAFs on load.
-  (cmstate2, ok, mods) <- io (cmLoadModule cmstate1 path)
-  setGHCiState state{ cmstate = cmstate2, target = Just path }
+  (cmstate2, ok, mods) <- io (cmLoadModule cmstate1 files)
+  setGHCiState state{ cmstate = cmstate2, targets = files }
   modulesLoadedMsg ok mods
 
 reloadModule :: String -> GHCi ()
 reloadModule "" = do
   state <- getGHCiState
-  case target state of
-   Nothing -> io (putStr "no current target\n")
-   Just path
+  case targets state of
+   [] -> io (putStr "no current target\n")
+   paths
       -> do io (revertCAFs)            -- always revert CAFs on reload.
-           (new_cmstate, ok, mods) <- io (cmLoadModule (cmstate state) path)
+           (new_cmstate, ok, mods) <- io (cmLoadModule (cmstate state) paths)
             setGHCiState state{ cmstate=new_cmstate }
            modulesLoadedMsg ok mods
 
@@ -574,7 +656,7 @@ newPackages new_pkgs = do
   state <- getGHCiState
   dflags <- io getDynFlags
   cmstate1 <- io (cmUnload (cmstate state) dflags)
-  setGHCiState state{ cmstate = cmstate1, target = Nothing }
+  setGHCiState state{ cmstate = cmstate1, targets = [] }
 
   io $ do
     pkgs <- getPackageInfo
@@ -588,7 +670,7 @@ newPackages new_pkgs = do
 
 data GHCiState = GHCiState
      { 
-       target         :: Maybe FilePath,
+       targets        :: [FilePath],
        cmstate        :: CmState,
        options        :: [GHCiOption]
      }
@@ -629,7 +711,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
@@ -670,9 +753,22 @@ linkPackages cmdline_lib_specs pkgs
    = do sequence_ [ linkPackage (name p `elem` loaded) p | p <- 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
-       loaded = [ "gmp", "rts", "std", "concurrent", "posix", "text", "util" ]
+       -- 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
@@ -680,7 +776,7 @@ linkPackages cmdline_lib_specs pkgs
                 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
@@ -736,8 +832,9 @@ linkPackage loaded_in_ghci 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
@@ -750,7 +847,7 @@ loadClassified (Right dll_unadorned)
         if    maybe_errmsg == nullPtr
          then return ()
          else do str <- peekCString maybe_errmsg
-                 throwDyn (CmdLineError ("can't find .o or .so/.DLL for: " 
+                 throwDyn (CmdLineError ("can't load .so/.DLL for: " 
                                        ++ dll_unadorned ++ " (" ++ str ++ ")" ))
 
 locateOneObj :: [FilePath] -> String -> IO LibrarySpec