Copyright | Isaac Jones 2003-2004 |
---|---|
License | BSD3 |
Maintainer | cabal-devel@haskell.org |
Portability | portable |
Safe Haskell | Safe |
Language | Haskell98 |
Distribution.Package
Contents
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"
.
- newtype PackageName = PackageName {}
- data PackageIdentifier = PackageIdentifier {}
- type PackageId = PackageIdentifier
- data ComponentId = ComponentId String
- getHSLibraryName :: ComponentId -> String
- type InstalledPackageId = ComponentId
- data Dependency = Dependency PackageName VersionRange
- thisPackageVersion :: PackageIdentifier -> Dependency
- notThisPackageVersion :: PackageIdentifier -> Dependency
- simplifyDependency :: Dependency -> Dependency
- class Package pkg where
- packageName :: Package pkg => pkg -> PackageName
- packageVersion :: Package pkg => pkg -> Version
- class Package pkg => HasComponentId pkg where
- class HasComponentId pkg => PackageInstalled pkg where
Package ids
newtype PackageName
Constructors
PackageName | |
Fields |
Instances
Eq PackageName | |
Data PackageName | |
Ord PackageName | |
Read PackageName | |
Show PackageName | |
Generic PackageName | |
Binary PackageName | |
NFData PackageName | |
Text PackageName | |
type Rep PackageName = D1 (MetaData "PackageName" "Distribution.Package" "Cabal-1.23.0.0" True) (C1 (MetaCons "PackageName" PrefixI True) (S1 (MetaSel (Just Symbol "unPackageName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String))) |
data PackageIdentifier
The name and version of a package.
Constructors
PackageIdentifier | |
Fields
|
Instances
Eq PackageIdentifier | |
Data PackageIdentifier | |
Ord PackageIdentifier | |
Read PackageIdentifier | |
Show PackageIdentifier | |
Generic PackageIdentifier | |
Binary PackageIdentifier | |
NFData PackageIdentifier | |
Text PackageIdentifier | |
Package PackageIdentifier | |
type Rep PackageIdentifier = D1 (MetaData "PackageIdentifier" "Distribution.Package" "Cabal-1.23.0.0" False) (C1 (MetaCons "PackageIdentifier" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "pkgName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 PackageName)) (S1 (MetaSel (Just Symbol "pkgVersion") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Version)))) |
type PackageId = PackageIdentifier
Type alias so we can use the shorter name PackageId.
Package keys/installed package IDs (used for linker symbols)
data ComponentId
A ComponentId
uniquely identifies the transitive source
code closure of a component. For non-Backpack components, it also
serves as the basis for install paths, symbols, etc.
Constructors
ComponentId String |
Instances
Eq ComponentId | |
Data ComponentId | |
Ord ComponentId | |
Read ComponentId | |
Show ComponentId | |
Generic ComponentId | |
Binary ComponentId | |
NFData ComponentId | |
Text ComponentId | |
type Rep ComponentId = D1 (MetaData "ComponentId" "Distribution.Package" "Cabal-1.23.0.0" False) (C1 (MetaCons "ComponentId" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String))) |
getHSLibraryName :: ComponentId -> String
Returns library name prefixed with HS, suitable for filenames
type InstalledPackageId = ComponentId
Package source dependencies
data Dependency
Describes a dependency on a source package (API)
Constructors
Dependency PackageName VersionRange |
Instances
Eq Dependency | |
Data Dependency | |
Read Dependency | |
Show Dependency | |
Generic Dependency | |
Binary Dependency | |
Text Dependency | |
type Rep Dependency = D1 (MetaData "Dependency" "Distribution.Package" "Cabal-1.23.0.0" False) (C1 (MetaCons "Dependency" PrefixI False) ((:*:) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 PackageName)) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 VersionRange)))) |
simplifyDependency :: Dependency -> Dependency
Simplify the VersionRange
expression in a Dependency
.
See simplifyVersionRange
.
Package classes
class Package pkg where
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.
Minimal complete definition
Methods
packageId :: pkg -> PackageIdentifier
packageName :: Package pkg => pkg -> PackageName
packageVersion :: Package pkg => pkg -> Version
class Package pkg => HasComponentId pkg where
Packages that have an installed package ID
Minimal complete definition
Methods
installedComponentId :: pkg -> ComponentId
Instances
class HasComponentId pkg => PackageInstalled pkg where
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
.
Minimal complete definition
Methods
installedDepends :: pkg -> [ComponentId]
Instances