[project @ 2005-01-28 15:03:06 by simonmar]
[ghc-base.git] / System / Environment.hs
index 31f6765..3271e29 100644 (file)
@@ -17,23 +17,23 @@ module System.Environment
       getArgs,      -- :: IO [String]
       getProgName,   -- :: IO String
       getEnv,        -- :: String -> IO String
-#ifdef __GLASGOW_HASKELL__
+#ifndef __NHC__
       withArgs,
       withProgName,
 #endif
+#ifdef __GLASGOW_HASKELL__
+      getEnvironment,
+#endif
   ) where
 
 import Prelude
-#ifndef __NHC__
-import Control.Exception       ( bracket )
-#endif
 
 #ifdef __GLASGOW_HASKELL__
 import Foreign
 import Foreign.C
+import Control.Exception       ( bracket )
 import Control.Monad
 import GHC.IOBase
-#include "config.h"
 #endif
 
 #ifdef __HUGS__
@@ -51,7 +51,7 @@ import System
 -- ---------------------------------------------------------------------------
 -- getArgs, getProgName, getEnv
 
--- Computation `getArgs' returns a list of the program's command
+-- | Computation 'getArgs' returns a list of the program's command
 -- line arguments (not including the program name).
 
 #ifdef __GLASGOW_HASKELL__
@@ -101,17 +101,19 @@ unpackProgName argv = do
 
    isPathSeparator :: Char -> Bool
    isPathSeparator '/'  = True
-#ifdef mingw32_TARGET_OS 
+#ifdef mingw32_HOST_OS 
    isPathSeparator '\\' = True
 #endif
    isPathSeparator _    = False
 
 
--- Computation `getEnv var' returns the value
--- of the environment variable {\em var}.  
-
--- This computation may fail with
---    NoSuchThing: The environment variable does not exist.
+-- | Computation 'getEnv' @var@ returns the value
+-- of the environment variable @var@.  
+--
+-- This computation may fail with:
+--
+--  * 'System.IO.Error.isDoesNotExistError' if the environment variable
+--    does not exist.
 
 getEnv :: String -> IO String
 getEnv name =
@@ -126,8 +128,8 @@ foreign import ccall unsafe "getenv"
    c_getenv :: CString -> IO (Ptr CChar)
 
 {-|
-@withArgs args act@ - while executing action @act@, have 'System.getArgs'
-return @args@ (GHC only).
+'withArgs' @args act@ - while executing action @act@, have 'getArgs'
+return @args@.
 -}
 withArgs :: [String] -> IO a -> IO a
 withArgs xs act = do
@@ -135,8 +137,8 @@ withArgs xs act = do
    withArgv (p:xs) act
 
 {-|
-@withProgName name act@ - while executing action @act@,
-have 'System.getProgName' return @name@ (GHC only).
+'withProgName' @name act@ - while executing action @act@,
+have 'getProgName' return @name@.
 -}
 withProgName :: String -> IO a -> IO a
 withProgName nm act = do
@@ -168,4 +170,26 @@ setArgs argv = do
 
 foreign import ccall unsafe "setProgArgv" 
   setArgsPrim  :: Int -> Ptr CString -> IO ()
+
+-- |'getEnvironment' retrieves the entire environment as a
+-- list of @(key,value)@ pairs.
+--
+-- If an environment entry does not contain an @\'=\'@ character,
+-- the @key@ is the whole entry and the @value@ is the empty string.
+
+getEnvironment :: IO [(String, String)]
+getEnvironment = do
+   pBlock <- getEnvBlock
+   if pBlock == nullPtr then return []
+    else do
+      stuff <- peekArray0 nullPtr pBlock >>= mapM peekCString
+      return (map divvy stuff)
+  where
+   divvy str = 
+      case break (=='=') str of
+        (xs,[])        -> (xs,[]) -- don't barf (like Posix.getEnvironment)
+        (name,_:value) -> (name,value)
+
+foreign import ccall unsafe "__hscore_environ" 
+  getEnvBlock :: IO (Ptr CString)
 #endif  /* __GLASGOW_HASKELL__ */