Reorganisation of the source tree
[ghc.git] / 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 = genSymZh            >>= \ (W# u#) ->
83                     return (I# (w2i (mask# `or#` u#)))
84     in
85     mk_supply#
86
87 foreign import ccall unsafe "genSymZh" genSymZh :: IO Word
88
89 splitUniqSupply (MkSplitUniqSupply _ s1 s2) = (s1, s2)
90 \end{code}
91
92 \begin{code}
93 uniqFromSupply  (MkSplitUniqSupply n _ _)  = mkUniqueGrimily n
94 uniqsFromSupply (MkSplitUniqSupply n _ s2) = mkUniqueGrimily n : uniqsFromSupply s2
95 \end{code}
96
97 %************************************************************************
98 %*                                                                      *
99 \subsubsection[UniqSupply-monad]{@UniqSupply@ monad: @UniqSM@}
100 %*                                                                      *
101 %************************************************************************
102
103 \begin{code}
104 type UniqSM result = UniqSupply -> (result, UniqSupply)
105
106 -- the initUs function also returns the final UniqSupply; initUs_ drops it
107 initUs :: UniqSupply -> UniqSM a -> (a,UniqSupply)
108 initUs init_us m = case m init_us of { (r,us) -> (r,us) }
109
110 initUs_ :: UniqSupply -> UniqSM a -> a
111 initUs_ init_us m = case m init_us of { (r,us) -> r }
112
113 {-# INLINE thenUs #-}
114 {-# INLINE lazyThenUs #-}
115 {-# INLINE returnUs #-}
116 {-# INLINE splitUniqSupply #-}
117 \end{code}
118
119 @thenUs@ is where we split the @UniqSupply@.
120 \begin{code}
121 fixUs :: (a -> UniqSM a) -> UniqSM a
122 fixUs m us
123   = (r,us')  where  (r,us') = m r us
124
125 thenUs :: UniqSM a -> (a -> UniqSM b) -> UniqSM b
126 thenUs expr cont us
127   = case (expr us) of { (result, us') -> cont result us' }
128
129 lazyThenUs :: UniqSM a -> (a -> UniqSM b) -> UniqSM b
130 lazyThenUs expr cont us
131   = let (result, us') = expr us in cont result us'
132
133 thenUs_ :: UniqSM a -> UniqSM b -> UniqSM b
134 thenUs_ expr cont us
135   = case (expr us) of { (_, us') -> cont us' }
136
137
138 returnUs :: a -> UniqSM a
139 returnUs result us = (result, us)
140
141 withUs :: (UniqSupply -> (a, UniqSupply)) -> UniqSM a
142 withUs f us = f us      -- Ha ha!
143                 
144 getUs :: UniqSM UniqSupply
145 getUs us = splitUniqSupply us
146
147 getUniqueUs :: UniqSM Unique
148 getUniqueUs us = case splitUniqSupply us of
149                    (us1,us2) -> (uniqFromSupply us1, us2)
150
151 getUniquesUs :: UniqSM [Unique]
152 getUniquesUs us = case splitUniqSupply us of
153                       (us1,us2) -> (uniqsFromSupply us1, us2)
154 \end{code}
155
156 \begin{code}
157 mapUs :: (a -> UniqSM b) -> [a] -> UniqSM [b]
158 mapUs f []     = returnUs []
159 mapUs f (x:xs)
160   = f x         `thenUs` \ r  ->
161     mapUs f xs  `thenUs` \ rs ->
162     returnUs (r:rs)
163
164 lazyMapUs :: (a -> UniqSM b) -> [a] -> UniqSM [b]
165 lazyMapUs f []     = returnUs []
166 lazyMapUs f (x:xs)
167   = f x             `lazyThenUs` \ r  ->
168     lazyMapUs f xs  `lazyThenUs` \ rs ->
169     returnUs (r:rs)
170
171 mapAndUnzipUs  :: (a -> UniqSM (b,c))   -> [a] -> UniqSM ([b],[c])
172 mapAndUnzip3Us :: (a -> UniqSM (b,c,d)) -> [a] -> UniqSM ([b],[c],[d])
173
174 mapAndUnzipUs f [] = returnUs ([],[])
175 mapAndUnzipUs f (x:xs)
176   = f x                 `thenUs` \ (r1,  r2)  ->
177     mapAndUnzipUs f xs  `thenUs` \ (rs1, rs2) ->
178     returnUs (r1:rs1, r2:rs2)
179
180 mapAndUnzip3Us f [] = returnUs ([],[],[])
181 mapAndUnzip3Us f (x:xs)
182   = f x                 `thenUs` \ (r1,  r2,  r3)  ->
183     mapAndUnzip3Us f xs `thenUs` \ (rs1, rs2, rs3) ->
184     returnUs (r1:rs1, r2:rs2, r3:rs3)
185
186 thenMaybeUs :: UniqSM (Maybe a) -> (a -> UniqSM (Maybe b)) -> UniqSM (Maybe b)
187 thenMaybeUs m k
188   = m   `thenUs` \ result ->
189     case result of
190       Nothing -> returnUs Nothing
191       Just x  -> k x
192
193 mapAccumLUs :: (acc -> x -> UniqSM (acc, y))
194             -> acc
195             -> [x]
196             -> UniqSM (acc, [y])
197
198 mapAccumLUs f b []     = returnUs (b, [])
199 mapAccumLUs f b (x:xs)
200   = f b x                           `thenUs` \ (b__2, x__2) ->
201     mapAccumLUs f b__2 xs           `thenUs` \ (b__3, xs__2) ->
202     returnUs (b__3, x__2:xs__2)
203 \end{code}