[project @ 2005-01-27 10:45:47 by simonpj]
[ghc-base.git] / Foreign / Ptr.hs
index 0079828..ad20da4 100644 (file)
@@ -1,4 +1,4 @@
-{-# OPTIONS -fno-implicit-prelude #-}
+{-# OPTIONS_GHC -fno-implicit-prelude #-}
 -----------------------------------------------------------------------------
 -- |
 -- Module      :  Foreign.Ptr
@@ -9,7 +9,7 @@
 -- Stability   :  provisional
 -- Portability :  portable
 --
--- The "Ptr" module provides typed pointers to foreign data.  It is part
+-- This module provides typed pointers to foreign data.  It is part
 -- of the Foreign Function Interface (FFI) and will normally be
 -- imported via the "Foreign" module.
 --
@@ -42,7 +42,6 @@ module Foreign.Ptr (
 #ifdef __GLASGOW_HASKELL__
 import GHC.Ptr
 import GHC.IOBase
-import GHC.Err
 import GHC.Base
 import GHC.Num
 import GHC.List
@@ -67,6 +66,9 @@ import NHC.FFI
   )
 #endif
 
+#ifdef __HUGS__
+import Hugs.Ptr
+#endif
 
 #ifdef __GLASGOW_HASKELL__
 #include "MachDeps.h"
@@ -76,7 +78,7 @@ instance Show (Ptr a) where
    showsPrec p (Ptr a) rs = pad_out (showHex (word2Integer(int2Word#(addr2Int# a))) "") rs
      where
         -- want 0s prefixed to pad it out to a fixed length.
-       pad_out ('0':'x':ls) rs = 
+       pad_out ls rs = 
          '0':'x':(replicate (2*SIZEOF_HSPTR - length ls) '0') ++ ls ++ rs
        -- word2Integer :: Word# -> Integer (stolen from Word.lhs)
        word2Integer w = case word2Integer# w of
@@ -85,9 +87,11 @@ instance Show (Ptr a) where
 instance Show (FunPtr a) where
    showsPrec p = showsPrec p . castFunPtrToPtr
 #endif
-#endif
 
-#ifndef __NHC__
+-- | Release the storage associated with the given 'FunPtr', which
+-- must have been obtained from a wrapper stub.  This should be called
+-- whenever the return value from a foreign import wrapper function is
+-- no longer required; otherwise, the storage it uses will leak.
 foreign import ccall unsafe "freeHaskellFunctionPtr"
     freeHaskellFunPtr :: FunPtr a -> IO ()
 #endif