Cabal-3.2.1.0: A framework for packaging Haskell software
Safe Haskell None
Language Haskell2010

Distribution.Types.VersionInterval

Synopsis

Version intervals

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

Instances details
Eq VersionIntervals Source #
Instance details

Defined in Distribution.Types.VersionInterval

Methods

(==) :: VersionIntervals -> VersionIntervals -> Bool Source #

(/=) :: VersionIntervals -> VersionIntervals -> Bool Source #

Show VersionIntervals Source #
Instance details

Defined in Distribution.Types.VersionInterval

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 ] -> VersionIntervals Source #

Directly construct a VersionIntervals from a list of intervals.

In Cabal-2.2 the Maybe is dropped from the result type.

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

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

invertVersionIntervals :: VersionIntervals -> VersionIntervals Source #

relaxLastInterval :: VersionIntervals -> VersionIntervals Source #

relaxHeadInterval :: VersionIntervals -> VersionIntervals Source #

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

Instances details
Eq LowerBound Source #
Instance details

Defined in Distribution.Types.VersionInterval

Methods

(==) :: LowerBound -> LowerBound -> Bool Source #

(/=) :: LowerBound -> LowerBound -> Bool Source #

Ord LowerBound Source #
Instance details

Defined in Distribution.Types.VersionInterval

Methods

compare :: LowerBound -> LowerBound -> Ordering Source #

(<) :: LowerBound -> LowerBound -> Bool Source #

(<=) :: LowerBound -> LowerBound -> Bool Source #

(>) :: LowerBound -> LowerBound -> Bool Source #

(>=) :: LowerBound -> LowerBound -> Bool Source #

max :: LowerBound -> LowerBound -> LowerBound Source #

min :: LowerBound -> LowerBound -> LowerBound Source #

Show LowerBound Source #
Instance details

Defined in Distribution.Types.VersionInterval

Methods

showsPrec :: Int -> LowerBound -> ShowS Source #

show :: LowerBound -> String Source #

showList :: [ LowerBound ] -> ShowS Source #

data UpperBound Source #

Constructors

NoUpperBound
UpperBound Version ! Bound

Instances

Instances details
Eq UpperBound Source #
Instance details

Defined in Distribution.Types.VersionInterval

Methods

(==) :: UpperBound -> UpperBound -> Bool Source #

(/=) :: UpperBound -> UpperBound -> Bool Source #

Ord UpperBound Source #
Instance details

Defined in Distribution.Types.VersionInterval

Methods

compare :: UpperBound -> UpperBound -> Ordering Source #

(<) :: UpperBound -> UpperBound -> Bool Source #

(<=) :: UpperBound -> UpperBound -> Bool Source #

(>) :: UpperBound -> UpperBound -> Bool Source #

(>=) :: UpperBound -> UpperBound -> Bool Source #

max :: UpperBound -> UpperBound -> UpperBound Source #

min :: UpperBound -> UpperBound -> UpperBound Source #

Show UpperBound Source #
Instance details

Defined in Distribution.Types.VersionInterval

Methods

showsPrec :: Int -> UpperBound -> ShowS Source #

show :: UpperBound -> String Source #

showList :: [ UpperBound ] -> ShowS Source #

data Bound Source #

Constructors

ExclusiveBound
InclusiveBound

Instances

Instances details
Eq Bound Source #
Instance details

Defined in Distribution.Types.VersionInterval

Methods

(==) :: Bound -> Bound -> Bool Source #

(/=) :: Bound -> Bound -> Bool Source #

Show Bound Source #
Instance details

Defined in Distribution.Types.VersionInterval

Methods

showsPrec :: Int -> Bound -> ShowS Source #

show :: Bound -> String Source #

showList :: [ Bound ] -> ShowS Source #