using System; using Newtonsoft.Json; using StardewModdingAPI.Framework; namespace StardewModdingAPI { /// A semantic version with an optional release tag. public class SemanticVersion : ISemanticVersion { /********* ** Properties *********/ /// The underlying semantic version implementation. private readonly ISemanticVersion Version; /// Manages deprecation warnings. internal static DeprecationManager DeprecationManager { get; set; } /********* ** Accessors *********/ /// The major version incremented for major API changes. public int MajorVersion => this.Version.MajorVersion; /// The minor version incremented for backwards-compatible changes. public int MinorVersion => this.Version.MinorVersion; /// The patch version for backwards-compatible bug fixes. public int PatchVersion => this.Version.PatchVersion; /// An optional build tag. [Obsolete("Use " + nameof(ISemanticVersion.PrereleaseTag) + " instead")] public string Build { get { SemanticVersion.DeprecationManager?.Warn($"{nameof(ISemanticVersion)}.{nameof(ISemanticVersion.Build)}", "2.8", DeprecationLevel.Notice); return this.Version.PrereleaseTag; } } /// An optional prerelease tag. public string PrereleaseTag => this.Version.PrereleaseTag; /********* ** Public methods *********/ /// Construct an instance. /// The major version incremented for major API changes. /// The minor version incremented for backwards-compatible changes. /// The patch version for backwards-compatible bug fixes. /// An optional build tag. [JsonConstructor] public SemanticVersion(int majorVersion, int minorVersion, int patchVersion, string build = null) : this(new Toolkit.SemanticVersion(majorVersion, minorVersion, patchVersion, build)) { } /// Construct an instance. /// The semantic version string. /// The is null. /// The is not a valid semantic version. public SemanticVersion(string version) : this(new Toolkit.SemanticVersion(version)) { } /// Construct an instance. /// The assembly version. /// The is null. public SemanticVersion(Version version) : this(new Toolkit.SemanticVersion(version)) { } /// Construct an instance. /// The underlying semantic version implementation. internal SemanticVersion(ISemanticVersion version) { this.Version = version; } /// Whether this is a pre-release version. public bool IsPrerelease() { return this.Version.IsPrerelease(); } /// Get an integer indicating whether this version precedes (less than 0), supercedes (more than 0), or is equivalent to (0) the specified version. /// The version to compare with this instance. /// The value is null. /// The implementation is defined by Semantic Version 2.0 (https://semver.org/). public int CompareTo(ISemanticVersion other) { return this.Version.CompareTo(other); } /// Get whether this version is older than the specified version. /// The version to compare with this instance. public bool IsOlderThan(ISemanticVersion other) { return this.Version.IsOlderThan(other); } /// Get whether this version is older than the specified version. /// The version to compare with this instance. /// The specified version is not a valid semantic version. public bool IsOlderThan(string other) { return this.Version.IsOlderThan(other); } /// Get whether this version is newer than the specified version. /// The version to compare with this instance. public bool IsNewerThan(ISemanticVersion other) { return this.Version.IsNewerThan(other); } /// Get whether this version is newer than the specified version. /// The version to compare with this instance. /// The specified version is not a valid semantic version. public bool IsNewerThan(string other) { return this.Version.IsNewerThan(other); } /// Get whether this version is between two specified versions (inclusively). /// The minimum version. /// The maximum version. public bool IsBetween(ISemanticVersion min, ISemanticVersion max) { return this.Version.IsBetween(min, max); } /// Get whether this version is between two specified versions (inclusively). /// The minimum version. /// The maximum version. /// One of the specified versions is not a valid semantic version. public bool IsBetween(string min, string max) { return this.Version.IsBetween(min, max); } /// Indicates whether the current object is equal to another object of the same type. /// true if the current object is equal to the parameter; otherwise, false. /// An object to compare with this object. public bool Equals(ISemanticVersion other) { return other != null && this.CompareTo(other) == 0; } /// Get a string representation of the version. public override string ToString() { return this.Version.ToString(); } /// Parse a version string without throwing an exception if it fails. /// The version string. /// The parsed representation. /// Returns whether parsing the version succeeded. internal static bool TryParse(string version, out ISemanticVersion parsed) { if (Toolkit.SemanticVersion.TryParse(version, out ISemanticVersion versionImpl)) { parsed = new SemanticVersion(versionImpl); return true; } parsed = null; return false; } } }