[project @ 2005-03-14 15:22:51 by simonmar]

[ghc-base.git] / GHC / Int.hs

diff --git a/GHC/Int.hs b/GHC/Int.hs
index cd12594..e48656d 100644 (file)
--- a/GHC/Int.hs
+++ b/GHC/Int.hs
@@ -1,4 +1,4 @@
-{-# OPTIONS -fno-implicit-prelude #-}
+{-# OPTIONS_GHC -fno-implicit-prelude #-}
 -----------------------------------------------------------------------------
 -- |
 -- Module      :  GHC.Int
@@ -15,12 +15,14 @@
 
 #include "MachDeps.h"
 
+-- #hide
 module GHC.Int (
     Int8(..), Int16(..), Int32(..), Int64(..))
     where
 
 import Data.Bits
 
+import {-# SOURCE #-} GHC.Err
 import GHC.Base
 import GHC.Enum
 import GHC.Num
@@ -38,9 +40,7 @@ import GHC.Show
 -- and must ensure that it holds only values from its logical range.
 
 data Int8 = I8# Int# deriving (Eq, Ord)
-
-instance CCallable Int8
-instance CReturnable Int8
+-- ^ 8-bit signed integer type
 
 instance Show Int8 where
     showsPrec p x = showsPrec p (fromIntegral x :: Int)
@@ -79,24 +79,24 @@ instance Enum Int8 where
 instance Integral Int8 where
     quot    x@(I8# x#) y@(I8# y#)
         | y /= 0                  = I8# (narrow8Int# (x# `quotInt#` y#))
-        | otherwise               = divZeroError "quot{Int8}" x
+        | otherwise               = divZeroError
     rem     x@(I8# x#) y@(I8# y#)
         | y /= 0                  = I8# (narrow8Int# (x# `remInt#` y#))
-        | otherwise               = divZeroError "rem{Int8}" x
+        | otherwise               = divZeroError
     div     x@(I8# x#) y@(I8# y#)
         | y /= 0                  = I8# (narrow8Int# (x# `divInt#` y#))
-        | otherwise               = divZeroError "div{Int8}" x
+        | otherwise               = divZeroError
     mod     x@(I8# x#) y@(I8# y#)
         | y /= 0                  = I8# (narrow8Int# (x# `modInt#` y#))
-        | otherwise               = divZeroError "mod{Int8}" x
+        | otherwise               = divZeroError
     quotRem x@(I8# x#) y@(I8# y#)
         | y /= 0                  = (I8# (narrow8Int# (x# `quotInt#` y#)),
                                     I8# (narrow8Int# (x# `remInt#` y#)))
-        | otherwise               = divZeroError "quotRem{Int8}" x
+        | otherwise               = divZeroError
     divMod  x@(I8# x#) y@(I8# y#)
         | y /= 0                  = (I8# (narrow8Int# (x# `divInt#` y#)),
                                     I8# (narrow8Int# (x# `modInt#` y#)))
-        | otherwise               = divZeroError "divMod{Int8}" x
+        | otherwise               = divZeroError
     toInteger (I8# x#)            = S# x#
 
 instance Bounded Int8 where
@@ -146,9 +146,7 @@ instance Bits Int8 where
 -- and must ensure that it holds only values from its logical range.
 
 data Int16 = I16# Int# deriving (Eq, Ord)
-
-instance CCallable Int16
-instance CReturnable Int16
+-- ^ 16-bit signed integer type
 
 instance Show Int16 where
     showsPrec p x = showsPrec p (fromIntegral x :: Int)
@@ -187,24 +185,24 @@ instance Enum Int16 where
 instance Integral Int16 where
     quot    x@(I16# x#) y@(I16# y#)
         | y /= 0                  = I16# (narrow16Int# (x# `quotInt#` y#))
-        | otherwise               = divZeroError "quot{Int16}" x
+        | otherwise               = divZeroError
     rem     x@(I16# x#) y@(I16# y#)
         | y /= 0                  = I16# (narrow16Int# (x# `remInt#` y#))
-        | otherwise               = divZeroError "rem{Int16}" x
+        | otherwise               = divZeroError
     div     x@(I16# x#) y@(I16# y#)
         | y /= 0                  = I16# (narrow16Int# (x# `divInt#` y#))
-        | otherwise               = divZeroError "div{Int16}" x
+        | otherwise               = divZeroError
     mod     x@(I16# x#) y@(I16# y#)
         | y /= 0                  = I16# (narrow16Int# (x# `modInt#` y#))
-        | otherwise               = divZeroError "mod{Int16}" x
+        | otherwise               = divZeroError
     quotRem x@(I16# x#) y@(I16# y#)
         | y /= 0                  = (I16# (narrow16Int# (x# `quotInt#` y#)),
                                     I16# (narrow16Int# (x# `remInt#` y#)))
-        | otherwise               = divZeroError "quotRem{Int16}" x
+        | otherwise               = divZeroError
     divMod  x@(I16# x#) y@(I16# y#)
         | y /= 0                  = (I16# (narrow16Int# (x# `divInt#` y#)),
                                     I16# (narrow16Int# (x# `modInt#` y#)))
-        | otherwise               = divZeroError "divMod{Int16}" x
+        | otherwise               = divZeroError
     toInteger (I16# x#)           = S# x#
 
 instance Bounded Int16 where
@@ -255,6 +253,7 @@ instance Bits Int16 where
 #if WORD_SIZE_IN_BITS < 32
 
 data Int32 = I32# Int32#
+-- ^ 32-bit signed integer type
 
 instance Eq Int32 where
     (I32# x#) == (I32# y#) = x# `eqInt32#` y#
@@ -302,22 +301,22 @@ instance Enum Int32 where
 instance Integral Int32 where
     quot    x@(I32# x#) y@(I32# y#)
         | y /= 0                  = I32# (x# `quotInt32#` y#)
-        | otherwise               = divZeroError "quot{Int32}" x
+        | otherwise               = divZeroError
     rem     x@(I32# x#) y@(I32# y#)
         | y /= 0                  = I32# (x# `remInt32#` y#)
-        | otherwise               = divZeroError "rem{Int32}" x
+        | otherwise               = divZeroError
     div     x@(I32# x#) y@(I32# y#)
         | y /= 0                  = I32# (x# `divInt32#` y#)
-        | otherwise               = divZeroError "div{Int32}" x
+        | otherwise               = divZeroError
     mod     x@(I32# x#) y@(I32# y#)
         | y /= 0                  = I32# (x# `modInt32#` y#)
-        | otherwise               = divZeroError "mod{Int32}" x
+        | otherwise               = divZeroError
     quotRem x@(I32# x#) y@(I32# y#)
         | y /= 0                  = (I32# (x# `quotInt32#` y#), I32# (x# `remInt32#` y#))
-        | otherwise               = divZeroError "quotRem{Int32}" x
+        | otherwise               = divZeroError
     divMod  x@(I32# x#) y@(I32# y#)
         | y /= 0                  = (I32# (x# `divInt32#` y#), I32# (x# `modInt32#` y#))
-        | otherwise               = divZeroError "divMod{Int32}" x
+        | otherwise               = divZeroError
     toInteger x@(I32# x#)
        | x >= fromIntegral (minBound::Int) && x <= fromIntegral (maxBound::Int)
                                   = S# (int32ToInt# x#)
@@ -406,6 +405,7 @@ foreign import "stg_shiftRL32"     unsafe shiftRL32#     :: Word32# -> Int# -> W
 #endif
 
 data Int32 = I32# Int# deriving (Eq, Ord)
+-- ^ 32-bit signed integer type
 
 instance Show Int32 where
     showsPrec p x = showsPrec p (fromIntegral x :: Int)
@@ -445,24 +445,24 @@ instance Enum Int32 where
 instance Integral Int32 where
     quot    x@(I32# x#) y@(I32# y#)
         | y /= 0                  = I32# (narrow32Int# (x# `quotInt#` y#))
-        | otherwise               = divZeroError "quot{Int32}" x
+        | otherwise               = divZeroError
     rem     x@(I32# x#) y@(I32# y#)
         | y /= 0                  = I32# (narrow32Int# (x# `remInt#` y#))
-        | otherwise               = divZeroError "rem{Int32}" x
+        | otherwise               = divZeroError
     div     x@(I32# x#) y@(I32# y#)
         | y /= 0                  = I32# (narrow32Int# (x# `divInt#` y#))
-        | otherwise               = divZeroError "div{Int32}" x
+        | otherwise               = divZeroError
     mod     x@(I32# x#) y@(I32# y#)
         | y /= 0                  = I32# (narrow32Int# (x# `modInt#` y#))
-        | otherwise               = divZeroError "mod{Int32}" x
+        | otherwise               = divZeroError
     quotRem x@(I32# x#) y@(I32# y#)
         | y /= 0                  = (I32# (narrow32Int# (x# `quotInt#` y#)),
                                     I32# (narrow32Int# (x# `remInt#` y#)))
-        | otherwise               = divZeroError "quotRem{Int32}" x
+        | otherwise               = divZeroError
     divMod  x@(I32# x#) y@(I32# y#)
         | y /= 0                  = (I32# (narrow32Int# (x# `divInt#` y#)),
                                     I32# (narrow32Int# (x# `modInt#` y#)))
-        | otherwise               = divZeroError "divMod{Int32}" x
+        | otherwise               = divZeroError
     toInteger (I32# x#)           = S# x#
 
 instance Read Int32 where
@@ -500,9 +500,6 @@ instance Bits Int32 where
 
 #endif 
 
-instance CCallable Int32
-instance CReturnable Int32
-
 instance Real Int32 where
     toRational x = toInteger x % 1
 
@@ -523,6 +520,7 @@ instance Ix Int32 where
 #if WORD_SIZE_IN_BITS < 64
 
 data Int64 = I64# Int64#
+-- ^ 64-bit signed integer type
 
 instance Eq Int64 where
     (I64# x#) == (I64# y#) = x# `eqInt64#` y#
@@ -570,22 +568,22 @@ instance Enum Int64 where
 instance Integral Int64 where
     quot    x@(I64# x#) y@(I64# y#)
         | y /= 0                  = I64# (x# `quotInt64#` y#)
-        | otherwise               = divZeroError "quot{Int64}" x
+        | otherwise               = divZeroError
     rem     x@(I64# x#) y@(I64# y#)
         | y /= 0                  = I64# (x# `remInt64#` y#)
-        | otherwise               = divZeroError "rem{Int64}" x
+        | otherwise               = divZeroError
     div     x@(I64# x#) y@(I64# y#)
         | y /= 0                  = I64# (x# `divInt64#` y#)
-        | otherwise               = divZeroError "div{Int64}" x
+        | otherwise               = divZeroError
     mod     x@(I64# x#) y@(I64# y#)
         | y /= 0                  = I64# (x# `modInt64#` y#)
-        | otherwise               = divZeroError "mod{Int64}" x
+        | otherwise               = divZeroError
     quotRem x@(I64# x#) y@(I64# y#)
         | y /= 0                  = (I64# (x# `quotInt64#` y#), I64# (x# `remInt64#` y#))
-        | otherwise               = divZeroError "quotRem{Int64}" x
+        | otherwise               = divZeroError
     divMod  x@(I64# x#) y@(I64# y#)
         | y /= 0                  = (I64# (x# `divInt64#` y#), I64# (x# `modInt64#` y#))
-        | otherwise               = divZeroError "divMod{Int64}" x
+        | otherwise               = divZeroError
     toInteger x@(I64# x#)
        | x >= fromIntegral (minBound::Int) && x <= fromIntegral (maxBound::Int)
                                   = S# (int64ToInt# x#)
@@ -692,6 +690,7 @@ foreign import ccall unsafe "stg_integerToInt64"  integerToInt64#  :: Int# -> By
 -- from its logical range.
 
 data Int64 = I64# Int# deriving (Eq, Ord)
+-- ^ 64-bit signed integer type
 
 instance Show Int64 where
     showsPrec p x = showsPrec p (fromIntegral x :: Int)
@@ -724,22 +723,22 @@ instance Enum Int64 where
 instance Integral Int64 where
     quot    x@(I64# x#) y@(I64# y#)
         | y /= 0                  = I64# (x# `quotInt#` y#)
-        | otherwise               = divZeroError "quot{Int64}" x
+        | otherwise               = divZeroError
     rem     x@(I64# x#) y@(I64# y#)
         | y /= 0                  = I64# (x# `remInt#` y#)
-        | otherwise               = divZeroError "rem{Int64}" x
+        | otherwise               = divZeroError
     div     x@(I64# x#) y@(I64# y#)
         | y /= 0                  = I64# (x# `divInt#` y#)
-        | otherwise               = divZeroError "div{Int64}" x
+        | otherwise               = divZeroError
     mod     x@(I64# x#) y@(I64# y#)
         | y /= 0                  = I64# (x# `modInt#` y#)
-        | otherwise               = divZeroError "mod{Int64}" x
+        | otherwise               = divZeroError
     quotRem x@(I64# x#) y@(I64# y#)
         | y /= 0                  = (I64# (x# `quotInt#` y#), I64# (x# `remInt#` y#))
-        | otherwise               = divZeroError "quotRem{Int64}" x
+        | otherwise               = divZeroError
     divMod  x@(I64# x#) y@(I64# y#)
         | y /= 0                  = (I64# (x# `divInt#` y#), I64# (x# `modInt#` y#))
-        | otherwise               = divZeroError "divMod{Int64}" x
+        | otherwise               = divZeroError
     toInteger (I64# x#)           = S# x#
 
 instance Read Int64 where
@@ -772,9 +771,6 @@ instance Bits Int64 where
 
 #endif
 
-instance CCallable Int64
-instance CReturnable Int64
-
 instance Real Int64 where
     toRational x = toInteger x % 1