[project @ 2003-11-06 17:09:50 by simonpj]
[ghc-hetmet.git] / ghc / compiler / basicTypes / UniqSupply.lhs
index 425e045..6992751 100644 (file)
@@ -1,35 +1,32 @@
 %
-% (c) The GRASP/AQUA Project, Glasgow University, 1992-1996
+% (c) The GRASP/AQUA Project, Glasgow University, 1992-1998
 %
 \section[UniqSupply]{The @UniqueSupply@ data type and a (monadic) supply thereof}
 
 \begin{code}
-#include "HsVersions.h"
-
 module UniqSupply (
 
        UniqSupply,             -- Abstractly
 
-       getUnique, getUniques,  -- basic ops
+       uniqFromSupply, uniqsFromSupply,        -- basic ops
 
-       UniqSM(..),             -- type: unique supply monad
-       initUs, thenUs, returnUs,
-       mapUs, mapAndUnzipUs,
+       UniqSM,         -- type: unique supply monad
+       initUs, initUs_, thenUs, thenUs_, returnUs, fixUs, getUs, withUs,
+       getUniqueUs, getUniquesUs,
+       mapUs, mapAndUnzipUs, mapAndUnzip3Us,
+       thenMaybeUs, mapAccumLUs,
+       lazyThenUs, lazyMapUs,
 
        mkSplitUniqSupply,
-       splitUniqSupply,
-
-       -- and the access functions for the `builtin' UniqueSupply
-       getBuiltinUniques, mkBuiltinUnique,
-       mkPseudoUnique1, mkPseudoUnique2, mkPseudoUnique3
+       splitUniqSupply
   ) where
 
-import Ubiq{-uitous-}
+#include "HsVersions.h"
 
 import Unique
-import Util
 
-import PreludeGlaST
+import GLAEXTS
+import UNSAFE_IO       ( unsafeInterleaveIO )
 
 w2i x = word2Int# x
 i2w x = int2Word# x
@@ -43,12 +40,6 @@ i2w_s x = (x :: Int#)
 %*                                                                     *
 %************************************************************************
 
-%************************************************************************
-%*                                                                     *
-\subsubsection[UniqSupply-type]{@UniqSupply@ type and operations}
-%*                                                                     *
-%************************************************************************
-
 A value of type @UniqSupply@ is unique, and it can
 supply {\em one} distinct @Unique@.  Also, from the supply, one can
 also manufacture an arbitrary number of further @UniqueSupplies@,
@@ -62,53 +53,45 @@ data UniqSupply
 \end{code}
 
 \begin{code}
-mkSplitUniqSupply :: Char -> PrimIO UniqSupply
+mkSplitUniqSupply :: Char -> IO UniqSupply
 
 splitUniqSupply :: UniqSupply -> (UniqSupply, UniqSupply)
-getUnique :: UniqSupply -> Unique
-getUniques :: Int -> UniqSupply -> [Unique]
+uniqFromSupply  :: UniqSupply -> Unique
+uniqsFromSupply :: UniqSupply -> [Unique]      -- Infinite
 \end{code}
 
 \begin{code}
-mkSplitUniqSupply (MkChar c#)
+mkSplitUniqSupply (C# c#)
   = let
+#if __GLASGOW_HASKELL__ >= 503
+       mask# = (i2w (ord# c#)) `uncheckedShiftL#` (i2w_s 24#)
+#else
        mask# = (i2w (ord# c#)) `shiftL#` (i2w_s 24#)
-
+#endif
        -- here comes THE MAGIC:
 
+       -- This is one of the most hammered bits in the whole compiler
        mk_supply#
-         = unsafe_interleave (
-               mk_unique   `thenPrimIO` \ uniq ->
-               mk_supply#  `thenPrimIO` \ s1 ->
-               mk_supply#  `thenPrimIO` \ s2 ->
-               returnPrimIO (MkSplitUniqSupply uniq s1 s2)
+         = unsafeInterleaveIO (
+               mk_unique   >>= \ uniq ->
+               mk_supply#  >>= \ s1 ->
+               mk_supply#  >>= \ s2 ->
+               return (MkSplitUniqSupply uniq s1 s2)
            )
-         where
-           -- inlined copy of unsafeInterleavePrimIO;
-           -- this is the single-most-hammered bit of code
-           -- in the compiler....
-           unsafe_interleave m s
-             = let
-                   (r, new_s) = m s
-               in
-               (r, s)
-
-       mk_unique = _ccall_ genSymZh            `thenPrimIO` \ (W# u#) ->
-                   returnPrimIO (MkInt (w2i (mask# `or#` u#)))
+
+       mk_unique = genSymZh            >>= \ (W# u#) ->
+                   return (I# (w2i (mask# `or#` u#)))
     in
     mk_supply#
 
+foreign import ccall "genSymZh" unsafe genSymZh :: IO Word
+
 splitUniqSupply (MkSplitUniqSupply _ s1 s2) = (s1, s2)
 \end{code}
 
 \begin{code}
-getUnique (MkSplitUniqSupply (MkInt n) _ _) = mkUniqueGrimily n
-
-getUniques i@(MkInt i#) supply = i# `get_from` supply
-  where
-    get_from 0# _ = []
-    get_from n# (MkSplitUniqSupply (MkInt u#) _ s2)
-      = mkUniqueGrimily u# : get_from (n# `minusInt#` 1#) s2
+uniqFromSupply  (MkSplitUniqSupply n _ _)  = mkUniqueGrimily n
+uniqsFromSupply (MkSplitUniqSupply n _ s2) = mkUniqueGrimily n : uniqsFromSupply s2
 \end{code}
 
 %************************************************************************
@@ -118,73 +101,103 @@ getUniques i@(MkInt i#) supply = i# `get_from` supply
 %************************************************************************
 
 \begin{code}
-type UniqSM result = UniqSupply -> result
-
--- the initUs function also returns the final UniqSupply
+type UniqSM result = UniqSupply -> (result, UniqSupply)
 
-initUs :: UniqSupply -> UniqSM a -> (UniqSupply, a)
+-- the initUs function also returns the final UniqSupply; initUs_ drops it
+initUs :: UniqSupply -> UniqSM a -> (a,UniqSupply)
+initUs init_us m = case m init_us of { (r,us) -> (r,us) }
 
-initUs init_us m
-  = case (splitUniqSupply init_us) of { (s1, s2) ->
-    (s2, m s1) }
+initUs_ :: UniqSupply -> UniqSM a -> a
+initUs_ init_us m = case m init_us of { (r,us) -> r }
 
 {-# INLINE thenUs #-}
+{-# INLINE lazyThenUs #-}
 {-# INLINE returnUs #-}
 {-# INLINE splitUniqSupply #-}
 \end{code}
 
 @thenUs@ is where we split the @UniqSupply@.
 \begin{code}
-thenUs :: UniqSM a -> (a -> UniqSM b) -> UniqSM b
+fixUs :: (a -> UniqSM a) -> UniqSM a
+fixUs m us
+  = (r,us')  where  (r,us') = m r us
 
+thenUs :: UniqSM a -> (a -> UniqSM b) -> UniqSM b
 thenUs expr cont us
-  = case (splitUniqSupply us) of { (s1, s2) ->
-    case (expr s1)           of { result ->
-    cont result s2 }}
-\end{code}
+  = case (expr us) of { (result, us') -> cont result us' }
+
+lazyThenUs :: UniqSM a -> (a -> UniqSM b) -> UniqSM b
+lazyThenUs expr cont us
+  = let (result, us') = expr us in cont result us'
+
+thenUs_ :: UniqSM a -> UniqSM b -> UniqSM b
+thenUs_ expr cont us
+  = case (expr us) of { (_, us') -> cont us' }
+
 
-\begin{code}
 returnUs :: a -> UniqSM a
-returnUs result us = result
+returnUs result us = (result, us)
 
-mapUs :: (a -> UniqSM b) -> [a] -> UniqSM [b]
+withUs :: (UniqSupply -> (a, UniqSupply)) -> UniqSM a
+withUs f us = f us     -- Ha ha!
+               
+getUs :: UniqSM UniqSupply
+getUs us = splitUniqSupply us
+
+getUniqueUs :: UniqSM Unique
+getUniqueUs us = case splitUniqSupply us of
+                  (us1,us2) -> (uniqFromSupply us1, us2)
 
+getUniquesUs :: UniqSM [Unique]
+getUniquesUs us = case splitUniqSupply us of
+                     (us1,us2) -> (uniqsFromSupply us1, us2)
+\end{code}
+
+\begin{code}
+mapUs :: (a -> UniqSM b) -> [a] -> UniqSM [b]
 mapUs f []     = returnUs []
 mapUs f (x:xs)
   = f x         `thenUs` \ r  ->
     mapUs f xs  `thenUs` \ rs ->
     returnUs (r:rs)
 
+lazyMapUs :: (a -> UniqSM b) -> [a] -> UniqSM [b]
+lazyMapUs f []     = returnUs []
+lazyMapUs f (x:xs)
+  = f x             `lazyThenUs` \ r  ->
+    lazyMapUs f xs  `lazyThenUs` \ rs ->
+    returnUs (r:rs)
+
 mapAndUnzipUs  :: (a -> UniqSM (b,c))   -> [a] -> UniqSM ([b],[c])
+mapAndUnzip3Us :: (a -> UniqSM (b,c,d)) -> [a] -> UniqSM ([b],[c],[d])
 
 mapAndUnzipUs f [] = returnUs ([],[])
 mapAndUnzipUs f (x:xs)
   = f x                        `thenUs` \ (r1,  r2)  ->
     mapAndUnzipUs f xs `thenUs` \ (rs1, rs2) ->
     returnUs (r1:rs1, r2:rs2)
-\end{code}
-
-%************************************************************************
-%*                                                                     *
-\subsubsection[UniqueSupplies-compiler]{@UniqueSupplies@ specific to the compiler}
-%*                                                                     *
-%************************************************************************
-
-\begin{code}
-mkPseudoUnique1, mkPseudoUnique2, mkPseudoUnique3,
- mkBuiltinUnique :: Int -> Unique
-
-mkBuiltinUnique i = mkUnique 'B' i
-mkPseudoUnique1 i = mkUnique 'C' i -- used for getItsUnique on Regs
-mkPseudoUnique2 i = mkUnique 'D' i -- ditto
-mkPseudoUnique3 i = mkUnique 'E' i -- ditto
 
-getBuiltinUniques :: Int -> [Unique]
-getBuiltinUniques n = map (mkUnique 'B') [1 .. n]
-\end{code}
-
-The following runs a uniq monad expression, using builtin uniq values:
-\begin{code}
---runBuiltinUs :: UniqSM a -> a
---runBuiltinUs m = snd (initUs uniqSupply_B m)
+mapAndUnzip3Us f [] = returnUs ([],[],[])
+mapAndUnzip3Us f (x:xs)
+  = f x                        `thenUs` \ (r1,  r2,  r3)  ->
+    mapAndUnzip3Us f xs        `thenUs` \ (rs1, rs2, rs3) ->
+    returnUs (r1:rs1, r2:rs2, r3:rs3)
+
+thenMaybeUs :: UniqSM (Maybe a) -> (a -> UniqSM (Maybe b)) -> UniqSM (Maybe b)
+thenMaybeUs m k
+  = m  `thenUs` \ result ->
+    case result of
+      Nothing -> returnUs Nothing
+      Just x  -> k x
+
+mapAccumLUs :: (acc -> x -> UniqSM (acc, y))
+           -> acc
+           -> [x]
+           -> UniqSM (acc, [y])
+
+mapAccumLUs f b []     = returnUs (b, [])
+mapAccumLUs f b (x:xs)
+  = f b x                          `thenUs` \ (b__2, x__2) ->
+    mapAccumLUs f b__2 xs          `thenUs` \ (b__3, xs__2) ->
+    returnUs (b__3, x__2:xs__2)
 \end{code}