Copyright	Duncan Coutts 2009, 2013
Maintainer	cabal-devel@haskell.org
Portability	portable
Safe Haskell	None
Language	Haskell98

Distribution.Simple.Program.HcPkg

Contents

Program invocations

Description

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

Synopsis

Documentation

data HcPkgInfo Source #

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

Constructors

HcPkgInfo

Fields

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

init :: HcPkgInfo -> Verbosity -> Bool -> FilePath -> IO () Source #

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

hc-pkg init {path}

invoke :: HcPkgInfo -> Verbosity -> PackageDBStack -> [String] -> IO () Source #

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

register :: HcPkgInfo -> Verbosity -> PackageDBStack -> Either FilePath InstalledPackageInfo -> IO () Source #

Call hc-pkg to register a package.

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

reregister :: HcPkgInfo -> Verbosity -> PackageDBStack -> Either FilePath InstalledPackageInfo -> IO () Source #

Call hc-pkg to re-register a package.

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

registerMultiInstance :: HcPkgInfo -> Verbosity -> PackageDBStack -> InstalledPackageInfo -> IO () Source #

unregister :: HcPkgInfo -> Verbosity -> PackageDB -> PackageId -> IO () Source #

Call hc-pkg to unregister a package

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

recache :: HcPkgInfo -> Verbosity -> PackageDB -> IO () Source #

Call hc-pkg to recache the registered packages.

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

expose :: HcPkgInfo -> Verbosity -> PackageDB -> PackageId -> IO () Source #

Call hc-pkg to expose a package.

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

hide :: HcPkgInfo -> Verbosity -> PackageDB -> PackageId -> IO () Source #

Call hc-pkg to hide a package.

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

dump :: HcPkgInfo -> Verbosity -> PackageDB -> IO [InstalledPackageInfo] Source #

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

describe :: HcPkgInfo -> Verbosity -> PackageDBStack -> PackageId -> IO [InstalledPackageInfo] Source #

Call hc-pkg to retrieve a specific package

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

list :: HcPkgInfo -> Verbosity -> PackageDB -> IO [PackageId] Source #

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.

Program invocations

initInvocation :: HcPkgInfo -> Verbosity -> FilePath -> ProgramInvocation Source #

registerInvocation :: HcPkgInfo -> Verbosity -> PackageDBStack -> Either FilePath InstalledPackageInfo -> ProgramInvocation Source #

reregisterInvocation :: HcPkgInfo -> Verbosity -> PackageDBStack -> Either FilePath InstalledPackageInfo -> ProgramInvocation Source #

registerMultiInstanceInvocation :: HcPkgInfo -> Verbosity -> PackageDBStack -> Either FilePath InstalledPackageInfo -> ProgramInvocation Source #

unregisterInvocation :: HcPkgInfo -> Verbosity -> PackageDB -> PackageId -> ProgramInvocation Source #

recacheInvocation :: HcPkgInfo -> Verbosity -> PackageDB -> ProgramInvocation Source #

exposeInvocation :: HcPkgInfo -> Verbosity -> PackageDB -> PackageId -> ProgramInvocation Source #

hideInvocation :: HcPkgInfo -> Verbosity -> PackageDB -> PackageId -> ProgramInvocation Source #

dumpInvocation :: HcPkgInfo -> Verbosity -> PackageDB -> ProgramInvocation Source #

describeInvocation :: HcPkgInfo -> Verbosity -> PackageDBStack -> PackageId -> ProgramInvocation Source #

listInvocation :: HcPkgInfo -> Verbosity -> PackageDB -> ProgramInvocation Source #