From 78e8a6a4a088d6bff017bfcf22007f9fc8950071 Mon Sep 17 00:00:00 2001 From: Jesse Plamondon-Willard Date: Fri, 4 Nov 2016 18:24:10 -0400 Subject: remove extensions from public interface, refactor & document --- src/StardewModdingAPI/Constants.cs | 14 ++++- src/StardewModdingAPI/Extensions.cs | 78 -------------------------- src/StardewModdingAPI/Inheritance/SGame.cs | 51 ++++++++++++++--- src/StardewModdingAPI/Log.cs | 6 +- src/StardewModdingAPI/Program.cs | 4 +- src/StardewModdingAPI/StardewModdingAPI.csproj | 1 - 6 files changed, 62 insertions(+), 92 deletions(-) delete mode 100644 src/StardewModdingAPI/Extensions.cs (limited to 'src/StardewModdingAPI') diff --git a/src/StardewModdingAPI/Constants.cs b/src/StardewModdingAPI/Constants.cs index d023be3c..e5752dfd 100644 --- a/src/StardewModdingAPI/Constants.cs +++ b/src/StardewModdingAPI/Constants.cs @@ -1,5 +1,6 @@ using System; using System.IO; +using System.Linq; using System.Reflection; using StardewValley; @@ -12,7 +13,7 @@ namespace StardewModdingAPI ** Properties *********/ /// The directory name containing the current save's data (if a save is loaded). - private static string RawSaveFolderName => Constants.PlayerNull ? string.Empty : $"{Game1.player.name.RemoveNumerics()}_{Game1.uniqueIDForThisGame}"; + private static string RawSaveFolderName => Constants.PlayerNull ? string.Empty : Constants.GetSaveFolderName(); /// The directory path containing the current save's data (if a save is loaded). private static string RawSavePath => Constants.PlayerNull ? string.Empty : Path.Combine(Constants.SavesPath, Constants.RawSaveFolderName); @@ -56,5 +57,16 @@ namespace StardewModdingAPI /// The file path to the error log where the latest output should be saved. public static string LogPath => Path.Combine(Constants.LogDir, "MODDED_ProgramLog.Log_LATEST.txt"); + + + /********* + ** Private field + *********/ + /// Get the name of a save directory for the current player. + private static string GetSaveFolderName() + { + string prefix = new string(Game1.player.name.Where(char.IsLetterOrDigit).ToArray()); + return $"{prefix}_{Game1.uniqueIDForThisGame}"; + } } } \ No newline at end of file diff --git a/src/StardewModdingAPI/Extensions.cs b/src/StardewModdingAPI/Extensions.cs deleted file mode 100644 index 9a8c55f4..00000000 --- a/src/StardewModdingAPI/Extensions.cs +++ /dev/null @@ -1,78 +0,0 @@ -using System; -using System.Collections; -using System.Collections.Generic; -using System.Linq; -using System.Reflection; -using Microsoft.Xna.Framework.Input; - -namespace StardewModdingAPI -{ - public static class Extensions - { - public static Random Random = new Random(); - - public static bool IsKeyDown(this Keys key) - { - return Keyboard.GetState().IsKeyDown(key); - } - - public static string ToSingular(this IEnumerable ienum, string split = ", ") // where T : class - { - //Apparently Keys[] won't split normally :l - if (typeof(T) == typeof(Keys)) - { - return string.Join(split, ienum.ToArray()); - } - return string.Join(split, ienum); - } - - public static bool IsInt32(this object o) - { - int i; - return int.TryParse(o.ToString(), out i); - } - - public static int AsInt32(this object o) - { - return int.Parse(o.ToString()); - } - - public static int GetHash(this IEnumerable enumerable) - { - var hash = 0; - foreach (var v in enumerable) - { - hash ^= v.GetHashCode(); - } - return hash; - } - - public static FieldInfo GetBaseFieldInfo(this Type t, string name) - { - return t.GetField(name, BindingFlags.Instance | BindingFlags.NonPublic | BindingFlags.Static); - } - - public static T GetBaseFieldValue(this Type t, object o, string name) where T : class - { - return t.GetBaseFieldInfo(name).GetValue(o) as T; - } - - public static void SetBaseFieldValue(this Type t, object o, string name, object newValue) where T : class - { - t.GetBaseFieldInfo(name).SetValue(o, newValue as T); - } - - public static string RemoveNumerics(this string st) - { - var s = st; - foreach (var c in s) - { - if (!char.IsLetterOrDigit(c)) - { - s = s.Replace(c.ToString(), ""); - } - } - return s; - } - } -} \ No newline at end of file diff --git a/src/StardewModdingAPI/Inheritance/SGame.cs b/src/StardewModdingAPI/Inheritance/SGame.cs index 74a3d5d5..bd6a3491 100644 --- a/src/StardewModdingAPI/Inheritance/SGame.cs +++ b/src/StardewModdingAPI/Inheritance/SGame.cs @@ -1,4 +1,5 @@ using System; +using System.Collections; using System.Collections.Generic; using System.Linq; using System.Reflection; @@ -134,15 +135,15 @@ namespace StardewModdingAPI.Inheritance /// The game's current render target. public RenderTarget2D Screen { - get { return typeof(Game1).GetBaseFieldValue(Program.gamePtr, "screen"); } - set { typeof(Game1).SetBaseFieldValue(this, "screen", value); } + get { return this.GetBaseFieldValue("screen"); } + set { this.SetBaseFieldValue("screen", value); } } /// The game's current background color. public Color BgColour { - get { return (Color)typeof(Game1).GetBaseFieldValue(Program.gamePtr, "bgColor"); } - set { typeof(Game1).SetBaseFieldValue(this, "bgColor", value); } + get { return (Color)this.GetBaseFieldValue("bgColor"); } + set { this.SetBaseFieldValue("bgColor", value); } } /// The current game instance. @@ -879,10 +880,10 @@ namespace StardewModdingAPI.Inheritance } // raise location list changed - if (Game1.locations.GetHash() != this.PreviousGameLocations) + if (this.GetHash(Game1.locations) != this.PreviousGameLocations) { LocationEvents.InvokeLocationsChanged(Game1.locations); - this.PreviousGameLocations = Game1.locations.GetHash(); + this.PreviousGameLocations = this.GetHash(Game1.locations); } // raise current location changed @@ -944,7 +945,7 @@ namespace StardewModdingAPI.Inheritance } // raise current location's object list changed - int? objectHash = Game1.currentLocation?.objects?.GetHash(); + int? objectHash = Game1.currentLocation?.objects != null ? this.GetHash(Game1.currentLocation.objects) : (int?)null; if (objectHash != null && this.PreviousLocationObjects != objectHash) { LocationEvents.InvokeOnNewLocationObject(Game1.currentLocation.objects); @@ -1032,5 +1033,39 @@ namespace StardewModdingAPI.Inheritance } } } + + /// Get a hash value for an enumeration. + /// The enumeration of items to hash. + private int GetHash(IEnumerable enumerable) + { + var hash = 0; + foreach (var v in enumerable) + hash ^= v.GetHashCode(); + return hash; + } + + /// Get reflection metadata for a private field. + /// The field name. + private FieldInfo GetBaseFieldInfo(string name) + { + return typeof(Game1).GetField(name, BindingFlags.Instance | BindingFlags.NonPublic | BindingFlags.Static); + } + + /// Get the value of a private field. + /// The expected value type. + /// The field name. + private TValue GetBaseFieldValue(string name) where TValue : class + { + return this.GetBaseFieldInfo(name).GetValue(Program.gamePtr) as TValue; + } + + /// Set the value of a private field. + /// The expected value type. + /// The field name. + /// The value to set. + public void SetBaseFieldValue(string name, object value) where TValue : class + { + this.GetBaseFieldInfo(name).SetValue(Program.gamePtr, value as TValue); + } } -} \ No newline at end of file +} diff --git a/src/StardewModdingAPI/Log.cs b/src/StardewModdingAPI/Log.cs index 15c4ce55..abf6e36a 100644 --- a/src/StardewModdingAPI/Log.cs +++ b/src/StardewModdingAPI/Log.cs @@ -7,6 +7,9 @@ namespace StardewModdingAPI { public static class Log { + /// A pseudorandom number generator used to generate log files. + private static readonly Random Random = new Random(); + private static readonly LogWriter _writer; static Log() @@ -38,9 +41,8 @@ namespace StardewModdingAPI public static void Application_ThreadException(object sender, ThreadExceptionEventArgs e) { Console.WriteLine("A thread exception has been caught"); - File.WriteAllText(Path.Combine(Constants.LogDir, $"MODDED_ErrorLog.Log_{Extensions.Random.Next(100000000, 999999999)}.txt"), e.Exception.ToString()); + File.WriteAllText(Path.Combine(Constants.LogDir, $"MODDED_ErrorLog.Log_{Log.Random.Next(100000000, 999999999)}.txt"), e.Exception.ToString()); } - #endregion #region Sync Logging diff --git a/src/StardewModdingAPI/Program.cs b/src/StardewModdingAPI/Program.cs index 3bfaee0d..1d4c6dcc 100644 --- a/src/StardewModdingAPI/Program.cs +++ b/src/StardewModdingAPI/Program.cs @@ -363,11 +363,11 @@ namespace StardewModdingAPI Log.AsyncR("The command specified could not be found"); else { - Log.AsyncY(fnd.CommandArgs.Length > 0 ? $"{fnd.CommandName}: {fnd.CommandDesc} - {fnd.CommandArgs.ToSingular()}" : $"{fnd.CommandName}: {fnd.CommandDesc}"); + Log.AsyncY(fnd.CommandArgs.Length > 0 ? $"{fnd.CommandName}: {fnd.CommandDesc} - {string.Join(", ", fnd.CommandArgs)}" : $"{fnd.CommandName}: {fnd.CommandDesc}"); } } else - Log.AsyncY("Commands: " + Command.RegisteredCommands.Select(x => x.CommandName).ToSingular()); + Log.AsyncY("Commands: " + string.Join(", ", Command.RegisteredCommands.Select(x => x.CommandName))); } } } diff --git a/src/StardewModdingAPI/StardewModdingAPI.csproj b/src/StardewModdingAPI/StardewModdingAPI.csproj index cf8c58cb..ddab8734 100644 --- a/src/StardewModdingAPI/StardewModdingAPI.csproj +++ b/src/StardewModdingAPI/StardewModdingAPI.csproj @@ -193,7 +193,6 @@ - -- cgit