osu-framework/osu.Framework/Testing/Input/ManualInputManager.cs

// Copyright (c) ppy Pty Ltd <contact@ppy.sh>. Licensed under the MIT Licence.
// See the LICENCE file in the repository root for full licence text.

using System.Linq;
using System;
using osu.Framework.Graphics;
using osu.Framework.Graphics.Containers;
using osu.Framework.Input;
using osu.Framework.Input.Events;
using osu.Framework.Input.Handlers;
using osu.Framework.Input.StateChanges;
using osu.Framework.Platform;
using osuTK;
using osuTK.Input;

namespace osu.Framework.Testing.Input
{
    public partial class ManualInputManager : PassThroughInputManager
    {
        private readonly ManualInputHandler handler;

        protected override Container<Drawable> Content => content;

        private bool showVisualCursorGuide = true;

        /// <summary>
        /// Whether to show a visible cursor tracking position and clicks.
        /// Generally should be enabled unless it blocks the test's content.
        /// </summary>
        public bool ShowVisualCursorGuide
        {
            get => showVisualCursorGuide;
            set
            {
                if (value == showVisualCursorGuide)
                    return;

                showVisualCursorGuide = value;
                testCursor.State.Value = value ? Visibility.Visible : Visibility.Hidden;
            }
        }

        private readonly Container content;

        private readonly TestCursorContainer testCursor;

        private readonly LocalPlatformActionContainer platformActionContainer;

        public override bool UseParentInput
        {
            get => base.UseParentInput;
            set
            {
                base.UseParentInput = value;
                platformActionContainer.ShouldHandle = !value;
            }
        }

        protected override bool AllowRightClickFromLongTouch => RightClickFromLongTouch;

        public bool RightClickFromLongTouch = true;

        public ManualInputManager()
        {
            AddHandler(handler = new ManualInputHandler());

            InternalChildren = new Drawable[]
            {
                platformActionContainer = new LocalPlatformActionContainer().WithChild(content = new Container { RelativeSizeAxes = Axes.Both }),
                testCursor = new TestCursorContainer(),
            };

            UseParentInput = true;
        }

        public void Input(IInput input)
        {
            UseParentInput = false;
            handler.EnqueueInput(input);
        }

        /// <summary>
        /// Press a key down. Release with <see cref="ReleaseKey"/>.
        /// </summary>
        /// <remarks>
        /// To press and release a key immediately, use <see cref="Key"/>.
        /// </remarks>
        /// <param name="key">The key to press.</param>
        public void PressKey(Key key) => Input(new KeyboardKeyInput(key, true));

        /// <summary>
        /// Release a pressed key.
        /// </summary>
        /// <param name="key">The key to release.</param>
        public void ReleaseKey(Key key) => Input(new KeyboardKeyInput(key, false));

        /// <summary>
        /// Press and release the specified key.
        /// </summary>
        /// <param name="key">The key to actuate.</param>
        public void Key(Key key)
        {
            PressKey(key);
            ReleaseKey(key);
        }

        /// <summary>
        /// Press and release the keys in the specified <see cref="PlatformAction"/>.
        /// </summary>
        /// <param name="action">The platform action to actuate.</param>
        public void Keys(PlatformAction action)
        {
            var binding = Host.PlatformKeyBindings.First(b => (PlatformAction)b.Action == action);

            foreach (var k in binding.KeyCombination.Keys)
                PressKey((Key)k);

            foreach (var k in binding.KeyCombination.Keys)
                ReleaseKey((Key)k);
        }

        public void ScrollBy(Vector2 delta, bool isPrecise = false) => Input(new MouseScrollRelativeInput { Delta = delta, IsPrecise = isPrecise });
        public void ScrollHorizontalBy(float delta, bool isPrecise = false) => ScrollBy(new Vector2(delta, 0), isPrecise);
        public void ScrollVerticalBy(float delta, bool isPrecise = false) => ScrollBy(new Vector2(0, delta), isPrecise);

        public void MoveMouseTo(Drawable drawable, Vector2? offset = null) => MoveMouseTo(drawable.ToScreenSpace(drawable.LayoutRectangle.Centre) + (offset ?? Vector2.Zero));
        public void MoveMouseTo(Vector2 position) => Input(new MousePositionAbsoluteInput { Position = position });

        public void MoveTouchTo(Touch touch) => Input(new TouchInput(touch, CurrentState.Touch.IsActive(touch.Source)));

        public void MovePenTo(Drawable drawable, Vector2? offset = null, TabletPenDeviceType deviceType = TabletPenDeviceType.Unknown)
            => MovePenTo(drawable.ToScreenSpace(drawable.LayoutRectangle.Centre) + (offset ?? Vector2.Zero), deviceType);

        public void MovePenTo(Vector2 position, TabletPenDeviceType deviceType = TabletPenDeviceType.Unknown)
            => Input(new MousePositionAbsoluteInputFromPen { Position = position, DeviceType = deviceType });

        public new bool TriggerClick() =>
            throw new InvalidOperationException($"To trigger a click via a {nameof(ManualInputManager)} use {nameof(Click)} instead.");

        /// <summary>
        /// Press and release the specified button.
        /// </summary>
        /// <param name="button">The button to press and release.</param>
        public void Click(MouseButton button)
        {
            PressButton(button);
            ReleaseButton(button);
        }

        /// <summary>
        /// Press a mouse button down. Release with <see cref="ReleaseButton"/>.
        /// </summary>
        /// <remarks>
        /// To press and release a mouse button immediately, use <see cref="Click"/>.
        /// </remarks>
        /// <param name="button">The button to press.</param>
        public void PressButton(MouseButton button) => Input(new MouseButtonInput(button, true));

        /// <summary>
        /// Release a pressed mouse button.
        /// </summary>
        /// <param name="button">The button to release.</param>
        public void ReleaseButton(MouseButton button) => Input(new MouseButtonInput(button, false));

        public void PressJoystickButton(JoystickButton button) => Input(new JoystickButtonInput(button, true));
        public void ReleaseJoystickButton(JoystickButton button) => Input(new JoystickButtonInput(button, false));

        public void BeginTouch(Touch touch) => Input(new TouchInput(touch, true));
        public void EndTouch(Touch touch) => Input(new TouchInput(touch, false));

        public void PressMidiKey(MidiKey key, byte velocity) => Input(new MidiKeyInput(key, velocity, true));
        public void ReleaseMidiKey(MidiKey key, byte velocity) => Input(new MidiKeyInput(key, velocity, false));

        public void PressPen(TabletPenDeviceType deviceType = TabletPenDeviceType.Unknown) => Input(new MouseButtonInputFromPen(true) { DeviceType = deviceType });
        public void ReleasePen(TabletPenDeviceType deviceType = TabletPenDeviceType.Unknown) => Input(new MouseButtonInputFromPen(false) { DeviceType = deviceType });

        public void PressTabletPenButton(TabletPenButton penButton) => Input(new TabletPenButtonInput(penButton, true));
        public void ReleaseTabletPenButton(TabletPenButton penButton) => Input(new TabletPenButtonInput(penButton, false));

        public void PressTabletAuxiliaryButton(TabletAuxiliaryButton auxiliaryButton) => Input(new TabletAuxiliaryButtonInput(auxiliaryButton, true));
        public void ReleaseTabletAuxiliaryButton(TabletAuxiliaryButton auxiliaryButton) => Input(new TabletAuxiliaryButtonInput(auxiliaryButton, false));

        private partial class LocalPlatformActionContainer : PlatformActionContainer
        {
            public bool ShouldHandle;

            protected override bool Handle(UIEvent e)
            {
                if (!ShouldHandle)
                    return false;

                return base.Handle(e);
            }
        }

        private class ManualInputHandler : InputHandler
        {
            public override bool Initialize(GameHost host) => true;
            public override bool IsActive => true;

            public void EnqueueInput(IInput input)
            {
                PendingInputs.Enqueue(input);
            }
        }
    }
}