1 \section[GHC.Base]{Module @GHC.Base@}
3 The overall structure of the GHC Prelude is a bit tricky.
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
9 b) We want to avoid giant modules
11 So the rough structure is as follows, in (linearised) dependency order
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
19 GHC.Base Classes: Eq, Ord, Functor, Monad
20 Types: list, (), Int, Bool, Ordering, Char, String
22 Data.Tuple Types: tuples, plus instances for GHC.Base classes
24 GHC.Show Class: Show, plus instances for GHC.Base/GHC.Tup types
26 GHC.Enum Class: Enum, plus instances for GHC.Base/GHC.Tup types
28 Data.Maybe Type: Maybe, plus instances for GHC.Base classes
30 GHC.List List functions
32 GHC.Num Class: Num, plus instances for Int
33 Type: Integer, plus instances for all classes so far (Eq, Ord, Num, Show)
35 Integer is needed here because it is mentioned in the signature
36 of 'fromInteger' in class Num
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
43 Rational is needed here because it is mentioned in the signature
44 of 'toRational' in class Real
46 GHC.ST The ST monad, instances and a few helper functions
48 Ix Classes: Ix, plus instances for Int, Bool, Char, Integer, Ordering, tuples
50 GHC.Arr Types: Array, MutableArray, MutableVar
52 Arrays are used by a function in GHC.Float
54 GHC.Float Classes: Floating, RealFloat
55 Types: Float, Double, plus instances of all classes so far
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
62 Other Prelude modules are much easier with fewer complex dependencies.
65 {-# OPTIONS_GHC -XNoImplicitPrelude #-}
66 {-# OPTIONS_HADDOCK hide #-}
67 -----------------------------------------------------------------------------
70 -- Copyright : (c) The University of Glasgow, 1992-2002
71 -- License : see libraries/base/LICENSE
73 -- Maintainer : cvs-ghc@haskell.org
74 -- Stability : internal
75 -- Portability : non-portable (GHC extensions)
77 -- Basic data types and classes.
79 -----------------------------------------------------------------------------
91 module GHC.Prim, -- Re-export GHC.Prim and GHC.Err, to avoid lots
92 module GHC.Err -- of people having to import it explicitly
101 import {-# SOURCE #-} GHC.Err
105 infix 4 ==, /=, <, <=, >=, >
111 default () -- Double isn't available yet
115 %*********************************************************
117 \subsection{DEBUGGING STUFF}
118 %* (for use when compiling GHC.Base itself doesn't work)
120 %*********************************************************
124 data Bool = False | True
125 data Ordering = LT | EQ | GT
133 (&&) True True = True
139 unpackCString# :: Addr# -> [Char]
140 unpackFoldrCString# :: Addr# -> (Char -> a -> a) -> a -> a
141 unpackAppendCString# :: Addr# -> [Char] -> [Char]
142 unpackCStringUtf8# :: Addr# -> [Char]
143 unpackCString# a = error "urk"
144 unpackFoldrCString# a = error "urk"
145 unpackAppendCString# a = error "urk"
146 unpackCStringUtf8# a = error "urk"
151 %*********************************************************
153 \subsection{Standard classes @Eq@, @Ord@}
155 %*********************************************************
159 -- | The 'Eq' class defines equality ('==') and inequality ('/=').
160 -- All the basic datatypes exported by the "Prelude" are instances of 'Eq',
161 -- and 'Eq' may be derived for any datatype whose constituents are also
162 -- instances of 'Eq'.
164 -- Minimal complete definition: either '==' or '/='.
167 (==), (/=) :: a -> a -> Bool
169 x /= y = not (x == y)
170 x == y = not (x /= y)
172 -- | The 'Ord' class is used for totally ordered datatypes.
174 -- Instances of 'Ord' can be derived for any user-defined
175 -- datatype whose constituent types are in 'Ord'. The declared order
176 -- of the constructors in the data declaration determines the ordering
177 -- in derived 'Ord' instances. The 'Ordering' datatype allows a single
178 -- comparison to determine the precise ordering of two objects.
180 -- Minimal complete definition: either 'compare' or '<='.
181 -- Using 'compare' can be more efficient for complex types.
183 class (Eq a) => Ord a where
184 compare :: a -> a -> Ordering
185 (<), (<=), (>), (>=) :: a -> a -> Bool
186 max, min :: a -> a -> a
190 | x <= y = LT -- NB: must be '<=' not '<' to validate the
191 -- above claim about the minimal things that
192 -- can be defined for an instance of Ord
195 x < y = case compare x y of { LT -> True; _other -> False }
196 x <= y = case compare x y of { GT -> False; _other -> True }
197 x > y = case compare x y of { GT -> True; _other -> False }
198 x >= y = case compare x y of { LT -> False; _other -> True }
200 -- These two default methods use '<=' rather than 'compare'
201 -- because the latter is often more expensive
202 max x y = if x <= y then y else x
203 min x y = if x <= y then x else y
206 %*********************************************************
208 \subsection{Monadic classes @Functor@, @Monad@ }
210 %*********************************************************
213 {- | The 'Functor' class is used for types that can be mapped over.
214 Instances of 'Functor' should satisfy the following laws:
217 > fmap (f . g) == fmap f . fmap g
219 The instances of 'Functor' for lists, 'Data.Maybe.Maybe' and 'System.IO.IO'
220 defined in the "Prelude" satisfy these laws.
223 class Functor f where
224 fmap :: (a -> b) -> f a -> f b
226 {- | The 'Monad' class defines the basic operations over a /monad/,
227 a concept from a branch of mathematics known as /category theory/.
228 From the perspective of a Haskell programmer, however, it is best to
229 think of a monad as an /abstract datatype/ of actions.
230 Haskell's @do@ expressions provide a convenient syntax for writing
233 Minimal complete definition: '>>=' and 'return'.
235 Instances of 'Monad' should satisfy the following laws:
237 > return a >>= k == k a
239 > m >>= (\x -> k x >>= h) == (m >>= k) >>= h
241 Instances of both 'Monad' and 'Functor' should additionally satisfy the law:
243 > fmap f xs == xs >>= return . f
245 The instances of 'Monad' for lists, 'Data.Maybe.Maybe' and 'System.IO.IO'
246 defined in the "Prelude" satisfy these laws.
250 -- | Sequentially compose two actions, passing any value produced
251 -- by the first as an argument to the second.
252 (>>=) :: forall a b. m a -> (a -> m b) -> m b
253 -- | Sequentially compose two actions, discarding any value produced
254 -- by the first, like sequencing operators (such as the semicolon)
255 -- in imperative languages.
256 (>>) :: forall a b. m a -> m b -> m b
257 -- Explicit for-alls so that we know what order to
258 -- give type arguments when desugaring
260 -- | Inject a value into the monadic type.
262 -- | Fail with a message. This operation is not part of the
263 -- mathematical definition of a monad, but is invoked on pattern-match
264 -- failure in a @do@ expression.
265 fail :: String -> m a
267 m >> k = m >>= \_ -> k
272 %*********************************************************
274 \subsection{The list type}
276 %*********************************************************
279 -- do explicitly: deriving (Eq, Ord)
280 -- to avoid weird names like con2tag_[]#
282 instance (Eq a) => Eq [a] where
283 {-# SPECIALISE instance Eq [Char] #-}
285 (x:xs) == (y:ys) = x == y && xs == ys
288 instance (Ord a) => Ord [a] where
289 {-# SPECIALISE instance Ord [Char] #-}
291 compare [] (_:_) = LT
292 compare (_:_) [] = GT
293 compare (x:xs) (y:ys) = case compare x y of
297 instance Functor [] where
300 instance Monad [] where
301 m >>= k = foldr ((++) . k) [] m
302 m >> k = foldr ((++) . (\ _ -> k)) [] m
307 A few list functions that appear here because they are used here.
308 The rest of the prelude list functions are in GHC.List.
310 ----------------------------------------------
311 -- foldr/build/augment
312 ----------------------------------------------
315 -- | 'foldr', applied to a binary operator, a starting value (typically
316 -- the right-identity of the operator), and a list, reduces the list
317 -- using the binary operator, from right to left:
319 -- > foldr f z [x1, x2, ..., xn] == x1 `f` (x2 `f` ... (xn `f` z)...)
321 foldr :: (a -> b -> b) -> b -> [a] -> b
323 -- foldr f z (x:xs) = f x (foldr f z xs)
324 {-# INLINE [0] foldr #-}
325 -- Inline only in the final stage, after the foldr/cons rule has had a chance
329 go (y:ys) = y `k` go ys
331 -- | A list producer that can be fused with 'foldr'.
332 -- This function is merely
334 -- > build g = g (:) []
336 -- but GHC's simplifier will transform an expression of the form
337 -- @'foldr' k z ('build' g)@, which may arise after inlining, to @g k z@,
338 -- which avoids producing an intermediate list.
340 build :: forall a. (forall b. (a -> b -> b) -> b -> b) -> [a]
341 {-# INLINE [1] build #-}
342 -- The INLINE is important, even though build is tiny,
343 -- because it prevents [] getting inlined in the version that
344 -- appears in the interface file. If [] *is* inlined, it
345 -- won't match with [] appearing in rules in an importing module.
347 -- The "1" says to inline in phase 1
351 -- | A list producer that can be fused with 'foldr'.
352 -- This function is merely
354 -- > augment g xs = g (:) xs
356 -- but GHC's simplifier will transform an expression of the form
357 -- @'foldr' k z ('augment' g xs)@, which may arise after inlining, to
358 -- @g k ('foldr' k z xs)@, which avoids producing an intermediate list.
360 augment :: forall a. (forall b. (a->b->b) -> b -> b) -> [a] -> [a]
361 {-# INLINE [1] augment #-}
362 augment g xs = g (:) xs
365 "fold/build" forall k z (g::forall b. (a->b->b) -> b -> b) .
366 foldr k z (build g) = g k z
368 "foldr/augment" forall k z xs (g::forall b. (a->b->b) -> b -> b) .
369 foldr k z (augment g xs) = g k (foldr k z xs)
371 "foldr/id" foldr (:) [] = \x -> x
372 "foldr/app" [1] forall ys. foldr (:) ys = \xs -> xs ++ ys
373 -- Only activate this from phase 1, because that's
374 -- when we disable the rule that expands (++) into foldr
376 -- The foldr/cons rule looks nice, but it can give disastrously
377 -- bloated code when commpiling
378 -- array (a,b) [(1,2), (2,2), (3,2), ...very long list... ]
379 -- i.e. when there are very very long literal lists
380 -- So I've disabled it for now. We could have special cases
381 -- for short lists, I suppose.
382 -- "foldr/cons" forall k z x xs. foldr k z (x:xs) = k x (foldr k z xs)
384 "foldr/single" forall k z x. foldr k z [x] = k x z
385 "foldr/nil" forall k z. foldr k z [] = z
387 "augment/build" forall (g::forall b. (a->b->b) -> b -> b)
388 (h::forall b. (a->b->b) -> b -> b) .
389 augment g (build h) = build (\c n -> g c (h c n))
390 "augment/nil" forall (g::forall b. (a->b->b) -> b -> b) .
391 augment g [] = build g
394 -- This rule is true, but not (I think) useful:
395 -- augment g (augment h t) = augment (\cn -> g c (h c n)) t
399 ----------------------------------------------
401 ----------------------------------------------
404 -- | 'map' @f xs@ is the list obtained by applying @f@ to each element
407 -- > map f [x1, x2, ..., xn] == [f x1, f x2, ..., f xn]
408 -- > map f [x1, x2, ...] == [f x1, f x2, ...]
410 map :: (a -> b) -> [a] -> [b]
412 map f (x:xs) = f x : map f xs
415 mapFB :: (elt -> lst -> lst) -> (a -> elt) -> a -> lst -> lst
416 {-# INLINE [0] mapFB #-}
417 mapFB c f x ys = c (f x) ys
419 -- The rules for map work like this.
421 -- Up to (but not including) phase 1, we use the "map" rule to
422 -- rewrite all saturated applications of map with its build/fold
423 -- form, hoping for fusion to happen.
424 -- In phase 1 and 0, we switch off that rule, inline build, and
425 -- switch on the "mapList" rule, which rewrites the foldr/mapFB
426 -- thing back into plain map.
428 -- It's important that these two rules aren't both active at once
429 -- (along with build's unfolding) else we'd get an infinite loop
430 -- in the rules. Hence the activation control below.
432 -- The "mapFB" rule optimises compositions of map.
434 -- This same pattern is followed by many other functions:
435 -- e.g. append, filter, iterate, repeat, etc.
438 "map" [~1] forall f xs. map f xs = build (\c n -> foldr (mapFB c f) n xs)
439 "mapList" [1] forall f. foldr (mapFB (:) f) [] = map f
440 "mapFB" forall c f g. mapFB (mapFB c f) g = mapFB c (f.g)
445 ----------------------------------------------
447 ----------------------------------------------
449 -- | Append two lists, i.e.,
451 -- > [x1, ..., xm] ++ [y1, ..., yn] == [x1, ..., xm, y1, ..., yn]
452 -- > [x1, ..., xm] ++ [y1, ...] == [x1, ..., xm, y1, ...]
454 -- If the first list is not finite, the result is the first list.
456 (++) :: [a] -> [a] -> [a]
458 (++) (x:xs) ys = x : xs ++ ys
461 "++" [~1] forall xs ys. xs ++ ys = augment (\c n -> foldr c n xs) ys
467 %*********************************************************
469 \subsection{Type @Bool@}
471 %*********************************************************
474 -- |The 'Bool' type is an enumeration. It is defined with 'False'
475 -- first so that the corresponding 'Prelude.Enum' instance will give
476 -- 'Prelude.fromEnum' 'False' the value zero, and
477 -- 'Prelude.fromEnum' 'True' the value 1.
478 -- The actual definition is in the ghc-prim package.
480 -- XXX These don't work:
481 -- deriving instance Eq Bool
482 -- deriving instance Ord Bool
483 -- <wired into compiler>:
484 -- Illegal binding of built-in syntax: con2tag_Bool#
486 instance Eq Bool where
488 False == False = True
491 instance Ord Bool where
492 compare False True = LT
493 compare True False = GT
496 -- Read is in GHC.Read, Show in GHC.Show
501 (&&) :: Bool -> Bool -> Bool
506 (||) :: Bool -> Bool -> Bool
515 -- |'otherwise' is defined as the value 'True'. It helps to make
516 -- guards more readable. eg.
518 -- > f x | x < 0 = ...
519 -- > | otherwise = ...
524 %*********************************************************
526 \subsection{Type @Ordering@}
528 %*********************************************************
531 -- | Represents an ordering relationship between two values: less
532 -- than, equal to, or greater than. An 'Ordering' is returned by
534 -- XXX These don't work:
535 -- deriving instance Eq Ordering
536 -- deriving instance Ord Ordering
537 -- Illegal binding of built-in syntax: con2tag_Ordering#
538 instance Eq Ordering where
543 -- Read in GHC.Read, Show in GHC.Show
545 instance Ord Ordering where
554 %*********************************************************
556 \subsection{Type @Char@ and @String@}
558 %*********************************************************
561 -- | A 'String' is a list of characters. String constants in Haskell are values
566 {-| The character type 'Char' is an enumeration whose values represent
567 Unicode (or equivalently ISO\/IEC 10646) characters
568 (see <http://www.unicode.org/> for details).
569 This set extends the ISO 8859-1 (Latin-1) character set
570 (the first 256 charachers), which is itself an extension of the ASCII
571 character set (the first 128 characters).
572 A character literal in Haskell has type 'Char'.
574 To convert a 'Char' to or from the corresponding 'Int' value defined
575 by Unicode, use 'Prelude.toEnum' and 'Prelude.fromEnum' from the
576 'Prelude.Enum' class respectively (or equivalently 'ord' and 'chr').
579 -- We don't use deriving for Eq and Ord, because for Ord the derived
580 -- instance defines only compare, which takes two primops. Then
581 -- '>' uses compare, and therefore takes two primops instead of one.
583 instance Eq Char where
584 (C# c1) == (C# c2) = c1 `eqChar#` c2
585 (C# c1) /= (C# c2) = c1 `neChar#` c2
587 instance Ord Char where
588 (C# c1) > (C# c2) = c1 `gtChar#` c2
589 (C# c1) >= (C# c2) = c1 `geChar#` c2
590 (C# c1) <= (C# c2) = c1 `leChar#` c2
591 (C# c1) < (C# c2) = c1 `ltChar#` c2
594 "x# `eqChar#` x#" forall x#. x# `eqChar#` x# = True
595 "x# `neChar#` x#" forall x#. x# `neChar#` x# = False
596 "x# `gtChar#` x#" forall x#. x# `gtChar#` x# = False
597 "x# `geChar#` x#" forall x#. x# `geChar#` x# = True
598 "x# `leChar#` x#" forall x#. x# `leChar#` x# = True
599 "x# `ltChar#` x#" forall x#. x# `ltChar#` x# = False
602 -- | The 'Prelude.toEnum' method restricted to the type 'Data.Char.Char'.
604 chr (I# i#) | int2Word# i# `leWord#` int2Word# 0x10FFFF# = C# (chr# i#)
605 | otherwise = error "Prelude.chr: bad argument"
607 unsafeChr :: Int -> Char
608 unsafeChr (I# i#) = C# (chr# i#)
610 -- | The 'Prelude.fromEnum' method restricted to the type 'Data.Char.Char'.
612 ord (C# c#) = I# (ord# c#)
615 String equality is used when desugaring pattern-matches against strings.
618 eqString :: String -> String -> Bool
619 eqString [] [] = True
620 eqString (c1:cs1) (c2:cs2) = c1 == c2 && cs1 `eqString` cs2
623 {-# RULES "eqString" (==) = eqString #-}
624 -- eqString also has a BuiltInRule in PrelRules.lhs:
625 -- eqString (unpackCString# (Lit s1)) (unpackCString# (Lit s2) = s1==s2
629 %*********************************************************
631 \subsection{Type @Int@}
633 %*********************************************************
637 -- ^A fixed-precision integer type with at least the range @[-2^29 .. 2^29-1]@.
638 -- The exact range for a given implementation can be determined by using
639 -- 'Prelude.minBound' and 'Prelude.maxBound' from the 'Prelude.Bounded' class.
641 zeroInt, oneInt, twoInt, maxInt, minInt :: Int
646 {- Seems clumsy. Should perhaps put minInt and MaxInt directly into MachDeps.h -}
647 #if WORD_SIZE_IN_BITS == 31
648 minInt = I# (-0x40000000#)
649 maxInt = I# 0x3FFFFFFF#
650 #elif WORD_SIZE_IN_BITS == 32
651 minInt = I# (-0x80000000#)
652 maxInt = I# 0x7FFFFFFF#
654 minInt = I# (-0x8000000000000000#)
655 maxInt = I# 0x7FFFFFFFFFFFFFFF#
658 instance Eq Int where
662 instance Ord Int where
669 compareInt :: Int -> Int -> Ordering
670 (I# x#) `compareInt` (I# y#) = compareInt# x# y#
672 compareInt# :: Int# -> Int# -> Ordering
680 %*********************************************************
682 \subsection{The function type}
684 %*********************************************************
687 -- | Identity function.
691 -- | The call '(lazy e)' means the same as 'e', but 'lazy' has a
692 -- magical strictness property: it is lazy in its first argument,
693 -- even though its semantics is strict.
696 -- Implementation note: its strictness and unfolding are over-ridden
697 -- by the definition in MkId.lhs; in both cases to nothing at all.
698 -- That way, 'lazy' does not get inlined, and the strictness analyser
699 -- sees it as lazy. Then the worker/wrapper phase inlines it.
703 -- | The call '(inline f)' reduces to 'f', but 'inline' has a BuiltInRule
704 -- that tries to inline 'f' (if it has an unfolding) unconditionally
705 -- The 'NOINLINE' pragma arranges that inline only gets inlined (and
706 -- hence eliminated) late in compilation, after the rule has had
707 -- a god chance to fire.
709 {-# NOINLINE[0] inline #-}
712 -- Assertion function. This simply ignores its boolean argument.
713 -- The compiler may rewrite it to @('assertError' line)@.
715 -- | If the first argument evaluates to 'True', then the result is the
716 -- second argument. Otherwise an 'AssertionFailed' exception is raised,
717 -- containing a 'String' with the source file and line number of the
720 -- Assertions can normally be turned on or off with a compiler flag
721 -- (for GHC, assertions are normally on unless optimisation is turned on
722 -- with @-O@ or the @-fignore-asserts@
723 -- option is given). When assertions are turned off, the first
724 -- argument to 'assert' is ignored, and the second argument is
725 -- returned as the result.
727 -- SLPJ: in 5.04 etc 'assert' is in GHC.Prim,
728 -- but from Template Haskell onwards it's simply
729 -- defined here in Base.lhs
730 assert :: Bool -> a -> a
736 breakpointCond :: Bool -> a -> a
737 breakpointCond _ r = r
739 data Opaque = forall a. O a
741 -- | Constant function.
745 -- | Function composition.
747 (.) :: (b -> c) -> (a -> b) -> a -> c
750 -- | @'flip' f@ takes its (first) two arguments in the reverse order of @f@.
751 flip :: (a -> b -> c) -> b -> a -> c
754 -- | Application operator. This operator is redundant, since ordinary
755 -- application @(f x)@ means the same as @(f '$' x)@. However, '$' has
756 -- low, right-associative binding precedence, so it sometimes allows
757 -- parentheses to be omitted; for example:
759 -- > f $ g $ h x = f (g (h x))
761 -- It is also useful in higher-order situations, such as @'map' ('$' 0) xs@,
762 -- or @'Data.List.zipWith' ('$') fs xs@.
764 ($) :: (a -> b) -> a -> b
767 -- | @'until' p f@ yields the result of applying @f@ until @p@ holds.
768 until :: (a -> Bool) -> (a -> a) -> a -> a
769 until p f x | p x = x
770 | otherwise = until p f (f x)
772 -- | 'asTypeOf' is a type-restricted version of 'const'. It is usually
773 -- used as an infix operator, and its typing forces its first argument
774 -- (which is usually overloaded) to have the same type as the second.
775 asTypeOf :: a -> a -> a
779 %*********************************************************
781 \subsection{@getTag@}
783 %*********************************************************
785 Returns the 'tag' of a constructor application; this function is used
786 by the deriving code for Eq, Ord and Enum.
788 The primitive dataToTag# requires an evaluated constructor application
789 as its argument, so we provide getTag as a wrapper that performs the
790 evaluation before calling dataToTag#. We could have dataToTag#
791 evaluate its argument, but we prefer to do it this way because (a)
792 dataToTag# can be an inline primop if it doesn't need to do any
793 evaluation, and (b) we want to expose the evaluation to the
794 simplifier, because it might be possible to eliminate the evaluation
795 in the case when the argument is already known to be evaluated.
798 {-# INLINE getTag #-}
800 getTag x = x `seq` dataToTag# x
803 %*********************************************************
805 \subsection{Numeric primops}
807 %*********************************************************
810 divInt# :: Int# -> Int# -> Int#
812 -- Be careful NOT to overflow if we do any additional arithmetic
813 -- on the arguments... the following previous version of this
814 -- code has problems with overflow:
815 -- | (x# ># 0#) && (y# <# 0#) = ((x# -# y#) -# 1#) `quotInt#` y#
816 -- | (x# <# 0#) && (y# ># 0#) = ((x# -# y#) +# 1#) `quotInt#` y#
817 | (x# ># 0#) && (y# <# 0#) = ((x# -# 1#) `quotInt#` y#) -# 1#
818 | (x# <# 0#) && (y# ># 0#) = ((x# +# 1#) `quotInt#` y#) -# 1#
819 | otherwise = x# `quotInt#` y#
821 modInt# :: Int# -> Int# -> Int#
823 | (x# ># 0#) && (y# <# 0#) ||
824 (x# <# 0#) && (y# ># 0#) = if r# /=# 0# then r# +# y# else 0#
830 Definitions of the boxed PrimOps; these will be
831 used in the case of partial applications, etc.
840 {-# INLINE plusInt #-}
841 {-# INLINE minusInt #-}
842 {-# INLINE timesInt #-}
843 {-# INLINE quotInt #-}
844 {-# INLINE remInt #-}
845 {-# INLINE negateInt #-}
847 plusInt, minusInt, timesInt, quotInt, remInt, divInt, modInt, gcdInt :: Int -> Int -> Int
848 (I# x) `plusInt` (I# y) = I# (x +# y)
849 (I# x) `minusInt` (I# y) = I# (x -# y)
850 (I# x) `timesInt` (I# y) = I# (x *# y)
851 (I# x) `quotInt` (I# y) = I# (x `quotInt#` y)
852 (I# x) `remInt` (I# y) = I# (x `remInt#` y)
853 (I# x) `divInt` (I# y) = I# (x `divInt#` y)
854 (I# x) `modInt` (I# y) = I# (x `modInt#` y)
857 "x# +# 0#" forall x#. x# +# 0# = x#
858 "0# +# x#" forall x#. 0# +# x# = x#
859 "x# -# 0#" forall x#. x# -# 0# = x#
860 "x# -# x#" forall x#. x# -# x# = 0#
861 "x# *# 0#" forall x#. x# *# 0# = 0#
862 "0# *# x#" forall x#. 0# *# x# = 0#
863 "x# *# 1#" forall x#. x# *# 1# = x#
864 "1# *# x#" forall x#. 1# *# x# = x#
867 gcdInt (I# a) (I# b) = g a b
868 where g 0# 0# = error "GHC.Base.gcdInt: gcd 0 0 is undefined"
871 g _ _ = I# (gcdInt# absA absB)
873 absInt x = if x <# 0# then negateInt# x else x
878 negateInt :: Int -> Int
879 negateInt (I# x) = I# (negateInt# x)
881 gtInt, geInt, eqInt, neInt, ltInt, leInt :: Int -> Int -> Bool
882 (I# x) `gtInt` (I# y) = x ># y
883 (I# x) `geInt` (I# y) = x >=# y
884 (I# x) `eqInt` (I# y) = x ==# y
885 (I# x) `neInt` (I# y) = x /=# y
886 (I# x) `ltInt` (I# y) = x <# y
887 (I# x) `leInt` (I# y) = x <=# y
890 "x# ># x#" forall x#. x# ># x# = False
891 "x# >=# x#" forall x#. x# >=# x# = True
892 "x# ==# x#" forall x#. x# ==# x# = True
893 "x# /=# x#" forall x#. x# /=# x# = False
894 "x# <# x#" forall x#. x# <# x# = False
895 "x# <=# x#" forall x#. x# <=# x# = True
899 "plusFloat x 0.0" forall x#. plusFloat# x# 0.0# = x#
900 "plusFloat 0.0 x" forall x#. plusFloat# 0.0# x# = x#
901 "minusFloat x 0.0" forall x#. minusFloat# x# 0.0# = x#
902 "minusFloat x x" forall x#. minusFloat# x# x# = 0.0#
903 "timesFloat x 0.0" forall x#. timesFloat# x# 0.0# = 0.0#
904 "timesFloat0.0 x" forall x#. timesFloat# 0.0# x# = 0.0#
905 "timesFloat x 1.0" forall x#. timesFloat# x# 1.0# = x#
906 "timesFloat 1.0 x" forall x#. timesFloat# 1.0# x# = x#
907 "divideFloat x 1.0" forall x#. divideFloat# x# 1.0# = x#
911 "plusDouble x 0.0" forall x#. (+##) x# 0.0## = x#
912 "plusDouble 0.0 x" forall x#. (+##) 0.0## x# = x#
913 "minusDouble x 0.0" forall x#. (-##) x# 0.0## = x#
914 "timesDouble x 1.0" forall x#. (*##) x# 1.0## = x#
915 "timesDouble 1.0 x" forall x#. (*##) 1.0## x# = x#
916 "divideDouble x 1.0" forall x#. (/##) x# 1.0## = x#
920 We'd like to have more rules, but for example:
922 This gives wrong answer (0) for NaN - NaN (should be NaN):
923 "minusDouble x x" forall x#. (-##) x# x# = 0.0##
925 This gives wrong answer (0) for 0 * NaN (should be NaN):
926 "timesDouble 0.0 x" forall x#. (*##) 0.0## x# = 0.0##
928 This gives wrong answer (0) for NaN * 0 (should be NaN):
929 "timesDouble x 0.0" forall x#. (*##) x# 0.0## = 0.0##
931 These are tested by num014.
934 -- Wrappers for the shift operations. The uncheckedShift# family are
935 -- undefined when the amount being shifted by is greater than the size
936 -- in bits of Int#, so these wrappers perform a check and return
937 -- either zero or -1 appropriately.
939 -- Note that these wrappers still produce undefined results when the
940 -- second argument (the shift amount) is negative.
942 -- | Shift the argument left by the specified number of bits
943 -- (which must be non-negative).
944 shiftL# :: Word# -> Int# -> Word#
945 a `shiftL#` b | b >=# WORD_SIZE_IN_BITS# = int2Word# 0#
946 | otherwise = a `uncheckedShiftL#` b
948 -- | Shift the argument right by the specified number of bits
949 -- (which must be non-negative).
950 shiftRL# :: Word# -> Int# -> Word#
951 a `shiftRL#` b | b >=# WORD_SIZE_IN_BITS# = int2Word# 0#
952 | otherwise = a `uncheckedShiftRL#` b
954 -- | Shift the argument left by the specified number of bits
955 -- (which must be non-negative).
956 iShiftL# :: Int# -> Int# -> Int#
957 a `iShiftL#` b | b >=# WORD_SIZE_IN_BITS# = 0#
958 | otherwise = a `uncheckedIShiftL#` b
960 -- | Shift the argument right (signed) by the specified number of bits
961 -- (which must be non-negative).
962 iShiftRA# :: Int# -> Int# -> Int#
963 a `iShiftRA#` b | b >=# WORD_SIZE_IN_BITS# = if a <# 0# then (-1#) else 0#
964 | otherwise = a `uncheckedIShiftRA#` b
966 -- | Shift the argument right (unsigned) by the specified number of bits
967 -- (which must be non-negative).
968 iShiftRL# :: Int# -> Int# -> Int#
969 a `iShiftRL#` b | b >=# WORD_SIZE_IN_BITS# = 0#
970 | otherwise = a `uncheckedIShiftRL#` b
972 #if WORD_SIZE_IN_BITS == 32
974 "narrow32Int#" forall x#. narrow32Int# x# = x#
975 "narrow32Word#" forall x#. narrow32Word# x# = x#
980 "int2Word2Int" forall x#. int2Word# (word2Int# x#) = x#
981 "word2Int2Word" forall x#. word2Int# (int2Word# x#) = x#
986 %********************************************************
988 \subsection{Unpacking C strings}
990 %********************************************************
992 This code is needed for virtually all programs, since it's used for
993 unpacking the strings of error messages.
996 unpackCString# :: Addr# -> [Char]
997 {-# NOINLINE [1] unpackCString# #-}
1002 | ch `eqChar#` '\0'# = []
1003 | otherwise = C# ch : unpack (nh +# 1#)
1005 ch = indexCharOffAddr# addr nh
1007 unpackAppendCString# :: Addr# -> [Char] -> [Char]
1008 unpackAppendCString# addr rest
1012 | ch `eqChar#` '\0'# = rest
1013 | otherwise = C# ch : unpack (nh +# 1#)
1015 ch = indexCharOffAddr# addr nh
1017 unpackFoldrCString# :: Addr# -> (Char -> a -> a) -> a -> a
1018 {-# NOINLINE [0] unpackFoldrCString# #-}
1019 -- Don't inline till right at the end;
1020 -- usually the unpack-list rule turns it into unpackCStringList
1021 -- It also has a BuiltInRule in PrelRules.lhs:
1022 -- unpackFoldrCString# "foo" c (unpackFoldrCString# "baz" c n)
1023 -- = unpackFoldrCString# "foobaz" c n
1024 unpackFoldrCString# addr f z
1028 | ch `eqChar#` '\0'# = z
1029 | otherwise = C# ch `f` unpack (nh +# 1#)
1031 ch = indexCharOffAddr# addr nh
1033 unpackCStringUtf8# :: Addr# -> [Char]
1034 unpackCStringUtf8# addr
1038 | ch `eqChar#` '\0'# = []
1039 | ch `leChar#` '\x7F'# = C# ch : unpack (nh +# 1#)
1040 | ch `leChar#` '\xDF'# =
1041 C# (chr# (((ord# ch -# 0xC0#) `uncheckedIShiftL#` 6#) +#
1042 (ord# (indexCharOffAddr# addr (nh +# 1#)) -# 0x80#))) :
1044 | ch `leChar#` '\xEF'# =
1045 C# (chr# (((ord# ch -# 0xE0#) `uncheckedIShiftL#` 12#) +#
1046 ((ord# (indexCharOffAddr# addr (nh +# 1#)) -# 0x80#) `uncheckedIShiftL#` 6#) +#
1047 (ord# (indexCharOffAddr# addr (nh +# 2#)) -# 0x80#))) :
1050 C# (chr# (((ord# ch -# 0xF0#) `uncheckedIShiftL#` 18#) +#
1051 ((ord# (indexCharOffAddr# addr (nh +# 1#)) -# 0x80#) `uncheckedIShiftL#` 12#) +#
1052 ((ord# (indexCharOffAddr# addr (nh +# 2#)) -# 0x80#) `uncheckedIShiftL#` 6#) +#
1053 (ord# (indexCharOffAddr# addr (nh +# 3#)) -# 0x80#))) :
1056 ch = indexCharOffAddr# addr nh
1058 unpackNBytes# :: Addr# -> Int# -> [Char]
1059 unpackNBytes# _addr 0# = []
1060 unpackNBytes# addr len# = unpack [] (len# -# 1#)
1065 case indexCharOffAddr# addr i# of
1066 ch -> unpack (C# ch : acc) (i# -# 1#)
1069 "unpack" [~1] forall a . unpackCString# a = build (unpackFoldrCString# a)
1070 "unpack-list" [1] forall a . unpackFoldrCString# a (:) [] = unpackCString# a
1071 "unpack-append" forall a n . unpackFoldrCString# a (:) n = unpackAppendCString# a n
1073 -- There's a built-in rule (in PrelRules.lhs) for
1074 -- unpackFoldr "foo" c (unpackFoldr "baz" c n) = unpackFoldr "foobaz" c n
1081 -- | A special argument for the 'Control.Monad.ST.ST' type constructor,
1082 -- indexing a state embedded in the 'Prelude.IO' monad by
1083 -- 'Control.Monad.ST.stToIO'.