[project @ 2002-05-09 13:16:29 by simonmar]
[ghc-base.git] / Foreign / Ptr.hs
index bc8d42e..f4260fd 100644 (file)
@@ -1,35 +1,34 @@
 {-# OPTIONS -fno-implicit-prelude #-}
 -----------------------------------------------------------------------------
--- 
+-- |
 -- Module      :  Foreign.Ptr
 -- Copyright   :  (c) The FFI task force 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
 --
--- $Id: Ptr.hs,v 1.3 2002/02/11 16:11:38 simonmar Exp $
---
--- Pointer types.
+-- The "Ptr" 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.
 --
 -----------------------------------------------------------------------------
 
 module Foreign.Ptr (
-    --------------------------------------------------------------------
-    -- Data pointers.
+
+    -- * Data pointers
     
-    Ptr(..),      -- data Ptr a
+    Ptr,      -- data Ptr a
     nullPtr,      -- :: Ptr a
     castPtr,      -- :: Ptr a -> Ptr b
     plusPtr,      -- :: Ptr a -> Int -> Ptr b
     alignPtr,     -- :: Ptr a -> Int -> Ptr a
     minusPtr,     -- :: Ptr a -> Ptr b -> Int
     
-    --------------------------------------------------------------------
-    -- Function pointers.
+    -- * Function pointers
     
-    FunPtr(..),      -- data FunPtr a
+    FunPtr,      -- data FunPtr a
     nullFunPtr,      -- :: FunPtr a
     castFunPtr,      -- :: FunPtr a -> FunPtr b
     castFunPtrToPtr, -- :: FunPtr a -> Ptr b
@@ -40,13 +39,10 @@ module Foreign.Ptr (
 
  ) where
 
-import Data.Dynamic
-
 #ifdef __GLASGOW_HASKELL__
 import GHC.Ptr
 import GHC.IOBase
 import GHC.Err
-import GHC.Prim
 import GHC.Base
 import GHC.Num
 import GHC.List
@@ -70,8 +66,5 @@ instance Show (Ptr a) where
 #endif
 #endif
 
-foreign import "freeHaskellFunctionPtr" unsafe
+foreign import ccall unsafe "freeHaskellFunctionPtr"
     freeHaskellFunPtr :: FunPtr a -> IO ()
-
-#include "Dynamic.h"
-INSTANCE_TYPEABLE1(Ptr,ptrTc,"Ptr")