<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Distribution.Package</title><link href="ocean.css" rel="stylesheet" type="text/css" title="Ocean" /><script src="haddock-util.js" type="text/javascript"></script><script type="text/javascript">//<![CDATA[
window.onload = function () {pageLoad();setSynopsis("mini_Distribution-Package.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="index.html">Contents</a></li><li><a href="doc-index.html">Index</a></li></ul><p class="caption">Cabal-1.14.0: A framework for packaging Haskell software</p></div><div id="content"><div id="module-header"><table class="info"><tr><th>Portability</th><td>portable</td></tr><tr><th>Maintainer</th><td>cabal-devel@haskell.org</td></tr><tr><th>Safe Haskell</th><td>Safe-Infered</td></tr></table><p class="caption">Distribution.Package</p></div><div id="table-of-contents"><p class="caption">Contents</p><ul><li><a href="#g:1">Package ids
</a></li><li><a href="#g:2">Installed package identifiers
</a></li><li><a href="#g:3">Package source dependencies
</a></li><li><a href="#g:4">Package classes
</a></li></ul></div><div id="description"><p class="caption">Description</p><div class="doc"><p>Defines a package identifier along with a parser and pretty printer for it.
<code><a href="Distribution-Package.html#t:PackageIdentifier">PackageIdentifier</a></code>s consist of a name and an exact version. It also defines
a <code><a href="Distribution-Package.html#t:Dependency">Dependency</a></code> data type. A dependency is a package name and a version
range, like <code>"foo >= 1.2 && < 2"</code>.
</p></div></div><div id="synopsis"><p id="control.syn" class="caption expander" onclick="toggleSection('syn')">Synopsis</p><ul id="section.syn" class="hide" onclick="toggleSection('syn')"><li class="src short"><span class="keyword">newtype</span> <a href="#t:PackageName">PackageName</a> = <a href="#v:PackageName">PackageName</a> <a href="../base-4.5.1.0/Data-String.html#t:String">String</a></li><li class="src short"><span class="keyword">data</span> <a href="#t:PackageIdentifier">PackageIdentifier</a> = <a href="#v:PackageIdentifier">PackageIdentifier</a> {<ul class="subs"><li><a href="#v:pkgName">pkgName</a> :: <a href="Distribution-Package.html#t:PackageName">PackageName</a></li><li><a href="#v:pkgVersion">pkgVersion</a> :: <a href="Distribution-Version.html#t:Version">Version</a></li></ul>}</li><li class="src short"><span class="keyword">type</span> <a href="#t:PackageId">PackageId</a> = <a href="Distribution-Package.html#t:PackageIdentifier">PackageIdentifier</a></li><li class="src short"><span class="keyword">newtype</span> <a href="#t:InstalledPackageId">InstalledPackageId</a> = <a href="#v:InstalledPackageId">InstalledPackageId</a> <a href="../base-4.5.1.0/Data-String.html#t:String">String</a></li><li class="src short"><span class="keyword">data</span> <a href="#t:Dependency">Dependency</a> = <a href="#v:Dependency">Dependency</a> <a href="Distribution-Package.html#t:PackageName">PackageName</a> <a href="Distribution-Version.html#t:VersionRange">VersionRange</a></li><li class="src short"><a href="#v:thisPackageVersion">thisPackageVersion</a> :: <a href="Distribution-Package.html#t:PackageIdentifier">PackageIdentifier</a> -> <a href="Distribution-Package.html#t:Dependency">Dependency</a></li><li class="src short"><a href="#v:notThisPackageVersion">notThisPackageVersion</a> :: <a href="Distribution-Package.html#t:PackageIdentifier">PackageIdentifier</a> -> <a href="Distribution-Package.html#t:Dependency">Dependency</a></li><li class="src short"><a href="#v:simplifyDependency">simplifyDependency</a> :: <a href="Distribution-Package.html#t:Dependency">Dependency</a> -> <a href="Distribution-Package.html#t:Dependency">Dependency</a></li><li class="src short"><span class="keyword">class</span> <a href="#t:Package">Package</a> pkg <span class="keyword">where</span><ul class="subs"><li><a href="#v:packageId">packageId</a> :: pkg -> <a href="Distribution-Package.html#t:PackageIdentifier">PackageIdentifier</a></li></ul></li><li class="src short"><a href="#v:packageName">packageName</a> :: <a href="Distribution-Package.html#t:Package">Package</a> pkg => pkg -> <a href="Distribution-Package.html#t:PackageName">PackageName</a></li><li class="src short"><a href="#v:packageVersion">packageVersion</a> :: <a href="Distribution-Package.html#t:Package">Package</a> pkg => pkg -> <a href="Distribution-Version.html#t:Version">Version</a></li><li class="src short"><span class="keyword">class</span> <a href="Distribution-Package.html#t:Package">Package</a> pkg => <a href="#t:PackageFixedDeps">PackageFixedDeps</a> pkg <span class="keyword">where</span><ul class="subs"><li><a href="#v:depends">depends</a> :: pkg -> [<a href="Distribution-Package.html#t:PackageIdentifier">PackageIdentifier</a>]</li></ul></li></ul></div><div id="interface"><h1 id="g:1">Package ids
</h1><div class="top"><p class="src"><span class="keyword">newtype</span> <a name="t:PackageName" class="def">PackageName</a> </p><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:PackageName" class="def">PackageName</a> <a href="../base-4.5.1.0/Data-String.html#t:String">String</a></td><td class="doc empty"> </td></tr></table></div><div class="subs instances"><p id="control.i:PackageName" class="caption collapser" onclick="toggleSection('i:PackageName')">Instances</p><div id="section.i:PackageName" class="show"><table><tr><td class="src"><a href="../base-4.5.1.0/Data-Eq.html#t:Eq">Eq</a> <a href="Distribution-Package.html#t:PackageName">PackageName</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="../base-4.5.1.0/Data-Ord.html#t:Ord">Ord</a> <a href="Distribution-Package.html#t:PackageName">PackageName</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="../base-4.5.1.0/Text-Read.html#t:Read">Read</a> <a href="Distribution-Package.html#t:PackageName">PackageName</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="../base-4.5.1.0/Text-Show.html#t:Show">Show</a> <a href="Distribution-Package.html#t:PackageName">PackageName</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Distribution-Text.html#t:Text">Text</a> <a href="Distribution-Package.html#t:PackageName">PackageName</a></td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:PackageIdentifier" class="def">PackageIdentifier</a> </p><div class="doc"><p>The name and version of a package.
</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:PackageIdentifier" class="def">PackageIdentifier</a></td><td class="doc empty"> </td></tr><tr><td colspan="2"><div class="subs fields"><p class="caption">Fields</p><dl><dt class="src"><a name="v:pkgName" class="def">pkgName</a> :: <a href="Distribution-Package.html#t:PackageName">PackageName</a></dt><dd class="doc"><p>The name of this package, eg. foo
</p></dd><dt class="src"><a name="v:pkgVersion" class="def">pkgVersion</a> :: <a href="Distribution-Version.html#t:Version">Version</a></dt><dd class="doc"><p>the version of this package, eg 1.2
</p></dd></dl><div class="clear"></div></div></td></tr></table></div><div class="subs instances"><p id="control.i:PackageIdentifier" class="caption collapser" onclick="toggleSection('i:PackageIdentifier')">Instances</p><div id="section.i:PackageIdentifier" class="show"><table><tr><td class="src"><a href="../base-4.5.1.0/Data-Eq.html#t:Eq">Eq</a> <a href="Distribution-Package.html#t:PackageIdentifier">PackageIdentifier</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="../base-4.5.1.0/Data-Ord.html#t:Ord">Ord</a> <a href="Distribution-Package.html#t:PackageIdentifier">PackageIdentifier</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="../base-4.5.1.0/Text-Read.html#t:Read">Read</a> <a href="Distribution-Package.html#t:PackageIdentifier">PackageIdentifier</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="../base-4.5.1.0/Text-Show.html#t:Show">Show</a> <a href="Distribution-Package.html#t:PackageIdentifier">PackageIdentifier</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Distribution-Text.html#t:Text">Text</a> <a href="Distribution-Package.html#t:PackageIdentifier">PackageIdentifier</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Distribution-Package.html#t:Package">Package</a> <a href="Distribution-Package.html#t:PackageIdentifier">PackageIdentifier</a></td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><span class="keyword">type</span> <a name="t:PackageId" class="def">PackageId</a> = <a href="Distribution-Package.html#t:PackageIdentifier">PackageIdentifier</a></p><div class="doc"><p>Type alias so we can use the shorter name PackageId.
</p></div></div><h1 id="g:2">Installed package identifiers
</h1><div class="top"><p class="src"><span class="keyword">newtype</span> <a name="t:InstalledPackageId" class="def">InstalledPackageId</a> </p><div class="doc"><p>An InstalledPackageId uniquely identifies an instance of an installed package.
There can be at most one package with a given <code><a href="Distribution-Package.html#t:InstalledPackageId">InstalledPackageId</a></code>
in a package database, or overlay of databases.
</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:InstalledPackageId" class="def">InstalledPackageId</a> <a href="../base-4.5.1.0/Data-String.html#t:String">String</a></td><td class="doc empty"> </td></tr></table></div><div class="subs instances"><p id="control.i:InstalledPackageId" class="caption collapser" onclick="toggleSection('i:InstalledPackageId')">Instances</p><div id="section.i:InstalledPackageId" class="show"><table><tr><td class="src"><a href="../base-4.5.1.0/Data-Eq.html#t:Eq">Eq</a> <a href="Distribution-Package.html#t:InstalledPackageId">InstalledPackageId</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="../base-4.5.1.0/Data-Ord.html#t:Ord">Ord</a> <a href="Distribution-Package.html#t:InstalledPackageId">InstalledPackageId</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="../base-4.5.1.0/Text-Read.html#t:Read">Read</a> <a href="Distribution-Package.html#t:InstalledPackageId">InstalledPackageId</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="../base-4.5.1.0/Text-Show.html#t:Show">Show</a> <a href="Distribution-Package.html#t:InstalledPackageId">InstalledPackageId</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Distribution-Text.html#t:Text">Text</a> <a href="Distribution-Package.html#t:InstalledPackageId">InstalledPackageId</a></td><td class="doc empty"> </td></tr></table></div></div></div><h1 id="g:3">Package source dependencies
</h1><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:Dependency" class="def">Dependency</a> </p><div class="doc"><p>Describes a dependency on a source package (API)
</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:Dependency" class="def">Dependency</a> <a href="Distribution-Package.html#t:PackageName">PackageName</a> <a href="Distribution-Version.html#t:VersionRange">VersionRange</a></td><td class="doc empty"> </td></tr></table></div><div class="subs instances"><p id="control.i:Dependency" class="caption collapser" onclick="toggleSection('i:Dependency')">Instances</p><div id="section.i:Dependency" class="show"><table><tr><td class="src"><a href="../base-4.5.1.0/Data-Eq.html#t:Eq">Eq</a> <a href="Distribution-Package.html#t:Dependency">Dependency</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="../base-4.5.1.0/Text-Read.html#t:Read">Read</a> <a href="Distribution-Package.html#t:Dependency">Dependency</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="../base-4.5.1.0/Text-Show.html#t:Show">Show</a> <a href="Distribution-Package.html#t:Dependency">Dependency</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Distribution-Text.html#t:Text">Text</a> <a href="Distribution-Package.html#t:Dependency">Dependency</a></td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><a name="v:thisPackageVersion" class="def">thisPackageVersion</a> :: <a href="Distribution-Package.html#t:PackageIdentifier">PackageIdentifier</a> -> <a href="Distribution-Package.html#t:Dependency">Dependency</a></p></div><div class="top"><p class="src"><a name="v:notThisPackageVersion" class="def">notThisPackageVersion</a> :: <a href="Distribution-Package.html#t:PackageIdentifier">PackageIdentifier</a> -> <a href="Distribution-Package.html#t:Dependency">Dependency</a></p></div><div class="top"><p class="src"><a name="v:simplifyDependency" class="def">simplifyDependency</a> :: <a href="Distribution-Package.html#t:Dependency">Dependency</a> -> <a href="Distribution-Package.html#t:Dependency">Dependency</a></p><div class="doc"><p>Simplify the <code><a href="Distribution-Version.html#t:VersionRange">VersionRange</a></code> expression in a <code><a href="Distribution-Package.html#t:Dependency">Dependency</a></code>.
See <code><a href="Distribution-Version.html#v:simplifyVersionRange">simplifyVersionRange</a></code>.
</p></div></div><h1 id="g:4">Package classes
</h1><div class="top"><p class="src"><span class="keyword">class</span> <a name="t:Package" class="def">Package</a> pkg <span class="keyword">where</span></p><div class="doc"><p>Class of things that have a <code><a href="Distribution-Package.html#t:PackageIdentifier">PackageIdentifier</a></code>
</p><p>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.
</p><p>Not all kinds of packages can be uniquely identified by a
<code><a href="Distribution-Package.html#t:PackageIdentifier">PackageIdentifier</a></code>. In particular, installed packages cannot, there may be
many installed instances of the same source package.
</p></div><div class="subs methods"><p class="caption">Methods</p><p class="src"><a name="v:packageId" class="def">packageId</a> :: pkg -> <a href="Distribution-Package.html#t:PackageIdentifier">PackageIdentifier</a></p></div><div class="subs instances"><p id="control.i:Package" class="caption collapser" onclick="toggleSection('i:Package')">Instances</p><div id="section.i:Package" class="show"><table><tr><td class="src"><a href="Distribution-Package.html#t:Package">Package</a> <a href="Distribution-Package.html#t:PackageIdentifier">PackageIdentifier</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Distribution-Package.html#t:Package">Package</a> <a href="Distribution-PackageDescription.html#t:GenericPackageDescription">GenericPackageDescription</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Distribution-Package.html#t:Package">Package</a> <a href="Distribution-PackageDescription.html#t:PackageDescription">PackageDescription</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Distribution-Package.html#t:Package">Package</a> (<a href="Distribution-InstalledPackageInfo.html#t:InstalledPackageInfo_">InstalledPackageInfo_</a> str)</td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><a name="v:packageName" class="def">packageName</a> :: <a href="Distribution-Package.html#t:Package">Package</a> pkg => pkg -> <a href="Distribution-Package.html#t:PackageName">PackageName</a></p></div><div class="top"><p class="src"><a name="v:packageVersion" class="def">packageVersion</a> :: <a href="Distribution-Package.html#t:Package">Package</a> pkg => pkg -> <a href="Distribution-Version.html#t:Version">Version</a></p></div><div class="top"><p class="src"><span class="keyword">class</span> <a href="Distribution-Package.html#t:Package">Package</a> pkg => <a name="t:PackageFixedDeps" class="def">PackageFixedDeps</a> pkg <span class="keyword">where</span></p><div class="doc"><p>Subclass of packages that have specific versioned dependencies.
</p><p>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.
</p></div><div class="subs methods"><p class="caption">Methods</p><p class="src"><a name="v:depends" class="def">depends</a> :: pkg -> [<a href="Distribution-Package.html#t:PackageIdentifier">PackageIdentifier</a>]</p></div></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.11.0</p></div></body></html>
distrib
>
Mageia
>
5
>
i586
>
media
>
core-release
>
by-pkgid
>
6e204a966e8c42d976f99a1700ce5f20
>
files
>
2022
