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 -fno-implicit-prelude #-}
66 -----------------------------------------------------------------------------
69 -- Copyright : (c) The University of Glasgow, 1992-2002
70 -- License : see libraries/base/LICENSE
72 -- Maintainer : cvs-ghc@haskell.org
73 -- Stability : internal
74 -- Portability : non-portable (GHC extensions)
76 -- Basic data types and classes.
78 -----------------------------------------------------------------------------
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
92 import {-# SOURCE #-} GHC.Err
96 infix 4 ==, /=, <, <=, >=, >
102 default () -- Double isn't available yet
106 %*********************************************************
108 \subsection{DEBUGGING STUFF}
109 %* (for use when compiling GHC.Base itself doesn't work)
111 %*********************************************************
115 data Bool = False | True
116 data Ordering = LT | EQ | GT
124 (&&) True True = True
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"
142 %*********************************************************
144 \subsection{Standard classes @Eq@, @Ord@}
146 %*********************************************************
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'.
155 -- Minimal complete definition: either '==' or '/='.
158 (==), (/=) :: a -> a -> Bool
160 x /= y = not (x == y)
161 x == y = not (x /= y)
163 -- | The 'Ord' class is used for totally ordered datatypes.
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.
171 -- Minimal complete definition: either 'compare' or '<='.
172 -- Using 'compare' can be more efficient for complex types.
174 class (Eq a) => Ord a where
175 compare :: a -> a -> Ordering
176 (<), (<=), (>), (>=) :: a -> a -> Bool
177 max, min :: a -> a -> a
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
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 }
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
197 %*********************************************************
199 \subsection{Monadic classes @Functor@, @Monad@ }
201 %*********************************************************
204 {- | The 'Functor' class is used for types that can be mapped over.
205 Instances of 'Functor' should satisfy the following laws:
208 > fmap (f . g) == fmap f . fmap g
210 The instances of 'Functor' for lists, 'Data.Maybe.Maybe' and 'System.IO.IO'
211 defined in the "Prelude" satisfy these laws.
214 class Functor f where
215 fmap :: (a -> b) -> f a -> f b
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
224 Minimal complete definition: '>>=' and 'return'.
226 Instances of 'Monad' should satisfy the following laws:
228 > return a >>= k == k a
230 > m >>= (\x -> k x >>= h) == (m >>= k) >>= h
232 Instances of both 'Monad' and 'Functor' should additionally satisfy the law:
234 > fmap f xs == xs >>= return . f
236 The instances of 'Monad' for lists, 'Data.Maybe.Maybe' and 'System.IO.IO'
237 defined in the "Prelude" satisfy these laws.
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
251 -- | Inject a value into the monadic type.
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
258 m >> k = m >>= \_ -> k
263 %*********************************************************
265 \subsection{The list type}
267 %*********************************************************
270 data [] a = [] | a : [a] -- do explicitly: deriving (Eq, Ord)
271 -- to avoid weird names like con2tag_[]#
274 instance (Eq a) => Eq [a] where
275 {-# SPECIALISE instance Eq [Char] #-}
277 (x:xs) == (y:ys) = x == y && xs == ys
280 instance (Ord a) => Ord [a] where
281 {-# SPECIALISE instance Ord [Char] #-}
283 compare [] (_:_) = LT
284 compare (_:_) [] = GT
285 compare (x:xs) (y:ys) = case compare x y of
289 instance Functor [] where
292 instance Monad [] where
293 m >>= k = foldr ((++) . k) [] m
294 m >> k = foldr ((++) . (\ _ -> k)) [] m
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.
302 ----------------------------------------------
303 -- foldr/build/augment
304 ----------------------------------------------
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:
311 -- > foldr f z [x1, x2, ..., xn] == x1 `f` (x2 `f` ... (xn `f` z)...)
313 foldr :: (a -> b -> b) -> b -> [a] -> b
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
321 go (y:ys) = y `k` go ys
323 -- | A list producer that can be fused with 'foldr'.
324 -- This function is merely
326 -- > build g = g (:) []
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.
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.
339 -- The "1" says to inline in phase 1
343 -- | A list producer that can be fused with 'foldr'.
344 -- This function is merely
346 -- > augment g xs = g (:) xs
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.
352 augment :: forall a. (forall b. (a->b->b) -> b -> b) -> [a] -> [a]
353 {-# INLINE [1] augment #-}
354 augment g xs = g (:) xs
357 "fold/build" forall k z (g::forall b. (a->b->b) -> b -> b) .
358 foldr k z (build g) = g k z
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)
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
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)
376 "foldr/single" forall k z x. foldr k z [x] = k x z
377 "foldr/nil" forall k z. foldr k z [] = z
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
386 -- This rule is true, but not (I think) useful:
387 -- augment g (augment h t) = augment (\cn -> g c (h c n)) t
391 ----------------------------------------------
393 ----------------------------------------------
396 -- | 'map' @f xs@ is the list obtained by applying @f@ to each element
399 -- > map f [x1, x2, ..., xn] == [f x1, f x2, ..., f xn]
400 -- > map f [x1, x2, ...] == [f x1, f x2, ...]
402 map :: (a -> b) -> [a] -> [b]
404 map f (x:xs) = f x : map f xs
407 mapFB :: (elt -> lst -> lst) -> (a -> elt) -> a -> lst -> lst
408 {-# INLINE [0] mapFB #-}
409 mapFB c f x ys = c (f x) ys
411 -- The rules for map work like this.
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.
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.
424 -- The "mapFB" rule optimises compositions of map.
426 -- This same pattern is followed by many other functions:
427 -- e.g. append, filter, iterate, repeat, etc.
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)
437 ----------------------------------------------
439 ----------------------------------------------
441 -- | Append two lists, i.e.,
443 -- > [x1, ..., xm] ++ [y1, ..., yn] == [x1, ..., xm, y1, ..., yn]
444 -- > [x1, ..., xm] ++ [y1, ...] == [x1, ..., xm, y1, ...]
446 -- If the first list is not finite, the result is the first list.
448 (++) :: [a] -> [a] -> [a]
450 (++) (x:xs) ys = x : xs ++ ys
453 "++" [~1] forall xs ys. xs ++ ys = augment (\c n -> foldr c n xs) ys
459 %*********************************************************
461 \subsection{Type @Bool@}
463 %*********************************************************
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
476 (&&) :: Bool -> Bool -> Bool
481 (||) :: Bool -> Bool -> Bool
490 -- |'otherwise' is defined as the value 'True'. It helps to make
491 -- guards more readable. eg.
493 -- > f x | x < 0 = ...
494 -- > | otherwise = ...
499 %*********************************************************
501 \subsection{The @()@ type}
503 %*********************************************************
505 The Unit type is here because virtually any program needs it (whereas
506 some programs may get away without consulting GHC.Tup). Furthermore,
507 the renamer currently *always* asks for () to be in scope, so that
508 ccalls can use () as their default type; so when compiling GHC.Base we
509 need (). (We could arrange suck in () only if -fglasgow-exts, but putting
510 it here seems more direct.)
513 -- | The unit datatype @()@ has one non-undefined member, the nullary
521 instance Ord () where
532 %*********************************************************
534 \subsection{Type @Ordering@}
536 %*********************************************************
539 -- | Represents an ordering relationship between two values: less
540 -- than, equal to, or greater than. An 'Ordering' is returned by
542 data Ordering = LT | EQ | GT deriving (Eq, Ord)
543 -- Read in GHC.Read, Show in GHC.Show
547 %*********************************************************
549 \subsection{Type @Char@ and @String@}
551 %*********************************************************
554 -- | A 'String' is a list of characters. String constants in Haskell are values
559 {-| The character type 'Char' is an enumeration whose values represent
560 Unicode (or equivalently ISO\/IEC 10646) characters
561 (see <http://www.unicode.org/> for details).
562 This set extends the ISO 8859-1 (Latin-1) character set
563 (the first 256 charachers), which is itself an extension of the ASCII
564 character set (the first 128 characters).
565 A character literal in Haskell has type 'Char'.
567 To convert a 'Char' to or from the corresponding 'Int' value defined
568 by Unicode, use 'Prelude.toEnum' and 'Prelude.fromEnum' from the
569 'Prelude.Enum' class respectively (or equivalently 'ord' and 'chr').
573 -- We don't use deriving for Eq and Ord, because for Ord the derived
574 -- instance defines only compare, which takes two primops. Then
575 -- '>' uses compare, and therefore takes two primops instead of one.
577 instance Eq Char where
578 (C# c1) == (C# c2) = c1 `eqChar#` c2
579 (C# c1) /= (C# c2) = c1 `neChar#` c2
581 instance Ord Char where
582 (C# c1) > (C# c2) = c1 `gtChar#` c2
583 (C# c1) >= (C# c2) = c1 `geChar#` c2
584 (C# c1) <= (C# c2) = c1 `leChar#` c2
585 (C# c1) < (C# c2) = c1 `ltChar#` c2
588 "x# `eqChar#` x#" forall x#. x# `eqChar#` x# = True
589 "x# `neChar#` x#" forall x#. x# `neChar#` x# = False
590 "x# `gtChar#` x#" forall x#. x# `gtChar#` x# = False
591 "x# `geChar#` x#" forall x#. x# `geChar#` x# = True
592 "x# `leChar#` x#" forall x#. x# `leChar#` x# = True
593 "x# `ltChar#` x#" forall x#. x# `ltChar#` x# = False
596 -- | The 'Prelude.toEnum' method restricted to the type 'Data.Char.Char'.
598 chr (I# i#) | int2Word# i# `leWord#` int2Word# 0x10FFFF# = C# (chr# i#)
599 | otherwise = error "Prelude.chr: bad argument"
601 unsafeChr :: Int -> Char
602 unsafeChr (I# i#) = C# (chr# i#)
604 -- | The 'Prelude.fromEnum' method restricted to the type 'Data.Char.Char'.
606 ord (C# c#) = I# (ord# c#)
609 String equality is used when desugaring pattern-matches against strings.
612 eqString :: String -> String -> Bool
613 eqString [] [] = True
614 eqString (c1:cs1) (c2:cs2) = c1 == c2 && cs1 `eqString` cs2
615 eqString cs1 cs2 = False
617 {-# RULES "eqString" (==) = eqString #-}
618 -- eqString also has a BuiltInRule in PrelRules.lhs:
619 -- eqString (unpackCString# (Lit s1)) (unpackCString# (Lit s2) = s1==s2
623 %*********************************************************
625 \subsection{Type @Int@}
627 %*********************************************************
631 -- ^A fixed-precision integer type with at least the range @[-2^29 .. 2^29-1]@.
632 -- The exact range for a given implementation can be determined by using
633 -- 'Prelude.minBound' and 'Prelude.maxBound' from the 'Prelude.Bounded' class.
635 zeroInt, oneInt, twoInt, maxInt, minInt :: Int
640 {- Seems clumsy. Should perhaps put minInt and MaxInt directly into MachDeps.h -}
641 #if WORD_SIZE_IN_BITS == 31
642 minInt = I# (-0x40000000#)
643 maxInt = I# 0x3FFFFFFF#
644 #elif WORD_SIZE_IN_BITS == 32
645 minInt = I# (-0x80000000#)
646 maxInt = I# 0x7FFFFFFF#
648 minInt = I# (-0x8000000000000000#)
649 maxInt = I# 0x7FFFFFFFFFFFFFFF#
652 instance Eq Int where
656 instance Ord Int where
663 compareInt :: Int -> Int -> Ordering
664 (I# x#) `compareInt` (I# y#) = compareInt# x# y#
666 compareInt# :: Int# -> Int# -> Ordering
674 %*********************************************************
676 \subsection{The function type}
678 %*********************************************************
681 -- | Identity function.
685 -- | The call '(lazy e)' means the same as 'e', but 'lazy' has a
686 -- magical strictness property: it is lazy in its first argument,
687 -- even though its semantics is strict.
690 -- Implementation note: its strictness and unfolding are over-ridden
691 -- by the definition in MkId.lhs; in both cases to nothing at all.
692 -- That way, 'lazy' does not get inlined, and the strictness analyser
693 -- sees it as lazy. Then the worker/wrapper phase inlines it.
697 -- | The call '(inline f)' reduces to 'f', but 'inline' has a BuiltInRule
698 -- that tries to inline 'f' (if it has an unfolding) unconditionally
699 -- The 'NOINLINE' pragma arranges that inline only gets inlined (and
700 -- hence eliminated) late in compilation, after the rule has had
701 -- a god chance to fire.
703 {-# NOINLINE[0] inline #-}
706 -- Assertion function. This simply ignores its boolean argument.
707 -- The compiler may rewrite it to @('assertError' line)@.
709 -- | If the first argument evaluates to 'True', then the result is the
710 -- second argument. Otherwise an 'AssertionFailed' exception is raised,
711 -- containing a 'String' with the source file and line number of the
714 -- Assertions can normally be turned on or off with a compiler flag
715 -- (for GHC, assertions are normally on unless optimisation is turned on
716 -- with @-O@ or the @-fignore-asserts@
717 -- option is given). When assertions are turned off, the first
718 -- argument to 'assert' is ignored, and the second argument is
719 -- returned as the result.
721 -- SLPJ: in 5.04 etc 'assert' is in GHC.Prim,
722 -- but from Template Haskell onwards it's simply
723 -- defined here in Base.lhs
724 assert :: Bool -> a -> a
730 breakpointCond :: Bool -> a -> a
731 breakpointCond _ r = r
737 data Unknown4 a b c d
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{Generics}
783 %*********************************************************
788 data (:+:) a b = Inl a | Inr b
789 data (:*:) a b = a :*: b
793 %*********************************************************
795 \subsection{@getTag@}
797 %*********************************************************
799 Returns the 'tag' of a constructor application; this function is used
800 by the deriving code for Eq, Ord and Enum.
802 The primitive dataToTag# requires an evaluated constructor application
803 as its argument, so we provide getTag as a wrapper that performs the
804 evaluation before calling dataToTag#. We could have dataToTag#
805 evaluate its argument, but we prefer to do it this way because (a)
806 dataToTag# can be an inline primop if it doesn't need to do any
807 evaluation, and (b) we want to expose the evaluation to the
808 simplifier, because it might be possible to eliminate the evaluation
809 in the case when the argument is already known to be evaluated.
812 {-# INLINE getTag #-}
814 getTag x = x `seq` dataToTag# x
817 %*********************************************************
819 \subsection{Numeric primops}
821 %*********************************************************
824 divInt# :: Int# -> Int# -> Int#
826 -- Be careful NOT to overflow if we do any additional arithmetic
827 -- on the arguments... the following previous version of this
828 -- code has problems with overflow:
829 -- | (x# ># 0#) && (y# <# 0#) = ((x# -# y#) -# 1#) `quotInt#` y#
830 -- | (x# <# 0#) && (y# ># 0#) = ((x# -# y#) +# 1#) `quotInt#` y#
831 | (x# ># 0#) && (y# <# 0#) = ((x# -# 1#) `quotInt#` y#) -# 1#
832 | (x# <# 0#) && (y# ># 0#) = ((x# +# 1#) `quotInt#` y#) -# 1#
833 | otherwise = x# `quotInt#` y#
835 modInt# :: Int# -> Int# -> Int#
837 | (x# ># 0#) && (y# <# 0#) ||
838 (x# <# 0#) && (y# ># 0#) = if r# /=# 0# then r# +# y# else 0#
844 Definitions of the boxed PrimOps; these will be
845 used in the case of partial applications, etc.
854 {-# INLINE plusInt #-}
855 {-# INLINE minusInt #-}
856 {-# INLINE timesInt #-}
857 {-# INLINE quotInt #-}
858 {-# INLINE remInt #-}
859 {-# INLINE negateInt #-}
861 plusInt, minusInt, timesInt, quotInt, remInt, divInt, modInt, gcdInt :: Int -> Int -> Int
862 (I# x) `plusInt` (I# y) = I# (x +# y)
863 (I# x) `minusInt` (I# y) = I# (x -# y)
864 (I# x) `timesInt` (I# y) = I# (x *# y)
865 (I# x) `quotInt` (I# y) = I# (x `quotInt#` y)
866 (I# x) `remInt` (I# y) = I# (x `remInt#` y)
867 (I# x) `divInt` (I# y) = I# (x `divInt#` y)
868 (I# x) `modInt` (I# y) = I# (x `modInt#` y)
871 "x# +# 0#" forall x#. x# +# 0# = x#
872 "0# +# x#" forall x#. 0# +# x# = x#
873 "x# -# 0#" forall x#. x# -# 0# = x#
874 "x# -# x#" forall x#. x# -# x# = 0#
875 "x# *# 0#" forall x#. x# *# 0# = 0#
876 "0# *# x#" forall x#. 0# *# x# = 0#
877 "x# *# 1#" forall x#. x# *# 1# = x#
878 "1# *# x#" forall x#. 1# *# x# = x#
881 gcdInt (I# a) (I# b) = g a b
882 where g 0# 0# = error "GHC.Base.gcdInt: gcd 0 0 is undefined"
885 g _ _ = I# (gcdInt# absA absB)
887 absInt x = if x <# 0# then negateInt# x else x
892 negateInt :: Int -> Int
893 negateInt (I# x) = I# (negateInt# x)
895 gtInt, geInt, eqInt, neInt, ltInt, leInt :: Int -> Int -> Bool
896 (I# x) `gtInt` (I# y) = x ># y
897 (I# x) `geInt` (I# y) = x >=# y
898 (I# x) `eqInt` (I# y) = x ==# y
899 (I# x) `neInt` (I# y) = x /=# y
900 (I# x) `ltInt` (I# y) = x <# y
901 (I# x) `leInt` (I# y) = x <=# y
904 "x# ># x#" forall x#. x# ># x# = False
905 "x# >=# x#" forall x#. x# >=# x# = True
906 "x# ==# x#" forall x#. x# ==# x# = True
907 "x# /=# x#" forall x#. x# /=# x# = False
908 "x# <# x#" forall x#. x# <# x# = False
909 "x# <=# x#" forall x#. x# <=# x# = True
913 "plusFloat x 0.0" forall x#. plusFloat# x# 0.0# = x#
914 "plusFloat 0.0 x" forall x#. plusFloat# 0.0# x# = x#
915 "minusFloat x 0.0" forall x#. minusFloat# x# 0.0# = x#
916 "minusFloat x x" forall x#. minusFloat# x# x# = 0.0#
917 "timesFloat x 0.0" forall x#. timesFloat# x# 0.0# = 0.0#
918 "timesFloat0.0 x" forall x#. timesFloat# 0.0# x# = 0.0#
919 "timesFloat x 1.0" forall x#. timesFloat# x# 1.0# = x#
920 "timesFloat 1.0 x" forall x#. timesFloat# 1.0# x# = x#
921 "divideFloat x 1.0" forall x#. divideFloat# x# 1.0# = x#
925 "plusDouble x 0.0" forall x#. (+##) x# 0.0## = x#
926 "plusDouble 0.0 x" forall x#. (+##) 0.0## x# = x#
927 "minusDouble x 0.0" forall x#. (-##) x# 0.0## = x#
928 "minusDouble x x" forall x#. (-##) x# x# = 0.0##
929 "timesDouble x 0.0" forall x#. (*##) x# 0.0## = 0.0##
930 "timesDouble 0.0 x" forall x#. (*##) 0.0## x# = 0.0##
931 "timesDouble x 1.0" forall x#. (*##) x# 1.0## = x#
932 "timesDouble 1.0 x" forall x#. (*##) 1.0## x# = x#
933 "divideDouble x 1.0" forall x#. (/##) x# 1.0## = x#
936 -- Wrappers for the shift operations. The uncheckedShift# family are
937 -- undefined when the amount being shifted by is greater than the size
938 -- in bits of Int#, so these wrappers perform a check and return
939 -- either zero or -1 appropriately.
941 -- Note that these wrappers still produce undefined results when the
942 -- second argument (the shift amount) is negative.
944 -- | Shift the argument left by the specified number of bits
945 -- (which must be non-negative).
946 shiftL# :: Word# -> Int# -> Word#
947 a `shiftL#` b | b >=# WORD_SIZE_IN_BITS# = int2Word# 0#
948 | otherwise = a `uncheckedShiftL#` b
950 -- | Shift the argument right by the specified number of bits
951 -- (which must be non-negative).
952 shiftRL# :: Word# -> Int# -> Word#
953 a `shiftRL#` b | b >=# WORD_SIZE_IN_BITS# = int2Word# 0#
954 | otherwise = a `uncheckedShiftRL#` b
956 -- | Shift the argument left by the specified number of bits
957 -- (which must be non-negative).
958 iShiftL# :: Int# -> Int# -> Int#
959 a `iShiftL#` b | b >=# WORD_SIZE_IN_BITS# = 0#
960 | otherwise = a `uncheckedIShiftL#` b
962 -- | Shift the argument right (signed) by the specified number of bits
963 -- (which must be non-negative).
964 iShiftRA# :: Int# -> Int# -> Int#
965 a `iShiftRA#` b | b >=# WORD_SIZE_IN_BITS# = if a <# 0# then (-1#) else 0#
966 | otherwise = a `uncheckedIShiftRA#` b
968 -- | Shift the argument right (unsigned) by the specified number of bits
969 -- (which must be non-negative).
970 iShiftRL# :: Int# -> Int# -> Int#
971 a `iShiftRL#` b | b >=# WORD_SIZE_IN_BITS# = 0#
972 | otherwise = a `uncheckedIShiftRL#` b
974 #if WORD_SIZE_IN_BITS == 32
976 "narrow32Int#" forall x#. narrow32Int# x# = x#
977 "narrow32Word#" forall x#. narrow32Word# x# = x#
982 "int2Word2Int" forall x#. int2Word# (word2Int# x#) = x#
983 "word2Int2Word" forall x#. word2Int# (int2Word# x#) = x#
988 %********************************************************
990 \subsection{Unpacking C strings}
992 %********************************************************
994 This code is needed for virtually all programs, since it's used for
995 unpacking the strings of error messages.
998 unpackCString# :: Addr# -> [Char]
999 {-# NOINLINE [1] unpackCString# #-}
1004 | ch `eqChar#` '\0'# = []
1005 | otherwise = C# ch : unpack (nh +# 1#)
1007 ch = indexCharOffAddr# addr nh
1009 unpackAppendCString# :: Addr# -> [Char] -> [Char]
1010 unpackAppendCString# addr rest
1014 | ch `eqChar#` '\0'# = rest
1015 | otherwise = C# ch : unpack (nh +# 1#)
1017 ch = indexCharOffAddr# addr nh
1019 unpackFoldrCString# :: Addr# -> (Char -> a -> a) -> a -> a
1020 {-# NOINLINE [0] unpackFoldrCString# #-}
1021 -- Don't inline till right at the end;
1022 -- usually the unpack-list rule turns it into unpackCStringList
1023 -- It also has a BuiltInRule in PrelRules.lhs:
1024 -- unpackFoldrCString# "foo" c (unpackFoldrCString# "baz" c n)
1025 -- = unpackFoldrCString# "foobaz" c n
1026 unpackFoldrCString# addr f z
1030 | ch `eqChar#` '\0'# = z
1031 | otherwise = C# ch `f` unpack (nh +# 1#)
1033 ch = indexCharOffAddr# addr nh
1035 unpackCStringUtf8# :: Addr# -> [Char]
1036 unpackCStringUtf8# addr
1040 | ch `eqChar#` '\0'# = []
1041 | ch `leChar#` '\x7F'# = C# ch : unpack (nh +# 1#)
1042 | ch `leChar#` '\xDF'# =
1043 C# (chr# (((ord# ch -# 0xC0#) `uncheckedIShiftL#` 6#) +#
1044 (ord# (indexCharOffAddr# addr (nh +# 1#)) -# 0x80#))) :
1046 | ch `leChar#` '\xEF'# =
1047 C# (chr# (((ord# ch -# 0xE0#) `uncheckedIShiftL#` 12#) +#
1048 ((ord# (indexCharOffAddr# addr (nh +# 1#)) -# 0x80#) `uncheckedIShiftL#` 6#) +#
1049 (ord# (indexCharOffAddr# addr (nh +# 2#)) -# 0x80#))) :
1052 C# (chr# (((ord# ch -# 0xF0#) `uncheckedIShiftL#` 18#) +#
1053 ((ord# (indexCharOffAddr# addr (nh +# 1#)) -# 0x80#) `uncheckedIShiftL#` 12#) +#
1054 ((ord# (indexCharOffAddr# addr (nh +# 2#)) -# 0x80#) `uncheckedIShiftL#` 6#) +#
1055 (ord# (indexCharOffAddr# addr (nh +# 3#)) -# 0x80#))) :
1058 ch = indexCharOffAddr# addr nh
1060 unpackNBytes# :: Addr# -> Int# -> [Char]
1061 unpackNBytes# _addr 0# = []
1062 unpackNBytes# addr len# = unpack [] (len# -# 1#)
1067 case indexCharOffAddr# addr i# of
1068 ch -> unpack (C# ch : acc) (i# -# 1#)
1071 "unpack" [~1] forall a . unpackCString# a = build (unpackFoldrCString# a)
1072 "unpack-list" [1] forall a . unpackFoldrCString# a (:) [] = unpackCString# a
1073 "unpack-append" forall a n . unpackFoldrCString# a (:) n = unpackAppendCString# a n
1075 -- There's a built-in rule (in PrelRules.lhs) for
1076 -- unpackFoldr "foo" c (unpackFoldr "baz" c n) = unpackFoldr "foobaz" c n
1083 -- | A special argument for the 'Control.Monad.ST.ST' type constructor,
1084 -- indexing a state embedded in the 'Prelude.IO' monad by
1085 -- 'Control.Monad.ST.stToIO'.