GHC/Base.lhs

   1 \section[GHC.Base]{Module @GHC.Base@}
   2
   3 The overall structure of the GHC Prelude is a bit tricky.
   4
   5   a) We want to avoid "orphan modules", i.e. ones with instance
   6         decls that don't belong either to a tycon or a class
   7         defined in the same module
   8
   9   b) We want to avoid giant modules
  10
  11 So the rough structure is as follows, in (linearised) dependency order
  12
  13
  14 GHC.Prim                Has no implementation.  It defines built-in things, and
  15                 by importing it you bring them into scope.
  16                 The source file is GHC.Prim.hi-boot, which is just
  17                 copied to make GHC.Prim.hi
  18
  19 GHC.Base        Classes: Eq, Ord, Functor, Monad
  20                 Types:   list, (), Int, Bool, Ordering, Char, String
  21
  22 Data.Tuple      Types: tuples, plus instances for GHC.Base classes
  23
  24 GHC.Show        Class: Show, plus instances for GHC.Base/GHC.Tup types
  25
  26 GHC.Enum        Class: Enum,  plus instances for GHC.Base/GHC.Tup types
  27
  28 Data.Maybe      Type: Maybe, plus instances for GHC.Base classes
  29
  30 GHC.List        List functions
  31
  32 GHC.Num         Class: Num, plus instances for Int
  33                 Type:  Integer, plus instances for all classes so far (Eq, Ord, Num, Show)
  34
  35                 Integer is needed here because it is mentioned in the signature
  36                 of 'fromInteger' in class Num
  37
  38 GHC.Real        Classes: Real, Integral, Fractional, RealFrac
  39                          plus instances for Int, Integer
  40                 Types:  Ratio, Rational
  41                         plus intances for classes so far
  42
  43                 Rational is needed here because it is mentioned in the signature
  44                 of 'toRational' in class Real
  45
  46 GHC.ST  The ST monad, instances and a few helper functions
  47
  48 Ix              Classes: Ix, plus instances for Int, Bool, Char, Integer, Ordering, tuples
  49
  50 GHC.Arr         Types: Array, MutableArray, MutableVar
  51
  52                 Arrays are used by a function in GHC.Float
  53
  54 GHC.Float       Classes: Floating, RealFloat
  55                 Types:   Float, Double, plus instances of all classes so far
  56
  57                 This module contains everything to do with floating point.
  58                 It is a big module (900 lines)
  59                 With a bit of luck, many modules can be compiled without ever reading GHC.Float.hi
  60
  61
  62 Other Prelude modules are much easier with fewer complex dependencies.
  63
  64 \begin{code}
  65 {-# OPTIONS_GHC -fno-implicit-prelude #-}
  66 -----------------------------------------------------------------------------
  67 -- |
  68 -- Module      :  GHC.Base
  69 -- Copyright   :  (c) The University of Glasgow, 1992-2002
  70 -- License     :  see libraries/base/LICENSE
  71 --
  72 -- Maintainer  :  cvs-ghc@haskell.org
  73 -- Stability   :  internal
  74 -- Portability :  non-portable (GHC extensions)
  75 --
  76 -- Basic data types and classes.
  77 --
  78 -----------------------------------------------------------------------------
  79
  80 #include "MachDeps.h"
  81
  82 -- #hide
  83 module GHC.Base
  84         (
  85         module GHC.Base,
  86         module GHC.Prim,        -- Re-export GHC.Prim and GHC.Err, to avoid lots
  87         module GHC.Err          -- of people having to import it explicitly
  88   )
  89         where
  90
  91 import GHC.Prim
  92 import {-# SOURCE #-} GHC.Err
  93
  94 infixr 9  .
  95 infixr 5  ++, :
  96 infix  4  ==, /=, <, <=, >=, >
  97 infixr 3  &&
  98 infixr 2  ||
  99 infixl 1  >>, >>=
 100 infixr 0  $
 101
 102 default ()              -- Double isn't available yet
 103 \end{code}
 104
 105
 106 %*********************************************************
 107 %*                                                      *
 108 \subsection{DEBUGGING STUFF}
 109 %*  (for use when compiling GHC.Base itself doesn't work)
 110 %*                                                      *
 111 %*********************************************************
 112
 113 \begin{code}
 114 {-
 115 data  Bool  =  False | True
 116 data Ordering = LT | EQ | GT
 117 data Char = C# Char#
 118 type  String = [Char]
 119 data Int = I# Int#
 120 data  ()  =  ()
 121 data [] a = MkNil
 122
 123 not True = False
 124 (&&) True True = True
 125 otherwise = True
 126
 127 build = error "urk"
 128 foldr = error "urk"
 129
 130 unpackCString# :: Addr# -> [Char]
 131 unpackFoldrCString# :: Addr# -> (Char  -> a -> a) -> a -> a
 132 unpackAppendCString# :: Addr# -> [Char] -> [Char]
 133 unpackCStringUtf8# :: Addr# -> [Char]
 134 unpackCString# a = error "urk"
 135 unpackFoldrCString# a = error "urk"
 136 unpackAppendCString# a = error "urk"
 137 unpackCStringUtf8# a = error "urk"
 138 -}
 139 \end{code}
 140
 141
 142 %*********************************************************
 143 %*                                                      *
 144 \subsection{Standard classes @Eq@, @Ord@}
 145 %*                                                      *
 146 %*********************************************************
 147
 148 \begin{code}
 149
 150 -- | The 'Eq' class defines equality ('==') and inequality ('/=').
 151 -- All the basic datatypes exported by the "Prelude" are instances of 'Eq',
 152 -- and 'Eq' may be derived for any datatype whose constituents are also
 153 -- instances of 'Eq'.
 154 --
 155 -- Minimal complete definition: either '==' or '/='.
 156 --
 157 class  Eq a  where
 158     (==), (/=)           :: a -> a -> Bool
 159
 160     x /= y               = not (x == y)
 161     x == y               = not (x /= y)
 162
 163 -- | The 'Ord' class is used for totally ordered datatypes.
 164 --
 165 -- Instances of 'Ord' can be derived for any user-defined
 166 -- datatype whose constituent types are in 'Ord'.  The declared order
 167 -- of the constructors in the data declaration determines the ordering
 168 -- in derived 'Ord' instances.  The 'Ordering' datatype allows a single
 169 -- comparison to determine the precise ordering of two objects.
 170 --
 171 -- Minimal complete definition: either 'compare' or '<='.
 172 -- Using 'compare' can be more efficient for complex types.
 173 --
 174 class  (Eq a) => Ord a  where
 175     compare              :: a -> a -> Ordering
 176     (<), (<=), (>), (>=) :: a -> a -> Bool
 177     max, min             :: a -> a -> a
 178
 179     compare x y
 180         | x == y    = EQ
 181         | x <= y    = LT        -- NB: must be '<=' not '<' to validate the
 182                                 -- above claim about the minimal things that
 183                                 -- can be defined for an instance of Ord
 184         | otherwise = GT
 185
 186     x <  y = case compare x y of { LT -> True;  _other -> False }
 187     x <= y = case compare x y of { GT -> False; _other -> True }
 188     x >  y = case compare x y of { GT -> True;  _other -> False }
 189     x >= y = case compare x y of { LT -> False; _other -> True }
 190
 191         -- These two default methods use '<=' rather than 'compare'
 192         -- because the latter is often more expensive
 193     max x y = if x <= y then y else x
 194     min x y = if x <= y then x else y
 195 \end{code}
 196
 197 %*********************************************************
 198 %*                                                      *
 199 \subsection{Monadic classes @Functor@, @Monad@ }
 200 %*                                                      *
 201 %*********************************************************
 202
 203 \begin{code}
 204 {- | The 'Functor' class is used for types that can be mapped over.
 205 Instances of 'Functor' should satisfy the following laws:
 206
 207 > fmap id  ==  id
 208 > fmap (f . g)  ==  fmap f . fmap g
 209
 210 The instances of 'Functor' for lists, 'Data.Maybe.Maybe' and 'System.IO.IO'
 211 defined in the "Prelude" satisfy these laws.
 212 -}
 213
 214 class  Functor f  where
 215     fmap        :: (a -> b) -> f a -> f b
 216
 217 {- | The 'Monad' class defines the basic operations over a /monad/,
 218 a concept from a branch of mathematics known as /category theory/.
 219 From the perspective of a Haskell programmer, however, it is best to
 220 think of a monad as an /abstract datatype/ of actions.
 221 Haskell's @do@ expressions provide a convenient syntax for writing
 222 monadic expressions.
 223
 224 Minimal complete definition: '>>=' and 'return'.
 225
 226 Instances of 'Monad' should satisfy the following laws:
 227
 228 > return a >>= k  ==  k a
 229 > m >>= return  ==  m
 230 > m >>= (\x -> k x >>= h)  ==  (m >>= k) >>= h
 231
 232 Instances of both 'Monad' and 'Functor' should additionally satisfy the law:
 233
 234 > fmap f xs  ==  xs >>= return . f
 235
 236 The instances of 'Monad' for lists, 'Data.Maybe.Maybe' and 'System.IO.IO'
 237 defined in the "Prelude" satisfy these laws.
 238 -}
 239
 240 class  Monad m  where
 241     -- | Sequentially compose two actions, passing any value produced
 242     -- by the first as an argument to the second.
 243     (>>=)       :: forall a b. m a -> (a -> m b) -> m b
 244     -- | Sequentially compose two actions, discarding any value produced
 245     -- by the first, like sequencing operators (such as the semicolon)
 246     -- in imperative languages.
 247     (>>)        :: forall a b. m a -> m b -> m b
 248         -- Explicit for-alls so that we know what order to
 249         -- give type arguments when desugaring
 250
 251     -- | Inject a value into the monadic type.
 252     return      :: a -> m a
 253     -- | Fail with a message.  This operation is not part of the
 254     -- mathematical definition of a monad, but is invoked on pattern-match
 255     -- failure in a @do@ expression.
 256     fail        :: String -> m a
 257
 258     m >> k      = m >>= \_ -> k
 259     fail s      = error s
 260 \end{code}
 261
 262
 263 %*********************************************************
 264 %*                                                      *
 265 \subsection{The list type}
 266 %*                                                      *
 267 %*********************************************************
 268
 269 \begin{code}
 270 data [] a = [] | a : [a]  -- do explicitly: deriving (Eq, Ord)
 271                           -- to avoid weird names like con2tag_[]#
 272
 273
 274 instance (Eq a) => Eq [a] where
 275     {-# SPECIALISE instance Eq [Char] #-}
 276     []     == []     = True
 277     (x:xs) == (y:ys) = x == y && xs == ys
 278     _xs    == _ys    = False
 279
 280 instance (Ord a) => Ord [a] where
 281     {-# SPECIALISE instance Ord [Char] #-}
 282     compare []     []     = EQ
 283     compare []     (_:_)  = LT
 284     compare (_:_)  []     = GT
 285     compare (x:xs) (y:ys) = case compare x y of
 286                                 EQ    -> compare xs ys
 287                                 other -> other
 288
 289 instance Functor [] where
 290     fmap = map
 291
 292 instance  Monad []  where
 293     m >>= k             = foldr ((++) . k) [] m
 294     m >> k              = foldr ((++) . (\ _ -> k)) [] m
 295     return x            = [x]
 296     fail _              = []
 297 \end{code}
 298
 299 A few list functions that appear here because they are used here.
 300 The rest of the prelude list functions are in GHC.List.
 301
 302 ----------------------------------------------
 303 --      foldr/build/augment
 304 ----------------------------------------------
 305
 306 \begin{code}
 307 -- | 'foldr', applied to a binary operator, a starting value (typically
 308 -- the right-identity of the operator), and a list, reduces the list
 309 -- using the binary operator, from right to left:
 310 --
 311 -- > foldr f z [x1, x2, ..., xn] == x1 `f` (x2 `f` ... (xn `f` z)...)
 312
 313 foldr            :: (a -> b -> b) -> b -> [a] -> b
 314 -- foldr _ z []     =  z
 315 -- foldr f z (x:xs) =  f x (foldr f z xs)
 316 {-# INLINE [0] foldr #-}
 317 -- Inline only in the final stage, after the foldr/cons rule has had a chance
 318 foldr k z xs = go xs
 319              where
 320                go []     = z
 321                go (y:ys) = y `k` go ys
 322
 323 -- | A list producer that can be fused with 'foldr'.
 324 -- This function is merely
 325 --
 326 -- >    build g = g (:) []
 327 --
 328 -- but GHC's simplifier will transform an expression of the form
 329 -- @'foldr' k z ('build' g)@, which may arise after inlining, to @g k z@,
 330 -- which avoids producing an intermediate list.
 331
 332 build   :: forall a. (forall b. (a -> b -> b) -> b -> b) -> [a]
 333 {-# INLINE [1] build #-}
 334         -- The INLINE is important, even though build is tiny,
 335         -- because it prevents [] getting inlined in the version that
 336         -- appears in the interface file.  If [] *is* inlined, it
 337         -- won't match with [] appearing in rules in an importing module.
 338         --
 339         -- The "1" says to inline in phase 1
 340
 341 build g = g (:) []
 342
 343 -- | A list producer that can be fused with 'foldr'.
 344 -- This function is merely
 345 --
 346 -- >    augment g xs = g (:) xs
 347 --
 348 -- but GHC's simplifier will transform an expression of the form
 349 -- @'foldr' k z ('augment' g xs)@, which may arise after inlining, to
 350 -- @g k ('foldr' k z xs)@, which avoids producing an intermediate list.
 351
 352 augment :: forall a. (forall b. (a->b->b) -> b -> b) -> [a] -> [a]
 353 {-# INLINE [1] augment #-}
 354 augment g xs = g (:) xs
 355
 356 {-# RULES
 357 "fold/build"    forall k z (g::forall b. (a->b->b) -> b -> b) .
 358                 foldr k z (build g) = g k z
 359
 360 "foldr/augment" forall k z xs (g::forall b. (a->b->b) -> b -> b) .
 361                 foldr k z (augment g xs) = g k (foldr k z xs)
 362
 363 "foldr/id"                        foldr (:) [] = \x  -> x
 364 "foldr/app"     [1] forall ys. foldr (:) ys = \xs -> xs ++ ys
 365         -- Only activate this from phase 1, because that's
 366         -- when we disable the rule that expands (++) into foldr
 367
 368 -- The foldr/cons rule looks nice, but it can give disastrously
 369 -- bloated code when commpiling
 370 --      array (a,b) [(1,2), (2,2), (3,2), ...very long list... ]
 371 -- i.e. when there are very very long literal lists
 372 -- So I've disabled it for now. We could have special cases
 373 -- for short lists, I suppose.
 374 -- "foldr/cons" forall k z x xs. foldr k z (x:xs) = k x (foldr k z xs)
 375
 376 "foldr/single"  forall k z x. foldr k z [x] = k x z
 377 "foldr/nil"     forall k z.   foldr k z []  = z
 378
 379 "augment/build" forall (g::forall b. (a->b->b) -> b -> b)
 380                        (h::forall b. (a->b->b) -> b -> b) .
 381                        augment g (build h) = build (\c n -> g c (h c n))
 382 "augment/nil"   forall (g::forall b. (a->b->b) -> b -> b) .
 383                         augment g [] = build g
 384  #-}
 385
 386 -- This rule is true, but not (I think) useful:
 387 --      augment g (augment h t) = augment (\cn -> g c (h c n)) t
 388 \end{code}
 389
 390
 391 ----------------------------------------------
 392 --              map
 393 ----------------------------------------------
 394
 395 \begin{code}
 396 -- | 'map' @f xs@ is the list obtained by applying @f@ to each element
 397 -- of @xs@, i.e.,
 398 --
 399 -- > map f [x1, x2, ..., xn] == [f x1, f x2, ..., f xn]
 400 -- > map f [x1, x2, ...] == [f x1, f x2, ...]
 401
 402 map :: (a -> b) -> [a] -> [b]
 403 map _ []     = []
 404 map f (x:xs) = f x : map f xs
 405
 406 -- Note eta expanded
 407 mapFB ::  (elt -> lst -> lst) -> (a -> elt) -> a -> lst -> lst
 408 {-# INLINE [0] mapFB #-}
 409 mapFB c f x ys = c (f x) ys
 410
 411 -- The rules for map work like this.
 412 --
 413 -- Up to (but not including) phase 1, we use the "map" rule to
 414 -- rewrite all saturated applications of map with its build/fold
 415 -- form, hoping for fusion to happen.
 416 -- In phase 1 and 0, we switch off that rule, inline build, and
 417 -- switch on the "mapList" rule, which rewrites the foldr/mapFB
 418 -- thing back into plain map.
 419 --
 420 -- It's important that these two rules aren't both active at once
 421 -- (along with build's unfolding) else we'd get an infinite loop
 422 -- in the rules.  Hence the activation control below.
 423 --
 424 -- The "mapFB" rule optimises compositions of map.
 425 --
 426 -- This same pattern is followed by many other functions:
 427 -- e.g. append, filter, iterate, repeat, etc.
 428
 429 {-# RULES
 430 "map"       [~1] forall f xs.   map f xs                = build (\c n -> foldr (mapFB c f) n xs)
 431 "mapList"   [1]  forall f.      foldr (mapFB (:) f) []  = map f
 432 "mapFB"     forall c f g.       mapFB (mapFB c f) g     = mapFB c (f.g)
 433   #-}
 434 \end{code}
 435
 436
 437 ----------------------------------------------
 438 --              append
 439 ----------------------------------------------
 440 \begin{code}
 441 -- | Append two lists, i.e.,
 442 --
 443 -- > [x1, ..., xm] ++ [y1, ..., yn] == [x1, ..., xm, y1, ..., yn]
 444 -- > [x1, ..., xm] ++ [y1, ...] == [x1, ..., xm, y1, ...]
 445 --
 446 -- If the first list is not finite, the result is the first list.
 447
 448 (++) :: [a] -> [a] -> [a]
 449 (++) []     ys = ys
 450 (++) (x:xs) ys = x : xs ++ ys
 451
 452 {-# RULES
 453 "++"    [~1] forall xs ys. xs ++ ys = augment (\c n -> foldr c n xs) ys
 454   #-}
 455
 456 \end{code}
 457
 458
 459 %*********************************************************
 460 %*                                                      *
 461 \subsection{Type @Bool@}
 462 %*                                                      *
 463 %*********************************************************
 464
 465 \begin{code}
 466 -- |The 'Bool' type is an enumeration.  It is defined with 'False'
 467 -- first so that the corresponding 'Prelude.Enum' instance will give
 468 -- 'Prelude.fromEnum' 'False' the value zero, and
 469 -- 'Prelude.fromEnum' 'True' the value 1.
 470 data  Bool  =  False | True  deriving (Eq, Ord)
 471         -- Read in GHC.Read, Show in GHC.Show
 472
 473 -- Boolean functions
 474
 475 -- | Boolean \"and\"
 476 (&&)                    :: Bool -> Bool -> Bool
 477 True  && x              =  x
 478 False && _              =  False
 479
 480 -- | Boolean \"or\"
 481 (||)                    :: Bool -> Bool -> Bool
 482 True  || _              =  True
 483 False || x              =  x
 484
 485 -- | Boolean \"not\"
 486 not                     :: Bool -> Bool
 487 not True                =  False
 488 not False               =  True
 489
 490 -- |'otherwise' is defined as the value 'True'.  It helps to make
 491 -- guards more readable.  eg.
 492 --
 493 -- >  f x | x < 0     = ...
 494 -- >      | otherwise = ...
 495 otherwise               :: Bool
 496 otherwise               =  True
 497 \end{code}
 498
 499
 500 %*********************************************************
 501 %*                                                      *
 502 \subsection{The @()@ type}
 503 %*                                                      *
 504 %*********************************************************
 505
 506 The Unit type is here because virtually any program needs it (whereas
 507 some programs may get away without consulting GHC.Tup).  Furthermore,
 508 the renamer currently *always* asks for () to be in scope, so that
 509 ccalls can use () as their default type; so when compiling GHC.Base we
 510 need ().  (We could arrange suck in () only if -fglasgow-exts, but putting
 511 it here seems more direct.)
 512
 513 \begin{code}
 514 -- | The unit datatype @()@ has one non-undefined member, the nullary
 515 -- constructor @()@.
 516 data () = ()
 517
 518 instance Eq () where
 519     () == () = True
 520     () /= () = False
 521
 522 instance Ord () where
 523     () <= () = True
 524     () <  () = False
 525     () >= () = True
 526     () >  () = False
 527     max () () = ()
 528     min () () = ()
 529     compare () () = EQ
 530 \end{code}
 531
 532
 533 %*********************************************************
 534 %*                                                      *
 535 \subsection{Type @Ordering@}
 536 %*                                                      *
 537 %*********************************************************
 538
 539 \begin{code}
 540 -- | Represents an ordering relationship between two values: less
 541 -- than, equal to, or greater than.  An 'Ordering' is returned by
 542 -- 'compare'.
 543 data Ordering = LT | EQ | GT deriving (Eq, Ord)
 544         -- Read in GHC.Read, Show in GHC.Show
 545 \end{code}
 546
 547
 548 %*********************************************************
 549 %*                                                      *
 550 \subsection{Type @Char@ and @String@}
 551 %*                                                      *
 552 %*********************************************************
 553
 554 \begin{code}
 555 -- | A 'String' is a list of characters.  String constants in Haskell are values
 556 -- of type 'String'.
 557 --
 558 type String = [Char]
 559
 560 {-| The character type 'Char' is an enumeration whose values represent
 561 Unicode (or equivalently ISO\/IEC 10646) characters
 562 (see <http://www.unicode.org/> for details).
 563 This set extends the ISO 8859-1 (Latin-1) character set
 564 (the first 256 charachers), which is itself an extension of the ASCII
 565 character set (the first 128 characters).
 566 A character literal in Haskell has type 'Char'.
 567
 568 To convert a 'Char' to or from the corresponding 'Int' value defined
 569 by Unicode, use 'Prelude.toEnum' and 'Prelude.fromEnum' from the
 570 'Prelude.Enum' class respectively (or equivalently 'ord' and 'chr').
 571 -}
 572 data Char = C# Char#
 573
 574 -- We don't use deriving for Eq and Ord, because for Ord the derived
 575 -- instance defines only compare, which takes two primops.  Then
 576 -- '>' uses compare, and therefore takes two primops instead of one.
 577
 578 instance Eq Char where
 579     (C# c1) == (C# c2) = c1 `eqChar#` c2
 580     (C# c1) /= (C# c2) = c1 `neChar#` c2
 581
 582 instance Ord Char where
 583     (C# c1) >  (C# c2) = c1 `gtChar#` c2
 584     (C# c1) >= (C# c2) = c1 `geChar#` c2
 585     (C# c1) <= (C# c2) = c1 `leChar#` c2
 586     (C# c1) <  (C# c2) = c1 `ltChar#` c2
 587
 588 {-# RULES
 589 "x# `eqChar#` x#" forall x#. x# `eqChar#` x# = True
 590 "x# `neChar#` x#" forall x#. x# `neChar#` x# = False
 591 "x# `gtChar#` x#" forall x#. x# `gtChar#` x# = False
 592 "x# `geChar#` x#" forall x#. x# `geChar#` x# = True
 593 "x# `leChar#` x#" forall x#. x# `leChar#` x# = True
 594 "x# `ltChar#` x#" forall x#. x# `ltChar#` x# = False
 595   #-}
 596
 597 -- | The 'Prelude.toEnum' method restricted to the type 'Data.Char.Char'.
 598 chr :: Int -> Char
 599 chr (I# i#) | int2Word# i# `leWord#` int2Word# 0x10FFFF# = C# (chr# i#)
 600             | otherwise                                  = error "Prelude.chr: bad argument"
 601
 602 unsafeChr :: Int -> Char
 603 unsafeChr (I# i#) = C# (chr# i#)
 604
 605 -- | The 'Prelude.fromEnum' method restricted to the type 'Data.Char.Char'.
 606 ord :: Char -> Int
 607 ord (C# c#) = I# (ord# c#)
 608 \end{code}
 609
 610 String equality is used when desugaring pattern-matches against strings.
 611
 612 \begin{code}
 613 eqString :: String -> String -> Bool
 614 eqString []       []       = True
 615 eqString (c1:cs1) (c2:cs2) = c1 == c2 && cs1 `eqString` cs2
 616 eqString cs1      cs2      = False
 617
 618 {-# RULES "eqString" (==) = eqString #-}
 619 -- eqString also has a BuiltInRule in PrelRules.lhs:
 620 --      eqString (unpackCString# (Lit s1)) (unpackCString# (Lit s2) = s1==s2
 621 \end{code}
 622
 623
 624 %*********************************************************
 625 %*                                                      *
 626 \subsection{Type @Int@}
 627 %*                                                      *
 628 %*********************************************************
 629
 630 \begin{code}
 631 data Int = I# Int#
 632 -- ^A fixed-precision integer type with at least the range @[-2^29 .. 2^29-1]@.
 633 -- The exact range for a given implementation can be determined by using
 634 -- 'Prelude.minBound' and 'Prelude.maxBound' from the 'Prelude.Bounded' class.
 635
 636 zeroInt, oneInt, twoInt, maxInt, minInt :: Int
 637 zeroInt = I# 0#
 638 oneInt  = I# 1#
 639 twoInt  = I# 2#
 640
 641 {- Seems clumsy. Should perhaps put minInt and MaxInt directly into MachDeps.h -}
 642 #if WORD_SIZE_IN_BITS == 31
 643 minInt  = I# (-0x40000000#)
 644 maxInt  = I# 0x3FFFFFFF#
 645 #elif WORD_SIZE_IN_BITS == 32
 646 minInt  = I# (-0x80000000#)
 647 maxInt  = I# 0x7FFFFFFF#
 648 #else
 649 minInt  = I# (-0x8000000000000000#)
 650 maxInt  = I# 0x7FFFFFFFFFFFFFFF#
 651 #endif
 652
 653 instance Eq Int where
 654     (==) = eqInt
 655     (/=) = neInt
 656
 657 instance Ord Int where
 658     compare = compareInt
 659     (<)     = ltInt
 660     (<=)    = leInt
 661     (>=)    = geInt
 662     (>)     = gtInt
 663
 664 compareInt :: Int -> Int -> Ordering
 665 (I# x#) `compareInt` (I# y#) = compareInt# x# y#
 666
 667 compareInt# :: Int# -> Int# -> Ordering
 668 compareInt# x# y#
 669     | x# <#  y# = LT
 670     | x# ==# y# = EQ
 671     | otherwise = GT
 672 \end{code}
 673
 674
 675 %*********************************************************
 676 %*                                                      *
 677 \subsection{The function type}
 678 %*                                                      *
 679 %*********************************************************
 680
 681 \begin{code}
 682 -- | Identity function.
 683 id                      :: a -> a
 684 id x                    =  x
 685
 686 -- | The call '(lazy e)' means the same as 'e', but 'lazy' has a
 687 -- magical strictness property: it is lazy in its first argument,
 688 -- even though its semantics is strict.
 689 lazy :: a -> a
 690 lazy x = x
 691 -- Implementation note: its strictness and unfolding are over-ridden
 692 -- by the definition in MkId.lhs; in both cases to nothing at all.
 693 -- That way, 'lazy' does not get inlined, and the strictness analyser
 694 -- sees it as lazy.  Then the worker/wrapper phase inlines it.
 695 -- Result: happiness
 696
 697
 698 -- | The call '(inline f)' reduces to 'f', but 'inline' has a BuiltInRule
 699 -- that tries to inline 'f' (if it has an unfolding) unconditionally
 700 -- The 'NOINLINE' pragma arranges that inline only gets inlined (and
 701 -- hence eliminated) late in compilation, after the rule has had
 702 -- a god chance to fire.
 703 inline :: a -> a
 704 {-# NOINLINE[0] inline #-}
 705 inline x = x
 706
 707 -- Assertion function.  This simply ignores its boolean argument.
 708 -- The compiler may rewrite it to @('assertError' line)@.
 709
 710 -- | If the first argument evaluates to 'True', then the result is the
 711 -- second argument.  Otherwise an 'AssertionFailed' exception is raised,
 712 -- containing a 'String' with the source file and line number of the
 713 -- call to 'assert'.
 714 --
 715 -- Assertions can normally be turned on or off with a compiler flag
 716 -- (for GHC, assertions are normally on unless optimisation is turned on
 717 -- with @-O@ or the @-fignore-asserts@
 718 -- option is given).  When assertions are turned off, the first
 719 -- argument to 'assert' is ignored, and the second argument is
 720 -- returned as the result.
 721
 722 --      SLPJ: in 5.04 etc 'assert' is in GHC.Prim,
 723 --      but from Template Haskell onwards it's simply
 724 --      defined here in Base.lhs
 725 assert :: Bool -> a -> a
 726 assert pred r = r
 727
 728 breakpoint :: a -> a
 729 breakpoint r = r
 730
 731 breakpointCond :: Bool -> a -> a
 732 breakpointCond _ r = r
 733
 734 data Unknown
 735
 736 -- | Constant function.
 737 const                   :: a -> b -> a
 738 const x _               =  x
 739
 740 -- | Function composition.
 741 {-# INLINE (.) #-}
 742 (.)       :: (b -> c) -> (a -> b) -> a -> c
 743 (.) f g x = f (g x)
 744
 745 -- | @'flip' f@ takes its (first) two arguments in the reverse order of @f@.
 746 flip                    :: (a -> b -> c) -> b -> a -> c
 747 flip f x y              =  f y x
 748
 749 -- | Application operator.  This operator is redundant, since ordinary
 750 -- application @(f x)@ means the same as @(f '$' x)@. However, '$' has
 751 -- low, right-associative binding precedence, so it sometimes allows
 752 -- parentheses to be omitted; for example:
 753 --
 754 -- >     f $ g $ h x  =  f (g (h x))
 755 --
 756 -- It is also useful in higher-order situations, such as @'map' ('$' 0) xs@,
 757 -- or @'Data.List.zipWith' ('$') fs xs@.
 758 {-# INLINE ($) #-}
 759 ($)                     :: (a -> b) -> a -> b
 760 f $ x                   =  f x
 761
 762 -- | @'until' p f@ yields the result of applying @f@ until @p@ holds.
 763 until                   :: (a -> Bool) -> (a -> a) -> a -> a
 764 until p f x | p x       =  x
 765             | otherwise =  until p f (f x)
 766
 767 -- | 'asTypeOf' is a type-restricted version of 'const'.  It is usually
 768 -- used as an infix operator, and its typing forces its first argument
 769 -- (which is usually overloaded) to have the same type as the second.
 770 asTypeOf                :: a -> a -> a
 771 asTypeOf                =  const
 772 \end{code}
 773
 774 %*********************************************************
 775 %*                                                      *
 776 \subsection{Generics}
 777 %*                                                      *
 778 %*********************************************************
 779
 780 \begin{code}
 781 data Unit = Unit
 782 #ifndef __HADDOCK__
 783 data (:+:) a b = Inl a | Inr b
 784 data (:*:) a b = a :*: b
 785 #endif
 786 \end{code}
 787
 788 %*********************************************************
 789 %*                                                      *
 790 \subsection{@getTag@}
 791 %*                                                      *
 792 %*********************************************************
 793
 794 Returns the 'tag' of a constructor application; this function is used
 795 by the deriving code for Eq, Ord and Enum.
 796
 797 The primitive dataToTag# requires an evaluated constructor application
 798 as its argument, so we provide getTag as a wrapper that performs the
 799 evaluation before calling dataToTag#.  We could have dataToTag#
 800 evaluate its argument, but we prefer to do it this way because (a)
 801 dataToTag# can be an inline primop if it doesn't need to do any
 802 evaluation, and (b) we want to expose the evaluation to the
 803 simplifier, because it might be possible to eliminate the evaluation
 804 in the case when the argument is already known to be evaluated.
 805
 806 \begin{code}
 807 {-# INLINE getTag #-}
 808 getTag :: a -> Int#
 809 getTag x = x `seq` dataToTag# x
 810 \end{code}
 811
 812 %*********************************************************
 813 %*                                                      *
 814 \subsection{Numeric primops}
 815 %*                                                      *
 816 %*********************************************************
 817
 818 \begin{code}
 819 divInt# :: Int# -> Int# -> Int#
 820 x# `divInt#` y#
 821         -- Be careful NOT to overflow if we do any additional arithmetic
 822         -- on the arguments...  the following  previous version of this
 823         -- code has problems with overflow:
 824 --    | (x# ># 0#) && (y# <# 0#) = ((x# -# y#) -# 1#) `quotInt#` y#
 825 --    | (x# <# 0#) && (y# ># 0#) = ((x# -# y#) +# 1#) `quotInt#` y#
 826     | (x# ># 0#) && (y# <# 0#) = ((x# -# 1#) `quotInt#` y#) -# 1#
 827     | (x# <# 0#) && (y# ># 0#) = ((x# +# 1#) `quotInt#` y#) -# 1#
 828     | otherwise                = x# `quotInt#` y#
 829
 830 modInt# :: Int# -> Int# -> Int#
 831 x# `modInt#` y#
 832     | (x# ># 0#) && (y# <# 0#) ||
 833       (x# <# 0#) && (y# ># 0#)    = if r# /=# 0# then r# +# y# else 0#
 834     | otherwise                   = r#
 835     where
 836     r# = x# `remInt#` y#
 837 \end{code}
 838
 839 Definitions of the boxed PrimOps; these will be
 840 used in the case of partial applications, etc.
 841
 842 \begin{code}
 843 {-# INLINE eqInt #-}
 844 {-# INLINE neInt #-}
 845 {-# INLINE gtInt #-}
 846 {-# INLINE geInt #-}
 847 {-# INLINE ltInt #-}
 848 {-# INLINE leInt #-}
 849 {-# INLINE plusInt #-}
 850 {-# INLINE minusInt #-}
 851 {-# INLINE timesInt #-}
 852 {-# INLINE quotInt #-}
 853 {-# INLINE remInt #-}
 854 {-# INLINE negateInt #-}
 855
 856 plusInt, minusInt, timesInt, quotInt, remInt, divInt, modInt, gcdInt :: Int -> Int -> Int
 857 (I# x) `plusInt`  (I# y) = I# (x +# y)
 858 (I# x) `minusInt` (I# y) = I# (x -# y)
 859 (I# x) `timesInt` (I# y) = I# (x *# y)
 860 (I# x) `quotInt`  (I# y) = I# (x `quotInt#` y)
 861 (I# x) `remInt`   (I# y) = I# (x `remInt#`  y)
 862 (I# x) `divInt`   (I# y) = I# (x `divInt#`  y)
 863 (I# x) `modInt`   (I# y) = I# (x `modInt#`  y)
 864
 865 {-# RULES
 866 "x# +# 0#" forall x#. x# +# 0# = x#
 867 "0# +# x#" forall x#. 0# +# x# = x#
 868 "x# -# 0#" forall x#. x# -# 0# = x#
 869 "x# -# x#" forall x#. x# -# x# = 0#
 870 "x# *# 0#" forall x#. x# *# 0# = 0#
 871 "0# *# x#" forall x#. 0# *# x# = 0#
 872 "x# *# 1#" forall x#. x# *# 1# = x#
 873 "1# *# x#" forall x#. 1# *# x# = x#
 874   #-}
 875
 876 gcdInt (I# a) (I# b) = g a b
 877    where g 0# 0# = error "GHC.Base.gcdInt: gcd 0 0 is undefined"
 878          g 0# _  = I# absB
 879          g _  0# = I# absA
 880          g _  _  = I# (gcdInt# absA absB)
 881
 882          absInt x = if x <# 0# then negateInt# x else x
 883
 884          absA     = absInt a
 885          absB     = absInt b
 886
 887 negateInt :: Int -> Int
 888 negateInt (I# x) = I# (negateInt# x)
 889
 890 gtInt, geInt, eqInt, neInt, ltInt, leInt :: Int -> Int -> Bool
 891 (I# x) `gtInt` (I# y) = x >#  y
 892 (I# x) `geInt` (I# y) = x >=# y
 893 (I# x) `eqInt` (I# y) = x ==# y
 894 (I# x) `neInt` (I# y) = x /=# y
 895 (I# x) `ltInt` (I# y) = x <#  y
 896 (I# x) `leInt` (I# y) = x <=# y
 897
 898 {-# RULES
 899 "x# ># x#"  forall x#. x# >#  x# = False
 900 "x# >=# x#" forall x#. x# >=# x# = True
 901 "x# ==# x#" forall x#. x# ==# x# = True
 902 "x# /=# x#" forall x#. x# /=# x# = False
 903 "x# <# x#"  forall x#. x# <#  x# = False
 904 "x# <=# x#" forall x#. x# <=# x# = True
 905   #-}
 906
 907 {-# RULES
 908 "plusFloat x 0.0"   forall x#. plusFloat#  x#   0.0# = x#
 909 "plusFloat 0.0 x"   forall x#. plusFloat#  0.0# x#   = x#
 910 "minusFloat x 0.0"  forall x#. minusFloat# x#   0.0# = x#
 911 "minusFloat x x"    forall x#. minusFloat# x#   x#   = 0.0#
 912 "timesFloat x 0.0"  forall x#. timesFloat# x#   0.0# = 0.0#
 913 "timesFloat0.0 x"   forall x#. timesFloat# 0.0# x#   = 0.0#
 914 "timesFloat x 1.0"  forall x#. timesFloat# x#   1.0# = x#
 915 "timesFloat 1.0 x"  forall x#. timesFloat# 1.0# x#   = x#
 916 "divideFloat x 1.0" forall x#. divideFloat# x#  1.0# = x#
 917   #-}
 918
 919 {-# RULES
 920 "plusDouble x 0.0"   forall x#. (+##) x#    0.0## = x#
 921 "plusDouble 0.0 x"   forall x#. (+##) 0.0## x#    = x#
 922 "minusDouble x 0.0"  forall x#. (-##) x#    0.0## = x#
 923 "minusDouble x x"    forall x#. (-##) x#    x#    = 0.0##
 924 "timesDouble x 0.0"  forall x#. (*##) x#    0.0## = 0.0##
 925 "timesDouble 0.0 x"  forall x#. (*##) 0.0## x#    = 0.0##
 926 "timesDouble x 1.0"  forall x#. (*##) x#    1.0## = x#
 927 "timesDouble 1.0 x"  forall x#. (*##) 1.0## x#    = x#
 928 "divideDouble x 1.0" forall x#. (/##) x#    1.0## = x#
 929   #-}
 930
 931 -- Wrappers for the shift operations.  The uncheckedShift# family are
 932 -- undefined when the amount being shifted by is greater than the size
 933 -- in bits of Int#, so these wrappers perform a check and return
 934 -- either zero or -1 appropriately.
 935 --
 936 -- Note that these wrappers still produce undefined results when the
 937 -- second argument (the shift amount) is negative.
 938
 939 -- | Shift the argument left by the specified number of bits
 940 -- (which must be non-negative).
 941 shiftL# :: Word# -> Int# -> Word#
 942 a `shiftL#` b   | b >=# WORD_SIZE_IN_BITS# = int2Word# 0#
 943                 | otherwise                = a `uncheckedShiftL#` b
 944
 945 -- | Shift the argument right by the specified number of bits
 946 -- (which must be non-negative).
 947 shiftRL# :: Word# -> Int# -> Word#
 948 a `shiftRL#` b  | b >=# WORD_SIZE_IN_BITS# = int2Word# 0#
 949                 | otherwise                = a `uncheckedShiftRL#` b
 950
 951 -- | Shift the argument left by the specified number of bits
 952 -- (which must be non-negative).
 953 iShiftL# :: Int# -> Int# -> Int#
 954 a `iShiftL#` b  | b >=# WORD_SIZE_IN_BITS# = 0#
 955                 | otherwise                = a `uncheckedIShiftL#` b
 956
 957 -- | Shift the argument right (signed) by the specified number of bits
 958 -- (which must be non-negative).
 959 iShiftRA# :: Int# -> Int# -> Int#
 960 a `iShiftRA#` b | b >=# WORD_SIZE_IN_BITS# = if a <# 0# then (-1#) else 0#
 961                 | otherwise                = a `uncheckedIShiftRA#` b
 962
 963 -- | Shift the argument right (unsigned) by the specified number of bits
 964 -- (which must be non-negative).
 965 iShiftRL# :: Int# -> Int# -> Int#
 966 a `iShiftRL#` b | b >=# WORD_SIZE_IN_BITS# = 0#
 967                 | otherwise                = a `uncheckedIShiftRL#` b
 968
 969 #if WORD_SIZE_IN_BITS == 32
 970 {-# RULES
 971 "narrow32Int#"  forall x#. narrow32Int#   x# = x#
 972 "narrow32Word#" forall x#. narrow32Word#   x# = x#
 973    #-}
 974 #endif
 975
 976 {-# RULES
 977 "int2Word2Int"  forall x#. int2Word# (word2Int# x#) = x#
 978 "word2Int2Word" forall x#. word2Int# (int2Word# x#) = x#
 979   #-}
 980 \end{code}
 981
 982
 983 %********************************************************
 984 %*                                                      *
 985 \subsection{Unpacking C strings}
 986 %*                                                      *
 987 %********************************************************
 988
 989 This code is needed for virtually all programs, since it's used for
 990 unpacking the strings of error messages.
 991
 992 \begin{code}
 993 unpackCString# :: Addr# -> [Char]
 994 {-# NOINLINE [1] unpackCString# #-}
 995 unpackCString# addr
 996   = unpack 0#
 997   where
 998     unpack nh
 999       | ch `eqChar#` '\0'# = []
1000       | otherwise          = C# ch : unpack (nh +# 1#)
1001       where
1002         ch = indexCharOffAddr# addr nh
1003
1004 unpackAppendCString# :: Addr# -> [Char] -> [Char]
1005 unpackAppendCString# addr rest
1006   = unpack 0#
1007   where
1008     unpack nh
1009       | ch `eqChar#` '\0'# = rest
1010       | otherwise          = C# ch : unpack (nh +# 1#)
1011       where
1012         ch = indexCharOffAddr# addr nh
1013
1014 unpackFoldrCString# :: Addr# -> (Char  -> a -> a) -> a -> a
1015 {-# NOINLINE [0] unpackFoldrCString# #-}
1016 -- Don't inline till right at the end;
1017 -- usually the unpack-list rule turns it into unpackCStringList
1018 -- It also has a BuiltInRule in PrelRules.lhs:
1019 --      unpackFoldrCString# "foo" c (unpackFoldrCString# "baz" c n)
1020 --        =  unpackFoldrCString# "foobaz" c n
1021 unpackFoldrCString# addr f z
1022   = unpack 0#
1023   where
1024     unpack nh
1025       | ch `eqChar#` '\0'# = z
1026       | otherwise          = C# ch `f` unpack (nh +# 1#)
1027       where
1028         ch = indexCharOffAddr# addr nh
1029
1030 unpackCStringUtf8# :: Addr# -> [Char]
1031 unpackCStringUtf8# addr
1032   = unpack 0#
1033   where
1034     unpack nh
1035       | ch `eqChar#` '\0'#   = []
1036       | ch `leChar#` '\x7F'# = C# ch : unpack (nh +# 1#)
1037       | ch `leChar#` '\xDF'# =
1038           C# (chr# (((ord# ch                                  -# 0xC0#) `uncheckedIShiftL#`  6#) +#
1039                      (ord# (indexCharOffAddr# addr (nh +# 1#)) -# 0x80#))) :
1040           unpack (nh +# 2#)
1041       | ch `leChar#` '\xEF'# =
1042           C# (chr# (((ord# ch                                  -# 0xE0#) `uncheckedIShiftL#` 12#) +#
1043                     ((ord# (indexCharOffAddr# addr (nh +# 1#)) -# 0x80#) `uncheckedIShiftL#`  6#) +#
1044                      (ord# (indexCharOffAddr# addr (nh +# 2#)) -# 0x80#))) :
1045           unpack (nh +# 3#)
1046       | otherwise            =
1047           C# (chr# (((ord# ch                                  -# 0xF0#) `uncheckedIShiftL#` 18#) +#
1048                     ((ord# (indexCharOffAddr# addr (nh +# 1#)) -# 0x80#) `uncheckedIShiftL#` 12#) +#
1049                     ((ord# (indexCharOffAddr# addr (nh +# 2#)) -# 0x80#) `uncheckedIShiftL#`  6#) +#
1050                      (ord# (indexCharOffAddr# addr (nh +# 3#)) -# 0x80#))) :
1051           unpack (nh +# 4#)
1052       where
1053         ch = indexCharOffAddr# addr nh
1054
1055 unpackNBytes# :: Addr# -> Int# -> [Char]
1056 unpackNBytes# _addr 0#   = []
1057 unpackNBytes#  addr len# = unpack [] (len# -# 1#)
1058     where
1059      unpack acc i#
1060       | i# <# 0#  = acc
1061       | otherwise =
1062          case indexCharOffAddr# addr i# of
1063             ch -> unpack (C# ch : acc) (i# -# 1#)
1064
1065 {-# RULES
1066 "unpack"       [~1] forall a   . unpackCString# a                  = build (unpackFoldrCString# a)
1067 "unpack-list"  [1]  forall a   . unpackFoldrCString# a (:) [] = unpackCString# a
1068 "unpack-append"     forall a n . unpackFoldrCString# a (:) n  = unpackAppendCString# a n
1069
1070 -- There's a built-in rule (in PrelRules.lhs) for
1071 --      unpackFoldr "foo" c (unpackFoldr "baz" c n)  =  unpackFoldr "foobaz" c n
1072
1073   #-}
1074 \end{code}
1075
1076 #ifdef __HADDOCK__
1077 \begin{code}
1078 -- | A special argument for the 'Control.Monad.ST.ST' type constructor,
1079 -- indexing a state embedded in the 'Prelude.IO' monad by
1080 -- 'Control.Monad.ST.stToIO'.
1081 data RealWorld
1082 \end{code}
1083 #endif