feat: add on-exception callback

bdunderscore · Sep 20, 2023 · 77a6fe8 · 77a6fe8
1 parent 339b355
commit 77a6fe8
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 0 deletions.
diff --git a/Editor/API/BuildContext.cs b/Editor/API/BuildContext.cs
@@ -237,6 +237,10 @@ internal void RunPass(ConcretePass pass)
             {
                 pass.Execute(this);
             }
+            catch (Exception e)
+            {
+                pass.Plugin.OnUnhandledException(e);
+            }
             finally
             {
                 Profiler.EndSample();

diff --git a/Editor/API/Fluent/Plugin.cs b/Editor/API/Fluent/Plugin.cs
@@ -3,6 +3,7 @@
 using System;
 using System.Threading;
 using nadena.dev.ndmf.fluent;
+using UnityEngine;
 
 #endregion
 
@@ -14,6 +15,8 @@ internal interface IPlugin
         string DisplayName { get; }
 
         void Configure(PluginInfo info);
+
+        void OnUnhandledException(Exception e);
     }
 
     public abstract class Plugin<T> : IPlugin where T : Plugin<T>, new()
@@ -54,5 +57,22 @@ protected Sequence InPhase(BuildPhase phase)
 
             return _info.NewSequence(phase);
         }
+
+        /// <summary>
+        /// Invoked when a pass in this plugin throws an exception. This exception can be passed to a plugin's own error
+        /// handling UI.
+        ///
+        /// This API will likely be deprecated once a native error-reporting system is available.
+        /// </summary>
+        /// <param name="e"></param>
+        protected virtual void OnUnhandledException(Exception e)
+        {
+            Debug.LogException(e);
+        }
+
+        void IPlugin.OnUnhandledException(Exception e)
+        {
+            OnUnhandledException(e);
+        }
     }
 }