Merge branch 'develop' into stable

build/GlobalAssemblyInfo.cs

@@ -2,5 +2,5 @@
 using System.Runtime.InteropServices;
 
 [assembly: ComVisible(false)]
-[assembly: AssemblyVersion("2.3.0.0")]
-[assembly: AssemblyFileVersion("2.3.0.0")]
+[assembly: AssemblyVersion("2.4.0.0")]
+[assembly: AssemblyFileVersion("2.4.0.0")]

docs/release-notes.md

@@ -1,4 +1,29 @@
 # Release notes
+## 2.4
+* For players:
+  * Fixed visual map glitch in rare cases.
+  * Fixed error parsing JSON files which have curly quotes.
+  * Fixed error parsing some JSON files generated on another system.
+  * Fixed error parsing some JSON files after mods reload core assemblies, which is no longer allowed.
+  * Fixed intermittent errors (e.g. 'collection has been modified') with some mods when loading a save.
+  * Fixed compatibility with Linux Terminator terminal.
+
+* For the [log parser][]:
+  * Fixed error parsing logs with zero installed mods.
+
+* For modders:
+  * Added `SaveEvents.BeforeCreate` and `AfterCreate` events.
+  * Added `SButton` `IsActionButton()` and `IsUseToolButton()` extensions.
+  * Improved JSON parse errors to provide more useful info for troubleshooting.
+  * Fixed events being raised while the game is loading a save file.
+  * Fixed input events not recognising controller input as an action or use-tool button.
+  * Fixed input events setting the same `IsActionButton` and `IsUseToolButton` values for all buttons pressed in an update tick.
+  * Fixed semantic versions ignoring `-0` as a prerelease tag.
+  * Updated Json.NET to 11.0.1-beta3 (needed to avoid a parser edge case).
+
+* For SMAPI developers:
+  * Overhauled input handling to support future input events.
+
 ## 2.3
 * For players:
   * Added a user-friendly [download page](https://smapi.io).

src/SMAPI.Common/SemanticVersionImpl.cs

@@ -190,9 +190,7 @@ internal static bool TryParse(string version, out SemanticVersionImpl parsed)
         private string GetNormalisedTag(string tag)
         {
             tag = tag?.Trim();
-            if (string.IsNullOrWhiteSpace(tag) || tag == "0") // '0' from incorrect examples in old SMAPI documentation
-                return null;
-            return tag;
+            return !string.IsNullOrWhiteSpace(tag) ? tag : null;
         }
     }
 }

src/SMAPI.ModBuildConfig/build/smapi.targets

@@ -122,8 +122,8 @@
     <Error Condition="'$(OS)' != 'OSX' AND '$(OS)' != 'Unix' AND '$(OS)' != 'Windows_NT'" Text="The mod build package doesn't recognise OS type '$(OS)'." />
 
     <Error Condition="!Exists('$(GamePath)')" Text="The mod build package can't find your game folder. You can specify where to find it; see details at https://github.com/Pathoschild/SMAPI/blob/develop/docs/mod-build-config.md#game-path." />
-    <Error Condition="'$(OS)' == 'Windows_NT' AND !Exists('$(GamePath)\Stardew Valley.exe')" Text="The mod build package found a a game folder at $(GamePath), but it doesn't contain the Stardew Valley.exe file. If this folder is invalid, delete it and the package will autodetect another game install path." />
-    <Error Condition="'$(OS)' != 'Windows_NT' AND !Exists('$(GamePath)\StardewValley.exe')" Text="The mod build package found a a game folder at $(GamePath), but it doesn't contain the StardewValley.exe file. If this folder is invalid, delete it and the package will autodetect another game install path." />
+    <Error Condition="'$(OS)' == 'Windows_NT' AND !Exists('$(GamePath)\Stardew Valley.exe')" Text="The mod build package found a game folder at $(GamePath), but it doesn't contain the Stardew Valley.exe file. If this folder is invalid, delete it and the package will autodetect another game install path." />
+    <Error Condition="'$(OS)' != 'Windows_NT' AND !Exists('$(GamePath)\StardewValley.exe')" Text="The mod build package found a game folder at $(GamePath), but it doesn't contain the StardewValley.exe file. If this folder is invalid, delete it and the package will autodetect another game install path." />
     <Error Condition="!Exists('$(GamePath)\StardewModdingAPI.exe')" Text="The mod build package found a game folder at $(GamePath), but it doesn't contain SMAPI. You need to install SMAPI before building the mod." />
   </Target>
 

src/SMAPI.Mods.ConsoleCommands/StardewModdingAPI.Mods.ConsoleCommands.csproj

@@ -36,8 +36,8 @@
     <PlatformTarget>x86</PlatformTarget>
   </PropertyGroup>
   <ItemGroup>
-    <Reference Include="Newtonsoft.Json, Version=10.0.0.0, Culture=neutral, PublicKeyToken=30ad4fe6b2a6aeed, processorArchitecture=MSIL">
-      <HintPath>..\packages\Newtonsoft.Json.10.0.3\lib\net45\Newtonsoft.Json.dll</HintPath>
+    <Reference Include="Newtonsoft.Json, Version=11.0.0.0, Culture=neutral, PublicKeyToken=30ad4fe6b2a6aeed, processorArchitecture=MSIL">
+      <HintPath>..\packages\Newtonsoft.Json.11.0.1-beta3\lib\net45\Newtonsoft.Json.dll</HintPath>
       <Private>False</Private>
     </Reference>
     <Reference Include="System" />

src/SMAPI.Mods.ConsoleCommands/manifest.json

@@ -1,12 +1,7 @@
 {
   "Name": "Console Commands",
   "Author": "SMAPI",
-  "Version": {
-    "MajorVersion": 2,
-    "MinorVersion": 3,
-    "PatchVersion": 0,
-    "Build": null
-  },
+  "Version": "2.4.0",
   "Description": "Adds SMAPI console commands that let you manipulate the game.",
   "UniqueID": "SMAPI.ConsoleCommands",
   "EntryDll": "ConsoleCommands.dll"

src/SMAPI.Mods.ConsoleCommands/packages.config

@@ -1,4 +1,4 @@
 <?xml version="1.0" encoding="utf-8"?>
 <packages>
-  <package id="Newtonsoft.Json" version="10.0.3" targetFramework="net45" />
+  <package id="Newtonsoft.Json" version="11.0.1-beta3" targetFramework="net45" />
 </packages>

src/SMAPI.Tests/StardewModdingAPI.Tests.csproj

@@ -36,8 +36,8 @@
     <Reference Include="Moq, Version=4.7.142.0, Culture=neutral, PublicKeyToken=69f491c39445e920, processorArchitecture=MSIL">
       <HintPath>..\packages\Moq.4.7.142\lib\net45\Moq.dll</HintPath>
     </Reference>
-    <Reference Include="Newtonsoft.Json, Version=10.0.0.0, Culture=neutral, PublicKeyToken=30ad4fe6b2a6aeed, processorArchitecture=MSIL">
-      <HintPath>..\packages\Newtonsoft.Json.10.0.3\lib\net45\Newtonsoft.Json.dll</HintPath>
+    <Reference Include="Newtonsoft.Json, Version=11.0.0.0, Culture=neutral, PublicKeyToken=30ad4fe6b2a6aeed, processorArchitecture=MSIL">
+      <HintPath>..\packages\Newtonsoft.Json.11.0.1-beta3\lib\net45\Newtonsoft.Json.dll</HintPath>
     </Reference>
     <Reference Include="nunit.framework, Version=3.8.1.0, Culture=neutral, PublicKeyToken=2638cd05610744eb, processorArchitecture=MSIL">
       <HintPath>..\packages\NUnit.3.8.1\lib\net45\nunit.framework.dll</HintPath>

src/SMAPI.Tests/Utilities/SemanticVersionTests.cs

@@ -33,6 +33,7 @@ public string Constructor_FromString(string input)
         [TestCase(3000, 4000, 5000, null, ExpectedResult = "3000.4000.5000")]
         [TestCase(1, 2, 3, "", ExpectedResult = "1.2.3")]
         [TestCase(1, 2, 3, "    ", ExpectedResult = "1.2.3")]
+        [TestCase(1, 2, 3, "0", ExpectedResult = "1.2.3-0")]
         [TestCase(1, 2, 3, "some-tag.4", ExpectedResult = "1.2.3-some-tag.4")]
         [TestCase(1, 2, 3, "some-tag.4   ", ExpectedResult = "1.2.3-some-tag.4")]
         public string Constructor_FromParts(int major, int minor, int patch, string tag)
@@ -270,6 +271,22 @@ public void GameVersion(string versionStr)
             Assert.IsTrue(version.IsOlderThan(new SemanticVersion("1.2.30")), "The game version should be considered older than the later semantic versions.");
         }
 
+        /****
+        ** LegacyManifestVersion
+        ****/
+        [Test(Description = "Assert that the LegacyManifestVersion subclass correctly parses legacy manifest versions.")]
+        [TestCase(1, 0, 0, null, ExpectedResult = "1.0")]
+        [TestCase(3000, 4000, 5000, null, ExpectedResult = "3000.4000.5000")]
+        [TestCase(1, 2, 3, "", ExpectedResult = "1.2.3")]
+        [TestCase(1, 2, 3, "    ", ExpectedResult = "1.2.3")]
+        [TestCase(1, 2, 3, "0", ExpectedResult = "1.2.3")]  // special case: drop '0' tag for legacy manifest versions
+        [TestCase(1, 2, 3, "some-tag.4", ExpectedResult = "1.2.3-some-tag.4")]
+        [TestCase(1, 2, 3, "some-tag.4   ", ExpectedResult = "1.2.3-some-tag.4")]
+        public string LegacyManifestVersion(int major, int minor, int patch, string tag)
+        {
+            return new LegacyManifestVersion(major, minor, patch, tag).ToString();
+        }
+
 
         /*********
         ** Private methods

src/SMAPI.Tests/packages.config

@@ -2,6 +2,6 @@
 <packages>
   <package id="Castle.Core" version="4.2.1" targetFramework="net45" />
   <package id="Moq" version="4.7.142" targetFramework="net45" />
-  <package id="Newtonsoft.Json" version="10.0.3" targetFramework="net45" />
+  <package id="Newtonsoft.Json" version="11.0.1-beta3" targetFramework="net45" />
   <package id="NUnit" version="3.8.1" targetFramework="net45" />
 </packages>

src/SMAPI.Web/Views/Index/Index.cshtml

@@ -62,7 +62,7 @@
 
 <h2>For mod creators</h2>
 <ul>
-    <li><a href="@Model.DevDownloadUrl">SMAPI 2.2 for developers</a> (includes <a href="https://docs.microsoft.com/en-us/visualstudio/ide/using-intellisense">intellisense</a> and full console output)</li>
+    <li><a href="@Model.DevDownloadUrl">SMAPI @Model.LatestVersion for developers</a> (includes <a href="https://docs.microsoft.com/en-us/visualstudio/ide/using-intellisense">intellisense</a> and full console output)</li>
     <li><a href="https://stardewvalleywiki.com/Modding:Index">Modding documentation</a></li>
     <li>Need help? Come <a href="https://stardewvalleywiki.com/Modding:Community#Discord">chat on Discord</a>.</li>
 </ul>

src/SMAPI.Web/Views/LogParser/Index.cshtml

@@ -3,9 +3,9 @@
 }
 @model StardewModdingAPI.Web.ViewModels.LogParserModel
 @section Head {
-    <link rel="stylesheet" href="~/Content/css/log-parser.css?r=20171202" />
+    <link rel="stylesheet" href="~/Content/css/log-parser.css?r=20180101" />
     <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.2.1/jquery.min.js" crossorigin="anonymous"></script>
-    <script src="~/Content/js/log-parser.js?r=20171202"></script>
+    <script src="~/Content/js/log-parser.js?r=20180101"></script>
     <style type="text/css" id="modflags"></style>
     <script>
         $(function() {

src/SMAPI.Web/wwwroot/Content/js/log-parser.js

@@ -175,7 +175,7 @@ smapi.logParser = function(sectionUrl, pasteID) {
 
         }
         var dataInfo = regexInfo.exec(data) || regexInfo.exec(data) || regexInfo.exec(data),
-            dataMods = regexMods.exec(data) || regexMods.exec(data) || regexMods.exec(data),
+            dataMods = regexMods.exec(data) || regexMods.exec(data) || regexMods.exec(data) || [""],
             dataDate = regexDate.exec(data) || regexDate.exec(data) || regexDate.exec(data),
             dataPath = regexPath.exec(data) || regexPath.exec(data) || regexPath.exec(data),
             match;

src/SMAPI.sln.DotSettings

@@ -6,14 +6,20 @@
 	<s:String x:Key="/Default/CodeStyle/CodeFormatting/CSharpCodeStyle/StaticQualifier/STATIC_MEMBERS_QUALIFY_MEMBERS/@EntryValue">Field, Property, Event, Method</s:String>
 	<s:String x:Key="/Default/CodeStyle/CodeFormatting/CSharpCodeStyle/ThisQualifier/INSTANCE_MEMBERS_QUALIFY_MEMBERS/@EntryValue">Field, Property, Event, Method</s:String>
 	<s:Boolean x:Key="/Default/CodeStyle/CodeFormatting/CSharpFormat/LINE_FEED_AT_FILE_END/@EntryValue">True</s:Boolean>
+	<s:String x:Key="/Default/CodeStyle/CodeFormatting/CSharpFormat/PLACE_ACCESSORHOLDER_ATTRIBUTE_ON_SAME_LINE_EX/@EntryValue">NEVER</s:String>
 	<s:Boolean x:Key="/Default/CodeStyle/CodeFormatting/CSharpFormat/WRAP_LINES/@EntryValue">False</s:Boolean>
 	<s:String x:Key="/Default/CodeStyle/CSharpVarKeywordUsage/ForBuiltInTypes/@EntryValue">UseVarWhenEvident</s:String>
 	<s:String x:Key="/Default/CodeStyle/CSharpVarKeywordUsage/ForSimpleTypes/@EntryValue">UseExplicitType</s:String>
 	<s:String x:Key="/Default/CodeStyle/Naming/CSharpNaming/Abbreviations/=ID/@EntryIndexedValue">ID</s:String>
 	<s:String x:Key="/Default/CodeStyle/Naming/CSharpNaming/PredefinedNamingRules/=PrivateInstanceFields/@EntryIndexedValue">&lt;Policy Inspect="True" Prefix="" Suffix="" Style="AaBb"&gt;&lt;ExtraRule Prefix="_" Suffix="" Style="aaBb" /&gt;&lt;/Policy&gt;</s:String>
 	<s:String x:Key="/Default/CodeStyle/Naming/CSharpNaming/PredefinedNamingRules/=PrivateStaticFields/@EntryIndexedValue">&lt;Policy Inspect="True" Prefix="" Suffix="" Style="AaBb"&gt;&lt;ExtraRule Prefix="_" Suffix="" Style="aaBb" /&gt;&lt;/Policy&gt;</s:String>
 	<s:String x:Key="/Default/CodeStyle/Naming/CSharpNaming/PredefinedNamingRules/=PrivateStaticReadonly/@EntryIndexedValue">&lt;Policy Inspect="True" Prefix="" Suffix="" Style="AaBb"&gt;&lt;ExtraRule Prefix="_" Suffix="" Style="aaBb" /&gt;&lt;/Policy&gt;</s:String>
+	<s:Boolean x:Key="/Default/Environment/SettingsMigration/IsMigratorApplied/=JetBrains_002EReSharper_002EPsi_002ECSharp_002ECodeStyle_002ECSharpAttributeForSingleLineMethodUpgrade/@EntryIndexedValue">True</s:Boolean>
+	<s:Boolean x:Key="/Default/Environment/SettingsMigration/IsMigratorApplied/=JetBrains_002EReSharper_002EPsi_002ECSharp_002ECodeStyle_002ECSharpKeepExistingMigration/@EntryIndexedValue">True</s:Boolean>
+	<s:Boolean x:Key="/Default/Environment/SettingsMigration/IsMigratorApplied/=JetBrains_002EReSharper_002EPsi_002ECSharp_002ECodeStyle_002ECSharpPlaceEmbeddedOnSameLineMigration/@EntryIndexedValue">True</s:Boolean>
+	<s:Boolean x:Key="/Default/Environment/SettingsMigration/IsMigratorApplied/=JetBrains_002EReSharper_002EPsi_002ECSharp_002ECodeStyle_002ECSharpRenamePlacementToArrangementMigration/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/Environment/SettingsMigration/IsMigratorApplied/=JetBrains_002EReSharper_002EPsi_002ECSharp_002ECodeStyle_002ESettingsUpgrade_002EAddAccessorOwnerDeclarationBracesMigration/@EntryIndexedValue">True</s:Boolean>
+	<s:Boolean x:Key="/Default/Environment/SettingsMigration/IsMigratorApplied/=JetBrains_002EReSharper_002EPsi_002ECSharp_002ECodeStyle_002ESettingsUpgrade_002ECSharpPlaceAttributeOnSameLineMigration/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/Environment/SettingsMigration/IsMigratorApplied/=JetBrains_002EReSharper_002EPsi_002ECSharp_002ECodeStyle_002ESettingsUpgrade_002EMigrateBlankLinesAroundFieldToBlankLinesAroundProperty/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/Environment/SettingsMigration/IsMigratorApplied/=JetBrains_002EReSharper_002EPsi_002ECSharp_002ECodeStyle_002ESettingsUpgrade_002EMigrateThisQualifierSettings/@EntryIndexedValue">True</s:Boolean>
 </wpf:ResourceDictionary>

src/SMAPI/Constants.cs

@@ -29,7 +29,7 @@ public static class Constants
         ** Public
         ****/
         /// <summary>SMAPI's current semantic version.</summary>
-        public static ISemanticVersion ApiVersion { get; } = new SemanticVersion("2.3");
+        public static ISemanticVersion ApiVersion { get; } = new SemanticVersion("2.4.0");
 
         /// <summary>The minimum supported version of Stardew Valley.</summary>
         public static ISemanticVersion MinimumGameVersion { get; } = new SemanticVersion("1.2.30");

src/SMAPI/Events/SaveEvents.cs

@@ -1,4 +1,4 @@
-using System;
+using System;
 using StardewModdingAPI.Framework;
 
 namespace StardewModdingAPI.Events
@@ -9,6 +9,12 @@ public static class SaveEvents
         /*********
         ** Events
         *********/
+        /// <summary>Raised before the game creates the save file.</summary>
+        public static event EventHandler BeforeCreate;
+
+        /// <summary>Raised after the game finishes creating the save file.</summary>
+        public static event EventHandler AfterCreate;
+
         /// <summary>Raised before the game begins writes data to the save file.</summary>
         public static event EventHandler BeforeSave;
 
@@ -25,6 +31,20 @@ public static class SaveEvents
         /*********
         ** Internal methods
         *********/
+        /// <summary>Raise a <see cref="BeforeCreate"/> event.</summary>
+        /// <param name="monitor">Encapsulates monitoring and logging.</param>
+        internal static void InvokeBeforeCreate(IMonitor monitor)
+        {
+            monitor.SafelyRaisePlainEvent($"{nameof(SaveEvents)}.{nameof(SaveEvents.BeforeCreate)}", SaveEvents.BeforeCreate?.GetInvocationList(), null, EventArgs.Empty);
+        }
+
+        /// <summary>Raise a <see cref="AfterCreate"/> event.</summary>
+        /// <param name="monitor">Encapsulates monitoring and logging.</param>
+        internal static void InvokeAfterCreated(IMonitor monitor)
+        {
+            monitor.SafelyRaisePlainEvent($"{nameof(SaveEvents)}.{nameof(SaveEvents.AfterCreate)}", SaveEvents.AfterCreate?.GetInvocationList(), null, EventArgs.Empty);
+        }
+
         /// <summary>Raise a <see cref="BeforeSave"/> event.</summary>
         /// <param name="monitor">Encapsulates monitoring and logging.</param>
         internal static void InvokeBeforeSave(IMonitor monitor)