X-Git-Url: http://git.megacz.com/?a=blobdiff_plain;f=Debug%2FTrace.hs;h=ebacb6c3d7fa28d37e385a2d240c97b2bd4d8d78;hb=HEAD;hp=08d2fc1a6556fc852255d1a8f88b777549094cd3;hpb=746ef6a7fd71bb1e9ebe3cd107c5f9f79f3b7a68;p=ghc-base.git

diff --git a/Debug/Trace.hs b/Debug/Trace.hs
index 08d2fc1..ebacb6c 100644
--- a/Debug/Trace.hs
+++ b/Debug/Trace.hs
@@ -1,39 +1,72 @@
+{-# LANGUAGE CPP, ForeignFunctionInterface #-}
+
 -----------------------------------------------------------------------------
 -- |
 -- Module      :  Debug.Trace
 -- Copyright   :  (c) The University of Glasgow 2001
--- License     :  BSD-style (see the file libraries/core/LICENSE)
+-- License     :  BSD-style (see the file libraries/base/LICENSE)
 -- 
 -- Maintainer  :  libraries@haskell.org
 -- Stability   :  provisional
 -- Portability :  portable
 --
--- The trace function.
+-- The 'trace' function.
 --
 -----------------------------------------------------------------------------
 
 module Debug.Trace (
-	trace -- :: String -> a -> a
+        -- * Tracing
+        putTraceMsg,      -- :: String -> IO ()
+        trace,            -- :: String -> a -> a
+        traceShow
   ) where
 
 import Prelude
 import System.IO.Unsafe
-import System.IO
 
 #ifdef __GLASGOW_HASKELL__
-import GHC.IOBase
-import GHC.Handle
+import Foreign.C.String
+#else
+import System.IO (hPutStrLn,stderr)
+#endif
+
+-- | 'putTraceMsg' function outputs the trace message from IO monad.
+-- Usually the output stream is 'System.IO.stderr' but if the function is called
+-- from Windows GUI application then the output will be directed to the Windows
+-- debug console.
+putTraceMsg :: String -> IO ()
+putTraceMsg msg = do
+#ifndef __GLASGOW_HASKELL__
+    hPutStrLn stderr msg
+#else
+    withCString "%s\n" $ \cfmt ->
+     withCString msg  $ \cmsg ->
+      debugBelch cfmt cmsg
+
+-- don't use debugBelch() directly, because we cannot call varargs functions
+-- using the FFI.
+foreign import ccall unsafe "HsBase.h debugBelch2"
+   debugBelch :: CString -> CString -> IO ()
 #endif
 
-#ifdef __GLASGOW_HASKELL__
 {-# NOINLINE trace #-}
+{-|
+When called, 'trace' outputs the string in its first argument, before 
+returning the second argument as its result. The 'trace' function is not 
+referentially transparent, and should only be used for debugging, or for 
+monitoring execution. Some implementations of 'trace' may decorate the string 
+that\'s output to indicate that you\'re tracing. The function is implemented on
+top of 'putTraceMsg'.
+-}
 trace :: String -> a -> a
 trace string expr = unsafePerformIO $ do
-    hPutStr stderr string
-    hPutChar stderr '\n'
-    fd <- withHandle_ "trace" stderr $ (return.haFD)
-    postTraceHook fd
+    putTraceMsg string
     return expr
 
-foreign import ccall "PostTraceHook" postTraceHook :: Int -> IO ()
-#endif
+{-|
+Like 'trace', but uses 'show' on the argument to convert it to a 'String'.
+
+> traceShow = trace . show
+-}
+traceShow :: (Show a) => a -> b -> b
+traceShow = trace . show