Refactor SrcLoc and SrcSpan
[ghc-hetmet.git] / compiler / utils / MonadUtils.hs
index 733eda1..75a88df 100644 (file)
@@ -8,6 +8,8 @@ module MonadUtils
         
         , MonadFix(..)
         , MonadIO(..)
+       
+       , ID, runID
         
         , liftIO1, liftIO2, liftIO3, liftIO4
 
@@ -17,21 +19,24 @@ module MonadUtils
         , mapSndM
         , concatMapM
         , mapMaybeM
+       , fmapMaybeM, fmapEitherM
         , anyM, allM
-        , foldlM, foldrM
+        , foldlM, foldlM_, foldrM
         , maybeMapM
         ) where
 
-----------------------------------------------------------------------------------------
+import Outputable 
+
+-------------------------------------------------------------------------------
 -- Detection of available libraries
-----------------------------------------------------------------------------------------
+-------------------------------------------------------------------------------
 
 -- we don't depend on MTL for now
 #define HAVE_MTL 0
 
-----------------------------------------------------------------------------------------
+-------------------------------------------------------------------------------
 -- Imports
-----------------------------------------------------------------------------------------
+-------------------------------------------------------------------------------
 
 import Maybes
 
@@ -42,9 +47,23 @@ import Control.Monad.Trans
 import Control.Monad
 import Control.Monad.Fix
 
-----------------------------------------------------------------------------------------
+-------------------------------------------------------------------------------
+-- The ID monad
+-------------------------------------------------------------------------------
+
+newtype ID a = ID a
+instance Monad ID where
+  return x     = ID x
+  (ID x) >>= f = f x
+  _ >> y       = y
+  fail s       = panic s
+
+runID :: ID a -> a
+runID (ID x) = x
+
+-------------------------------------------------------------------------------
 -- MTL
-----------------------------------------------------------------------------------------
+-------------------------------------------------------------------------------
 
 #if !HAVE_MTL
 
@@ -54,10 +73,10 @@ class Monad m => MonadIO m where
 instance MonadIO IO where liftIO = id
 #endif
 
-----------------------------------------------------------------------------------------
+-------------------------------------------------------------------------------
 -- Lift combinators
 --  These are used throughout the compiler
-----------------------------------------------------------------------------------------
+-------------------------------------------------------------------------------
 
 -- | Lift an 'IO' operation with 1 argument into another monad
 liftIO1 :: MonadIO m => (a -> IO b) -> a -> m b
@@ -75,10 +94,10 @@ liftIO3 = ((.).((.).(.))) liftIO
 liftIO4 :: MonadIO m => (a -> b -> c -> d -> IO e) -> a -> b -> c -> d -> m e
 liftIO4 = (((.).(.)).((.).(.))) liftIO
 
-----------------------------------------------------------------------------------------
+-------------------------------------------------------------------------------
 -- Common functions
 --  These are used throughout the compiler
-----------------------------------------------------------------------------------------
+-------------------------------------------------------------------------------
 
 zipWith3M :: Monad m => (a -> b -> c -> m d) -> [a] -> [b] -> [c] -> m [d]
 zipWith3M _ []     _      _      = return []
@@ -130,6 +149,16 @@ concatMapM f xs = liftM concat (mapM f xs)
 mapMaybeM :: (Monad m) => (a -> m (Maybe b)) -> [a] -> m [b]
 mapMaybeM f = liftM catMaybes . mapM f
 
+-- | Monadic version of fmap
+fmapMaybeM :: (Monad m) => (a -> m b) -> Maybe a -> m (Maybe b)
+fmapMaybeM _ Nothing  = return Nothing
+fmapMaybeM f (Just x) = f x >>= (return . Just)
+
+-- | Monadic version of fmap
+fmapEitherM :: Monad m => (a -> m b) -> (c -> m d) -> Either a c -> m (Either b d)
+fmapEitherM fl _ (Left  a) = fl a >>= (return . Left)
+fmapEitherM _ fr (Right b) = fr b >>= (return . Right)
+
 -- | Monadic version of 'any', aborts the computation at the first @True@ value
 anyM :: Monad m => (a -> m Bool) -> [a] -> m Bool
 anyM _ []     = return False
@@ -146,6 +175,10 @@ allM f (b:bs) = (f b) >>= (\bv -> if bv then allM f bs else return False)
 foldlM :: (Monad m) => (a -> b -> m a) -> a -> [b] -> m a
 foldlM = foldM
 
+-- | Monadic version of foldl that discards its result
+foldlM_ :: (Monad m) => (a -> b -> m a) -> a -> [b] -> m ()
+foldlM_ = foldM_
+
 -- | Monadic version of foldr
 foldrM        :: (Monad m) => (b -> a -> m a) -> a -> [b] -> m a
 foldrM _ z []     = return z