Merge pull request #1316 from andy840119/implement-get-value-by-text-tag-state

andy840119 · web-flow · commit 4ea630af5fc6 · 2022-05-14T14:36:45.000+08:00
Remove something like state == TextIndex.IndexState.Start ? A : B
diff --git a/osu.Game.Rulesets.Karaoke.Tests/Utils/TextIndexUtilsTest.cs b/osu.Game.Rulesets.Karaoke.Tests/Utils/TextIndexUtilsTest.cs
@@ -95,6 +95,18 @@ public void TestOutOfRange(int index, TextIndex.IndexState state, string lyric,
             Assert.AreEqual(expected, actual);
         }
 
+        [TestCase(TextIndex.IndexState.Start, 1, -1, 1)]
+        [TestCase(TextIndex.IndexState.End, 1, -1, -1)]
+        [TestCase(TextIndex.IndexState.Start, "1", "-1", "1")]
+        [TestCase(TextIndex.IndexState.End, "1", "-1", "-1")]
+        public void TestGetValueByState(TextIndex.IndexState state, object startValue, object endValue, object expected)
+        {
+            var textIndex = new TextIndex(0, state);
+
+            object actual = TextIndexUtils.GetValueByState(textIndex, startValue, endValue);
+            Assert.AreEqual(expected, actual);
+        }
+
         [TestCase(0, TextIndex.IndexState.Start, "0")]
         [TestCase(0, TextIndex.IndexState.End, "0(end)")]
         [TestCase(-1, TextIndex.IndexState.Start, "-1")]
diff --git a/osu.Game.Rulesets.Karaoke/Beatmaps/Formats/LrcEncoder.cs b/osu.Game.Rulesets.Karaoke/Beatmaps/Formats/LrcEncoder.cs
@@ -54,8 +54,7 @@ internal static IReadOnlyDictionary<TextIndex, double> ToDictionary(IList<Karaok
 
             // convert to dictionary, will get start's smallest time and end's largest time.
             return sortedTimeTags.Where(x => x.Time != null).GroupBy(x => x.Index)
-                                 .Select(x =>
-                                     x.Key.State == TextIndex.IndexState.Start ? x.FirstOrDefault() : x.LastOrDefault())
+                                 .Select(x => TextIndexUtils.GetValueByState(x.Key, x.FirstOrDefault(), x.LastOrDefault()))
                                  .ToDictionary(
                                      k => k?.Index ?? throw new ArgumentNullException(nameof(k)),
                                      v => v?.Time ?? throw new ArgumentNullException(nameof(v)));
diff --git a/osu.Game.Rulesets.Karaoke/Edit/Components/Cursor/TimeTagTooltip.cs b/osu.Game.Rulesets.Karaoke/Edit/Components/Cursor/TimeTagTooltip.cs
@@ -5,7 +5,6 @@
 using osu.Framework.Graphics;
 using osu.Framework.Graphics.Containers;
 using osu.Framework.Graphics.Shapes;
-using osu.Framework.Graphics.Sprites;
 using osu.Game.Graphics;
 using osu.Game.Graphics.Sprites;
 using osu.Game.Rulesets.Karaoke.Graphics.Cursor;
@@ -94,7 +93,7 @@ public override void SetContent(TimeTag timeTag)
 
             trackTimer.Text = TimeTagUtils.FormattedString(timeTag);
             index.Text = $"Position: {timeTag.Index.Index}";
-            indexState.Text = timeTag.Index.State == TextIndex.IndexState.Start ? "Start" : "End";
+            indexState.Text = TextIndexUtils.GetValueByState(timeTag.Index, "start", "end");
         }
 
         [BackgroundDependencyLoader]
diff --git a/osu.Game.Rulesets.Karaoke/Edit/Lyrics/OsuColourExtensions.cs b/osu.Game.Rulesets.Karaoke/Edit/Lyrics/OsuColourExtensions.cs
@@ -1,9 +1,9 @@
 ﻿// Copyright (c) andy840119 <andy840119@gmail.com>. Licensed under the GPL Licence.
 // See the LICENCE file in the repository root for full licence text.
 
-using osu.Framework.Graphics.Sprites;
 using osu.Game.Graphics;
 using osu.Game.Rulesets.Karaoke.Objects;
+using osu.Game.Rulesets.Karaoke.Utils;
 using osuTK.Graphics;
 
 namespace osu.Game.Rulesets.Karaoke.Edit.Lyrics
@@ -16,8 +16,7 @@ public static Color4 GetTimeTagColour(this OsuColour colours, TimeTag timeTag)
             if (!hasTime)
                 return colours.Gray7;
 
-            bool start = timeTag.Index.State == TextIndex.IndexState.Start;
-            return start ? colours.Yellow : colours.YellowDarker;
+            return TextIndexUtils.GetValueByState(timeTag.Index, colours.Yellow, colours.YellowDarker);
         }
 
         public static Color4 GetEditTimeTagCaretColour(this OsuColour colours)
diff --git a/osu.Game.Rulesets.Karaoke/Edit/Lyrics/Rows/Components/Carets/DrawableTimeTagEditCaret.cs b/osu.Game.Rulesets.Karaoke/Edit/Lyrics/Rows/Components/Carets/DrawableTimeTagEditCaret.cs
@@ -3,10 +3,10 @@
 
 using osu.Framework.Allocation;
 using osu.Framework.Graphics;
-using osu.Framework.Graphics.Sprites;
 using osu.Game.Graphics;
 using osu.Game.Rulesets.Karaoke.Edit.Components.Sprites;
 using osu.Game.Rulesets.Karaoke.Edit.Lyrics.CaretPosition;
+using osu.Game.Rulesets.Karaoke.Utils;
 using osuTK;
 
 namespace osu.Game.Rulesets.Karaoke.Edit.Lyrics.Rows.Components.Carets
@@ -40,7 +40,7 @@ protected override void Apply(TimeTagIndexCaretPosition caret)
         {
             var textIndex = caret.Index;
             Position = karaokeSpriteText.GetTextIndexPosition(textIndex);
-            Origin = textIndex.State == TextIndex.IndexState.Start ? Anchor.BottomLeft : Anchor.BottomRight;
+            Origin = TextIndexUtils.GetValueByState(textIndex, Anchor.BottomLeft, Anchor.BottomRight);
 
             drawableTextIndex.State = textIndex.State;
             drawableTextIndex.Colour = colours.GetEditTimeTagCaretColour();
diff --git a/osu.Game.Rulesets.Karaoke/Edit/Lyrics/Rows/Components/Carets/DrawableTimeTagRecordCaret.cs b/osu.Game.Rulesets.Karaoke/Edit/Lyrics/Rows/Components/Carets/DrawableTimeTagRecordCaret.cs
@@ -3,10 +3,10 @@
 
 using osu.Framework.Allocation;
 using osu.Framework.Graphics;
-using osu.Framework.Graphics.Sprites;
 using osu.Game.Graphics;
 using osu.Game.Rulesets.Karaoke.Edit.Components.Sprites;
 using osu.Game.Rulesets.Karaoke.Edit.Lyrics.CaretPosition;
+using osu.Game.Rulesets.Karaoke.Utils;
 using osuTK;
 
 namespace osu.Game.Rulesets.Karaoke.Edit.Lyrics.Rows.Components.Carets
@@ -41,7 +41,7 @@ protected override void Apply(TimeTagCaretPosition caret)
             var timeTag = caret.TimeTag;
             var textIndex = timeTag.Index;
             this.MoveTo(karaokeSpriteText.GetTimeTagPosition(timeTag), Preview ? 0 : 100, Easing.OutCubic);
-            Origin = textIndex.State == TextIndex.IndexState.Start ? Anchor.BottomLeft : Anchor.BottomRight;
+            Origin = TextIndexUtils.GetValueByState(textIndex, Anchor.BottomLeft, Anchor.BottomRight);
 
             drawableTextIndex.State = textIndex.State;
             drawableTextIndex.Colour = colours.GetRecordingTimeTagCaretColour(timeTag);
diff --git a/osu.Game.Rulesets.Karaoke/Edit/Lyrics/Rows/Components/EditorKaraokeSpriteText.cs b/osu.Game.Rulesets.Karaoke/Edit/Lyrics/Rows/Components/EditorKaraokeSpriteText.cs
@@ -104,12 +104,12 @@ public Vector2 GetTimeTagPosition(TimeTag timeTag)
             float extraPosition = extraSpacing(HitObject.TimeTags, timeTag);
             return basePosition + new Vector2(extraPosition, 0);
 
-            static float extraSpacing(IEnumerable<TimeTag> timeTagsInLyric, TimeTag timeTag)
+            static float extraSpacing(IList<TimeTag> timeTagsInLyric, TimeTag timeTag)
             {
-                bool isStart = timeTag.Index.State == TextIndex.IndexState.Start;
-                var timeTags = isStart ? timeTagsInLyric.Reverse() : timeTagsInLyric;
-                int duplicatedTagAmount = timeTags.SkipWhile(t => t != timeTag).Count(x => x.Index == timeTag.Index) - 1;
-                int spacing = duplicatedTagAmount * time_tag_spacing * (isStart ? 1 : -1);
+                var textIndex = timeTag.Index;
+                var timeTags = TextIndexUtils.GetValueByState(textIndex, timeTagsInLyric.Reverse(), timeTagsInLyric);
+                int duplicatedTagAmount = timeTags.SkipWhile(t => t != timeTag).Count(x => x.Index == textIndex) - 1;
+                int spacing = duplicatedTagAmount * time_tag_spacing * TextIndexUtils.GetValueByState(textIndex, 1, -1);
                 return spacing;
             }
         }
@@ -172,7 +172,7 @@ public RectangleF GetRomajiTagPosition(RomajiTag romajiTag)
             public Vector2 GetTimeTagPosition(TextIndex index)
             {
                 var drawRectangle = GetCharacterRectangle(index.Index);
-                return index.State == TextIndex.IndexState.Start ? drawRectangle.BottomLeft : drawRectangle.BottomRight;
+                return TextIndexUtils.GetValueByState(index, drawRectangle.BottomLeft, drawRectangle.BottomRight);
             }
         }
     }
diff --git a/osu.Game.Rulesets.Karaoke/Edit/Lyrics/Rows/Components/Parts/DrawableTimeTag.cs b/osu.Game.Rulesets.Karaoke/Edit/Lyrics/Rows/Components/Parts/DrawableTimeTag.cs
@@ -10,6 +10,7 @@
 using osu.Game.Rulesets.Karaoke.Edit.Components.Cursor;
 using osu.Game.Rulesets.Karaoke.Edit.Components.Sprites;
 using osu.Game.Rulesets.Karaoke.Objects;
+using osu.Game.Rulesets.Karaoke.Utils;
 using osuTK;
 
 namespace osu.Game.Rulesets.Karaoke.Edit.Lyrics.Rows.Components.Parts
@@ -26,7 +27,7 @@ public class DrawableTimeTag : CompositeDrawable, IHasCustomTooltip<TimeTag>
         public DrawableTimeTag(TimeTag timeTag)
         {
             AutoSizeAxes = Axes.Both;
-            Origin = timeTag.Index.State == TextIndex.IndexState.Start ? Anchor.BottomLeft : Anchor.BottomRight;
+            Origin = TextIndexUtils.GetValueByState(timeTag.Index, Anchor.BottomLeft, Anchor.BottomRight);
 
             this.timeTag = timeTag;
             var state = timeTag.Index.State;
diff --git a/osu.Game.Rulesets.Karaoke/Edit/Lyrics/Rows/Extends/RecordingTimeTags/RecordingTimeTagPart.cs b/osu.Game.Rulesets.Karaoke/Edit/Lyrics/Rows/Extends/RecordingTimeTags/RecordingTimeTagPart.cs
@@ -92,9 +92,10 @@ private void load(OsuColour colours, RecordingTimeTagEditor timeline, ILyricCare
                     }
 
                     var timeTag = timeTagCaretPosition.TimeTag;
+                    var textIndex = timeTag.Index;
                     var state = timeTag.Index.State;
 
-                    Origin = state == TextIndex.IndexState.Start ? Anchor.BottomLeft : Anchor.BottomRight;
+                    Origin = TextIndexUtils.GetValueByState(textIndex, Anchor.BottomLeft, Anchor.BottomRight);
                     drawableTextIndex.Colour = colours.GetRecordingTimeTagCaretColour(timeTag);
                     drawableTextIndex.State = state;
 
@@ -131,11 +132,11 @@ public RecordingTimeTagVisualization(Lyric lyric, TimeTag timeTag)
                 this.lyric = lyric;
                 this.timeTag = timeTag;
 
-                var state = timeTag.Index.State;
-                bool start = state == TextIndex.IndexState.Start;
+                var textIndex = timeTag.Index;
 
                 Anchor = Anchor.CentreLeft;
-                Origin = start ? Anchor.CentreLeft : Anchor.CentreRight;
+                Origin = TextIndexUtils.GetValueByState(textIndex, Anchor.CentreLeft, Anchor.CentreRight);
+
                 RelativePositionAxes = Axes.X;
                 Size = new Vector2(RecordingTimeTagEditor.TIMELINE_HEIGHT);
 
@@ -148,13 +149,13 @@ public RecordingTimeTagVisualization(Lyric lyric, TimeTag timeTag)
                         Anchor = Anchor.Centre,
                         Origin = Anchor.Centre,
                         RelativeSizeAxes = Axes.Both,
-                        State = state
+                        State = textIndex.State
                     },
                     new OsuSpriteText
                     {
                         Text = LyricUtils.GetTimeTagDisplayRubyText(lyric, timeTag),
-                        Anchor = start ? Anchor.BottomLeft : Anchor.BottomRight,
-                        Origin = start ? Anchor.TopLeft : Anchor.TopRight,
+                        Anchor = TextIndexUtils.GetValueByState(textIndex, Anchor.BottomLeft, Anchor.BottomRight),
+                        Origin = TextIndexUtils.GetValueByState(textIndex, Anchor.TopLeft, Anchor.TopRight),
                     }
                 };
             }
diff --git a/osu.Game.Rulesets.Karaoke/Edit/Lyrics/Rows/Extends/TimeTags/TimeTagEditorHitObjectBlueprint.cs b/osu.Game.Rulesets.Karaoke/Edit/Lyrics/Rows/Extends/TimeTags/TimeTagEditorHitObjectBlueprint.cs
@@ -160,22 +160,22 @@ public TimeTagPiece(TimeTag timeTag)
                 RelativeSizeAxes = Axes.Y;
                 Width = 10;
 
-                var state = timeTag.Index.State;
+                var textIndex = timeTag.Index;
                 InternalChildren = new Drawable[]
                 {
                     new Box
                     {
                         RelativeSizeAxes = Axes.Y,
                         Width = 1.5f,
-                        Anchor = state == TextIndex.IndexState.Start ? Anchor.CentreLeft : Anchor.CentreRight,
-                        Origin = state == TextIndex.IndexState.Start ? Anchor.CentreLeft : Anchor.CentreRight
+                        Anchor = TextIndexUtils.GetValueByState(textIndex, Anchor.CentreLeft, Anchor.CentreRight),
+                        Origin = TextIndexUtils.GetValueByState(textIndex, Anchor.CentreLeft, Anchor.CentreRight),
                     },
                     new DrawableTextIndex
                     {
                         Size = new Vector2(10),
                         Anchor = Anchor.BottomCentre,
                         Origin = Anchor.BottomCentre,
-                        State = state
+                        State = textIndex.State
                     }
                 };
             }
diff --git a/osu.Game.Rulesets.Karaoke/IO/Serialization/Converters/TimeTagConverter.cs b/osu.Game.Rulesets.Karaoke/IO/Serialization/Converters/TimeTagConverter.cs
@@ -8,6 +8,7 @@
 using osu.Framework.Graphics.Sprites;
 using osu.Game.Rulesets.Karaoke.Extensions;
 using osu.Game.Rulesets.Karaoke.Objects;
+using osu.Game.Rulesets.Karaoke.Utils;
 
 namespace osu.Game.Rulesets.Karaoke.IO.Serialization.Converters
 {
@@ -35,11 +36,11 @@ public override TimeTag ReadJson(JsonReader reader, Type objectType, TimeTag exi
 
         public override void WriteJson(JsonWriter writer, TimeTag value, JsonSerializer serializer)
         {
-            var tag = value.Index;
-            string state = tag.State == TextIndex.IndexState.Start ? "start" : "end";
+            var index = value.Index;
+            string state = TextIndexUtils.GetValueByState(index, "start", "end");
             double? time = value.Time;
 
-            string str = $"[{tag.Index},{state}]:{time}";
+            string str = $"[{index.Index},{state}]:{time}";
             writer.WriteValue(str);
         }
     }
diff --git a/osu.Game.Rulesets.Karaoke/Utils/TextIndexUtils.cs b/osu.Game.Rulesets.Karaoke/Utils/TextIndexUtils.cs
@@ -1,19 +1,15 @@
 ﻿// Copyright (c) andy840119 <andy840119@gmail.com>. Licensed under the GPL Licence.
 // See the LICENCE file in the repository root for full licence text.
 
+using System;
 using osu.Framework.Graphics.Sprites;
 
 namespace osu.Game.Rulesets.Karaoke.Utils
 {
     public static class TextIndexUtils
     {
         public static int ToStringIndex(TextIndex index)
-        {
-            if (index.State == TextIndex.IndexState.Start)
-                return index.Index;
-
-            return index.Index + 1;
-        }
+            => GetValueByState(index, index.Index, index.Index + 1);
 
         public static TextIndex FromStringIndex(int index, bool end)
         {
@@ -50,6 +46,14 @@ public static bool OutOfRange(TextIndex index, string lyric)
             return index.Index < 0 || index.Index >= lyric.Length;
         }
 
+        public static T GetValueByState<T>(TextIndex index, T startValue, T endValue) =>
+            index.State switch
+            {
+                TextIndex.IndexState.Start => startValue,
+                TextIndex.IndexState.End => endValue,
+                _ => throw new ArgumentOutOfRangeException(nameof(index))
+            };
+
         /// <summary>
         /// Display string with position format
         /// </summary>
@@ -62,7 +66,7 @@ public static bool OutOfRange(TextIndex index, string lyric)
         public static string PositionFormattedString(TextIndex textIndex)
         {
             int index = textIndex.Index;
-            string state = textIndex.State == TextIndex.IndexState.End ? "(end)" : "";
+            string state = GetValueByState(textIndex, "", "(end)");
             return $"{index}{state}";
         }
     }

Original file line number	Diff line number	Diff line change
`@@ -104,12 +104,12 @@ public Vector2 GetTimeTagPosition(TimeTag timeTag)`
`104`	`104`	`float extraPosition = extraSpacing(HitObject.TimeTags, timeTag);`
`105`	`105`	`return basePosition + new Vector2(extraPosition, 0);`
`106`	`106`
`107`		`- static float extraSpacing(IEnumerable<TimeTag> timeTagsInLyric, TimeTag timeTag)`
	`107`	`+ static float extraSpacing(IList<TimeTag> timeTagsInLyric, TimeTag timeTag)`
`108`	`108`	`{`
`109`		`- bool isStart = timeTag.Index.State == TextIndex.IndexState.Start;`
`110`		`- var timeTags = isStart ? timeTagsInLyric.Reverse() : timeTagsInLyric;`
`111`		`- int duplicatedTagAmount = timeTags.SkipWhile(t => t != timeTag).Count(x => x.Index == timeTag.Index) - 1;`
`112`		`- int spacing = duplicatedTagAmount * time_tag_spacing * (isStart ? 1 : -1);`
	`109`	`+ var textIndex = timeTag.Index;`
	`110`	`+ var timeTags = TextIndexUtils.GetValueByState(textIndex, timeTagsInLyric.Reverse(), timeTagsInLyric);`
	`111`	`+ int duplicatedTagAmount = timeTags.SkipWhile(t => t != timeTag).Count(x => x.Index == textIndex) - 1;`
	`112`	`+ int spacing = duplicatedTagAmount * time_tag_spacing * TextIndexUtils.GetValueByState(textIndex, 1, -1);`
`113`	`113`	`return spacing;`
`114`	`114`	`}`
`115`	`115`	`}`
`@@ -172,7 +172,7 @@ public RectangleF GetRomajiTagPosition(RomajiTag romajiTag)`
`172`	`172`	`public Vector2 GetTimeTagPosition(TextIndex index)`
`173`	`173`	`{`
`174`	`174`	`var drawRectangle = GetCharacterRectangle(index.Index);`
`175`		`- return index.State == TextIndex.IndexState.Start ? drawRectangle.BottomLeft : drawRectangle.BottomRight;`
	`175`	`+ return TextIndexUtils.GetValueByState(index, drawRectangle.BottomLeft, drawRectangle.BottomRight);`
`176`	`176`	`}`
`177`	`177`	`}`
`178`	`178`	`}`
Original file line number	Diff line number	Diff line change
`@@ -160,22 +160,22 @@ public TimeTagPiece(TimeTag timeTag)`
`160`	`160`	`RelativeSizeAxes = Axes.Y;`
`161`	`161`	`Width = 10;`
`162`	`162`
`163`		`- var state = timeTag.Index.State;`
	`163`	`+ var textIndex = timeTag.Index;`
`164`	`164`	`InternalChildren = new Drawable[]`
`165`	`165`	`{`
`166`	`166`	`new Box`
`167`	`167`	`{`
`168`	`168`	`RelativeSizeAxes = Axes.Y,`
`169`	`169`	`Width = 1.5f,`
`170`		`- Anchor = state == TextIndex.IndexState.Start ? Anchor.CentreLeft : Anchor.CentreRight,`
`171`		`- Origin = state == TextIndex.IndexState.Start ? Anchor.CentreLeft : Anchor.CentreRight`
	`170`	`+ Anchor = TextIndexUtils.GetValueByState(textIndex, Anchor.CentreLeft, Anchor.CentreRight),`
	`171`	`+ Origin = TextIndexUtils.GetValueByState(textIndex, Anchor.CentreLeft, Anchor.CentreRight),`
`172`	`172`	`},`
`173`	`173`	`new DrawableTextIndex`
`174`	`174`	`{`
`175`	`175`	`Size = new Vector2(10),`
`176`	`176`	`Anchor = Anchor.BottomCentre,`
`177`	`177`	`Origin = Anchor.BottomCentre,`
`178`		`- State = state`
	`178`	`+ State = textIndex.State`
`179`	`179`	`}`
`180`	`180`	`};`
`181`	`181`	`}`