Represents a program which can be configured.

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

A search path to use when locating executables. This is analogous to the unix $PATH or win32 %PATH% but with the ability to use the system default method for finding executables (findExecutable which on unix is simply looking on the $PATH but on win32 is a bit more complicated).

The default to use is [ProgSearchPathDefault] but you can add extra dirs either before, after or instead of the default, e.g. here we add an extra dir to search after the usual ones.

['ProgramSearchPathDefault', 'ProgramSearchPathDir' dir]

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 ... }

Look for a program and try to find it's version number. It can accept either an absolute path or the name of a program binary, in which case we will look for the program on the path.

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.

The full path of a configured program.

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

Runs the given configured program.

Runs the given configured program and gets the output.

Suppress any extra arguments added by the user.

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.

The default list of programs. These programs are typically used internally to Cabal.

The configuration is a collection of information about programs. It contains information both about configured programs and also about programs that we are yet to configure.

The idea is that we start from a collection of unconfigured programs and one by one we try to configure them at which point we move them into the configured collection. For unconfigured programs we record not just the Program but also any user-provided arguments and location for the program.

The 'Read'\/'Show' and Binary instances do not preserve all the unconfigured Programs because Program is not in 'Read'\/'Show' because it contains functions. So to fully restore a deserialised ProgramDb use this function to add back all the known Programs.

• It does not add the default programs, but you probably want them, use builtinPrograms in addition to any extra you might need.

Add a known program that we may configure later

Get the current ProgramSearchPath used by the ProgramDb. This is the default list of locations where programs are looked for when configuring them. This can be overridden for specific programs (with userSpecifyPath), and specific known programs can modify or ignore this search path in their own configuration code.

Change the current ProgramSearchPath used by the ProgramDb. This will affect programs that are configured from here on, so you should usually set it before configuring any programs.

User-specify this path. Basically override any path information for this program in the configuration. If it's not a known program ignore it.

Like userSpecifyPath but for a list of progs and their paths.

User-specify the arguments for this program. Basically override any args information for this program in the configuration. If it's not a known program, ignore it..

Like userSpecifyPath but for a list of progs and their args.

Get any extra args that have been previously specified for a program.

Try to find a configured program

Check that a program is configured and available to be run.

Additionally check that the program version number is suitable and return it. For example you could require AnyVersion or orLaterVersion (Version [1,0] [])

It returns the configured program, its version number and a possibly updated ProgramDb. If the program could not be configured or the version is unsuitable, it returns an error value.

Update a configured program in the database.

Try to configure a specific program. If the program is already included in the collection of unconfigured programs then we use any user-supplied location and arguments. If the program gets configured successfully it gets added to the configured collection.

Note that it is not a failure if the program cannot be configured. It's only a failure if the user supplied a location and the program could not be found at that location.

The reason for it not being a failure at this stage is that we don't know up front all the programs we will need, so we try to configure them all. To verify that a program was actually successfully configured use requireProgram.

Try to configure all the known programs that have not yet been configured.

reconfigure a bunch of programs given new user-specified args. It takes the same inputs as userSpecifyPath and userSpecifyArgs and for all progs with a new path it calls configureProgram.

Check that a program is configured and available to be run.

It raises an exception if the program could not be configured, otherwise it returns the configured program.

Like lookupProgramVersion, but raises an exception in case of error instead of returning 'Left errMsg'.

Looks up the given program in the program database and runs it.

Looks up the given program in the program database and runs it.

Look for a program on the path.