Distribution.Version

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".

Package versions

data Version

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

Defined in Distribution.Types.Version

Methods

(==) :: Version -> Version -> Bool

(/=) :: Version -> Version -> Bool

Data Version

Defined in Distribution.Types.Version

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Version -> c Version

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Version

toConstr :: Version -> Constr

dataTypeOf :: Version -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Version)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Version)

gmapT :: (forall b. Data b => b -> b) -> Version -> Version

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Version -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Version -> r

gmapQ :: (forall d. Data d => d -> u) -> Version -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> Version -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Version -> m Version

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Version -> m Version

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Version -> m Version

Ord Version

Defined in Distribution.Types.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

Defined in Distribution.Types.Version

Methods

readsPrec :: Int -> ReadS Version

readList :: ReadS [Version]

readPrec :: ReadPrec Version

readListPrec :: ReadPrec [Version]

Show Version

Defined in Distribution.Types.Version

Methods

showsPrec :: Int -> Version -> ShowS

show :: Version -> String

showList :: [Version] -> ShowS

Generic Version

Defined in Distribution.Types.Version

Associated Types

type Rep Version :: Type -> Type

Methods

from :: Version -> Rep Version x

to :: Rep Version x -> Version

Binary Version

Defined in Distribution.Types.Version

Methods

put :: Version -> Put

get :: Get Version

putList :: [Version] -> Put

NFData Version

Defined in Distribution.Types.Version

Methods

rnf :: Version -> ()

Structured Version

Defined in Distribution.Types.Version

Methods

structure :: Proxy Version -> Structure

structureHash' :: Tagged Version MD5

Pretty Version

Defined in Distribution.Types.Version

Methods

pretty :: Version -> Doc

prettyVersioned :: CabalSpecVersion -> Version -> Doc

Parsec Version

Defined in Distribution.Types.Version

Methods

parsec :: CabalParsing m => m Version

type Rep Version

Defined in Distribution.Types.Version

type Rep Version = D1 ('MetaData "Version" "Distribution.Types.Version" "Cabal-3.4.1.0-6DL0OBffl0FKxcw4uMtLyp" 'False) (C1 ('MetaCons "PV0" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 Word64)) :+: C1 ('MetaCons "PV1" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Int])))

version0 :: Version

Version 0. A lower bound of Version.

Since: 2.2

mkVersion :: [Int] -> Version

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

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

Since: 2.0.0.2

versionNumbers :: Version -> [Int]

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

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

Apply function to list of version number components

alterVersion f == mkVersion . f . versionNumbers

Since: 2.0.0.2

Version ranges

data VersionRange

Instances

Eq VersionRange

Defined in Distribution.Types.VersionRange.Internal

Methods

(==) :: VersionRange -> VersionRange -> Bool

(/=) :: VersionRange -> VersionRange -> Bool

Data VersionRange

Defined in Distribution.Types.VersionRange.Internal

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> VersionRange -> c VersionRange

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c VersionRange

toConstr :: VersionRange -> Constr

dataTypeOf :: VersionRange -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c VersionRange)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c VersionRange)

gmapT :: (forall b. Data b => b -> b) -> VersionRange -> VersionRange

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> VersionRange -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> VersionRange -> r

gmapQ :: (forall d. Data d => d -> u) -> VersionRange -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> VersionRange -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> VersionRange -> m VersionRange

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> VersionRange -> m VersionRange

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> VersionRange -> m VersionRange

Read VersionRange

Defined in Distribution.Types.VersionRange.Internal

Methods

readsPrec :: Int -> ReadS VersionRange

readList :: ReadS [VersionRange]

readPrec :: ReadPrec VersionRange

readListPrec :: ReadPrec [VersionRange]

Show VersionRange

Defined in Distribution.Types.VersionRange.Internal

Methods

showsPrec :: Int -> VersionRange -> ShowS

show :: VersionRange -> String

showList :: [VersionRange] -> ShowS

Generic VersionRange

Defined in Distribution.Types.VersionRange.Internal

Associated Types

type Rep VersionRange :: Type -> Type

Methods

from :: VersionRange -> Rep VersionRange x

to :: Rep VersionRange x -> VersionRange

Binary VersionRange

Defined in Distribution.Types.VersionRange.Internal

Methods

put :: VersionRange -> Put

get :: Get VersionRange

putList :: [VersionRange] -> Put

NFData VersionRange

Defined in Distribution.Types.VersionRange.Internal

Methods

rnf :: VersionRange -> ()

Structured VersionRange

Defined in Distribution.Types.VersionRange.Internal

Methods

structure :: Proxy VersionRange -> Structure

structureHash' :: Tagged VersionRange MD5

Pretty VersionRange

>>> fmap pretty (simpleParsec' CabalSpecV1_6 "== 3.2.*" :: Maybe VersionRange)
Just >=3.2 && <3.3

>>> fmap (prettyVersioned CabalSpecV1_6) (simpleParsec' CabalSpecV1_6 "== 3.2.*" :: Maybe VersionRange)
Just ==3.2.*

>>> fmap pretty (simpleParsec' CabalSpecV1_6 "-any" :: Maybe VersionRange)
Just >=0

>>> fmap (prettyVersioned CabalSpecV1_6) (simpleParsec' CabalSpecV1_6 "-any" :: Maybe VersionRange)
Just >=0

Defined in Distribution.Types.VersionRange.Internal

Methods

pretty :: VersionRange -> Doc

prettyVersioned :: CabalSpecVersion -> VersionRange -> Doc

Parsec VersionRange

>>> simpleParsec "^>= 3.4" :: Maybe VersionRange
Just (MajorBoundVersion (mkVersion [3,4]))

Small history:

-any and -none removed in 3.4 Use >=0 and <0 instead.

>>> map (`simpleParsec'` "-none") [CabalSpecV3_0, CabalSpecV3_4] :: [Maybe VersionRange]
[Just (EarlierVersion (mkVersion [0])),Nothing]

Set operations are introduced in 3.0

>>> map (`simpleParsec'` "^>= { 1.2 , 1.3 }") [CabalSpecV2_4, CabalSpecV3_0] :: [Maybe VersionRange]
[Nothing,Just (UnionVersionRanges (MajorBoundVersion (mkVersion [1,2])) (MajorBoundVersion (mkVersion [1,3])))]

^>= is introduced in 2.0

>>> map (`simpleParsec'` "^>=1.2") [CabalSpecV1_24, CabalSpecV2_0] :: [Maybe VersionRange]
[Nothing,Just (MajorBoundVersion (mkVersion [1,2]))]

-none is introduced in 1.22

>>> map (`simpleParsec'` "-none") [CabalSpecV1_20, CabalSpecV1_22] :: [Maybe VersionRange]
[Nothing,Just (EarlierVersion (mkVersion [0]))]

Operators are introduced in 1.8. Issues only a warning.

>>> map (`simpleParsecW'` "== 1 || ==2") [CabalSpecV1_6, CabalSpecV1_8] :: [Maybe VersionRange]
[Nothing,Just (UnionVersionRanges (ThisVersion (mkVersion [1])) (ThisVersion (mkVersion [2])))]

Wild-version ranges are introduced in 1.6. Issues only a warning.

>>> map (`simpleParsecW'` "== 1.2.*") [CabalSpecV1_4, CabalSpecV1_6] :: [Maybe VersionRange]
[Nothing,Just (IntersectVersionRanges (OrLaterVersion (mkVersion [1,2])) (EarlierVersion (mkVersion [1,3])))]

Defined in Distribution.Types.VersionRange.Internal

Methods

parsec :: CabalParsing m => m VersionRange

Newtype (CompilerFlavor, VersionRange) TestedWith

Defined in Distribution.FieldGrammar.Newtypes

Methods

pack :: (CompilerFlavor, VersionRange) -> TestedWith

unpack :: TestedWith -> (CompilerFlavor, VersionRange)

type Rep VersionRange

Defined in Distribution.Types.VersionRange.Internal

type Rep VersionRange = D1 ('MetaData "VersionRange" "Distribution.Types.VersionRange.Internal" "Cabal-3.4.1.0-6DL0OBffl0FKxcw4uMtLyp" 'False) (((C1 ('MetaCons "ThisVersion" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Version)) :+: C1 ('MetaCons "LaterVersion" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Version))) :+: (C1 ('MetaCons "OrLaterVersion" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Version)) :+: C1 ('MetaCons "EarlierVersion" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Version)))) :+: ((C1 ('MetaCons "OrEarlierVersion" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Version)) :+: C1 ('MetaCons "MajorBoundVersion" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Version))) :+: (C1 ('MetaCons "UnionVersionRanges" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 VersionRange) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 VersionRange)) :+: C1 ('MetaCons "IntersectVersionRanges" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 VersionRange) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 VersionRange)))))

Constructing

anyVersion :: VersionRange

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

withinRange v anyVersion = True

noVersion :: VersionRange

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

This can be constructed using any unsatisfiable version range expression, for example < 0.

withinRange v noVersion = False

thisVersion :: Version -> VersionRange

The version range == v

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

notThisVersion :: Version -> VersionRange

The version range || v

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

laterVersion :: Version -> VersionRange

The version range > v

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

earlierVersion :: Version -> VersionRange

The version range < v

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

orLaterVersion :: Version -> VersionRange

The version range >= v

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

orEarlierVersion :: Version -> VersionRange

The version range <= v

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

unionVersionRanges :: VersionRange -> VersionRange -> VersionRange

The version range vr1 || vr2

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

intersectVersionRanges :: VersionRange -> VersionRange -> VersionRange

The version range vr1 && vr2

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

differenceVersionRanges :: VersionRange -> VersionRange -> VersionRange

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

The inverse of a version range

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

withinVersion :: Version -> VersionRange

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

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

Inspection

withinRange :: Version -> VersionRange -> Bool

Does this version fall within the given range?

This is the evaluation function for the VersionRange type.

isAnyVersion :: VersionRange -> Bool

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

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

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

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

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.

normaliseVersionRange :: VersionRange -> VersionRange

Normalise VersionRange.

In particular collapse (== v || > v) into >= v, and so on.

stripParensVersionRange :: VersionRange -> VersionRange

Remove VersionRangeParens constructors.

Since version 3.4 this function is id, there aren't VersionRangeParens constructor in VersionRange anymore.

Since: 2.2

hasUpperBound :: VersionRange -> Bool

Does the version range have an upper bound?

Since: 1.24.0.0

hasLowerBound :: VersionRange -> Bool

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

Cata & ana

data VersionRangeF a

F-Algebra of VersionRange. See cataVersionRange.

Since: 2.2

Constructors

ThisVersionF Version

LaterVersionF Version

OrLaterVersionF Version

EarlierVersionF Version

OrEarlierVersionF Version

MajorBoundVersionF Version

UnionVersionRangesF a a

IntersectVersionRangesF a a

Instances

Functor VersionRangeF

Defined in Distribution.Types.VersionRange.Internal

Methods

fmap :: (a -> b) -> VersionRangeF a -> VersionRangeF b

(<$) :: a -> VersionRangeF b -> VersionRangeF a

Foldable VersionRangeF

Defined in Distribution.Types.VersionRange.Internal

Methods

fold :: Monoid m => VersionRangeF m -> m

foldMap :: Monoid m => (a -> m) -> VersionRangeF a -> m

foldMap' :: Monoid m => (a -> m) -> VersionRangeF a -> m

foldr :: (a -> b -> b) -> b -> VersionRangeF a -> b

foldr' :: (a -> b -> b) -> b -> VersionRangeF a -> b

foldl :: (b -> a -> b) -> b -> VersionRangeF a -> b

foldl' :: (b -> a -> b) -> b -> VersionRangeF a -> b

foldr1 :: (a -> a -> a) -> VersionRangeF a -> a

foldl1 :: (a -> a -> a) -> VersionRangeF a -> a

toList :: VersionRangeF a -> [a]

null :: VersionRangeF a -> Bool

length :: VersionRangeF a -> Int

elem :: Eq a => a -> VersionRangeF a -> Bool

maximum :: Ord a => VersionRangeF a -> a

minimum :: Ord a => VersionRangeF a -> a

sum :: Num a => VersionRangeF a -> a

product :: Num a => VersionRangeF a -> a

Traversable VersionRangeF

Defined in Distribution.Types.VersionRange.Internal

Methods

traverse :: Applicative f => (a -> f b) -> VersionRangeF a -> f (VersionRangeF b)

sequenceA :: Applicative f => VersionRangeF (f a) -> f (VersionRangeF a)

mapM :: Monad m => (a -> m b) -> VersionRangeF a -> m (VersionRangeF b)

sequence :: Monad m => VersionRangeF (m a) -> m (VersionRangeF a)

Eq a => Eq (VersionRangeF a)

Defined in Distribution.Types.VersionRange.Internal

Methods

(==) :: VersionRangeF a -> VersionRangeF a -> Bool

(/=) :: VersionRangeF a -> VersionRangeF a -> Bool

Data a => Data (VersionRangeF a)

Defined in Distribution.Types.VersionRange.Internal

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> VersionRangeF a -> c (VersionRangeF a)

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c (VersionRangeF a)

toConstr :: VersionRangeF a -> Constr

dataTypeOf :: VersionRangeF a -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c (VersionRangeF a))

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c (VersionRangeF a))

gmapT :: (forall b. Data b => b -> b) -> VersionRangeF a -> VersionRangeF a

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> VersionRangeF a -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> VersionRangeF a -> r

gmapQ :: (forall d. Data d => d -> u) -> VersionRangeF a -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> VersionRangeF a -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> VersionRangeF a -> m (VersionRangeF a)

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> VersionRangeF a -> m (VersionRangeF a)

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> VersionRangeF a -> m (VersionRangeF a)

Read a => Read (VersionRangeF a)

Defined in Distribution.Types.VersionRange.Internal

Methods

readsPrec :: Int -> ReadS (VersionRangeF a)

readList :: ReadS [VersionRangeF a]

readPrec :: ReadPrec (VersionRangeF a)

readListPrec :: ReadPrec [VersionRangeF a]

Show a => Show (VersionRangeF a)

Defined in Distribution.Types.VersionRange.Internal

Methods

showsPrec :: Int -> VersionRangeF a -> ShowS

show :: VersionRangeF a -> String

showList :: [VersionRangeF a] -> ShowS

Generic (VersionRangeF a)

Defined in Distribution.Types.VersionRange.Internal

Associated Types

type Rep (VersionRangeF a) :: Type -> Type

Methods

from :: VersionRangeF a -> Rep (VersionRangeF a) x

to :: Rep (VersionRangeF a) x -> VersionRangeF a

type Rep (VersionRangeF a)

Defined in Distribution.Types.VersionRange.Internal

type Rep (VersionRangeF a) = D1 ('MetaData "VersionRangeF" "Distribution.Types.VersionRange.Internal" "Cabal-3.4.1.0-6DL0OBffl0FKxcw4uMtLyp" 'False) (((C1 ('MetaCons "ThisVersionF" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Version)) :+: C1 ('MetaCons "LaterVersionF" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Version))) :+: (C1 ('MetaCons "OrLaterVersionF" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Version)) :+: C1 ('MetaCons "EarlierVersionF" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Version)))) :+: ((C1 ('MetaCons "OrEarlierVersionF" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Version)) :+: C1 ('MetaCons "MajorBoundVersionF" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Version))) :+: (C1 ('MetaCons "UnionVersionRangesF" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 a) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 a)) :+: C1 ('MetaCons "IntersectVersionRangesF" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 a) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 a)))))

cataVersionRange :: (VersionRangeF a -> a) -> VersionRange -> a

Fold VersionRange.

Since: 2.2

anaVersionRange :: (a -> VersionRangeF a) -> a -> VersionRange

Unfold VersionRange.

Since: 2.2

hyloVersionRange :: (VersionRangeF VersionRange -> VersionRange) -> (VersionRange -> VersionRangeF VersionRange) -> VersionRange -> VersionRange

Refold VersionRange

Since: 2.2

projectVersionRange :: VersionRange -> VersionRangeF VersionRange

Since: 2.2

embedVersionRange :: VersionRangeF VersionRange -> VersionRange

Since: 2.2

Utilities

wildcardUpperBound :: Version -> Version

Since: 2.2

majorUpperBound :: Version -> Version

Compute next greater major version to be used as upper bound

Example: 0.4.1 produces the version 0.5 which then can be used to construct a range >= 0.4.1 && < 0.5

Since: 2.2

Modification

removeUpperBound :: VersionRange -> VersionRange

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

removeLowerBound :: VersionRange -> VersionRange

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]

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)

data LowerBound

Constructors

LowerBound Version !Bound

Instances

Eq LowerBound

Defined in Distribution.Types.VersionInterval

Methods

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

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

Ord LowerBound

Defined in Distribution.Types.VersionInterval

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

Defined in Distribution.Types.VersionInterval

Methods

showsPrec :: Int -> LowerBound -> ShowS

show :: LowerBound -> String

showList :: [LowerBound] -> ShowS

data UpperBound

Constructors

NoUpperBound

UpperBound Version !Bound

Instances

Eq UpperBound

Defined in Distribution.Types.VersionInterval

Methods

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

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

Ord UpperBound

Defined in Distribution.Types.VersionInterval

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

Defined in Distribution.Types.VersionInterval

Methods

showsPrec :: Int -> UpperBound -> ShowS

show :: UpperBound -> String

showList :: [UpperBound] -> ShowS

data Bound

Constructors

ExclusiveBound

InclusiveBound

Instances

Eq Bound

Defined in Distribution.Types.VersionInterval

Methods

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

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

Show Bound

Defined in Distribution.Types.VersionInterval

Methods

showsPrec :: Int -> Bound -> ShowS

show :: Bound -> String

showList :: [Bound] -> ShowS

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 VersionIntervals.

data VersionIntervals

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 VersionRanges. 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

Defined in Distribution.Types.VersionInterval

Methods

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

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

Show VersionIntervals

Defined in Distribution.Types.VersionInterval

Methods

showsPrec :: Int -> VersionIntervals -> ShowS

show :: VersionIntervals -> String

showList :: [VersionIntervals] -> ShowS

toVersionIntervals :: VersionRange -> VersionIntervals

Convert a VersionRange to a sequence of version intervals.

fromVersionIntervals :: VersionIntervals -> VersionRange

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

withinIntervals :: Version -> VersionIntervals -> Bool

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]

Inspect the list of version intervals.

mkVersionIntervals :: [VersionInterval] -> VersionIntervals

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

intersectVersionIntervals :: VersionIntervals -> VersionIntervals -> VersionIntervals

invertVersionIntervals :: VersionIntervals -> VersionIntervals