A module for shell-like / perl-like programming in Haskell. The stuff in here is not pretty, but it does get job done. The functionality provided by this module is (unlike standard Haskell filesystem functionality) thread-safe: each ShIO maintains its own environment and its own working directory.
- type ShIO a = ReaderT (IORef St) IO a
- shellish :: MonadIO m => ShIO a -> m a
- sub :: ShIO a -> ShIO a
- silently :: ShIO a -> ShIO a
- verbosely :: ShIO a -> ShIO a
- setenv :: String -> String -> ShIO ()
- getenv :: String -> ShIO String
- cd :: FilePath -> ShIO ()
- pwd :: ShIO String
- echo :: String -> ShIO ()
- echo_n :: String -> ShIO ()
- echo_err :: String -> ShIO ()
- echo_n_err :: String -> ShIO ()
- ls :: FilePath -> ShIO [String]
- test_e :: FilePath -> ShIO Bool
- test_f :: FilePath -> ShIO Bool
- test_d :: FilePath -> ShIO Bool
- which :: String -> ShIO (Maybe FilePath)
- find :: FilePath -> ShIO [String]
- mv :: FilePath -> FilePath -> ShIO ()
- rm_f :: FilePath -> ShIO ()
- rm_rf :: FilePath -> ShIO ()
- cp :: FilePath -> FilePath -> ShIO ()
- cp_r :: FilePath -> FilePath -> ShIO ()
- mkdir :: FilePath -> ShIO ()
- mkdir_p :: FilePath -> ShIO ()
- readfile :: FilePath -> ShIO String
- writefile :: FilePath -> String -> ShIO ()
- appendfile :: FilePath -> String -> ShIO ()
- withTmpDir :: (FilePath -> ShIO a) -> ShIO a
- run :: String -> [String] -> ShIO String
- (#) :: String -> [String] -> ShIO String
- lastOutput :: ShIO ByteString
- lastStdout :: ShIO ByteString
- lastStderr :: ShIO ByteString
- (</>) :: FilePath -> FilePath -> FilePath
- (<.>) :: FilePath -> String -> FilePath
- (<$>) :: Functor f => (a -> b) -> f a -> f b
- (<$$>) :: Functor m => (b -> c) -> (a -> m b) -> a -> m c
- grep :: PredicateLike pattern hay => pattern -> [hay] -> [hay]
- whenM :: Monad m => m Bool -> m () -> m ()
- canonic :: FilePath -> ShIO FilePath
- catch_sh :: Exception e => ShIO a -> (e -> ShIO a) -> ShIO a
- liftIO :: MonadIO m => forall a. IO a -> m a
- data MemTime = MemTime Rational Double
- time :: ShIO a -> ShIO (MemTime, a)
- catchany :: IO a -> (SomeException -> IO a) -> IO a
- data RunFailed = RunFailed String Int String
Enter a ShIO from (Monad)IO. The environment and working directories are inherited from the current process-wide values. Any subsequent changes in processwide working directory or environment are not reflected in the running ShIO.
Enter a sub-ShIO. The new ShIO inherits the environment and working directory from the current one, but the sub-ShIO cannot affect the current one. Exceptions are propagated normally.
Create a sub-ShIO in which external command outputs are not echoed. See sub.
Create a sub-ShIO in which external command outputs are echoed. See sub.
Modifying and querying environment.
Set an environment variable. The environment is maintained in ShIO internally, and is passed to any external commands to be executed.
Fetch the current value of an environment variable. Both empty and non-existent variables give empty string as a result.
Change current working directory of ShIO. This does *not* change the working directory of the process we are running it. Instead, ShIO keeps track of its own workking directory and builds absolute paths internally instead of passing down relative paths. This may have performance repercussions if you are doing hundreds of thousands of filesystem operations. You will want to handle these issues differently in those cases.
Printing & stuff.
Echo string to standard (error, when using _err variants) output. The _n variants do not print a final newline.
List directory contents. Does *not* include "." and "..", but it does include (other) hidden files.
Get a full path to an executable on
PATH, if exists. FIXME does not
respect setenv'd environment and uses
PATH inherited from the process
Remove a file. Does not fail if the file already is not there. Does fail if the file is not a file.
A swiss army cannon for removing things. Actually this goes farther than a normal rm -rf, as it will circumvent permission problems for the files we own. Use carefully.
Copy a file. The second path could be a directory, in which case the original file name is used, in that directory.
Create a new directory, including parents (succeeds if the directory already exists).
Create a temporary directory and pass it as a parameter to a ShIO computation. The directory is nuked afterwards.
Running external commands.
Execute an external command. Takes the command name (no shell allowed,
just a name of something that can be found via
PATH; FIXME: setenv'd
PATH is not taken into account, only the one inherited from the actual
outside environment). Nothing is provided on stdin of the process, and
stdout and stderr are collected and stored. The stdout is returned as
a result of run, and complete outputs are available after the fact using
lastStdout, lastStderr and lastOutput with the last giving an
interleaving of both, approximately reflecting the times of their arrival --
2>&1 would give you in a shell.
An infix shorthand for run. Write
"command" # [ "argument" ... ].
addExtension, for people who like that sort of thing.
A functor-lifting function composition.
Like filter, but more conveniently used with String lists, where a
substring match (TODO: also provide regexps, and maybe globs) is expressed as
grep "needle" [ "the", "stack", "of", "hay" ]. Boolean
predicates just like with filter are supported too:
grep ("fun" .
Obtain a (reasonably) canonic file path to a filesystem object. Based on canonicalizePath in System.FilePath.
Catch an exception in the ShIO monad.
Run a ShIO computation and collect timing (TODO: and memory) information.
A helper to catch any exception (same as
catch (e :: SomeException) -> ...