Distribution.Version

Cabal-2.0.1.0: A framework for packaging Haskell software

Copyright | Isaac Jones Simon Marlow 2003-2004 Duncan Coutts 2008
License | BSD3
Maintainer | cabal-devel@haskell.org
Portability | portable
Safe Haskell | None
Language | Haskell2010

Distribution.Version

Contents

- Package versions
  - Backwards compatibility
- Version ranges
  - Constructing
  - Inspection
  - Modification
- Version intervals view
  - `VersionIntervals` abstract type

Description

Exports the `Version` type along with a parser and pretty printer. A version is something like `"1.3.3"`. It also defines the `VersionRange` data types. Version ranges are like `">= 1.2 && < 2"`.

Synopsis

- data Version
- mkVersion :: [Int] -> Version
- mkVersion' :: Version -> Version
- versionNumbers :: Version -> [Int]
- nullVersion :: Version
- alterVersion :: ([Int] -> [Int]) -> Version -> Version
- showVersion :: Version -> String
- data VersionRange
  - = AnyVersion
  - | ThisVersion Version
  - | LaterVersion Version
  - | EarlierVersion Version
  - | WildcardVersion Version
  - | MajorBoundVersion Version
  - | UnionVersionRanges VersionRange VersionRange
  - | IntersectVersionRanges VersionRange VersionRange
  - | VersionRangeParens VersionRange
- anyVersion :: VersionRange
- noVersion :: VersionRange
- thisVersion :: Version -> VersionRange
- notThisVersion :: Version -> VersionRange
- laterVersion :: Version -> VersionRange
- earlierVersion :: Version -> VersionRange
- orLaterVersion :: Version -> VersionRange
- orEarlierVersion :: Version -> VersionRange
- unionVersionRanges :: VersionRange -> VersionRange -> VersionRange
- intersectVersionRanges :: VersionRange -> VersionRange -> VersionRange
- differenceVersionRanges :: VersionRange -> VersionRange -> VersionRange
- invertVersionRange :: VersionRange -> VersionRange
- withinVersion :: Version -> VersionRange
- majorBoundVersion :: Version -> VersionRange
- betweenVersionsInclusive :: Version -> Version -> VersionRange
- withinRange :: Version -> VersionRange -> Bool
- isAnyVersion :: VersionRange -> Bool
- isNoVersion :: VersionRange -> Bool
- isSpecificVersion :: VersionRange -> Maybe Version
- simplifyVersionRange :: VersionRange -> VersionRange
- foldVersionRange :: a -> (Version -> a) -> (Version -> a) -> (Version -> a) -> (a -> a -> a) -> (a -> a -> a) -> VersionRange -> a
- foldVersionRange' :: a -> (Version -> a) -> (Version -> a) -> (Version -> a) -> (Version -> a) -> (Version -> a) -> (Version -> Version -> a) -> (Version -> Version -> a) -> (a -> a -> a) -> (a -> a -> a) -> (a -> a) -> VersionRange -> a
- hasUpperBound :: VersionRange -> Bool
- hasLowerBound :: VersionRange -> Bool
- removeUpperBound :: VersionRange -> VersionRange
- removeLowerBound :: VersionRange -> VersionRange
- asVersionIntervals :: VersionRange -> [VersionInterval]
- type VersionInterval = (LowerBound, UpperBound)
- data LowerBound = LowerBound Version !Bound
- data UpperBound
  - = NoUpperBound
  - | UpperBound Version !Bound
- data Bound
  - = ExclusiveBound
  - | InclusiveBound
- data VersionIntervals
- toVersionIntervals :: VersionRange -> VersionIntervals
- fromVersionIntervals :: VersionIntervals -> VersionRange
- withinIntervals :: Version -> VersionIntervals -> Bool
- versionIntervals :: VersionIntervals -> [VersionInterval]
- mkVersionIntervals :: [VersionInterval] -> Maybe VersionIntervals
- unionVersionIntervals :: VersionIntervals -> VersionIntervals -> VersionIntervals
- intersectVersionIntervals :: VersionIntervals -> VersionIntervals -> VersionIntervals
- invertVersionIntervals :: VersionIntervals -> VersionIntervals

# Package versions

data Version Source #

A `Version` represents the version of a software entity.

Instances of `Eq` and `Ord` are provided, which gives exact equality and lexicographic ordering of the version number components (i.e. 2.1 > 2.0, 1.2.3 > 1.2.2, etc.).

This type is opaque and distinct from the `Version` type in Data.Version since `Cabal-2.0`. The difference extends to the `Binary` instance using a different (and more compact) encoding.

Since: 2.0.0.2

Instances

Eq Version # |
Methods (==) :: Version -> Version -> Bool # (/=) :: Version -> Version -> Bool #
Data Version # |
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Version -> c Version Source # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Version Source # toConstr :: Version -> Constr Source # dataTypeOf :: Version -> DataType Source # dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c Version) Source # dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Version) Source # gmapT :: (forall b. Data b => b -> b) -> Version -> Version Source # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Version -> r Source # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Version -> r Source # gmapQ :: (forall d. Data d => d -> u) -> Version -> [u] Source # gmapQi :: Int -> (forall d. Data d => d -> u) -> Version -> u Source # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Version -> m Version Source # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Version -> m Version Source # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Version -> m Version Source #
Ord Version # |
Methods compare :: Version -> Version -> Ordering # (<) :: Version -> Version -> Bool # (<=) :: Version -> Version -> Bool # (>) :: Version -> Version -> Bool # (>=) :: Version -> Version -> Bool # max :: Version -> Version -> Version # min :: Version -> Version -> Version #
Read Version # |
Methods readsPrec :: Int -> ReadS Version Source # readList :: ReadS [Version] Source # readPrec :: ReadPrec Version Source # readListPrec :: ReadPrec [Version] Source #
Show Version # |
Methods showsPrec :: Int -> Version -> ShowS Source # show :: Version -> String Source # showList :: [Version] -> ShowS Source #
Generic Version # |
Associated Types type Rep Version :: * -> * Source # Methods from :: Version -> Rep Version x Source # to :: Rep Version x -> Version Source #
NFData Version # |
Methods rnf :: Version -> () Source #
Binary Version # |
Methods put :: Version -> Put Source # get :: Get Version Source # putList :: [Version] -> Put Source #
Text Version # |
Methods disp :: Version -> Doc Source # parse :: ReadP r Version Source #
type Rep Version # |
type Rep Version = D1 * (MetaData "Version" "Distribution.Version" "Cabal-2.0.1.0" False) ((:+:) * (C1 * (MetaCons "PV0" PrefixI False) (S1 * (MetaSel (Nothing Symbol) SourceUnpack SourceStrict DecidedStrict) (Rec0 * Word64))) (C1 * (MetaCons "PV1" PrefixI False) ((:*:) * (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * [Int])))))

mkVersion :: [Int] -> Version Source #

Construct `Version` from list of version number components.

For instance, `mkVersion [3,2,1]` constructs a `Version` representing the version `3.2.1`.

All version components must be non-negative. `mkVersion []` currently represents the special null version; see also `nullVersion`.

Since: 2.0.0.2

mkVersion' :: Version -> Version Source #

Variant of `Version` which converts a Data.Version `Version` into Cabal's `Version` type.

Since: 2.0.0.2

versionNumbers :: Version -> [Int] Source #

Unpack `Version` into list of version number components.

This is the inverse to `mkVersion`, so the following holds:

    (versionNumbers . mkVersion) vs == vs

Since: 2.0.0.2

nullVersion :: Version Source #

Constant representing the special null `Version`

The `nullVersion` compares (via `Ord`) as less than every proper `Version` value.

Since: 2.0.0.2

alterVersion :: ([Int] -> [Int]) -> Version -> Version Source #

Apply function to list of version number components

    alterVersion f == mkVersion . f . versionNumbers

Since: 2.0.0.2

## Backwards compatibility

showVersion :: Version -> String Source #

# Version ranges

data VersionRange Source #

Constructors

AnyVersion | Deprecated: Use `anyVersion`, `foldVersionRange` or `asVersionIntervals`
ThisVersion Version | Deprecated: Use `thisVersion`, `foldVersionRange` or `asVersionIntervals`
LaterVersion Version | Deprecated: Use `laterVersion`, `foldVersionRange` or `asVersionIntervals`
EarlierVersion Version | Deprecated: Use `earlierVersion`, `foldVersionRange` or `asVersionIntervals`
WildcardVersion Version | Deprecated: Use `anyVersion`, `foldVersionRange` or `asVersionIntervals`
MajorBoundVersion Version |
UnionVersionRanges VersionRange VersionRange | Deprecated: Use `unionVersionRanges`, `foldVersionRange` or `asVersionIntervals`
IntersectVersionRanges VersionRange VersionRange | Deprecated: Use `intersectVersionRanges`, `foldVersionRange` or `asVersionIntervals`
VersionRangeParens VersionRange |

Instances

Eq VersionRange # |
Methods (==) :: VersionRange -> VersionRange -> Bool # (/=) :: VersionRange -> VersionRange -> Bool #
Data VersionRange # |
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> VersionRange -> c VersionRange Source # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c VersionRange Source # toConstr :: VersionRange -> Constr Source # dataTypeOf :: VersionRange -> DataType Source # dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c VersionRange) Source # dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c VersionRange) Source # gmapT :: (forall b. Data b => b -> b) -> VersionRange -> VersionRange Source # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> VersionRange -> r Source # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> VersionRange -> r Source # gmapQ :: (forall d. Data d => d -> u) -> VersionRange -> [u] Source # gmapQi :: Int -> (forall d. Data d => d -> u) -> VersionRange -> u Source # gmapM :: Monad m => (forall d. Data d => d -> m d) -> VersionRange -> m VersionRange Source # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> VersionRange -> m VersionRange Source # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> VersionRange -> m VersionRange Source #
Read VersionRange # |
Methods readsPrec :: Int -> ReadS VersionRange Source # readList :: ReadS [VersionRange] Source # readPrec :: ReadPrec VersionRange Source # readListPrec :: ReadPrec [VersionRange] Source #
Show VersionRange # |
Methods showsPrec :: Int -> VersionRange -> ShowS Source # show :: VersionRange -> String Source # showList :: [VersionRange] -> ShowS Source #
Generic VersionRange # |
Associated Types type Rep VersionRange :: * -> * Source # Methods from :: VersionRange -> Rep VersionRange x Source # to :: Rep VersionRange x -> VersionRange Source #
NFData VersionRange # |
Methods rnf :: VersionRange -> () Source #
Binary VersionRange # |
Methods put :: VersionRange -> Put Source # get :: Get VersionRange Source # putList :: [VersionRange] -> Put Source #
Text VersionRange # |
Methods disp :: VersionRange -> Doc Source # parse :: ReadP r VersionRange Source #
type Rep VersionRange # |
type Rep VersionRange = D1 * (MetaData "VersionRange" "Distribution.Version" "Cabal-2.0.1.0" False) ((:+:) * ((:+:) * ((:+:) * (C1 * (MetaCons "AnyVersion" PrefixI False) (U1 *)) (C1 * (MetaCons "ThisVersion" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Version)))) ((:+:) * (C1 * (MetaCons "LaterVersion" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Version))) (C1 * (MetaCons "EarlierVersion" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Version))))) ((:+:) * ((:+:) * (C1 * (MetaCons "WildcardVersion" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Version))) (C1 * (MetaCons "MajorBoundVersion" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Version)))) ((:+:) * (C1 * (MetaCons "UnionVersionRanges" PrefixI False) ((:*:) * (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * VersionRange)) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * VersionRange)))) ((:+:) * (C1 * (MetaCons "IntersectVersionRanges" PrefixI False) ((:*:) * (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * VersionRange)) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * VersionRange)))) (C1 * (MetaCons "VersionRangeParens" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * VersionRange)))))))

## Constructing

anyVersion :: VersionRange Source #

The version range `-any`. That is, a version range containing all versions.

    withinRange v anyVersion = True

noVersion :: VersionRange Source #

The empty version range, that is a version range containing no versions.

This can be constructed using any unsatisfiable version range expression, for example `> 1 && < 1`.

    withinRange v noVersion = False

thisVersion :: Version -> VersionRange Source #

The version range `== v`

    withinRange v' (thisVersion v) = v' == v

notThisVersion :: Version -> VersionRange Source #

The version range `|| v`

    withinRange v' (notThisVersion v) = v' /= v

laterVersion :: Version -> VersionRange Source #

The version range `> v`

    withinRange v' (laterVersion v) = v' > v

earlierVersion :: Version -> VersionRange Source #

The version range `< v`

    withinRange v' (earlierVersion v) = v' < v

orLaterVersion :: Version -> VersionRange Source #

The version range `>= v`

    withinRange v' (orLaterVersion v) = v' >= v

orEarlierVersion :: Version -> VersionRange Source #

The version range `<= v`

    withinRange v' (orEarlierVersion v) = v' <= v

unionVersionRanges :: VersionRange -> VersionRange -> VersionRange Source #

The version range `vr1 || vr2`

      withinRange v' (unionVersionRanges vr1 vr2)
    = withinRange v' vr1 || withinRange v' vr2

intersectVersionRanges :: VersionRange -> VersionRange -> VersionRange Source #

The version range `vr1 && vr2`

      withinRange v' (intersectVersionRanges vr1 vr2)
    = withinRange v' vr1 && withinRange v' vr2

differenceVersionRanges :: VersionRange -> VersionRange -> VersionRange Source #

The difference of two version ranges

      withinRange v' (differenceVersionRanges vr1 vr2)
    = withinRange v' vr1 && not (withinRange v' vr2)

Since: 1.24.1.0

invertVersionRange :: VersionRange -> VersionRange Source #

The inverse of a version range

      withinRange v' (invertVersionRange vr)
    = not (withinRange v' vr)

withinVersion :: Version -> VersionRange Source #

The version range `== v.*`.

For example, for version `1.2`, the version range `== 1.2.*` is the same as `>= 1.2 && < 1.3`

    withinRange v' (laterVersion v) = v' >= v && v' < upper v
      where
        upper (Version lower t) = Version (init lower ++ [last lower + 1]) t

majorBoundVersion :: Version -> VersionRange Source #

The version range `^>= v`.

For example, for version `1.2.3.4`, the version range `^>= 1.2.3.4` is the same as `>= 1.2.3.4 && < 1.3`.

Note that `^>= 1` is equivalent to `>= 1 && < 1.1`.

Since: 2.0.0.2

betweenVersionsInclusive :: Version -> Version -> VersionRange Source #

Deprecated: In practice this is not very useful because we normally use inclusive lower bounds and exclusive upper bounds

## Inspection

withinRange :: Version -> VersionRange -> Bool Source #

Does this version fall within the given range?

This is the evaluation function for the `VersionRange` type.

isAnyVersion :: VersionRange -> Bool Source #

Does this `VersionRange` place any restriction on the `Version` or is it in fact equivalent to `AnyVersion`.

Note this is a semantic check, not simply a syntactic check. So for example the following is `True` (for all `v`).

    isAnyVersion (EarlierVersion v `UnionVersionRanges` orLaterVersion v)

isNoVersion :: VersionRange -> Bool Source #

This is the converse of `isAnyVersion`. It check if the version range is empty, if there is no possible version that satisfies the version range.

For example this is `True` (for all `v`):

    isNoVersion (EarlierVersion v `IntersectVersionRanges` LaterVersion v)

isSpecificVersion :: VersionRange -> Maybe Version Source #

Is this version range in fact just a specific version?

For example the version range `">= 3 && <= 3"` contains only the version `3`.

simplifyVersionRange :: VersionRange -> VersionRange Source #

Simplify a `VersionRange` 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.

If you need a canonical form use `fromVersionIntervals . toVersionIntervals`

It satisfies the following properties:

    withinRange v (simplifyVersionRange r) = withinRange v r

        withinRange v r = withinRange v r'
    ==> simplifyVersionRange r = simplifyVersionRange r'
     || isNoVersion r
     || isNoVersion r'

foldVersionRange Source #

Arguments

:: a | `"-any"` version
-> (Version -> a) |
    "== v"
-> (Version -> a) |
    "> v"
-> (Version -> a) |
    "< v"
-> (a -> a -> a) | `"_ || _"` union
-> (a -> a -> a) | `"_ && _"` intersection
-> VersionRange |
-> a |

Fold over the basic syntactic structure of a `VersionRange`.

This provides a syntactic view of the expression defining the version range. The syntactic sugar `">= v"`, `"<= v"` and `"== v.*"` is presented in terms of the other basic syntax.

For a semantic view use `asVersionIntervals`.

foldVersionRange' Source #

Arguments

:: a | `"-any"` version
-> (Version -> a) |
    "== v"
-> (Version -> a) |
    "> v"
-> (Version -> a) |
    "< v"
-> (Version -> a) |
    ">= v"
-> (Version -> a) |
    "<= v"
-> (Version -> Version -> a) | `"== v.*"` wildcard. The function is passed the inclusive lower bound and the exclusive upper bounds of the range defined by the wildcard.
-> (Version -> Version -> a) | `"^>= v"` major upper bound The function is passed the inclusive lower bound and the exclusive major upper bounds of the range defined by this operator.
-> (a -> a -> a) | `"_ || _"` union
-> (a -> a -> a) | `"_ && _"` intersection
-> (a -> a) | `"(_)"` parentheses
-> VersionRange |
-> a |

An extended variant of `foldVersionRange` that also provides a view of the expression in which the syntactic sugar `">= v"`, `"<= v"` and `"== v.*"` is presented explicitly rather than in terms of the other basic syntax.

hasUpperBound :: VersionRange -> Bool Source #

Does the version range have an upper bound?

Since: 1.24.0.0

hasLowerBound :: VersionRange -> Bool Source #

Does the version range have an explicit lower bound?

Note: this function only considers the user-specified lower bounds, but not the implicit >=0 lower bound.

Since: 1.24.0.0

## Modification

removeUpperBound :: VersionRange -> VersionRange Source #

Given a version range, remove the highest upper bound. Example: `(>= 1 && < 3) || (>= 4 && < 5)` is converted to `(>= 1 && || (= 4)`.

removeLowerBound :: VersionRange -> VersionRange Source #

Given a version range, remove the lowest lower bound. Example: `(>= 1 && || (= 4 && < 5)` is converted to `(>= 0 && || (= 4 && < 5)`.

# Version intervals view

asVersionIntervals :: VersionRange -> [VersionInterval] Source #

View a `VersionRange` as a union of intervals.

This provides a canonical view of the semantics of a `VersionRange` as opposed to the syntax of the expression used to define it. For the syntactic view use `foldVersionRange`.

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 `&& 2`).

Other checks are trivial to implement using this view. For example:

    isNoVersion vr | [] <- asVersionIntervals vr = True
                   | otherwise                   = False

    isSpecificVersion vr
       | [(LowerBound v  InclusiveBound
          ,UpperBound v' InclusiveBound)] <- asVersionIntervals vr
       , v == v'   = Just v
       | otherwise = Nothing

type VersionInterval = (LowerBound, UpperBound) Source #

data LowerBound Source #

Constructors

LowerBound Version !Bound |

Instances

Eq LowerBound # |
Methods (==) :: LowerBound -> LowerBound -> Bool # (/=) :: LowerBound -> LowerBound -> Bool #
Ord LowerBound # |
Methods compare :: LowerBound -> LowerBound -> Ordering # (<) :: LowerBound -> LowerBound -> Bool # (<=) :: LowerBound -> LowerBound -> Bool # (>) :: LowerBound -> LowerBound -> Bool # (>=) :: LowerBound -> LowerBound -> Bool # max :: LowerBound -> LowerBound -> LowerBound # min :: LowerBound -> LowerBound -> LowerBound #
Show LowerBound # |
Methods showsPrec :: Int -> LowerBound -> ShowS Source # show :: LowerBound -> String Source # showList :: [LowerBound] -> ShowS Source #

data UpperBound Source #

Constructors

NoUpperBound |
UpperBound Version !Bound |

Instances

Eq UpperBound # |
Methods (==) :: UpperBound -> UpperBound -> Bool # (/=) :: UpperBound -> UpperBound -> Bool #
Ord UpperBound # |
Methods compare :: UpperBound -> UpperBound -> Ordering # (<) :: UpperBound -> UpperBound -> Bool # (<=) :: UpperBound -> UpperBound -> Bool # (>) :: UpperBound -> UpperBound -> Bool # (>=) :: UpperBound -> UpperBound -> Bool # max :: UpperBound -> UpperBound -> UpperBound # min :: UpperBound -> UpperBound -> UpperBound #
Show UpperBound # |
Methods showsPrec :: Int -> UpperBound -> ShowS Source # show :: UpperBound -> String Source # showList :: [UpperBound] -> ShowS Source #

data Bound Source #

Constructors

ExclusiveBound |
InclusiveBound |

Instances

Eq Bound # |
Methods (==) :: Bound -> Bound -> Bool # (/=) :: Bound -> Bound -> Bool #
Show Bound # |
Methods showsPrec :: Int -> Bound -> ShowS Source # show :: Bound -> String Source # showList :: [Bound] -> ShowS Source #

## `VersionIntervals` abstract type

The `VersionIntervals` type and the accompanying functions are exposed primarily for completeness and testing purposes. In practice `asVersionIntervals` is the main function to use to view a `VersionRange` as a bunch of `VersionInterval`s.

data VersionIntervals Source #

A complementary representation of a `VersionRange`. Instead of a boolean version predicate it uses an increasing sequence of non-overlapping, non-empty intervals.

The key point is that this representation gives a canonical representation for the semantics of `VersionRange`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.

Instances

Eq VersionIntervals # |
Methods (==) :: VersionIntervals -> VersionIntervals -> Bool # (/=) :: VersionIntervals -> VersionIntervals -> Bool #
Show VersionIntervals # |
Methods showsPrec :: Int -> VersionIntervals -> ShowS Source # show :: VersionIntervals -> String Source # showList :: [VersionIntervals] -> ShowS Source #

toVersionIntervals :: VersionRange -> VersionIntervals Source #

Convert a `VersionRange` to a sequence of version intervals.

fromVersionIntervals :: VersionIntervals -> VersionRange Source #

Convert a `VersionIntervals` value back into a `VersionRange` expression representing the version intervals.

withinIntervals :: Version -> VersionIntervals -> Bool Source #

Test if a version falls within the version intervals.

It exists mostly for completeness and testing. It satisfies the following properties:

    withinIntervals v (toVersionIntervals vr) = withinRange v vr
    withinIntervals v ivs = withinRange v (fromVersionIntervals ivs)

versionIntervals :: VersionIntervals -> [VersionInterval] Source #

Inspect the list of version intervals.

mkVersionIntervals :: [VersionInterval] -> Maybe VersionIntervals Source #

Directly construct a `VersionIntervals` from a list of intervals.

Each interval must be non-empty. The sequence must be in increasing order and no intervals may overlap or touch. If any of these conditions are not satisfied the function returns `Nothing`.

unionVersionIntervals :: VersionIntervals -> VersionIntervals -> VersionIntervals Source #

intersectVersionIntervals :: VersionIntervals -> VersionIntervals -> VersionIntervals Source #

invertVersionIntervals :: VersionIntervals -> VersionIntervals Source #