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