Add new extension for formatting time durations

osu.Game.Tests/NonVisual/TimeDisplayExtensionTest.cs

@@ -0,0 +1,41 @@
+// 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;
+using NUnit.Framework;
+using osu.Game.Extensions;
+
+namespace osu.Game.Tests.NonVisual
+{
+    [TestFixture]
+    public class TimeDisplayExtensionTest
+    {
+        private static readonly object[][] editor_formatted_duration_tests =
+        {
+            new object[] { new TimeSpan(0, 0, 0, 0, 50), "00:00:050" },
+            new object[] { new TimeSpan(0, 0, 0, 10, 50), "00:10:050" },
+            new object[] { new TimeSpan(0, 0, 5, 10), "05:10:000" },
+            new object[] { new TimeSpan(0, 1, 5, 10), "65:10:000" },
+        };
+
+        [TestCaseSource(nameof(editor_formatted_duration_tests))]
+        public void TestEditorFormat(TimeSpan input, string expectedOutput)
+        {
+            Assert.AreEqual(expectedOutput, input.ToEditorFormattedString());
+        }
+
+        private static readonly object[][] formatted_duration_tests =
+        {
+            new object[] { new TimeSpan(0, 0, 10), "00:10" },
+            new object[] { new TimeSpan(0, 5, 10), "05:10" },
+            new object[] { new TimeSpan(1, 5, 10), "01:05:10" },
+            new object[] { new TimeSpan(1, 1, 5, 10), "01:01:05:10" },
+        };
+
+        [TestCaseSource(nameof(formatted_duration_tests))]
+        public void TestFormattedDuration(TimeSpan input, string expectedOutput)
+        {
+            Assert.AreEqual(expectedOutput, input.ToFormattedDuration().ToString());
+        }
+    }
+}

osu.Game/Extensions/EditorDisplayExtensions.cs

@@ -1,26 +0,0 @@
-// 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;
-
-namespace osu.Game.Extensions
-{
-    public static class EditorDisplayExtensions
-    {
-        /// <summary>
-        /// Get an editor formatted string (mm:ss:mss)
-        /// </summary>
-        /// <param name="milliseconds">A time value in milliseconds.</param>
-        /// <returns>An editor formatted display string.</returns>
-        public static string ToEditorFormattedString(this double milliseconds) =>
-            ToEditorFormattedString(TimeSpan.FromMilliseconds(milliseconds));
-
-        /// <summary>
-        /// Get an editor formatted string (mm:ss:mss)
-        /// </summary>
-        /// <param name="timeSpan">A time value.</param>
-        /// <returns>An editor formatted display string.</returns>
-        public static string ToEditorFormattedString(this TimeSpan timeSpan) =>
-            $"{(timeSpan < TimeSpan.Zero ? "-" : string.Empty)}{timeSpan:mm\\:ss\\:fff}";
-    }
-}

osu.Game/Extensions/TimeDisplayExtensions.cs

@@ -0,0 +1,51 @@
+// 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;
+using osu.Framework.Localisation;
+
+namespace osu.Game.Extensions
+{
+    public static class TimeDisplayExtensions
+    {
+        /// <summary>
+        /// Get an editor formatted string (mm:ss:mss)
+        /// </summary>
+        /// <param name="milliseconds">A time value in milliseconds.</param>
+        /// <returns>An editor formatted display string.</returns>
+        public static string ToEditorFormattedString(this double milliseconds) =>
+            ToEditorFormattedString(TimeSpan.FromMilliseconds(milliseconds));
+
+        /// <summary>
+        /// Get an editor formatted string (mm:ss:mss)
+        /// </summary>
+        /// <param name="timeSpan">A time value.</param>
+        /// <returns>An editor formatted display string.</returns>
+        public static string ToEditorFormattedString(this TimeSpan timeSpan) =>
+            $"{(timeSpan < TimeSpan.Zero ? "-" : string.Empty)}{(int)timeSpan.TotalMinutes:00}:{timeSpan:ss\\:fff}";
+
+        /// <summary>
+        /// Get a formatted duration (mm:ss or HH:mm:ss if more than an hour).
+        /// </summary>
+        /// <param name="milliseconds">A duration in milliseconds.</param>
+        /// <returns>A formatted duration string.</returns>
+        public static LocalisableString ToFormattedDuration(this double milliseconds) =>
+            ToFormattedDuration(TimeSpan.FromMilliseconds(milliseconds));
+
+        /// <summary>
+        /// Get a formatted duration (dd:hh:mm:ss with days/hours omitted if zero).
+        /// </summary>
+        /// <param name="timeSpan">A duration value.</param>
+        /// <returns>A formatted duration string.</returns>
+        public static LocalisableString ToFormattedDuration(this TimeSpan timeSpan)
+        {
+            if (timeSpan.TotalDays >= 1)
+                return new LocalisableFormattableString(timeSpan, @"dd\:hh\:mm\:ss");
+
+            if (timeSpan.TotalHours >= 1)
+                return new LocalisableFormattableString(timeSpan, @"hh\:mm\:ss");
+
+            return new LocalisableFormattableString(timeSpan, @"mm\:ss");
+        }
+    }
+}