| Cabal-1.8.0.6: A framework for packaging Haskell software | Contents | Index

Distribution.Simple.Program.Run

Portability | portable
Maintainer | cabal-devel@haskell.org

Description
This module provides a data type for program invocations and functions to run them.
Synopsis

data ProgramInvocation = ProgramInvocation {

progInvokePath :: FilePath
progInvokeArgs :: [String]
progInvokeEnv :: [(String, String)]
progInvokeCwd :: Maybe FilePath
progInvokeInput :: Maybe String
progInvokeInputEncoding :: IOEncoding
progInvokeOutputEncoding :: IOEncoding

}

data IOEncoding

= IOEncodingText
| IOEncodingUTF8

emptyProgramInvocation :: ProgramInvocation
simpleProgramInvocation :: FilePath -> [String] -> ProgramInvocation
programInvocation :: ConfiguredProgram -> [String] -> ProgramInvocation
multiStageProgramInvocation :: ProgramInvocation -> (ProgramInvocation, ProgramInvocation, ProgramInvocation) -> [String] -> [ProgramInvocation]
runProgramInvocation :: Verbosity -> ProgramInvocation -> IO ()
getProgramInvocationOutput :: Verbosity -> ProgramInvocation -> IO String

Documentation
data ProgramInvocation

Represents a specific invocation of a specific program. This is used as an intermediate type between deciding how to call a program and actually doing it. This provides the opportunity to the caller to adjust how the program will be called. These invocations can either be run directly or turned into shell or batch scripts.
Constructors

ProgramInvocation |

progInvokePath :: FilePath |
progInvokeArgs :: [String] |
progInvokeEnv :: [(String, String)] |
progInvokeCwd :: Maybe FilePath |
progInvokeInput :: Maybe String |
progInvokeInputEncoding :: IOEncoding |
progInvokeOutputEncoding :: IOEncoding |

data IOEncoding

Constructors

IOEncodingText |
IOEncodingUTF8 |

emptyProgramInvocation :: ProgramInvocation
simpleProgramInvocation :: FilePath -> [String] -> ProgramInvocation
programInvocation :: ConfiguredProgram -> [String] -> ProgramInvocation
multiStageProgramInvocation :: ProgramInvocation -> (ProgramInvocation, ProgramInvocation, ProgramInvocation) -> [String] -> [ProgramInvocation]

Like the unix xargs program. Useful for when we've got very long command lines that might overflow an OS limit on command line length and so you need to invoke a command multiple times to get all the args in.

It takes four template invocations corresponding to the simple, initial, middle and last invocations. If the number of args given is small enough that we can get away with just a single invocation then the simple one is used:

     $ simple args

If the number of args given means that we need to use multiple invocations then the templates for the initial, middle and last invocations are used:

     $ initial args_0
     $ middle  args_1
     $ middle  args_2
       ...
     $ final   args_n

runProgramInvocation :: Verbosity -> ProgramInvocation -> IO ()
getProgramInvocationOutput :: Verbosity -> ProgramInvocation -> IO String
Produced by Haddock version 2.6.1