ModuleCabal-syntax-3.12.1.0Haskell2010

Distribution.Types.VersionRange.Internal

The only purpose of this module is to prevent the export of VersionRange constructors from Distribution.Types.VersionRange. To avoid creating orphan instances, a lot of related code had to be moved here too.

2 types
20 values

PackageCabal-syntax-3.12.1.0
Exports22
LanguageHaskell2010
LicenceBSD-3-Clause
SourceInternal.hs

datadata VersionRange

Constructors

ThisVersion Version
LaterVersion Version
OrLaterVersion Version
EarlierVersion Version
OrEarlierVersion Version
MajorBoundVersion Version
UnionVersionRanges VersionRange VersionRange
IntersectVersionRanges VersionRange VersionRange

Instances13Eq, Data, Ord, Read, Show, Generic, …

Eq VersionRangeDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.VersionRange.Internal
Data VersionRangeDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.VersionRange.Internal
Ord VersionRangeDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.VersionRange.Internal
Read VersionRangeDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.VersionRange.Internal
Show VersionRangeDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.VersionRange.Internal
Generic VersionRangeDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.VersionRange.Internal
NFData VersionRangeDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.VersionRange.Internal
Binary VersionRangeDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.VersionRange.Internal

Parsec VersionRangeDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.VersionRange.Internal

Example1 expression

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

Small history:

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

Example1 expression

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

Set operations are introduced in 3.0

Example1 expression

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

Example1 expression

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

-none is introduced in 1.22

Example1 expression

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

Operators are introduced in 1.8. Issues only a warning.

Example1 expression

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

Example1 expression

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

Pretty VersionRangeDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.VersionRange.Internal

Example1 expression

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

Example1 expression

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

Example1 expression

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

Example1 expression

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

Structured VersionRangeDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.VersionRange.Internal
Newtype (CompilerFlavor, VersionRange) TestedWithDefined in Cabal-syntax-3.12.1.0 · Distribution.FieldGrammar.Newtypes
type Rep VersionRange = D1 ('MetaData "VersionRange" "Distribution.Types.VersionRange.Internal" "Cabal-syntax-3.12.1.0-3adc" 'False) (((C1 ('MetaCons "ThisVersion" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Version)) :+: C1 ('MetaCons "LaterVersion" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Version))) :+: (C1 ('MetaCons "OrLaterVersion" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Version)) :+: C1 ('MetaCons "EarlierVersion" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Version)))) :+: ((C1 ('MetaCons "OrEarlierVersion" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Version)) :+: C1 ('MetaCons "MajorBoundVersion" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Version))) :+: (C1 ('MetaCons "UnionVersionRanges" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 VersionRange) :*: S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 VersionRange)) :+: C1 ('MetaCons "IntersectVersionRanges" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 VersionRange) :*: S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 VersionRange)))))Defined in Cabal-syntax-3.12.1.0 · Distribution.Types.VersionRange.Internal

valueanyVersion :: VersionRange

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

withinRange v anyVersion = True

valuenoVersion :: VersionRange

The empty version range -none, 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

valuethisVersion :: Version -> VersionRange

The version range == v.

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

valuenotThisVersion :: Version -> VersionRange

The version range /= v.

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

valuelaterVersion :: Version -> VersionRange

The version range > v.

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

valueearlierVersion :: Version -> VersionRange

The version range < v.

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

valueorLaterVersion :: Version -> VersionRange

The version range >= v.

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

valueorEarlierVersion :: Version -> VersionRange

The version range <= v.

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

valueunionVersionRanges :: VersionRange -> VersionRange -> VersionRange

The version range vr1 || vr2.

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

valueintersectVersionRanges :: VersionRange -> VersionRange -> VersionRange

The version range vr1 && vr2.

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

valuewithinVersion :: 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' (withinVersion v) = v' >= v && v' < upper v
  where
    upper (Version lower t) = Version (init lower ++ [last lower + 1]) t

valuemajorBoundVersion :: 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.

datadata VersionRangeF a

F-Algebra of VersionRange. See cataVersionRange.

Constructors

ThisVersionF Version
== version.
LaterVersionF Version
> version. NB: not >=
OrLaterVersionF Version
>= version.
EarlierVersionF Version
< version.
OrEarlierVersionF Version
<= version.
MajorBoundVersionF Version
^>= version, same as >= version && < MAJ(version)+1.
UnionVersionRangesF a a
||.
IntersectVersionRangesF a a
&&.

Instances9Functor, Foldable, Traversable, Eq, Data, Read, …

Functor VersionRangeFDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.VersionRange.Internal
Foldable VersionRangeFDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.VersionRange.Internal
Traversable VersionRangeFDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.VersionRange.Internal
Eq a => Eq (VersionRangeF a)Defined in Cabal-syntax-3.12.1.0 · Distribution.Types.VersionRange.Internal
Data a => Data (VersionRangeF a)Defined in Cabal-syntax-3.12.1.0 · Distribution.Types.VersionRange.Internal
Read a => Read (VersionRangeF a)Defined in Cabal-syntax-3.12.1.0 · Distribution.Types.VersionRange.Internal
Show a => Show (VersionRangeF a)Defined in Cabal-syntax-3.12.1.0 · Distribution.Types.VersionRange.Internal
Generic (VersionRangeF a)Defined in Cabal-syntax-3.12.1.0 · Distribution.Types.VersionRange.Internal
type Rep (VersionRangeF a) = D1 ('MetaData "VersionRangeF" "Distribution.Types.VersionRange.Internal" "Cabal-syntax-3.12.1.0-3adc" 'False) (((C1 ('MetaCons "ThisVersionF" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Version)) :+: C1 ('MetaCons "LaterVersionF" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Version))) :+: (C1 ('MetaCons "OrLaterVersionF" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Version)) :+: C1 ('MetaCons "EarlierVersionF" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Version)))) :+: ((C1 ('MetaCons "OrEarlierVersionF" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Version)) :+: C1 ('MetaCons "MajorBoundVersionF" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Version))) :+: (C1 ('MetaCons "UnionVersionRangesF" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 a) :*: S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 a)) :+: C1 ('MetaCons "IntersectVersionRangesF" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 a) :*: S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 a)))))Defined in Cabal-syntax-3.12.1.0 · Distribution.Types.VersionRange.Internal

valueprojectVersionRange :: VersionRange -> VersionRangeF VersionRange

Generic destructor for VersionRange.

valueembedVersionRange :: VersionRangeF VersionRange -> VersionRange

Generic constructor for VersionRange.

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

Fold VersionRange.

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

Unfold VersionRange.

valuehyloVersionRange

:: VersionRangeF VersionRange -> VersionRange
-> VersionRange -> VersionRangeF VersionRange
-> VersionRange
-> VersionRange

Refold VersionRange.

valueversionRangeParser

:: CabalParsing m
=> m Int
-> CabalSpecVersion
-> m VersionRange

VersionRange parser parametrised by version digit parser.

versionDigitParser is used for all VersionRange.
integral is used for backward-compat pkgconfig-depends versions, PkgConfigVersionRange.

valuemajorUpperBound :: 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

valuewildcardUpperBound :: Version -> Version

Increment the last version number.

Example: For 1.2 this returns 1.3 so that it can be used as upper bound when resolving == 1.2.*. For 0.4.1 it returns 0.4.2.