JonKazama-Hellion/HellionChat
1
0
Fork 0
Code Issues 1 Pull Requests 3 Actions Releases 49 Activity

chore: reformat after editorconfig update
Security / scan (push) Successful in 12s
Details

Browse Source 
Updated .editorconfig to set indent_style=space and indent_size=4 for C# files. Reformat all .cs files to apply the new indentation settings. No code logic changes, just whitespace reformatting.
also updated some comments in files in shorter and Precise way. No logic changes, just comment rewording for clarity and conciseness.
This commit is contained in:
JonKazama-Hellion
2026-05-10 19:54:39 +02:00
parent 3cabdf3e15
commit 4000bbd199
23 changed files with 203 additions and 800 deletions
Download Patch File Download Diff File Expand all files Collapse all files
HellionChat/Integrations/HonorificService.cs
+26 -87
View File
@@ -6,25 +6,17 @@ using Newtonsoft.Json;
namespace HellionChat.Integrations;
// We pull Newtonsoft.Json into this single file for IPC compatibility:
// Honorific serialises its TitleData with Newtonsoft (see
// Honorific-master/IpcProvider.cs:9 and CustomTitle.cs:12). Using the
// same library guarantees identical handling of System.Numerics.Vector3?
// and the enum fields we ignore. Newtonsoft is a transitive dependency
// via Dalamud, so no new NuGet entry is needed. The rest of HellionChat
// keeps using System.Text.Json.
// Newtonsoft.Json is used here for IPC compatibility with Honorific, which
// serialises TitleData with it. It's a transitive Dalamud dependency — no
// new NuGet entry needed. The rest of HellionChat uses System.Text.Json.
internal sealed class HonorificService : IDisposable
{
private const string IpcNamespace = "Honorific";
// Major version of the Honorific IPC contract HellionChat is built against.
// Used both by the runtime compatibility check and by the settings tab when
// it tells the user which major version we expected, so the literal lives
// in exactly one place.
// Major version of the Honorific IPC contract we're built against.
internal const uint ExpectedApiMajor = 3;
// IPC gates we subscribe to. Keep them as fields so Dispose can
// unsubscribe the same instances we subscribed in the constructor.
// IPC gates — kept as fields so Dispose can unsubscribe the same instances.
private readonly ICallGateSubscriber<(uint, uint)> _apiVersion;
private readonly ICallGateSubscriber<string> _getLocalCharacterTitle;
private readonly ICallGateSubscriber<string, object> _localCharacterTitleChanged;
@@ -48,23 +40,11 @@ internal sealed class HonorificService : IDisposable
_framework = framework;
_log = log;
// Dalamud caches gate objects per-name for the lifetime of the
// plugin interface, so we can register subscribers even when
// Honorific isn't loaded yet — the gate just won't fire. Calling
// InvokeFunc before Honorific is up will throw, which is why the
// initial pull below is wrapped in try-catch.
//
// Thread-context: plugin constructors run on Dalamud's plugin-loader
// thread, NOT the framework thread. Honorific's IPC handlers read
// ObjectTable.LocalPlayer (Honorific IpcProvider.cs:61), which throws
// "Not on main thread!" outside the framework thread. If Honorific is
// already loaded when HellionChat starts, a synchronous InvokeFunc
// here would surface that exception, the broad catch below would
// mark IsAvailable=false, and OnTitleChanged's `if (!IsAvailable)`
// gate would block every subsequent title update. We therefore
// schedule the initial pull onto the framework thread via
// IFramework.RunOnFrameworkThread so the IPC call sees the right
// thread context.
// Gate objects are cached per-name by Dalamud and safe to register
// before Honorific loads — they just won't fire until it does.
// Initial pull is scheduled on the framework thread because plugin
// constructors run on the loader thread, and Honorific's IPC handlers
// read ObjectTable.LocalPlayer which throws off the framework thread.
_apiVersion = pluginInterface.GetIpcSubscriber<(uint, uint)>($"{IpcNamespace}.ApiVersion");
_getLocalCharacterTitle = pluginInterface.GetIpcSubscriber<string>(
$"{IpcNamespace}.GetLocalCharacterTitle"
@@ -84,11 +64,8 @@ internal sealed class HonorificService : IDisposable
public void Dispose()
{
// Honorific may already be gone by the time we dispose. Wrap each
// unsubscribe so a missing gate doesn't prevent the others from
// unsubscribing — leaking even one subscription leaves a callback
// alive that captures `this`, which keeps the whole service alive
// and breaks plugin reload.
// Wrap each unsubscribe — a missing gate must not block the others.
// Leaking a subscription keeps this service alive across plugin reloads.
TryUnsubscribe(() => _localCharacterTitleChanged.Unsubscribe(OnTitleChanged));
TryUnsubscribe(() => _ready.Unsubscribe(OnReady));
TryUnsubscribe(() => _disposing.Unsubscribe(OnDisposing));
@@ -119,34 +96,21 @@ internal sealed class HonorificService : IDisposable
IsAvailable = true;
_versionWarningLogged = false;
// Pull the current title once at startup; from here on we rely
// on LocalCharacterTitleChanged events.
var json = _getLocalCharacterTitle.InvokeFunc();
CurrentTitle = ParseTitleJson(json);
}
catch (Exception ex)
{
// Honorific isn't installed or hasn't initialised yet. The Ready
// event will give us a second chance later. Log at Debug so
// users without Honorific don't see noise on every reload.
// Honorific not installed or not yet initialised — Ready will retry.
_log.Debug(ex, "Honorific not available at HellionChat startup; awaiting Ready.");
IsAvailable = false;
CurrentTitle = null;
}
}
// Honorific fires LocalCharacterTitleChanged through its nameplate hook
// (Honorific-master/Plugin.cs:665), which means we get title updates on
// character switches automatically as soon as the new character is
// rendered. While the user is in the character-select menu, HellionChat's
// window is hidden by default via HideWhenNotLoggedIn (Configuration.cs:152),
// so the stale-title window between logout and login isn't user-visible.
private void OnTitleChanged(string json)
{
// Don't update cached state when we've already decided we can't trust
// Honorific (e.g. version mismatch). Subscription stays live in case a
// compatible Honorific reloads, in which case Ready triggers TryInitialPull
// and sets IsAvailable back to true.
// Skip updates on version mismatch; subscription stays live for reload.
if (!IsAvailable)
return;
CurrentTitle = ParseTitleJson(json);
@@ -154,28 +118,16 @@ internal sealed class HonorificService : IDisposable
private void OnReady()
{
// Honorific loaded after HellionChat; redo the version check and
// initial pull. Idempotent on purpose — Honorific can fire Ready
// more than once across reloads.
//
// Honorific's NotifyReady may dispatch from any thread, and
// TryInitialPull eventually calls IPC handlers that read
// ObjectTable.LocalPlayer — same "Not on main thread!" hazard as
// the constructor path. Schedule onto the framework thread.
// Schedule on framework thread — NotifyReady can dispatch from any thread.
_framework.RunOnFrameworkThread(TryInitialPull);
}
private void OnDisposing()
{
// Honorific is unloading. Drop our cached state so the header
// hides on the next frame; subscriptions stay registered because
// the gates may come back later (Honorific reload).
//
// Race-note: Honorific's NotifyDisposing calls ChangedLocalCharacterTitle(null)
// BEFORE SendMessage on the Disposing gate (IpcProvider.cs:109-111),
// so OnTitleChanged is expected to fire first and already null out
// CurrentTitle. We re-clear here as belt-and-braces; should the
// ordering ever flip, ShouldRenderSlot would still gate on IsAvailable.
// Honorific unloading — clear cached state so the header hides next frame.
// Subscriptions stay registered in case Honorific reloads.
// CurrentTitle is already nulled by OnTitleChanged before this fires,
// re-clearing here is belt-and-braces.
CurrentTitle = null;
IsAvailable = false;
DetectedApiVersion = null;
@@ -193,28 +145,15 @@ internal sealed class HonorificService : IDisposable
}
}
// Threading note: Dalamud fires IPC events on the framework thread and
// ImGui renders on the framework thread, so OnTitleChanged and the
// render path that reads CurrentTitle never race — OnTitleChanged is
// safe to keep direct (no RunOnFrameworkThread wrap needed) because
// LocalCharacterTitleChanged delivery is framework-thread by Dalamud
// contract. If a future change moves either side onto a worker thread,
// switch to volatile/Interlocked for the CurrentTitle field.
// Threading: IPC events and ImGui both run on the framework thread, so
// OnTitleChanged and the render path never race — no volatile/Interlocked
// needed as long as Dalamud's framework-thread delivery contract holds.
//
// The constructor's initial pull and OnReady, on the other hand, are
// explicitly scheduled via IFramework.RunOnFrameworkThread because
// they run outside that contract: the constructor executes on the
// plugin-loader thread, and Honorific's NotifyReady can dispatch from
// any thread. Both call paths eventually invoke IPC handlers that read
// ObjectTable.LocalPlayer, which throws "Not on main thread!" off the
// framework thread — see the constructor comment block for context.
//
// Divergence from ChatTwo/Ipc/ExtraChat.cs: that file uses `volatile`
// on its state fields out of caution. We don't, because the framework-
// thread delivery is the documented Dalamud contract. If the two files
// ever need to share a threading audit, this is the place to revisit.
// Constructor and OnReady are exceptions: they run outside that contract
// (plugin-loader thread and Honorific's NotifyReady respectively), so both
// use RunOnFrameworkThread to safely reach ObjectTable.LocalPlayer.
// --- Pure-logic helpers below; tested via HellionChat.Tests/Integrations. ---
// --- Pure-logic helpers; tested via HellionChat.Tests/Integrations. ---
internal static HonorificTitleData? ParseTitleJson(string json)
{
HellionChat/Integrations/HonorificTitleData.cs
+3 -7
View File
@@ -2,13 +2,9 @@ using System.Numerics;
namespace HellionChat.Integrations;
// Local DTO mirroring Honorific's TitleData shape. We replicate the structure
// instead of referencing Honorific.dll because a hard build-time dependency
// would couple the two assemblies and break HellionChat at load time when
// Honorific is missing. Glow, Color3, GradientColourSet and GradientAnimationStyle
// are intentionally omitted — Cycle 1 renders text in the primary Color only;
// the "Honorific Full Fidelity" backlog item adds them later as a pure
// extension that won't break this DTO's existing consumers.
// Local DTO mirroring Honorific's TitleData — no hard reference to Honorific.dll
// so HellionChat loads cleanly when Honorific is absent.
// Glow/gradient fields omitted; Cycle 1 renders primary Color only.
internal sealed record HonorificTitleData(
string? Title,
bool IsPrefix,
HellionChat/Integrations/IntegrationLinks.cs
+1 -5
View File
@@ -1,10 +1,6 @@
namespace HellionChat.Integrations;
// External URLs for the third-party plugins HellionChat integrates with.
// Kept separate from BrandingLinks (which is for Hellion-owned URLs) so
// future cycles can extend this file with maintainer attribution links
// for Moodles, NotificationMaster, ExtraChat, etc. without polluting the
// brand-links class.
// Third-party plugin URLs — separate from BrandingLinks (Hellion-owned URLs).
internal static class IntegrationLinks
{
public const string HonorificRepo = "https://github.com/Caraxi/Honorific";