<!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.Version</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-Version.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.Version</p></div><div id="table-of-contents"><p class="caption">Contents</p><ul><li><a href="#g:1">Package versions
</a></li><li><a href="#g:2">Version ranges
</a><ul><li><a href="#g:3">Constructing
</a></li><li><a href="#g:4">Inspection
</a></li></ul></li><li><a href="#g:5">Version intervals view
</a><ul><li><a href="#g:6"><code><a href="Distribution-Version.html#t:VersionIntervals">VersionIntervals</a></code> abstract type
</a></li></ul></li></ul></div><div id="description"><p class="caption">Description</p><div class="doc"><p>Exports the <code><a href="Distribution-Version.html#t:Version">Version</a></code> type along with a parser and pretty printer. A version
is something like <code>"1.3.3"</code>. It also defines the <code><a href="Distribution-Version.html#t:VersionRange">VersionRange</a></code> data
types. Version ranges are like <code>">= 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">data</span> <a href="#t:Version">Version</a> = <a href="#v:Version">Version</a> {<ul class="subs"><li><a href="#v:versionBranch">versionBranch</a> :: [<a href="../base-4.5.1.0/Data-Int.html#t:Int">Int</a>]</li><li><a href="#v:versionTags">versionTags</a> :: [<a href="../base-4.5.1.0/Data-String.html#t:String">String</a>]</li></ul>}</li><li class="src short"><span class="keyword">data</span> <a href="#t:VersionRange">VersionRange</a> <ul class="subs"><li>= <a href="#v:AnyVersion">AnyVersion</a> </li><li>| <a href="#v:ThisVersion">ThisVersion</a> <a href="Distribution-Version.html#t:Version">Version</a> </li><li>| <a href="#v:LaterVersion">LaterVersion</a> <a href="Distribution-Version.html#t:Version">Version</a> </li><li>| <a href="#v:EarlierVersion">EarlierVersion</a> <a href="Distribution-Version.html#t:Version">Version</a> </li><li>| <a href="#v:WildcardVersion">WildcardVersion</a> <a href="Distribution-Version.html#t:Version">Version</a> </li><li>| <a href="#v:UnionVersionRanges">UnionVersionRanges</a> <a href="Distribution-Version.html#t:VersionRange">VersionRange</a> <a href="Distribution-Version.html#t:VersionRange">VersionRange</a> </li><li>| <a href="#v:IntersectVersionRanges">IntersectVersionRanges</a> <a href="Distribution-Version.html#t:VersionRange">VersionRange</a> <a href="Distribution-Version.html#t:VersionRange">VersionRange</a> </li><li>| <a href="#v:VersionRangeParens">VersionRangeParens</a> <a href="Distribution-Version.html#t:VersionRange">VersionRange</a> </li></ul></li><li class="src short"><a href="#v:anyVersion">anyVersion</a> :: <a href="Distribution-Version.html#t:VersionRange">VersionRange</a></li><li class="src short"><a href="#v:noVersion">noVersion</a> :: <a href="Distribution-Version.html#t:VersionRange">VersionRange</a></li><li class="src short"><a href="#v:thisVersion">thisVersion</a> :: <a href="Distribution-Version.html#t:Version">Version</a> -> <a href="Distribution-Version.html#t:VersionRange">VersionRange</a></li><li class="src short"><a href="#v:notThisVersion">notThisVersion</a> :: <a href="Distribution-Version.html#t:Version">Version</a> -> <a href="Distribution-Version.html#t:VersionRange">VersionRange</a></li><li class="src short"><a href="#v:laterVersion">laterVersion</a> :: <a href="Distribution-Version.html#t:Version">Version</a> -> <a href="Distribution-Version.html#t:VersionRange">VersionRange</a></li><li class="src short"><a href="#v:earlierVersion">earlierVersion</a> :: <a href="Distribution-Version.html#t:Version">Version</a> -> <a href="Distribution-Version.html#t:VersionRange">VersionRange</a></li><li class="src short"><a href="#v:orLaterVersion">orLaterVersion</a> :: <a href="Distribution-Version.html#t:Version">Version</a> -> <a href="Distribution-Version.html#t:VersionRange">VersionRange</a></li><li class="src short"><a href="#v:orEarlierVersion">orEarlierVersion</a> :: <a href="Distribution-Version.html#t:Version">Version</a> -> <a href="Distribution-Version.html#t:VersionRange">VersionRange</a></li><li class="src short"><a href="#v:unionVersionRanges">unionVersionRanges</a> :: <a href="Distribution-Version.html#t:VersionRange">VersionRange</a> -> <a href="Distribution-Version.html#t:VersionRange">VersionRange</a> -> <a href="Distribution-Version.html#t:VersionRange">VersionRange</a></li><li class="src short"><a href="#v:intersectVersionRanges">intersectVersionRanges</a> :: <a href="Distribution-Version.html#t:VersionRange">VersionRange</a> -> <a href="Distribution-Version.html#t:VersionRange">VersionRange</a> -> <a href="Distribution-Version.html#t:VersionRange">VersionRange</a></li><li class="src short"><a href="#v:withinVersion">withinVersion</a> :: <a href="Distribution-Version.html#t:Version">Version</a> -> <a href="Distribution-Version.html#t:VersionRange">VersionRange</a></li><li class="src short"><a href="#v:betweenVersionsInclusive">betweenVersionsInclusive</a> :: <a href="Distribution-Version.html#t:Version">Version</a> -> <a href="Distribution-Version.html#t:Version">Version</a> -> <a href="Distribution-Version.html#t:VersionRange">VersionRange</a></li><li class="src short"><a href="#v:withinRange">withinRange</a> :: <a href="Distribution-Version.html#t:Version">Version</a> -> <a href="Distribution-Version.html#t:VersionRange">VersionRange</a> -> <a href="../base-4.5.1.0/Data-Bool.html#t:Bool">Bool</a></li><li class="src short"><a href="#v:isAnyVersion">isAnyVersion</a> :: <a href="Distribution-Version.html#t:VersionRange">VersionRange</a> -> <a href="../base-4.5.1.0/Data-Bool.html#t:Bool">Bool</a></li><li class="src short"><a href="#v:isNoVersion">isNoVersion</a> :: <a href="Distribution-Version.html#t:VersionRange">VersionRange</a> -> <a href="../base-4.5.1.0/Data-Bool.html#t:Bool">Bool</a></li><li class="src short"><a href="#v:isSpecificVersion">isSpecificVersion</a> :: <a href="Distribution-Version.html#t:VersionRange">VersionRange</a> -> <a href="../base-4.5.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Distribution-Version.html#t:Version">Version</a></li><li class="src short"><a href="#v:simplifyVersionRange">simplifyVersionRange</a> :: <a href="Distribution-Version.html#t:VersionRange">VersionRange</a> -> <a href="Distribution-Version.html#t:VersionRange">VersionRange</a></li><li class="src short"><a href="#v:foldVersionRange">foldVersionRange</a> :: a -> (<a href="Distribution-Version.html#t:Version">Version</a> -> a) -> (<a href="Distribution-Version.html#t:Version">Version</a> -> a) -> (<a href="Distribution-Version.html#t:Version">Version</a> -> a) -> (a -> a -> a) -> (a -> a -> a) -> <a href="Distribution-Version.html#t:VersionRange">VersionRange</a> -> a</li><li class="src short"><a href="#v:foldVersionRange-39-">foldVersionRange'</a> :: a -> (<a href="Distribution-Version.html#t:Version">Version</a> -> a) -> (<a href="Distribution-Version.html#t:Version">Version</a> -> a) -> (<a href="Distribution-Version.html#t:Version">Version</a> -> a) -> (<a href="Distribution-Version.html#t:Version">Version</a> -> a) -> (<a href="Distribution-Version.html#t:Version">Version</a> -> a) -> (<a href="Distribution-Version.html#t:Version">Version</a> -> <a href="Distribution-Version.html#t:Version">Version</a> -> a) -> (a -> a -> a) -> (a -> a -> a) -> (a -> a) -> <a href="Distribution-Version.html#t:VersionRange">VersionRange</a> -> a</li><li class="src short"><a href="#v:asVersionIntervals">asVersionIntervals</a> :: <a href="Distribution-Version.html#t:VersionRange">VersionRange</a> -> [<a href="Distribution-Version.html#t:VersionInterval">VersionInterval</a>]</li><li class="src short"><span class="keyword">type</span> <a href="#t:VersionInterval">VersionInterval</a> = (<a href="Distribution-Version.html#t:LowerBound">LowerBound</a>, <a href="Distribution-Version.html#t:UpperBound">UpperBound</a>)</li><li class="src short"><span class="keyword">data</span> <a href="#t:LowerBound">LowerBound</a> = <a href="#v:LowerBound">LowerBound</a> <a href="Distribution-Version.html#t:Version">Version</a> !<a href="Distribution-Version.html#t:Bound">Bound</a></li><li class="src short"><span class="keyword">data</span> <a href="#t:UpperBound">UpperBound</a> <ul class="subs"><li>= <a href="#v:NoUpperBound">NoUpperBound</a> </li><li>| <a href="#v:UpperBound">UpperBound</a> <a href="Distribution-Version.html#t:Version">Version</a> !<a href="Distribution-Version.html#t:Bound">Bound</a> </li></ul></li><li class="src short"><span class="keyword">data</span> <a href="#t:Bound">Bound</a> <ul class="subs"><li>= <a href="#v:ExclusiveBound">ExclusiveBound</a> </li><li>| <a href="#v:InclusiveBound">InclusiveBound</a> </li></ul></li><li class="src short"><span class="keyword">data</span> <a href="#t:VersionIntervals">VersionIntervals</a> </li><li class="src short"><a href="#v:toVersionIntervals">toVersionIntervals</a> :: <a href="Distribution-Version.html#t:VersionRange">VersionRange</a> -> <a href="Distribution-Version.html#t:VersionIntervals">VersionIntervals</a></li><li class="src short"><a href="#v:fromVersionIntervals">fromVersionIntervals</a> :: <a href="Distribution-Version.html#t:VersionIntervals">VersionIntervals</a> -> <a href="Distribution-Version.html#t:VersionRange">VersionRange</a></li><li class="src short"><a href="#v:withinIntervals">withinIntervals</a> :: <a href="Distribution-Version.html#t:Version">Version</a> -> <a href="Distribution-Version.html#t:VersionIntervals">VersionIntervals</a> -> <a href="../base-4.5.1.0/Data-Bool.html#t:Bool">Bool</a></li><li class="src short"><a href="#v:versionIntervals">versionIntervals</a> :: <a href="Distribution-Version.html#t:VersionIntervals">VersionIntervals</a> -> [<a href="Distribution-Version.html#t:VersionInterval">VersionInterval</a>]</li><li class="src short"><a href="#v:mkVersionIntervals">mkVersionIntervals</a> :: [<a href="Distribution-Version.html#t:VersionInterval">VersionInterval</a>] -> <a href="../base-4.5.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Distribution-Version.html#t:VersionIntervals">VersionIntervals</a></li><li class="src short"><a href="#v:unionVersionIntervals">unionVersionIntervals</a> :: <a href="Distribution-Version.html#t:VersionIntervals">VersionIntervals</a> -> <a href="Distribution-Version.html#t:VersionIntervals">VersionIntervals</a> -> <a href="Distribution-Version.html#t:VersionIntervals">VersionIntervals</a></li><li class="src short"><a href="#v:intersectVersionIntervals">intersectVersionIntervals</a> :: <a href="Distribution-Version.html#t:VersionIntervals">VersionIntervals</a> -> <a href="Distribution-Version.html#t:VersionIntervals">VersionIntervals</a> -> <a href="Distribution-Version.html#t:VersionIntervals">VersionIntervals</a></li></ul></div><div id="interface"><h1 id="g:1">Package versions
</h1><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:Version" class="def">Version</a> <a href="../base-4.5.1.0/src/Data-Version.html#Version" class="link">Source</a></p><div class="doc"><p>A <code><a href="Distribution-Version.html#t:Version">Version</a></code> represents the version of a software entity.
</p><p>An instance of <code><a href="../base-4.5.1.0/Data-Eq.html#t:Eq">Eq</a></code> is provided, which implements exact equality
modulo reordering of the tags in the <code><a href="Distribution-Version.html#v:versionTags">versionTags</a></code> field.
</p><p>An instance of <code><a href="../base-4.5.1.0/Data-Ord.html#t:Ord">Ord</a></code> is also provided, which gives lexicographic
ordering on the <code><a href="Distribution-Version.html#v:versionBranch">versionBranch</a></code> fields (i.e. 2.1 > 2.0, 1.2.3 > 1.2.2,
etc.). This is expected to be sufficient for many uses, but note that
you may need to use a more specific ordering for your versioning
scheme. For example, some versioning schemes may include pre-releases
which have tags <code>"pre1"</code>, <code>"pre2"</code>, and so on, and these would need to
be taken into account when determining ordering. In some cases, date
ordering may be more appropriate, so the application would have to
look for <code>date</code> tags in the <code><a href="Distribution-Version.html#v:versionTags">versionTags</a></code> field and compare those.
The bottom line is, don't always assume that <code><a href="../base-4.5.1.0/Data-Ord.html#v:compare">compare</a></code> and other <code><a href="../base-4.5.1.0/Data-Ord.html#t:Ord">Ord</a></code>
operations are the right thing for every <code><a href="Distribution-Version.html#t:Version">Version</a></code>.
</p><p>Similarly, concrete representations of versions may differ. One
possible concrete representation is provided (see <code><a href="../base-4.5.1.0/Data-Version.html#v:showVersion">showVersion</a></code> and
<code><a href="../base-4.5.1.0/Data-Version.html#v:parseVersion">parseVersion</a></code>), but depending on the application a different concrete
representation may be more appropriate.
</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:Version" class="def">Version</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:versionBranch" class="def">versionBranch</a> :: [<a href="../base-4.5.1.0/Data-Int.html#t:Int">Int</a>]</dt><dd class="doc"><p>The numeric branch for this version. This reflects the
fact that most software versions are tree-structured; there
is a main trunk which is tagged with versions at various
points (1,2,3...), and the first branch off the trunk after
version 3 is 3.1, the second branch off the trunk after
version 3 is 3.2, and so on. The tree can be branched
arbitrarily, just by adding more digits.
</p><p>We represent the branch as a list of <code><a href="../base-4.5.1.0/Data-Int.html#t:Int">Int</a></code>, so
version 3.2.1 becomes [3,2,1]. Lexicographic ordering
(i.e. the default instance of <code><a href="../base-4.5.1.0/Data-Ord.html#t:Ord">Ord</a></code> for <code>[Int]</code>) gives
the natural ordering of branches.
</p></dd><dt class="src"><a name="v:versionTags" class="def">versionTags</a> :: [<a href="../base-4.5.1.0/Data-String.html#t:String">String</a>]</dt><dd class="doc"><p>A version can be tagged with an arbitrary list of strings.
The interpretation of the list of tags is entirely dependent
on the entity that this version applies to.
</p></dd></dl><div class="clear"></div></div></td></tr></table></div><div class="subs instances"><p id="control.i:Version" class="caption collapser" onclick="toggleSection('i:Version')">Instances</p><div id="section.i:Version" class="show"><table><tr><td class="src"><a href="../base-4.5.1.0/Data-Eq.html#t:Eq">Eq</a> <a href="Distribution-Version.html#t:Version">Version</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-Version.html#t:Version">Version</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-Version.html#t:Version">Version</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-Version.html#t:Version">Version</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="../base-4.5.1.0/Data-Typeable-Internal.html#t:Typeable">Typeable</a> <a href="Distribution-Version.html#t:Version">Version</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Distribution-Text.html#t:Text">Text</a> <a href="Distribution-Version.html#t:Version">Version</a></td><td class="doc empty"> </td></tr></table></div></div></div><h1 id="g:2">Version ranges
</h1><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:VersionRange" class="def">VersionRange</a> </p><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:AnyVersion" class="def">AnyVersion</a></td><td class="doc"><div class="warning"><p>Deprecated: Use 'anyVersion', 'foldVersionRange' or 'asVersionIntervals'</p></div></td></tr><tr><td class="src"><a name="v:ThisVersion" class="def">ThisVersion</a> <a href="Distribution-Version.html#t:Version">Version</a></td><td class="doc"><div class="warning"><p>Deprecated: use 'thisVersion', 'foldVersionRange' or 'asVersionIntervals'</p></div></td></tr><tr><td class="src"><a name="v:LaterVersion" class="def">LaterVersion</a> <a href="Distribution-Version.html#t:Version">Version</a></td><td class="doc"><div class="warning"><p>Deprecated: use 'laterVersion', 'foldVersionRange' or 'asVersionIntervals'</p></div></td></tr><tr><td class="src"><a name="v:EarlierVersion" class="def">EarlierVersion</a> <a href="Distribution-Version.html#t:Version">Version</a></td><td class="doc"><div class="warning"><p>Deprecated: use 'earlierVersion', 'foldVersionRange' or 'asVersionIntervals'</p></div></td></tr><tr><td class="src"><a name="v:WildcardVersion" class="def">WildcardVersion</a> <a href="Distribution-Version.html#t:Version">Version</a></td><td class="doc"><div class="warning"><p>Deprecated: use 'anyVersion', 'foldVersionRange' or 'asVersionIntervals'</p></div></td></tr><tr><td class="src"><a name="v:UnionVersionRanges" class="def">UnionVersionRanges</a> <a href="Distribution-Version.html#t:VersionRange">VersionRange</a> <a href="Distribution-Version.html#t:VersionRange">VersionRange</a></td><td class="doc"><div class="warning"><p>Deprecated: use 'unionVersionRanges', 'foldVersionRange' or 'asVersionIntervals'</p></div></td></tr><tr><td class="src"><a name="v:IntersectVersionRanges" class="def">IntersectVersionRanges</a> <a href="Distribution-Version.html#t:VersionRange">VersionRange</a> <a href="Distribution-Version.html#t:VersionRange">VersionRange</a></td><td class="doc"><div class="warning"><p>Deprecated: use 'intersectVersionRanges', 'foldVersionRange' or 'asVersionIntervals'</p></div></td></tr><tr><td class="src"><a name="v:VersionRangeParens" class="def">VersionRangeParens</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:VersionRange" class="caption collapser" onclick="toggleSection('i:VersionRange')">Instances</p><div id="section.i:VersionRange" class="show"><table><tr><td class="src"><a href="../base-4.5.1.0/Data-Eq.html#t:Eq">Eq</a> <a href="Distribution-Version.html#t:VersionRange">VersionRange</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-Version.html#t:VersionRange">VersionRange</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-Version.html#t:VersionRange">VersionRange</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Distribution-Text.html#t:Text">Text</a> <a href="Distribution-Version.html#t:VersionRange">VersionRange</a></td><td class="doc empty"> </td></tr></table></div></div></div><h2 id="g:3">Constructing
</h2><div class="top"><p class="src"><a name="v:anyVersion" class="def">anyVersion</a> :: <a href="Distribution-Version.html#t:VersionRange">VersionRange</a></p><div class="doc"><p>The version range <code>-any</code>. That is, a version range containing all
versions.
</p><pre> withinRange v anyVersion = True
</pre></div></div><div class="top"><p class="src"><a name="v:noVersion" class="def">noVersion</a> :: <a href="Distribution-Version.html#t:VersionRange">VersionRange</a></p><div class="doc"><p>The empty version range, that is a version range containing no versions.
</p><p>This can be constructed using any unsatisfiable version range expression,
for example <code>> 1 && < 1</code>.
</p><pre> withinRange v anyVersion = False
</pre></div></div><div class="top"><p class="src"><a name="v:thisVersion" class="def">thisVersion</a> :: <a href="Distribution-Version.html#t:Version">Version</a> -> <a href="Distribution-Version.html#t:VersionRange">VersionRange</a></p><div class="doc"><p>The version range <code>== v</code>
</p><pre> withinRange v' (thisVersion v) = v' == v
</pre></div></div><div class="top"><p class="src"><a name="v:notThisVersion" class="def">notThisVersion</a> :: <a href="Distribution-Version.html#t:Version">Version</a> -> <a href="Distribution-Version.html#t:VersionRange">VersionRange</a></p><div class="doc"><p>The version range <code><a href=" v || "> v || </a> v</code>
</p><pre> withinRange v' (notThisVersion v) = v' /= v
</pre></div></div><div class="top"><p class="src"><a name="v:laterVersion" class="def">laterVersion</a> :: <a href="Distribution-Version.html#t:Version">Version</a> -> <a href="Distribution-Version.html#t:VersionRange">VersionRange</a></p><div class="doc"><p>The version range <code>> v</code>
</p><pre> withinRange v' (laterVersion v) = v' > v
</pre></div></div><div class="top"><p class="src"><a name="v:earlierVersion" class="def">earlierVersion</a> :: <a href="Distribution-Version.html#t:Version">Version</a> -> <a href="Distribution-Version.html#t:VersionRange">VersionRange</a></p><div class="doc"><p>The version range <code>< v</code>
</p><pre> withinRange v' (earlierVersion v) = v' < v
</pre></div></div><div class="top"><p class="src"><a name="v:orLaterVersion" class="def">orLaterVersion</a> :: <a href="Distribution-Version.html#t:Version">Version</a> -> <a href="Distribution-Version.html#t:VersionRange">VersionRange</a></p><div class="doc"><p>The version range <code>>= v</code>
</p><pre> withinRange v' (orLaterVersion v) = v' >= v
</pre></div></div><div class="top"><p class="src"><a name="v:orEarlierVersion" class="def">orEarlierVersion</a> :: <a href="Distribution-Version.html#t:Version">Version</a> -> <a href="Distribution-Version.html#t:VersionRange">VersionRange</a></p><div class="doc"><p>The version range <code><= v</code>
</p><pre> withinRange v' (orEarlierVersion v) = v' <= v
</pre></div></div><div class="top"><p class="src"><a name="v:unionVersionRanges" class="def">unionVersionRanges</a> :: <a href="Distribution-Version.html#t:VersionRange">VersionRange</a> -> <a href="Distribution-Version.html#t:VersionRange">VersionRange</a> -> <a href="Distribution-Version.html#t:VersionRange">VersionRange</a></p><div class="doc"><p>The version range <code>vr1 || vr2</code>
</p><pre> withinRange v' (unionVersionRanges vr1 vr2)
= withinRange v' vr1 || withinRange v' vr2
</pre></div></div><div class="top"><p class="src"><a name="v:intersectVersionRanges" class="def">intersectVersionRanges</a> :: <a href="Distribution-Version.html#t:VersionRange">VersionRange</a> -> <a href="Distribution-Version.html#t:VersionRange">VersionRange</a> -> <a href="Distribution-Version.html#t:VersionRange">VersionRange</a></p><div class="doc"><p>The version range <code>vr1 && vr2</code>
</p><pre> withinRange v' (intersectVersionRanges vr1 vr2)
= withinRange v' vr1 && withinRange v' vr2
</pre></div></div><div class="top"><p class="src"><a name="v:withinVersion" class="def">withinVersion</a> :: <a href="Distribution-Version.html#t:Version">Version</a> -> <a href="Distribution-Version.html#t:VersionRange">VersionRange</a></p><div class="doc"><p>The version range <code>== v.*</code>.
</p><p>For example, for version <code>1.2</code>, the version range <code>== 1.2.*</code> is the same as
<code>>= 1.2 && < 1.3</code>
</p><pre> withinRange v' (laterVersion v) = v' >= v && v' < upper v
where
upper (Version lower t) = Version (init lower ++ [last lower + 1]) t
</pre></div></div><div class="top"><p class="src"><a name="v:betweenVersionsInclusive" class="def">betweenVersionsInclusive</a> :: <a href="Distribution-Version.html#t:Version">Version</a> -> <a href="Distribution-Version.html#t:Version">Version</a> -> <a href="Distribution-Version.html#t:VersionRange">VersionRange</a></p><div class="doc"><div class="warning"><p>Deprecated: In practice this is not very useful because we normally use inclusive lower bounds and exclusive upper bounds</p></div><p>The version range <code>>= v1 && <= v2</code>.
</p><p>In practice this is not very useful because we normally use inclusive lower
bounds and exclusive upper bounds.
</p><pre> withinRange v' (laterVersion v) = v' > v
</pre></div></div><h2 id="g:4">Inspection
</h2><div class="top"><p class="src"><a name="v:withinRange" class="def">withinRange</a> :: <a href="Distribution-Version.html#t:Version">Version</a> -> <a href="Distribution-Version.html#t:VersionRange">VersionRange</a> -> <a href="../base-4.5.1.0/Data-Bool.html#t:Bool">Bool</a></p><div class="doc"><p>Does this version fall within the given range?
</p><p>This is the evaluation function for the <code><a href="Distribution-Version.html#t:VersionRange">VersionRange</a></code> type.
</p></div></div><div class="top"><p class="src"><a name="v:isAnyVersion" class="def">isAnyVersion</a> :: <a href="Distribution-Version.html#t:VersionRange">VersionRange</a> -> <a href="../base-4.5.1.0/Data-Bool.html#t:Bool">Bool</a></p><div class="doc"><p>Does this <code><a href="Distribution-Version.html#t:VersionRange">VersionRange</a></code> place any restriction on the <code><a href="Distribution-Version.html#t:Version">Version</a></code> or is it
in fact equivalent to <code><a href="Distribution-Version.html#v:AnyVersion">AnyVersion</a></code>.
</p><p>Note this is a semantic check, not simply a syntactic check. So for example
the following is <code>True</code> (for all <code>v</code>).
</p><pre> isAnyVersion (EarlierVersion v `UnionVersionRanges` orLaterVersion v)
</pre></div></div><div class="top"><p class="src"><a name="v:isNoVersion" class="def">isNoVersion</a> :: <a href="Distribution-Version.html#t:VersionRange">VersionRange</a> -> <a href="../base-4.5.1.0/Data-Bool.html#t:Bool">Bool</a></p><div class="doc"><p>This is the converse of <code><a href="Distribution-Version.html#v:isAnyVersion">isAnyVersion</a></code>. It check if the version range is
empty, if there is no possible version that satisfies the version range.
</p><p>For example this is <code>True</code> (for all <code>v</code>):
</p><pre> isNoVersion (EarlierVersion v `IntersectVersionRanges` LaterVersion v)
</pre></div></div><div class="top"><p class="src"><a name="v:isSpecificVersion" class="def">isSpecificVersion</a> :: <a href="Distribution-Version.html#t:VersionRange">VersionRange</a> -> <a href="../base-4.5.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Distribution-Version.html#t:Version">Version</a></p><div class="doc"><p>Is this version range in fact just a specific version?
</p><p>For example the version range <code>">= 3 && <= 3"</code> contains only the version
<code>3</code>.
</p></div></div><div class="top"><p class="src"><a name="v:simplifyVersionRange" class="def">simplifyVersionRange</a> :: <a href="Distribution-Version.html#t:VersionRange">VersionRange</a> -> <a href="Distribution-Version.html#t:VersionRange">VersionRange</a></p><div class="doc"><p>Simplify a <code><a href="Distribution-Version.html#t:VersionRange">VersionRange</a></code> expression. For non-empty version ranges
this produces a canonical form. Empty or inconsistent version ranges
are left as-is because that provides more information.
</p><p>If you need a canonical form use
<code>fromVersionIntervals . toVersionIntervals</code>
</p><p>It satisfies the following properties:
</p><pre> withinRange v (simplifyVersionRange r) = withinRange v r
</pre><pre> withinRange v r = withinRange v r'
==> simplifyVersionRange r = simplifyVersionRange r'
|| isNoVersion r
|| isNoVersion r'
</pre></div></div><div class="top"><p class="src"><a name="v:foldVersionRange" class="def">foldVersionRange</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: a</td><td class="doc"><p><code>"-any"</code> version
</p></td></tr><tr><td class="src">-> (<a href="Distribution-Version.html#t:Version">Version</a> -> a)</td><td class="doc"><pre>"== v"</pre></td></tr><tr><td class="src">-> (<a href="Distribution-Version.html#t:Version">Version</a> -> a)</td><td class="doc"><pre>"> v"</pre></td></tr><tr><td class="src">-> (<a href="Distribution-Version.html#t:Version">Version</a> -> a)</td><td class="doc"><pre>"< v"</pre></td></tr><tr><td class="src">-> (a -> a -> a)</td><td class="doc"><p><code>"_ || _"</code> union
</p></td></tr><tr><td class="src">-> (a -> a -> a)</td><td class="doc"><p><code>"_ && _"</code> intersection
</p></td></tr><tr><td class="src">-> <a href="Distribution-Version.html#t:VersionRange">VersionRange</a></td><td class="doc empty"> </td></tr><tr><td class="src">-> a</td><td class="doc empty"> </td></tr></table></div><div class="doc"><p>Fold over the basic syntactic structure of a <code><a href="Distribution-Version.html#t:VersionRange">VersionRange</a></code>.
</p><p>This provides a syntacic view of the expression defining the version range.
The syntactic sugar <code>">= v"</code>, <code>"<= v"</code> and <code>"== v.*"</code> is presented
in terms of the other basic syntax.
</p><p>For a semantic view use <code><a href="Distribution-Version.html#v:asVersionIntervals">asVersionIntervals</a></code>.
</p></div></div><div class="top"><p class="src"><a name="v:foldVersionRange-39-" class="def">foldVersionRange'</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: a</td><td class="doc"><p><code>"-any"</code> version
</p></td></tr><tr><td class="src">-> (<a href="Distribution-Version.html#t:Version">Version</a> -> a)</td><td class="doc"><pre>"== v"</pre></td></tr><tr><td class="src">-> (<a href="Distribution-Version.html#t:Version">Version</a> -> a)</td><td class="doc"><pre>"> v"</pre></td></tr><tr><td class="src">-> (<a href="Distribution-Version.html#t:Version">Version</a> -> a)</td><td class="doc"><pre>"< v"</pre></td></tr><tr><td class="src">-> (<a href="Distribution-Version.html#t:Version">Version</a> -> a)</td><td class="doc"><pre>">= v"</pre></td></tr><tr><td class="src">-> (<a href="Distribution-Version.html#t:Version">Version</a> -> a)</td><td class="doc"><pre>"<= v"</pre></td></tr><tr><td class="src">-> (<a href="Distribution-Version.html#t:Version">Version</a> -> <a href="Distribution-Version.html#t:Version">Version</a> -> a)</td><td class="doc"><p><code>"== v.*"</code> wildcard. The
function is passed the
inclusive lower bound and the
exclusive upper bounds of the
range defined by the wildcard.
</p></td></tr><tr><td class="src">-> (a -> a -> a)</td><td class="doc"><p><code>"_ || _"</code> union
</p></td></tr><tr><td class="src">-> (a -> a -> a)</td><td class="doc"><p><code>"_ && _"</code> intersection
</p></td></tr><tr><td class="src">-> (a -> a)</td><td class="doc"><p><code>"(_)"</code> parentheses
</p></td></tr><tr><td class="src">-> <a href="Distribution-Version.html#t:VersionRange">VersionRange</a></td><td class="doc empty"> </td></tr><tr><td class="src">-> a</td><td class="doc empty"> </td></tr></table></div><div class="doc"><p>An extended variant of <code><a href="Distribution-Version.html#v:foldVersionRange">foldVersionRange</a></code> that also provides a view of
in which the syntactic sugar <code>">= v"</code>, <code>"<= v"</code> and <code>"== v.*"</code> is presented
explicitly rather than in terms of the other basic syntax.
</p></div></div><h1 id="g:5">Version intervals view
</h1><div class="top"><p class="src"><a name="v:asVersionIntervals" class="def">asVersionIntervals</a> :: <a href="Distribution-Version.html#t:VersionRange">VersionRange</a> -> [<a href="Distribution-Version.html#t:VersionInterval">VersionInterval</a>]</p><div class="doc"><p>View a <code><a href="Distribution-Version.html#t:VersionRange">VersionRange</a></code> as a union of intervals.
</p><p>This provides a canonical view of the semantics of a <code><a href="Distribution-Version.html#t:VersionRange">VersionRange</a></code> as
opposed to the syntax of the expression used to define it. For the syntactic
view use <code><a href="Distribution-Version.html#v:foldVersionRange">foldVersionRange</a></code>.
</p><p>Each interval is non-empty. The sequence is in increasing order and no
intervals overlap or touch. Therefore only the first and last can be
unbounded. The sequence can be empty if the range is empty
(e.g. a range expression like <code><a href=" 1 && "> 1 && </a> 2</code>).
</p><p>Other checks are trivial to implement using this view. For example:
</p><pre> isNoVersion vr | [] <- asVersionIntervals vr = True
| otherwise = False
</pre><pre> isSpecificVersion vr
| [(LowerBound v InclusiveBound
,UpperBound v' InclusiveBound)] <- asVersionIntervals vr
, v == v' = Just v
| otherwise = Nothing
</pre></div></div><div class="top"><p class="src"><span class="keyword">type</span> <a name="t:VersionInterval" class="def">VersionInterval</a> = (<a href="Distribution-Version.html#t:LowerBound">LowerBound</a>, <a href="Distribution-Version.html#t:UpperBound">UpperBound</a>)</p></div><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:LowerBound" class="def">LowerBound</a> </p><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:LowerBound" class="def">LowerBound</a> <a href="Distribution-Version.html#t:Version">Version</a> !<a href="Distribution-Version.html#t:Bound">Bound</a></td><td class="doc empty"> </td></tr></table></div><div class="subs instances"><p id="control.i:LowerBound" class="caption collapser" onclick="toggleSection('i:LowerBound')">Instances</p><div id="section.i:LowerBound" class="show"><table><tr><td class="src"><a href="../base-4.5.1.0/Data-Eq.html#t:Eq">Eq</a> <a href="Distribution-Version.html#t:LowerBound">LowerBound</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-Version.html#t:LowerBound">LowerBound</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-Version.html#t:LowerBound">LowerBound</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:UpperBound" class="def">UpperBound</a> </p><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:NoUpperBound" class="def">NoUpperBound</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:UpperBound" class="def">UpperBound</a> <a href="Distribution-Version.html#t:Version">Version</a> !<a href="Distribution-Version.html#t:Bound">Bound</a></td><td class="doc empty"> </td></tr></table></div><div class="subs instances"><p id="control.i:UpperBound" class="caption collapser" onclick="toggleSection('i:UpperBound')">Instances</p><div id="section.i:UpperBound" class="show"><table><tr><td class="src"><a href="../base-4.5.1.0/Data-Eq.html#t:Eq">Eq</a> <a href="Distribution-Version.html#t:UpperBound">UpperBound</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-Version.html#t:UpperBound">UpperBound</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-Version.html#t:UpperBound">UpperBound</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:Bound" class="def">Bound</a> </p><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:ExclusiveBound" class="def">ExclusiveBound</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:InclusiveBound" class="def">InclusiveBound</a></td><td class="doc empty"> </td></tr></table></div><div class="subs instances"><p id="control.i:Bound" class="caption collapser" onclick="toggleSection('i:Bound')">Instances</p><div id="section.i:Bound" class="show"><table><tr><td class="src"><a href="../base-4.5.1.0/Data-Eq.html#t:Eq">Eq</a> <a href="Distribution-Version.html#t:Bound">Bound</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-Version.html#t:Bound">Bound</a></td><td class="doc empty"> </td></tr></table></div></div></div><h2 id="g:6"><code><a href="Distribution-Version.html#t:VersionIntervals">VersionIntervals</a></code> abstract type
</h2><div class="doc"><p>The <code><a href="Distribution-Version.html#t:VersionIntervals">VersionIntervals</a></code> type and the accompanying functions are exposed
primarily for completeness and testing purposes. In practice
<code><a href="Distribution-Version.html#v:asVersionIntervals">asVersionIntervals</a></code> is the main function to use to
view a <code><a href="Distribution-Version.html#t:VersionRange">VersionRange</a></code> as a bunch of <code><a href="Distribution-Version.html#t:VersionInterval">VersionInterval</a></code>s.
</p></div><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:VersionIntervals" class="def">VersionIntervals</a> </p><div class="doc"><p>A complementary representation of a <code><a href="Distribution-Version.html#t:VersionRange">VersionRange</a></code>. Instead of a boolean
version predicate it uses an increasing sequence of non-overlapping,
non-empty intervals.
</p><p>The key point is that this representation gives a canonical representation
for the semantics of <code><a href="Distribution-Version.html#t:VersionRange">VersionRange</a></code>s. This makes it easier to check things
like whether a version range is empty, covers all versions, or requires a
certain minimum or maximum version. It also makes it easy to check equality
or containment. It also makes it easier to identify 'simple' version
predicates for translation into foreign packaging systems that do not
support complex version range expressions.
</p></div><div class="subs instances"><p id="control.i:VersionIntervals" class="caption collapser" onclick="toggleSection('i:VersionIntervals')">Instances</p><div id="section.i:VersionIntervals" class="show"><table><tr><td class="src"><a href="../base-4.5.1.0/Data-Eq.html#t:Eq">Eq</a> <a href="Distribution-Version.html#t:VersionIntervals">VersionIntervals</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-Version.html#t:VersionIntervals">VersionIntervals</a></td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><a name="v:toVersionIntervals" class="def">toVersionIntervals</a> :: <a href="Distribution-Version.html#t:VersionRange">VersionRange</a> -> <a href="Distribution-Version.html#t:VersionIntervals">VersionIntervals</a></p><div class="doc"><p>Convert a <code><a href="Distribution-Version.html#t:VersionRange">VersionRange</a></code> to a sequence of version intervals.
</p></div></div><div class="top"><p class="src"><a name="v:fromVersionIntervals" class="def">fromVersionIntervals</a> :: <a href="Distribution-Version.html#t:VersionIntervals">VersionIntervals</a> -> <a href="Distribution-Version.html#t:VersionRange">VersionRange</a></p><div class="doc"><p>Convert a <code><a href="Distribution-Version.html#t:VersionIntervals">VersionIntervals</a></code> value back into a <code><a href="Distribution-Version.html#t:VersionRange">VersionRange</a></code> expression
representing the version intervals.
</p></div></div><div class="top"><p class="src"><a name="v:withinIntervals" class="def">withinIntervals</a> :: <a href="Distribution-Version.html#t:Version">Version</a> -> <a href="Distribution-Version.html#t:VersionIntervals">VersionIntervals</a> -> <a href="../base-4.5.1.0/Data-Bool.html#t:Bool">Bool</a></p><div class="doc"><p>Test if a version falls within the version intervals.
</p><p>It exists mostly for completeness and testing. It satisfies the following
properties:
</p><pre> withinIntervals v (toVersionIntervals vr) = withinRange v vr
withinIntervals v ivs = withinRange v (fromVersionIntervals ivs)
</pre></div></div><div class="top"><p class="src"><a name="v:versionIntervals" class="def">versionIntervals</a> :: <a href="Distribution-Version.html#t:VersionIntervals">VersionIntervals</a> -> [<a href="Distribution-Version.html#t:VersionInterval">VersionInterval</a>]</p><div class="doc"><p>Inspect the list of version intervals.
</p></div></div><div class="top"><p class="src"><a name="v:mkVersionIntervals" class="def">mkVersionIntervals</a> :: [<a href="Distribution-Version.html#t:VersionInterval">VersionInterval</a>] -> <a href="../base-4.5.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Distribution-Version.html#t:VersionIntervals">VersionIntervals</a></p><div class="doc"><p>Directly construct a <code><a href="Distribution-Version.html#t:VersionIntervals">VersionIntervals</a></code> from a list of intervals.
</p><p>Each interval must be non-empty. The sequence must be in increasing order
and no invervals may overlap or touch. If any of these conditions are not
satisfied the function returns <code>Nothing</code>.
</p></div></div><div class="top"><p class="src"><a name="v:unionVersionIntervals" class="def">unionVersionIntervals</a> :: <a href="Distribution-Version.html#t:VersionIntervals">VersionIntervals</a> -> <a href="Distribution-Version.html#t:VersionIntervals">VersionIntervals</a> -> <a href="Distribution-Version.html#t:VersionIntervals">VersionIntervals</a></p></div><div class="top"><p class="src"><a name="v:intersectVersionIntervals" class="def">intersectVersionIntervals</a> :: <a href="Distribution-Version.html#t:VersionIntervals">VersionIntervals</a> -> <a href="Distribution-Version.html#t:VersionIntervals">VersionIntervals</a> -> <a href="Distribution-Version.html#t:VersionIntervals">VersionIntervals</a></p></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
>
2073
