Add main menu bar generation from gui panel paths

Moneyl · Moneyl · commit 41be9e34835f · 2022-08-21T12:59:08.000-04:00
Bringing over all the gui code from the c++ version. Next up is documents &amp; change tracking &amp; save confirmation dialogs
diff --git a/src/Gui/Extensions.bf b/src/Gui/Extensions.bf
@@ -50,6 +50,18 @@ namespace ImGui
             return ImGui.TreeNodeEx(str.Ptr, flags);
         }
 
+        public static bool MenuItem(StringView label, char* shortcut, bool* p_selected, bool enabled = true)
+        {
+            String str = scope .(label)..Append('\0');
+            return ImGui.MenuItem(str.Ptr, shortcut, p_selected, enabled);
+        }
+
+        public static bool BeginMenu(StringView label, bool enabled = true)
+        {
+            String str = scope .(label)..Append('\0');
+            return ImGui.BeginMenu(str.Ptr, enabled);
+        }
+
         //Draw label and value next to each other with value using secondary color
         public static void LabelAndValue(StringView label, StringView value, Vec4<f32> color)
         {
diff --git a/src/Gui/Gui.bf b/src/Gui/Gui.bf
@@ -11,7 +11,7 @@ namespace Nanoforge.Gui
 	[System]
 	public class Gui : ISystem
 	{
-        public List<IGuiPanel> Panels = new .() ~DeleteContainerAndItems!(_);
+        public List<GuiPanelBase> Panels = new .() ~DeleteContainerAndItems!(_);
 
 		static void ISystem.Build(App app)
 		{
@@ -21,16 +21,37 @@ namespace Nanoforge.Gui
 		[SystemInit]
 		void Init(App app)
 		{
-            Panels.Add(new MainMenuBar());
-            Panels.Add(new DebugGui());
-            Panels.Add(new StateViewer());
+            AddPanel("", true, new MainMenuBar());
+            AddPanel("View/Debug", true, new DebugGui());
+            AddPanel("View/State viewer", true, new StateViewer());
 		}
 
 		[SystemStage(.Update)]
 		void Update(App app)
 		{
-			for (IGuiPanel panel in Panels)
-                panel.Update(app);
+			for (GuiPanelBase panel in Panels)
+                if (panel.Open)
+                    panel.Update(app, this);
 		}
+
+        ///Add gui panel and validate its path to make sure its not a duplicate. Takes ownership of panel.
+        void AddPanel(StringView menuPos, bool open, GuiPanelBase panel)
+        {
+            //Make sure there isn't already a panel with the same menuPos
+            for (GuiPanelBase existingPanel in Panels)
+            {
+                if (StringView.Equals(menuPos, existingPanel.MenuPos, true))
+                {
+                    //Just crash when a duplicate is found. These are set at compile time currently so it'll always happen if theres a duplicate
+                    Runtime.FatalError(scope $"Duplicate GuiPanel menu path. Fix this before release. Type = {panel.GetType().ToString(.. scope .())}. Path = '{menuPos}'");
+                    delete panel;
+                    return;
+                }
+            }
+
+            panel.MenuPos.Set(menuPos);
+            panel.Open = open;
+            Panels.Add(panel);
+        }
 	}
 }
diff --git a/src/Gui/IGuiPanel.bf b/src/Gui/IGuiPanel.bf
@@ -4,10 +4,23 @@ using System;
 
 namespace Nanoforge.Gui
 {
-	//A single UI window. Only one instance of each implementation should exist
+	///A single UI window. Only one instance of each implementation should exist
 	public interface IGuiPanel
 	{
 		//Per-frame update
-		public void Update(App app);
+		public void Update(App app, Gui gui);
 	}
+
+    ///Base class for all gui panels. Has fields and functions that all panels should have.
+	///Can't do this in IGuiPanel because Beef doesn't allow interfaces to have fields like we could get away with in C++.
+    public class GuiPanelBase : IGuiPanel
+    {
+        public bool Open = true;
+        public String MenuPos = new .() ~delete _;
+
+        public virtual void Update(App app, Gui gui)
+        {
+            return;
+        }
+    }
 }
diff --git a/src/Gui/Panels/DebugGui.bf b/src/Gui/Panels/DebugGui.bf
@@ -7,11 +7,11 @@ using ImGui;
 
 namespace Nanoforge.Gui.Panels
 {
-	public class DebugGui : IGuiPanel
+	public class DebugGui : GuiPanelBase
 	{
 		bool ShowImGuiDemo = true;
 
-		public void Update(App app)
+		public override void Update(App app, Gui gui)
 		{
 			if (ShowImGuiDemo)
 				ImGui.ShowDemoWindow(&ShowImGuiDemo);
@@ -21,7 +21,7 @@ namespace Nanoforge.Gui.Panels
 
 		private void DrawDebugWindow(App app)
 		{
-			if (!ImGui.Begin(scope String(Icons.ICON_FA_BUG)..Append(" Debug")))
+			if (!ImGui.Begin(scope String(Icons.ICON_FA_BUG)..Append(" Debug"), &Open))
 			{
 				ImGui.End();
 				return;
diff --git a/src/Gui/Panels/MainMenuBar.bf b/src/Gui/Panels/MainMenuBar.bf
@@ -2,15 +2,24 @@ using Nanoforge.App;
 using Nanoforge;
 using System;
 using ImGui;
+using System.Collections;
 
 namespace Nanoforge.Gui.Panels
 {
-	public class MainMenuBar : IGuiPanel
+	public class MainMenuBar : GuiPanelBase
 	{
 		private ImGui.DockNodeFlags dockspaceFlags = 0;
+        public List<MenuItem> MenuItems = new .() ~DeleteContainerAndItems!(_);
 
-		void IGuiPanel.Update(App app)
+		public override void Update(App app, Gui gui)
 		{
+            static bool firstDraw = true;
+            if (firstDraw)
+            {
+                GenerateMenus(gui);
+                firstDraw = false;
+            }
+
 			DrawMainMenuBar(app);
 			DrawDockspace(app);
 		}
@@ -32,6 +41,11 @@ namespace Nanoforge.Gui.Panels
 				{
 					ImGui.EndMenu();
 				}
+
+                //Draw menu item for each panel (e.g. file explorer, properties, log, etc) so user can toggle visibility
+                for (MenuItem item in MenuItems)
+                    item.Draw();
+
 				if(ImGui.BeginMenu("View"))
 				{
 					//Todo: Put toggles for other guis in this layer here
@@ -87,5 +101,95 @@ namespace Nanoforge.Gui.Panels
 
 			ImGui.End();
 		}
+
+        private MenuItem GetMenu(StringView text)
+        {
+            for (MenuItem item in MenuItems)
+                if (StringView.Equals(item.Text, text, true))
+                    return item;
+
+            return null;
+        }
+
+        private void GenerateMenus(Gui gui)
+        {
+            for (GuiPanelBase panel in gui.Panels)
+            {
+                //No menu entry if it's left blank. The main menu itself also doesn't have an entry
+                if (panel.MenuPos == "" || panel == this)
+                {
+                    panel.Open = true;
+                    continue;
+                }
+
+                //Split menu path into components
+                StringView[] pathSplit = panel.MenuPos.Split!('/');
+                StringView menuName = pathSplit[0];
+
+                //Get or create menu
+                MenuItem curMenuItem = GetMenu(menuName);
+                if (curMenuItem == null)
+                {
+                    curMenuItem = new MenuItem(menuName);
+                    MenuItems.Add(curMenuItem);
+                }
+
+                //Iterate through path segmeents to create menu tree
+                for (int i = 1; i < pathSplit.Count; i++)
+                {
+                    StringView nextPart = pathSplit[i];
+                    MenuItem nextItem = curMenuItem.GetChild(nextPart);
+                    if (nextItem == null)
+                    {
+                        nextItem = new MenuItem(nextPart);
+                        curMenuItem.Items.Add(nextItem);
+                    }
+
+                    curMenuItem = nextItem;
+                }
+
+                curMenuItem.Panel = panel;
+            }
+        }
 	}
+
+    //Entry in the main menu bar
+    public class MenuItem
+    {
+        public String Text = new .() ~delete _;
+        public List<MenuItem> Items = new .() ~DeleteContainerAndItems!(_);
+        public GuiPanelBase Panel = null;
+
+        public this(StringView text)
+        {
+            Text.Set(text);
+        }
+
+        public void Draw()
+        {
+            if (Panel != null)
+            {
+                ImGui.MenuItem(Text, "", &Panel.Open);
+                return;
+            }
+
+            if (ImGui.BeginMenu(Text))
+            {
+                for (MenuItem item in Items)
+                {
+                    item.Draw();
+                }
+                ImGui.EndMenu();
+            }
+        }
+
+        public MenuItem GetChild(StringView text)
+        {
+            for (MenuItem item in Items)
+                if (StringView.Equals(item.Text, text, true))
+                    return item;
+
+            return null;
+        }
+    }
 }
diff --git a/src/Gui/Panels/StateViewer.bf b/src/Gui/Panels/StateViewer.bf
@@ -7,11 +7,11 @@ using ImGui;
 namespace Nanoforge.Gui.Panels
 {
     //Has a bunch of info about the apps state, system functions, and stages
-    public class StateViewer : IGuiPanel
+    public class StateViewer : GuiPanelBase
     {
-        void IGuiPanel.Update(App app)
+        public override void Update(App app, Gui gui)
         {
-            if (!ImGui.Begin(scope String(Icons.ICON_FA_CODE_BRANCH)..Append(" App state")))
+            if (!ImGui.Begin(scope String(Icons.ICON_FA_CODE_BRANCH)..Append(" App state"), &Open))
             {
                 ImGui.End();
                 return;
diff --git a/src/Misc/Extensions.bf b/src/Misc/Extensions.bf
@@ -37,6 +37,14 @@ namespace System
             return str;
         }
 	}
+
+    extension StringView
+    {
+        public static bool Equals(StringView a, StringView b, bool ignoreCase = false)
+        {
+            return StringView.Compare(a, b, ignoreCase) == 0;
+        }
+    }
 }
 
 static

Original file line number	Diff line number	Diff line change
`@@ -7,11 +7,11 @@ using ImGui;`
`7`	`7`
`8`	`8`	`namespace Nanoforge.Gui.Panels`
`9`	`9`	`{`
`10`		`- public class DebugGui : IGuiPanel`
	`10`	`+ public class DebugGui : GuiPanelBase`
`11`	`11`	`{`
`12`	`12`	`bool ShowImGuiDemo = true;`
`13`	`13`
`14`		`- public void Update(App app)`
	`14`	`+ public override void Update(App app, Gui gui)`
`15`	`15`	`{`
`16`	`16`	`if (ShowImGuiDemo)`
`17`	`17`	`ImGui.ShowDemoWindow(&ShowImGuiDemo);`
`@@ -21,7 +21,7 @@ namespace Nanoforge.Gui.Panels`
`21`	`21`
`22`	`22`	`private void DrawDebugWindow(App app)`
`23`	`23`	`{`
`24`		`- if (!ImGui.Begin(scope String(Icons.ICON_FA_BUG)..Append(" Debug")))`
	`24`	`+ if (!ImGui.Begin(scope String(Icons.ICON_FA_BUG)..Append(" Debug"), &Open))`
`25`	`25`	`{`
`26`	`26`	`ImGui.End();`
`27`	`27`	`return;`
Original file line number	Diff line number	Diff line change
`@@ -7,11 +7,11 @@ using ImGui;`
`7`	`7`	`namespace Nanoforge.Gui.Panels`
`8`	`8`	`{`
`9`	`9`	`//Has a bunch of info about the apps state, system functions, and stages`
`10`		`- public class StateViewer : IGuiPanel`
	`10`	`+ public class StateViewer : GuiPanelBase`
`11`	`11`	`{`
`12`		`- void IGuiPanel.Update(App app)`
	`12`	`+ public override void Update(App app, Gui gui)`
`13`	`13`	`{`
`14`		`- if (!ImGui.Begin(scope String(Icons.ICON_FA_CODE_BRANCH)..Append(" App state")))`
	`14`	`+ if (!ImGui.Begin(scope String(Icons.ICON_FA_CODE_BRANCH)..Append(" App state"), &Open))`
`15`	`15`	`{`
`16`	`16`	`ImGui.End();`
`17`	`17`	`return;`
Original file line number	Diff line number	Diff line change
`@@ -37,6 +37,14 @@ namespace System`
`37`	`37`	`return str;`
`38`	`38`	`}`
`39`	`39`	`}`
	`40`	`+`
	`41`	`+ extension StringView`
	`42`	`+ {`
	`43`	`+ public static bool Equals(StringView a, StringView b, bool ignoreCase = false)`
	`44`	`+ {`
	`45`	`+ return StringView.Compare(a, b, ignoreCase) == 0;`
	`46`	`+ }`
	`47`	`+ }`
`40`	`48`	`}`
`41`	`49`
`42`	`50`	`static`