Added some statistics to coroutines

It took me half a year, but closes #4

Coroutine/ActiveCoroutine.cs

@@ -1,14 +1,16 @@
 using System;
 using System.Collections.Generic;
+using System.Diagnostics;
 
 namespace Coroutine {
     /// <summary>
     /// A reference to a currently running coroutine.
-    /// This is returned by <see cref="CoroutineHandler.Start(IEnumerator{Wait})"/>.
+    /// This is returned by <see cref="CoroutineHandler.Start(IEnumerator{Wait},string)"/>.
     /// </summary>
     public class ActiveCoroutine {
 
         private readonly IEnumerator<Wait> enumerator;
+        private readonly Stopwatch stopwatch;
         private Wait current;
 
         /// <summary>
@@ -21,13 +23,35 @@ namespace Coroutine {
         /// </summary>
         public bool WasCanceled { get; private set; }
         /// <summary>
+        /// The total amount of time that <see cref="MoveNext"/> took.
+        /// This is the amount of time that this active coroutine took for the entirety of its "steps", or yield statements.
+        /// </summary>
+        public TimeSpan TotalMoveNextTime { get; private set; }
+        /// <summary>
+        /// The total amount of times that <see cref="MoveNext"/> was invoked.
+        /// This is the amount of "steps" in your coroutine, or the amount of yield statements.
+        /// </summary>
+        public int MoveNextCount { get; private set; }
+        /// <summary>
+        /// The average amount of time that <see cref="MoveNext"/> took.
+        /// This is the average amount of time that each "step", or each yield statement, of this coroutine took to execute.
+        /// </summary>
+        public TimeSpan AverageMoveNextTime => new TimeSpan(this.TotalMoveNextTime.Ticks / this.MoveNextCount);
+        /// <summary>
         /// An event that gets fired when this active coroutine finishes or gets cancelled.
         /// When this event is called, <see cref="IsFinished"/> is always true.
         /// </summary>
         public event FinishCallback OnFinished;
+        /// <summary>
+        /// The name of this coroutine.
+        /// When not specified on startup of this coroutine, the name defaults to an empty string.
+        /// </summary>
+        public readonly string Name;
 
-        internal ActiveCoroutine(IEnumerator<Wait> enumerator) {
+        internal ActiveCoroutine(IEnumerator<Wait> enumerator, string name, Stopwatch stopwatch) {
             this.enumerator = enumerator;
+            this.stopwatch = stopwatch;
+            this.Name = name;
         }
 
         /// <summary>
@@ -60,7 +84,13 @@ namespace Coroutine {
         }
 
         internal bool MoveNext() {
-            if (!this.enumerator.MoveNext()) {
+            this.stopwatch.Restart();
+            var result = this.enumerator.MoveNext();
+            this.stopwatch.Stop();
+            this.TotalMoveNextTime += this.stopwatch.Elapsed;
+            this.MoveNextCount++;
+
+            if (!result) {
                 this.IsFinished = true;
                 this.OnFinished?.Invoke(this);
                 return false;

Coroutine/CoroutineHandler.cs

@@ -1,6 +1,5 @@
 using System;
 using System.Collections.Generic;
-using System.Linq;
 
 namespace Coroutine {
     /// <summary>
@@ -11,19 +10,24 @@ namespace Coroutine {
 
         private static readonly CoroutineHandlerInstance Instance = new CoroutineHandlerInstance();
 
-        /// <inheritdoc cref="CoroutineHandlerInstance.Start(IEnumerable{Wait})"/>
-        public static ActiveCoroutine Start(IEnumerable<Wait> coroutine) {
-            return Instance.Start(coroutine);
+        /// <inheritdoc cref="CoroutineHandlerInstance.TickingCount"/>
+        public static int TickingCount => Instance.TickingCount;
+        /// <inheritdoc cref="CoroutineHandlerInstance.EventCount"/>
+        public static int EventCount => Instance.EventCount;
+
+        /// <inheritdoc cref="CoroutineHandlerInstance.Start(IEnumerable{Wait},string)"/>
+        public static ActiveCoroutine Start(IEnumerable<Wait> coroutine, string name = "") {
+            return Instance.Start(coroutine, name);
         }
 
-        /// <inheritdoc cref="CoroutineHandlerInstance.Start(IEnumerator{Wait})"/>
-        public static ActiveCoroutine Start(IEnumerator<Wait> coroutine) {
-            return Instance.Start(coroutine);
+        /// <inheritdoc cref="CoroutineHandlerInstance.Start(IEnumerator{Wait},string)"/>
+        public static ActiveCoroutine Start(IEnumerator<Wait> coroutine, string name = "") {
+            return Instance.Start(coroutine, name);
         }
 
         /// <inheritdoc cref="CoroutineHandlerInstance.InvokeLater"/>
-        public static void InvokeLater(Wait wait, Action action) {
-            Instance.InvokeLater(wait, action);
+        public static ActiveCoroutine InvokeLater(Wait wait, Action action) {
+            return Instance.InvokeLater(wait, action);
         }
 
         /// <inheritdoc cref="CoroutineHandlerInstance.Tick"/>

Coroutine/CoroutineHandlerInstance.cs

@@ -1,5 +1,6 @@
 using System;
 using System.Collections.Generic;
+using System.Diagnostics;
 using System.Linq;
 
 namespace Coroutine {
@@ -11,24 +12,36 @@ namespace Coroutine {
 
         private readonly List<ActiveCoroutine> tickingCoroutines = new List<ActiveCoroutine>();
         private readonly List<ActiveCoroutine> eventCoroutines = new List<ActiveCoroutine>();
+        private readonly Stopwatch stopwatch = new Stopwatch();
+
+        /// <summary>
+        /// The amount of <see cref="ActiveCoroutine"/> instances that are currently waiting for a tick (waiting for time to pass)
+        /// </summary>
+        public int TickingCount => this.tickingCoroutines.Count;
+        /// <summary>
+        /// The amount of <see cref="ActiveCoroutine"/> instances that are currently waiting for an <see cref="Event"/>
+        /// </summary>
+        public int EventCount => this.eventCoroutines.Count;
 
         /// <summary>
         /// Starts the given coroutine, returning a <see cref="ActiveCoroutine"/> object for management.
         /// Note that this calls <see cref="IEnumerable{T}.GetEnumerator"/> to get the enumerator.
         /// </summary>
         /// <param name="coroutine">The coroutine to start</param>
+        /// <param name="name">The name that this coroutine should have. Defaults to an empty string.</param>
         /// <returns>An active coroutine object representing this coroutine</returns>
-        public ActiveCoroutine Start(IEnumerable<Wait> coroutine) {
-            return this.Start(coroutine.GetEnumerator());
+        public ActiveCoroutine Start(IEnumerable<Wait> coroutine, string name = "") {
+            return this.Start(coroutine.GetEnumerator(), name);
         }
 
         /// <summary>
         /// Starts the given coroutine, returning a <see cref="ActiveCoroutine"/> object for management.
         /// </summary>
         /// <param name="coroutine">The coroutine to start</param>
+        /// <param name="name">The name that this coroutine should have. Defaults to an empty string.</param>
         /// <returns>An active coroutine object representing this coroutine</returns>
-        public ActiveCoroutine Start(IEnumerator<Wait> coroutine) {
-            var inst = new ActiveCoroutine(coroutine);
+        public ActiveCoroutine Start(IEnumerator<Wait> coroutine, string name = "") {
+            var inst = new ActiveCoroutine(coroutine, name, this.stopwatch);
             if (inst.MoveNext()) {
                 if (inst.IsWaitingForEvent()) {
                     this.eventCoroutines.Add(inst);
@@ -45,8 +58,9 @@ namespace Coroutine {
         /// </summary>
         /// <param name="wait">The wait to wait for</param>
         /// <param name="action">The action to execute after waiting</param>
-        public void InvokeLater(Wait wait, Action action) {
-            this.Start(InvokeLaterImpl(wait, action));
+        /// <returns>An active coroutine object representing this coroutine</returns>
+        public ActiveCoroutine InvokeLater(Wait wait, Action action) {
+            return this.Start(InvokeLaterImpl(wait, action));
         }
 
         /// <summary>

Test/Example.cs

@@ -9,7 +9,7 @@ namespace Test {
         private static readonly Event TestEvent = new Event();
 
         public static void Main() {
-            var seconds = CoroutineHandler.Start(WaitSeconds());
+            var seconds = CoroutineHandler.Start(WaitSeconds(), "Awesome Waiting Coroutine");
             CoroutineHandler.Start(PrintEvery10Seconds(seconds));
 
             CoroutineHandler.Start(EmptyCoroutine());
@@ -50,6 +50,7 @@ namespace Test {
                 Console.WriteLine("The time is " + DateTime.Now);
                 if (first.IsFinished) {
                     Console.WriteLine("By the way, the first coroutine has finished!");
+                    Console.WriteLine($"{first.Name} data: {first.MoveNextCount} moves, {first.TotalMoveNextTime} total time, {first.AverageMoveNextTime} average");
                     Environment.Exit(0);
                 }
             }

Test/Test.csproj

@@ -9,7 +9,7 @@
         <AppDesignerFolder>Properties</AppDesignerFolder>
         <RootNamespace>Test</RootNamespace>
         <AssemblyName>Test</AssemblyName>
-        <TargetFrameworkVersion>v4.7.2</TargetFrameworkVersion>
+        <TargetFrameworkVersion>v4.6.2</TargetFrameworkVersion>
         <FileAlignment>512</FileAlignment>
     </PropertyGroup>
     <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|AnyCPU' ">