| Copyright | Isaac Jones 2003-2004 |
|---|---|
| License | BSD3 |
| Maintainer | cabal-devel@haskell.org |
| Portability | portable |
| Safe Haskell | None |
| 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
- data ComponentId = ComponentId String
- newtype UnitId = SimpleUnitId ComponentId
- mkUnitId :: String -> UnitId
- mkLegacyUnitId :: PackageId -> UnitId
- getHSLibraryName :: UnitId -> String
- type InstalledPackageId = UnitId
- newtype AbiHash = AbiHash String
- 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 => HasUnitId pkg where
- installedPackageId :: HasUnitId pkg => pkg -> UnitId
- class HasUnitId pkg => PackageInstalled pkg where
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.
Package keys/installed package IDs (used for linker symbols)
data ComponentId Source #
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 |
For now, there is no distinction between component IDs and unit IDs in Cabal.
Constructors
| SimpleUnitId ComponentId |
mkLegacyUnitId :: PackageId -> UnitId Source #
Make an old-style UnitId from a package identifier
getHSLibraryName :: UnitId -> String Source #
Returns library name prefixed with HS, suitable for filenames
type InstalledPackageId = UnitId Source #
Deprecated: Use UnitId instead
ABI hash
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.
Minimal complete definition
Methods
packageId :: pkg -> PackageIdentifier Source #
packageName :: Package pkg => pkg -> PackageName Source #
packageVersion :: Package pkg => pkg -> Version Source #
class Package pkg => HasUnitId pkg where Source #
Packages that have an installed package ID
Minimal complete definition
Methods
installedUnitId :: pkg -> UnitId Source #
Instances
installedPackageId :: HasUnitId pkg => pkg -> UnitId Source #
Deprecated: Use installedUnitId instead
Compatibility wrapper for Cabal pre-1.24.
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.
Minimal complete definition
Methods
installedDepends :: pkg -> [UnitId] Source #
Instances