Obsolete (static) PluginLog for future removal

- Mark PluginLog as obsoleted and pending removal, encouraging users to switch to IPluginLog.
- Remove internal references to PluginLog.
This commit is contained in:
Kaz Wolfe 2023-09-22 17:01:10 -07:00
parent 43abb12710
commit 4f8de2e205
No known key found for this signature in database
GPG key ID: 258813F53A16EBB4
3 changed files with 15 additions and 13 deletions

View file

@ -1,10 +1,8 @@
using System; using System;
using System.IO; using System.IO;
using Dalamud.Configuration.Internal; using Dalamud.Configuration.Internal;
using Dalamud.Game.Command; using Dalamud.Game.Command;
using Dalamud.Interface.Windowing; using Dalamud.Interface.Windowing;
using Dalamud.Logging;
using Dalamud.Plugin; using Dalamud.Plugin;
using Dalamud.Plugin.Services; using Dalamud.Plugin.Services;
using Dalamud.Utility; using Dalamud.Utility;
@ -52,6 +50,8 @@ namespace Dalamud.CorePlugin
private readonly WindowSystem windowSystem = new("Dalamud.CorePlugin"); private readonly WindowSystem windowSystem = new("Dalamud.CorePlugin");
private Localization localization; private Localization localization;
private IPluginLog pluginLog;
/// <summary> /// <summary>
/// Initializes a new instance of the <see cref="PluginImpl"/> class. /// Initializes a new instance of the <see cref="PluginImpl"/> class.
/// </summary> /// </summary>
@ -63,6 +63,7 @@ namespace Dalamud.CorePlugin
{ {
// this.InitLoc(); // this.InitLoc();
this.Interface = pluginInterface; this.Interface = pluginInterface;
this.pluginLog = log;
this.windowSystem.AddWindow(new PluginWindow()); this.windowSystem.AddWindow(new PluginWindow());
@ -76,7 +77,7 @@ namespace Dalamud.CorePlugin
} }
catch (Exception ex) catch (Exception ex)
{ {
PluginLog.Error(ex, "kaboom"); log.Error(ex, "kaboom");
} }
} }
@ -130,13 +131,13 @@ namespace Dalamud.CorePlugin
} }
catch (Exception ex) catch (Exception ex)
{ {
PluginLog.Error(ex, "Boom"); this.pluginLog.Error(ex, "Boom");
} }
} }
private void OnCommand(string command, string args) private void OnCommand(string command, string args)
{ {
PluginLog.Information("Command called!"); this.pluginLog.Information("Command called!");
// this.window.IsOpen = true; // this.window.IsOpen = true;
} }

View file

@ -1,6 +1,5 @@
using System;
using System.Reflection; using System.Reflection;
using Dalamud.Plugin.Services;
using Serilog; using Serilog;
using Serilog.Events; using Serilog.Events;
@ -9,6 +8,11 @@ namespace Dalamud.Logging;
/// <summary> /// <summary>
/// Class offering various static methods to allow for logging in plugins. /// Class offering various static methods to allow for logging in plugins.
/// </summary> /// </summary>
/// <remarks>
/// PluginLog has been obsoleted and replaced by the <see cref="IPluginLog"/> service. Developers are encouraged to
/// move over as soon as reasonably possible for performance reasons.
/// </remarks>
[Obsolete("Static PluginLog will be removed in API 10. Developers should use IPluginLog.")]
public static class PluginLog public static class PluginLog
{ {
#region "Log" prefixed Serilog style methods #region "Log" prefixed Serilog style methods

View file

@ -1,11 +1,8 @@
using System; using System.Linq;
using System.Linq;
using System.Reflection; using System.Reflection;
using System.Runtime.InteropServices; using System.Runtime.InteropServices;
using Dalamud.Game; using Dalamud.Game;
using Dalamud.Hooking; using Dalamud.Hooking;
using Dalamud.Logging;
using Dalamud.Utility.Signatures.Wrappers; using Dalamud.Utility.Signatures.Wrappers;
using Serilog; using Serilog;
@ -23,7 +20,7 @@ public static class SignatureHelper
/// <see cref="SignatureAttribute"/>. /// <see cref="SignatureAttribute"/>.
/// </summary> /// </summary>
/// <param name="self">The object to initialise.</param> /// <param name="self">The object to initialise.</param>
/// <param name="log">If warnings should be logged using <see cref="PluginLog"/>.</param> /// <param name="log">If warnings should be logged.</param>
public static void Initialise(object self, bool log = true) public static void Initialise(object self, bool log = true)
{ {
var scanner = Service<SigScanner>.Get(); var scanner = Service<SigScanner>.Get();
@ -61,7 +58,7 @@ public static class SignatureHelper
: message; : message;
if (fallible) if (fallible)
{ {
PluginLog.Warning(errorMsg); Log.Warning(errorMsg);
} }
else else
{ {