ModuleCabal-3.16.0.0Haskell2010

Distribution.Simple.Program.HcPkg

This module provides an library interface to the hc-pkg program. Currently only GHC and GHCJS have hc-pkg programs.

2 types
20 values

PackageCabal-3.16.0.0
Exports22
LanguageHaskell2010
LicenceBSD-3-Clause
SourceHcPkg.hs

Types

3 declarations

datadata HcPkgInfo

Information about the features and capabilities of an hc-pkg program.

Constructors

HcPkgInfo
- hcPkgProgram :: ConfiguredProgram
- noPkgDbStack :: Bool
  no package DB stack supported
- noVerboseFlag :: Bool
  hc-pkg does not support verbosity flags
- flagPackageConf :: Bool
  use package-conf option instead of package-db
- supportsDirDbs :: Bool
  supports directory style package databases
- requiresDirDbs :: Bool
  requires directory style package databases
- nativeMultiInstance :: Bool
  supports --enable-multi-instance flag
- recacheMultiInstance :: Bool
  supports multi-instance via recache
- suppressFilesCheck :: Bool
  supports --force-files or equivalent

datadata RegisterOptions

Additional variations in the behaviour for register.

Constructors

RegisterOptions
- registerAllowOverwrite :: Bool
  Allows re-registering / overwriting an existing package
- registerMultiInstance :: Bool
  Insist on the ability to register multiple instances of a single version of a single package. This will fail if the hc-pkg does not support it, see nativeMultiInstance and recacheMultiInstance.
- registerSuppressFilesCheck :: Bool
  Require that no checks are performed on the existence of package files mentioned in the registration info. This must be used if registering prior to putting the files in their final place. This will fail if the hc-pkg does not support it, see suppressFilesCheck.

valuedefaultRegisterOptions :: RegisterOptions

Defaults are True, False and False

Actions

10 declarations

valueinit :: HcPkgInfo -> Verbosity -> Bool -> FilePath -> IO ()

Call hc-pkg to initialise a package database at the location {path}.

hc-pkg init {path}

valueinvoke

:: HcPkgInfo
-> Verbosity
-> Maybe (SymbolicPath CWD ('Dir Pkg))
-> PackageDBStack
-> [String]
-> IO ()

Run hc-pkg using a given package DB stack, directly forwarding the provided command-line arguments to it.

valueregister

:: HcPkgInfo
-> Verbosity
-> Maybe (SymbolicPath CWD ('Dir from))
-> PackageDBStackS from
-> InstalledPackageInfo
-> RegisterOptions
-> IO ()

Call hc-pkg to register a package.

hc-pkg register {filename | -} [--user | --global | --package-db]

valueunregister

:: HcPkgInfo
-> Verbosity
-> Maybe (SymbolicPath CWD ('Dir Pkg))
-> PackageDB
-> PackageId
-> IO ()

Call hc-pkg to unregister a package

hc-pkg unregister [pkgid] [--user | --global | --package-db]

valuerecache

:: HcPkgInfo
-> Verbosity
-> Maybe (SymbolicPath CWD ('Dir from))
-> PackageDBS from
-> IO ()

Call hc-pkg to recache the registered packages.

hc-pkg recache [--user | --global | --package-db]

valueexpose

:: HcPkgInfo
-> Verbosity
-> Maybe (SymbolicPath CWD ('Dir Pkg))
-> PackageDB
-> PackageId
-> IO ()

Call hc-pkg to expose a package.

hc-pkg expose [pkgid] [--user | --global | --package-db]

valuehide

:: HcPkgInfo
-> Verbosity
-> Maybe (SymbolicPath CWD ('Dir Pkg))
-> PackageDB
-> PackageId
-> IO ()

Call hc-pkg to hide a package.

hc-pkg hide [pkgid] [--user | --global | --package-db]

valuedump

:: HcPkgInfo
-> Verbosity
-> Maybe (SymbolicPath CWD ('Dir from))
-> PackageDBX (SymbolicPath from ('Dir PkgDB))
-> IO [InstalledPackageInfo]

Call hc-pkg to get all the details of all the packages in the given package database.

valuedescribe

:: HcPkgInfo
-> Verbosity
-> Maybe (SymbolicPath CWD ('Dir Pkg))
-> PackageDBStack
-> PackageId
-> IO [InstalledPackageInfo]

Call hc-pkg to retrieve a specific package

hc-pkg describe [pkgid] [--user | --global | --package-db]

valuelist

:: HcPkgInfo
-> Verbosity
-> Maybe (SymbolicPath CWD ('Dir Pkg))
-> PackageDB
-> IO [PackageId]

Call hc-pkg to get the source package Id of all the packages in the given package database.

This is much less information than with dump, but also rather quicker. Note in particular that it does not include the UnitId, just the source PackageId which is not necessarily unique in any package db.