Copyright	Isaac Jones 2003-2004
License	BSD3
Maintainer	cabal-devel@haskell.org
Portability	portable
Safe Haskell	None
Language	Haskell2010

Distribution.Package

Description

Defines a package identifier along with a parser and pretty printer for it. PackageIdentifier s consist of a name and an exact version. It also defines a Dependency data type. A dependency is a package name and a version range, like "foo >= 1.2 && < 2" .

Synopsis

module Distribution.Types.AbiHash
module Distribution.Types.ComponentId
module Distribution.Types.PackageId
module Distribution.Types.UnitId
module Distribution.Types.Module
module Distribution.Types.PackageName
module Distribution.Types.PkgconfigName
module Distribution.Types.Dependency
class Package pkg where
- packageId :: pkg -> PackageIdentifier
packageName :: Package pkg => pkg -> PackageName
packageVersion :: Package pkg => pkg -> Version
class HasMungedPackageId pkg where
- mungedId :: pkg -> MungedPackageId
mungedName' :: HasMungedPackageId pkg => pkg -> MungedPackageName
mungedVersion' :: HasMungedPackageId munged => munged -> Version
class Package pkg => HasUnitId pkg where
- installedUnitId :: pkg -> UnitId
class HasUnitId pkg => PackageInstalled pkg where
- installedDepends :: pkg -> [ UnitId ]

Documentation

module Distribution.Types.AbiHash

module Distribution.Types.ComponentId

module Distribution.Types.PackageId

module Distribution.Types.UnitId

module Distribution.Types.Module

module Distribution.Types.PackageName

module Distribution.Types.PkgconfigName

module Distribution.Types.Dependency

class Package pkg where Source #

Class of things that have a PackageIdentifier

Types in this class are all notions of a package. This allows us to have different types for the different phases that packages go though, from simple name/id, package description, configured or installed packages.

Not all kinds of packages can be uniquely identified by a PackageIdentifier . In particular, installed packages cannot, there may be many installed instances of the same source package.

Methods

packageId :: pkg -> PackageIdentifier Source #

Instances

Instances details

Package PackageIdentifier Source #
Instance details Defined in Distribution.Package Methods packageId :: PackageIdentifier -> PackageIdentifier Source #
Package InstalledPackageInfo Source #
Instance details Defined in Distribution.Types.InstalledPackageInfo Methods packageId :: InstalledPackageInfo -> PackageIdentifier Source #
Package PackageDescription Source #
Instance details Defined in Distribution.Types.PackageDescription Methods packageId :: PackageDescription -> PackageIdentifier Source #
Package GenericPackageDescription Source #
Instance details Defined in Distribution.Types.GenericPackageDescription Methods packageId :: GenericPackageDescription -> PackageIdentifier Source #
Package LinkedComponent Source #
Instance details Defined in Distribution.Backpack.LinkedComponent Methods packageId :: LinkedComponent -> PackageIdentifier Source #
Package ( AnnotatedId id) Source #
Instance details Defined in Distribution.Types.AnnotatedId Methods packageId :: AnnotatedId id -> PackageIdentifier Source #

packageName :: Package pkg => pkg -> PackageName Source #

packageVersion :: Package pkg => pkg -> Version Source #

class HasMungedPackageId pkg where Source #

Methods

mungedId :: pkg -> MungedPackageId Source #

Instances

Instances details

HasMungedPackageId MungedPackageId Source #
Instance details Defined in Distribution.Package Methods mungedId :: MungedPackageId -> MungedPackageId Source #
HasMungedPackageId InstalledPackageInfo Source #
Instance details Defined in Distribution.Types.InstalledPackageInfo Methods mungedId :: InstalledPackageInfo -> MungedPackageId Source #

mungedName' :: HasMungedPackageId pkg => pkg -> MungedPackageName Source #

mungedVersion' :: HasMungedPackageId munged => munged -> Version Source #

class Package pkg => HasUnitId pkg where Source #

Packages that have an installed unit ID

Methods

installedUnitId :: pkg -> UnitId Source #

Instances

Instances details

HasUnitId InstalledPackageInfo Source #
Instance details Defined in Distribution.Types.InstalledPackageInfo Methods installedUnitId :: InstalledPackageInfo -> UnitId Source #

class HasUnitId pkg => PackageInstalled pkg where Source #

Class of installed packages.

The primary data type which is an instance of this package is InstalledPackageInfo , but when we are doing install plans in Cabal install we may have other, installed package-like things which contain more metadata. Installed packages have exact dependencies installedDepends .

Methods

installedDepends :: pkg -> [ UnitId ] Source #

Instances

Instances details

PackageInstalled InstalledPackageInfo Source #
Instance details Defined in Distribution.Types.InstalledPackageInfo Methods installedDepends :: InstalledPackageInfo -> [ UnitId ] Source #