| 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.
PackageIdentifiers 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
- newtype InstalledPackageId = InstalledPackageId String
- data PackageKey
- mkPackageKey :: Bool -> PackageId -> [PackageKey] -> [(ModuleName, (PackageKey, ModuleName))] -> PackageKey
- data Dependency = Dependency PackageName VersionRange
- thisPackageVersion :: PackageIdentifier -> Dependency
- notThisPackageVersion :: PackageIdentifier -> Dependency
- simplifyDependency :: Dependency -> Dependency
- class Package pkg where
- packageId :: pkg -> PackageIdentifier
- packageName :: Package pkg => pkg -> PackageName
- packageVersion :: Package pkg => pkg -> Version
- class Package pkg => PackageFixedDeps pkg where
- depends :: pkg -> [PackageIdentifier]
- class Package pkg => PackageInstalled pkg where
- installedPackageId :: pkg -> InstalledPackageId
- installedDepends :: pkg -> [InstalledPackageId]
Package ids
newtype PackageName Source
Constructors
| PackageName | |
Fields | |
data PackageIdentifier Source
The name and version of a package.
Constructors
| PackageIdentifier | |
Fields
| |
Instances
type PackageId = PackageIdentifier Source
Type alias so we can use the shorter name PackageId.
Installed package identifiers
newtype InstalledPackageId Source
An InstalledPackageId uniquely identifies an instance of an installed
package. There can be at most one package with a given InstalledPackageId
in a package database, or overlay of databases.
Constructors
| InstalledPackageId String |
Package keys (used for linker symbols)
data PackageKey Source
A PackageKey is the notion of "package ID" which is visible to the
compiler. Why is this not a PackageId? The PackageId is a user-visible
concept written explicity in Cabal files; on the other hand, a PackageKey
may contain, for example, information about the transitive dependency
tree of a package. Why is this not an InstalledPackageId? A PackageKey
affects the ABI because it is used for linker symbols; however, an
InstalledPackageId can be used to distinguish two ABI-compatible versions
of a library.
Constructors
| PackageKey !String !Word64 !Word64 | Modern package key which is a hash of the PackageId and the transitive dependency key. Manually inline it here so we can get the instances we need. Also contains a short informative string |
| OldPackageKey !PackageId | Old-style package key which is just a |
mkPackageKey :: Bool -> PackageId -> [PackageKey] -> [(ModuleName, (PackageKey, ModuleName))] -> PackageKey Source
Generates a PackageKey from a PackageId, sorted package keys of the
immediate dependencies.
Package source dependencies
data Dependency Source
Describes a dependency on a source package (API)
Constructors
| Dependency PackageName VersionRange |
Instances
simplifyDependency :: Dependency -> Dependency Source
Simplify the VersionRange expression in a Dependency.
See simplifyVersionRange.
Package classes
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
packageName :: Package pkg => pkg -> PackageName Source
packageVersion :: Package pkg => pkg -> Version Source
class Package pkg => PackageFixedDeps pkg where Source
Subclass of packages that have specific versioned dependencies.
So for example a not-yet-configured package has dependencies on version ranges, not specific versions. A configured or an already installed package depends on exact versions. Some operations or data structures (like dependency graphs) only make sense on this subclass of package types.
Methods
depends :: pkg -> [PackageIdentifier] Source
class Package 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
installedPackageId :: pkg -> InstalledPackageId Source
installedDepends :: pkg -> [InstalledPackageId] Source
Instances