Refactor coroutine management and improve cancellation handling in CVarConsole and CVarDisplay

Author: DerKekser

Assets/Kekser/UnityCVarConsole/CVarConsole.cs

@@ -136,10 +136,11 @@ public IEnumerator ReadKeyCoroutine(Action<char> onKeyRead)
 
             while (!_cts.IsCancellationRequested)
             {
-                yield return null;
-        
                 if (!AnyKeyDown)
+                {
+                    yield return null;
                     continue;
+                }
 
                 foreach (KeyCode keyCode in Enum.GetValues(typeof(KeyCode)))
                 {
@@ -156,10 +157,9 @@ public IEnumerator ReadKeyCoroutine(Action<char> onKeyRead)
                     onKeyRead(InputString[0]);
                     yield break;
                 }
+                
+                yield return null;
             }
-            
-            Display.HideCursor();
-            onKeyRead('\0');
         }
 
         public IEnumerator ReadLineCoroutine(Action<string> onLineRead, bool useHistory = false)
@@ -174,10 +174,11 @@ public IEnumerator ReadLineCoroutine(Action<string> onLineRead, bool useHistory
 
             while (!_cts.IsCancellationRequested)
             {
-                yield return null; // Wait for next frame
-
                 if (!AnyKeyDown)
+                {
+                    yield return null;
                     continue;
+                }
 
                 bool consumedInputString = false;
 
@@ -223,7 +224,7 @@ public IEnumerator ReadLineCoroutine(Action<string> onLineRead, bool useHistory
                             break;
                         case KeyCode.UpArrow:
                             if (!useHistory)
-                                continue;
+                                break;
                             int oldIndex1 = historyIndex;
                             historyIndex++;
                             historyIndex = Mathf.Clamp(historyIndex, -1, _history.Count - 1);
@@ -238,7 +239,7 @@ public IEnumerator ReadLineCoroutine(Action<string> onLineRead, bool useHistory
                             break;
                         case KeyCode.DownArrow:
                             if (!useHistory)
-                                continue;
+                                break;
                             int oldIndex2 = historyIndex;
                             historyIndex--;
                             historyIndex = Mathf.Clamp(historyIndex, -1, _history.Count - 1);
@@ -297,10 +298,9 @@ public IEnumerator ReadLineCoroutine(Action<string> onLineRead, bool useHistory
                         Display.Write(' ');
                 Display.SetCursor(startPosition.x + cursorPosition, startPosition.y);
                 oldInputLength = newInputLength;
+                
+                yield return null; // Wait for next frame
             }
-            
-            Display.HideCursor();
-            onLineRead(null);
         }
 
         private IEnumerator SplitMessage(string message)
@@ -486,7 +486,17 @@ private void Start()
             _cts = new CancellationTokenSource();
             //Application.logMessageReceived -= OnLogMessageReceived; // TODO: improve input handling and re-enable
             RenderIntro();
-            StartCoroutine(UpdateRunner());
+            CVarCoroutines.Run(UpdateRunner());
+        }
+        
+        private void OnDestroy()
+        {
+            _cts?.Cancel();
+        }
+
+        private void OnApplicationQuit()
+        {
+            _cts?.Cancel();
         }
     }
 }

Assets/Kekser/UnityCVarConsole/CVarCoroutines.cs

@@ -0,0 +1,36 @@
+using System.Collections;
+using UnityEngine;
+
+namespace Kekser.UnityCVarConsole
+{
+    public class CVarCoroutines : MonoBehaviour
+    {
+        private static bool _initialized;
+        private static CVarCoroutines _instance;
+        
+        private static void Initialize()
+        {
+            if (_initialized)
+                return;
+            
+            _instance = new GameObject("CVarCoroutines").AddComponent<CVarCoroutines>();
+            DontDestroyOnLoad(_instance.gameObject);
+            
+            _initialized = true;
+        }
+        
+        public static Coroutine Run(IEnumerator coroutine)
+        {
+            Initialize();
+            return _instance.StartCoroutine(coroutine);
+        }
+        
+        public static void Stop(Coroutine coroutine)
+        {
+            if (!_initialized)
+                return;
+            
+            _instance.StopCoroutine(coroutine);
+        }
+    }
+}

Assets/Kekser/UnityCVarConsole/CVarCoroutines.cs.meta

@@ -53,7 +53,12 @@ private void Awake()
         private void Start()
         {
             _cts = new CancellationTokenSource();
-            StartCoroutine(RefreshLoop());
+            CVarCoroutines.Run(RefreshLoop());
+        }
+
+        private void OnDestroy()
+        {
+            _cts?.Cancel();
         }
 
         private void OnApplicationQuit()
@@ -65,8 +70,6 @@ private IEnumerator RefreshLoop()
         {
             while (!_cts.IsCancellationRequested)
             {
-                yield return new WaitForSeconds(1f / _refreshRate);
-                
                 RecalculateSize();
                 if (_isDirty)
                     RenderText();
@@ -82,6 +85,8 @@ private IEnumerator RefreshLoop()
                     _fontRenderer.Render();
                 _lastCursorVisible = _cursorVisible;
                 _isDirty = false;
+                
+                yield return new WaitForSeconds(1f / _refreshRate);
             }
         }