-{-# OPTIONS -fno-implicit-prelude #-}
+{-# OPTIONS_GHC -XNoImplicitPrelude #-}
-----------------------------------------------------------------------------
-- |
-- Module : Foreign.C.Types
-----------------------------------------------------------------------------
module Foreign.C.Types
- ( -- * Representations of C types
+ ( -- * Representations of C types
#ifndef __NHC__
- -- $ctypes
-
- -- ** Integral types
- -- | These types are are represented as @newtype@s of types in
- -- "Data.Int" and "Data.Word", and are instances of
- -- 'Eq', 'Ord', 'Num', 'Read', 'Show', 'Enum', 'Typeable',
- -- 'Storable', 'Bounded', 'Real', 'Integral' and 'Bits'.
- CChar, CSChar, CUChar
- , CShort, CUShort, CInt, CUInt
- , CLong, CULong
- , CPtrdiff, CSize, CWchar, CSigAtomic
+ -- $ctypes
+
+ -- ** Integral types
+ -- | These types are are represented as @newtype@s of
+ -- types in "Data.Int" and "Data.Word", and are instances of
+ -- 'Prelude.Eq', 'Prelude.Ord', 'Prelude.Num', 'Prelude.Read',
+ -- 'Prelude.Show', 'Prelude.Enum', 'Typeable', 'Storable',
+ -- 'Prelude.Bounded', 'Prelude.Real', 'Prelude.Integral' and
+ -- 'Bits'.
+ CChar, CSChar, CUChar
+ , CShort, CUShort, CInt, CUInt
+ , CLong, CULong
+ , CPtrdiff, CSize, CWchar, CSigAtomic
, CLLong, CULLong
-
- -- ** Numeric types
- -- | These types are are represented as @newtype@s of basic
- -- foreign types, and are instances of
- -- 'Eq', 'Ord', 'Num', 'Read', 'Show', 'Enum', 'Typeable' and
- -- 'Storable'.
- , CClock, CTime
-
- -- ** Floating types
- -- | These types are are represented as @newtype@s of 'Float'
- -- and 'Double', and are instances of
- -- 'Eq', 'Ord', 'Num', 'Read', 'Show', 'Enum', 'Typeable',
- -- 'Storable', 'Real', 'Fractional', 'Floating', 'RealFrac'
- -- and 'RealFloat'.
- , CFloat, CDouble, CLDouble
+ , CIntPtr, CUIntPtr
+ , CIntMax, CUIntMax
+
+ -- ** Numeric types
+ -- | These types are are represented as @newtype@s of basic
+ -- foreign types, and are instances of
+ -- 'Prelude.Eq', 'Prelude.Ord', 'Prelude.Num', 'Prelude.Read',
+ -- 'Prelude.Show', 'Prelude.Enum', 'Typeable' and 'Storable'.
+ , CClock, CTime
+
+ -- ** Floating types
+ -- | These types are are represented as @newtype@s of
+ -- 'Prelude.Float' and 'Prelude.Double', and are instances of
+ -- 'Prelude.Eq', 'Prelude.Ord', 'Prelude.Num', 'Prelude.Read',
+ -- 'Prelude.Show', 'Prelude.Enum', 'Typeable', 'Storable',
+ -- 'Prelude.Real', 'Prelude.Fractional', 'Prelude.Floating',
+ -- 'Prelude.RealFrac' and 'Prelude.RealFloat'.
+ , CFloat, CDouble, CLDouble
#else
- -- Exported non-abstractly in nhc98 to fix an interface file problem.
- CChar(..), CSChar(..), CUChar(..)
- , CShort(..), CUShort(..), CInt(..), CUInt(..)
- , CLong(..), CULong(..)
- , CPtrdiff(..), CSize(..), CWchar(..), CSigAtomic(..)
+ -- Exported non-abstractly in nhc98 to fix an interface file problem.
+ CChar(..), CSChar(..), CUChar(..)
+ , CShort(..), CUShort(..), CInt(..), CUInt(..)
+ , CLong(..), CULong(..)
+ , CPtrdiff(..), CSize(..), CWchar(..), CSigAtomic(..)
, CLLong(..), CULLong(..)
- , CClock(..), CTime(..)
- , CFloat(..), CDouble(..), CLDouble(..)
+ , CClock(..), CTime(..)
+ , CFloat(..), CDouble(..), CLDouble(..)
#endif
- -- ** Other types
+ -- ** Other types
-- Instances of: Eq and Storable
- , CFile, CFpos, CJmpBuf
- ) where
+ , CFile, CFpos, CJmpBuf
+ ) where
#ifndef __NHC__
-import Foreign.Storable
-import Data.Bits ( Bits(..) )
-import Data.Int ( Int8, Int16, Int32, Int64 )
-import Data.Word ( Word8, Word16, Word32, Word64 )
-import Data.Typeable
+import {-# SOURCE #-} Foreign.Storable
+import Data.Bits ( Bits(..) )
+import Data.Int ( Int8, Int16, Int32, Int64 )
+import Data.Word ( Word8, Word16, Word32, Word64 )
+import {-# SOURCE #-} Data.Typeable
#ifdef __GLASGOW_HASKELL__
import GHC.Base
import GHC.Read
import GHC.Num
#else
-import Control.Monad
-import Foreign.Ptr
+import Control.Monad ( liftM )
+#endif
+
+#ifdef __HUGS__
+import Hugs.Ptr ( castPtr )
#endif
-#include "Typeable.h"
+#include "HsBaseConfig.h"
#include "CTypes.h"
-- | Haskell type representing the C @char@ type.
-- | Haskell type representing the C @clock_t@ type.
ARITHMETIC_TYPE(CClock,tyConCClock,"CClock",HTYPE_CLOCK_T)
-- | Haskell type representing the C @time_t@ type.
+--
+-- To convert to a @Data.Time.UTCTime@, use the following formula:
+--
+-- > posixSecondsToUTCTime (realToFrac :: POSIXTime)
+--
ARITHMETIC_TYPE(CTime,tyConCTime,"CTime",HTYPE_TIME_T)
-- FIXME: Implement and provide instances for Eq and Storable
-- | Haskell type representing the C @jmp_buf@ type.
data CJmpBuf = CJmpBuf
+INTEGRAL_TYPE(CIntPtr,tyConCIntPtr,"CIntPtr",HTYPE_INTPTR_T)
+INTEGRAL_TYPE(CUIntPtr,tyConCUIntPtr,"CUIntPtr",HTYPE_UINTPTR_T)
+INTEGRAL_TYPE(CIntMax,tyConCIntMax,"CIntMax",HTYPE_INTMAX_T)
+INTEGRAL_TYPE(CUIntMax,tyConCUIntMax,"CUIntMax",HTYPE_UINTMAX_T)
+
+{-# RULES
+"fromIntegral/a->CIntPtr" fromIntegral = \x -> CIntPtr (fromIntegral x)
+"fromIntegral/a->CUIntPtr" fromIntegral = \x -> CUIntPtr (fromIntegral x)
+"fromIntegral/a->CIntMax" fromIntegral = \x -> CIntMax (fromIntegral x)
+"fromIntegral/a->CUIntMax" fromIntegral = \x -> CUIntMax (fromIntegral x)
+ #-}
+
-- C99 types which are still missing include:
--- intptr_t, uintptr_t, intmax_t, uintmax_t, wint_t, wctrans_t, wctype_t
+-- wint_t, wctrans_t, wctype_t
{- $ctypes
following guarantees are provided concerning a Haskell type @CT@
representing a C type @t@:
-* If a C function prototype has @t@ as an argument or result type,
- the use of @CT@ in the corresponding position in a foreign declaration
- permits the Haskell program to access the full range of values encoded by
- the C type; and conversely, any Haskell value for @CT@ has a valid
+* If a C function prototype has @t@ as an argument or result type, the
+ use of @CT@ in the corresponding position in a foreign declaration
+ permits the Haskell program to access the full range of values encoded
+ by the C type; and conversely, any Haskell value for @CT@ has a valid
representation in C.
-* @'sizeOf' ('undefined' :: CT)@ will yield the same value as
+* @'sizeOf' ('Prelude.undefined' :: CT)@ will yield the same value as
@sizeof (t)@ in C.
-* @'alignment' ('undefined' :: CT)@ matches the alignment constraint
- enforced by the C implementation for @t@.
+* @'alignment' ('Prelude.undefined' :: CT)@ matches the alignment
+ constraint enforced by the C implementation for @t@.
-* The members 'peek' and 'poke' of the 'Storable' class map all values of
- @CT@ to the corresponding value of @t@ and vice versa.
+* The members 'peek' and 'poke' of the 'Storable' class map all values
+ of @CT@ to the corresponding value of @t@ and vice versa.
-* When an instance of 'Bounded' is defined for @CT@, the values of
- 'minBound' and 'maxBound' coincide with @t_MIN@ and @t_MAX@ in C.
+* When an instance of 'Prelude.Bounded' is defined for @CT@, the values
+ of 'Prelude.minBound' and 'Prelude.maxBound' coincide with @t_MIN@
+ and @t_MAX@ in C.
-* When an instance of 'Eq' or 'Ord' is defined for @CT@, the predicates
- defined by the type class implement the same relation as the
- corresponding predicate in C on @t@.
+* When an instance of 'Prelude.Eq' or 'Prelude.Ord' is defined for @CT@,
+ the predicates defined by the type class implement the same relation
+ as the corresponding predicate in C on @t@.
-* When an instance of 'Num', 'Read', 'Integral', 'Fractional', 'Floating',
- 'RealFrac', or 'RealFloat' is defined for @CT@, the arithmetic
- operations defined by the type class implement the same function as
- the corresponding arithmetic operations (if available) in C on @t@.
+* When an instance of 'Prelude.Num', 'Prelude.Read', 'Prelude.Integral',
+ 'Prelude.Fractional', 'Prelude.Floating', 'Prelude.RealFrac', or
+ 'Prelude.RealFloat' is defined for @CT@, the arithmetic operations
+ defined by the type class implement the same function as the
+ corresponding arithmetic operations (if available) in C on @t@.
* When an instance of 'Bits' is defined for @CT@, the bitwise operation
defined by the type class implement the same function as the
-}
-#else /* __NHC__ */
+#else /* __NHC__ */
import NHC.FFI
( CChar(..), CSChar(..), CUChar(..)