Safe Haskell | Safe-Infered |
---|
A module for shell-like / perl-like programming in Haskell. The stuff in here is not always pretty, but it gets the 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
- shelly :: MonadIO m => ShIO a -> m a
- sub :: ShIO a -> ShIO a
- silently :: ShIO a -> ShIO a
- verbosely :: ShIO a -> ShIO a
- print_commands :: ShIO a -> ShIO a
- setenv :: Text -> Text -> ShIO ()
- getenv :: Text -> ShIO Text
- getenv_def :: Text -> Text -> ShIO Text
- cd :: FilePath -> ShIO ()
- chdir :: FilePath -> ShIO a -> ShIO a
- pwd :: ShIO FilePath
- echo, echo_n_err, echo_err, echo_n :: Text -> ShIO ()
- inspect :: Show s => s -> ShIO ()
- ls :: FilePath -> ShIO [FilePath]
- ls' :: FilePath -> ShIO [Text]
- test_e :: FilePath -> ShIO Bool
- test_f :: FilePath -> ShIO Bool
- test_d :: FilePath -> ShIO Bool
- test_s :: FilePath -> ShIO Bool
- which :: FilePath -> ShIO (Maybe FilePath)
- find :: FilePath -> ShIO [FilePath]
- path :: FilePath -> ShIO FilePath
- absPath :: FilePath -> ShIO FilePath
- 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 Text
- writefile :: FilePath -> Text -> ShIO ()
- appendfile :: FilePath -> Text -> ShIO ()
- withTmpDir :: (FilePath -> ShIO a) -> ShIO a
- run :: FilePath -> [Text] -> ShIO Text
- (#) :: FilePath -> [Text] -> ShIO Text
- run_ :: FilePath -> [Text] -> ShIO ()
- command :: FilePath -> [Text] -> [Text] -> ShIO Text
- command_ :: FilePath -> [Text] -> [Text] -> ShIO ()
- lastStderr :: ShIO Text
- exit :: Int -> ShIO ()
- errorExit :: Text -> ShIO ()
- (<$>) :: 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
- catchany :: IO a -> (SomeException -> IO a) -> IO a
- catch_sh :: Exception e => ShIO a -> (e -> ShIO a) -> ShIO a
- catchany_sh :: ShIO a -> (SomeException -> ShIO a) -> ShIO a
- data MemTime = MemTime Rational Double
- time :: ShIO a -> ShIO (MemTime, a)
- data RunFailed = RunFailed FilePath [Text] Int Text
- (|<>) :: FilePath -> Text -> Text
- (<>|) :: Text -> FilePath -> Text
- toTextUnsafe :: FilePath -> Text
- toTextWarn :: FilePath -> ShIO Text
- fromText :: Text -> FilePath
- liftIO :: MonadIO m => forall a. IO a -> m a
- when :: Monad m => Bool -> m () -> m ()
Entering ShIO.
shelly :: MonadIO m => ShIO a -> m aSource
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.
silently :: ShIO a -> ShIO aSource
Create a sub-ShIO in which external command outputs are not echoed. See sub.
verbosely :: ShIO a -> ShIO aSource
Create a sub-ShIO in which external command outputs are echoed. See sub.
print_commands :: ShIO a -> ShIO aSource
Create a sub-ShIO in which external command outputs are echoed. See sub.
Modifying and querying environment.
setenv :: Text -> Text -> ShIO ()Source
Set an environment variable. The environment is maintained in ShIO internally, and is passed to any external commands to be executed.
getenv :: Text -> ShIO TextSource
Fetch the current value of an environment variable. Both empty and non-existent variables give empty string as a result.
getenv_def :: Text -> Text -> ShIO TextSource
Fetch the current value of an environment variable. Both empty and non-existent variables give the default value as a result
cd :: FilePath -> ShIO ()Source
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.
chdir :: FilePath -> ShIO a -> ShIO aSource
cd, execute a ShIO action in the new directory and then pop back to the original directory
Printing
echo, echo_n_err, echo_err, echo_n :: Text -> ShIO ()Source
Echo text to standard (error, when using _err variants) output. The _n variants do not print a final newline.
Querying filesystem.
ls :: FilePath -> ShIO [FilePath]Source
List directory contents. Does *not* include "." and "..", but it does include (other) hidden files.
which :: FilePath -> ShIO (Maybe FilePath)Source
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
environment.
Filename helpers
path :: FilePath -> ShIO FilePathSource
makes an absolute path. Same as canonic. TODO: use normalise from system-filepath
Manipulating filesystem.
mv :: FilePath -> FilePath -> ShIO ()Source
Currently a renameFile wrapper. TODO: Support cross-filesystem move. TODO: Support directory paths in the second parameter, like in cp.
rm_f :: FilePath -> ShIO ()Source
Remove a file. Does not fail if the file already is not there. Does fail if the file is not a file.
rm_rf :: FilePath -> ShIO ()Source
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.
cp :: FilePath -> FilePath -> ShIO ()Source
Copy a file. The second path could be a directory, in which case the original file name is used, in that directory.
mkdir_p :: FilePath -> ShIO ()Source
Create a new directory, including parents (succeeds if the directory already exists).
readfile :: FilePath -> ShIO TextSource
(Strictly) read file into a Text. All other functions use Lazy Text. So Internally this reads a file as strict text and then converts it to lazy text, which is inefficient
withTmpDir :: (FilePath -> ShIO a) -> ShIO aSource
Create a temporary directory and pass it as a parameter to a ShIO computation. The directory is nuked afterwards.
Running external commands.
run :: FilePath -> [Text] -> ShIO TextSource
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 stderr output is available after the fact using
lastStderr
All of the stdout output will be loaded into memory You can avoid this but still consume the result by using run', or if you need to process the output than runFoldLines
(#) :: FilePath -> [Text] -> ShIO TextSource
An infix shorthand for run. Write "command" # [ "argument" ... ]
.
The output of last external command. See run.
exiting the program
Utilities.
(<$$>) :: Functor m => (b -> c) -> (a -> m b) -> a -> m cSource
A functor-lifting function composition.
grep :: PredicateLike pattern hay => pattern -> [hay] -> [hay]Source
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"
.
isPrefixOf
) [...]
canonic :: FilePath -> ShIO FilePathSource
Obtain a (reasonably) canonic file path to a filesystem object. Based on canonicalizePath in FileSystem.
catchany :: IO a -> (SomeException -> IO a) -> IO aSource
A helper to catch any exception (same as
...
).
catch
(e :: SomeException) -> ...
catch_sh :: Exception e => ShIO a -> (e -> ShIO a) -> ShIO aSource
Catch an exception in the ShIO monad.
catchany_sh :: ShIO a -> (SomeException -> ShIO a) -> ShIO aSource
Catch an exception in the ShIO monad.
time :: ShIO a -> ShIO (MemTime, a)Source
Run a ShIO computation and collect timing (TODO: and memory) information.
mappend () Text with a FilePath
convert between Text and FilePath
toTextUnsafe :: FilePath -> TextSource
silently uses the Right or Left value of Filesystem.Path.CurrentOS.toText
toTextWarn :: FilePath -> ShIO TextSource