darcs-2.8.4: a distributed, interactive, smart revision control system

Portability | portable
Stability | experimental
Maintainer | darcs-devel@darcs.net
Safe Haskell | None

Progress

Description

Utility functions for tracking progress of long-running actions.

Synopsis

- beginTedious :: String -> IO ()
- endTedious :: String -> IO ()
- tediousSize :: String -> Int -> IO ()
- debugMessage :: String -> IO ()
- debugFail :: String -> IO a
- withoutProgress :: IO a -> IO a
- progress :: String -> a -> a
- progressKeepLatest :: String -> a -> a
- finishedOne :: String -> String -> a -> a
- finishedOneIO :: String -> String -> IO ()
- progressList :: String -> [a] -> [a]
- minlist :: Int
- setProgressMode :: Bool -> IO ()

# Documentation

beginTedious :: String -> IO ()

`beginTedious k` starts a tedious process and registers it in `_progressData` with the key `k`. A tedious process is one for which we want a progress indicator.

Wouldn't it be safer if it had type String -> IO ProgressDataKey, so that we can ensure there is no collision? What happens if you call beginTedious twice with the same string, without calling endTedious in the meantime?

endTedious :: String -> IO ()

`endTedious k` unregisters the tedious process with key `k`, printing Done if such a tedious process exists.

tediousSize :: String -> Int -> IO ()

debugMessage :: String -> IO ()

debugFail :: String -> IO a

withoutProgress :: IO a -> IO a

progress :: String -> a -> a

progressKeepLatest :: String -> a -> a

finishedOne :: String -> String -> a -> a

finishedOneIO :: String -> String -> IO ()

progressList :: String -> [a] -> [a]

minlist :: Int

XXX: document this constant

setProgressMode :: Bool -> IO ()