Dalamud/Dalamud/Game/Gui/Dtr/DtrBarEntry.cs

using System.Linq;

using Dalamud.Configuration.Internal;
using Dalamud.Game.Text.SeStringHandling;
using Dalamud.Utility;

using FFXIVClientStructs.FFXIV.Client.System.String;
using FFXIVClientStructs.FFXIV.Component.GUI;

namespace Dalamud.Game.Gui.Dtr;

/// <summary>
/// Interface representing a read-only entry in the server info bar.
/// </summary>
public interface IReadOnlyDtrBarEntry
{
    /// <summary>
    /// Gets the title of this entry.
    /// </summary>
    public string Title { get; }
    
    /// <summary>
    /// Gets a value indicating whether this entry has a click action.
    /// </summary>
    public bool HasClickAction { get; }
    
    /// <summary>
    /// Gets the text of this entry.
    /// </summary>
    public SeString Text { get; }
    
    /// <summary>
    /// Gets a tooltip to be shown when the user mouses over the dtr entry.
    /// </summary>
    public SeString Tooltip { get; }
    
    /// <summary>
    /// Gets a value indicating whether this entry should be shown.
    /// </summary>
    public bool Shown { get; }
    
    /// <summary>
    /// Gets a value indicating whether or not the user has hidden this entry from view through the Dalamud settings.
    /// </summary>
    public bool UserHidden { get; }
    
    /// <summary>
    /// Triggers the click action of this entry.
    /// </summary>
    /// <returns>True, if a click action was registered and executed.</returns>
    public bool TriggerClickAction();
}

/// <summary>
/// Interface representing an entry in the server info bar.
/// </summary>
public interface IDtrBarEntry : IReadOnlyDtrBarEntry
{
    /// <summary>
    /// Gets or sets the text of this entry.
    /// </summary>
    public new SeString? Text { get; set; }
    
    /// <summary>
    /// Gets or sets a tooltip to be shown when the user mouses over the dtr entry.
    /// </summary>
    public new SeString? Tooltip { get; set; }
    
    /// <summary>
    /// Gets or sets a value indicating whether this entry is visible.
    /// </summary>
    public new bool Shown { get; set; }
    
    /// <summary>
    /// Gets or sets a action to be invoked when the user clicks on the dtr entry.
    /// </summary>
    public Action? OnClick { get; set; }
    
    /// <summary>
    /// Remove this entry from the bar.
    /// You will need to re-acquire it from DtrBar to reuse it.
    /// </summary>
    public void Remove();
}

/// <summary>
/// Class representing an entry in the server info bar.
/// </summary>
public sealed unsafe class DtrBarEntry : IDisposable, IDtrBarEntry
{
    private readonly DalamudConfiguration configuration;

    private bool shownBacking = true;
    private SeString? textBacking;

    /// <summary>
    /// Initializes a new instance of the <see cref="DtrBarEntry"/> class.
    /// </summary>
    /// <param name="configuration">Dalamud configuration, used to check if the entry is hidden by the user.</param>
    /// <param name="title">The title of the bar entry.</param>
    /// <param name="textNode">The corresponding text node.</param>
    internal DtrBarEntry(DalamudConfiguration configuration, string title, AtkTextNode* textNode)
    {
        this.configuration = configuration;
        this.Title = title;
        this.TextNode = textNode;
    }

    /// <inheritdoc/>
    public string Title { get; init; }

    /// <inheritdoc cref="IDtrBarEntry.Text" />
    public SeString? Text
    {
        get => this.textBacking;
        set
        {
            this.textBacking = value;
            this.Dirty = true;
        }
    }

    /// <inheritdoc cref="IDtrBarEntry.Tooltip" />
    public SeString? Tooltip { get; set; }
    
    /// <summary>
    /// Gets or sets a action to be invoked when the user clicks on the dtr entry.
    /// </summary>
    public Action? OnClick { get; set; }

    /// <inheritdoc/>
    public bool HasClickAction => this.OnClick != null;

    /// <inheritdoc cref="IDtrBarEntry.Shown" />
    public bool Shown
    {
        get => this.shownBacking;
        set
        {
            if (value != this.shownBacking)
            {
                this.shownBacking = value;
                this.Dirty = true;
            }
        }
    }

    /// <inheritdoc/>
    [Api10ToDo("Maybe make this config scoped to internalname?")]
    public bool UserHidden => this.configuration.DtrIgnore?.Contains(this.Title) ?? false;

    /// <summary>
    /// Gets or sets the internal text node of this entry.
    /// </summary>
    internal AtkTextNode* TextNode { get; set; }
    
    /// <summary>
    /// Gets or sets the storage for the text of this entry.
    /// </summary>
    internal Utf8String* Storage { get; set; }

    /// <summary>
    /// Gets a value indicating whether this entry should be removed.
    /// </summary>
    internal bool ShouldBeRemoved { get; private set; }

    /// <summary>
    /// Gets or sets a value indicating whether this entry is dirty.
    /// </summary>
    internal bool Dirty { get; set; }

    /// <summary>
    /// Gets or sets a value indicating whether this entry has just been added.
    /// </summary>
    internal bool Added { get; set; } 

    /// <inheritdoc/>
    public bool TriggerClickAction()
    {
        if (this.OnClick == null)
            return false;
        
        this.OnClick.Invoke();
        return true;
    }

    /// <summary>
    /// Remove this entry from the bar.
    /// You will need to re-acquire it from DtrBar to reuse it.
    /// </summary>
    public void Remove()
    {
        this.ShouldBeRemoved = true;
    }

    /// <inheritdoc/>
    public void Dispose()
    {
        this.Remove();
    }
}