    {-# LANGUAGE CPP #-}
    {-# LANGUAGE FunctionalDependencies #-}
    {-# LANGUAGE FlexibleInstances #-}
    {-# LANGUAGE MultiParamTypeClasses #-}
    {-# LANGUAGE UndecidableInstances #-}
    -- Search for UndecidableInstances to see why this is needed

    -----------------------------------------------------------------------------
    -- |
    -- Module      :  Control.Monad.State.Class
    -- Copyright   :  (c) Andy Gill 2001,
    --                (c) Oregon Graduate Institute of Science and Technology, 2001
    -- License     :  BSD-style (see the file LICENSE)
    --
    -- Maintainer  :  libraries@haskell.org
    -- Stability   :  experimental
    -- Portability :  non-portable (multi-param classes, functional dependencies)
    --
    -- MonadState class.
    --
    --      This module is inspired by the paper
    --      /Functional Programming with Overloading and Higher-Order Polymorphism/,
    --        Mark P Jones (<http://web.cecs.pdx.edu/~mpj/>)
    --          Advanced School of Functional Programming, 1995.

    -----------------------------------------------------------------------------

    module Control.Monad.State.Class (
        MonadState(..),
        modify,
        modify',
        gets
      ) where

    import Control.Monad.Trans.Cont
    import Control.Monad.Trans.Error
    import Control.Monad.Trans.Except
    import Control.Monad.Trans.Identity
    import Control.Monad.Trans.List
    import Control.Monad.Trans.Maybe
    import Control.Monad.Trans.Reader
    import qualified Control.Monad.Trans.RWS.Lazy as LazyRWS (RWST, get, put, state)
    import qualified Control.Monad.Trans.RWS.Strict as StrictRWS (RWST, get, put, state)
    import qualified Control.Monad.Trans.State.Lazy as Lazy (StateT, get, put, state)
    import qualified Control.Monad.Trans.State.Strict as Strict (StateT, get, put, state)
    import Control.Monad.Trans.Writer.Lazy as Lazy
    import Control.Monad.Trans.Writer.Strict as Strict

    import Control.Monad.Trans.Class (lift)
    import Control.Monad
    import Data.Monoid

    -- ---------------------------------------------------------------------------

    -- | Minimal definition is either both of @get@ and @put@ or just @state@
    class Monad m => MonadState s m | m -> s where
        -- | Return the state from the internals of the monad.
        get :: m s
        get = forall s (m :: * -> *) a. MonadState s m => (s -> (a, s)) -> m a
    state (\s
    s -> (s
    s, s
    s))

        -- | Replace the state inside the monad.
        put :: s -> m ()
        put s
    s = forall s (m :: * -> *) a. MonadState s m => (s -> (a, s)) -> m a
    state (\s
    _ -> ((), s
    s))

        -- | Embed a simple state action into the monad.
        state :: (s -> (a, s)) -> m a
        state s -> (a, s)
    f = do
          s
    s <- forall s (m :: * -> *). MonadState s m => m s
    get
          let ~(a
    a, s
    s') = s -> (a, s)
    f s
    s
          forall s (m :: * -> *). MonadState s m => s -> m ()
    put s
    s'
          forall (m :: * -> *) a. Monad m => a -> m a
    return a
    a
    #if __GLASGOW_HASKELL__ >= 707
        {-# MINIMAL state | get, put #-}
    #endif

    -- | Monadic state transformer.
    --
    --      Maps an old state to a new state inside a state monad.
    --      The old state is thrown away.
    --
    -- >      Main> :t modify ((+1) :: Int -> Int)
    -- >      modify (...) :: (MonadState Int a) => a ()
    --
    --    This says that @modify (+1)@ acts over any
    --    Monad that is a member of the @MonadState@ class,
    --    with an @Int@ state.
    modify :: MonadState s m => (s -> s) -> m ()
    modify :: forall s (m :: * -> *). MonadState s m => (s -> s) -> m ()
    modify s -> s
    f = forall s (m :: * -> *) a. MonadState s m => (s -> (a, s)) -> m a
    state (\s
    s -> ((), s -> s
    f s
    s))

    -- | A variant of 'modify' in which the computation is strict in the
    -- new state.
    --
    -- @since 2.2
    modify' :: MonadState s m => (s -> s) -> m ()
    modify' :: forall s (m :: * -> *). MonadState s m => (s -> s) -> m ()
    modify' s -> s
    f = do
      s
    s' <- forall s (m :: * -> *). MonadState s m => m s
    get
      forall s (m :: * -> *). MonadState s m => s -> m ()
    put forall a b. (a -> b) -> a -> b
    $! s -> s
    f s
    s'

    -- | Gets specific component of the state, using a projection function
    -- supplied.
    gets :: MonadState s m => (s -> a) -> m a
    gets :: forall s (m :: * -> *) a. MonadState s m => (s -> a) -> m a
    gets s -> a
    f = do
        s
    s <- forall s (m :: * -> *). MonadState s m => m s
    get
        forall (m :: * -> *) a. Monad m => a -> m a
    return (s -> a
    f s
    s)

    instance Monad m => MonadState s (Lazy.StateT s m) where
        get :: StateT s m s
    get = forall (m :: * -> *) s. Monad m => StateT s m s
    Lazy.get
        put :: s -> StateT s m ()
    put = forall (m :: * -> *) s. Monad m => s -> StateT s m ()
    Lazy.put
        state :: forall a. (s -> (a, s)) -> StateT s m a
    state = forall (m :: * -> *) s a. Monad m => (s -> (a, s)) -> StateT s m a
    Lazy.state

    instance Monad m => MonadState s (Strict.StateT s m) where
        get :: StateT s m s
    get = forall (m :: * -> *) s. Monad m => StateT s m s
    Strict.get
        put :: s -> StateT s m ()
    put = forall (m :: * -> *) s. Monad m => s -> StateT s m ()
    Strict.put
        state :: forall a. (s -> (a, s)) -> StateT s m a
    state = forall (m :: * -> *) s a. Monad m => (s -> (a, s)) -> StateT s m a
    Strict.state

    instance (Monad m, Monoid w) => MonadState s (LazyRWS.RWST r w s m) where
        get :: RWST r w s m s
    get = forall w (m :: * -> *) r s. (Monoid w, Monad m) => RWST r w s m s
    LazyRWS.get
        put :: s -> RWST r w s m ()
    put = forall w (m :: * -> *) s r.
    (Monoid w, Monad m) =>
    s -> RWST r w s m ()
    LazyRWS.put
        state :: forall a. (s -> (a, s)) -> RWST r w s m a
    state = forall w (m :: * -> *) s a r.
    (Monoid w, Monad m) =>
    (s -> (a, s)) -> RWST r w s m a
    LazyRWS.state

    instance (Monad m, Monoid w) => MonadState s (StrictRWS.RWST r w s m) where
        get :: RWST r w s m s
    get = forall w (m :: * -> *) r s. (Monoid w, Monad m) => RWST r w s m s
    StrictRWS.get
        put :: s -> RWST r w s m ()
    put = forall w (m :: * -> *) s r.
    (Monoid w, Monad m) =>
    s -> RWST r w s m ()
    StrictRWS.put
        state :: forall a. (s -> (a, s)) -> RWST r w s m a
    state = forall w (m :: * -> *) s a r.
    (Monoid w, Monad m) =>
    (s -> (a, s)) -> RWST r w s m a
    StrictRWS.state

    -- ---------------------------------------------------------------------------
    -- Instances for other mtl transformers
    --
    -- All of these instances need UndecidableInstances,
    -- because they do not satisfy the coverage condition.

    instance MonadState s m => MonadState s (ContT r m) where
        get :: ContT r m s
    get = forall (t :: (* -> *) -> * -> *) (m :: * -> *) a.
    (MonadTrans t, Monad m) =>
    m a -> t m a
    lift forall s (m :: * -> *). MonadState s m => m s
    get
        put :: s -> ContT r m ()
    put = forall (t :: (* -> *) -> * -> *) (m :: * -> *) a.
    (MonadTrans t, Monad m) =>
    m a -> t m a
    lift forall b c a. (b -> c) -> (a -> b) -> a -> c
    . forall s (m :: * -> *). MonadState s m => s -> m ()
    put
        state :: forall a. (s -> (a, s)) -> ContT r m a
    state = forall (t :: (* -> *) -> * -> *) (m :: * -> *) a.
    (MonadTrans t, Monad m) =>
    m a -> t m a
    lift forall b c a. (b -> c) -> (a -> b) -> a -> c
    . forall s (m :: * -> *) a. MonadState s m => (s -> (a, s)) -> m a
    state

    instance (Error e, MonadState s m) => MonadState s (ErrorT e m) where
        get :: ErrorT e m s
    get = forall (t :: (* -> *) -> * -> *) (m :: * -> *) a.
    (MonadTrans t, Monad m) =>
    m a -> t m a
    lift forall s (m :: * -> *). MonadState s m => m s
    get
        put :: s -> ErrorT e m ()
    put = forall (t :: (* -> *) -> * -> *) (m :: * -> *) a.
    (MonadTrans t, Monad m) =>
    m a -> t m a
    lift forall b c a. (b -> c) -> (a -> b) -> a -> c
    . forall s (m :: * -> *). MonadState s m => s -> m ()
    put
        state :: forall a. (s -> (a, s)) -> ErrorT e m a
    state = forall (t :: (* -> *) -> * -> *) (m :: * -> *) a.
    (MonadTrans t, Monad m) =>
    m a -> t m a
    lift forall b c a. (b -> c) -> (a -> b) -> a -> c
    . forall s (m :: * -> *) a. MonadState s m => (s -> (a, s)) -> m a
    state

    -- | @since 2.2
    instance MonadState s m => MonadState s (ExceptT e m) where
        get :: ExceptT e m s
    get = forall (t :: (* -> *) -> * -> *) (m :: * -> *) a.
    (MonadTrans t, Monad m) =>
    m a -> t m a
    lift forall s (m :: * -> *). MonadState s m => m s
    get
        put :: s -> ExceptT e m ()
    put = forall (t :: (* -> *) -> * -> *) (m :: * -> *) a.
    (MonadTrans t, Monad m) =>
    m a -> t m a
    lift forall b c a. (b -> c) -> (a -> b) -> a -> c
    . forall s (m :: * -> *). MonadState s m => s -> m ()
    put
        state :: forall a. (s -> (a, s)) -> ExceptT e m a
    state = forall (t :: (* -> *) -> * -> *) (m :: * -> *) a.
    (MonadTrans t, Monad m) =>
    m a -> t m a
    lift forall b c a. (b -> c) -> (a -> b) -> a -> c
    . forall s (m :: * -> *) a. MonadState s m => (s -> (a, s)) -> m a
    state

    instance MonadState s m => MonadState s (IdentityT m) where
        get :: IdentityT m s
    get = forall (t :: (* -> *) -> * -> *) (m :: * -> *) a.
    (MonadTrans t, Monad m) =>
    m a -> t m a
    lift forall s (m :: * -> *). MonadState s m => m s
    get
        put :: s -> IdentityT m ()
    put = forall (t :: (* -> *) -> * -> *) (m :: * -> *) a.
    (MonadTrans t, Monad m) =>
    m a -> t m a
    lift forall b c a. (b -> c) -> (a -> b) -> a -> c
    . forall s (m :: * -> *). MonadState s m => s -> m ()
    put
        state :: forall a. (s -> (a, s)) -> IdentityT m a
    state = forall (t :: (* -> *) -> * -> *) (m :: * -> *) a.
    (MonadTrans t, Monad m) =>
    m a -> t m a
    lift forall b c a. (b -> c) -> (a -> b) -> a -> c
    . forall s (m :: * -> *) a. MonadState s m => (s -> (a, s)) -> m a
    state

    instance MonadState s m => MonadState s (ListT m) where
        get :: ListT m s
    get = forall (t :: (* -> *) -> * -> *) (m :: * -> *) a.
    (MonadTrans t, Monad m) =>
    m a -> t m a
    lift forall s (m :: * -> *). MonadState s m => m s
    get
        put :: s -> ListT m ()
    put = forall (t :: (* -> *) -> * -> *) (m :: * -> *) a.
    (MonadTrans t, Monad m) =>
    m a -> t m a
    lift forall b c a. (b -> c) -> (a -> b) -> a -> c
    . forall s (m :: * -> *). MonadState s m => s -> m ()
    put
        state :: forall a. (s -> (a, s)) -> ListT m a
    state = forall (t :: (* -> *) -> * -> *) (m :: * -> *) a.
    (MonadTrans t, Monad m) =>
    m a -> t m a
    lift forall b c a. (b -> c) -> (a -> b) -> a -> c
    . forall s (m :: * -> *) a. MonadState s m => (s -> (a, s)) -> m a
    state

    instance MonadState s m => MonadState s (MaybeT m) where
        get :: MaybeT m s
    get = forall (t :: (* -> *) -> * -> *) (m :: * -> *) a.
    (MonadTrans t, Monad m) =>
    m a -> t m a
    lift forall s (m :: * -> *). MonadState s m => m s
    get
        put :: s -> MaybeT m ()
    put = forall (t :: (* -> *) -> * -> *) (m :: * -> *) a.
    (MonadTrans t, Monad m) =>
    m a -> t m a
    lift forall b c a. (b -> c) -> (a -> b) -> a -> c
    . forall s (m :: * -> *). MonadState s m => s -> m ()
    put
        state :: forall a. (s -> (a, s)) -> MaybeT m a
    state = forall (t :: (* -> *) -> * -> *) (m :: * -> *) a.
    (MonadTrans t, Monad m) =>
    m a -> t m a
    lift forall b c a. (b -> c) -> (a -> b) -> a -> c
    . forall s (m :: * -> *) a. MonadState s m => (s -> (a, s)) -> m a
    state

    instance MonadState s m => MonadState s (ReaderT r m) where
        get :: ReaderT r m s
    get = forall (t :: (* -> *) -> * -> *) (m :: * -> *) a.
    (MonadTrans t, Monad m) =>
    m a -> t m a
    lift forall s (m :: * -> *). MonadState s m => m s
    get
        put :: s -> ReaderT r m ()
    put = forall (t :: (* -> *) -> * -> *) (m :: * -> *) a.
    (MonadTrans t, Monad m) =>
    m a -> t m a
    lift forall b c a. (b -> c) -> (a -> b) -> a -> c
    . forall s (m :: * -> *). MonadState s m => s -> m ()
    put
        state :: forall a. (s -> (a, s)) -> ReaderT r m a
    state = forall (t :: (* -> *) -> * -> *) (m :: * -> *) a.
    (MonadTrans t, Monad m) =>
    m a -> t m a
    lift forall b c a. (b -> c) -> (a -> b) -> a -> c
    . forall s (m :: * -> *) a. MonadState s m => (s -> (a, s)) -> m a
    state

    instance (Monoid w, MonadState s m) => MonadState s (Lazy.WriterT w m) where
        get :: WriterT w m s
    get = forall (t :: (* -> *) -> * -> *) (m :: * -> *) a.
    (MonadTrans t, Monad m) =>
    m a -> t m a
    lift forall s (m :: * -> *). MonadState s m => m s
    get
        put :: s -> WriterT w m ()
    put = forall (t :: (* -> *) -> * -> *) (m :: * -> *) a.
    (MonadTrans t, Monad m) =>
    m a -> t m a
    lift forall b c a. (b -> c) -> (a -> b) -> a -> c
    . forall s (m :: * -> *). MonadState s m => s -> m ()
    put
        state :: forall a. (s -> (a, s)) -> WriterT w m a
    state = forall (t :: (* -> *) -> * -> *) (m :: * -> *) a.
    (MonadTrans t, Monad m) =>
    m a -> t m a
    lift forall b c a. (b -> c) -> (a -> b) -> a -> c
    . forall s (m :: * -> *) a. MonadState s m => (s -> (a, s)) -> m a
    state

    instance (Monoid w, MonadState s m) => MonadState s (Strict.WriterT w m) where
        get :: WriterT w m s
    get = forall (t :: (* -> *) -> * -> *) (m :: * -> *) a.
    (MonadTrans t, Monad m) =>
    m a -> t m a
    lift forall s (m :: * -> *). MonadState s m => m s
    get
        put :: s -> WriterT w m ()
    put = forall (t :: (* -> *) -> * -> *) (m :: * -> *) a.
    (MonadTrans t, Monad m) =>
    m a -> t m a
    lift forall b c a. (b -> c) -> (a -> b) -> a -> c
    . forall s (m :: * -> *). MonadState s m => s -> m ()
    put
        state :: forall a. (s -> (a, s)) -> WriterT w m a
    state = forall (t :: (* -> *) -> * -> *) (m :: * -> *) a.
    (MonadTrans t, Monad m) =>
    m a -> t m a
    lift forall b c a. (b -> c) -> (a -> b) -> a -> c
    . forall s (m :: * -> *) a. MonadState s m => (s -> (a, s)) -> m a
    state