Merge pull request #86 from arimger/develop

Develop - 0.12.5

Author: arimger

Assets/Editor Toolbox/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 0.12.5 [11.09.2023]
+
+### Changed:
+- Make ToolboxEditorHandler public
+
+### Added:
+- Add public OnCacheRefreshed event to the SceneSerializationUtility
+
 ## 0.12.4 [31.07.2023]
 
 ### Changed:

Assets/Editor Toolbox/Editor/Drawers/Helpers/DrawerDataStorageBase.cs

@@ -6,7 +6,7 @@ public abstract class DrawerDataStorageBase
     {
         static DrawerDataStorageBase()
         {
-            InspectorUtility.OnEditorReload += () =>
+            ToolboxEditorHandler.OnEditorReload += () =>
             {
                 for (var i = 0; i < storages.Count; i++)
                 {

Assets/Editor Toolbox/Editor/Drawers/Toolbox/Decorator/DynamicHelpAttributeDrawer.cs

@@ -8,7 +8,7 @@ public class DynamicHelpAttributeDrawer : ToolboxDecoratorDrawer<DynamicHelpAttr
         protected override void OnGuiBeginSafe(DynamicHelpAttribute attribute)
         {
             var sourceHandle = attribute.SourceHandle;
-            var targetObjects = InspectorUtility.CurrentTargetObjects;
+            var targetObjects = ToolboxEditorHandler.CurrentTargetObjects;
             if (ValueExtractionHelper.TryGetValue(sourceHandle, targetObjects, out var value, out var hasMixedValues))
             {
                 var messageText = hasMixedValues ? "-" : value?.ToString();

Assets/Editor Toolbox/Editor/Drawers/Toolbox/Decorator/EditorButtonAttributeDrawer.cs

@@ -123,7 +123,7 @@ private void CallMethods(EditorButtonAttribute attribute, Object[] targetObjects
 
         protected override void OnGuiCloseSafe(EditorButtonAttribute attribute)
         {
-            var targetObjects = InspectorUtility.CurrentTargetObjects;
+            var targetObjects = ToolboxEditorHandler.CurrentTargetObjects;
             if (targetObjects == null || targetObjects.Length == 0)
             {
                 //NOTE: something went really wrong, internal bug or OnGuiBeginSafe was called out of the Toolbox scope

Assets/Editor Toolbox/Editor/Editors/ToolboxScriptedImporterEditor.cs

@@ -38,7 +38,6 @@ public void IgnoreProperty(string propertyPath)
             Drawer.IgnoreProperty(propertyPath);
         }
 
-
         Editor IToolboxEditor.ContextEditor => this;
         public IToolboxEditorDrawer Drawer { get; } = new ToolboxEditorDrawer();
     }

Assets/Editor Toolbox/Editor/ToolboxDrawerModule.cs

@@ -20,7 +20,7 @@ internal static class ToolboxDrawerModule
         [InitializeOnLoadMethod]
         internal static void InitializeModule()
         {
-            InspectorUtility.OnEditorReload += ReloadDrawers;
+            ToolboxEditorHandler.OnEditorReload += ReloadDrawers;
         }
 
 
@@ -405,7 +405,7 @@ internal static List<Type> GetAllPossibleTargetTypeDrawers()
         /// </summary>
         internal static ToolboxPropertyHandler GetPropertyHandler(SerializedProperty property)
         {
-            if (InspectorUtility.InToolboxEditor)
+            if (ToolboxEditorHandler.InToolboxEditor)
             {
                 //NOTE: maybe type-based key?
                 var propertyKey = property.GetPropertyHashKey();

Assets/Editor Toolbox/Editor/ToolboxEditor.cs

@@ -1,5 +1,4 @@
 using System;
-
 using UnityEditor;
 
 namespace Toolbox.Editor
@@ -45,7 +44,6 @@ public void IgnoreProperty(string propertyPath)
             Drawer.IgnoreProperty(propertyPath);
         }
 
-
         Editor IToolboxEditor.ContextEditor => this;
         /// <inheritdoc />
         public virtual IToolboxEditorDrawer Drawer { get; } = new ToolboxEditorDrawer();

Assets/Editor Toolbox/Editor/ToolboxEditorDrawer.cs

@@ -1,6 +1,5 @@
 using System;
 using System.Collections.Generic;
-
 using UnityEditor;
 
 namespace Toolbox.Editor

Assets/Editor Toolbox/Editor/ToolboxEditorHandler.cs

@@ -1,41 +1,94 @@
 using System;
+using System.Collections.Generic;
 
 namespace Toolbox.Editor
 {
     using Editor = UnityEditor.Editor;
+    using Object = UnityEngine.Object;
 
-    internal static class ToolboxEditorHandler
+    public static class ToolboxEditorHandler
     {
+        private static int lastCachedEditorId;
+        private static Editor lastCachedEditor;
+        private static readonly Stack<Editor> cachedEditors = new Stack<Editor>();
+
+        private static void OnBeginEditor(Editor editor)
+        {
+            //NOTE: it means that last Editor was null or disposed, anyway we probably want to reload drawers-related cache
+            if (lastCachedEditor == null || lastCachedEditorId != lastCachedEditor.GetInstanceID())
+            {
+                lastCachedEditor = editor;
+                lastCachedEditorId = editor.GetInstanceID();
+                OnEditorReload?.Invoke();
+            }
+
+            cachedEditors.Push(editor);
+            OnBeginToolboxEditor?.Invoke(editor);
+        }
+
+        private static void OnBreakEditor(Editor editor)
+        {
+            cachedEditors.Clear();
+            OnBreakToolboxEditor?.Invoke(editor);
+        }
+
+        private static void OnCloseEditor(Editor editor)
+        {
+            if (InToolboxEditor)
+            {
+                cachedEditors.Pop();
+            }
+
+            OnCloseToolboxEditor?.Invoke(editor);
+            ContextEditor = null;
+        }
+
         public static void HandleToolboxEditor(IToolboxEditor editor)
         {
             try
             {
                 ContextEditor = editor.ContextEditor;
-                OnBeginToolboxEditor?.Invoke(ContextEditor);
+                OnBeginEditor(ContextEditor);
                 editor.DrawCustomInspector();
             }
             catch (Exception)
             {
                 //make sure to catch all Exceptions (especially ExitGUIException),
                 //it will allow us to safely dispose all layout-based controls, etc.
-                OnBreakToolboxEditor?.Invoke(ContextEditor);
+                OnBreakEditor(ContextEditor);
                 throw;
             }
             finally
             {
-                OnCloseToolboxEditor?.Invoke(ContextEditor);
-                ContextEditor = null;
+                OnCloseEditor(ContextEditor);
             }
         }
 
+        /// <summary>
+        /// Event fired every time when <see cref="ToolboxEditor"/>s were re-created.
+        /// </summary>
+        internal static event Action OnEditorReload;
+
+        internal static event Action<Editor> OnBeginToolboxEditor;
+        internal static event Action<Editor> OnBreakToolboxEditor;
+        internal static event Action<Editor> OnCloseToolboxEditor;
 
-        public static event Action<Editor> OnBeginToolboxEditor;
-        public static event Action<Editor> OnBreakToolboxEditor;
-        public static event Action<Editor> OnCloseToolboxEditor;
+        internal static bool InToolboxEditor
+        {
+            get => cachedEditors.Count > 0;
+        }
+
+        /// <summary>
+        /// Last cached targetObjects from the currently processed <see cref="ToolboxEditor"/>.
+        /// </summary>
+        internal static Object[] CurrentTargetObjects
+        {
+            get => cachedEditors.Count > 0 ? cachedEditors.Peek().targets : new Object[0];
+        }
 
         /// <summary>
         /// Currently maintained <see cref="Editor"/>.
         /// </summary>
-        public static Editor ContextEditor { get; private set; }
+        internal static Editor ContextEditor { get; private set; }
     }
 }

Assets/Editor Toolbox/Editor/ToolboxLayoutHandler.cs

@@ -23,7 +23,7 @@ static ToolboxLayoutHandler()
             ToolboxEditorHandler.OnCloseToolboxEditor += OnCloseEditor;
 
             //we have to reset the current state between Editors to keep values independent
-            InspectorUtility.OnEditorReload += ResetCache;
+            ToolboxEditorHandler.OnEditorReload += ResetCache;
         }