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