Control.Monad.Hefty.Concurrent.Subprocess

Effects for well-typed subprocess.

Documentation

process :: FilePath -> [String] -> CreateProcess ('SubprocMode 'NoPipe 'NoPipe 'NoPipe 'Wait 'Wait)

data CreateProcess (p :: SubprocMode) where

Constructors

CreateProcess

Fields

• :: forall (i :: StreamMode) (o :: StreamMode) (e :: StreamMode) (lp :: Lifecycle) (ls :: Lifecycle). { cmdspec :: CmdSpec

  Executable & arguments, or shell command. If cwd is Nothing, relative paths are resolved with respect to the current working directory. If cwd is provided, it is implementation-dependent whether relative paths are resolved with respect to cwd or the current working directory, so absolute paths should be used to ensure portability.

•    , stdin :: StdStream i

  How to determine stdin

•    , stdout :: StdStream o

  How to determine stdout

•    , stderr :: StdStream e

  How to determine stderr

•    , subprocLifecycle :: LifecycleMode lp

  Whether to kill the subprocess or wait when the scope's computation finishes first.

•    , scopeLifecycle :: LifecycleMode ls

  Whether to cancel the scope's computation or wait when the subprocess finishes first.

•    , cwd :: Maybe FilePath

  Optional path to the working directory for the new process

•    , env :: Maybe [(String, String)]

  Optional environment (otherwise inherit from the current process)

•    , closeFds :: Bool

  Close all file descriptors except stdin, stdout and stderr in the new process (on Windows, only works if std_in, std_out, and std_err are all Inherit). This implementation will call close on every fd from 3 to the maximum of open files, which can be slow for high maximum of open files. XXX verify what happens with fds in nodejs child processes

•    , createGroup :: Bool

  Create a new process group. On JavaScript this also creates a new session.

•    , delegateCtlc :: Bool

  Delegate control-C handling. Use this for interactive console processes to let them handle control-C themselves (see below for details).

•    , detachConsole :: Bool

  Use the windows DETACHED_PROCESS flag when creating the process; does nothing on other platforms.

•    , createNewConsole :: Bool

  Use the windows CREATE_NEW_CONSOLE flag when creating the process; does nothing on other platforms.

•    , newSession :: Bool

  Use posix setsid to start the new process in a new session; starts process in a new session on JavaScript; does nothing on other platforms.

•    , childGroup :: Maybe GroupID

  Use posix setgid to set child process's group id; works for JavaScript when system running nodejs is posix. does nothing on other platforms.

•    , childUser :: Maybe UserID

  Use posix setuid to set child process's user id; works for JavaScript when system running nodejs is posix. does nothing on other platforms.

•    , useProcessJobs :: Bool

  On Windows systems this flag indicates that we should wait for the entire process tree to finish before unblocking. On POSIX systems this flag is ignored. See $exec-on-windows for details.

•    } -> CreateProcess ('SubprocMode i o e lp ls)

data Lifecycle

Constructors

Kill

Wait

shell :: String -> CreateProcess ('SubprocMode 'NoPipe 'NoPipe 'NoPipe 'Wait 'Wait)

data StdStream (s :: StreamMode) where

Constructors

CreatePipe

Fields

• :: StdStream 'Piped

  Create a new pipe. The returned Handle will use the default encoding and newline translation mode (just like Handles created by openFile).

Inherit

Fields

• :: StdStream 'NoPipe

  Inherit Handle from parent

UseHandle

Fields

• :: Handle
• -> StdStream 'NoPipe

  Use the supplied Handle

NoStream

Fields

• :: StdStream 'NoPipe

  Close the stream's file descriptor without passing a Handle. On POSIX systems this may lead to strange behavior in the child process because attempting to read or write after the file has been closed throws an error. This should only be used with child processes that don't use the file descriptor at all. If you wish to ignore the child process's output you should either create a pipe and drain it manually or pass a Handle that writes to /dev/null.

data Subprocess (p :: SubprocMode) a where

Constructors

WriteStdin :: forall (o :: StreamMode) (e :: StreamMode) (lp :: Lifecycle). ByteString -> Subprocess ('SubprocMode 'Piped o e lp 'Kill) ()

TryWriteStdin :: forall (o :: StreamMode) (e :: StreamMode) (lp :: Lifecycle) (ls :: Lifecycle). ByteString -> Subprocess ('SubprocMode 'Piped o e lp ls) Bool

ReadStdout :: forall (i :: StreamMode) (e :: StreamMode) (lp :: Lifecycle) (ls :: Lifecycle). Subprocess ('SubprocMode i 'Piped e lp ls) ByteString

ReadStderr :: forall (i :: StreamMode) (o :: StreamMode) (lp :: Lifecycle) (ls :: Lifecycle). Subprocess ('SubprocMode i o 'Piped lp ls) ByteString

PollSubproc :: forall (i :: StreamMode) (o :: StreamMode) (e :: StreamMode) (lp :: Lifecycle). Subprocess ('SubprocMode i o e lp 'Wait) (Maybe ExitCode)

data SubprocMode

Constructors

SubprocMode StreamMode StreamMode StreamMode Lifecycle Lifecycle

data StreamMode

Constructors

Piped

NoPipe

type SubprocProvider (eh :: [EffectH]) (ef :: [EffectF]) = Provide SubprocResult CreateProcess (Const2 LNop :: SubprocMode -> (Type -> Type) -> Type -> Type) Subprocess eh ef

data SubprocResult (p :: SubprocMode) a where

Constructors

RaceResult :: forall a (i :: StreamMode) (o :: StreamMode) (e :: StreamMode). Either ExitCode a -> SubprocResult ('SubprocMode i o e 'Kill 'Kill) a

SubprocResult :: forall a (i :: StreamMode) (o :: StreamMode) (e :: StreamMode). ExitCode -> Maybe a -> SubprocResult ('SubprocMode i o e 'Wait 'Kill) a

ScopeResult :: forall a (i :: StreamMode) (o :: StreamMode) (e :: StreamMode). Maybe ExitCode -> a -> SubprocResult ('SubprocMode i o e 'Kill 'Wait) a

SubprocScopeResult :: forall a (i :: StreamMode) (o :: StreamMode) (e :: StreamMode). ExitCode -> a -> SubprocResult ('SubprocMode i o e 'Wait 'Wait) a

Instances

Show a => Show (SubprocResult p a)

Defined in Control.Monad.Hefty.Concurrent.Subprocess

Methods

showsPrec :: Int -> SubprocResult p a -> ShowS

show :: SubprocResult p a -> String

showList :: [SubprocResult p a] -> ShowS

Eq a => Eq (SubprocResult p a)

Defined in Control.Monad.Hefty.Concurrent.Subprocess

Methods

(==) :: SubprocResult p a -> SubprocResult p a -> Bool

(/=) :: SubprocResult p a -> SubprocResult p a -> Bool

runSubprocIO :: forall (eh :: [EffectH]) (ef :: [EffectF]). (UnliftIO <<| eh, IO <| ef) => Eff (SubprocProvider eh ef ': eh) ef ~> Eff eh ef

toRawCreateProcess :: forall (stdio :: SubprocMode). CreateProcess stdio -> CreateProcess

hRead :: Handle -> IO ByteString

data LifecycleMode (t :: Lifecycle) where

Constructors

KillMode :: LifecycleMode 'Kill

WaitMode :: LifecycleMode 'Wait

chunkSize :: Int

command :: CmdSpec -> CreateProcess ('SubprocMode 'NoPipe 'NoPipe 'NoPipe 'Wait 'Wait)

commandWith :: forall (i :: StreamMode) (o :: StreamMode) (e :: StreamMode) (lp :: Lifecycle) (ls :: Lifecycle). CmdSpec -> StdStream i -> StdStream o -> StdStream e -> LifecycleMode lp -> LifecycleMode ls -> CreateProcess ('SubprocMode i o e lp ls)

toRawStdStream :: forall (pipe :: StreamMode). StdStream pipe -> StdStream

writeStdin :: forall (o :: StreamMode) (e :: StreamMode) (lp :: Lifecycle) f. SendFOE (Subprocess ('SubprocMode 'Piped o e lp 'Kill)) f => ByteString -> f ()

writeStdin' :: forall {k} (tag :: k) (o :: StreamMode) (e :: StreamMode) (lp :: Lifecycle) f. SendFOE (Tag (Subprocess ('SubprocMode 'Piped o e lp 'Kill)) tag) f => ByteString -> f ()

writeStdin'' :: forall {k} (key :: k) (o :: StreamMode) (e :: StreamMode) (lp :: Lifecycle) f. SendFOEBy key (Subprocess ('SubprocMode 'Piped o e lp 'Kill)) f => ByteString -> f ()

tryWriteStdin :: forall (o :: StreamMode) (e :: StreamMode) (lp :: Lifecycle) (ls :: Lifecycle) f. SendFOE (Subprocess ('SubprocMode 'Piped o e lp ls)) f => ByteString -> f Bool

tryWriteStdin' :: forall {k} (tag :: k) (o :: StreamMode) (e :: StreamMode) (lp :: Lifecycle) (ls :: Lifecycle) f. SendFOE (Tag (Subprocess ('SubprocMode 'Piped o e lp ls)) tag) f => ByteString -> f Bool

tryWriteStdin'' :: forall {k} (key :: k) (o :: StreamMode) (e :: StreamMode) (lp :: Lifecycle) (ls :: Lifecycle) f. SendFOEBy key (Subprocess ('SubprocMode 'Piped o e lp ls)) f => ByteString -> f Bool

readStdout :: forall (i :: StreamMode) (e :: StreamMode) (lp :: Lifecycle) (ls :: Lifecycle) f. SendFOE (Subprocess ('SubprocMode i 'Piped e lp ls)) f => f ByteString

readStdout' :: forall {k} (tag :: k) (i :: StreamMode) (e :: StreamMode) (lp :: Lifecycle) (ls :: Lifecycle) f. SendFOE (Tag (Subprocess ('SubprocMode i 'Piped e lp ls)) tag) f => f ByteString

readStdout'' :: forall {k} (key :: k) (i :: StreamMode) (e :: StreamMode) (lp :: Lifecycle) (ls :: Lifecycle) f. SendFOEBy key (Subprocess ('SubprocMode i 'Piped e lp ls)) f => f ByteString

readStderr :: forall (i :: StreamMode) (o :: StreamMode) (lp :: Lifecycle) (ls :: Lifecycle) f. SendFOE (Subprocess ('SubprocMode i o 'Piped lp ls)) f => f ByteString

readStderr' :: forall {k} (tag :: k) (i :: StreamMode) (o :: StreamMode) (lp :: Lifecycle) (ls :: Lifecycle) f. SendFOE (Tag (Subprocess ('SubprocMode i o 'Piped lp ls)) tag) f => f ByteString

readStderr'' :: forall {k} (key :: k) (i :: StreamMode) (o :: StreamMode) (lp :: Lifecycle) (ls :: Lifecycle) f. SendFOEBy key (Subprocess ('SubprocMode i o 'Piped lp ls)) f => f ByteString

pollSubproc :: forall (i :: StreamMode) (o :: StreamMode) (e :: StreamMode) (lp :: Lifecycle) f. SendFOE (Subprocess ('SubprocMode i o e lp 'Wait)) f => f (Maybe ExitCode)

pollSubproc' :: forall {k} (tag :: k) (i :: StreamMode) (o :: StreamMode) (e :: StreamMode) (lp :: Lifecycle) f. SendFOE (Tag (Subprocess ('SubprocMode i o e lp 'Wait)) tag) f => f (Maybe ExitCode)

pollSubproc'' :: forall {k} (key :: k) (i :: StreamMode) (o :: StreamMode) (e :: StreamMode) (lp :: Lifecycle) f. SendFOEBy key (Subprocess ('SubprocMode i o e lp 'Wait)) f => f (Maybe ExitCode)

type LSubprocess (p :: SubprocMode) = LiftFOE (Subprocess p)

pattern LWriteStdin :: forall a (o :: StreamMode) (e :: StreamMode) (lp :: Lifecycle) f. () => (a ~ (), ()) => ByteString -> LiftFOE (Subprocess ('SubprocMode 'Piped o e lp 'Kill)) f a

pattern LTryWriteStdin :: forall a (o :: StreamMode) (e :: StreamMode) (lp :: Lifecycle) (ls :: Lifecycle) f. () => (a ~ Bool, ()) => ByteString -> LiftFOE (Subprocess ('SubprocMode 'Piped o e lp ls)) f a

pattern LReadStdout :: forall a (i :: StreamMode) (e :: StreamMode) (lp :: Lifecycle) (ls :: Lifecycle) f. () => (a ~ ByteString, ()) => LiftFOE (Subprocess ('SubprocMode i 'Piped e lp ls)) f a

pattern LReadStderr :: forall a (i :: StreamMode) (o :: StreamMode) (lp :: Lifecycle) (ls :: Lifecycle) f. () => (a ~ ByteString, ()) => LiftFOE (Subprocess ('SubprocMode i o 'Piped lp ls)) f a

pattern LPollSubproc :: forall a (i :: StreamMode) (o :: StreamMode) (e :: StreamMode) (lp :: Lifecycle) f. () => (a ~ Maybe ExitCode, ()) => LiftFOE (Subprocess ('SubprocMode i o e lp 'Wait)) f a

module Control.Monad.Hefty.Provider

data CmdSpec

Constructors

ShellCommand String

A command line to execute using the shell

RawCommand FilePath [String]

The name of an executable with a list of arguments

The FilePath argument names the executable, and is interpreted according to the platform's standard policy for searching for executables. Specifically:

• on Unix systems the execvp(3) semantics is used, where if the executable filename does not contain a slash (/) then the PATH environment variable is searched for the executable.
• on Windows systems the Win32 CreateProcess semantics is used. Briefly: if the filename does not contain a path, then the directory containing the parent executable is searched, followed by the current directory, then some standard locations, and finally the current PATH. An .exe extension is added if the filename does not already have an extension. For full details see the documentation for the Windows SearchPath API.

Windows does not have a mechanism for passing multiple arguments. When using RawCommand on Windows, the command line is serialised into a string, with arguments quoted separately. Command line parsing is up individual programs, so the default behaviour may not work for some programs. If you are not getting the desired results, construct the command line yourself and use ShellCommand.

Instances

IsString CmdSpec

construct a ShellCommand from a string literal

Since: process-1.2.1.0

Defined in System.Process.Common

Methods

fromString :: String -> CmdSpec

Show CmdSpec

Defined in System.Process.Common

Methods

showsPrec :: Int -> CmdSpec -> ShowS

show :: CmdSpec -> String

showList :: [CmdSpec] -> ShowS

Eq CmdSpec

Defined in System.Process.Common

Methods

(==) :: CmdSpec -> CmdSpec -> Bool

(/=) :: CmdSpec -> CmdSpec -> Bool

type GroupID = CGid

type UserID = CUid

data Handle

Haskell defines operations to read and write characters from and to files, represented by values of type Handle. Each value of this type is a handle: a record used by the Haskell run-time system to manage I/O with file system objects. A handle has at least the following properties:

• whether it manages input or output or both;
• whether it is open, closed or semi-closed;
• whether the object is seekable;
• whether buffering is disabled, or enabled on a line or block basis;
• a buffer (whose length may be zero).

Most handles will also have a current I/O position indicating where the next input or output operation will occur. A handle is readable if it manages only input or both input and output; likewise, it is writable if it manages only output or both input and output. A handle is open when first allocated. Once it is closed it can no longer be used for either input or output, though an implementation cannot re-use its storage while references remain to it. Handles are in the Show and Eq classes. The string produced by showing a handle is system dependent; it should include enough information to identify the handle for debugging. A handle is equal according to == only to itself; no attempt is made to compare the internal state of different handles for equality.

Instances

Show Handle

Since: base-4.1.0.0

Defined in GHC.IO.Handle.Types

Methods

showsPrec :: Int -> Handle -> ShowS

show :: Handle -> String

showList :: [Handle] -> ShowS

Eq Handle

Since: base-4.1.0.0

Defined in GHC.IO.Handle.Types

Methods

(==) :: Handle -> Handle -> Bool

(/=) :: Handle -> Handle -> Bool

data ExitCode

Defines the exit codes that a program can return.

Instances

Exception ExitCode

Since: base-4.1.0.0

Defined in GHC.IO.Exception

Methods

toException :: ExitCode -> SomeException

fromException :: SomeException -> Maybe ExitCode

displayException :: ExitCode -> String

Generic ExitCode

Defined in GHC.IO.Exception

Associated Types

type Rep ExitCode

Defined in GHC.IO.Exception

type Rep ExitCode = D1 ('MetaData "ExitCode" "GHC.IO.Exception" "base" 'False) (C1 ('MetaCons "ExitSuccess" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ExitFailure" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int)))

Methods

from :: ExitCode -> Rep ExitCode x

to :: Rep ExitCode x -> ExitCode

Read ExitCode

Defined in GHC.IO.Exception

Methods

readsPrec :: Int -> ReadS ExitCode

readList :: ReadS [ExitCode]

readPrec :: ReadPrec ExitCode

readListPrec :: ReadPrec [ExitCode]

Show ExitCode

Defined in GHC.IO.Exception

Methods

showsPrec :: Int -> ExitCode -> ShowS

show :: ExitCode -> String

showList :: [ExitCode] -> ShowS

Eq ExitCode

Defined in GHC.IO.Exception

Methods

(==) :: ExitCode -> ExitCode -> Bool

(/=) :: ExitCode -> ExitCode -> Bool

Ord ExitCode

Defined in GHC.IO.Exception

Methods

compare :: ExitCode -> ExitCode -> Ordering

(<) :: ExitCode -> ExitCode -> Bool

(<=) :: ExitCode -> ExitCode -> Bool

(>) :: ExitCode -> ExitCode -> Bool

(>=) :: ExitCode -> ExitCode -> Bool

max :: ExitCode -> ExitCode -> ExitCode

min :: ExitCode -> ExitCode -> ExitCode

type Rep ExitCode

Defined in GHC.IO.Exception

type Rep ExitCode = D1 ('MetaData "ExitCode" "GHC.IO.Exception" "base" 'False) (C1 ('MetaCons "ExitSuccess" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ExitFailure" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int)))

data ByteString

A space-efficient representation of a Word8 vector, supporting many efficient operations.

A ByteString contains 8-bit bytes, or by using the operations from Data.ByteString.Char8 it can be interpreted as containing 8-bit characters.

Instances

Data ByteString

Defined in Data.ByteString.Internal.Type

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ByteString -> c ByteString

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ByteString

toConstr :: ByteString -> Constr

dataTypeOf :: ByteString -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ByteString)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ByteString)

gmapT :: (forall b. Data b => b -> b) -> ByteString -> ByteString

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ByteString -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ByteString -> r

gmapQ :: (forall d. Data d => d -> u) -> ByteString -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ByteString -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ByteString -> m ByteString

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ByteString -> m ByteString

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ByteString -> m ByteString

IsString ByteString

Beware: fromString truncates multi-byte characters to octets. e.g. "枯朶に烏のとまりけり秋の暮" becomes �6k�nh~�Q��n�

Defined in Data.ByteString.Internal.Type

Methods

fromString :: String -> ByteString

Monoid ByteString

Defined in Data.ByteString.Internal.Type

Methods

mempty :: ByteString

mappend :: ByteString -> ByteString -> ByteString

mconcat :: [ByteString] -> ByteString

Semigroup ByteString

Defined in Data.ByteString.Internal.Type

Methods

(<>) :: ByteString -> ByteString -> ByteString

sconcat :: NonEmpty ByteString -> ByteString

stimes :: Integral b => b -> ByteString -> ByteString

IsList ByteString

Since: bytestring-0.10.12.0

Defined in Data.ByteString.Internal.Type

Associated Types

type Item ByteString

Defined in Data.ByteString.Internal.Type

type Item ByteString = Word8

Methods

fromList :: [Item ByteString] -> ByteString

fromListN :: Int -> [Item ByteString] -> ByteString

toList :: ByteString -> [Item ByteString]

Read ByteString

Defined in Data.ByteString.Internal.Type

Methods

readsPrec :: Int -> ReadS ByteString

readList :: ReadS [ByteString]

readPrec :: ReadPrec ByteString

readListPrec :: ReadPrec [ByteString]

Show ByteString

Defined in Data.ByteString.Internal.Type

Methods

showsPrec :: Int -> ByteString -> ShowS

show :: ByteString -> String

showList :: [ByteString] -> ShowS

NFData ByteString

Defined in Data.ByteString.Internal.Type

Methods

rnf :: ByteString -> ()

Eq ByteString

Defined in Data.ByteString.Internal.Type

Methods

(==) :: ByteString -> ByteString -> Bool

(/=) :: ByteString -> ByteString -> Bool

Ord ByteString

Defined in Data.ByteString.Internal.Type

Methods

compare :: ByteString -> ByteString -> Ordering

(<) :: ByteString -> ByteString -> Bool

(<=) :: ByteString -> ByteString -> Bool

(>) :: ByteString -> ByteString -> Bool

(>=) :: ByteString -> ByteString -> Bool

max :: ByteString -> ByteString -> ByteString

min :: ByteString -> ByteString -> ByteString

Lift ByteString

Since: bytestring-0.11.2.0

Defined in Data.ByteString.Internal.Type

Methods

lift :: Quote m => ByteString -> m Exp

liftTyped :: forall (m :: Type -> Type). Quote m => ByteString -> Code m ByteString

type Item ByteString

Defined in Data.ByteString.Internal.Type

type Item ByteString = Word8

hPut :: Handle -> ByteString -> IO ()

Outputs a ByteString to the specified Handle.

hGet :: Handle -> Int -> IO ByteString

Read a ByteString directly from the specified Handle. This is far more efficient than reading the characters into a String and then using pack. First argument is the Handle to read from, and the second is the number of bytes to read. It returns the bytes read, up to n, or empty if EOF has been reached.

hGet is implemented in terms of hGetBuf.

If the handle is a pipe or socket, and the writing end is closed, hGet will behave as if EOF was reached.

hGetNonBlocking :: Handle -> Int -> IO ByteString

hGetNonBlocking is similar to hGet, except that it will never block waiting for data to become available, instead it returns only whatever data is available. If there is no data available to be read, hGetNonBlocking returns empty.

Note: on Windows and with Haskell implementation other than GHC, this function does not work correctly; it behaves identically to hGet.