-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | Types and parsers for software version numbers.
--   
--   A library for parsing and comparing software version numbers. We like
--   to give version numbers to our software in a myriad of ways. Some ways
--   follow strict guidelines for incrementing and comparison. Some follow
--   conventional wisdom and are generally self-consistent. Some are just
--   plain asinine. This library provides a means of parsing and comparing
--   <i>any</i> style of versioning, be it a nice Semantic Version like
--   this:
--   
--   <pre>
--   1.2.3-r1+git123
--   </pre>
--   
--   ...or a monstrosity like this:
--   
--   <pre>
--   2:10.2+0.0093r3+1-1
--   </pre>
--   
--   Please switch to <a>Semantic Versioning</a> if you aren't currently
--   using it. It provides consistency in version incrementing and has the
--   best constraints on comparisons.
@package versions
@version 3.3.1


-- | A library for parsing and comparing software version numbers.
--   
--   We like to give version numbers to our software in a myriad of
--   different ways. Some ways follow strict guidelines for incrementing
--   and comparison. Some follow conventional wisdom and are generally
--   self-consistent. Some are just plain asinine. This library provides a
--   means of parsing and comparing <i>any</i> style of versioning, be it a
--   nice Semantic Version like this:
--   
--   <pre>
--   1.2.3-r1+git123
--   </pre>
--   
--   ...or a monstrosity like this:
--   
--   <pre>
--   2:10.2+0.0093r3+1-1
--   </pre>
--   
--   Please switch to <a>Semantic Versioning</a> if you aren't currently
--   using it. It provides consistency in version incrementing and has the
--   best constraints on comparisons.
--   
--   <h2>Using the Parsers</h2>
--   
--   In general, <a>parseV</a> is the function you want. It attempts to
--   parse a given <tt>Text</tt> using the three individual parsers,
--   <a>semver</a>, <a>version</a> and <a>mess</a>. If one fails, it tries
--   the next. If you know you only want to parse one specific version
--   type, use that parser directly (e.g. <a>semver</a>).
module Data.Versions

-- | A top-level Versioning type. Acts as a wrapper for the more specific
--   types. This allows each subtype to have its own parser, and for said
--   parsers to be composed. This is useful for specifying custom behaviour
--   for when a certain parser fails.
data Versioning
Ideal :: SemVer -> Versioning
General :: Version -> Versioning
Complex :: Mess -> Versioning

-- | An (Ideal) version number that conforms to Semantic Versioning. This
--   is a <i>prescriptive</i> parser, meaning it follows the SemVer
--   standard.
--   
--   Legal semvers are of the form: MAJOR.MINOR.PATCH-PREREL+META
--   
--   Example: 1.2.3-r1+commithash
--   
--   Extra Rules:
--   
--   <ol>
--   <li>Pre-release versions have <i>lower</i> precedence than normal
--   versions.</li>
--   <li>Build metadata does not affect version precedence.</li>
--   <li>PREREL and META strings may only contain ASCII alphanumerics.</li>
--   </ol>
--   
--   For more information, see <a>http://semver.org</a>
data SemVer
SemVer :: Word -> Word -> Word -> [VChunk] -> [VChunk] -> SemVer
[_svMajor] :: SemVer -> Word
[_svMinor] :: SemVer -> Word
[_svPatch] :: SemVer -> Word
[_svPreRel] :: SemVer -> [VChunk]
[_svMeta] :: SemVer -> [VChunk]

-- | A (General) Version. Not quite as ideal as a <a>SemVer</a>, but has
--   some internal consistancy from version to version. Generally conforms
--   to the <tt>x.x.x-x</tt> pattern, and may optionally have an
--   <i>epoch</i>. These are prefixes marked by a colon, like in
--   <tt>1:2.3.4</tt>.
--   
--   Examples of <tt>Version</tt> that are not <tt>SemVer</tt>: 0.25-2,
--   8.u51-1, 20150826-1, 1:2.3.4
data Version
Version :: Maybe Word -> [VChunk] -> [VChunk] -> Version
[_vEpoch] :: Version -> Maybe Word
[_vChunks] :: Version -> [VChunk]
[_vRel] :: Version -> [VChunk]

-- | A (Complex) Mess. This is a <i>descriptive</i> parser, based on
--   examples of stupidly crafted version numbers used in the wild.
--   
--   Groups of letters/numbers, separated by a period, can be further
--   separated by the symbols <tt>_-+:</tt>
--   
--   Unfortunately, <tt>VChunk</tt>s cannot be used here, as some
--   developers have numbers like <tt>1.003.04</tt> which make parsers
--   quite sad.
--   
--   Not guaranteed to have well-defined ordering (<tt>Ord</tt>) behaviour,
--   but so far internal tests show consistency.
data Mess
VLeaf :: [Text] -> Mess
VNode :: [Text] -> VSep -> Mess -> Mess

-- | A single unit of a Version. May be digits or a string of characters.
--   Groups of these are called <a>VChunk</a>s, and are the identifiers
--   separated by periods in the source.
data VUnit
Digits :: Word -> VUnit
Str :: Text -> VUnit

-- | Smart constructor for a <a>VUnit</a> made of digits.
digits :: Word -> VUnit

-- | Smart constructor for a <a>VUnit</a> made of letters.
str :: Text -> Maybe VUnit

-- | A logical unit of a version number. Can consist of multiple letters
--   and numbers.
type VChunk = [VUnit]

-- | Developers use a number of symbols to seperate groups of
--   digits/letters in their version numbers. These are:
--   
--   <ul>
--   <li>A colon (:). Often denotes an "epoch".</li>
--   <li>A hyphen (-).</li>
--   <li>A plus (+). Stop using this outside of metadata if you are.
--   Example: <tt>10.2+0.93+1-1</tt></li>
--   <li>An underscore (_). Stop using this if you are.</li>
--   </ul>
data VSep
VColon :: VSep
VHyphen :: VSep
VPlus :: VSep
VUnder :: VSep

-- | A wrapper for a parser function. Can be composed via their Monoid
--   instance, such that a different parser can be tried if a previous one
--   fails.
newtype VParser
VParser :: (Text -> Either ParsingError Versioning) -> VParser
[runVP] :: VParser -> Text -> Either ParsingError Versioning

-- | A synonym for the more verbose <tt>megaparsec</tt> error type.
type ParsingError = ParseError (Token Text) Void

-- | Parse a (Ideal) Semantic Version.
semver :: Text -> Either ParsingError SemVer

-- | Parse a (General) <a>Version</a>, as defined above.
version :: Text -> Either ParsingError Version

-- | Parse a (Complex) <a>Mess</a>, as defined above.
mess :: Text -> Either ParsingError Mess

-- | Parse a piece of <a>Text</a> into either an (Ideal) <a>SemVer</a>, a
--   (General) <a>Version</a>, or a (Complex) <a>Mess</a>.
parseV :: Text -> Either ParsingError Versioning

-- | A wrapped <a>SemVer</a> parser. Can be composed with other parsers.
semverP :: VParser

-- | A wrapped <a>Version</a> parser. Can be composed with other parsers.
versionP :: VParser

-- | A wrapped <a>Mess</a> parser. Can be composed with other parsers.
messP :: VParser

-- | Internal megaparsec parser of <a>semverP</a>.
semver' :: Parsec Void Text SemVer

-- | Internal megaparsec parser of <a>versionP</a>.
version' :: Parsec Void Text Version

-- | Internal megaparsec parser of <a>messP</a>.
mess' :: Parsec Void Text Mess

-- | Convert any parsed Versioning type to its textual representation.
prettyV :: Versioning -> Text

-- | Convert a <a>SemVer</a> back to its textual representation.
prettySemVer :: SemVer -> Text

-- | Convert a <a>Version</a> back to its textual representation.
prettyVer :: Version -> Text

-- | Convert a <a>Mess</a> back to its textual representation.
prettyMess :: Mess -> Text

-- | Pretty-print a <a>ParseError</a>. The rendered <a>String</a> always
--   ends with a newline.
parseErrorPretty :: (Ord t, ShowToken t, ShowErrorComponent e) => ParseError t e -> String

-- | Simple Lenses compatible with both lens and microlens.
type Lens' s a = forall f. Functor f => (a -> f a) -> s -> f s

-- | Simple Traversals compatible with both lens and microlens.
type Traversal' s a = forall f. Applicative f => (a -> f a) -> s -> f s

-- | Version types which sanely and safely yield <a>SemVer</a>-like
--   information about themselves. For instances other than <a>SemVer</a>
--   itself however, these optics may <i>not</i> yield anything, depending
--   on the actual value being traversed. Hence, the optics here are all
--   <a>Traversal'</a>s.
--   
--   Consider the <a>Version</a> <tt>1.2.3.4.5</tt>. We can imagine wanting
--   to increment the minor number:
--   
--   <pre>
--   λ "1.2.3.4.5" &amp; minor %~ (+ 1)
--   "1.3.3.4.5"
--   </pre>
--   
--   But of course something like this would fail:
--   
--   <pre>
--   λ "1.e.3.4.5" &amp; minor %~ (+ 1)
--   "1.e.3.4.5"
--   </pre>
--   
--   However!
--   
--   <pre>
--   λ "1.e.3.4.5" &amp; major %~ (+ 1)
--   "2.e.3.4.5"
--   </pre>
class Semantic v

-- | <pre>
--   MAJOR.minor.patch-prerel+meta
--   </pre>
major :: Semantic v => Traversal' v Word

-- | <pre>
--   major.MINOR.patch-prerel+meta
--   </pre>
minor :: Semantic v => Traversal' v Word

-- | <pre>
--   major.minor.PATCH-prerel+meta
--   </pre>
patch :: Semantic v => Traversal' v Word

-- | <pre>
--   major.minor.patch-PREREL+meta
--   </pre>
release :: Semantic v => Traversal' v [VChunk]

-- | <pre>
--   major.minor.patch-prerel+META
--   </pre>
meta :: Semantic v => Traversal' v [VChunk]

-- | A Natural Transformation into an proper <a>SemVer</a>.
semantic :: Semantic v => Traversal' v SemVer

-- | Traverse some Text for its inner versioning.
--   
--   <pre>
--   λ "1.2.3" &amp; _Versioning . _Ideal . patch %~ (+ 1)  -- or just: "1.2.3" &amp; patch %~ (+ 1)
--   "1.2.4"
--   </pre>
_Versioning :: Traversal' Text Versioning

-- | Traverse some Text for its inner SemVer.
_SemVer :: Traversal' Text SemVer

-- | Traverse some Text for its inner Version.
_Version :: Traversal' Text Version

-- | Traverse some Text for its inner Mess.
_Mess :: Traversal' Text Mess
_Ideal :: Traversal' Versioning SemVer
_General :: Traversal' Versioning Version
_Complex :: Traversal' Versioning Mess
epoch :: Lens' Version (Maybe Word)
_Digits :: Traversal' VUnit Word
_Str :: Traversal' VUnit Text
instance Data.Hashable.Class.Hashable Data.Versions.Versioning
instance Control.DeepSeq.NFData Data.Versions.Versioning
instance GHC.Generics.Generic Data.Versions.Versioning
instance GHC.Show.Show Data.Versions.Versioning
instance GHC.Classes.Eq Data.Versions.Versioning
instance Data.Hashable.Class.Hashable Data.Versions.Mess
instance Control.DeepSeq.NFData Data.Versions.Mess
instance GHC.Generics.Generic Data.Versions.Mess
instance GHC.Show.Show Data.Versions.Mess
instance GHC.Classes.Eq Data.Versions.Mess
instance Data.Hashable.Class.Hashable Data.Versions.VSep
instance Control.DeepSeq.NFData Data.Versions.VSep
instance GHC.Generics.Generic Data.Versions.VSep
instance GHC.Show.Show Data.Versions.VSep
instance GHC.Classes.Eq Data.Versions.VSep
instance Data.Hashable.Class.Hashable Data.Versions.Version
instance Control.DeepSeq.NFData Data.Versions.Version
instance GHC.Generics.Generic Data.Versions.Version
instance GHC.Show.Show Data.Versions.Version
instance GHC.Classes.Eq Data.Versions.Version
instance Data.Hashable.Class.Hashable Data.Versions.SemVer
instance Control.DeepSeq.NFData Data.Versions.SemVer
instance GHC.Generics.Generic Data.Versions.SemVer
instance GHC.Show.Show Data.Versions.SemVer
instance Data.Hashable.Class.Hashable Data.Versions.VUnit
instance Control.DeepSeq.NFData Data.Versions.VUnit
instance GHC.Generics.Generic Data.Versions.VUnit
instance GHC.Classes.Ord Data.Versions.VUnit
instance GHC.Read.Read Data.Versions.VUnit
instance GHC.Show.Show Data.Versions.VUnit
instance GHC.Classes.Eq Data.Versions.VUnit
instance GHC.Classes.Ord Data.Versions.Versioning
instance Data.Versions.Semantic Data.Versions.Versioning
instance Data.Versions.Semantic Data.Text.Internal.Text
instance GHC.Classes.Eq Data.Versions.SemVer
instance GHC.Classes.Ord Data.Versions.SemVer
instance GHC.Base.Monoid Data.Versions.SemVer
instance Data.Versions.Semantic Data.Versions.SemVer
instance GHC.Base.Monoid Data.Versions.VUnit
instance GHC.Base.Monoid Data.Versions.Version
instance GHC.Classes.Ord Data.Versions.Version
instance Data.Versions.Semantic Data.Versions.Version
instance GHC.Classes.Ord Data.Versions.Mess
instance Data.Versions.Semantic Data.Versions.Mess
instance GHC.Base.Monoid Data.Versions.VParser