From fadb1a5e0b44c85b2ff132aa0ab91b9c34285621 Mon Sep 17 00:00:00 2001
From: Dean Herbert <pe@ppy.sh>
Date: Thu, 10 May 2018 17:30:24 +0900
Subject: [PATCH] Add tests and expand functionality to ensure single fire

---
 .../Visual/TestCaseHoldToConfirmOverlay.cs    | 62 +++++++++++++++++++
 osu.Game/Overlays/HoldToConfirmOverlay.cs     | 25 +++++---
 2 files changed, 78 insertions(+), 9 deletions(-)
 create mode 100644 osu.Game.Tests/Visual/TestCaseHoldToConfirmOverlay.cs

diff --git a/osu.Game.Tests/Visual/TestCaseHoldToConfirmOverlay.cs b/osu.Game.Tests/Visual/TestCaseHoldToConfirmOverlay.cs
new file mode 100644
index 0000000000..ef6f44b42e
--- /dev/null
+++ b/osu.Game.Tests/Visual/TestCaseHoldToConfirmOverlay.cs
@@ -0,0 +1,62 @@
+// Copyright (c) 2007-2018 ppy Pty Ltd <contact@ppy.sh>.
+// Licensed under the MIT Licence - https://raw.githubusercontent.com/ppy/osu/master/LICENCE
+
+using System;
+using System.Collections.Generic;
+using osu.Framework.Graphics;
+using osu.Game.Graphics.Sprites;
+using osu.Game.Screens.Menu;
+
+namespace osu.Game.Tests.Visual
+{
+    public class TestCaseHoldToConfirmOverlay : OsuTestCase
+    {
+        public override IReadOnlyList<Type> RequiredTypes => new[] { typeof(ExitConfirmOverlay) };
+
+        public TestCaseHoldToConfirmOverlay()
+        {
+            bool fired = false;
+
+            var abortText = new OsuSpriteText
+            {
+                Anchor = Anchor.Centre,
+                Origin = Anchor.Centre,
+                Text = "Aborted!",
+                TextSize = 50,
+                Alpha = 0,
+            };
+
+            var overlay = new TestHoldToConfirmOverlay
+            {
+                Action = () =>
+                {
+                    fired = true;
+                    abortText.FadeTo(1).Then().FadeOut(1000);
+                }
+            };
+
+            Children = new Drawable[]
+            {
+                overlay,
+                abortText
+            };
+
+            AddStep("start confirming", () => overlay.Begin());
+            AddStep("abort confirming", () => overlay.Abort());
+
+            AddAssert("ensure aborted", () => !fired);
+
+            AddStep("start confirming", () => overlay.Begin());
+
+            AddUntilStep(() => fired, "wait until confirmed");
+        }
+
+        private class TestHoldToConfirmOverlay : ExitConfirmOverlay
+        {
+            protected override bool AllowMultipleFires => true;
+
+            public void Begin() => BeginConfirm();
+            public void Abort() => AbortConfirm();
+        }
+    }
+}
diff --git a/osu.Game/Overlays/HoldToConfirmOverlay.cs b/osu.Game/Overlays/HoldToConfirmOverlay.cs
index 4bc7154ce8..a0e4bf1a39 100644
--- a/osu.Game/Overlays/HoldToConfirmOverlay.cs
+++ b/osu.Game/Overlays/HoldToConfirmOverlay.cs
@@ -25,6 +25,11 @@ namespace osu.Game.Overlays
 
         private bool fired;
 
+        /// <summary>
+        /// Whether the overlay should be allowed to return from a fired state.
+        /// </summary>
+        protected virtual bool AllowMultipleFires => false;
+
         [BackgroundDependencyLoader]
         private void load()
         {
@@ -42,18 +47,20 @@ namespace osu.Game.Overlays
             };
         }
 
-        protected void BeginConfirm() => overlay.FadeIn(activate_delay, Easing.Out);
-
-        protected void AbortConfirm() => overlay.FadeOut(fadeout_delay, Easing.Out);
-
-        protected override void Update()
+        protected void BeginConfirm()
         {
-            base.Update();
-            if (!fired && overlay.Alpha == 1)
+            if (!AllowMultipleFires && fired) return;
+            overlay.FadeIn(activate_delay * (1 - overlay.Alpha), Easing.Out).OnComplete(_ =>
             {
-                fired = true;
                 Action?.Invoke();
-            }
+                fired = true;
+            });
+        }
+
+        protected void AbortConfirm()
+        {
+            if (!AllowMultipleFires && fired) return;
+            overlay.FadeOut(fadeout_delay, Easing.Out);
         }
     }
 }