Move layout files to workflow settings folder

bonsai-rx · Aug 6, 2024 · b155301 · b155301
1 parent 3d278ac
commit b155301
Show file tree

Hide file tree

Showing 4 changed files with 37 additions and 4 deletions.
diff --git a/Bonsai.Editor/EditorForm.cs b/Bonsai.Editor/EditorForm.cs
@@ -841,6 +841,7 @@ bool OpenWorkflow(string fileName, bool setWorkingDirectory)
             editorControl.Workflow = workflowBuilder.Workflow;
             editorSite.ValidateWorkflow();
 
+#pragma warning disable CS0612 // Support for deprecated layout config files
             var layoutPath = LayoutHelper.GetLayoutPath(fileName);
             if (File.Exists(layoutPath))
             {
@@ -850,6 +851,7 @@ bool OpenWorkflow(string fileName, bool setWorkingDirectory)
                     catch (InvalidOperationException) { }
                 }
             }
+#pragma warning restore CS0612 // Support for deprecated layout config files
 
             saveWorkflowDialog.FileName = fileName;
             ResetProjectStatus();
@@ -903,8 +905,17 @@ bool SaveWorkflow(string fileName)
             editorControl.UpdateVisualizerLayout();
             if (editorControl.VisualizerLayout != null)
             {
-                var layoutPath = LayoutHelper.GetLayoutPath(fileName);
-                SaveVisualizerLayout(layoutPath, editorControl.VisualizerLayout);
+                var layoutPath = new FileInfo(PathHelper.GetLayoutConfigPath(fileName));
+                layoutPath.Directory?.Create();
+
+                SaveVisualizerLayout(layoutPath.FullName, editorControl.VisualizerLayout);
+#pragma warning disable CS0612 // Support for deprecated layout config files
+                var legacyLayoutPath = new FileInfo(PathHelper.GetLegacyLayoutConfigPath(fileName));
+                if (legacyLayoutPath.Exists)
+                {
+                    legacyLayoutPath.Delete();
+                }
+#pragma warning restore CS0612 // Support for deprecated layout config files
             }
 
             UpdateWorkflowDirectory(fileName);

diff --git a/Bonsai.Editor/Layout/LayoutHelper.cs b/Bonsai.Editor/Layout/LayoutHelper.cs
@@ -12,7 +12,6 @@ namespace Bonsai.Design
 {
     static class LayoutHelper
     {
-        const string LayoutExtension = ".layout";
         static readonly XName XsdAttributeName = ((XNamespace)"http://www.w3.org/2000/xmlns/") + "xsd";
         static readonly XName XsiAttributeName = ((XNamespace)"http://www.w3.org/2000/xmlns/") + "xsi";
         const string XsdAttributeValue = "http://www.w3.org/2001/XMLSchema";
@@ -25,9 +24,13 @@ public static VisualizerDialogSettings GetLayoutSettings(this VisualizerLayout v
             return visualizerLayout?.DialogSettings.FirstOrDefault(xs => xs.Tag == key || xs.Tag == null);
         }
 
+        [Obsolete]
         public static string GetLayoutPath(string fileName)
         {
-            return Path.ChangeExtension(fileName, Path.GetExtension(fileName) + LayoutExtension);
+            var newLayoutPath = Editor.PathHelper.GetLayoutConfigPath(fileName);
+            return File.Exists(newLayoutPath)
+                ? newLayoutPath
+                : Editor.PathHelper.GetLegacyLayoutConfigPath(fileName);
         }
 
         public static void SetLayoutTags(ExpressionBuilderGraph source, VisualizerLayout layout)

diff --git a/Bonsai.Editor/PathHelper.cs b/Bonsai.Editor/PathHelper.cs
@@ -6,6 +6,7 @@ namespace Bonsai.Editor
     static class PathHelper
     {
         internal const string BonsaiExtension = ".bonsai";
+        internal const string LayoutExtension = ".layout";
 
         public static string GetCurrentBaseDirectory()
         {
@@ -33,5 +34,21 @@ public static string GetWorkflowBaseDirectory(string fileName)
         {
             return Path.GetDirectoryName(fileName);
         }
+
+        public static string GetWorkflowSettingsDirectory(string fileName)
+        {
+            return Path.Combine(BonsaiExtension, Path.GetFileNameWithoutExtension(fileName));
+        }
+
+        public static string GetLayoutConfigPath(string fileName)
+        {
+            return Path.Combine(GetWorkflowSettingsDirectory(fileName), LayoutExtension);
+        }
+
+        [Obsolete]
+        internal static string GetLegacyLayoutConfigPath(string fileName)
+        {
+            return Path.ChangeExtension(fileName, Path.GetExtension(fileName) + LayoutExtension);
+        }
     }
 }
diff --git a/Bonsai.Editor/WorkflowRunner.cs b/Bonsai.Editor/WorkflowRunner.cs
@@ -137,7 +137,9 @@ public static void Run(
             }
 
             var workflowBuilder = ElementStore.LoadWorkflow(fileName);
+#pragma warning disable CS0612 // Support for deprecated layout config files
             layoutPath ??= LayoutHelper.GetLayoutPath(fileName);
+#pragma warning restore CS0612 // Support for deprecated layout config files
             if (visualizerProvider != null && File.Exists(layoutPath))
             {
                 VisualizerLayout layout = null;