// https://github.com/mattj23/InteractiveReadLine
using InteractiveReadLine.Formatting;

namespace InteractiveReadLine
{
    /// <summary>
    /// The underlying contract for any object which is to provide ReadLine functionality to the input handler.
    /// </summary>
    /// <remarks>
    /// Any object which is to provide a functioning backend on which the ReadLineHandler can act must implement these
    /// three features: synchronously returning a single ConsoleKeyInfo when asked, writing out text and a cursor
    /// position on the currently active line (clearing whatever was there before), and inserting text to some
    /// output without interfering with the active display line.
    ///
    /// Finally, the provider must implement IDisposable; as it will be disposed by the handler when the input of
    /// a line has been completed. The provider must then clean up the view in some fashion (on a standard System.Console
    /// provider this involves writing a newline to the console)
    /// </remarks>
    public interface IReadLineProvider : IDisposable
    {
        /// <summary>
        /// Waits synchronously for a ConsoleKeyInfo to be returned from some underlying input source.
        /// </summary>
        /// <returns>The information of the key which was just read/pressed</returns>
        ConsoleKeyInfo ReadKey();

        /// <summary>
        /// Displays the LineDisplayState to the visual output, including the cursor position
        /// </summary>
        /// <param name="state">The line display state (prefix, suffix, text, and cursor position) to be displayed</param>
        void SetDisplay(LineDisplayState state);
        
        /// <summary>
        /// Inserts text to the console out in the spot where the current read line input is, then
        /// immediately re-displays the line input on the next row. This is used to interrupt the user with a message or
        /// information while the ReadLine is still active
        /// </summary>
        /// <param name="text">The text to write to the console, a newline char will be added automatically</param>
        void InsertText(FormattedText text);

    }
}