Copyright | Isaac Jones 2006 Duncan Coutts 2007-2009 |
---|---|
Maintainer | cabal-devel@haskell.org |
Portability | portable |
Safe Haskell | None |
Language | Haskell2010 |
Distribution.Simple.Program.Types
Description
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.
Synopsis
-
data
Program
=
Program
{
- programName :: String
- programFindLocation :: Verbosity -> ProgramSearchPath -> IO ( Maybe ( FilePath , [ FilePath ]))
- programFindVersion :: Verbosity -> FilePath -> IO ( Maybe Version )
- programPostConf :: Verbosity -> ConfiguredProgram -> IO ConfiguredProgram
- programNormaliseArgs :: Maybe Version -> PackageDescription -> [ String ] -> [ String ]
- type ProgramSearchPath = [ ProgramSearchPathEntry ]
- data ProgramSearchPathEntry
- simpleProgram :: String -> Program
-
data
ConfiguredProgram
=
ConfiguredProgram
{
- programId :: String
- programVersion :: Maybe Version
- programDefaultArgs :: [ String ]
- programOverrideArgs :: [ String ]
- programOverrideEnv :: [( String , Maybe String )]
- programProperties :: Map String String
- programLocation :: ProgramLocation
- programMonitorFiles :: [ FilePath ]
- programPath :: ConfiguredProgram -> FilePath
- suppressOverrideArgs :: ConfiguredProgram -> ConfiguredProgram
- type ProgArg = String
-
data
ProgramLocation
- = UserSpecified { }
- | FoundOnSystem { }
- simpleConfiguredProgram :: String -> ProgramLocation -> ConfiguredProgram
Program and functions for constructing them
Represents a program which can be configured.
Note: rather than constructing this directly, start with
simpleProgram
and
override any extra fields.
Constructors
Program | |
Fields
|
type ProgramSearchPath = [ ProgramSearchPathEntry ] Source #
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]
data ProgramSearchPathEntry Source #
Constructors
ProgramSearchPathDir FilePath |
A specific dir |
ProgramSearchPathDefault |
The system default |
Instances
simpleProgram :: String -> Program Source #
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.
Constructors
ConfiguredProgram | |
Fields
|
Instances
programPath :: ConfiguredProgram -> FilePath Source #
The full path of a configured program.
suppressOverrideArgs :: ConfiguredProgram -> ConfiguredProgram Source #
Suppress any extra arguments added by the user.
data ProgramLocation Source #
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.
Constructors
UserSpecified |
The user gave the path to this program, eg. --ghc-path=/usr/bin/ghc-6.6 |
Fields |
|
FoundOnSystem |
The program was found automatically. |
Fields |
Instances
simpleConfiguredProgram :: String -> ProgramLocation -> ConfiguredProgram Source #
Make a simple
ConfiguredProgram
.
simpleConfiguredProgram "foo" (FoundOnSystem path)