summaryrefslogtreecommitdiff
path: root/src/SMAPI
diff options
context:
space:
mode:
authorJesse Plamondon-Willard <github@jplamondonw.com>2018-06-24 21:29:10 -0400
committerJesse Plamondon-Willard <github@jplamondonw.com>2018-06-24 21:29:10 -0400
commit316242eeb2b6b6e711ab98f64c147a59c1d0aab8 (patch)
tree8266077b34ce63dd09690d97e5e67446f8afc665 /src/SMAPI
parent71efadf2322a622bc5a74614b1575d2680a84165 (diff)
downloadSMAPI-316242eeb2b6b6e711ab98f64c147a59c1d0aab8.tar.gz
SMAPI-316242eeb2b6b6e711ab98f64c147a59c1d0aab8.tar.bz2
SMAPI-316242eeb2b6b6e711ab98f64c147a59c1d0aab8.zip
merge ISemanticVersion interfaces into new project (#532)
Diffstat (limited to 'src/SMAPI')
-rw-r--r--src/SMAPI/Constants.cs16
-rw-r--r--src/SMAPI/Framework/ModLoading/Rewriters/TypeReferenceRewriter.cs11
-rw-r--r--src/SMAPI/ISemanticVersion.cs62
-rw-r--r--src/SMAPI/Metadata/InstructionMetadata.cs3
-rw-r--r--src/SMAPI/Program.cs2
-rw-r--r--src/SMAPI/SemanticVersion.cs31
-rw-r--r--src/SMAPI/StardewModdingAPI.csproj1
7 files changed, 31 insertions, 95 deletions
diff --git a/src/SMAPI/Constants.cs b/src/SMAPI/Constants.cs
index 65ca7866..df70d603 100644
--- a/src/SMAPI/Constants.cs
+++ b/src/SMAPI/Constants.cs
@@ -38,10 +38,10 @@ namespace StardewModdingAPI
** Public
****/
/// <summary>SMAPI's current semantic version.</summary>
- public static ISemanticVersion ApiVersion { get; }
+ public static ISemanticVersion ApiVersion { get; } = new Toolkit.SemanticVersion("2.6-beta.17");
/// <summary>The minimum supported version of Stardew Valley.</summary>
- public static ISemanticVersion MinimumGameVersion { get; }
+ public static ISemanticVersion MinimumGameVersion { get; } = new GameVersion("1.3.21");
/// <summary>The maximum supported version of Stardew Valley.</summary>
public static ISemanticVersion MaximumGameVersion { get; } = null;
@@ -70,9 +70,6 @@ namespace StardewModdingAPI
/****
** Internal
****/
- /// <summary>SMAPI's current semantic version as a mod toolkit version.</summary>
- internal static Toolkit.ISemanticVersion ApiVersionForToolkit { get; }
-
/// <summary>The URL of the SMAPI home page.</summary>
internal const string HomePageUrl = "https://smapi.io";
@@ -113,15 +110,6 @@ namespace StardewModdingAPI
/*********
** Internal methods
*********/
- /// <summary>Initialise the static values.</summary>
- static Constants()
- {
- Constants.ApiVersionForToolkit = new Toolkit.SemanticVersion("2.6-beta.17");
- Constants.MinimumGameVersion = new GameVersion("1.3.20");
-
- Constants.ApiVersion = new SemanticVersion(Constants.ApiVersionForToolkit);
- }
-
/// <summary>Get metadata for mapping assemblies to the current platform.</summary>
/// <param name="targetPlatform">The target game platform.</param>
internal static PlatformAssemblyMap GetAssemblyMap(Platform targetPlatform)
diff --git a/src/SMAPI/Framework/ModLoading/Rewriters/TypeReferenceRewriter.cs b/src/SMAPI/Framework/ModLoading/Rewriters/TypeReferenceRewriter.cs
index 5c7db902..de9c439a 100644
--- a/src/SMAPI/Framework/ModLoading/Rewriters/TypeReferenceRewriter.cs
+++ b/src/SMAPI/Framework/ModLoading/Rewriters/TypeReferenceRewriter.cs
@@ -17,6 +17,9 @@ namespace StardewModdingAPI.Framework.ModLoading.Rewriters
/// <summary>The new type to reference.</summary>
private readonly Type ToType;
+ /// <summary>A lambda which indicates whether a matching type reference should be rewritten.</summary>
+ private readonly Func<TypeReference, bool> ShouldRewrite;
+
/*********
** Public methods
@@ -24,11 +27,13 @@ namespace StardewModdingAPI.Framework.ModLoading.Rewriters
/// <summary>Construct an instance.</summary>
/// <param name="fromTypeFullName">The full type name to which to find references.</param>
/// <param name="toType">The new type to reference.</param>
- public TypeReferenceRewriter(string fromTypeFullName, Type toType)
+ /// <param name="shouldRewrite">A lambda which indicates whether a matching type reference should be rewritten.</param>
+ public TypeReferenceRewriter(string fromTypeFullName, Type toType, Func<TypeReference, bool> shouldRewrite = null)
: base(fromTypeFullName, InstructionHandleResult.None)
{
this.FromTypeName = fromTypeFullName;
this.ToType = toType;
+ this.ShouldRewrite = shouldRewrite ?? (type => true);
}
/// <summary>Perform the predefined logic for a method if applicable.</summary>
@@ -135,7 +140,11 @@ namespace StardewModdingAPI.Framework.ModLoading.Rewriters
{
// root type
if (type.FullName == this.FromTypeName)
+ {
+ if (!this.ShouldRewrite(type))
+ return type;
return module.ImportReference(this.ToType);
+ }
// generic arguments
if (type is GenericInstanceType genericType)
diff --git a/src/SMAPI/ISemanticVersion.cs b/src/SMAPI/ISemanticVersion.cs
deleted file mode 100644
index 961ef777..00000000
--- a/src/SMAPI/ISemanticVersion.cs
+++ /dev/null
@@ -1,62 +0,0 @@
-using System;
-
-namespace StardewModdingAPI
-{
- /// <summary>A semantic version with an optional release tag.</summary>
- public interface ISemanticVersion : IComparable<ISemanticVersion>, IEquatable<ISemanticVersion>
- {
- /*********
- ** Accessors
- *********/
- /// <summary>The major version incremented for major API changes.</summary>
- int MajorVersion { get; }
-
- /// <summary>The minor version incremented for backwards-compatible changes.</summary>
- int MinorVersion { get; }
-
- /// <summary>The patch version for backwards-compatible bug fixes.</summary>
- int PatchVersion { get; }
-
- /// <summary>An optional build tag.</summary>
- string Build { get; }
-
-
- /*********
- ** Accessors
- *********/
- /// <summary>Whether this is a pre-release version.</summary>
- bool IsPrerelease();
-
- /// <summary>Get whether this version is older than the specified version.</summary>
- /// <param name="other">The version to compare with this instance.</param>
- bool IsOlderThan(ISemanticVersion other);
-
- /// <summary>Get whether this version is older than the specified version.</summary>
- /// <param name="other">The version to compare with this instance.</param>
- /// <exception cref="FormatException">The specified version is not a valid semantic version.</exception>
- bool IsOlderThan(string other);
-
- /// <summary>Get whether this version is newer than the specified version.</summary>
- /// <param name="other">The version to compare with this instance.</param>
- bool IsNewerThan(ISemanticVersion other);
-
- /// <summary>Get whether this version is newer than the specified version.</summary>
- /// <param name="other">The version to compare with this instance.</param>
- /// <exception cref="FormatException">The specified version is not a valid semantic version.</exception>
- bool IsNewerThan(string other);
-
- /// <summary>Get whether this version is between two specified versions (inclusively).</summary>
- /// <param name="min">The minimum version.</param>
- /// <param name="max">The maximum version.</param>
- bool IsBetween(ISemanticVersion min, ISemanticVersion max);
-
- /// <summary>Get whether this version is between two specified versions (inclusively).</summary>
- /// <param name="min">The minimum version.</param>
- /// <param name="max">The maximum version.</param>
- /// <exception cref="FormatException">One of the specified versions is not a valid semantic version.</exception>
- bool IsBetween(string min, string max);
-
- /// <summary>Get a string representation of the version.</summary>
- string ToString();
- }
-}
diff --git a/src/SMAPI/Metadata/InstructionMetadata.cs b/src/SMAPI/Metadata/InstructionMetadata.cs
index 1063ae71..543d44a7 100644
--- a/src/SMAPI/Metadata/InstructionMetadata.cs
+++ b/src/SMAPI/Metadata/InstructionMetadata.cs
@@ -37,6 +37,9 @@ namespace StardewModdingAPI.Metadata
// rewrite for SMAPI 2.0
new VirtualEntryCallRemover(),
+ // rewrite for SMAPI 2.6
+ new TypeReferenceRewriter("StardewModdingAPI.ISemanticVersion", typeof(ISemanticVersion), type => type.Scope.Name == "StardewModdingAPI"), // moved to SMAPI.Toolkit.CoreInterfaces
+
// rewrite for Stardew Valley 1.3
new StaticFieldToConstantRewriter<int>(typeof(Game1), "tileSize", Game1.tileSize),
diff --git a/src/SMAPI/Program.cs b/src/SMAPI/Program.cs
index 7b5176a0..a51d6380 100644
--- a/src/SMAPI/Program.cs
+++ b/src/SMAPI/Program.cs
@@ -585,7 +585,7 @@ namespace StardewModdingAPI
#if !SMAPI_FOR_WINDOWS
url = url.Replace("https://", "http://"); // workaround for OpenSSL issues with the game's bundled Mono on Linux/Mac
#endif
- WebApiClient client = new WebApiClient(url, Constants.ApiVersionForToolkit);
+ WebApiClient client = new WebApiClient(url, Constants.ApiVersion);
this.Monitor.Log("Checking for updates...", LogLevel.Trace);
// check SMAPI version
diff --git a/src/SMAPI/SemanticVersion.cs b/src/SMAPI/SemanticVersion.cs
index c4dd1912..587ff286 100644
--- a/src/SMAPI/SemanticVersion.cs
+++ b/src/SMAPI/SemanticVersion.cs
@@ -10,23 +10,23 @@ namespace StardewModdingAPI
** Properties
*********/
/// <summary>The underlying semantic version implementation.</summary>
- private readonly Toolkit.ISemanticVersion Version;
+ private readonly ISemanticVersion Version;
/*********
** Accessors
*********/
/// <summary>The major version incremented for major API changes.</summary>
- public int MajorVersion => this.Version.Major;
+ public int MajorVersion => this.Version.MajorVersion;
/// <summary>The minor version incremented for backwards-compatible changes.</summary>
- public int MinorVersion => this.Version.Minor;
+ public int MinorVersion => this.Version.MinorVersion;
/// <summary>The patch version for backwards-compatible bug fixes.</summary>
- public int PatchVersion => this.Version.Patch;
+ public int PatchVersion => this.Version.PatchVersion;
/// <summary>An optional build tag.</summary>
- public string Build => this.Version.Tag;
+ public string Build => this.Version.Build;
/*********
@@ -56,7 +56,7 @@ namespace StardewModdingAPI
/// <summary>Construct an instance.</summary>
/// <param name="version">The underlying semantic version implementation.</param>
- internal SemanticVersion(Toolkit.ISemanticVersion version)
+ internal SemanticVersion(ISemanticVersion version)
{
this.Version = version;
}
@@ -64,7 +64,7 @@ namespace StardewModdingAPI
/// <summary>Whether this is a pre-release version.</summary>
public bool IsPrerelease()
{
- return !string.IsNullOrWhiteSpace(this.Build);
+ return this.Version.IsPrerelease();
}
/// <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>
@@ -73,15 +73,14 @@ namespace StardewModdingAPI
/// <remarks>The implementation is defined by Semantic Version 2.0 (http://semver.org/).</remarks>
public int CompareTo(ISemanticVersion other)
{
- Toolkit.ISemanticVersion toolkitOther = new Toolkit.SemanticVersion(other.MajorVersion, other.MinorVersion, other.PatchVersion, other.Build);
- return this.Version.CompareTo(toolkitOther);
+ return this.Version.CompareTo(other);
}
/// <summary>Get whether this version is older than the specified version.</summary>
/// <param name="other">The version to compare with this instance.</param>
public bool IsOlderThan(ISemanticVersion other)
{
- return this.CompareTo(other) < 0;
+ return this.Version.IsOlderThan(other);
}
/// <summary>Get whether this version is older than the specified version.</summary>
@@ -89,14 +88,14 @@ namespace StardewModdingAPI
/// <exception cref="FormatException">The specified version is not a valid semantic version.</exception>
public bool IsOlderThan(string other)
{
- return this.IsOlderThan(new SemanticVersion(other));
+ return this.Version.IsOlderThan(other);
}
/// <summary>Get whether this version is newer than the specified version.</summary>
/// <param name="other">The version to compare with this instance.</param>
public bool IsNewerThan(ISemanticVersion other)
{
- return this.CompareTo(other) > 0;
+ return this.Version.IsNewerThan(other);
}
/// <summary>Get whether this version is newer than the specified version.</summary>
@@ -104,7 +103,7 @@ namespace StardewModdingAPI
/// <exception cref="FormatException">The specified version is not a valid semantic version.</exception>
public bool IsNewerThan(string other)
{
- return this.IsNewerThan(new SemanticVersion(other));
+ return this.Version.IsNewerThan(other);
}
/// <summary>Get whether this version is between two specified versions (inclusively).</summary>
@@ -112,7 +111,7 @@ namespace StardewModdingAPI
/// <param name="max">The maximum version.</param>
public bool IsBetween(ISemanticVersion min, ISemanticVersion max)
{
- return this.CompareTo(min) >= 0 && this.CompareTo(max) <= 0;
+ return this.Version.IsBetween(min, max);
}
/// <summary>Get whether this version is between two specified versions (inclusively).</summary>
@@ -121,7 +120,7 @@ namespace StardewModdingAPI
/// <exception cref="FormatException">One of the specified versions is not a valid semantic version.</exception>
public bool IsBetween(string min, string max)
{
- return this.IsBetween(new SemanticVersion(min), new SemanticVersion(max));
+ return this.Version.IsBetween(min, max);
}
/// <summary>Indicates whether the current object is equal to another object of the same type.</summary>
@@ -144,7 +143,7 @@ namespace StardewModdingAPI
/// <returns>Returns whether parsing the version succeeded.</returns>
internal static bool TryParse(string version, out ISemanticVersion parsed)
{
- if (Toolkit.SemanticVersion.TryParse(version, out Toolkit.ISemanticVersion versionImpl))
+ if (Toolkit.SemanticVersion.TryParse(version, out ISemanticVersion versionImpl))
{
parsed = new SemanticVersion(versionImpl);
return true;
diff --git a/src/SMAPI/StardewModdingAPI.csproj b/src/SMAPI/StardewModdingAPI.csproj
index a429d204..c872391c 100644
--- a/src/SMAPI/StardewModdingAPI.csproj
+++ b/src/SMAPI/StardewModdingAPI.csproj
@@ -280,7 +280,6 @@
<Compile Include="IModHelper.cs" />
<Compile Include="IModLinked.cs" />
<Compile Include="Framework\Logging\LogFileManager.cs" />
- <Compile Include="ISemanticVersion.cs" />
<Compile Include="ITranslationHelper.cs" />
<Compile Include="LogLevel.cs" />
<Compile Include="Framework\ModRegistry.cs" />