Updates from analyzers and get ready for adding controls to hosts

k3ldar · Jan 10, 2024 · 690dd9c · 690dd9c
1 parent c83f118
commit 690dd9c
Show file tree

Hide file tree

Showing 25 changed files with 124 additions and 19 deletions.
diff --git a/src/GCAAnalyser/Analyzers/AnalyzeM600Pause.cs b/src/GCAAnalyser/Analyzers/AnalyzeM600Pause.cs
@@ -14,7 +14,7 @@ public void Analyze(string fileName, IGCodeAnalyses gCodeAnalyses)
             if (m600Commands.Count == 0)
                 return;
 
-            if (m600Commands.Count > 0 && gCodeAnalyses is GCodeAnalyses codeAnalyses)
+            if (gCodeAnalyses is GCodeAnalyses codeAnalyses)
             {
                 foreach (IGCodeCommand command in m600Commands)
                 {

diff --git a/src/GCAAnalyser/Analyzers/AnalyzeM601Timeout.cs b/src/GCAAnalyser/Analyzers/AnalyzeM601Timeout.cs
@@ -14,7 +14,7 @@ public void Analyze(string fileName, IGCodeAnalyses gCodeAnalyses)
             if (m601Commands.Count == 0)
                 return;
 
-            if (m601Commands.Count > 0 && gCodeAnalyses is GCodeAnalyses codeAnalyses)
+            if (gCodeAnalyses is GCodeAnalyses codeAnalyses)
             {
                 foreach (IGCodeCommand command in m601Commands)
                 {

diff --git a/src/GCAAnalyser/Analyzers/AnalyzeM605PlaySounds.cs b/src/GCAAnalyser/Analyzers/AnalyzeM605PlaySounds.cs
@@ -14,7 +14,7 @@ public void Analyze(string fileName, IGCodeAnalyses gCodeAnalyses)
             if (m605Commands.Count == 0)
                 return;
 
-            if (m605Commands.Count > 0 && gCodeAnalyses is GCodeAnalyses codeAnalyses)
+            if (gCodeAnalyses is GCodeAnalyses codeAnalyses)
             {
                 if (!gCodeAnalyses.AnalysesOptions.HasFlag(AnalysesOptions.PlaySound))
                     codeAnalyses.AddOptions(AnalysesOptions.PlaySound);

diff --git a/src/GCAAnalyser/Analyzers/AnalyzeM630RunProgram.cs b/src/GCAAnalyser/Analyzers/AnalyzeM630RunProgram.cs
@@ -14,7 +14,7 @@ public void Analyze(string fileName, IGCodeAnalyses gCodeAnalyses)
             if (m630Commands.Count == 0)
                 return;
 
-            if (m630Commands.Count > 0 && gCodeAnalyses is GCodeAnalyses codeAnalyses)
+            if (gCodeAnalyses is GCodeAnalyses codeAnalyses)
             {
                 if (!gCodeAnalyses.AnalysesOptions.HasFlag(AnalysesOptions.RunProgram))
                     codeAnalyses.AddOptions(AnalysesOptions.RunProgram);

diff --git a/src/GCAAnalyser/Analyzers/AnalyzeM630_1RunParameters.cs b/src/GCAAnalyser/Analyzers/AnalyzeM630_1RunParameters.cs
@@ -14,7 +14,7 @@ public void Analyze(string fileName, IGCodeAnalyses gCodeAnalyses)
             if (mCommands.Count == 0)
                 return;
 
-            if (mCommands.Count > 0 && gCodeAnalyses is GCodeAnalyses codeAnalyses)
+            if (gCodeAnalyses is GCodeAnalyses codeAnalyses)
             {
                 List<int> lineNumbers = [];
 

diff --git a/src/GCAAnalyser/Analyzers/AnalyzeM631_1RunParameters.cs b/src/GCAAnalyser/Analyzers/AnalyzeM631_1RunParameters.cs
@@ -14,7 +14,7 @@ public void Analyze(string fileName, IGCodeAnalyses gCodeAnalyses)
             if (mCommands.Count == 0)
                 return;
 
-            if (mCommands.Count > 0 && gCodeAnalyses is GCodeAnalyses codeAnalyses)
+            if (gCodeAnalyses is GCodeAnalyses codeAnalyses)
             {
                 List<int> lineNumbers = [];
 

diff --git a/src/GCAAnalyser/Analyzers/AnalyzeM631_2ReturnCode.cs b/src/GCAAnalyser/Analyzers/AnalyzeM631_2ReturnCode.cs
@@ -14,7 +14,7 @@ public void Analyze(string fileName, IGCodeAnalyses gCodeAnalyses)
             if (mCommands.Count == 0)
                 return;
 
-            if (mCommands.Count > 0 && gCodeAnalyses is GCodeAnalyses codeAnalyses)
+            if (gCodeAnalyses is GCodeAnalyses codeAnalyses)
             {
                 foreach (IGCodeCommand command in mCommands)
                 {

diff --git a/src/GCATests/Mocks/MockEditorPluginHost.cs b/src/GCATests/Mocks/MockEditorPluginHost.cs
@@ -32,6 +32,11 @@ public MockEditorPluginHost()
 
         public IGSendContext GSendContext => throw new NotImplementedException();
 
+        public void AddControl(IPluginControl pluginControl)
+        {
+            throw new NotImplementedException();
+        }
+
         public void AddMenu(IPluginMenu pluginMenu)
         {
             throw new NotImplementedException();

diff --git a/src/GCATests/Mocks/MockSenderPluginHost.cs b/src/GCATests/Mocks/MockSenderPluginHost.cs
@@ -84,6 +84,11 @@ public void SendMessage(string message)
             Messages.Add(message);
         }
 
+        public void AddControl(IPluginControl pluginControl)
+        {
+            throw new NotImplementedException();
+        }
+
         public IGSendContext GSendContext => throw new NotImplementedException();
     }
 }
diff --git a/src/GCSDesktop/FormMain.cs b/src/GCSDesktop/FormMain.cs
@@ -566,7 +566,7 @@ public void UpdateOnlineStatus(bool isOnline, string server)
                 toolStripStatusConnected.Text = statusText;
         }
 
-        #region ISenderPluginHost
+        #region IPluginHost
 
         public PluginHosts Host => PluginHosts.SenderHost;
 
@@ -608,11 +608,16 @@ public void AddToolbar(IPluginToolbarButton toolbarButton)
             _pluginHelper.AddToolbarButton(this, toolStripMain, toolbarButton);
         }
 
+        public void AddControl(IPluginControl pluginControl)
+        {
+            // nothing to do here yet!
+        }
+
         public void AddMessage(InformationType informationType, string message)
         {
             throw new InvalidOperationException();
         }
 
-        #endregion ISenderPluginHost
+        #endregion IPluginHost
     }
 }
diff --git a/src/GCSDesktop/Forms/FrmMachine.cs b/src/GCSDesktop/Forms/FrmMachine.cs
@@ -2654,7 +2654,7 @@ public List<IShortcut> GetShortcuts()
 
         #endregion Shortcuts
 
-        #region ISenderPluginHost
+        #region IPluginHost
 
         public PluginHosts Host => PluginHosts.Sender;
 
@@ -2714,6 +2714,11 @@ public void AddToolbar(IPluginToolbarButton toolbarButton)
                 _pluginsWithClientMessages.Add(toolbarButton);
         }
 
+        public void AddControl(IPluginControl pluginControl)
+        {
+            // nothing to do here yet!
+        }
+
         public void SendMessage(string message)
         {
             InternalSendMessage(message);
@@ -2735,6 +2740,6 @@ public void AddMessage(InformationType informationType, string message)
 
         public IMachine GetMachine() => _machine;
 
-        #endregion ISenderPluginHost
+        #endregion IPluginHost
     }
 }
diff --git a/src/GCSShared/Plugins/PluginEnums.cs b/src/GCSShared/Plugins/PluginEnums.cs
@@ -33,7 +33,9 @@ public enum PluginOptions
 
         HasToolbarButtons = 4,
 
-        MessageReceived = 8,
+        HasControls = 8,
+
+        MessageReceived = 8192,
     }
 
     /// <summary>
@@ -83,4 +85,11 @@ public enum ButtonType
 
         Button
     }
+
+    public enum ControlLocation
+    {
+        Primary,
+
+        Secondary,
+    }
 }
diff --git a/src/GSendControls/Abstractions/IGSendPluginModule.cs b/src/GSendControls/Abstractions/IGSendPluginModule.cs
@@ -38,8 +38,16 @@ public interface IGSendPluginModule
         /// </summary>
         IReadOnlyList<IPluginMenu> MenuItems { get; }
 
+        /// <summary>
+        /// Toolbar items to be displayed within the host
+        /// </summary>
         IReadOnlyList<IPluginToolbarButton> ToolbarItems { get; }
 
+        /// <summary>
+        /// Controls to be displayed within host
+        /// </summary>
+        IReadOnlyList<IPluginControl> ControlItems { get; }
+
         void ClientMessageReceived(IClientBaseMessage clientBaseMessage);
     }
 }
diff --git a/src/GSendControls/Abstractions/IPluginControl.cs b/src/GSendControls/Abstractions/IPluginControl.cs
@@ -0,0 +1,15 @@
+using GSendControls.Controls;
+
+using GSendShared.Plugins;
+
+namespace GSendControls.Abstractions
+{
+    public interface IPluginControl
+    {
+        string Name { get; }
+
+        PluginControl Control { get; }
+
+        ControlLocation Location { get; }
+    }
+}
diff --git a/src/GSendControls/Abstractions/IPluginHost.cs b/src/GSendControls/Abstractions/IPluginHost.cs
@@ -17,6 +17,8 @@ public interface IPluginHost
 
         void AddToolbar(IPluginToolbarButton toolbarButton);
 
+        void AddControl(IPluginControl pluginControl);
+
         void AddMessage(InformationType informationType, string message);
 
         void AddPlugin(IGSendPluginModule pluginModule);

diff --git a/src/GSendControls/Controls/PluginControl.cs b/src/GSendControls/Controls/PluginControl.cs
@@ -0,0 +1,13 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace GSendControls.Controls
+{
+    public class PluginControl : BaseControl
+    {
+
+    }
+}
diff --git a/src/GSendControls/GlobalSuppressions.cs b/src/GSendControls/GlobalSuppressions.cs
@@ -19,4 +19,7 @@
 [assembly: SuppressMessage("Major Code Smell", "S1168:Empty arrays and collections should be returned instead of null", Justification = "expects null", Scope = "member", Target = "~P:GSendControls.Plugins.InternalPlugins.ServerMenu.ServerMenuPlugin.ToolbarItems")]
 [assembly: SuppressMessage("Major Code Smell", "S1168:Empty arrays and collections should be returned instead of null", Justification = "expects null", Scope = "member", Target = "~P:GSendControls.Plugins.InternalPlugins.HelpMenu.HelpMenuPlugin.ToolbarItems")]
 [assembly: SuppressMessage("Major Bug", "S2259:Null pointers should not be dereferenced", Justification = "<Pending>", Scope = "member", Target = "~M:GSendControls.Plugins.PluginHelper.InitializeAllPlugins(GSendControls.Abstractions.IPluginHost)")]
-[assembly: SuppressMessage("Major Code Smell", "S1168:Empty arrays and collections should be returned instead of null", Justification = "Null is fine", Scope = "member", Target = "~P:GSendControls.Plugins.InternalPlugins.SearchMenu.SearchMenuPlugin.ToolbarItems")]
+[assembly: SuppressMessage("Major Code Smell", "S1168:Empty arrays and collections should be returned instead of null", Justification = "Null is fine and by design", Scope = "member", Target = "~P:GSendControls.Plugins.InternalPlugins.SearchMenu.SearchMenuPlugin.ToolbarItems")]
+[assembly: SuppressMessage("Major Code Smell", "S1168:Empty arrays and collections should be returned instead of null", Justification = "Null is fine and by design", Scope = "member", Target = "~P:GSendControls.Plugins.InternalPlugins.HelpMenu.HelpMenuPlugin.ControlItems")]
+[assembly: SuppressMessage("Major Code Smell", "S1168:Empty arrays and collections should be returned instead of null", Justification = "Null is fine and by design", Scope = "member", Target = "~P:GSendControls.Plugins.InternalPlugins.SearchMenu.SearchMenuPlugin.ControlItems")]
+[assembly: SuppressMessage("Major Code Smell", "S1168:Empty arrays and collections should be returned instead of null", Justification = "Null is fine and by design", Scope = "member", Target = "~P:GSendControls.Plugins.InternalPlugins.ServerMenu.ServerMenuPlugin.ControlItems")]
diff --git a/src/GSendControls/Plugins/InternalPlugins/HelpMenu/HelpMenuPlugin.cs b/src/GSendControls/Plugins/InternalPlugins/HelpMenu/HelpMenuPlugin.cs
@@ -44,6 +44,8 @@ public IReadOnlyList<IPluginMenu> MenuItems
 
         public IReadOnlyList<IPluginToolbarButton> ToolbarItems => null;
 
+        public IReadOnlyList<IPluginControl> ControlItems => null;
+
         public void ClientMessageReceived(IClientBaseMessage clientBaseMessage)
         {
             // from interface, not used in any context

diff --git a/src/GSendControls/Plugins/InternalPlugins/SearchMenu/SearchMenuPlugin.cs b/src/GSendControls/Plugins/InternalPlugins/SearchMenu/SearchMenuPlugin.cs
@@ -44,6 +44,8 @@ public IReadOnlyList<IPluginMenu> MenuItems
 
         public IReadOnlyList<IPluginToolbarButton> ToolbarItems => null;
 
+        public IReadOnlyList<IPluginControl> ControlItems => null;
+
         public void ClientMessageReceived(IClientBaseMessage clientBaseMessage)
         {
             // from interface, not used in this context

diff --git a/src/GSendControls/Plugins/InternalPlugins/ServerMenu/ServerMenuPlugin.cs b/src/GSendControls/Plugins/InternalPlugins/ServerMenu/ServerMenuPlugin.cs
@@ -76,6 +76,8 @@ public IReadOnlyList<IPluginMenu> MenuItems
 
         public IReadOnlyList<IPluginToolbarButton> ToolbarItems => null;
 
+        public IReadOnlyList<IPluginControl> ControlItems => null;
+
         public void ClientMessageReceived(IClientBaseMessage clientBaseMessage)
         {
             // from interface, not used in this context

diff --git a/src/GSendControls/Plugins/PluginHelper.cs b/src/GSendControls/Plugins/PluginHelper.cs
@@ -131,6 +131,20 @@ public void InitializeAllPlugins(IPluginHost pluginHost)
                         }
                     }
 
+                    if (plugin.Options.HasFlag(PluginOptions.HasControls))
+                    {
+                        if (plugin.ControlItems == null)
+                            throw new InvalidOperationException("Controls can not be null if HasControls option is used");
+
+                        foreach (IPluginControl pluginControl in plugin.ControlItems)
+                        {
+                            if (pluginControl == null)
+                                continue;
+
+                            pluginHost.AddControl(pluginControl);
+                        }
+                    }
+
                     pluginHost.AddPlugin(plugin);
                     _logger.AddToLog(PluginManager.LogLevel.PluginLoadSuccess, $"{plugin.Name} was loaded for host {pluginHost}");
                 }

diff --git a/src/GSendEditor/FrmMain.cs b/src/GSendEditor/FrmMain.cs
@@ -1189,7 +1189,7 @@ public List<IShortcut> GetShortcuts()
 
         #endregion Shortcuts
 
-        #region ISenderPluginHost
+        #region IPluginHost
 
         public PluginHosts Host => PluginHosts.Editor;
 
@@ -1235,12 +1235,17 @@ public void AddToolbar(IPluginToolbarButton toolbarButton)
             _pluginHelper.AddToolbarButton(this, toolbarMain, toolbarButton);
         }
 
+        public void AddControl(IPluginControl pluginControl)
+        {
+            // nothing to do here yet!
+        }
+
         public void AddMessage(InformationType informationType, string message)
         {
             throw new InvalidOperationException();
         }
 
-        #endregion ISenderPluginHost
+        #endregion IPluginHost
 
         #region IEditorPluginHost
 

diff --git a/src/Plugins/GrblTuning/GSendProTuningWizardPlugin.cs b/src/Plugins/GrblTuning/GSendProTuningWizardPlugin.cs
@@ -30,9 +30,10 @@ public IReadOnlyList<IPluginMenu> MenuItems
             }
         }
 
-        [System.Diagnostics.CodeAnalysis.SuppressMessage("Major Code Smell", "S1168:Empty arrays and collections should be returned instead of null", Justification = "Expecting null if non available")]
         public IReadOnlyList<IPluginToolbarButton> ToolbarItems => null;
 
+        public IReadOnlyList<IPluginControl> ControlItems => null;
+
         public void ClientMessageReceived(IClientBaseMessage clientBaseMessage)
         {
 

diff --git a/src/Plugins/GrblTuning/GlobalSuppressions.cs b/src/Plugins/GrblTuning/GlobalSuppressions.cs
@@ -0,0 +1,9 @@
+// This file is used by Code Analysis to maintain SuppressMessage
+// attributes that are applied to this project.
+// Project-level suppressions either have no target or are given
+// a specific target and scoped to a namespace, type, member, etc.
+
+using System.Diagnostics.CodeAnalysis;
+
+[assembly: SuppressMessage("Major Code Smell", "S1168:Empty arrays and collections should be returned instead of null", Justification = "Null is fine and by design", Scope = "member", Target = "~P:GrblTuningWizard.GSendProTuningWizardPlugin.ControlItems")]
+[assembly: SuppressMessage("Major Code Smell", "S1168:Empty arrays and collections should be returned instead of null", Justification = "Null is fine and by design", Scope = "member", Target = "~P:GrblTuningWizard.GSendProTuningWizardPlugin.ToolbarItems")]
diff --git a/wwwroot/Controllers/MCodesController.cs b/wwwroot/Controllers/MCodesController.cs
@@ -14,10 +14,10 @@ public class MCodesController : BaseController
     {
         public const string MCodes = "MCodes";
 
-        private static readonly string[] _validMCodes = {
+        private static readonly string[] _validMCodes = [
             "M600", "M601", "M602", "M605", "M620", "M621",
             "M622", "M623", "M630", "M630.1", "M631",
-            "M631.1", "M631.2" };
+            "M631.1", "M631.2" ];
 
         private static readonly Dictionary<string, decimal[]> _seeAlso = new()
         {
@@ -52,7 +52,7 @@ public IActionResult MCode(string mCode)
 
             bool seeAlsoExists = _seeAlso.TryGetValue(mCode, out _);
             MCodeModel mCodeModel = new(GetModelData(), mCode, menuData,
-                seeAlsoExists ? _seeAlso[mCode] : Array.Empty<decimal>());
+                seeAlsoExists ? _seeAlso[mCode] : []);
             mCodeModel.Breadcrumbs.Add(new BreadcrumbItem(GSend.Language.Resources.BreadcrumbMCodes, "/MCodes/Index", false));
             mCodeModel.Breadcrumbs.Add(new BreadcrumbItem(mCode, $"/MCodes/{mCode}/", false));