ghc/compiler/basicTypes/UniqSupply.lhs

   1 %
   2 % (c) The GRASP/AQUA Project, Glasgow University, 1992-1998
   3 %
   4 \section[UniqSupply]{The @UniqueSupply@ data type and a (monadic) supply thereof}
   5
   6 \begin{code}
   7 module UniqSupply (
   8
   9         UniqSupply,             -- Abstractly
  10
  11         uniqFromSupply, uniqsFromSupply,        -- basic ops
  12
  13         UniqSM,         -- type: unique supply monad
  14         initUs, initUs_, thenUs, thenUs_, returnUs, fixUs, getUs, withUs,
  15         getUniqueUs, getUniquesUs,
  16         mapUs, mapAndUnzipUs, mapAndUnzip3Us,
  17         thenMaybeUs, mapAccumLUs,
  18         lazyThenUs, lazyMapUs,
  19
  20         mkSplitUniqSupply,
  21         splitUniqSupply
  22   ) where
  23
  24 #include "HsVersions.h"
  25
  26 import Unique
  27
  28 import GLAEXTS
  29 import UNSAFE_IO        ( unsafeInterleaveIO )
  30
  31 w2i x = word2Int# x
  32 i2w x = int2Word# x
  33 i2w_s x = (x :: Int#)
  34 \end{code}
  35
  36
  37 %************************************************************************
  38 %*                                                                      *
  39 \subsection{Splittable Unique supply: @UniqSupply@}
  40 %*                                                                      *
  41 %************************************************************************
  42
  43 A value of type @UniqSupply@ is unique, and it can
  44 supply {\em one} distinct @Unique@.  Also, from the supply, one can
  45 also manufacture an arbitrary number of further @UniqueSupplies@,
  46 which will be distinct from the first and from all others.
  47
  48 \begin{code}
  49 data UniqSupply
  50   = MkSplitUniqSupply Int       -- make the Unique with this
  51                    UniqSupply UniqSupply
  52                                 -- when split => these two supplies
  53 \end{code}
  54
  55 \begin{code}
  56 mkSplitUniqSupply :: Char -> IO UniqSupply
  57
  58 splitUniqSupply :: UniqSupply -> (UniqSupply, UniqSupply)
  59 uniqFromSupply  :: UniqSupply -> Unique
  60 uniqsFromSupply :: UniqSupply -> [Unique]       -- Infinite
  61 \end{code}
  62
  63 \begin{code}
  64 mkSplitUniqSupply (C# c#)
  65   = let
  66 #if __GLASGOW_HASKELL__ >= 503
  67         mask# = (i2w (ord# c#)) `uncheckedShiftL#` (i2w_s 24#)
  68 #else
  69         mask# = (i2w (ord# c#)) `shiftL#` (i2w_s 24#)
  70 #endif
  71         -- here comes THE MAGIC:
  72
  73         -- This is one of the most hammered bits in the whole compiler
  74         mk_supply#
  75           = unsafeInterleaveIO (
  76                 mk_unique   >>= \ uniq ->
  77                 mk_supply#  >>= \ s1 ->
  78                 mk_supply#  >>= \ s2 ->
  79                 return (MkSplitUniqSupply uniq s1 s2)
  80             )
  81
  82         mk_unique =
  83 #if __GLASGOW_HASKELL__ < 603
  84                     _ccall_
  85 #endif
  86                     genSymZh            >>= \ (W# u#) ->
  87                     return (I# (w2i (mask# `or#` u#)))
  88     in
  89     mk_supply#
  90
  91 #if __GLASGOW_HASKELL__ >= 603
  92 foreign import ccall unsafe "genSymZh" genSymZh :: IO Word
  93 #endif
  94
  95 splitUniqSupply (MkSplitUniqSupply _ s1 s2) = (s1, s2)
  96 \end{code}
  97
  98 \begin{code}
  99 uniqFromSupply  (MkSplitUniqSupply (I# n) _ _)  = mkUniqueGrimily n
 100 uniqsFromSupply (MkSplitUniqSupply (I# n) _ s2) = mkUniqueGrimily n : uniqsFromSupply s2
 101 \end{code}
 102
 103 %************************************************************************
 104 %*                                                                      *
 105 \subsubsection[UniqSupply-monad]{@UniqSupply@ monad: @UniqSM@}
 106 %*                                                                      *
 107 %************************************************************************
 108
 109 \begin{code}
 110 type UniqSM result = UniqSupply -> (result, UniqSupply)
 111
 112 -- the initUs function also returns the final UniqSupply; initUs_ drops it
 113 initUs :: UniqSupply -> UniqSM a -> (a,UniqSupply)
 114 initUs init_us m = case m init_us of { (r,us) -> (r,us) }
 115
 116 initUs_ :: UniqSupply -> UniqSM a -> a
 117 initUs_ init_us m = case m init_us of { (r,us) -> r }
 118
 119 {-# INLINE thenUs #-}
 120 {-# INLINE lazyThenUs #-}
 121 {-# INLINE returnUs #-}
 122 {-# INLINE splitUniqSupply #-}
 123 \end{code}
 124
 125 @thenUs@ is where we split the @UniqSupply@.
 126 \begin{code}
 127 fixUs :: (a -> UniqSM a) -> UniqSM a
 128 fixUs m us
 129   = (r,us')  where  (r,us') = m r us
 130
 131 thenUs :: UniqSM a -> (a -> UniqSM b) -> UniqSM b
 132 thenUs expr cont us
 133   = case (expr us) of { (result, us') -> cont result us' }
 134
 135 lazyThenUs :: UniqSM a -> (a -> UniqSM b) -> UniqSM b
 136 lazyThenUs expr cont us
 137   = let (result, us') = expr us in cont result us'
 138
 139 thenUs_ :: UniqSM a -> UniqSM b -> UniqSM b
 140 thenUs_ expr cont us
 141   = case (expr us) of { (_, us') -> cont us' }
 142
 143
 144 returnUs :: a -> UniqSM a
 145 returnUs result us = (result, us)
 146
 147 withUs :: (UniqSupply -> (a, UniqSupply)) -> UniqSM a
 148 withUs f us = f us      -- Ha ha!
 149
 150 getUs :: UniqSM UniqSupply
 151 getUs us = splitUniqSupply us
 152
 153 getUniqueUs :: UniqSM Unique
 154 getUniqueUs us = case splitUniqSupply us of
 155                    (us1,us2) -> (uniqFromSupply us1, us2)
 156
 157 getUniquesUs :: UniqSM [Unique]
 158 getUniquesUs us = case splitUniqSupply us of
 159                       (us1,us2) -> (uniqsFromSupply us1, us2)
 160 \end{code}
 161
 162 \begin{code}
 163 mapUs :: (a -> UniqSM b) -> [a] -> UniqSM [b]
 164 mapUs f []     = returnUs []
 165 mapUs f (x:xs)
 166   = f x         `thenUs` \ r  ->
 167     mapUs f xs  `thenUs` \ rs ->
 168     returnUs (r:rs)
 169
 170 lazyMapUs :: (a -> UniqSM b) -> [a] -> UniqSM [b]
 171 lazyMapUs f []     = returnUs []
 172 lazyMapUs f (x:xs)
 173   = f x             `lazyThenUs` \ r  ->
 174     lazyMapUs f xs  `lazyThenUs` \ rs ->
 175     returnUs (r:rs)
 176
 177 mapAndUnzipUs  :: (a -> UniqSM (b,c))   -> [a] -> UniqSM ([b],[c])
 178 mapAndUnzip3Us :: (a -> UniqSM (b,c,d)) -> [a] -> UniqSM ([b],[c],[d])
 179
 180 mapAndUnzipUs f [] = returnUs ([],[])
 181 mapAndUnzipUs f (x:xs)
 182   = f x                 `thenUs` \ (r1,  r2)  ->
 183     mapAndUnzipUs f xs  `thenUs` \ (rs1, rs2) ->
 184     returnUs (r1:rs1, r2:rs2)
 185
 186 mapAndUnzip3Us f [] = returnUs ([],[],[])
 187 mapAndUnzip3Us f (x:xs)
 188   = f x                 `thenUs` \ (r1,  r2,  r3)  ->
 189     mapAndUnzip3Us f xs `thenUs` \ (rs1, rs2, rs3) ->
 190     returnUs (r1:rs1, r2:rs2, r3:rs3)
 191
 192 thenMaybeUs :: UniqSM (Maybe a) -> (a -> UniqSM (Maybe b)) -> UniqSM (Maybe b)
 193 thenMaybeUs m k
 194   = m   `thenUs` \ result ->
 195     case result of
 196       Nothing -> returnUs Nothing
 197       Just x  -> k x
 198
 199 mapAccumLUs :: (acc -> x -> UniqSM (acc, y))
 200             -> acc
 201             -> [x]
 202             -> UniqSM (acc, [y])
 203
 204 mapAccumLUs f b []     = returnUs (b, [])
 205 mapAccumLUs f b (x:xs)
 206   = f b x                           `thenUs` \ (b__2, x__2) ->
 207     mapAccumLUs f b__2 xs           `thenUs` \ (b__3, xs__2) ->
 208     returnUs (b__3, x__2:xs__2)
 209 \end{code}