System/IO/Unsafe.hs

{-# LANGUAGE Unsafe #-}
{-# LANGUAGE CPP, NoImplicitPrelude #-}

-----------------------------------------------------------------------------
-- |
-- Module : System.IO.Unsafe
-- Copyright : (c) The University of Glasgow 2001
-- License : BSD-style (see the file libraries/base/LICENSE)
-- 
-- Maintainer : libraries@haskell.org
-- Stability : provisional
-- Portability : portable
--
-- \"Unsafe\" IO operations.
--
-----------------------------------------------------------------------------

module System.IO.Unsafe (
 -- * Unsafe 'System.IO.IO' operations
 unsafePerformIO, -- :: IO a -> a
 unsafeDupablePerformIO, -- :: IO a -> a
 unsafeInterleaveIO, -- :: IO a -> IO a
 unsafeFixIO,
 ) where

#ifdef __GLASGOW_HASKELL__
import GHC.Base
import GHC.IO
import GHC.IORef
import GHC.Exception
import Control.Exception
#endif

#ifdef __HUGS__
import Hugs.IOExts (unsafePerformIO, unsafeInterleaveIO)
unsafeDupablePerformIO = unsafePerformIO
#endif

#ifdef __NHC__
import NHC.Internal (unsafePerformIO, unsafeInterleaveIO)
unsafeDupablePerformIO = unsafePerformIO
#endif

-- | A slightly faster version of `System.IO.fixIO` that may not be
-- safe to use with multiple threads. The unsafety arises when used
-- like this:
--
-- > unsafeFixIO $ \r ->
-- > forkIO (print r)
-- > return (...)
--
-- In this case, the child thread will receive a @NonTermination@
-- exception instead of waiting for the value of @r@ to be computed.
--
unsafeFixIO :: (a -> IO a) -> IO a
unsafeFixIO k = do
 ref <- newIORef (throw NonTermination)
 ans <- unsafeDupableInterleaveIO (readIORef ref)
 result <- k ans
 writeIORef ref result
 return result