| Copyright | Duncan Coutts 2009 2013 |
|---|---|
| Maintainer | cabal-devel@haskell.org |
| Portability | portable |
| Safe Haskell | None |
| Language | Haskell2010 |
Distribution.Simple.Program.HcPkg
Contents
Description
This module provides an library interface to the hc-pkg program.
Currently only GHC and GHCJS have hc-pkg programs.
Synopsis
- data ConfiguredProgram = ConfiguredProgram {}
- data RegisterOptions = RegisterOptions {}
- defaultRegisterOptions :: RegisterOptions
- init :: ConfiguredProgram -> Verbosity -> FilePath -> IO ()
- invoke :: ConfiguredProgram -> Verbosity -> Maybe (SymbolicPath CWD ('Dir Pkg)) -> PackageDBStack -> [String] -> IO ()
- register :: ConfiguredProgram -> Verbosity -> Maybe (SymbolicPath CWD ('Dir from)) -> PackageDBStackS from -> InstalledPackageInfo -> RegisterOptions -> IO ()
- unregister :: ConfiguredProgram -> Verbosity -> Maybe (SymbolicPath CWD ('Dir Pkg)) -> PackageDB -> PackageId -> IO ()
- recache :: ConfiguredProgram -> Verbosity -> Maybe (SymbolicPath CWD ('Dir from)) -> PackageDBS from -> IO ()
- expose :: ConfiguredProgram -> Verbosity -> Maybe (SymbolicPath CWD ('Dir Pkg)) -> PackageDB -> PackageId -> IO ()
- hide :: ConfiguredProgram -> Verbosity -> Maybe (SymbolicPath CWD ('Dir Pkg)) -> PackageDB -> PackageId -> IO ()
- dump :: ConfiguredProgram -> Verbosity -> Maybe (SymbolicPath CWD ('Dir from)) -> PackageDBX (SymbolicPath from ('Dir PkgDB)) -> IO [InstalledPackageInfo]
- describe :: ConfiguredProgram -> Verbosity -> Maybe (SymbolicPath CWD ('Dir Pkg)) -> PackageDBStack -> PackageId -> IO [InstalledPackageInfo]
- list :: ConfiguredProgram -> Verbosity -> Maybe (SymbolicPath CWD ('Dir Pkg)) -> PackageDB -> IO [PackageId]
- initInvocation :: ConfiguredProgram -> Verbosity -> FilePath -> ProgramInvocation
- registerInvocation :: ConfiguredProgram -> VerbosityLevel -> Maybe (SymbolicPath CWD ('Dir from)) -> PackageDBStackS from -> InstalledPackageInfo -> RegisterOptions -> ProgramInvocation
- unregisterInvocation :: ConfiguredProgram -> VerbosityLevel -> Maybe (SymbolicPath CWD ('Dir Pkg)) -> PackageDB -> PackageId -> ProgramInvocation
- recacheInvocation :: ConfiguredProgram -> VerbosityLevel -> Maybe (SymbolicPath CWD ('Dir from)) -> PackageDBS from -> ProgramInvocation
- exposeInvocation :: ConfiguredProgram -> VerbosityLevel -> Maybe (SymbolicPath CWD ('Dir Pkg)) -> PackageDB -> PackageId -> ProgramInvocation
- hideInvocation :: ConfiguredProgram -> VerbosityLevel -> Maybe (SymbolicPath CWD ('Dir Pkg)) -> PackageDB -> PackageId -> ProgramInvocation
- dumpInvocation :: ConfiguredProgram -> VerbosityLevel -> Maybe (SymbolicPath CWD ('Dir from)) -> PackageDBX (SymbolicPath from ('Dir PkgDB)) -> ProgramInvocation
- describeInvocation :: ConfiguredProgram -> VerbosityLevel -> Maybe (SymbolicPath CWD ('Dir Pkg)) -> PackageDBStack -> PackageId -> ProgramInvocation
- listInvocation :: ConfiguredProgram -> VerbosityLevel -> Maybe (SymbolicPath CWD ('Dir Pkg)) -> PackageDB -> ProgramInvocation
Types
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
data RegisterOptions Source #
Additional variations in the behaviour for register.
Constructors
| RegisterOptions | |
Fields
| |
defaultRegisterOptions :: RegisterOptions Source #
Defaults are True, False and False
Actions
init :: ConfiguredProgram -> Verbosity -> FilePath -> IO () Source #
Call hc-pkg to initialise a package database at the location {path}.
hc-pkg init {path}invoke :: ConfiguredProgram -> Verbosity -> Maybe (SymbolicPath CWD ('Dir Pkg)) -> PackageDBStack -> [String] -> IO () Source #
Run hc-pkg using a given package DB stack, directly forwarding the
provided command-line arguments to it.
register :: ConfiguredProgram -> Verbosity -> Maybe (SymbolicPath CWD ('Dir from)) -> PackageDBStackS from -> InstalledPackageInfo -> RegisterOptions -> IO () Source #
Call hc-pkg to register a package.
hc-pkg register {filename | -} [--user | --global | --package-db]unregister :: ConfiguredProgram -> Verbosity -> Maybe (SymbolicPath CWD ('Dir Pkg)) -> PackageDB -> PackageId -> IO () Source #
Call hc-pkg to unregister a package
hc-pkg unregister [pkgid] [--user | --global | --package-db]
recache :: ConfiguredProgram -> Verbosity -> Maybe (SymbolicPath CWD ('Dir from)) -> PackageDBS from -> IO () Source #
Call hc-pkg to recache the registered packages.
hc-pkg recache [--user | --global | --package-db]
expose :: ConfiguredProgram -> Verbosity -> Maybe (SymbolicPath CWD ('Dir Pkg)) -> PackageDB -> PackageId -> IO () Source #
Call hc-pkg to expose a package.
hc-pkg expose [pkgid] [--user | --global | --package-db]
hide :: ConfiguredProgram -> Verbosity -> Maybe (SymbolicPath CWD ('Dir Pkg)) -> PackageDB -> PackageId -> IO () Source #
Call hc-pkg to hide a package.
hc-pkg hide [pkgid] [--user | --global | --package-db]
dump :: ConfiguredProgram -> Verbosity -> Maybe (SymbolicPath CWD ('Dir from)) -> PackageDBX (SymbolicPath from ('Dir PkgDB)) -> IO [InstalledPackageInfo] Source #
Call hc-pkg to get all the details of all the packages in the given
package database.
describe :: ConfiguredProgram -> Verbosity -> Maybe (SymbolicPath CWD ('Dir Pkg)) -> PackageDBStack -> PackageId -> IO [InstalledPackageInfo] Source #
Call hc-pkg to retrieve a specific package
hc-pkg describe [pkgid] [--user | --global | --package-db]
list :: ConfiguredProgram -> Verbosity -> Maybe (SymbolicPath CWD ('Dir Pkg)) -> PackageDB -> IO [PackageId] Source #
Program invocations
initInvocation :: ConfiguredProgram -> Verbosity -> FilePath -> ProgramInvocation Source #
registerInvocation :: ConfiguredProgram -> VerbosityLevel -> Maybe (SymbolicPath CWD ('Dir from)) -> PackageDBStackS from -> InstalledPackageInfo -> RegisterOptions -> ProgramInvocation Source #
unregisterInvocation :: ConfiguredProgram -> VerbosityLevel -> Maybe (SymbolicPath CWD ('Dir Pkg)) -> PackageDB -> PackageId -> ProgramInvocation Source #
recacheInvocation :: ConfiguredProgram -> VerbosityLevel -> Maybe (SymbolicPath CWD ('Dir from)) -> PackageDBS from -> ProgramInvocation Source #
exposeInvocation :: ConfiguredProgram -> VerbosityLevel -> Maybe (SymbolicPath CWD ('Dir Pkg)) -> PackageDB -> PackageId -> ProgramInvocation Source #
hideInvocation :: ConfiguredProgram -> VerbosityLevel -> Maybe (SymbolicPath CWD ('Dir Pkg)) -> PackageDB -> PackageId -> ProgramInvocation Source #
dumpInvocation :: ConfiguredProgram -> VerbosityLevel -> Maybe (SymbolicPath CWD ('Dir from)) -> PackageDBX (SymbolicPath from ('Dir PkgDB)) -> ProgramInvocation Source #
describeInvocation :: ConfiguredProgram -> VerbosityLevel -> Maybe (SymbolicPath CWD ('Dir Pkg)) -> PackageDBStack -> PackageId -> ProgramInvocation Source #
listInvocation :: ConfiguredProgram -> VerbosityLevel -> Maybe (SymbolicPath CWD ('Dir Pkg)) -> PackageDB -> ProgramInvocation Source #