Cabal-1.16.0: A framework for packaging Haskell software

Safe HaskellNone




This provides an abstraction which deals with configuring and running programs. A Program is a static notion of a known program. A ConfiguredProgram is a Program that has been found on the current machine and is ready to be run (possibly with some user-supplied default args). Configuring a program involves finding its location and if necessary finding its version. There's reasonable default behavior for trying to find "foo" in PATH, being able to override its location, etc.


Program and functions for constructing them

data Program Source

Represents a program which can be configured.

Note: rather than constructing this directly, start with simpleProgram and override any extra fields.




programName :: String

The simple name of the program, eg. ghc

programFindLocation :: Verbosity -> IO (Maybe FilePath)

A function to search for the program if it's location was not specified by the user. Usually this will just be a

programFindVersion :: Verbosity -> FilePath -> IO (Maybe Version)

Try to find the version of the program. For many programs this is not possible or is not necessary so it's ok to return Nothing.

programPostConf :: Verbosity -> ConfiguredProgram -> IO [ProgArg]

A function to do any additional configuration after we have located the program (and perhaps identified its version). It is allowed to return additional flags that will be passed to the program on every invocation.

simpleProgram :: String -> ProgramSource

Make a simple named program.

By default we'll just search for it in the path and not try to find the version name. You can override these behaviours if necessary, eg:

 simpleProgram "foo" { programFindLocation = ... , programFindVersion ... }

Configured program and related functions

data ConfiguredProgram Source

Represents a program which has been configured and is thus ready to be run.

These are usually made by configuring a Program, but if you have to construct one directly then start with simpleConfiguredProgram and override any extra fields.




programId :: String

Just the name again

programVersion :: Maybe Version

The version of this program, if it is known.

programDefaultArgs :: [String]

Default command-line args for this program. These flags will appear first on the command line, so they can be overridden by subsequent flags.

programOverrideArgs :: [String]

Override command-line args for this program. These flags will appear last on the command line, so they override all earlier flags.

programLocation :: ProgramLocation

Location of the program. eg. /usr/bin/ghc-6.4

programPath :: ConfiguredProgram -> FilePathSource

The full path of a configured program.

data ProgramLocation Source

Where a program was found. Also tells us whether it's specifed by user or not. This includes not just the path, but the program as well.



The user gave the path to this program, eg. --ghc-path=/usr/bin/ghc-6.6


The program was found automatically.

simpleConfiguredProgram :: String -> ProgramLocation -> ConfiguredProgramSource

Make a simple ConfiguredProgram.

 simpleConfiguredProgram "foo" (FoundOnSystem path)