Merge pull request #1423 from andy840119/remove-disable-null-in-the-l…

…yric-editor-state

Enable NRT in the lyric editor state.

osu.Game.Rulesets.Karaoke.Tests/Editor/Lyrics/States/LyricCaretStateTest.cs

@@ -1,8 +1,6 @@
 // Copyright (c) andy840119 <[email protected]>. Licensed under the GPL Licence.
 // See the LICENCE file in the repository root for full licence text.
 
-#nullable disable
-
 using System;
 using System.Collections.Generic;
 using NUnit.Framework;
@@ -28,8 +26,8 @@ namespace osu.Game.Rulesets.Karaoke.Tests.Editor.Lyrics.States
     public class LyricCaretStateTest : OsuTestScene
     {
         private readonly IBeatmap beatmap;
-        private ILyricEditorState state;
-        private LyricCaretState lyricCaretState;
+        private ILyricEditorState state = null!;
+        private LyricCaretState lyricCaretState = null!;
 
         public LyricCaretStateTest()
         {
@@ -239,11 +237,11 @@ public void MovingHoverCaretByCaretPositionWithEditMode()
 
             // because switch to the singer lyric, so current caret position will at the first lyric.
             assertCaretPosition(Assert.IsInstanceOf<NavigateCaretPosition>);
-            assertCaretPosition(x => Assert.AreEqual(firstLyric, x.Lyric));
+            assertCaretPosition(x => Assert.AreEqual(firstLyric, x?.Lyric));
 
             // yes, should change the position if contains algorithm.
             assertHoverCaretPosition(Assert.IsInstanceOf<NavigateCaretPosition>);
-            assertHoverCaretPosition(x => Assert.AreEqual(targetLyric, x.Lyric));
+            assertHoverCaretPosition(x => Assert.AreEqual(targetLyric, x?.Lyric));
         }
 
         [Test]
@@ -318,17 +316,17 @@ private void movingHoverCaretByLyric(ICaretPosition caretPosition, bool exceptSu
         }
 
         private Lyric getLyricFromBeatmap(int index)
-            => beatmap.HitObjects[index] as Lyric;
+            => (Lyric)beatmap.HitObjects[index];
 
-        private void assertCaretPosition(Action<ICaretPosition> caretPosition)
+        private void assertCaretPosition(Action<ICaretPosition?> caretPosition)
         {
             AddStep("Assert caret position", () =>
             {
                 caretPosition.Invoke(lyricCaretState.BindableCaretPosition.Value);
             });
         }
 
-        private void assertHoverCaretPosition(Action<ICaretPosition> caretPosition)
+        private void assertHoverCaretPosition(Action<ICaretPosition?> caretPosition)
         {
             AddStep("Assert hover caret position", () =>
             {

osu.Game.Rulesets.Karaoke/Edit/Lyrics/States/CreateTimeTagEditMode.cs

@@ -1,8 +1,6 @@
 // Copyright (c) andy840119 <[email protected]>. Licensed under the GPL Licence.
 // See the LICENCE file in the repository root for full licence text.
 
-#nullable disable
-
 namespace osu.Game.Rulesets.Karaoke.Edit.Lyrics.States
 {
     public enum CreateTimeTagEditMode

osu.Game.Rulesets.Karaoke/Edit/Lyrics/States/ILyricCaretState.cs

@@ -1,8 +1,6 @@
 // Copyright (c) andy840119 <[email protected]>. Licensed under the GPL Licence.
 // See the LICENCE file in the repository root for full licence text.
 
-#nullable disable
-
 using osu.Framework.Bindables;
 using osu.Game.Rulesets.Karaoke.Edit.Lyrics.CaretPosition;
 using osu.Game.Rulesets.Karaoke.Edit.Lyrics.CaretPosition.Algorithms;
@@ -12,11 +10,11 @@ namespace osu.Game.Rulesets.Karaoke.Edit.Lyrics.States
 {
     public interface ILyricCaretState
     {
-        IBindable<ICaretPosition> BindableHoverCaretPosition { get; }
+        IBindable<ICaretPosition?> BindableHoverCaretPosition { get; }
 
-        IBindable<ICaretPosition> BindableCaretPosition { get; }
+        IBindable<ICaretPosition?> BindableCaretPosition { get; }
 
-        IBindable<ICaretPositionAlgorithm> BindableCaretPositionAlgorithm { get; }
+        IBindable<ICaretPositionAlgorithm?> BindableCaretPositionAlgorithm { get; }
 
         bool MoveCaret(MovingCaretAction action);
 

osu.Game.Rulesets.Karaoke/Edit/Lyrics/States/ILyricSelectionState.cs

@@ -1,8 +1,6 @@
 // Copyright (c) andy840119 <[email protected]>. Licensed under the GPL Licence.
 // See the LICENCE file in the repository root for full licence text.
 
-#nullable disable
-
 using System;
 using System.Collections.Generic;
 using osu.Framework.Bindables;
@@ -19,7 +17,7 @@ public interface ILyricSelectionState
 
         IBindableList<Lyric> SelectedLyrics { get; }
 
-        Action<LyricEditorSelectingAction> Action { get; set; }
+        Action<LyricEditorSelectingAction>? Action { get; set; }
 
         void StartSelecting();
 

osu.Game.Rulesets.Karaoke/Edit/Lyrics/States/LyricCaretState.cs

@@ -1,10 +1,9 @@
 // Copyright (c) andy840119 <[email protected]>. Licensed under the GPL Licence.
 // See the LICENCE file in the repository root for full licence text.
 
-#nullable disable
-
 using System;
 using System.ComponentModel;
+using System.Diagnostics.CodeAnalysis;
 using System.Linq;
 using osu.Framework.Allocation;
 using osu.Framework.Bindables;
@@ -21,16 +20,16 @@ namespace osu.Game.Rulesets.Karaoke.Edit.Lyrics.States
 {
     public class LyricCaretState : Component, ILyricCaretState
     {
-        public IBindable<ICaretPosition> BindableHoverCaretPosition => bindableHoverCaretPosition;
-        public IBindable<ICaretPosition> BindableCaretPosition => bindableCaretPosition;
+        public IBindable<ICaretPosition?> BindableHoverCaretPosition => bindableHoverCaretPosition;
+        public IBindable<ICaretPosition?> BindableCaretPosition => bindableCaretPosition;
 
-        public IBindable<ICaretPositionAlgorithm> BindableCaretPositionAlgorithm => bindableCaretPositionAlgorithm;
+        public IBindable<ICaretPositionAlgorithm?> BindableCaretPositionAlgorithm => bindableCaretPositionAlgorithm;
 
-        private readonly Bindable<ICaretPosition> bindableHoverCaretPosition = new();
-        private readonly Bindable<ICaretPosition> bindableCaretPosition = new();
-        private readonly Bindable<ICaretPositionAlgorithm> bindableCaretPositionAlgorithm = new();
+        private readonly Bindable<ICaretPosition?> bindableHoverCaretPosition = new();
+        private readonly Bindable<ICaretPosition?> bindableCaretPosition = new();
+        private readonly Bindable<ICaretPositionAlgorithm?> bindableCaretPositionAlgorithm = new();
 
-        private ICaretPositionAlgorithm algorithm => bindableCaretPositionAlgorithm.Value;
+        private ICaretPositionAlgorithm? algorithm => bindableCaretPositionAlgorithm.Value;
 
         private readonly IBindableList<Lyric> bindableLyrics = new BindableList<Lyric>();
 
@@ -44,7 +43,7 @@ public class LyricCaretState : Component, ILyricCaretState
         private readonly IBindable<MovingTimeTagCaretMode> bindableRecordingMovingCaretMode = new Bindable<MovingTimeTagCaretMode>();
         private readonly IBindable<bool> bindableRecordingChangeTimeWhileMovingTheCaret = new Bindable<bool>();
 
-        [Resolved]
+        [Resolved, AllowNull]
         private EditorClock editorClock { get; set; }
 
         public LyricCaretState()
@@ -109,7 +108,7 @@ private void refreshAlgorithmAndCaretPosition()
             // should update selection if selected lyric changed.
             postProcess();
 
-            static ICaretPosition getCaretPosition(ICaretPositionAlgorithm algorithm, Lyric lyric)
+            static ICaretPosition? getCaretPosition(ICaretPositionAlgorithm? algorithm, Lyric? lyric)
             {
                 if (algorithm == null)
                     return null;
@@ -121,7 +120,7 @@ static ICaretPosition getCaretPosition(ICaretPositionAlgorithm algorithm, Lyric
             }
         }
 
-        private ICaretPositionAlgorithm getAlgorithmByMode()
+        private ICaretPositionAlgorithm? getAlgorithmByMode()
         {
             var lyrics = bindableLyrics.ToArray();
             var lyricEditorMode = bindableMode.Value;
@@ -187,10 +186,10 @@ public bool MoveCaret(MovingCaretAction action)
 
             var position = action switch
             {
-                MovingCaretAction.Up => algorithm.MoveUp(currentPosition),
-                MovingCaretAction.Down => algorithm.MoveDown(currentPosition),
-                MovingCaretAction.Left => algorithm.MoveLeft(currentPosition),
-                MovingCaretAction.Right => algorithm.MoveRight(currentPosition),
+                MovingCaretAction.Up => moveIfNotNull(currentPosition, algorithm.MoveUp),
+                MovingCaretAction.Down => moveIfNotNull(currentPosition, algorithm.MoveDown),
+                MovingCaretAction.Left => moveIfNotNull(currentPosition, algorithm.MoveLeft),
+                MovingCaretAction.Right => moveIfNotNull(currentPosition, algorithm.MoveRight),
                 MovingCaretAction.First => algorithm.MoveToFirst(),
                 MovingCaretAction.Last => algorithm.MoveToLast(),
                 _ => throw new InvalidEnumArgumentException(nameof(action))
@@ -201,6 +200,9 @@ public bool MoveCaret(MovingCaretAction action)
 
             MoveCaretToTargetPosition(position);
             return true;
+
+            static ICaretPosition? moveIfNotNull(ICaretPosition? caretPosition, Func<ICaretPosition, ICaretPosition?> action)
+                => caretPosition != null ? action.Invoke(caretPosition) : caretPosition;
         }
 
         public void MoveCaretToTargetPosition(Lyric lyric)
@@ -220,9 +222,6 @@ public void MoveCaretToTargetPosition(ICaretPosition position)
             if (position == null)
                 throw new ArgumentNullException(nameof(position));
 
-            if (position.Lyric == null)
-                return;
-
             bool movable = CaretPositionMovable(position);
 
             // stop moving the caret if forbidden by algorithm calculation.
@@ -240,9 +239,6 @@ public void MoveHoverCaretToTargetPosition(ICaretPosition position)
             if (position == null)
                 throw new ArgumentNullException(nameof(position));
 
-            if (position.Lyric == null)
-                return;
-
             if (!CaretPositionMovable(position))
                 return;
 
@@ -275,7 +271,7 @@ private void postProcess()
             var caretPosition = bindableCaretPosition.Value;
             navigateToTimeByCaretPosition(caretPosition);
 
-            void navigateToTimeByCaretPosition(ICaretPosition position)
+            void navigateToTimeByCaretPosition(ICaretPosition? position)
             {
                 if (position is not TimeTagCaretPosition timeTagCaretPosition)
                     return;

osu.Game.Rulesets.Karaoke/Edit/Lyrics/States/LyricEditorSelectingAction.cs

@@ -1,8 +1,6 @@
 // Copyright (c) andy840119 <[email protected]>. Licensed under the GPL Licence.
 // See the LICENCE file in the repository root for full licence text.
 
-#nullable disable
-
 namespace osu.Game.Rulesets.Karaoke.Edit.Lyrics.States
 {
     public enum LyricEditorSelectingAction

osu.Game.Rulesets.Karaoke/Edit/Lyrics/States/LyricSelectionState.cs

@@ -1,10 +1,9 @@
 // Copyright (c) andy840119 <[email protected]>. Licensed under the GPL Licence.
 // See the LICENCE file in the repository root for full licence text.
 
-#nullable disable
-
 using System;
 using System.Collections.Generic;
+using System.Diagnostics.CodeAnalysis;
 using System.Linq;
 using osu.Framework.Allocation;
 using osu.Framework.Bindables;
@@ -26,12 +25,12 @@ public class LyricSelectionState : Component, ILyricSelectionState
 
         public IBindableList<Lyric> SelectedLyrics => bindableSelectedLyrics;
 
-        public Action<LyricEditorSelectingAction> Action { get; set; }
+        public Action<LyricEditorSelectingAction>? Action { get; set; }
 
-        [Resolved]
+        [Resolved, AllowNull]
         private EditorBeatmap beatmap { get; set; }
 
-        [Resolved]
+        [Resolved, AllowNull]
         private ILyricCaretState lyricCaretState { get; set; }
 
         private readonly BindableBool selecting = new();
@@ -119,9 +118,6 @@ public void UpdateDisableLyricList(IDictionary<Lyric, LocalisableString> disable
 
             bindableDisableSelectingLyric.Clear();
 
-            if (disableLyrics == null)
-                return;
-
             foreach ((var lyric, LocalisableString reason) in disableLyrics)
                 bindableDisableSelectingLyric.Add(lyric, reason);
         }

osu.Game.Rulesets.Karaoke/Edit/Lyrics/States/Modes/EditNoteModeState.cs

@@ -1,8 +1,6 @@
 // Copyright (c) andy840119 <[email protected]>. Licensed under the GPL Licence.
 // See the LICENCE file in the repository root for full licence text.
 
-#nullable disable
-
 using osu.Framework.Allocation;
 using osu.Framework.Bindables;
 using osu.Framework.Graphics;

osu.Game.Rulesets.Karaoke/Edit/Lyrics/States/Modes/EditRomajiModeState.cs

@@ -1,8 +1,6 @@
 // Copyright (c) andy840119 <[email protected]>. Licensed under the GPL Licence.
 // See the LICENCE file in the repository root for full licence text.
 
-#nullable disable
-
 using osu.Framework.Bindables;
 using osu.Framework.Graphics;
 using osu.Game.Rulesets.Karaoke.Objects;

osu.Game.Rulesets.Karaoke/Edit/Lyrics/States/Modes/EditRubyModeState.cs

@@ -1,8 +1,6 @@
 // Copyright (c) andy840119 <[email protected]>. Licensed under the GPL Licence.
 // See the LICENCE file in the repository root for full licence text.
 
-#nullable disable
-
 using osu.Framework.Bindables;
 using osu.Framework.Graphics;
 using osu.Game.Rulesets.Karaoke.Objects;

osu.Game.Rulesets.Karaoke/Edit/Lyrics/States/Modes/IEditNoteModeState.cs

@@ -1,8 +1,6 @@
 // Copyright (c) andy840119 <[email protected]>. Licensed under the GPL Licence.
 // See the LICENCE file in the repository root for full licence text.
 
-#nullable disable
-
 using osu.Framework.Bindables;
 using osu.Game.Rulesets.Karaoke.Edit.Lyrics.Extends.Notes;
 using osu.Game.Rulesets.Karaoke.Objects;

osu.Game.Rulesets.Karaoke/Edit/Lyrics/States/Modes/IEditRomajiModeState.cs

@@ -1,8 +1,6 @@
 // Copyright (c) andy840119 <[email protected]>. Licensed under the GPL Licence.
 // See the LICENCE file in the repository root for full licence text.
 
-#nullable disable
-
 using osu.Game.Rulesets.Karaoke.Objects;
 
 namespace osu.Game.Rulesets.Karaoke.Edit.Lyrics.States.Modes

osu.Game.Rulesets.Karaoke/Edit/Lyrics/States/Modes/IEditRubyModeState.cs

@@ -1,8 +1,6 @@
 // Copyright (c) andy840119 <[email protected]>. Licensed under the GPL Licence.
 // See the LICENCE file in the repository root for full licence text.
 
-#nullable disable
-
 using osu.Game.Rulesets.Karaoke.Objects;
 
 namespace osu.Game.Rulesets.Karaoke.Edit.Lyrics.States.Modes

osu.Game.Rulesets.Karaoke/Edit/Lyrics/States/Modes/IHasBlueprintSelection.cs

@@ -1,8 +1,6 @@
 // Copyright (c) andy840119 <[email protected]>. Licensed under the GPL Licence.
 // See the LICENCE file in the repository root for full licence text.
 
-#nullable disable
-
 using osu.Framework.Bindables;
 
 namespace osu.Game.Rulesets.Karaoke.Edit.Lyrics.States.Modes

osu.Game.Rulesets.Karaoke/Edit/Lyrics/States/Modes/IHasEditModeState.cs

@@ -1,8 +1,6 @@
 // Copyright (c) andy840119 <[email protected]>. Licensed under the GPL Licence.
 // See the LICENCE file in the repository root for full licence text.
 
-#nullable disable
-
 using System;
 using osu.Framework.Bindables;
 

osu.Game.Rulesets.Karaoke/Edit/Lyrics/States/Modes/IHasSpecialAction.cs

@@ -1,8 +1,6 @@
 // Copyright (c) andy840119 <[email protected]>. Licensed under the GPL Licence.
 // See the LICENCE file in the repository root for full licence text.
 
-#nullable disable
-
 using System;
 using osu.Framework.Bindables;
 

osu.Game.Rulesets.Karaoke/Edit/Lyrics/States/Modes/ILanguageModeState.cs

@@ -1,8 +1,6 @@
 // Copyright (c) andy840119 <[email protected]>. Licensed under the GPL Licence.
 // See the LICENCE file in the repository root for full licence text.
 
-#nullable disable
-
 using osu.Game.Rulesets.Karaoke.Edit.Lyrics.Extends.Languages;
 
 namespace osu.Game.Rulesets.Karaoke.Edit.Lyrics.States.Modes

osu.Game.Rulesets.Karaoke/Edit/Lyrics/States/Modes/IManageModeState.cs

@@ -1,8 +1,6 @@
 // Copyright (c) andy840119 <[email protected]>. Licensed under the GPL Licence.
 // See the LICENCE file in the repository root for full licence text.
 
-#nullable disable
-
 using osu.Game.Rulesets.Karaoke.Edit.Lyrics.Extends.Manage;
 
 namespace osu.Game.Rulesets.Karaoke.Edit.Lyrics.States.Modes

osu.Game.Rulesets.Karaoke/Edit/Lyrics/States/Modes/ITimeTagModeState.cs

@@ -1,8 +1,6 @@
 // Copyright (c) andy840119 <[email protected]>. Licensed under the GPL Licence.
 // See the LICENCE file in the repository root for full licence text.
 
-#nullable disable
-
 using osu.Framework.Bindables;
 using osu.Game.Rulesets.Karaoke.Objects;
 

osu.Game.Rulesets.Karaoke/Edit/Lyrics/States/Modes/LanguageEditMode.cs

@@ -1,8 +1,6 @@
 // Copyright (c) andy840119 <[email protected]>. Licensed under the GPL Licence.
 // See the LICENCE file in the repository root for full licence text.
 
-#nullable disable
-
 namespace osu.Game.Rulesets.Karaoke.Edit.Lyrics.States.Modes
 {
     public enum LanguageEditMode

osu.Game.Rulesets.Karaoke/Edit/Lyrics/States/Modes/LanguageModeState.cs

@@ -1,8 +1,6 @@
 // Copyright (c) andy840119 <[email protected]>. Licensed under the GPL Licence.
 // See the LICENCE file in the repository root for full licence text.
 
-#nullable disable
-
 using osu.Framework.Bindables;
 using osu.Framework.Graphics;
 using osu.Game.Rulesets.Karaoke.Edit.Lyrics.Extends.Languages;