using System;

namespace Artemis.Core.Services;

/// <summary>
///     A service that allows you to interact with keyboard and mice input events
/// </summary>
public interface IInputService : IArtemisService, IDisposable
{
    /// <summary>
    ///     Gets the current keyboard toggle status
    /// </summary>
    KeyboardToggleStatus KeyboardToggleStatus { get; }

    /// <summary>
    ///     Adds an input provided
    /// </summary>
    /// <param name="inputProvider">The input provider the add</param>
    void AddInputProvider(InputProvider inputProvider);

    /// <summary>
    ///     Removes an input provided
    /// </summary>
    /// <param name="inputProvider">The input provider the remove</param>
    void RemoveInputProvider(InputProvider inputProvider);

    /// <summary>
    ///     Identifies the provided <paramref name="device" /> by assigning the next received device identification to it
    /// </summary>
    /// <param name="device">The device to identify - Must be a keyboard or mouse</param>
    void IdentifyDevice(ArtemisDevice device);

    /// <summary>
    ///     Cancels identifying the device last passed to <see cref="IdentifyDevice" />
    /// </summary>
    void StopIdentify();

    /// <summary>
    ///     Flush all currently pressed buttons/keys
    /// </summary>
    void ReleaseAll();

    /// <summary>
    ///     Determines whether the provided key is pressed by any device
    /// </summary>
    /// <param name="key">The key to check</param>
    /// <returns><see langword="true" /> if the key is pressed; otherwise <see langword="false" /></returns>
    bool IsKeyDown(KeyboardKey key);

    /// <summary>
    ///     Determines whether the button key is pressed by any device
    /// </summary>
    /// <param name="button">The button to check</param>
    /// <returns><see langword="true" /> if the button is pressed; otherwise <see langword="false" /></returns>
    bool IsButtonDown(MouseButton button);

    /// <summary>
    ///     Occurs whenever a key on a keyboard was pressed or released
    /// </summary>
    event EventHandler<ArtemisKeyboardKeyUpDownEventArgs> KeyboardKeyUpDown;

    /// <summary>
    ///     Occurs whenever a key on a keyboard was pressed
    /// </summary>
    event EventHandler<ArtemisKeyboardKeyEventArgs> KeyboardKeyDown;

    /// <summary>
    ///     Occurs whenever a key on a keyboard was released
    /// </summary>
    event EventHandler<ArtemisKeyboardKeyEventArgs> KeyboardKeyUp;

    /// <summary>
    ///     Occurs whenever a one or more of the keyboard toggle statuses changed
    /// </summary>
    event EventHandler<ArtemisKeyboardToggleStatusArgs> KeyboardToggleStatusChanged;

    /// <summary>
    ///     Occurs whenever a button on a mouse was pressed or released
    /// </summary>
    event EventHandler<ArtemisMouseButtonUpDownEventArgs> MouseButtonUpDown;

    /// <summary>
    ///     Occurs whenever a button on a mouse was pressed
    /// </summary>
    event EventHandler<ArtemisMouseButtonEventArgs> MouseButtonDown;

    /// <summary>
    ///     Occurs whenever a button on a mouse was released
    /// </summary>
    event EventHandler<ArtemisMouseButtonEventArgs> MouseButtonUp;

    /// <summary>
    ///     Occurs whenever a the scroll wheel of a mouse is turned
    /// </summary>
    event EventHandler<ArtemisMouseScrollEventArgs> MouseScroll;

    /// <summary>
    ///     Occurs whenever a a mouse is moved
    /// </summary>
    event EventHandler<ArtemisMouseMoveEventArgs> MouseMove;

    /// <summary>
    ///     Occurs when a device has been identified after calling <see cref="IdentifyDevice" />
    /// </summary>
    public event EventHandler DeviceIdentified;

    #region Identification

    /// <summary>
    ///     Attempts to identify the device using the provided <paramref name="identifier" />
    /// </summary>
    /// <param name="provider">The input provider to identify the device for</param>
    /// <param name="identifier">The value to use to identify the device</param>
    /// <param name="type">A device type to fall back to if no match is found</param>
    /// <returns>If found, the Artemis device matching the provider and identifier</returns>
    ArtemisDevice? GetDeviceByIdentifier(InputProvider provider, object identifier, InputDeviceType type);

    /// <summary>
    ///     Clears the identifier cache
    /// </summary>
    void BustIdentifierCache();

    #endregion
}