ghc/lib/std/PrelWord.lhs

   1 %
   2 % (c) The University of Glasgow, 1997-2001
   3 %
   4 \section[PrelWord]{Module @PrelWord@}
   5
   6 \begin{code}
   7 {-# OPTIONS -monly-3-regs #-}
   8
   9 #include "MachDeps.h"
  10
  11 module PrelWord (
  12     Word(..), Word8(..), Word16(..), Word32(..), Word64(..),
  13     divZeroError, toEnumError, fromEnumError, succError, predError)
  14     where
  15
  16 import PrelBase
  17 import PrelEnum
  18 import PrelNum
  19 import PrelReal
  20 import PrelRead
  21 import PrelArr
  22 import PrelBits
  23
  24 ------------------------------------------------------------------------
  25 -- Helper functions
  26 ------------------------------------------------------------------------
  27
  28 {-# NOINLINE divZeroError #-}
  29 divZeroError :: (Show a) => String -> a -> b
  30 divZeroError meth x =
  31     error $ "Integral." ++ meth ++ ": divide by 0 (" ++ show x ++ " / 0)"
  32
  33 {-# NOINLINE toEnumError #-}
  34 toEnumError :: (Show a) => String -> Int -> (a,a) -> b
  35 toEnumError inst_ty i bnds =
  36     error $ "Enum.toEnum{" ++ inst_ty ++ "}: tag (" ++
  37             show i ++
  38             ") is outside of bounds " ++
  39             show bnds
  40
  41 {-# NOINLINE fromEnumError #-}
  42 fromEnumError :: (Show a) => String -> a -> b
  43 fromEnumError inst_ty x =
  44     error $ "Enum.fromEnum{" ++ inst_ty ++ "}: value (" ++
  45             show x ++
  46             ") is outside of Int's bounds " ++
  47             show (minBound::Int, maxBound::Int)
  48
  49 {-# NOINLINE succError #-}
  50 succError :: String -> a
  51 succError inst_ty =
  52     error $ "Enum.succ{" ++ inst_ty ++ "}: tried to take `succ' of maxBound"
  53
  54 {-# NOINLINE predError #-}
  55 predError :: String -> a
  56 predError inst_ty =
  57     error $ "Enum.pred{" ++ inst_ty ++ "}: tried to take `pred' of minBound"
  58
  59 ------------------------------------------------------------------------
  60 -- type Word
  61 ------------------------------------------------------------------------
  62
  63 -- A Word is an unsigned integral type, with the same size as Int.
  64
  65 data Word = W# Word# deriving (Eq, Ord)
  66
  67 instance CCallable Word
  68 instance CReturnable Word
  69
  70 instance Show Word where
  71     showsPrec p x = showsPrec p (toInteger x)
  72
  73 instance Num Word where
  74     (W# x#) + (W# y#)      = W# (x# `plusWord#` y#)
  75     (W# x#) - (W# y#)      = W# (x# `minusWord#` y#)
  76     (W# x#) * (W# y#)      = W# (x# `timesWord#` y#)
  77     negate (W# x#)         = W# (int2Word# (negateInt# (word2Int# x#)))
  78     abs x                  = x
  79     signum 0               = 0
  80     signum _               = 1
  81     fromInteger (S# i#)    = W# (int2Word# i#)
  82     fromInteger (J# s# d#) = W# (integer2Word# s# d#)
  83
  84 instance Real Word where
  85     toRational x = toInteger x % 1
  86
  87 instance Enum Word where
  88     succ x
  89         | x /= maxBound = x + 1
  90         | otherwise     = succError "Word"
  91     pred x
  92         | x /= minBound = x - 1
  93         | otherwise     = predError "Word"
  94     toEnum i@(I# i#)
  95         | i >= 0        = W# (int2Word# i#)
  96         | otherwise     = toEnumError "Word" i (minBound::Word, maxBound::Word)
  97     fromEnum x@(W# x#)
  98         | x <= fromIntegral (maxBound::Int)
  99                         = I# (word2Int# x#)
 100         | otherwise     = fromEnumError "Word" x
 101     enumFrom            = integralEnumFrom
 102     enumFromThen        = integralEnumFromThen
 103
 104 instance Integral Word where
 105     quot    x@(W# x#) y@(W# y#)
 106         | y /= 0                = W# (x# `quotWord#` y#)
 107         | otherwise             = divZeroError "quot{Word}" x
 108     rem     x@(W# x#) y@(W# y#)
 109         | y /= 0                = W# (x# `remWord#` y#)
 110         | otherwise             = divZeroError "rem{Word}" x
 111     div     x@(W# x#) y@(W# y#)
 112         | y /= 0                = W# (x# `quotWord#` y#)
 113         | otherwise             = divZeroError "div{Word}" x
 114     mod     x@(W# x#) y@(W# y#)
 115         | y /= 0                = W# (x# `remWord#` y#)
 116         | otherwise             = divZeroError "mod{Word}" x
 117     quotRem x@(W# x#) y@(W# y#)
 118         | y /= 0                = (W# (x# `quotWord#` y#), W# (x# `remWord#` y#))
 119         | otherwise             = divZeroError "quotRem{Word}" x
 120     divMod  x@(W# x#) y@(W# y#)
 121         | y /= 0                = (W# (x# `quotWord#` y#), W# (x# `remWord#` y#))
 122         | otherwise             = divZeroError "divMod{Word}" x
 123     toInteger (W# x#)
 124         | i# >=# 0#             = S# i#
 125         | otherwise             = case word2Integer# x# of (# s, d #) -> J# s d
 126         where
 127         i# = word2Int# x#
 128
 129 instance Bounded Word where
 130     minBound = 0
 131 #if WORD_SIZE_IN_BYTES == 4
 132     maxBound = 0xFFFFFFFF
 133 #else
 134     maxBound = 0xFFFFFFFFFFFFFFFF
 135 #endif
 136
 137 instance Ix Word where
 138     range (m,n)       = [m..n]
 139     index b@(m,_) i
 140         | inRange b i = fromIntegral (i - m)
 141         | otherwise   = indexError b i "Word"
 142     inRange (m,n) i   = m <= i && i <= n
 143
 144 instance Read Word where
 145     readsPrec p s = [(fromInteger x, r) | (x, r) <- readsPrec p s]
 146
 147 instance Bits Word where
 148     (W# x#) .&.   (W# y#)    = W# (x# `and#` y#)
 149     (W# x#) .|.   (W# y#)    = W# (x# `or#`  y#)
 150     (W# x#) `xor` (W# y#)    = W# (x# `xor#` y#)
 151     complement (W# x#)       = W# (x# `xor#` mb#) where W# mb# = maxBound
 152     (W# x#) `shift` (I# i#)
 153         | i# >=# 0#          = W# (x# `shiftL#` i#)
 154         | otherwise          = W# (x# `shiftRL#` negateInt# i#)
 155 #if WORD_SIZE_IN_BYTES == 4
 156     (W# x#) `rotate` (I# i#) = W# ((x# `shiftL#` i'#) `or#` (x# `shiftRL#` (32# -# i'#)))
 157         where
 158         i'# = word2Int# (int2Word# i# `and#` int2Word# 31#)
 159 #else
 160     (W# x#) `rotate` (I# i#) = W# ((x# `shiftL#` i'#) `or#` (x# `shiftRL#` (64# -# i'#)))
 161         where
 162         i'# = word2Int# (int2Word# i# `and#` int2Word# 63#)
 163 #endif
 164     bitSize  _               = WORD_SIZE_IN_BYTES * 8
 165     isSigned _               = False
 166
 167 {-# RULES
 168 "fromIntegral/Int->Word"  fromIntegral = \(I# x#) -> W# (int2Word# x#)
 169 "fromIntegral/Word->Int"  fromIntegral = \(W# x#) -> I# (word2Int# x#)
 170 "fromIntegral/Word->Word" fromIntegral = id :: Word -> Word
 171     #-}
 172
 173 ------------------------------------------------------------------------
 174 -- type Word8
 175 ------------------------------------------------------------------------
 176
 177 -- Word8 is represented in the same way as Word. Operations may assume
 178 -- and must ensure that it holds only values from its logical range.
 179
 180 data Word8 = W8# Word# deriving (Eq, Ord)
 181
 182 instance CCallable Word8
 183 instance CReturnable Word8
 184
 185 instance Show Word8 where
 186     showsPrec p x = showsPrec p (fromIntegral x :: Int)
 187
 188 instance Num Word8 where
 189     (W8# x#) + (W8# y#)    = W8# (wordToWord8# (x# `plusWord#` y#))
 190     (W8# x#) - (W8# y#)    = W8# (wordToWord8# (x# `minusWord#` y#))
 191     (W8# x#) * (W8# y#)    = W8# (wordToWord8# (x# `timesWord#` y#))
 192     negate (W8# x#)        = W8# (wordToWord8# (int2Word# (negateInt# (word2Int# x#))))
 193     abs x                  = x
 194     signum 0               = 0
 195     signum _               = 1
 196     fromInteger (S# i#)    = W8# (wordToWord8# (int2Word# i#))
 197     fromInteger (J# s# d#) = W8# (wordToWord8# (integer2Word# s# d#))
 198
 199 instance Real Word8 where
 200     toRational x = toInteger x % 1
 201
 202 instance Enum Word8 where
 203     succ x
 204         | x /= maxBound = x + 1
 205         | otherwise     = succError "Word8"
 206     pred x
 207         | x /= minBound = x - 1
 208         | otherwise     = predError "Word8"
 209     toEnum i@(I# i#)
 210         | i >= 0 && i <= fromIntegral (maxBound::Word8)
 211                         = W8# (int2Word# i#)
 212         | otherwise     = toEnumError "Word8" i (minBound::Word8, maxBound::Word8)
 213     fromEnum (W8# x#)   = I# (word2Int# x#)
 214     enumFrom            = boundedEnumFrom
 215     enumFromThen        = boundedEnumFromThen
 216
 217 instance Integral Word8 where
 218     quot    x@(W8# x#) y@(W8# y#)
 219         | y /= 0                  = W8# (x# `quotWord#` y#)
 220         | otherwise               = divZeroError "quot{Word8}" x
 221     rem     x@(W8# x#) y@(W8# y#)
 222         | y /= 0                  = W8# (x# `remWord#` y#)
 223         | otherwise               = divZeroError "rem{Word8}" x
 224     div     x@(W8# x#) y@(W8# y#)
 225         | y /= 0                  = W8# (x# `quotWord#` y#)
 226         | otherwise               = divZeroError "div{Word8}" x
 227     mod     x@(W8# x#) y@(W8# y#)
 228         | y /= 0                  = W8# (x# `remWord#` y#)
 229         | otherwise               = divZeroError "mod{Word8}" x
 230     quotRem x@(W8# x#) y@(W8# y#)
 231         | y /= 0                  = (W8# (x# `quotWord#` y#), W8# (x# `remWord#` y#))
 232         | otherwise               = divZeroError "quotRem{Word8}" x
 233     divMod  x@(W8# x#) y@(W8# y#)
 234         | y /= 0                  = (W8# (x# `quotWord#` y#), W8# (x# `remWord#` y#))
 235         | otherwise               = divZeroError "quotRem{Word8}" x
 236     toInteger (W8# x#)            = S# (word2Int# x#)
 237
 238 instance Bounded Word8 where
 239     minBound = 0
 240     maxBound = 0xFF
 241
 242 instance Ix Word8 where
 243     range (m,n)       = [m..n]
 244     index b@(m,_) i
 245         | inRange b i = fromIntegral (i - m)
 246         | otherwise   = indexError b i "Word8"
 247     inRange (m,n) i   = m <= i && i <= n
 248
 249 instance Read Word8 where
 250     readsPrec p s = [(fromIntegral (x::Int), r) | (x, r) <- readsPrec p s]
 251
 252 instance Bits Word8 where
 253     (W8# x#) .&.   (W8# y#)   = W8# (x# `and#` y#)
 254     (W8# x#) .|.   (W8# y#)   = W8# (x# `or#`  y#)
 255     (W8# x#) `xor` (W8# y#)   = W8# (x# `xor#` y#)
 256     complement (W8# x#)       = W8# (x# `xor#` mb#) where W8# mb# = maxBound
 257     (W8# x#) `shift` (I# i#)
 258         | i# >=# 0#           = W8# (wordToWord8# (x# `shiftL#` i#))
 259         | otherwise           = W8# (x# `shiftRL#` negateInt# i#)
 260     (W8# x#) `rotate` (I# i#) = W8# (wordToWord8# ((x# `shiftL#` i'#) `or#`
 261                                                    (x# `shiftRL#` (8# -# i'#))))
 262         where
 263         i'# = word2Int# (int2Word# i# `and#` int2Word# 7#)
 264     bitSize  _                = 8
 265     isSigned _                = False
 266
 267 {-# RULES
 268 "fromIntegral/a->Word8" fromIntegral = \x -> case fromIntegral x of W# x# -> W8# (wordToWord8# x#)
 269 "fromIntegral/Word8->a" fromIntegral = \(W8# x#) -> fromIntegral (W# x#)
 270     #-}
 271
 272 ------------------------------------------------------------------------
 273 -- type Word16
 274 ------------------------------------------------------------------------
 275
 276 -- Word16 is represented in the same way as Word. Operations may assume
 277 -- and must ensure that it holds only values from its logical range.
 278
 279 data Word16 = W16# Word# deriving (Eq, Ord)
 280
 281 instance CCallable Word16
 282 instance CReturnable Word16
 283
 284 instance Show Word16 where
 285     showsPrec p x = showsPrec p (fromIntegral x :: Int)
 286
 287 instance Num Word16 where
 288     (W16# x#) + (W16# y#)  = W16# (wordToWord16# (x# `plusWord#` y#))
 289     (W16# x#) - (W16# y#)  = W16# (wordToWord16# (x# `minusWord#` y#))
 290     (W16# x#) * (W16# y#)  = W16# (wordToWord16# (x# `timesWord#` y#))
 291     negate (W16# x#)       = W16# (wordToWord16# (int2Word# (negateInt# (word2Int# x#))))
 292     abs x                  = x
 293     signum 0               = 0
 294     signum _               = 1
 295     fromInteger (S# i#)    = W16# (wordToWord16# (int2Word# i#))
 296     fromInteger (J# s# d#) = W16# (wordToWord16# (integer2Word# s# d#))
 297
 298 instance Real Word16 where
 299     toRational x = toInteger x % 1
 300
 301 instance Enum Word16 where
 302     succ x
 303         | x /= maxBound = x + 1
 304         | otherwise     = succError "Word16"
 305     pred x
 306         | x /= minBound = x - 1
 307         | otherwise     = predError "Word16"
 308     toEnum i@(I# i#)
 309         | i >= 0 && i <= fromIntegral (maxBound::Word16)
 310                         = W16# (int2Word# i#)
 311         | otherwise     = toEnumError "Word16" i (minBound::Word16, maxBound::Word16)
 312     fromEnum (W16# x#)  = I# (word2Int# x#)
 313     enumFrom            = boundedEnumFrom
 314     enumFromThen        = boundedEnumFromThen
 315
 316 instance Integral Word16 where
 317     quot    x@(W16# x#) y@(W16# y#)
 318         | y /= 0                    = W16# (x# `quotWord#` y#)
 319         | otherwise                 = divZeroError "quot{Word16}" x
 320     rem     x@(W16# x#) y@(W16# y#)
 321         | y /= 0                    = W16# (x# `remWord#` y#)
 322         | otherwise                 = divZeroError "rem{Word16}" x
 323     div     x@(W16# x#) y@(W16# y#)
 324         | y /= 0                    = W16# (x# `quotWord#` y#)
 325         | otherwise                 = divZeroError "div{Word16}" x
 326     mod     x@(W16# x#) y@(W16# y#)
 327         | y /= 0                    = W16# (x# `remWord#` y#)
 328         | otherwise                 = divZeroError "mod{Word16}" x
 329     quotRem x@(W16# x#) y@(W16# y#)
 330         | y /= 0                    = (W16# (x# `quotWord#` y#), W16# (x# `remWord#` y#))
 331         | otherwise                 = divZeroError "quotRem{Word16}" x
 332     divMod  x@(W16# x#) y@(W16# y#)
 333         | y /= 0                    = (W16# (x# `quotWord#` y#), W16# (x# `remWord#` y#))
 334         | otherwise                 = divZeroError "quotRem{Word16}" x
 335     toInteger (W16# x#)             = S# (word2Int# x#)
 336
 337 instance Bounded Word16 where
 338     minBound = 0
 339     maxBound = 0xFFFF
 340
 341 instance Ix Word16 where
 342     range (m,n)       = [m..n]
 343     index b@(m,_) i
 344         | inRange b i = fromIntegral (i - m)
 345         | otherwise   = indexError b i "Word16"
 346     inRange (m,n) i   = m <= i && i <= n
 347
 348 instance Read Word16 where
 349     readsPrec p s = [(fromIntegral (x::Int), r) | (x, r) <- readsPrec p s]
 350
 351 instance Bits Word16 where
 352     (W16# x#) .&.   (W16# y#)  = W16# (x# `and#` y#)
 353     (W16# x#) .|.   (W16# y#)  = W16# (x# `or#`  y#)
 354     (W16# x#) `xor` (W16# y#)  = W16# (x# `xor#` y#)
 355     complement (W16# x#)       = W16# (x# `xor#` mb#) where W16# mb# = maxBound
 356     (W16# x#) `shift` (I# i#)
 357         | i# >=# 0#            = W16# (wordToWord16# (x# `shiftL#` i#))
 358         | otherwise            = W16# (x# `shiftRL#` negateInt# i#)
 359     (W16# x#) `rotate` (I# i#) = W16# (wordToWord16# ((x# `shiftL#` i'#) `or#`
 360                                                       (x# `shiftRL#` (16# -# i'#))))
 361         where
 362         i'# = word2Int# (int2Word# i# `and#` int2Word# 15#)
 363     bitSize  _                = 16
 364     isSigned _                = False
 365
 366 {-# RULES
 367 "fromIntegral/a->Word16" fromIntegral = \x -> case fromIntegral x of W# x# -> W16# (wordToWord16# x#)
 368 "fromIntegral/Word16->a" fromIntegral = \(W16# x#) -> fromIntegral (W# x#)
 369     #-}
 370
 371 ------------------------------------------------------------------------
 372 -- type Word32
 373 ------------------------------------------------------------------------
 374
 375 -- Word32 is represented in the same way as Word.
 376 #if WORD_SIZE_IN_BYTES == 8
 377 -- Operations may assume and must ensure that it holds only values
 378 -- from its logical range.
 379 #endif
 380
 381 data Word32 = W32# Word# deriving (Eq, Ord)
 382
 383 #if WORD_SIZE_IN_BYTES == 4
 384 {-# RULES "wordToWord32#" forall x#. wordToWord32# x# = x# #-}
 385 #endif
 386
 387 instance CCallable Word32
 388 instance CReturnable Word32
 389
 390 instance Show Word32 where
 391 #if WORD_SIZE_IN_BYTES == 4
 392     showsPrec p x = showsPrec p (toInteger x)
 393 #else
 394     showsPrec p x = showsPrec p (fromIntegral x :: Int)
 395 #endif
 396
 397 instance Num Word32 where
 398     (W32# x#) + (W32# y#)  = W32# (wordToWord32# (x# `plusWord#` y#))
 399     (W32# x#) - (W32# y#)  = W32# (wordToWord32# (x# `minusWord#` y#))
 400     (W32# x#) * (W32# y#)  = W32# (wordToWord32# (x# `timesWord#` y#))
 401     negate (W32# x#)       = W32# (wordToWord32# (int2Word# (negateInt# (word2Int# x#))))
 402     abs x                  = x
 403     signum 0               = 0
 404     signum _               = 1
 405     fromInteger (S# i#)    = W32# (wordToWord32# (int2Word# i#))
 406     fromInteger (J# s# d#) = W32# (wordToWord32# (integer2Word# s# d#))
 407
 408 instance Real Word32 where
 409     toRational x = toInteger x % 1
 410
 411 instance Enum Word32 where
 412     succ x
 413         | x /= maxBound = x + 1
 414         | otherwise     = succError "Word32"
 415     pred x
 416         | x /= minBound = x - 1
 417         | otherwise     = predError "Word32"
 418     toEnum i@(I# i#)
 419         | i >= 0
 420 #if WORD_SIZE_IN_BYTES == 8
 421           && i <= fromIntegral (maxBound::Word32)
 422 #endif
 423                         = W32# (int2Word# i#)
 424         | otherwise     = toEnumError "Word32" i (minBound::Word32, maxBound::Word32)
 425 #if WORD_SIZE_IN_BYTES == 4
 426     fromEnum (W32# x#)  = I# (word2Int# x#)
 427     enumFrom            = integralEnumFrom
 428     enumFromThen        = integralEnumFromThen
 429 #else
 430     fromEnum x@(W32# x#)
 431         | x <= fromIntegral (maxBound::Int)
 432                         = I# (word2Int# x#)
 433         | otherwise     = fromEnumError "Word32" x
 434     enumFrom            = boundedEnumFrom
 435     enumFromThen        = boundedEnumFromThen
 436 #endif
 437
 438 instance Integral Word32 where
 439     quot    x@(W32# x#) y@(W32# y#)
 440         | y /= 0                    = W32# (x# `quotWord#` y#)
 441         | otherwise                 = divZeroError "quot{Word32}" x
 442     rem     x@(W32# x#) y@(W32# y#)
 443         | y /= 0                    = W32# (x# `remWord#` y#)
 444         | otherwise                 = divZeroError "rem{Word32}" x
 445     div     x@(W32# x#) y@(W32# y#)
 446         | y /= 0                    = W32# (x# `quotWord#` y#)
 447         | otherwise                 = divZeroError "div{Word32}" x
 448     mod     x@(W32# x#) y@(W32# y#)
 449         | y /= 0                    = W32# (x# `remWord#` y#)
 450         | otherwise                 = divZeroError "mod{Word32}" x
 451     quotRem x@(W32# x#) y@(W32# y#)
 452         | y /= 0                    = (W32# (x# `quotWord#` y#), W32# (x# `remWord#` y#))
 453         | otherwise                 = divZeroError "quotRem{Word32}" x
 454     divMod  x@(W32# x#) y@(W32# y#)
 455         | y /= 0                    = (W32# (x# `quotWord#` y#), W32# (x# `remWord#` y#))
 456         | otherwise                 = divZeroError "quotRem{Word32}" x
 457     toInteger (W32# x#)
 458 #if WORD_SIZE_IN_BYTES == 4
 459         | i# >=# 0#                 = S# i#
 460         | otherwise                 = case word2Integer# x# of (# s, d #) -> J# s d
 461         where
 462         i# = word2Int# x#
 463 #else
 464                                     = S# (word2Int# x#)
 465 #endif
 466
 467 instance Bounded Word32 where
 468     minBound = 0
 469     maxBound = 0xFFFFFFFF
 470
 471 instance Ix Word32 where
 472     range (m,n)       = [m..n]
 473     index b@(m,_) i
 474         | inRange b i = fromIntegral (i - m)
 475         | otherwise   = indexError b i "Word32"
 476     inRange (m,n) i   = m <= i && i <= n
 477
 478 instance Read Word32 where
 479 #if WORD_SIZE_IN_BYTES == 4
 480     readsPrec p s = [(fromInteger x, r) | (x, r) <- readsPrec p s]
 481 #else
 482     readsPrec p s = [(fromIntegral (x::Int), r) | (x, r) <- readsPrec p s]
 483 #endif
 484
 485 instance Bits Word32 where
 486     (W32# x#) .&.   (W32# y#)  = W32# (x# `and#` y#)
 487     (W32# x#) .|.   (W32# y#)  = W32# (x# `or#`  y#)
 488     (W32# x#) `xor` (W32# y#)  = W32# (x# `xor#` y#)
 489     complement (W32# x#)       = W32# (x# `xor#` mb#) where W32# mb# = maxBound
 490     (W32# x#) `shift` (I# i#)
 491         | i# >=# 0#            = W32# (wordToWord32# (x# `shiftL#` i#))
 492         | otherwise            = W32# (x# `shiftRL#` negateInt# i#)
 493     (W32# x#) `rotate` (I# i#) = W32# (wordToWord32# ((x# `shiftL#` i'#) `or#`
 494                                                       (x# `shiftRL#` (32# -# i'#))))
 495         where
 496         i'# = word2Int# (int2Word# i# `and#` int2Word# 31#)
 497     bitSize  _                = 32
 498     isSigned _                = False
 499
 500 {-# RULES
 501 "fromIntegral/a->Word32" fromIntegral = \x -> case fromIntegral x of W# x# -> W32# (wordToWord32# x#)
 502 "fromIntegral/Word32->a" fromIntegral = \(W32# x#) -> fromIntegral (W# x#)
 503     #-}
 504
 505 ------------------------------------------------------------------------
 506 -- type Word64
 507 ------------------------------------------------------------------------
 508
 509 #if WORD_SIZE_IN_BYTES == 4
 510
 511 data Word64 = W64# Word64#
 512
 513 instance Eq Word64 where
 514     (W64# x#) == (W64# y#) = x# `eqWord64#` y#
 515     (W64# x#) /= (W64# y#) = x# `neWord64#` y#
 516
 517 instance Ord Word64 where
 518     (W64# x#) <  (W64# y#) = x# `ltWord64#` y#
 519     (W64# x#) <= (W64# y#) = x# `leWord64#` y#
 520     (W64# x#) >  (W64# y#) = x# `gtWord64#` y#
 521     (W64# x#) >= (W64# y#) = x# `geWord64#` y#
 522
 523 instance Num Word64 where
 524     (W64# x#) + (W64# y#)  = W64# (int64ToWord64# (word64ToInt64# x# `plusInt64#` word64ToInt64# y#))
 525     (W64# x#) - (W64# y#)  = W64# (int64ToWord64# (word64ToInt64# x# `minusInt64#` word64ToInt64# y#))
 526     (W64# x#) * (W64# y#)  = W64# (int64ToWord64# (word64ToInt64# x# `timesInt64#` word64ToInt64# y#))
 527     negate (W64# x#)       = W64# (int64ToWord64# (negateInt64# (word64ToInt64# x#)))
 528     abs x                  = x
 529     signum 0               = 0
 530     signum _               = 1
 531     fromInteger (S# i#)    = W64# (int64ToWord64# (intToInt64# i#))
 532     fromInteger (J# s# d#) = W64# (integerToWord64# s# d#)
 533
 534 instance Enum Word64 where
 535     succ x
 536         | x /= maxBound = x + 1
 537         | otherwise     = succError "Word64"
 538     pred x
 539         | x /= minBound = x - 1
 540         | otherwise     = predError "Word64"
 541     toEnum i@(I# i#)
 542         | i >= 0        = W64# (wordToWord64# (int2Word# i#))
 543         | otherwise     = toEnumError "Word64" i (minBound::Word64, maxBound::Word64)
 544     fromEnum x@(W64# x#)
 545         | x <= fromIntegral (maxBound::Int)
 546                         = I# (word2Int# (word64ToWord# x#))
 547         | otherwise     = fromEnumError "Word64" x
 548     enumFrom            = integralEnumFrom
 549     enumFromThen        = integralEnumFromThen
 550
 551 instance Integral Word64 where
 552     quot    x@(W64# x#) y@(W64# y#)
 553         | y /= 0                    = W64# (x# `quotWord64#` y#)
 554         | otherwise                 = divZeroError "quot{Word64}" x
 555     rem     x@(W64# x#) y@(W64# y#)
 556         | y /= 0                    = W64# (x# `remWord64#` y#)
 557         | otherwise                 = divZeroError "rem{Word64}" x
 558     div     x@(W64# x#) y@(W64# y#)
 559         | y /= 0                    = W64# (x# `quotWord64#` y#)
 560         | otherwise                 = divZeroError "div{Word64}" x
 561     mod     x@(W64# x#) y@(W64# y#)
 562         | y /= 0                    = W64# (x# `remWord64#` y#)
 563         | otherwise                 = divZeroError "mod{Word64}" x
 564     quotRem x@(W64# x#) y@(W64# y#)
 565         | y /= 0                    = (W64# (x# `quotWord64#` y#), W64# (x# `remWord64#` y#))
 566         | otherwise                 = divZeroError "quotRem{Word64}" x
 567     divMod  x@(W64# x#) y@(W64# y#)
 568         | y /= 0                    = (W64# (x# `quotWord64#` y#), W64# (x# `remWord64#` y#))
 569         | otherwise                 = divZeroError "quotRem{Word64}" x
 570     toInteger x@(W64# x#)
 571         | x <= 0x7FFFFFFF           = S# (word2Int# (word64ToWord# x#))
 572         | otherwise                 = case word64ToInteger# x# of (# s, d #) -> J# s d
 573
 574 instance Bits Word64 where
 575     (W64# x#) .&.   (W64# y#)  = W64# (x# `and64#` y#)
 576     (W64# x#) .|.   (W64# y#)  = W64# (x# `or64#`  y#)
 577     (W64# x#) `xor` (W64# y#)  = W64# (x# `xor64#` y#)
 578     complement (W64# x#)       = W64# (not64# x#)
 579     (W64# x#) `shift` (I# i#)
 580         | i# >=# 0#            = W64# (x# `shiftL64#` i#)
 581         | otherwise            = W64# (x# `shiftRL64#` negateInt# i#)
 582     (W64# x#) `rotate` (I# i#) = W64# ((x# `shiftL64#` i'#) `or64#`
 583                                        (x# `shiftRL64#` (64# -# i'#)))
 584         where
 585         i'# = word2Int# (int2Word# i# `and#` int2Word# 63#)
 586     bitSize  _                = 64
 587     isSigned _                = False
 588
 589 foreign import "stg_eqWord64"      unsafe eqWord64#      :: Word64# -> Word64# -> Bool
 590 foreign import "stg_neWord64"      unsafe neWord64#      :: Word64# -> Word64# -> Bool
 591 foreign import "stg_ltWord64"      unsafe ltWord64#      :: Word64# -> Word64# -> Bool
 592 foreign import "stg_leWord64"      unsafe leWord64#      :: Word64# -> Word64# -> Bool
 593 foreign import "stg_gtWord64"      unsafe gtWord64#      :: Word64# -> Word64# -> Bool
 594 foreign import "stg_geWord64"      unsafe geWord64#      :: Word64# -> Word64# -> Bool
 595 foreign import "stg_int64ToWord64" unsafe int64ToWord64# :: Int64# -> Word64#
 596 foreign import "stg_word64ToInt64" unsafe word64ToInt64# :: Word64# -> Int64#
 597 foreign import "stg_plusInt64"     unsafe plusInt64#     :: Int64# -> Int64# -> Int64#
 598 foreign import "stg_minusInt64"    unsafe minusInt64#    :: Int64# -> Int64# -> Int64#
 599 foreign import "stg_timesInt64"    unsafe timesInt64#    :: Int64# -> Int64# -> Int64#
 600 foreign import "stg_negateInt64"   unsafe negateInt64#   :: Int64# -> Int64#
 601 foreign import "stg_intToInt64"    unsafe intToInt64#    :: Int# -> Int64#
 602 foreign import "stg_wordToWord64"  unsafe wordToWord64#  :: Word# -> Word64#
 603 foreign import "stg_word64ToWord"  unsafe word64ToWord#  :: Word64# -> Word#
 604 foreign import "stg_quotWord64"    unsafe quotWord64#    :: Word64# -> Word64# -> Word64#
 605 foreign import "stg_remWord64"     unsafe remWord64#     :: Word64# -> Word64# -> Word64#
 606 foreign import "stg_and64"         unsafe and64#         :: Word64# -> Word64# -> Word64#
 607 foreign import "stg_or64"          unsafe or64#          :: Word64# -> Word64# -> Word64#
 608 foreign import "stg_xor64"         unsafe xor64#         :: Word64# -> Word64# -> Word64#
 609 foreign import "stg_not64"         unsafe not64#         :: Word64# -> Word64#
 610 foreign import "stg_shiftL64"      unsafe shiftL64#      :: Word64# -> Int# -> Word64#
 611 foreign import "stg_shiftRL64"     unsafe shiftRL64#     :: Word64# -> Int# -> Word64#
 612
 613 {-# RULES
 614 "fromIntegral/Int->Word64"    fromIntegral = \(I#   x#) -> W64# (int64ToWord64# (intToInt64# x#))
 615 "fromIntegral/Word->Word64"   fromIntegral = \(W#   x#) -> W64# (wordToWord64# x#)
 616 "fromIntegral/Word64->Int"    fromIntegral = \(W64# x#) -> I#   (word2Int# (word64ToWord# x#))
 617 "fromIntegral/Word64->Word"   fromIntegral = \(W64# x#) -> W#   (word64ToWord# x#)
 618 "fromIntegral/Word64->Word64" fromIntegral = id :: Word64 -> Word64
 619     #-}
 620
 621 #else
 622
 623 data Word32 = W64# Word# deriving (Eq, Ord)
 624
 625 instance Num Word64 where
 626     (W64# x#) + (W64# y#)  = W64# (x# `plusWord#` y#)
 627     (W64# x#) - (W64# y#)  = W64# (x# `minusWord#` y#)
 628     (W64# x#) * (W64# y#)  = W64# (x# `timesWord#` y#)
 629     negate (W64# x#)       = W64# (int2Word# (negateInt# (word2Int# x#)))
 630     abs x                  = x
 631     signum 0               = 0
 632     signum _               = 1
 633     fromInteger (S# i#)    = W64# (int2Word# i#)
 634     fromInteger (J# s# d#) = W64# (integer2Word# s# d#)
 635
 636 instance Enum Word64 where
 637     succ x
 638         | x /= maxBound = x + 1
 639         | otherwise     = succError "Word64"
 640     pred x
 641         | x /= minBound = x - 1
 642         | otherwise     = predError "Word64"
 643     toEnum i@(I# i#)
 644         | i >= 0        = W64# (int2Word# i#)
 645         | otherwise     = toEnumError "Word64" i (minBound::Word64, maxBound::Word64)
 646     fromEnum x@(W64# x#)
 647         | x <= fromIntegral (maxBound::Int)
 648                         = I# (word2Int# x#)
 649         | otherwise     = fromEnumError "Word64" x
 650     enumFrom            = integralEnumFrom
 651     enumFromThen        = integralEnumFromThen
 652
 653 instance Integral Word64 where
 654     quot    x@(W64# x#) y@(W64# y#)
 655         | y /= 0                    = W64# (x# `quotWord#` y#)
 656         | otherwise                 = divZeroError "quot{Word64}" x
 657     rem     x@(W64# x#) y@(W64# y#)
 658         | y /= 0                    = W64# (x# `remWord#` y#)
 659         | otherwise                 = divZeroError "rem{Word64}" x
 660     div     x@(W64# x#) y@(W64# y#)
 661         | y /= 0                    = W64# (x# `quotWord#` y#)
 662         | otherwise                 = divZeroError "div{Word64}" x
 663     mod     x@(W64# x#) y@(W64# y#)
 664         | y /= 0                    = W64# (x# `remWord#` y#)
 665         | otherwise                 = divZeroError "mod{Word64}" x
 666     quotRem x@(W64# x#) y@(W64# y#)
 667         | y /= 0                    = (W64# (x# `quotWord#` y#), W64# (x# `remWord#` y#))
 668         | otherwise                 = divZeroError "quotRem{Word64}" x
 669     divMod  x@(W64# x#) y@(W64# y#)
 670         | y /= 0                    = (W64# (x# `quotWord#` y#), W64# (x# `remWord#` y#))
 671         | otherwise                 = divZeroError "quotRem{Word64}" x
 672     toInteger (W64# x#)
 673         | i# >=# 0#                 = S# i#
 674         | otherwise                 = case word2Integer# x# of (# s, d #) -> J# s d
 675         where
 676         i# = word2Int# x#
 677
 678 instance Bits Word64 where
 679     (W64# x#) .&.   (W64# y#)  = W64# (x# `and#` y#)
 680     (W64# x#) .|.   (W64# y#)  = W64# (x# `or#`  y#)
 681     (W64# x#) `xor` (W64# y#)  = W64# (x# `xor#` y#)
 682     complement (W64# x#)       = W64# (x# `xor#` mb#) where W64# mb# = maxBound
 683     (W64# x#) `shift` (I# i#)
 684         | i# >=# 0#            = W64# (x# `shiftL#` i#)
 685         | otherwise            = W64# (x# `shiftRL#` negateInt# i#)
 686     (W64# x#) `rotate` (I# i#) = W64# ((x# `shiftL#` i'#) `or#`
 687                                        (x# `shiftRL#` (64# -# i'#)))
 688         where
 689         i'# = word2Int# (int2Word# i# `and#` int2Word# 63#)
 690     bitSize  _                = 64
 691     isSigned _                = False
 692
 693 {-# RULES
 694 "fromIntegral/a->Word64" fromIntegral = \x -> case fromIntegral x of W# x# -> W64# x#
 695 "fromIntegral/Word64->a" fromIntegral = \(W64# x#) -> fromIntegral (W# x#)
 696     #-}
 697
 698 #endif
 699
 700 instance CCallable Word64
 701 instance CReturnable Word64
 702
 703 instance Show Word64 where
 704     showsPrec p x = showsPrec p (toInteger x)
 705
 706 instance Real Word64 where
 707     toRational x = toInteger x % 1
 708
 709 instance Bounded Word64 where
 710     minBound = 0
 711     maxBound = 0xFFFFFFFFFFFFFFFF
 712
 713 instance Ix Word64 where
 714     range (m,n)       = [m..n]
 715     index b@(m,_) i
 716         | inRange b i = fromIntegral (i - m)
 717         | otherwise   = indexError b i "Word64"
 718     inRange (m,n) i   = m <= i && i <= n
 719
 720 instance Read Word64 where
 721     readsPrec p s = [(fromInteger x, r) | (x, r) <- readsPrec p s]
 722 \end{code}