From 02022599e5760c0221882c4e58ddd36ea113a866 Mon Sep 17 00:00:00 2001
From: goat <goatsdev@protonmail.com>
Date: Fri, 7 Jun 2024 21:04:31 +0200
Subject: [PATCH] console: add public interface

---
 Dalamud/Console/ConsoleManager.cs             |   4 +-
 Dalamud/Console/ConsoleManagerPluginScoped.cs | 174 ++++++++++++++++++
 Dalamud/Plugin/Services/IConsole.cs           | 130 +++++++++++++
 3 files changed, 306 insertions(+), 2 deletions(-)
 create mode 100644 Dalamud/Console/ConsoleManagerPluginScoped.cs
 create mode 100644 Dalamud/Plugin/Services/IConsole.cs

diff --git a/Dalamud/Console/ConsoleManager.cs b/Dalamud/Console/ConsoleManager.cs
index c4c68e033..5ee2b6d72 100644
--- a/Dalamud/Console/ConsoleManager.cs
+++ b/Dalamud/Console/ConsoleManager.cs
@@ -191,7 +191,7 @@ internal partial class ConsoleManager : IServiceType
             return false;
         
         var entryName = matches[0].Value;
-        if (string.IsNullOrEmpty(entryName) || entryName.Any(x => x == ' '))
+        if (string.IsNullOrEmpty(entryName) || entryName.Any(char.IsWhiteSpace))
         {
             Log.Error("No valid command specified");
             return false;
@@ -419,7 +419,7 @@ internal partial class ConsoleManager : IServiceType
     /// </summary>
     private class ConsoleCommand : ConsoleEntry, IConsoleCommand
     {
-        private Delegate func;
+        private readonly Delegate func;
         
         /// <summary>
         /// Initializes a new instance of the <see cref="ConsoleCommand"/> class.
diff --git a/Dalamud/Console/ConsoleManagerPluginScoped.cs b/Dalamud/Console/ConsoleManagerPluginScoped.cs
new file mode 100644
index 000000000..3d11aca18
--- /dev/null
+++ b/Dalamud/Console/ConsoleManagerPluginScoped.cs
@@ -0,0 +1,174 @@
+using System.Collections.Generic;
+using System.Linq;
+using System.Text.RegularExpressions;
+
+using Dalamud.IoC;
+using Dalamud.IoC.Internal;
+using Dalamud.Plugin.Internal.Types;
+using Dalamud.Plugin.Services;
+
+namespace Dalamud.Console;
+
+/// <summary>
+/// Plugin-scoped version of the console service.
+/// </summary>
+[PluginInterface]
+[InterfaceVersion("1.0")]
+[ServiceManager.ScopedService]
+#pragma warning disable SA1015
+[ResolveVia<IConsole>]
+#pragma warning restore SA1015
+public class ConsoleManagerPluginScoped : IConsole, IInternalDisposableService
+{
+    private readonly ConsoleManager console;
+    
+    private readonly List<IConsoleEntry> trackedEntries = new();
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="ConsoleManagerPluginScoped"/> class.
+    /// </summary>
+    /// <param name="plugin">The plugin this service belongs to.</param>
+    /// <param name="console">The console manager.</param>
+    [ServiceManager.ServiceConstructor]
+    internal ConsoleManagerPluginScoped(LocalPlugin plugin, ConsoleManager console)
+    {
+        this.console = console;
+        
+        this.Prefix = ConsoleManagerPluginUtil.GetSanitizedNamespaceName(plugin.InternalName);
+    }
+
+    /// <inheritdoc/>
+    public string Prefix { get; private set; }
+    
+    /// <inheritdoc/>
+    void IInternalDisposableService.DisposeService()
+    {
+        foreach (var trackedEntry in this.trackedEntries)
+        {
+            this.console.RemoveEntry(trackedEntry);
+        }
+        
+        this.trackedEntries.Clear();
+    }
+
+    /// <inheritdoc/>
+    public IConsoleCommand AddCommand(string name, string description, Func<bool> func)
+        => this.InternalAddCommand(name, description, func);
+
+    /// <inheritdoc/>
+    public IConsoleCommand AddCommand<T1>(string name, string description, Func<bool, T1> func)
+        => this.InternalAddCommand(name, description, func);
+
+    /// <inheritdoc/>
+    public IConsoleCommand AddCommand<T1, T2>(string name, string description, Func<bool, T1, T2> func)
+        => this.InternalAddCommand(name, description, func);
+
+    /// <inheritdoc/>
+    public IConsoleCommand AddCommand<T1, T2, T3>(string name, string description, Func<bool, T1, T2, T3> func)
+        => this.InternalAddCommand(name, description, func);
+
+    /// <inheritdoc/>
+    public IConsoleCommand AddCommand<T1, T2, T3, T4>(string name, string description, Func<bool, T1, T2, T3, T4> func)
+        => this.InternalAddCommand(name, description, func);
+
+    /// <inheritdoc/>
+    public IConsoleCommand AddCommand<T1, T2, T3, T4, T5>(string name, string description, Func<bool, T1, T2, T3, T4, T5> func)
+        => this.InternalAddCommand(name, description, func);
+
+    /// <inheritdoc/>
+    public IConsoleVariable<T> AddVariable<T>(string name, string description, T defaultValue)
+    {
+        var variable = this.console.AddVariable(this.GetPrefixedName(name), description, defaultValue);
+        this.trackedEntries.Add(variable);
+        return variable;
+    }
+
+    /// <inheritdoc/>
+    public IConsoleEntry AddAlias(string name, string alias)
+    {
+        var entry = this.console.AddAlias(this.GetPrefixedName(name), alias);
+        this.trackedEntries.Add(entry);
+        return entry;
+    }
+
+    /// <inheritdoc/>
+    public T GetVariable<T>(string name)
+    {
+        return this.console.GetVariable<T>(this.GetPrefixedName(name));
+    }
+
+    /// <inheritdoc/>
+    public void SetVariable<T>(string name, T value)
+    {
+        this.console.SetVariable(this.GetPrefixedName(name), value);
+    }
+
+    /// <inheritdoc/>
+    public void RemoveEntry(IConsoleEntry entry)
+    {
+        this.console.RemoveEntry(entry);
+        this.trackedEntries.Remove(entry);
+    }
+    
+    private string GetPrefixedName(string name)
+    {
+        ArgumentNullException.ThrowIfNull(name);
+        
+        // If the name is empty, return the prefix to allow for a single command or variable to be top-level.
+        if (name.Length == 0)
+            return this.Prefix;
+        
+        if (name.Any(char.IsWhiteSpace))
+            throw new ArgumentException("Name cannot contain whitespace.", nameof(name));
+        
+        return $"{this.Prefix}.{name}";
+    }
+    
+    private IConsoleCommand InternalAddCommand(string name, string description, Delegate func)
+    {
+        var command = this.console.AddCommand(this.GetPrefixedName(name), description, func);
+        this.trackedEntries.Add(command);
+        return command;
+    }
+}
+
+/// <summary>
+/// Utility functions for the console manager.
+/// </summary>
+internal static partial class ConsoleManagerPluginUtil
+{
+    private static readonly string[] ReservedNamespaces = ["dalamud", "xl"];
+    
+    /// <summary>
+    /// Get a sanitized namespace name from a plugin's internal name.
+    /// </summary>
+    /// <param name="pluginInternalName">The plugin's internal name.</param>
+    /// <returns>A sanitized namespace.</returns>
+    public static string GetSanitizedNamespaceName(string pluginInternalName)
+    {
+        // Must be lowercase
+        pluginInternalName = pluginInternalName.ToLowerInvariant();
+        
+        // Remove all non-alphabetic characters
+        pluginInternalName = NonAlphaRegex().Replace(pluginInternalName, string.Empty);
+        
+        // Remove reserved namespaces from the start or end
+        foreach (var reservedNamespace in ReservedNamespaces)
+        {
+            if (pluginInternalName.StartsWith(reservedNamespace))
+            {
+                pluginInternalName = pluginInternalName[reservedNamespace.Length..];
+            }
+            
+            if (pluginInternalName.EndsWith(reservedNamespace))
+            {
+                pluginInternalName = pluginInternalName[..^reservedNamespace.Length];
+            }
+        }
+        
+        return pluginInternalName;
+    }
+
+    [GeneratedRegex(@"[^a-z]")]
+    private static partial Regex NonAlphaRegex();
+}
diff --git a/Dalamud/Plugin/Services/IConsole.cs b/Dalamud/Plugin/Services/IConsole.cs
new file mode 100644
index 000000000..0b6832efb
--- /dev/null
+++ b/Dalamud/Plugin/Services/IConsole.cs
@@ -0,0 +1,130 @@
+using System.Diagnostics.CodeAnalysis;
+
+using Dalamud.Console;
+
+namespace Dalamud.Plugin.Services;
+
+/// <summary>
+/// Provides functions to register console commands and variables.
+/// </summary>
+[Experimental("Dalamud001")]
+public interface IConsole
+{
+    /// <summary>
+    /// Gets this plugin's namespace prefix, derived off its internal name.
+    /// This is the prefix that all commands and variables registered by this plugin will have.
+    /// If the internal name is "SamplePlugin", the prefix will be "sampleplugin.".
+    /// </summary>
+    public string Prefix { get; }
+
+    /// <summary>
+    /// Add a command to the console.
+    /// </summary>
+    /// <param name="name">The name of the command.</param>
+    /// <param name="description">A description of the command.</param>
+    /// <param name="func">Function to invoke when the command has been called. Must return a <see cref="bool"/> indicating success.</param>
+    /// <returns>The added command.</returns>
+    public IConsoleCommand AddCommand(string name, string description, Func<bool> func);
+
+    /// <summary>
+    /// Add a command to the console.
+    /// </summary>
+    /// <param name="name">The name of the command.</param>
+    /// <param name="description">A description of the command.</param>
+    /// <param name="func">Function to invoke when the command has been called. Must return a <see cref="bool"/> indicating success.</param>
+    /// <typeparam name="T1">The first argument to the command.</typeparam>
+    /// <returns>The added command.</returns>
+    public IConsoleCommand AddCommand<T1>(string name, string description, Func<bool, T1> func);
+
+    /// <summary>
+    /// Add a command to the console.
+    /// </summary>
+    /// <param name="name">The name of the command.</param>
+    /// <param name="description">A description of the command.</param>
+    /// <param name="func">Function to invoke when the command has been called. Must return a <see cref="bool"/> indicating success.</param>
+    /// <typeparam name="T1">The first argument to the command.</typeparam>
+    /// <typeparam name="T2">The second argument to the command.</typeparam>
+    /// <returns>The added command.</returns>
+    public IConsoleCommand AddCommand<T1, T2>(string name, string description, Func<bool, T1, T2> func);
+
+    /// <summary>
+    /// Add a command to the console.
+    /// </summary>
+    /// <param name="name">The name of the command.</param>
+    /// <param name="description">A description of the command.</param>
+    /// <param name="func">Function to invoke when the command has been called. Must return a <see cref="bool"/> indicating success.</param>
+    /// <typeparam name="T1">The first argument to the command.</typeparam>
+    /// <typeparam name="T2">The second argument to the command.</typeparam>
+    /// <typeparam name="T3">The third argument to the command.</typeparam>
+    /// <returns>The added command.</returns>
+    public IConsoleCommand AddCommand<T1, T2, T3>(string name, string description, Func<bool, T1, T2, T3> func);
+
+    /// <summary>
+    /// Add a command to the console.
+    /// </summary>
+    /// <param name="name">The name of the command.</param>
+    /// <param name="description">A description of the command.</param>
+    /// <param name="func">Function to invoke when the command has been called. Must return a <see cref="bool"/> indicating success.</param>
+    /// <typeparam name="T1">The first argument to the command.</typeparam>
+    /// <typeparam name="T2">The second argument to the command.</typeparam>
+    /// <typeparam name="T3">The third argument to the command.</typeparam>
+    /// <typeparam name="T4">The fourth argument to the command.</typeparam>
+    /// <returns>The added command.</returns>
+    public IConsoleCommand AddCommand<T1, T2, T3, T4>(
+        string name, string description, Func<bool, T1, T2, T3, T4> func);
+
+    /// <summary>
+    /// Add a command to the console.
+    /// </summary>
+    /// <param name="name">The name of the command.</param>
+    /// <param name="description">A description of the command.</param>
+    /// <param name="func">Function to invoke when the command has been called. Must return a <see cref="bool"/> indicating success.</param>
+    /// <typeparam name="T1">The first argument to the command.</typeparam>
+    /// <typeparam name="T2">The second argument to the command.</typeparam>
+    /// <typeparam name="T3">The third argument to the command.</typeparam>
+    /// <typeparam name="T4">The fourth argument to the command.</typeparam>
+    /// <typeparam name="T5">The fifth argument to the command.</typeparam>
+    /// <returns>The added command.</returns>
+    public IConsoleCommand AddCommand<T1, T2, T3, T4, T5>(
+        string name, string description, Func<bool, T1, T2, T3, T4, T5> func);
+
+    /// <summary>
+    /// Add a variable to the console.
+    /// </summary>
+    /// <param name="name">The name of the variable.</param>
+    /// <param name="description">A description of the variable.</param>
+    /// <param name="defaultValue">The default value of the variable.</param>
+    /// <typeparam name="T">The type of the variable.</typeparam>
+    /// <returns>The added variable.</returns>
+    public IConsoleVariable<T> AddVariable<T>(string name, string description, T defaultValue);
+
+    /// <summary>
+    /// Add an alias to a console entry.
+    /// </summary>
+    /// <param name="name">The name of the entry to add an alias for.</param>
+    /// <param name="alias">The alias to use.</param>
+    /// <returns>The added alias.</returns>
+    public IConsoleEntry AddAlias(string name, string alias);
+
+    /// <summary>
+    /// Get the value of a variable.
+    /// </summary>
+    /// <param name="name">The name of the variable.</param>
+    /// <typeparam name="T">The type of the variable.</typeparam>
+    /// <returns>The value of the variable.</returns>
+    public T GetVariable<T>(string name);
+
+    /// <summary>
+    /// Set the value of a variable.
+    /// </summary>
+    /// <param name="name">The name of the variable.</param>
+    /// <param name="value">The value to set.</param>
+    /// <typeparam name="T">The type of the value to set.</typeparam>
+    public void SetVariable<T>(string name, T value);
+
+    /// <summary>
+    /// Remove an entry from the console.
+    /// </summary>
+    /// <param name="entry">The entry to remove.</param>
+    public void RemoveEntry(IConsoleEntry entry);
+}