Copyright | (c) The University of Glasgow 2001 (c) Jeff Newbern 2003-2007 (c) Andriy Palamarchuk 2007 |
---|---|
License | BSD-style (see the file LICENSE) |
Maintainer | libraries@haskell.org |
Stability | experimental |
Portability | portable |
Safe Haskell | Safe |
Language | Haskell2010 |
- Computation type:
- Computations which can be interrupted and resumed.
- Binding strategy:
- Binding a function to a monadic value creates a new continuation which uses the function as the continuation of the monadic computation.
- Useful for:
- Complex control structures, error handling, and creating co-routines.
- Zero and plus:
- None.
- Example type:
Cont
r a
The Continuation monad represents computations in continuation-passing style
(CPS).
In continuation-passing style function result is not returned,
but instead is passed to another function,
received as a parameter (continuation).
Computations are built up from sequences
of nested continuations, terminated by a final continuation (often id
)
which produces the final result.
Since continuations are functions which represent the future of a computation,
manipulation of the continuation functions can achieve complex manipulations
of the future of the computation,
such as interrupting a computation in the middle, aborting a portion
of a computation, restarting a computation, and interleaving execution of
computations.
The Continuation monad adapts CPS to the structure of a monad.
Before using the Continuation monad, be sure that you have a firm understanding of continuation-passing style and that continuations represent the best solution to your particular design problem. Many algorithms which require continuations in other languages do not require them in Haskell, due to Haskell's lazy semantics. Abuse of the Continuation monad can produce code that is impossible to understand and maintain.
Synopsis
- class Monad m => MonadCont (m :: Type -> Type) where
- callCC :: ((a -> m b) -> m a) -> m a
- label :: MonadCont m => a -> m (a -> m b, a)
- label_ :: MonadCont m => m (m a)
- type Cont r = ContT r Identity
- cont :: ((a -> r) -> r) -> Cont r a
- runCont :: Cont r a -> (a -> r) -> r
- evalCont :: Cont r r -> r
- mapCont :: (r -> r) -> Cont r a -> Cont r a
- withCont :: ((b -> r) -> a -> r) -> Cont r a -> Cont r b
- newtype ContT (r :: k) (m :: k -> Type) a = ContT ((a -> m r) -> m r)
- runContT :: ContT r m a -> (a -> m r) -> m r
- evalContT :: Monad m => ContT r m r -> m r
- mapContT :: forall {k} m (r :: k) a. (m r -> m r) -> ContT r m a -> ContT r m a
- withContT :: forall {k} b m (r :: k) a. ((b -> m r) -> a -> m r) -> ContT r m a -> ContT r m b
MonadCont class
class Monad m => MonadCont (m :: Type -> Type) where Source #
callCC :: ((a -> m b) -> m a) -> m a Source #
callCC
(call-with-current-continuation)
calls a function with the current continuation as its argument.
Provides an escape continuation mechanism for use with Continuation monads.
Escape continuations allow to abort the current computation and return
a value immediately.
They achieve a similar effect to throwError
and catchError
within an Except
monad.
Advantage of this function over calling return
is that it makes
the continuation explicit,
allowing more flexibility and better control
(see examples in Control.Monad.Cont).
The standard idiom used with callCC
is to provide a lambda-expression
to name the continuation. Then calling the named continuation anywhere
within its scope will escape from the computation,
even if it is many layers deep within nested computations.
Instances
MonadCont m => MonadCont (MaybeT m) Source # | |
(Monoid w, MonadCont m) => MonadCont (AccumT w m) Source # | Since: mtl-2.3 |
MonadCont m => MonadCont (ExceptT e m) Source # | Since: mtl-2.2 |
MonadCont m => MonadCont (IdentityT m) Source # | |
MonadCont m => MonadCont (ReaderT r m) Source # | |
MonadCont m => MonadCont (StateT s m) Source # | |
MonadCont m => MonadCont (StateT s m) Source # | |
(Monoid w, MonadCont m) => MonadCont (WriterT w m) Source # | Since: mtl-2.3 |
(Monoid w, MonadCont m) => MonadCont (WriterT w m) Source # | |
(Monoid w, MonadCont m) => MonadCont (WriterT w m) Source # | |
MonadCont (ContT r m) Source # | Since: mtl-2.3.1 |
(Monoid w, MonadCont m) => MonadCont (RWST r w s m) Source # | Since: mtl-2.3 |
(Monoid w, MonadCont m) => MonadCont (RWST r w s m) Source # | |
(Monoid w, MonadCont m) => MonadCont (RWST r w s m) Source # | |
label :: MonadCont m => a -> m (a -> m b, a) Source #
Introduces a recursive binding to the continuation.
Due to the use of callCC
, calling the continuation will interrupt execution
of the current block creating an effect similar to goto/setjmp in C.
Since: mtl-2.3.1
label_ :: MonadCont m => m (m a) Source #
Simplified version of label
without arguments.
Since: mtl-2.3.1
The Cont monad
type Cont r = ContT r Identity Source #
Continuation monad.
Cont r a
is a CPS ("continuation-passing style") computation that produces an
intermediate result of type a
within a CPS computation whose final result type
is r
.
The return
function simply creates a continuation which passes the value on.
The >>=
operator adds the bound function into the continuation chain.
cont :: ((a -> r) -> r) -> Cont r a Source #
Construct a continuation-passing computation from a function.
(The inverse of runCont
)
:: Cont r a | continuation computation ( |
-> (a -> r) | the final continuation, which produces
the final result (often |
-> r |
The result of running a CPS computation with a given final continuation.
(The inverse of cont
)
The ContT monad transformer
newtype ContT (r :: k) (m :: k -> Type) a Source #
The continuation monad transformer.
Can be used to add continuation handling to any type constructor:
the Monad
instance and most of the operations do not require m
to be a monad.
ContT
is not a functor on the category of monads, and many operations
cannot be lifted through it.
ContT ((a -> m r) -> m r) |
Instances
MonadAccum w m => MonadAccum w (ContT r m) Source # | The continuation can see, and interact with, the accumulated value. Since: mtl-2.3 | ||||
MonadReader r' m => MonadReader r' (ContT r m) Source # | |||||
MonadSelect r' m => MonadSelect r' (ContT r m) Source # | The continuation describes a way of choosing a 'search' or 'ranking'
strategy for Since: mtl-2.3 | ||||
Defined in Control.Monad.Select | |||||
MonadState s m => MonadState s (ContT r m) Source # | |||||
MonadTrans (ContT r) Source # | |||||
Applicative (ContT r m) Source # | |||||
Functor (ContT r m) Source # | |||||
Monad (ContT r m) Source # | |||||
MonadFail m => MonadFail (ContT r m) Source # | |||||
Defined in Control.Monad.Trans.Cont | |||||
MonadIO m => MonadIO (ContT r m) Source # | |||||
Defined in Control.Monad.Trans.Cont | |||||
MonadCont (ContT r m) Source # | Since: mtl-2.3.1 | ||||
Generic (ContT r m a) Source # | |||||
Defined in Control.Monad.Trans.Cont
| |||||
type Rep (ContT r m a) Source # | |||||
Defined in Control.Monad.Trans.Cont |
withContT :: forall {k} b m (r :: k) a. ((b -> m r) -> a -> m r) -> ContT r m a -> ContT r m b Source #
Example 1: Simple Continuation Usage
Calculating length of a list continuation-style:
calculateLength :: [a] -> Cont r Int calculateLength l = return (length l)
Here we use calculateLength
by making it to pass its result to print
:
main = do runCont (calculateLength "123") print -- result: 3
It is possible to chain Cont
blocks with >>=
.
double :: Int -> Cont r Int double n = return (n * 2) main = do runCont (calculateLength "123" >>= double) print -- result: 6
Example 2: Using callCC
This example gives a taste of how escape continuations work, shows a typical pattern for their usage.
-- Returns a string depending on the length of the name parameter. -- If the provided string is empty, returns an error. -- Otherwise, returns a welcome message. whatsYourName :: String -> String whatsYourName name = (`runCont` id) $ do -- 1 response <- callCC $ \exit -> do -- 2 validateName name exit -- 3 return $ "Welcome, " ++ name ++ "!" -- 4 return response -- 5 validateName name exit = do when (null name) (exit "You forgot to tell me your name!")
Here is what this example does:
- Runs an anonymous
Cont
block and extracts value from it with(`runCont` id)
. Hereid
is the continuation, passed to theCont
block. - Binds
response
to the result of the followingcallCC
block, bindsexit
to the continuation. - Validates
name
. This approach illustrates advantage of usingcallCC
overreturn
. We pass the continuation tovalidateName
, and interrupt execution of theCont
block from inside ofvalidateName
. - Returns the welcome message from the
callCC
block. This line is not executed ifvalidateName
fails. - Returns from the
Cont
block.
Example 3: Using ContT
Monad Transformer
ContT
can be used to add continuation handling to other monads.
Here is an example how to combine it with IO
monad:
import Control.Monad.Cont import System.IO main = do hSetBuffering stdout NoBuffering runContT (callCC askString) reportResult askString :: (String -> ContT () IO String) -> ContT () IO String askString next = do liftIO $ putStrLn "Please enter a string" s <- liftIO $ getLine next s reportResult :: String -> IO () reportResult s = do putStrLn ("You entered: " ++ s)
Action askString
requests user to enter a string,
and passes it to the continuation.
askString
takes as a parameter a continuation taking a string parameter,
and returning IO ()
.
Compare its signature to runContT
definition.
Example 4: Using label
The early exit behavior of callCC
can be leveraged to produce other idioms:
whatsYourNameLabel :: IO () whatsYourNameLabel = evalContT $ do (beginning, attempts) <- label (0 :: Int) liftIO $ putStrLn $ "Attempt #" <> show attempts liftIO $ putStrLn $ "What's your name?" name <- liftIO getLine when (null name) $ beginning (attempts + 1) liftIO $ putStrLn $ "Welcome, " ++ name ++ "!"
Calling beggining
will interrupt execution of the block, skipping the welcome message, which will be printed only once at the very end of the loop.