ToxicMushroom/Dalamud
1
0
Fork 0
mirror of https://github.com/goatcorp/Dalamud.git synced 2025-12-12 18:27:23 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

fix disposes and add TextureWrapIconSource

Browse source
This commit is contained in:
Soreepeong 2024-02-26 04:16:36 +09:00
parent 9644dd9922
commit 42b6f8fd4b
10 changed files with 187 additions and 81 deletions
Download patch file Download diff file Expand all files Collapse all files

25
Dalamud/Interface/ImGuiNotification/IActiveNotification.cs
View file

@ -56,11 +56,6 @@ public interface IActiveNotification : INotification
/// <inheritdoc cref="INotification.Type"/>
new NotificationType Type { get; set; }
/// <summary>Gets or sets the icon source.</summary>
/// <remarks>Setting a new value to this property does not change the icon. Use <see cref="UpdateIcon"/> to do so.
/// </remarks>
new INotificationIconSource? IconSource { get; set; }
/// <inheritdoc cref="INotification.Expiry"/>
new DateTime Expiry { get; set; }
@ -86,25 +81,19 @@ public interface IActiveNotification : INotification
/// <remarks>This includes when the hide animation is being played.</remarks>
bool IsDismissed { get; }
/// <summary>Clones this notification as a <see cref="Notification"/>.</summary>
/// <returns>A new instance of <see cref="Notification"/>.</returns>
Notification CloneNotification();
/// <summary>Dismisses this notification.</summary>
void DismissNow();
/// <summary>Updates the notification data.</summary>
/// <remarks>
/// Call <see cref="UpdateIcon"/> to update the icon using the new <see cref="INotification.IconSource"/>.
/// If <see cref="IsDismissed"/> is <c>true</c>, then this function is a no-op.
/// </remarks>
/// <param name="newNotification">The new notification entry.</param>
void Update(INotification newNotification);
/// <summary>Loads the icon again using <see cref="INotification.IconSource"/>.</summary>
/// <summary>Loads the icon again using the same <see cref="INotification.IconSource"/>.</summary>
/// <remarks>If <see cref="IsDismissed"/> is <c>true</c>, then this function is a no-op.</remarks>
void UpdateIcon();
/// <summary>Disposes the previous icon source, take ownership of the new icon source,
/// and calls <see cref="UpdateIcon"/>.</summary>
/// <param name="newIconSource">Thew new icon source.</param>
/// <remarks>If <see cref="IsDismissed"/> is <c>true</c>, then this function is a no-op.</remarks>
void UpdateIconSource(INotificationIconSource? newIconSource);
/// <summary>Generates a new value to use for <see cref="Id"/>.</summary>
/// <returns>The new value.</returns>
internal static long CreateNewId() => Interlocked.Increment(ref idCounter);

9
Dalamud/Interface/ImGuiNotification/INotification.cs
View file

@ -4,7 +4,7 @@ using Dalamud.Interface.Internal.Notifications;
namespace Dalamud.Interface.ImGuiNotification;
/// <summary>Represents a notification.</summary>
public interface INotification
public interface INotification : IDisposable
{
/// <summary>Gets the content body of the notification.</summary>
string Content { get; }
@ -16,10 +16,15 @@ public interface INotification
NotificationType Type { get; }
/// <summary>Gets the icon source.</summary>
/// <remarks>The following icon sources are currently available.<br />
/// <remarks>
/// The assigned value will be disposed upon the <see cref="IDisposable.Dispose"/> call on this instance of
/// <see cref="INotification"/>.<br />
/// <br />
/// The following icon sources are currently available.<br />
/// <ul>
/// <li><see cref="SeIconCharIconSource"/></li>
/// <li><see cref="FontAwesomeIconIconSource"/></li>
/// <li><see cref="TextureWrapIconSource"/></li>
/// <li><see cref="TextureWrapTaskIconSource"/></li>
/// <li><see cref="GamePathIconSource"/></li>
/// <li><see cref="FilePathIconSource"/></li>

63
Dalamud/Interface/ImGuiNotification/IconSource/TextureWrapIconSource.cs Normal file
View file

@ -0,0 +1,63 @@
using System.Numerics;
using System.Threading;
using Dalamud.Interface.ImGuiNotification.Internal;
using Dalamud.Interface.Internal;
using Dalamud.Plugin.Internal.Types;
namespace Dalamud.Interface.ImGuiNotification.IconSource;
/// <summary>Represents the use of future <see cref="IDalamudTextureWrap"/> as the icon of a notification.</summary>
/// <remarks>If there was no texture loaded for any reason, the plugin icon will be displayed instead.</remarks>
public sealed class TextureWrapIconSource : INotificationIconSource.IInternal
{
private IDalamudTextureWrap? wrap;
/// <summary>Initializes a new instance of the <see cref="TextureWrapIconSource"/> class.</summary>
/// <param name="wrap">The texture wrap to handle over the ownership.</param>
/// <param name="takeOwnership">
/// If <c>true</c>, this class will own the passed <paramref name="wrap"/>, and you <b>must not</b> call
/// <see cref="IDisposable.Dispose"/> on the passed wrap.
/// If <c>false</c>, this class will create a new reference of the passed wrap, and you <b>should</b> call
/// <see cref="IDisposable.Dispose"/> on the passed wrap.
/// In both cases, this class must be disposed after use.</param>
public TextureWrapIconSource(IDalamudTextureWrap? wrap, bool takeOwnership) =>
this.wrap = takeOwnership ? wrap : wrap?.CreateWrapSharingLowLevelResource();
/// <summary>Gets the underlying texture wrap.</summary>
public IDalamudTextureWrap? Wrap => this.wrap;
/// <inheritdoc/>
public INotificationIconSource Clone() => new TextureWrapIconSource(this.wrap, false);
/// <inheritdoc/>
public void Dispose()
{
if (Interlocked.Exchange(ref this.wrap, null) is { } w)
w.Dispose();
}
/// <inheritdoc/>
INotificationMaterializedIcon INotificationIconSource.IInternal.Materialize() =>
new MaterializedIcon(this.wrap?.CreateWrapSharingLowLevelResource());
private sealed class MaterializedIcon : INotificationMaterializedIcon
{
private IDalamudTextureWrap? wrap;
public MaterializedIcon(IDalamudTextureWrap? wrap) => this.wrap = wrap;
public void Dispose()
{
if (Interlocked.Exchange(ref this.wrap, null) is { } w)
w.Dispose();
}
public void DrawIcon(Vector2 minCoord, Vector2 maxCoord, Vector4 color, LocalPlugin? initiatorPlugin) =>
NotificationUtilities.DrawTexture(
this.wrap,
minCoord,
maxCoord,
initiatorPlugin);
}
}

72
Dalamud/Interface/ImGuiNotification/Internal/ActiveNotification.cs
View file

@ -43,7 +43,10 @@ internal sealed class ActiveNotification : IActiveNotification, IDisposable
/// <param name="initiatorPlugin">The initiator plugin. Use <c>null</c> if originated by Dalamud.</param>
public ActiveNotification(Notification underlyingNotification, LocalPlugin? initiatorPlugin)
{
this.underlyingNotification = underlyingNotification with { };
this.underlyingNotification = underlyingNotification with
{
IconSource = underlyingNotification.IconSource?.Clone(),
};
this.InitiatorPlugin = initiatorPlugin;
this.showEasing = new InCubic(NotificationConstants.ShowAnimationDuration);
this.hideEasing = new OutCubic(NotificationConstants.HideAnimationDuration);
@ -51,7 +54,16 @@ internal sealed class ActiveNotification : IActiveNotification, IDisposable
this.showEasing.Start();
this.progressEasing.Start();
this.UpdateIcon();
try
{
this.UpdateIcon();
}
catch (Exception e)
{
// Ignore the one caused from ctor only; other UpdateIcon calls are from plugins, and they should handle the
// error accordingly.
Log.Error(e, $"{nameof(ActiveNotification)}#{this.Id} ctor: {nameof(this.UpdateIcon)} failed and ignored.");
}
}
/// <inheritdoc/>
@ -114,17 +126,8 @@ internal sealed class ActiveNotification : IActiveNotification, IDisposable
}
}
/// <inheritdoc cref="IActiveNotification.IconSource"/>
public INotificationIconSource? IconSource
{
get => this.underlyingNotification.IconSource;
set
{
if (this.IsDismissed)
return;
this.underlyingNotification.IconSource = value;
}
}
/// <inheritdoc/>
public INotificationIconSource? IconSource => this.underlyingNotification.IconSource;
/// <inheritdoc cref="IActiveNotification.Expiry"/>
public DateTime Expiry
@ -264,23 +267,14 @@ internal sealed class ActiveNotification : IActiveNotification, IDisposable
/// <inheritdoc/>
public void Dispose()
{
this.ClearIconTask();
this.underlyingNotification.IconSource = null;
this.ClearMaterializedIcon();
this.underlyingNotification.Dispose();
this.Dismiss = null;
this.Click = null;
this.DrawActions = null;
this.InitiatorPlugin = null;
}
/// <inheritdoc/>
public Notification CloneNotification()
{
var newValue = this.underlyingNotification with { };
if (this.newProgress is { } p)
newValue.Progress = p;
return newValue;
}
/// <inheritdoc/>
public void DismissNow() => this.DismissNow(NotificationDismissReason.Programmatical);
@ -504,30 +498,26 @@ internal sealed class ActiveNotification : IActiveNotification, IDisposable
return windowSize.Y;
}
/// <inheritdoc/>
public void Update(INotification newNotification)
{
if (this.IsDismissed)
return;
this.Content = newNotification.Content;
this.Title = newNotification.Title;
this.Type = newNotification.Type;
this.IconSource = newNotification.IconSource;
this.Expiry = newNotification.Expiry;
this.Interactable = newNotification.Interactable;
this.HoverExtendDuration = newNotification.HoverExtendDuration;
this.newProgress = newNotification.Progress;
}
/// <inheritdoc/>
public void UpdateIcon()
{
if (this.IsDismissed)
return;
this.ClearIconTask();
this.ClearMaterializedIcon();
this.MaterializedIcon = (this.IconSource as INotificationIconSource.IInternal)?.Materialize();
}
/// <inheritdoc/>
public void UpdateIconSource(INotificationIconSource? newIconSource)
{
if (this.IsDismissed || this.underlyingNotification.IconSource == newIconSource)
return;
this.underlyingNotification.IconSource?.Dispose();
this.underlyingNotification.IconSource = newIconSource;
this.UpdateIcon();
}
/// <summary>Removes non-Dalamud invocation targets from events.</summary>
public void RemoveNonDalamudInvocations()
{
@ -567,7 +557,7 @@ internal sealed class ActiveNotification : IActiveNotification, IDisposable
}
}
private void ClearIconTask()
private void ClearMaterializedIcon()
{
this.MaterializedIcon?.Dispose();
this.MaterializedIcon = null;

26
Dalamud/Interface/ImGuiNotification/Internal/NotificationManager.cs
View file

@ -56,8 +56,9 @@ internal class NotificationManager : INotificationManager, IServiceType, IDispos
}
/// <inheritdoc/>
public IActiveNotification AddNotification(Notification notification)
public IActiveNotification AddNotification(Notification notification, bool disposeNotification = true)
{
using var disposer = disposeNotification ? notification : null;
var an = new ActiveNotification(notification, null);
this.pendingNotifications.Add(an);
return an;
@ -65,10 +66,13 @@ internal class NotificationManager : INotificationManager, IServiceType, IDispos
/// <summary>Adds a notification originating from a plugin.</summary>
/// <param name="notification">The notification.</param>
/// <param name="disposeNotification">Dispose <paramref name="notification"/> when this function returns.</param>
/// <param name="plugin">The source plugin.</param>
/// <returns>The new notification.</returns>
public IActiveNotification AddNotification(Notification notification, LocalPlugin plugin)
/// <returns>The added notification.</returns>
/// <remarks><paramref name="disposeNotification"/> will be honored even on exceptions.</remarks>
public IActiveNotification AddNotification(Notification notification, bool disposeNotification, LocalPlugin plugin)
{
using var disposer = disposeNotification ? notification : null;
var an = new ActiveNotification(notification, plugin);
this.pendingNotifications.Add(an);
return an;
@ -88,7 +92,8 @@ internal class NotificationManager : INotificationManager, IServiceType, IDispos
Content = content,
Title = title,
Type = type,
});
},
true);
/// <summary>Draw all currently queued notifications.</summary>
public void Draw()
@ -101,7 +106,14 @@ internal class NotificationManager : INotificationManager, IServiceType, IDispos
var maxWidth = Math.Max(320 * ImGuiHelpers.GlobalScale, viewportSize.X / 3);
this.notifications.RemoveAll(x => x.UpdateAnimations());
this.notifications.RemoveAll(static x =>
{
if (!x.UpdateAnimations())
return false;
x.Dispose();
return true;
});
foreach (var tn in this.notifications)
height += tn.Draw(maxWidth, height) + NotificationConstants.ScaledWindowGap;
}
@ -127,9 +139,9 @@ internal class NotificationManagerPluginScoped : INotificationManager, IServiceT
this.localPlugin = localPlugin;
/// <inheritdoc/>
public IActiveNotification AddNotification(Notification notification)
public IActiveNotification AddNotification(Notification notification, bool disposeNotification = true)
{
var an = this.notificationManagerService.AddNotification(notification, this.localPlugin);
var an = this.notificationManagerService.AddNotification(notification, disposeNotification, this.localPlugin);
_ = this.notifications.TryAdd(an, 0);
an.Dismiss += (a, unused) => this.notifications.TryRemove(an, out _);
return an;

23
Dalamud/Interface/ImGuiNotification/Internal/NotificationUtilities.cs
View file

@ -23,7 +23,22 @@ internal static class NotificationUtilities
Vector2 maxCoord,
LocalPlugin? initiatorPlugin)
{
if (texture is null)
var handle = nint.Zero;
var size = Vector2.Zero;
if (texture is not null)
{
try
{
handle = texture.ImGuiHandle;
size = texture.Size;
}
catch
{
// must have been disposed or something; ignore the texture
}
}
if (handle == nint.Zero)
{
var dam = Service<DalamudAssetManager>.Get();
if (initiatorPlugin is null)
@ -46,14 +61,16 @@ internal static class NotificationUtilities
};
}
}
handle = texture.ImGuiHandle;
size = texture.Size;
}
var size = texture.Size;
if (size.X > maxCoord.X - minCoord.X)
size *= (maxCoord.X - minCoord.X) / size.X;
if (size.Y > maxCoord.Y - minCoord.Y)
size *= (maxCoord.Y - minCoord.Y) / size.Y;
ImGui.SetCursorPos(((minCoord + maxCoord) - size) / 2);
ImGui.Image(texture.ImGuiHandle, size);
ImGui.Image(handle, size);
}
}

7
Dalamud/Interface/ImGuiNotification/Notification.cs
View file

@ -31,4 +31,11 @@ public sealed record Notification : INotification
/// <inheritdoc/>
public float Progress { get; set; } = 1f;
/// <inheritdoc/>
public void Dispose()
{
this.IconSource?.Dispose();
this.IconSource = null;
}
}

34
Dalamud/Interface/Internal/Windows/Data/Widgets/ImGuiWidget.cs
View file

@ -79,27 +79,26 @@ internal class ImGuiWidget : IDataWindowWidget
NotificationTemplate.IconSourceTitles.Length);
switch (this.notificationTemplate.IconSourceInt)
{
case 1:
case 2:
case 1 or 2:
ImGui.InputText(
"Icon Text##iconSourceText",
ref this.notificationTemplate.IconSourceText,
255);
break;
case 3:
case 3 or 4:
ImGui.Combo(
"Icon Source##iconSourceAssetCombo",
ref this.notificationTemplate.IconSourceAssetInt,
NotificationTemplate.AssetSources,
NotificationTemplate.AssetSources.Length);
break;
case 4:
case 5 or 7:
ImGui.InputText(
"Game Path##iconSourceText",
ref this.notificationTemplate.IconSourceText,
255);
break;
case 5:
case 6 or 8:
ImGui.InputText(
"File Path##iconSourceText",
ref this.notificationTemplate.IconSourceText,
@ -170,17 +169,31 @@ internal class ImGuiWidget : IDataWindowWidget
(FontAwesomeIcon)(this.notificationTemplate.IconSourceText.Length == 0
? 0
: this.notificationTemplate.IconSourceText[0])),
3 => new TextureWrapTaskIconSource(
3 => new TextureWrapIconSource(
Service<DalamudAssetManager>.Get().GetDalamudTextureWrap(
Enum.Parse<DalamudAsset>(
NotificationTemplate.AssetSources[
this.notificationTemplate.IconSourceAssetInt])),
false),
4 => new TextureWrapTaskIconSource(
() =>
Service<DalamudAssetManager>.Get().GetDalamudTextureWrapAsync(
Enum.Parse<DalamudAsset>(
NotificationTemplate.AssetSources[
this.notificationTemplate.IconSourceAssetInt]))),
4 => new GamePathIconSource(this.notificationTemplate.IconSourceText),
5 => new FilePathIconSource(this.notificationTemplate.IconSourceText),
5 => new GamePathIconSource(this.notificationTemplate.IconSourceText),
6 => new FilePathIconSource(this.notificationTemplate.IconSourceText),
7 => new TextureWrapIconSource(
Service<TextureManager>.Get().GetTextureFromGame(this.notificationTemplate.IconSourceText),
false),
8 => new TextureWrapIconSource(
Service<TextureManager>.Get().GetTextureFromFile(
new(this.notificationTemplate.IconSourceText)),
false),
_ => null,
},
});
},
true);
switch (this.notificationTemplate.ProgressMode)
{
case 2:
@ -276,9 +289,12 @@ internal class ImGuiWidget : IDataWindowWidget
"None (use Type)",
"SeIconChar",
"FontAwesomeIcon",
"TextureWrap from DalamudAssets",
"TextureWrapTask from DalamudAssets",
"GamePath",
"FilePath",
"TextureWrap from GamePath",
"TextureWrap from FilePath",
};
public static readonly string[] AssetSources =

1
Dalamud/Interface/UiBuilder.cs
View file

@ -581,6 +581,7 @@ public sealed class UiBuilder : IDisposable
Type = type,
Expiry = DateTime.Now + TimeSpan.FromMilliseconds(msDelay),
},
true,
this.localPlugin);
_ = this.notifications.TryAdd(an, 0);
an.Dismiss += (a, unused) => this.notifications.TryRemove(an, out _);

8
Dalamud/Plugin/Services/INotificationManager.cs
View file

@ -11,6 +11,12 @@ public interface INotificationManager
/// Adds a notification.
/// </summary>
/// <param name="notification">The new notification.</param>
/// <param name="disposeNotification">
/// Dispose <paramref name="notification"/> when this function returns, even if the function throws an exception.
/// Set to <c>false</c> to reuse <paramref name="notification"/> for multiple calls to this function, in which case,
/// you should call <see cref="IDisposable.Dispose"/> on the value supplied to <paramref name="notification"/> at a
/// later time.
/// </param>
/// <returns>The added notification.</returns>
IActiveNotification AddNotification(Notification notification);
IActiveNotification AddNotification(Notification notification, bool disposeNotification = true);
}