X-Git-Url: http://git.megacz.com/?a=blobdiff_plain;f=Foreign%2FStablePtr.hs;h=522c6fc3449c5fcc2058d0b7260e7ab8c4cf85d3;hb=a07504ab09e4c63e7ef25c13e4e97466c36a651a;hp=1b169d0e8f158f23236d4887bc8bf443aaa010a4;hpb=746ef6a7fd71bb1e9ebe3cd107c5f9f79f3b7a68;p=ghc-base.git

diff --git a/Foreign/StablePtr.hs b/Foreign/StablePtr.hs
index 1b169d0..522c6fc 100644
--- a/Foreign/StablePtr.hs
+++ b/Foreign/StablePtr.hs
@@ -1,28 +1,62 @@
-{-# OPTIONS -fno-implicit-prelude #-}
+{-# LANGUAGE CPP, NoImplicitPrelude #-}
+
 -----------------------------------------------------------------------------
 -- |
 -- Module      :  Foreign.StablePtr
 -- 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  :  ffi@haskell.org
 -- Stability   :  provisional
 -- Portability :  portable
 --
--- Stable pointers.
+-- This module is part of the Foreign Function Interface (FFI) and will usually
+-- be imported via the module "Foreign".
 --
 -----------------------------------------------------------------------------
 
+
 module Foreign.StablePtr
-        ( StablePtr,         -- abstract
+        ( -- * Stable references to Haskell values
+          StablePtr          -- abstract
         , newStablePtr       -- :: a -> IO (StablePtr a)
         , deRefStablePtr     -- :: StablePtr a -> IO a
         , freeStablePtr      -- :: StablePtr a -> IO ()
         , castStablePtrToPtr -- :: StablePtr a -> Ptr ()
         , castPtrToStablePtr -- :: Ptr () -> StablePtr a
+        , -- ** The C-side interface
+
+          -- $cinterface
         ) where
 
 #ifdef __GLASGOW_HASKELL__
 import GHC.Stable
-import GHC.Err
 #endif
+
+#ifdef __HUGS__
+import Hugs.StablePtr
+#endif
+
+#ifdef __NHC__
+import NHC.FFI
+  ( StablePtr
+  , newStablePtr
+  , deRefStablePtr
+  , freeStablePtr
+  , castStablePtrToPtr
+  , castPtrToStablePtr
+  )
+#endif
+
+-- $cinterface
+--
+-- The following definition is available to C programs inter-operating with
+-- Haskell code when including the header @HsFFI.h@.
+--
+-- > typedef void *HsStablePtr;  /* C representation of a StablePtr */
+--
+-- Note that no assumptions may be made about the values representing stable
+-- pointers.  In fact, they need not even be valid memory addresses.  The only
+-- guarantee provided is that if they are passed back to Haskell land, the
+-- function 'deRefStablePtr' will be able to reconstruct the
+-- Haskell value referred to by the stable pointer.