SafeHaskell: Added SafeHaskell to base
[packages/base.git] / GHC / Ptr.lhs
1 \begin{code}
2 {-# LANGUAGE CPP, NoImplicitPrelude, MagicHash #-}
3 {-# OPTIONS_HADDOCK hide #-}
4
5 -----------------------------------------------------------------------------
6 -- |
7 -- Module      :  GHC.Ptr
8 -- Copyright   :  (c) The FFI Task Force, 2000-2002
9 -- License     :  see libraries/base/LICENSE
10 -- 
11 -- Maintainer  :  ffi@haskell.org
12 -- Stability   :  internal
13 -- Portability :  non-portable (GHC Extensions)
14 --
15 -- The 'Ptr' and 'FunPtr' types and operations.
16 --
17 -----------------------------------------------------------------------------
18
19 -- #hide
20 module GHC.Ptr (
21         Ptr(..), FunPtr(..),
22         nullPtr, castPtr, plusPtr, alignPtr, minusPtr,
23         nullFunPtr, castFunPtr,
24
25         -- * Unsafe functions
26         castFunPtrToPtr, castPtrToFunPtr
27     ) where
28
29 import GHC.Base
30 import GHC.Show
31 import GHC.Num
32 import GHC.List ( length, replicate )
33 import Numeric          ( showHex )
34
35 #include "MachDeps.h"
36
37 ------------------------------------------------------------------------
38 -- Data pointers.
39
40 data Ptr a = Ptr Addr# deriving (Eq, Ord)
41 -- ^ A value of type @'Ptr' a@ represents a pointer to an object, or an
42 -- array of objects, which may be marshalled to or from Haskell values
43 -- of type @a@.
44 --
45 -- The type @a@ will often be an instance of class
46 -- 'Foreign.Storable.Storable' which provides the marshalling operations.
47 -- However this is not essential, and you can provide your own operations
48 -- to access the pointer.  For example you might write small foreign
49 -- functions to get or set the fields of a C @struct@.
50
51 -- |The constant 'nullPtr' contains a distinguished value of 'Ptr'
52 -- that is not associated with a valid memory location.
53 nullPtr :: Ptr a
54 nullPtr = Ptr nullAddr#
55
56 -- |The 'castPtr' function casts a pointer from one type to another.
57 castPtr :: Ptr a -> Ptr b
58 castPtr (Ptr addr) = Ptr addr
59
60 -- |Advances the given address by the given offset in bytes.
61 plusPtr :: Ptr a -> Int -> Ptr b
62 plusPtr (Ptr addr) (I# d) = Ptr (plusAddr# addr d)
63
64 -- |Given an arbitrary address and an alignment constraint,
65 -- 'alignPtr' yields the next higher address that fulfills the
66 -- alignment constraint.  An alignment constraint @x@ is fulfilled by
67 -- any address divisible by @x@.  This operation is idempotent.
68 alignPtr :: Ptr a -> Int -> Ptr a
69 alignPtr addr@(Ptr a) (I# i)
70   = case remAddr# a i of {
71       0# -> addr;
72       n -> Ptr (plusAddr# a (i -# n)) }
73
74 -- |Computes the offset required to get from the second to the first
75 -- argument.  We have 
76 --
77 -- > p2 == p1 `plusPtr` (p2 `minusPtr` p1)
78 minusPtr :: Ptr a -> Ptr b -> Int
79 minusPtr (Ptr a1) (Ptr a2) = I# (minusAddr# a1 a2)
80
81 ------------------------------------------------------------------------
82 -- Function pointers for the default calling convention.
83
84 data FunPtr a = FunPtr Addr# deriving (Eq, Ord)
85 -- ^ A value of type @'FunPtr' a@ is a pointer to a function callable
86 -- from foreign code.  The type @a@ will normally be a /foreign type/,
87 -- a function type with zero or more arguments where
88 --
89 -- * the argument types are /marshallable foreign types/,
90 --   i.e. 'Char', 'Int', 'Double', 'Float',
91 --   'Bool', 'Data.Int.Int8', 'Data.Int.Int16', 'Data.Int.Int32',
92 --   'Data.Int.Int64', 'Data.Word.Word8', 'Data.Word.Word16',
93 --   'Data.Word.Word32', 'Data.Word.Word64', @'Ptr' a@, @'FunPtr' a@,
94 --   @'Foreign.StablePtr.StablePtr' a@ or a renaming of any of these
95 --   using @newtype@.
96 -- 
97 -- * the return type is either a marshallable foreign type or has the form
98 --   @'IO' t@ where @t@ is a marshallable foreign type or @()@.
99 --
100 -- A value of type @'FunPtr' a@ may be a pointer to a foreign function,
101 -- either returned by another foreign function or imported with a
102 -- a static address import like
103 --
104 -- > foreign import ccall "stdlib.h &free"
105 -- >   p_free :: FunPtr (Ptr a -> IO ())
106 --
107 -- or a pointer to a Haskell function created using a /wrapper/ stub
108 -- declared to produce a 'FunPtr' of the correct type.  For example:
109 --
110 -- > type Compare = Int -> Int -> Bool
111 -- > foreign import ccall "wrapper"
112 -- >   mkCompare :: Compare -> IO (FunPtr Compare)
113 --
114 -- Calls to wrapper stubs like @mkCompare@ allocate storage, which
115 -- should be released with 'Foreign.Ptr.freeHaskellFunPtr' when no
116 -- longer required.
117 --
118 -- To convert 'FunPtr' values to corresponding Haskell functions, one
119 -- can define a /dynamic/ stub for the specific foreign type, e.g.
120 --
121 -- > type IntFunction = CInt -> IO ()
122 -- > foreign import ccall "dynamic" 
123 -- >   mkFun :: FunPtr IntFunction -> IntFunction
124
125 -- |The constant 'nullFunPtr' contains a
126 -- distinguished value of 'FunPtr' that is not
127 -- associated with a valid memory location.
128 nullFunPtr :: FunPtr a
129 nullFunPtr = FunPtr nullAddr#
130
131 -- |Casts a 'FunPtr' to a 'FunPtr' of a different type.
132 castFunPtr :: FunPtr a -> FunPtr b
133 castFunPtr (FunPtr addr) = FunPtr addr
134
135 -- |Casts a 'FunPtr' to a 'Ptr'.
136 --
137 -- /Note:/ this is valid only on architectures where data and function
138 -- pointers range over the same set of addresses, and should only be used
139 -- for bindings to external libraries whose interface already relies on
140 -- this assumption.
141 castFunPtrToPtr :: FunPtr a -> Ptr b
142 castFunPtrToPtr (FunPtr addr) = Ptr addr
143
144 -- |Casts a 'Ptr' to a 'FunPtr'.
145 --
146 -- /Note:/ this is valid only on architectures where data and function
147 -- pointers range over the same set of addresses, and should only be used
148 -- for bindings to external libraries whose interface already relies on
149 -- this assumption.
150 castPtrToFunPtr :: Ptr a -> FunPtr b
151 castPtrToFunPtr (Ptr addr) = FunPtr addr
152
153
154 ------------------------------------------------------------------------
155 -- Show instances for Ptr and FunPtr
156
157 instance Show (Ptr a) where
158    showsPrec _ (Ptr a) rs = pad_out (showHex (wordToInteger(int2Word#(addr2Int# a))) "")
159      where
160         -- want 0s prefixed to pad it out to a fixed length.
161        pad_out ls = 
162           '0':'x':(replicate (2*SIZEOF_HSPTR - length ls) '0') ++ ls ++ rs
163
164 instance Show (FunPtr a) where
165    showsPrec p = showsPrec p . castFunPtrToPtr
166
167 \end{code}