Remove (most of) the FiniteMap wrapper
[ghc-hetmet.git] / compiler / utils / Maybes.lhs
index 1d43365..1f443db 100644 (file)
@@ -10,6 +10,7 @@ module Maybes (
         MaybeErr(..), -- Instance of Monad
         failME, isSuccess,
 
+        fmapM_maybe,
         orElse,
         mapCatMaybes,
         allMaybes,
@@ -17,6 +18,7 @@ module Maybes (
         expectJust,
         maybeToBool,
 
+        MaybeT(..)
     ) where
 
 import Data.Maybe
@@ -34,14 +36,9 @@ infixr 4 `orElse`
 maybeToBool :: Maybe a -> Bool
 maybeToBool Nothing  = False
 maybeToBool (Just _) = True
-\end{code}
-
-@catMaybes@ takes a list of @Maybe@s and returns a list of
-the contents of all the @Just@s in it. @allMaybes@ collects
-a list of @Justs@ into a single @Just@, returning @Nothing@ if there
-are any @Nothings@.
 
-\begin{code}
+-- | Collects a list of @Justs@ into a single @Just@, returning @Nothing@ if
+-- there are any @Nothings@.
 allMaybes :: [Maybe a] -> Maybe [a]
 allMaybes [] = Just []
 allMaybes (Nothing : _)  = Nothing
@@ -49,12 +46,8 @@ allMaybes (Just x  : ms) = case allMaybes ms of
                            Nothing -> Nothing
                            Just xs -> Just (x:xs)
 
-\end{code}
-
-@firstJust@ takes a list of @Maybes@ and returns the
-first @Just@ if there is one, or @Nothing@ otherwise.
-
-\begin{code}
+-- | Takes a list of @Maybes@ and returns the first @Just@ if there is one, or
+-- @Nothing@ otherwise.
 firstJust :: [Maybe a] -> Maybe a
 firstJust [] = Nothing
 firstJust (Just x  : _)  = Just x
@@ -82,6 +75,34 @@ orElse :: Maybe a -> a -> a
 Nothing  `orElse` y = y
 \end{code}
 
+\begin{code}
+fmapM_maybe :: Monad m => (a -> m b) -> Maybe a -> m (Maybe b)
+fmapM_maybe _ Nothing = return Nothing
+fmapM_maybe f (Just x) = do
+        x' <- f x
+        return $ Just x'
+\end{code}
+
+%************************************************************************
+%*                                                                     *
+\subsection[MaybeT type]{The @MaybeT@ monad transformer}
+%*                                                                     *
+%************************************************************************
+
+\begin{code}
+
+newtype MaybeT m a = MaybeT {runMaybeT :: m (Maybe a)}
+
+instance Functor m => Functor (MaybeT m) where
+  fmap f x = MaybeT $ fmap (fmap f) $ runMaybeT x
+
+instance Monad m => Monad (MaybeT m) where
+  return = MaybeT . return . Just
+  x >>= f = MaybeT $ runMaybeT x >>= maybe (return Nothing) (runMaybeT . f)
+  fail _ = MaybeT $ return Nothing
+
+\end{code}
+
 
 %************************************************************************
 %*                                                                      *