[project @ 2001-06-18 09:09:28 by simonmar]
[ghc-hetmet.git] / ghc / compiler / ghci / InteractiveUI.hs
index be216e6..e64323c 100644 (file)
@@ -1,5 +1,5 @@
 -----------------------------------------------------------------------------
--- $Id: InteractiveUI.hs,v 1.64 2001/04/26 11:38:53 qrczak Exp $
+-- $Id: InteractiveUI.hs,v 1.77 2001/06/18 09:09:28 simonmar Exp $
 --
 -- GHC Interactive User Interface
 --
@@ -13,20 +13,26 @@ module InteractiveUI ( interactiveUI, ghciWelcomeMsg ) where
 #include "../includes/config.h"
 #include "HsVersions.h"
 
+import Packages
 import CompManager
-import CmStaticInfo
+import HscTypes                ( GhciMode(..) )
 import ByteCodeLink
 import DriverFlags
 import DriverState
 import DriverUtil
 import Linker
+import Finder          ( flushPackageCache )
 import Util
 import Name            ( Name )
 import Outputable
-import CmdLineOpts     ( DynFlag(..), dopt_unset )
+import CmdLineOpts     ( DynFlag(..), getDynFlags, saveDynFlags, restoreDynFlags, dopt_unset )
 import Panic           ( GhcException(..) )
 import Config
 
+#ifndef mingw32_TARGET_OS
+import Posix
+#endif
+
 import Exception
 import Dynamic
 #if HAVE_READLINE_HEADERS && HAVE_READLINE_LIBS
@@ -52,7 +58,7 @@ import CString                ( peekCString )
 ghciWelcomeMsg = "\ 
 \   ___         ___ _\n\ 
 \  / _ \\ /\\  /\\/ __(_)\n\ 
-\ / /_\\// /_/ / /  | |      GHC Interactive, version " ++ cProjectVersion ++ ", For Haskell 98.\n\ 
+\ / /_\\// /_/ / /  | |      GHC Interactive, version " ++ cProjectVersion ++ ", for Haskell 98.\n\ 
 \/ /_\\\\/ __  / /___| |      http://www.haskell.org/ghc/\n\ 
 \\\____/\\/ /_/\\____/|_|      Type :? for help.\n"
 
@@ -83,19 +89,19 @@ shortHelpText = "use :? for help.\n"
 helpText = "\ 
 \ Commands available from the prompt:\n\ 
 \\  
-\   <stmt>             evaluate/run <stmt>\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 it 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\ 
-\   :undef <name>      undefine user-defined command :<name>\n\ 
-\   :type <expr>       show the type of <expr>\n\ 
-\   :unset <option> ...        unset options\n\ 
-\   :quit              exit GHCi\n\ 
-\   :!<command>                run the shell command <command>\n\ 
+\   <stmt>                evaluate/run <stmt>\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\ 
+\   :module <mod>         set the context for expression evaluation to <mod>\n\ 
+\   :reload               reload the current module set\n\ 
+\   :set <option> ...     set options\n\ 
+\   :undef <cmd>          undefine user-defined command :<cmd>\n\ 
+\   :type <expr>          show the type of <expr>\n\ 
+\   :unset <option> ...           unset options\n\ 
+\   :quit                 exit GHCi\n\ 
+\   :!<command>                   run the shell command <command>\n\ 
 \\ 
 \ Options for `:set' and `:unset':\n\ 
 \\ 
@@ -115,7 +121,7 @@ interactiveUI cmstate mod cmdline_libs = do
    -- link in the available packages
    pkgs <- getPackageInfo
    initLinker
-   linkPackages cmdline_libs (reverse pkgs)
+   linkPackages cmdline_libs pkgs
 
    (cmstate, ok, mods) <-
        case mod of
@@ -140,31 +146,39 @@ interactiveUI cmstate mod cmdline_libs = do
        Just hval -> writeIORef flush_stdout (unsafeCoerce# hval :: IO ())
        _ -> panic "interactiveUI:stdout"
 
-   (unGHCi runGHCi) GHCiState{ target = mod,
-                              cmstate = cmstate,
-                              options = [] }
+   startGHCi runGHCi GHCiState{ target = mod,
+                               cmstate = cmstate,
+                               options = [] }
    return ()
 
 
 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.
+  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 ~/.ghci
-  home <- io (IO.try (getEnv "HOME"))
-  case home of
-   Left e  -> return ()
-   Right dir -> 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
-         dot_ghci <- io (IO.try (openFile (dir ++ "/.ghci") ReadMode))
-         case dot_ghci of
-            Left e -> return ()
-            Right hdl -> fileLoop hdl False
+       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 commands from stdin
 #if HAVE_READLINE_HEADERS && HAVE_READLINE_LIBS
@@ -177,6 +191,38 @@ runGHCi = do
   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.
+
+checkPerms :: String -> IO Bool
+checkPerms name =
+  handle (\_ -> return False) $ do
+#ifdef mingw32_TARGET_OS
+     doesFileExist name
+#else
+     st <- getFileStatus name
+     me <- getRealUserID
+     if fileOwner st /= me then do
+       putStrLn $ "WARNING: " ++ name ++ " is owned by someone else, IGNORING!"
+       return False
+      else do
+       let mode =  fileMode st
+       if (groupWriteMode == (mode `intersectFileModes` groupWriteMode))
+          || (otherWriteMode == (mode `intersectFileModes` otherWriteMode)) 
+          then do
+              putStrLn $ "*** WARNING: " ++ name ++ 
+                         " is writable by someone else, IGNORING!"
+              return False
+         else return True
+#endif
+
 fileLoop :: Handle -> Bool -> GHCi ()
 fileLoop hdl prompt = do
    st <- getGHCiState
@@ -222,27 +268,28 @@ readlineLoop = do
 -- and carries on.
 runCommand :: String -> GHCi Bool
 runCommand c = 
-  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.")
-                       -- omit the location for CmdLineError
-                   CmdLineError s -> io (putStrLn s)
-                   other -> io (putStrLn (show (ghc_ex :: GhcException)))
-
-          other -> io (putStrLn ("*** Exception: " ++ show exception))
-
-       ) >> return False
-     ) $
-
-   doCommand c
+  ghciHandle ( \exception -> do
+               flushEverything
+               showException exception
+               return False
+            ) $
+  doCommand 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))
+showException other_exception
+  = io (putStrLn ("*** Exception: " ++ show other_exception))
 
 doCommand (':' : command) = specialCommand command
 doCommand stmt
@@ -257,7 +304,7 @@ runStmt stmt
  = return Nothing
  | otherwise
  = do st <- getGHCiState
-      dflags <- io (getDynFlags)
+      dflags <- io getDynFlags
       let dflags' = dopt_unset dflags Opt_WarnUnusedBinds
       (new_cmstate, names) <- io (cmRunStmt (cmstate st) dflags' stmt)
       setGHCiState st{cmstate = new_cmstate}
@@ -318,8 +365,10 @@ addModule _ = throwDyn (InstallationError ":add not implemented")
 setContext :: String -> GHCi ()
 setContext ""
   = throwDyn (CmdLineError "syntax: `:m <module>'")
-setContext m | not (isUpper (head m)) || not (all isAlphaNum (tail m))
+setContext m | not (isUpper (head m)) || not (all isAlphaNumEx (tail m))
   = throwDyn (CmdLineError ("strange looking module name: `" ++ m ++ "'"))
+    where
+       isAlphaNumEx c = isAlphaNum c || c == '_'
 setContext str
   = do st <- getGHCiState
        new_cmstate <- io (cmSetContext (cmstate st) str)
@@ -349,7 +398,7 @@ defineMacro s = do
 
   -- compile the expression
   st <- getGHCiState
-  dflags <- io (getDynFlags)
+  dflags <- io getDynFlags
   (new_cmstate, maybe_hv) <- io (cmCompileExpr (cmstate st) dflags new_expr)
   setGHCiState st{cmstate = new_cmstate}
   case maybe_hv of
@@ -380,13 +429,12 @@ loadModule path = timeIt (loadModule' path)
 
 loadModule' path = do
   state <- getGHCiState
-  cmstate1 <- io (cmUnload (cmstate state))
+  dflags <- io getDynFlags
+  cmstate1 <- io (cmUnload (cmstate state) dflags)
+  setGHCiState state{ cmstate = cmstate1, target = Nothing }
   io (revertCAFs)                      -- always revert CAFs on load.
   (cmstate2, ok, mods) <- io (cmLoadModule cmstate1 path)
-  let new_state = state{ cmstate = cmstate2,
-                        target = Just path
-                      }
-  setGHCiState new_state
+  setGHCiState state{ cmstate = cmstate2, target = Just path }
   modulesLoadedMsg ok mods
 
 reloadModule :: String -> GHCi ()
@@ -418,7 +466,7 @@ modulesLoadedMsg ok mods = do
 typeOfExpr :: String -> GHCi ()
 typeOfExpr str 
   = do st <- getGHCiState
-       dflags <- io (getDynFlags)
+       dflags <- io getDynFlags
        (new_cmstate, maybe_tystr) <- io (cmTypeOfExpr (cmstate st) dflags str)
        setGHCiState st{cmstate = new_cmstate}
        case maybe_tystr of
@@ -453,32 +501,29 @@ setOptions ""
           ))
 setOptions str
   = do -- first, deal with the GHCi opts (+s, +t, etc.)
-       let opts = words str
-          (minus_opts, rest1) = partition isMinus opts
-          (plus_opts, rest2)  = partition isPlus rest1
-
-       if (not (null rest2)) 
-         then io (putStrLn ("unknown option: `" ++ head rest2 ++ "'"))
-         else do
-
-       mapM setOpt plus_opts
-
-       -- now, the GHC flags
-       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 (CmdLineError ("unrecognised flags: " ++ 
+      let (plus_opts, minus_opts)  = partition isPlus (words str)
+      mapM setOpt plus_opts
+
+      -- now, the GHC flags
+      pkgs_before <- io (readIORef v_Packages)
+      leftovers   <- io (processArgs static_flags minus_opts [])
+      pkgs_after  <- io (readIORef v_Packages)
+
+      -- update things if the users wants more packages
+      when (pkgs_before /= pkgs_after) $
+        newPackages (pkgs_after \\ pkgs_before)
+
+      -- then, dynamic flags
+      io $ do 
+       restoreDynFlags
+        leftovers <- processArgs dynamic_flags leftovers []
+       saveDynFlags
+
+        if (not (null leftovers))
+               then throwDyn (CmdLineError ("unrecognised flags: " ++ 
                                                unwords leftovers))
-                else return ()
-         )
+               else return ()
+
 
 unsetOptions :: String -> GHCi ()
 unsetOptions str
@@ -525,6 +570,19 @@ optToStr ShowTiming = "s"
 optToStr ShowType   = "t"
 optToStr RevertCAFs = "r"
 
+newPackages new_pkgs = do
+  state <- getGHCiState
+  dflags <- io getDynFlags
+  cmstate1 <- io (cmUnload (cmstate state) dflags)
+  setGHCiState state{ cmstate = cmstate1, target = Nothing }
+
+  io $ do
+    pkgs <- getPackageInfo
+    flushPackageCache pkgs
+   
+    new_pkg_info <- getPackageDetails new_pkgs
+    mapM_ (linkPackage False) (reverse new_pkg_info)
+
 -----------------------------------------------------------------------------
 -- GHCi monad
 
@@ -544,14 +602,17 @@ data GHCiOption
 GLOBAL_VAR(flush_stdout, error "no flush_stdout", IO ())
 GLOBAL_VAR(flush_stderr, error "no flush_stdout", IO ())
 
-newtype GHCi a = GHCi { unGHCi :: GHCiState -> IO (GHCiState, a) }
+newtype GHCi a = GHCi { unGHCi :: IORef GHCiState -> IO a }
+
+startGHCi :: GHCi a -> GHCiState -> IO a
+startGHCi g state = do ref <- newIORef state; unGHCi g ref
 
 instance Monad GHCi where
-  (GHCi m) >>= k  =  GHCi $ \s -> m s >>= \(s,a) -> unGHCi (k a) s
-  return a  = GHCi $ \s -> return (s,a)
+  (GHCi m) >>= k  =  GHCi $ \s -> m s >>= \a -> unGHCi (k a) s
+  return a  = GHCi $ \s -> return a
 
-getGHCiState   = GHCi $ \s -> return (s,s)
-setGHCiState s = GHCi $ \_ -> return (s,())
+getGHCiState   = GHCi $ \r -> readIORef r
+setGHCiState s = GHCi $ \r -> writeIORef r s
 
 isOptionSet :: GHCiOption -> GHCi Bool
 isOptionSet opt
@@ -568,7 +629,7 @@ unsetOption opt
  = do st <- getGHCiState
       setGHCiState (st{ options = filter (/= opt) (options st) })
 
-io m = GHCi $ \s -> m >>= \a -> return (s,a)
+io m = GHCi $ \s -> m >>= \a -> return a
 
 -----------------------------------------------------------------------------
 -- recursive exception handlers
@@ -593,7 +654,11 @@ ghciUnblock (GHCi a) = GHCi $ \s -> Exception.unblock (a s)
 --        e.g.    On unix     "qt"  denotes "libqt.so"
 --                On WinDoze  "burble"  denotes "burble.DLL"
 --        addDLL is platform-specific and adds the lib/.so/.DLL
---        prefixes plaform-dependently; we don't do that here.
+--        suffixes platform-dependently; we don't do that here.
+-- 
+-- For dynamic objects only, try to find the object file in all the 
+-- directories specified in v_Library_Paths before giving up.
+
 type LibrarySpec
    = Either FilePath String
 
@@ -602,33 +667,57 @@ showLS (Right nm) = "(dynamic) " ++ nm
 
 linkPackages :: [LibrarySpec] -> [PackageConfig] -> IO ()
 linkPackages cmdline_lib_specs pkgs
-   = do mapM_ linkPackage pkgs
-        mapM_ preloadLib cmdline_lib_specs
+   = do sequence_ [ linkPackage (name p `elem` loaded) p | p <- reverse pkgs ]
+        lib_paths <- readIORef v_Library_paths
+        mapM_ (preloadLib lib_paths) cmdline_lib_specs
      where
-        preloadLib lib_spec
+       -- packages that are already linked into GHCi
+       loaded = [ "gmp", "rts", "std", "concurrent", "posix", "text", "util" ]
+
+        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 <- doesFileExist static_ish
-                            if    not b
-                             then do putStr "not found.\n"
-                                     croak
-                             else do loadObj static_ish
-                                     putStr "done.\n"
+                      -> do b <- preload_static lib_paths static_ish
+                            putStrLn (if b then "done" else "not found")
                    Right dll_unadorned
-                      -> do maybe_errmsg <- addDLL dll_unadorned
-                            if    maybe_errmsg == nullPtr
-                             then putStr "done.\n"
-                             else do str <- peekCString maybe_errmsg
-                                     putStr ("failed (" ++ str ++ ")\n")
-                                     croak
-
-        croak = throwDyn (CmdLineError "user specified .o/.so/.DLL could not be loaded.")
-
-
-linkPackage :: PackageConfig -> IO ()
+                      -> -- We add "" to the set of paths to try, so that
+                         -- if none of the real paths match, we force addDLL
+                         -- to look in the default dynamic-link search paths.
+                         do b <- preload_dynamic (lib_paths++[""]) dll_unadorned
+                            when (not b) (cantFind lib_paths lib_spec)
+                            putStrLn "done"
+
+        cantFind :: [String] -> LibrarySpec -> IO ()
+        cantFind paths spec
+           = do putStr ("failed.\nCan't find " ++ showLS spec
+                        ++ " in directories:\n"
+                        ++ unlines (map ("   "++) paths) )
+                give_up
+
+        -- not interested in the paths in the static case.
+        preload_static paths name
+           = do b <- doesFileExist name
+                if not b then return False
+                         else loadObj name >> return True
+
+        preload_dynamic [] name
+           = return False
+        preload_dynamic (path:paths) rootname
+           = do maybe_errmsg <- addDLL path rootname
+                if    maybe_errmsg /= nullPtr
+                 then preload_dynamic paths rootname
+                 else return True
+
+        give_up 
+           = (throwDyn . CmdLineError)
+                "user specified .o/.so/.DLL could not be loaded."
+
+
+linkPackage :: Bool -> PackageConfig -> IO ()
 -- ignore rts and gmp for now (ToDo; better?)
-linkPackage pkg 
+linkPackage loaded_in_ghci pkg
    | name pkg `elem` ["rts", "gmp"] 
    = return ()
    | otherwise
@@ -638,8 +727,13 @@ linkPackage pkg
         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
+
+       -- 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
+
         mapM loadClassified sos_first
         putStr "linking ... "
         resolveObjs
@@ -652,7 +746,7 @@ loadClassified :: LibrarySpec -> IO ()
 loadClassified (Left obj_absolute_filename)
    = do loadObj obj_absolute_filename
 loadClassified (Right dll_unadorned)
-   = do maybe_errmsg <- addDLL dll_unadorned
+   = do maybe_errmsg <- addDLL "" dll_unadorned -- doesn't seem right to me
         if    maybe_errmsg == nullPtr
          then return ()
          else do str <- peekCString maybe_errmsg