X-Git-Url: http://git.megacz.com/?a=blobdiff_plain;f=Foreign%2FC%2FTypes.hs;h=f6bdec1b6bd1be3ef23fa1e696bab6464db2e9c3;hb=24617fc54416bdb7ec77c63d868a9de7a9ae313b;hp=c4be5a7fe763bc0a36922a25755e14baf138813e;hpb=33a64642f17054fa3b194e40b3819a1846bee24e;p=ghc-base.git diff --git a/Foreign/C/Types.hs b/Foreign/C/Types.hs index c4be5a7..f6bdec1 100644 --- a/Foreign/C/Types.hs +++ b/Foreign/C/Types.hs @@ -1,4 +1,15 @@ -{-# OPTIONS -fno-implicit-prelude #-} +{-# LANGUAGE CPP + , NoImplicitPrelude + , MagicHash + , GeneralizedNewtypeDeriving + #-} +{-# OPTIONS_GHC -fno-warn-unused-binds #-} +#ifdef __GLASGOW_HASKELL__ +{-# LANGUAGE DeriveDataTypeable, StandaloneDeriving #-} +#endif +-- XXX -fno-warn-unused-binds stops us warning about unused constructors, +-- but really we should just remove them if we don't want them + ----------------------------------------------------------------------------- -- | -- Module : Foreign.C.Types @@ -14,58 +25,76 @@ ----------------------------------------------------------------------------- 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, CUSeconds, CSUSeconds + + -- extracted from CTime, because we don't want this comment in + -- the Haskell 2010 report: + + -- | To convert 'CTime' to 'Data.Time.UTCTime', use the following formula: + -- + -- > posixSecondsToUTCTime (realToFrac :: POSIXTime) + -- + + -- ** 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 +-- GHC doesn't support CLDouble yet +#ifndef __GLASGOW_HASKELL__ + , CLDouble +#endif #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(..), CUSeconds(..), CSUSeconds(..) + , CFloat(..), CDouble(..), CLDouble(..) + , CIntPtr(..), CUIntPtr(..), CIntMax(..), CUIntMax(..) #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 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 @@ -76,11 +105,14 @@ import GHC.Show 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. @@ -140,20 +172,25 @@ INTEGRAL_TYPE(CULLong,tyConCULLong,"CULLong",HTYPE_UNSIGNED_LONG_LONG) FLOATING_TYPE(CFloat,tyConCFloat,"CFloat",HTYPE_FLOAT) -- | Haskell type representing the C @double@ type. FLOATING_TYPE(CDouble,tyConCDouble,"CDouble",HTYPE_DOUBLE) +-- GHC doesn't support CLDouble yet +#ifndef __GLASGOW_HASKELL__ -- HACK: Currently no long double in the FFI, so we simply re-use double -- | Haskell type representing the C @long double@ type. FLOATING_TYPE(CLDouble,tyConCLDouble,"CLDouble",HTYPE_DOUBLE) +#endif {-# RULES "realToFrac/a->CFloat" realToFrac = \x -> CFloat (realToFrac x) "realToFrac/a->CDouble" realToFrac = \x -> CDouble (realToFrac x) -"realToFrac/a->CLDouble" realToFrac = \x -> CLDouble (realToFrac x) "realToFrac/CFloat->a" realToFrac = \(CFloat x) -> realToFrac x "realToFrac/CDouble->a" realToFrac = \(CDouble x) -> realToFrac x -"realToFrac/CLDouble->a" realToFrac = \(CLDouble x) -> realToFrac x #-} +-- GHC doesn't support CLDouble yet +-- "realToFrac/a->CLDouble" realToFrac = \x -> CLDouble (realToFrac x) +-- "realToFrac/CLDouble->a" realToFrac = \(CLDouble x) -> realToFrac x + -- | Haskell type representing the C @ptrdiff_t@ type. INTEGRAL_TYPE(CPtrdiff,tyConCPtrdiff,"CPtrdiff",HTYPE_PTRDIFF_T) -- | Haskell type representing the C @size_t@ type. @@ -178,7 +215,12 @@ INTEGRAL_TYPE(CSigAtomic,tyConCSigAtomic,"CSigAtomic",HTYPE_SIG_ATOMIC_T) -- | Haskell type representing the C @clock_t@ type. ARITHMETIC_TYPE(CClock,tyConCClock,"CClock",HTYPE_CLOCK_T) -- | Haskell type representing the C @time_t@ type. +-- ARITHMETIC_TYPE(CTime,tyConCTime,"CTime",HTYPE_TIME_T) +-- | Haskell type representing the C @useconds_t@ type. +ARITHMETIC_TYPE(CUSeconds,tyConCUSeconds,"CUSeconds",HTYPE_USECONDS_T) +-- | Haskell type representing the C @suseconds_t@ type. +ARITHMETIC_TYPE(CSUSeconds,tyConCSUSeconds,"CSUSeconds",HTYPE_SUSECONDS_T) -- FIXME: Implement and provide instances for Eq and Storable -- | Haskell type representing the C @FILE@ type. @@ -188,8 +230,20 @@ data CFpos = CFpos -- | 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 @@ -199,32 +253,34 @@ is not required to represent those types exactly as C does, but the 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 @@ -232,15 +288,16 @@ representing a C type @t@: -} -#else /* __NHC__ */ +#else /* __NHC__ */ import NHC.FFI ( CChar(..), CSChar(..), CUChar(..) , CShort(..), CUShort(..), CInt(..), CUInt(..) , CLong(..), CULong(..), CLLong(..), CULLong(..) , CPtrdiff(..), CSize(..), CWchar(..), CSigAtomic(..) - , CClock(..), CTime(..) + , CClock(..), CTime(..), CUSeconds(..), CSUSeconds(..) , CFloat(..), CDouble(..), CLDouble(..) + , CIntPtr(..), CUIntPtr(..),CIntMax(..), CUIntMax(..) , CFile, CFpos, CJmpBuf , Storable(..) ) @@ -278,5 +335,9 @@ INSTANCE_BITS(CPtrdiff) INSTANCE_BITS(CWchar) INSTANCE_BITS(CSigAtomic) INSTANCE_BITS(CSize) +INSTANCE_BITS(CIntPtr) +INSTANCE_BITS(CUIntPtr) +INSTANCE_BITS(CIntMax) +INSTANCE_BITS(CUIntMax) #endif