split up extension files

Pathoschild · Pathoschild · commit 87bfc1b09340 · 2026-03-26T00:48:58.000-04:00
diff --git a/src/SMAPI.Web/Controllers/JsonValidatorController.cs b/src/SMAPI.Web/Controllers/JsonValidatorController.cs
@@ -9,6 +9,7 @@
 using Newtonsoft.Json.Linq;
 using Newtonsoft.Json.Schema;
 using StardewModdingAPI.Web.Framework;
+using StardewModdingAPI.Web.Framework.Extensions;
 using StardewModdingAPI.Web.Framework.Storage;
 using StardewModdingAPI.Web.ViewModels.JsonValidator;
 
diff --git a/src/SMAPI.Web/Controllers/LogParserController.cs b/src/SMAPI.Web/Controllers/LogParserController.cs
@@ -8,6 +8,7 @@
 using Newtonsoft.Json;
 using StardewModdingAPI.Toolkit.Utilities;
 using StardewModdingAPI.Web.Framework;
+using StardewModdingAPI.Web.Framework.Extensions;
 using StardewModdingAPI.Web.Framework.LogParsing;
 using StardewModdingAPI.Web.Framework.LogParsing.Models;
 using StardewModdingAPI.Web.Framework.Storage;
diff --git a/src/SMAPI.Web/Controllers/ModsApiController.cs b/src/SMAPI.Web/Controllers/ModsApiController.cs
@@ -23,6 +23,7 @@
 using StardewModdingAPI.Web.Framework.Clients.Nexus;
 using StardewModdingAPI.Web.Framework.Clients.UpdateManifest;
 using StardewModdingAPI.Web.Framework.ConfigModels;
+using StardewModdingAPI.Web.Framework.Extensions;
 using StardewModdingAPI.Web.Framework.Metrics;
 
 namespace StardewModdingAPI.Web.Controllers;
diff --git a/src/SMAPI.Web/Framework/Extensions/RazorPageBaseExtensions.cs b/src/SMAPI.Web/Framework/Extensions/RazorPageBaseExtensions.cs
@@ -0,0 +1,24 @@
+using Microsoft.AspNetCore.Html;
+using Microsoft.AspNetCore.Mvc.Razor;
+using Microsoft.AspNetCore.Mvc.Rendering;
+using Newtonsoft.Json;
+
+namespace StardewModdingAPI.Web.Framework.Extensions;
+
+/// <summary>Provides extensions for <see cref="RazorPageBase"/>.</summary>
+public static class RazorPageBaseExtensions
+{
+    /// <param name="page">The page to extend.</param>
+    extension(RazorPageBase page)
+    {
+        /// <summary>Get a serialized JSON representation of the value.</summary>
+        /// <param name="value">The value to serialize.</param>
+        /// <returns>The serialized JSON.</returns>
+        /// <remarks>This bypasses unnecessary validation (e.g. not allowing null values) in <see cref="IJsonHelper.Serialize"/>.</remarks>
+        public IHtmlContent ForJson(object? value)
+        {
+            string json = JsonConvert.SerializeObject(value);
+            return new HtmlString(json);
+        }
+    }
+}
diff --git a/src/SMAPI.Web/Framework/Extensions/UrlHelperExtensions.cs b/src/SMAPI.Web/Framework/Extensions/UrlHelperExtensions.cs
@@ -1,24 +1,14 @@
 using System;
 using JetBrains.Annotations;
-using Microsoft.AspNetCore.Html;
 using Microsoft.AspNetCore.Http;
 using Microsoft.AspNetCore.Mvc;
-using Microsoft.AspNetCore.Mvc.Razor;
-using Microsoft.AspNetCore.Mvc.Rendering;
 using Microsoft.AspNetCore.Routing;
-using Newtonsoft.Json;
 
-namespace StardewModdingAPI.Web.Framework;
+namespace StardewModdingAPI.Web.Framework.Extensions;
 
-/// <summary>Provides extensions on ASP.NET Core types.</summary>
-public static class Extensions
+/// <summary>Provides extensions for <see cref="IUrlHelper"/>.</summary>
+public static class UrlHelperExtensions
 {
-    /*********
-    ** Public methods
-    *********/
-    /****
-    ** View helpers
-    ****/
     /// <param name="helper">The URL helper to extend.</param>
     extension(IUrlHelper helper)
     {
@@ -60,18 +50,4 @@ public string ContentWithCacheBust(string url)
             return helper.Content($"{url}{delimiter}v={Program.CacheBustValue}");
         }
     }
-
-    /// <param name="page">The page to extend.</param>
-    extension(RazorPageBase page)
-    {
-        /// <summary>Get a serialized JSON representation of the value.</summary>
-        /// <param name="value">The value to serialize.</param>
-        /// <returns>The serialized JSON.</returns>
-        /// <remarks>This bypasses unnecessary validation (e.g. not allowing null values) in <see cref="IJsonHelper.Serialize"/>.</remarks>
-        public IHtmlContent ForJson(object? value)
-        {
-            string json = JsonConvert.SerializeObject(value);
-            return new HtmlString(json);
-        }
-    }
 }
diff --git a/src/SMAPI.Web/Views/Index/Index.cshtml b/src/SMAPI.Web/Views/Index/Index.cshtml
@@ -1,4 +1,4 @@
-@using StardewModdingAPI.Web.Framework
+@using StardewModdingAPI.Web.Framework.Extensions
 @model StardewModdingAPI.Web.ViewModels.IndexModel
 @{
     ViewData["Title"] = "SMAPI";
diff --git a/src/SMAPI.Web/Views/Index/Privacy.cshtml b/src/SMAPI.Web/Views/Index/Privacy.cshtml
@@ -1,4 +1,4 @@
-@using StardewModdingAPI.Web.Framework
+@using StardewModdingAPI.Web.Framework.Extensions
 @{
     ViewData["Title"] = "SMAPI privacy notes";
 }
diff --git a/src/SMAPI.Web/Views/JsonValidator/Index.cshtml b/src/SMAPI.Web/Views/JsonValidator/Index.cshtml
@@ -1,5 +1,5 @@
 @using Humanizer
-@using StardewModdingAPI.Web.Framework
+@using StardewModdingAPI.Web.Framework.Extensions
 @using StardewModdingAPI.Web.ViewModels.JsonValidator
 @model JsonValidatorModel
 
diff --git a/src/SMAPI.Web/Views/LogParser/Index.cshtml b/src/SMAPI.Web/Views/LogParser/Index.cshtml
@@ -1,6 +1,7 @@
 @using Humanizer
 @using StardewModdingAPI.Toolkit.Utilities
 @using StardewModdingAPI.Web.Framework
+@using StardewModdingAPI.Web.Framework.Extensions
 @using StardewModdingAPI.Web.Framework.LogParsing.Models
 @using StardewModdingAPI.Web.ViewModels
 @model StardewModdingAPI.Web.ViewModels.LogParserModel
diff --git a/src/SMAPI.Web/Views/Mods/Index.cshtml b/src/SMAPI.Web/Views/Mods/Index.cshtml
@@ -1,5 +1,5 @@
 @using Humanizer
-@using StardewModdingAPI.Web.Framework
+@using StardewModdingAPI.Web.Framework.Extensions
 @model StardewModdingAPI.Web.ViewModels.ModListModel
 @{
     ViewData["Title"] = "Mod compatibility";
diff --git a/src/SMAPI.Web/Views/Shared/_Layout.cshtml b/src/SMAPI.Web/Views/Shared/_Layout.cshtml
@@ -1,6 +1,6 @@
 @using Microsoft.Extensions.Options
-@using StardewModdingAPI.Web.Framework
 @using StardewModdingAPI.Web.Framework.ConfigModels
+@using StardewModdingAPI.Web.Framework.Extensions
 @inject IOptions<SiteConfig> SiteConfig
 
 <!DOCTYPE html>
diff --git a/src/SMAPI/Framework/Content/AssetDataForImage.cs b/src/SMAPI/Framework/Content/AssetDataForImage.cs
@@ -3,6 +3,7 @@
 using System.Diagnostics.CodeAnalysis;
 using Microsoft.Xna.Framework;
 using Microsoft.Xna.Framework.Graphics;
+using StardewModdingAPI.Framework.Extensions;
 using StardewValley;
 
 namespace StardewModdingAPI.Framework.Content;
diff --git a/src/SMAPI/Framework/ContentCoordinator.cs b/src/SMAPI/Framework/ContentCoordinator.cs
@@ -11,6 +11,7 @@
 using StardewModdingAPI.Events;
 using StardewModdingAPI.Framework.Content;
 using StardewModdingAPI.Framework.ContentManagers;
+using StardewModdingAPI.Framework.Extensions;
 using StardewModdingAPI.Framework.Reflection;
 using StardewModdingAPI.Framework.Utilities;
 using StardewModdingAPI.Metadata;
diff --git a/src/SMAPI/Framework/ContentManagers/BaseContentManager.cs b/src/SMAPI/Framework/ContentManagers/BaseContentManager.cs
@@ -10,6 +10,7 @@
 using Microsoft.Xna.Framework.Graphics;
 using StardewModdingAPI.Framework.Content;
 using StardewModdingAPI.Framework.Exceptions;
+using StardewModdingAPI.Framework.Extensions;
 using StardewModdingAPI.Framework.Reflection;
 using StardewValley;
 
diff --git a/src/SMAPI/Framework/ContentManagers/GameContentManager.cs b/src/SMAPI/Framework/ContentManagers/GameContentManager.cs
@@ -8,6 +8,7 @@
 using StardewModdingAPI.Events;
 using StardewModdingAPI.Framework.Content;
 using StardewModdingAPI.Framework.Exceptions;
+using StardewModdingAPI.Framework.Extensions;
 using StardewModdingAPI.Framework.Reflection;
 using StardewModdingAPI.Framework.Utilities;
 using StardewModdingAPI.Internal;
diff --git a/src/SMAPI/Framework/ContentManagers/ModContentManager.cs b/src/SMAPI/Framework/ContentManagers/ModContentManager.cs
@@ -12,6 +12,7 @@
 using SkiaSharp;
 using StardewModdingAPI.Framework.Content;
 using StardewModdingAPI.Framework.Exceptions;
+using StardewModdingAPI.Framework.Extensions;
 using StardewModdingAPI.Framework.Reflection;
 using StardewModdingAPI.Toolkit.Serialization;
 using StardewModdingAPI.Toolkit.Utilities;
diff --git a/src/SMAPI/Framework/Events/ManagedEvent.cs b/src/SMAPI/Framework/Events/ManagedEvent.cs
@@ -3,6 +3,7 @@
 using System.Linq;
 using System.Reflection;
 using StardewModdingAPI.Events;
+using StardewModdingAPI.Framework.Extensions;
 using StardewModdingAPI.Internal;
 
 namespace StardewModdingAPI.Framework.Events;
diff --git a/src/SMAPI/Framework/Extensions/ClickableMenuExtensions.cs b/src/SMAPI/Framework/Extensions/ClickableMenuExtensions.cs
@@ -0,0 +1,25 @@
+using System.Collections.Generic;
+using System.Linq;
+using StardewValley.Menus;
+
+namespace StardewModdingAPI.Framework.Extensions;
+
+/// <summary>Provides internal extensions for <see cref="IClickableMenu"/>.</summary>
+internal static class ClickableMenuExtensions
+{
+    /// <param name="menu">The clickable menu to extend.</param>
+    extension(IClickableMenu menu)
+    {
+        /// <summary>Get a string representation of the menu chain to the given menu (including the specified menu), in parent to child order.</summary>
+        public string GetMenuChainLabel()
+        {
+            static IEnumerable<IClickableMenu> GetAncestors(IClickableMenu menu)
+            {
+                for (; menu != null; menu = menu.GetParentMenu())
+                    yield return menu;
+            }
+
+            return string.Join(" > ", GetAncestors(menu).Reverse().Select(p => p.GetType().FullName));
+        }
+    }
+}
diff --git a/src/SMAPI/Framework/Extensions/ManagedEventExtensions.cs b/src/SMAPI/Framework/Extensions/ManagedEventExtensions.cs
@@ -0,0 +1,20 @@
+using StardewModdingAPI.Framework.Events;
+
+namespace StardewModdingAPI.Framework.Extensions;
+
+/// <summary>Provides internal extensions for <see cref="ManagedEvent{T}"/>.</summary>
+internal static class ManagedEventExtensions
+{
+    /// <typeparam name="TEventArgs">The event args type to construct.</typeparam>
+    /// <param name="event">The event to extend.</param>
+    extension<TEventArgs>(ManagedEvent<TEventArgs> @event)
+        where TEventArgs : new()
+    {
+        /// <summary>Raise the event using the default event args and notify all handlers.</summary>
+        public void RaiseEmpty()
+        {
+            if (@event.HasListeners)
+                @event.Raise(Singleton<TEventArgs>.Instance);
+        }
+    }
+}
diff --git a/src/SMAPI/Framework/Extensions/ModMetadataExtensions.cs b/src/SMAPI/Framework/Extensions/ModMetadataExtensions.cs
@@ -0,0 +1,30 @@
+using System;
+
+namespace StardewModdingAPI.Framework.Extensions;
+
+/// <summary>Provides internal extensions for <see cref="IModMetadata"/>.</summary>
+internal static class ModMetadataExtensions
+{
+    /// <param name="metadata">The mod metadata to extend.</param>
+    extension(IModMetadata metadata)
+    {
+        /// <summary>Log a message using the mod's monitor.</summary>
+        /// <param name="message">The message to log.</param>
+        /// <param name="level">The log severity level.</param>
+        public void LogAsMod(string message, LogLevel level = LogLevel.Trace)
+        {
+            if (metadata.Monitor is null)
+                throw new InvalidOperationException($"Can't log as mod {metadata.DisplayName}: mod is broken or a content pack. Logged message:\n[{level}] {message}");
+
+            metadata.Monitor.Log(message, level);
+        }
+
+        /// <summary>Log a message using the mod's monitor, but only if it hasn't already been logged since the last game launch.</summary>
+        /// <param name="message">The message to log.</param>
+        /// <param name="level">The log severity level.</param>
+        public void LogAsModOnce(string message, LogLevel level = LogLevel.Trace)
+        {
+            metadata.Monitor?.LogOnce(message, level);
+        }
+    }
+}
diff --git a/src/SMAPI/Framework/Extensions/MonitorExtensions.cs b/src/SMAPI/Framework/Extensions/MonitorExtensions.cs
@@ -0,0 +1,24 @@
+using System.Collections.Generic;
+
+namespace StardewModdingAPI.Framework.Extensions;
+
+/// <summary>Provides internal extensions for <see cref="IMonitor"/>.</summary>
+internal static class MonitorExtensions
+{
+    /// <param name="monitor">The monitor to extend.</param>
+    extension(IMonitor monitor)
+    {
+        /// <summary>Log a message for the player or developer the first time it occurs.</summary>
+        /// <param name="hash">The hash of logged messages.</param>
+        /// <param name="message">The message to log.</param>
+        /// <param name="level">The log severity level.</param>
+        public void LogOnce(HashSet<string> hash, string message, LogLevel level = LogLevel.Trace)
+        {
+            if (!hash.Contains(message))
+            {
+                monitor.Log(message, level);
+                hash.Add(message);
+            }
+        }
+    }
+}
diff --git a/src/SMAPI/Framework/Extensions/ReaderWriterLockSlimExtensions.cs b/src/SMAPI/Framework/Extensions/ReaderWriterLockSlimExtensions.cs
@@ -0,0 +1,74 @@
+using System;
+using System.Threading;
+
+namespace StardewModdingAPI.Framework.Extensions;
+
+/// <summary>Provides internal extensions for <see cref="ReaderWriterLockSlim"/>.</summary>
+internal static class ReaderWriterLockSlimExtensions
+{
+    /// <param name="lock">The lock to extend.</param>
+    extension(ReaderWriterLockSlim @lock)
+    {
+        /// <summary>Run code within a read lock.</summary>
+        /// <param name="action">The action to perform.</param>
+        public void InReadLock(Action action)
+        {
+            @lock.EnterReadLock();
+            try
+            {
+                action();
+            }
+            finally
+            {
+                @lock.ExitReadLock();
+            }
+        }
+
+        /// <summary>Run code within a read lock.</summary>
+        /// <typeparam name="TReturn">The action's return value.</typeparam>
+        /// <param name="action">The action to perform.</param>
+        public TReturn InReadLock<TReturn>(Func<TReturn> action)
+        {
+            @lock.EnterReadLock();
+            try
+            {
+                return action();
+            }
+            finally
+            {
+                @lock.ExitReadLock();
+            }
+        }
+
+        /// <summary>Run code within a write lock.</summary>
+        /// <param name="action">The action to perform.</param>
+        public void InWriteLock(Action action)
+        {
+            @lock.EnterWriteLock();
+            try
+            {
+                action();
+            }
+            finally
+            {
+                @lock.ExitWriteLock();
+            }
+        }
+
+        /// <summary>Run code within a write lock.</summary>
+        /// <typeparam name="TReturn">The action's return value.</typeparam>
+        /// <param name="action">The action to perform.</param>
+        public TReturn InWriteLock<TReturn>(Func<TReturn> action)
+        {
+            @lock.EnterWriteLock();
+            try
+            {
+                return action();
+            }
+            finally
+            {
+                @lock.ExitWriteLock();
+            }
+        }
+    }
+}
diff --git a/src/SMAPI/Framework/Extensions/SpriteBatchExtensions.cs b/src/SMAPI/Framework/Extensions/SpriteBatchExtensions.cs
@@ -0,0 +1,19 @@
+using Microsoft.Xna.Framework.Graphics;
+using StardewModdingAPI.Framework.Reflection;
+
+namespace StardewModdingAPI.Framework.Extensions;
+
+/// <summary>Provides internal extensions for <see cref="SpriteBatch"/>.</summary>
+internal static class SpriteBatchExtensions
+{
+    /// <param name="spriteBatch">The sprite batch to extend.</param>
+    extension(SpriteBatch spriteBatch)
+    {
+        /// <summary>Get whether the sprite batch is between a begin and end pair.</summary>
+        /// <param name="reflection">The reflection helper with which to access private fields.</param>
+        public bool IsOpen(Reflector reflection)
+        {
+            return reflection.GetField<bool>(spriteBatch, "_beginCalled").GetValue();
+        }
+    }
+}
diff --git a/src/SMAPI/Framework/Extensions/Texture2dExtensions.cs b/src/SMAPI/Framework/Extensions/Texture2dExtensions.cs
diff --git a/src/SMAPI/Framework/InternalExtensions.cs b/src/SMAPI/Framework/InternalExtensions.cs
diff --git a/src/SMAPI/Framework/ModLoading/AssemblyLoader.cs b/src/SMAPI/Framework/ModLoading/AssemblyLoader.cs
diff --git a/src/SMAPI/Framework/SCore.cs b/src/SMAPI/Framework/SCore.cs
diff --git a/src/SMAPI/Framework/SGame.cs b/src/SMAPI/Framework/SGame.cs
diff --git a/src/SMAPI/Framework/SModHooks.cs b/src/SMAPI/Framework/SModHooks.cs

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-@using StardewModdingAPI.Web.Framework`
	`1`	`+@using StardewModdingAPI.Web.Framework.Extensions`
`2`	`2`	`@model StardewModdingAPI.Web.ViewModels.IndexModel`
`3`	`3`	`@{`
`4`	`4`	`ViewData["Title"] = "SMAPI";`