Minecraft-Console-Client/MinecraftClient/IConsoleBackend.cs

using System;
using System.Threading;
using System.Threading.Tasks;

namespace MinecraftClient
{
    /// <summary>
    /// Input buffer state passed with OnInputChange events.
    /// </summary>
    public readonly struct ConsoleInputBuffer
    {
        public string Text { get; }
        public int CursorPosition { get; }

        public ConsoleInputBuffer(string text, int cursorPosition)
        {
            Text = text;
            CursorPosition = cursorPosition;
        }
    }

    /// <summary>
    /// Backend-independent suggestion item used by the TUI autocomplete popup.
    /// Mirrors the shape of ConsoleInteractive.ConsoleSuggestion.Suggestion
    /// without requiring a dependency on the ConsoleInteractive assembly.
    /// </summary>
    public readonly struct CommandSuggestion
    {
        public string Text { get; }
        public string Tooltip { get; }

        public CommandSuggestion(string text, string tooltip = "")
        {
            Text = text;
            Tooltip = tooltip;
        }
    }

    /// <summary>
    /// Abstraction over the console I/O backend.
    /// Implementations: ClassicConsoleBackend (ConsoleInteractive), TuiConsoleBackend (Avalonia/Consolonia), BasicConsoleBackend (stdio).
    /// </summary>
    public interface IConsoleBackend
    {
        void Init();

        void WriteLine(string text);

        void WriteLineFormatted(string text);

        void BeginReadThread();

        void StopReadThread();

        event EventHandler<string>? MessageReceived;

        event EventHandler<ConsoleInputBuffer>? OnInputChange;

        string RequestImmediateInput();

        Task<string> RequestImmediateInputAsync(CancellationToken cancellationToken);

        string? ReadPassword();

        Task<string?> ReadPasswordAsync(CancellationToken cancellationToken);

        void ClearInputBuffer();

        bool DisplayUserInput { get; set; }

        void SetInputVisible(bool visible);

        void SetBackreadBufferLimit(int limit);

        void Shutdown();
    }
}