summaryrefslogtreecommitdiff
path: root/src/SMAPI.Common
diff options
context:
space:
mode:
Diffstat (limited to 'src/SMAPI.Common')
-rw-r--r--src/SMAPI.Common/Models/ModInfoModel.cs56
-rw-r--r--src/SMAPI.Common/Models/ModSeachModel.cs37
-rw-r--r--src/SMAPI.Common/SemanticVersionImpl.cs199
-rw-r--r--src/SMAPI.Common/StardewModdingAPI.Common.projitems19
-rw-r--r--src/SMAPI.Common/StardewModdingAPI.Common.shproj13
5 files changed, 0 insertions, 324 deletions
diff --git a/src/SMAPI.Common/Models/ModInfoModel.cs b/src/SMAPI.Common/Models/ModInfoModel.cs
deleted file mode 100644
index 48df235a..00000000
--- a/src/SMAPI.Common/Models/ModInfoModel.cs
+++ /dev/null
@@ -1,56 +0,0 @@
-namespace StardewModdingAPI.Common.Models
-{
- /// <summary>Generic metadata about a mod.</summary>
- internal class ModInfoModel
- {
- /*********
- ** Accessors
- *********/
- /// <summary>The mod name.</summary>
- public string Name { get; set; }
-
- /// <summary>The semantic version for the mod's latest release.</summary>
- public string Version { get; set; }
-
- /// <summary>The semantic version for the mod's latest preview release, if available and different from <see cref="Version"/>.</summary>
- public string PreviewVersion { get; set; }
-
- /// <summary>The mod's web URL.</summary>
- public string Url { get; set; }
-
- /// <summary>The error message indicating why the mod is invalid (if applicable).</summary>
- public string Error { get; set; }
-
-
- /*********
- ** Public methods
- *********/
- /// <summary>Construct an empty instance.</summary>
- public ModInfoModel()
- {
- // needed for JSON deserialising
- }
-
- /// <summary>Construct an instance.</summary>
- /// <param name="name">The mod name.</param>
- /// <param name="version">The semantic version for the mod's latest release.</param>
- /// <param name="previewVersion">The semantic version for the mod's latest preview release, if available and different from <see cref="Version"/>.</param>
- /// <param name="url">The mod's web URL.</param>
- /// <param name="error">The error message indicating why the mod is invalid (if applicable).</param>
- public ModInfoModel(string name, string version, string url, string previewVersion = null, string error = null)
- {
- this.Name = name;
- this.Version = version;
- this.PreviewVersion = previewVersion;
- this.Url = url;
- this.Error = error; // mainly initialised here for the JSON deserialiser
- }
-
- /// <summary>Construct an instance.</summary>
- /// <param name="error">The error message indicating why the mod is invalid.</param>
- public ModInfoModel(string error)
- {
- this.Error = error;
- }
- }
-}
diff --git a/src/SMAPI.Common/Models/ModSeachModel.cs b/src/SMAPI.Common/Models/ModSeachModel.cs
deleted file mode 100644
index 3c33d0b6..00000000
--- a/src/SMAPI.Common/Models/ModSeachModel.cs
+++ /dev/null
@@ -1,37 +0,0 @@
-using System.Collections.Generic;
-using System.Linq;
-
-namespace StardewModdingAPI.Common.Models
-{
- /// <summary>Specifies mods whose update-check info to fetch.</summary>
- internal class ModSearchModel
- {
- /*********
- ** Accessors
- *********/
- /// <summary>The namespaced mod keys to search.</summary>
- public string[] ModKeys { get; set; }
-
- /// <summary>Whether to allow non-semantic versions, instead of returning an error for those.</summary>
- public bool AllowInvalidVersions { get; set; }
-
-
- /*********
- ** Public methods
- *********/
- /// <summary>Construct an empty instance.</summary>
- public ModSearchModel()
- {
- // needed for JSON deserialising
- }
-
- /// <summary>Construct an instance.</summary>
- /// <param name="modKeys">The namespaced mod keys to search.</param>
- /// <param name="allowInvalidVersions">Whether to allow non-semantic versions, instead of returning an error for those.</param>
- public ModSearchModel(IEnumerable<string> modKeys, bool allowInvalidVersions)
- {
- this.ModKeys = modKeys.ToArray();
- this.AllowInvalidVersions = allowInvalidVersions;
- }
- }
-}
diff --git a/src/SMAPI.Common/SemanticVersionImpl.cs b/src/SMAPI.Common/SemanticVersionImpl.cs
deleted file mode 100644
index 084f56a3..00000000
--- a/src/SMAPI.Common/SemanticVersionImpl.cs
+++ /dev/null
@@ -1,199 +0,0 @@
-using System;
-using System.Text.RegularExpressions;
-
-namespace StardewModdingAPI.Common
-{
- /// <summary>A low-level implementation of a semantic version with an optional release tag.</summary>
- /// <remarks>The implementation is defined by Semantic Version 2.0 (http://semver.org/).</remarks>
- internal class SemanticVersionImpl
- {
- /*********
- ** Accessors
- *********/
- /// <summary>The major version incremented for major API changes.</summary>
- public int Major { get; }
-
- /// <summary>The minor version incremented for backwards-compatible changes.</summary>
- public int Minor { get; }
-
- /// <summary>The patch version for backwards-compatible bug fixes.</summary>
- public int Patch { get; }
-
- /// <summary>An optional prerelease tag.</summary>
- public string Tag { get; }
-
- /// <summary>A regex pattern matching a version within a larger string.</summary>
- internal const string UnboundedVersionPattern = @"(?>(?<major>0|[1-9]\d*))\.(?>(?<minor>0|[1-9]\d*))(?>(?:\.(?<patch>0|[1-9]\d*))?)(?:-(?<prerelease>(?>[a-z0-9]+[\-\.]?)+))?";
-
- /// <summary>A regular expression matching a semantic version string.</summary>
- /// <remarks>
- /// This pattern is derived from the BNF documentation in the <a href="https://github.com/mojombo/semver">semver repo</a>,
- /// with three important deviations intended to support Stardew Valley mod conventions:
- /// - allows short-form "x.y" versions;
- /// - allows hyphens in prerelease tags as synonyms for dots (like "-unofficial-update.3");
- /// - doesn't allow '+build' suffixes.
- /// </remarks>
- internal static readonly Regex Regex = new Regex($@"^{SemanticVersionImpl.UnboundedVersionPattern}$", RegexOptions.CultureInvariant | RegexOptions.IgnoreCase | RegexOptions.Compiled | RegexOptions.ExplicitCapture);
-
- /*********
- ** Public methods
- *********/
- /// <summary>Construct an instance.</summary>
- /// <param name="major">The major version incremented for major API changes.</param>
- /// <param name="minor">The minor version incremented for backwards-compatible changes.</param>
- /// <param name="patch">The patch version for backwards-compatible bug fixes.</param>
- /// <param name="tag">An optional prerelease tag.</param>
- public SemanticVersionImpl(int major, int minor, int patch, string tag = null)
- {
- this.Major = major;
- this.Minor = minor;
- this.Patch = patch;
- this.Tag = this.GetNormalisedTag(tag);
- }
-
- /// <summary>Construct an instance.</summary>
- /// <param name="version">The assembly version.</param>
- /// <exception cref="ArgumentNullException">The <paramref name="version"/> is null.</exception>
- public SemanticVersionImpl(Version version)
- {
- if (version == null)
- throw new ArgumentNullException(nameof(version), "The input version can't be null.");
-
- this.Major = version.Major;
- this.Minor = version.Minor;
- this.Patch = version.Build;
- }
-
- /// <summary>Construct an instance.</summary>
- /// <param name="version">The semantic version string.</param>
- /// <exception cref="ArgumentNullException">The <paramref name="version"/> is null.</exception>
- /// <exception cref="FormatException">The <paramref name="version"/> is not a valid semantic version.</exception>
- public SemanticVersionImpl(string version)
- {
- // parse
- if (version == null)
- throw new ArgumentNullException(nameof(version), "The input version string can't be null.");
- var match = SemanticVersionImpl.Regex.Match(version.Trim());
- if (!match.Success)
- throw new FormatException($"The input '{version}' isn't a valid semantic version.");
-
- // initialise
- this.Major = int.Parse(match.Groups["major"].Value);
- this.Minor = match.Groups["minor"].Success ? int.Parse(match.Groups["minor"].Value) : 0;
- this.Patch = match.Groups["patch"].Success ? int.Parse(match.Groups["patch"].Value) : 0;
- this.Tag = match.Groups["prerelease"].Success ? this.GetNormalisedTag(match.Groups["prerelease"].Value) : null;
- }
-
- /// <summary>Get an integer indicating whether this version precedes (less than 0), supercedes (more than 0), or is equivalent to (0) the specified version.</summary>
- /// <param name="other">The version to compare with this instance.</param>
- /// <exception cref="ArgumentNullException">The <paramref name="other"/> value is null.</exception>
- public int CompareTo(SemanticVersionImpl other)
- {
- if (other == null)
- throw new ArgumentNullException(nameof(other));
- return this.CompareTo(other.Major, other.Minor, other.Patch, other.Tag);
- }
-
-
- /// <summary>Get an integer indicating whether this version precedes (less than 0), supercedes (more than 0), or is equivalent to (0) the specified version.</summary>
- /// <param name="otherMajor">The major version to compare with this instance.</param>
- /// <param name="otherMinor">The minor version to compare with this instance.</param>
- /// <param name="otherPatch">The patch version to compare with this instance.</param>
- /// <param name="otherTag">The prerelease tag to compare with this instance.</param>
- public int CompareTo(int otherMajor, int otherMinor, int otherPatch, string otherTag)
- {
- const int same = 0;
- const int curNewer = 1;
- const int curOlder = -1;
-
- // compare stable versions
- if (this.Major != otherMajor)
- return this.Major.CompareTo(otherMajor);
- if (this.Minor != otherMinor)
- return this.Minor.CompareTo(otherMinor);
- if (this.Patch != otherPatch)
- return this.Patch.CompareTo(otherPatch);
- if (this.Tag == otherTag)
- return same;
-
- // stable supercedes pre-release
- bool curIsStable = string.IsNullOrWhiteSpace(this.Tag);
- bool otherIsStable = string.IsNullOrWhiteSpace(otherTag);
- if (curIsStable)
- return curNewer;
- if (otherIsStable)
- return curOlder;
-
- // compare two pre-release tag values
- string[] curParts = this.Tag.Split('.', '-');
- string[] otherParts = otherTag.Split('.', '-');
- for (int i = 0; i < curParts.Length; i++)
- {
- // longer prerelease tag supercedes if otherwise equal
- if (otherParts.Length <= i)
- return curNewer;
-
- // compare if different
- if (curParts[i] != otherParts[i])
- {
- // compare numerically if possible
- {
- if (int.TryParse(curParts[i], out int curNum) && int.TryParse(otherParts[i], out int otherNum))
- return curNum.CompareTo(otherNum);
- }
-
- // else compare lexically
- return string.Compare(curParts[i], otherParts[i], StringComparison.OrdinalIgnoreCase);
- }
- }
-
- // fallback (this should never happen)
- return string.Compare(this.ToString(), new SemanticVersionImpl(otherMajor, otherMinor, otherPatch, otherTag).ToString(), StringComparison.InvariantCultureIgnoreCase);
- }
-
- /// <summary>Get a string representation of the version.</summary>
- public override string ToString()
- {
- // version
- string result = this.Patch != 0
- ? $"{this.Major}.{this.Minor}.{this.Patch}"
- : $"{this.Major}.{this.Minor}";
-
- // tag
- string tag = this.Tag;
- if (tag != null)
- result += $"-{tag}";
- return result;
- }
-
- /// <summary>Parse a version string without throwing an exception if it fails.</summary>
- /// <param name="version">The version string.</param>
- /// <param name="parsed">The parsed representation.</param>
- /// <returns>Returns whether parsing the version succeeded.</returns>
- internal static bool TryParse(string version, out SemanticVersionImpl parsed)
- {
- try
- {
- parsed = new SemanticVersionImpl(version);
- return true;
- }
- catch
- {
- parsed = null;
- return false;
- }
- }
-
-
- /*********
- ** Private methods
- *********/
- /// <summary>Get a normalised build tag.</summary>
- /// <param name="tag">The tag to normalise.</param>
- private string GetNormalisedTag(string tag)
- {
- tag = tag?.Trim();
- return !string.IsNullOrWhiteSpace(tag) ? tag : null;
- }
- }
-}
diff --git a/src/SMAPI.Common/StardewModdingAPI.Common.projitems b/src/SMAPI.Common/StardewModdingAPI.Common.projitems
deleted file mode 100644
index 223b0d5c..00000000
--- a/src/SMAPI.Common/StardewModdingAPI.Common.projitems
+++ /dev/null
@@ -1,19 +0,0 @@
-<?xml version="1.0" encoding="utf-8"?>
-<Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
- <PropertyGroup>
- <MSBuildAllProjects>$(MSBuildAllProjects);$(MSBuildThisFileFullPath)</MSBuildAllProjects>
- <HasSharedItems>true</HasSharedItems>
- <SharedGUID>2aa02fb6-ff03-41cf-a215-2ee60ab4f5dc</SharedGUID>
- </PropertyGroup>
- <PropertyGroup Label="Configuration">
- <Import_RootNamespace>StardewModdingAPI.Common</Import_RootNamespace>
- </PropertyGroup>
- <ItemGroup>
- <Compile Include="$(MSBuildThisFileDirectory)Models\ModSeachModel.cs" />
- <Compile Include="$(MSBuildThisFileDirectory)Models\ModInfoModel.cs" />
- <Compile Include="$(MSBuildThisFileDirectory)SemanticVersionImpl.cs" />
- </ItemGroup>
- <ItemGroup>
- <Folder Include="$(MSBuildThisFileDirectory)Models\" />
- </ItemGroup>
-</Project> \ No newline at end of file
diff --git a/src/SMAPI.Common/StardewModdingAPI.Common.shproj b/src/SMAPI.Common/StardewModdingAPI.Common.shproj
deleted file mode 100644
index 0ef29144..00000000
--- a/src/SMAPI.Common/StardewModdingAPI.Common.shproj
+++ /dev/null
@@ -1,13 +0,0 @@
-<?xml version="1.0" encoding="utf-8"?>
-<Project ToolsVersion="15.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
- <PropertyGroup Label="Globals">
- <ProjectGuid>2aa02fb6-ff03-41cf-a215-2ee60ab4f5dc</ProjectGuid>
- <MinimumVisualStudioVersion>14.0</MinimumVisualStudioVersion>
- </PropertyGroup>
- <Import Project="$(MSBuildExtensionsPath)\$(MSBuildToolsVersion)\Microsoft.Common.props" Condition="Exists('$(MSBuildExtensionsPath)\$(MSBuildToolsVersion)\Microsoft.Common.props')" />
- <Import Project="$(MSBuildExtensionsPath32)\Microsoft\VisualStudio\v$(VisualStudioVersion)\CodeSharing\Microsoft.CodeSharing.Common.Default.props" />
- <Import Project="$(MSBuildExtensionsPath32)\Microsoft\VisualStudio\v$(VisualStudioVersion)\CodeSharing\Microsoft.CodeSharing.Common.props" />
- <PropertyGroup />
- <Import Project="StardewModdingAPI.Common.projitems" Label="Shared" />
- <Import Project="$(MSBuildExtensionsPath32)\Microsoft\VisualStudio\v$(VisualStudioVersion)\CodeSharing\Microsoft.CodeSharing.CSharp.targets" />
-</Project>
generated by cgit (git 2.46.0) at 2025-04-05 14:24:24 +0000