Start to move 'onNameQuery' into a mixin. This unifies a bunch of logic,

saves stored bytes, and will form the basis for moving other duplicated code into a couple of mixins
keyboardio · Mar 6, 2024 · 5c73ff0 · 5c73ff0
1 parent d2a79b0
commit 5c73ff0
Show file tree

Hide file tree

Showing 35 changed files with 121 additions and 105 deletions.
diff --git a/plugins/Kaleidoscope-Colormap/src/kaleidoscope/plugin/Colormap.cpp b/plugins/Kaleidoscope-Colormap/src/kaleidoscope/plugin/Colormap.cpp
@@ -43,9 +43,6 @@ void ColormapEffect::max_layers(uint8_t max_) {
   map_base_   = ::LEDPaletteTheme.reserveThemes(max_layers_);
 }
 
-EventHandlerResult ColormapEffect::onNameQuery() {
-  return ::Focus.sendName(F("ColormapEffect"));
-}
 
 bool ColormapEffect::isUninitialized() {
   return ::LEDPaletteTheme.isThemeUninitialized(map_base_, max_layers_);

diff --git a/plugins/Kaleidoscope-Colormap/src/kaleidoscope/plugin/Colormap.h b/plugins/Kaleidoscope-Colormap/src/kaleidoscope/plugin/Colormap.h
@@ -25,22 +25,24 @@
 #include "kaleidoscope/plugin/AccessTransientLEDMode.h"  // for AccessTransientLEDMode
 #include "kaleidoscope/plugin/LEDMode.h"                 // for LEDMode
 #include "kaleidoscope/plugin/LEDModeInterface.h"        // for LEDModeInterface
+#include "kaleidoscope/plugin/FocusPlugin.h"             // for FocusPlugin
 
 namespace kaleidoscope {
 namespace plugin {
 class ColormapEffect : public Plugin,
+                       public FocusPlugin,
                        public LEDModeInterface,
                        public AccessTransientLEDMode {
  public:
   void max_layers(uint8_t max_);
 
   EventHandlerResult onLayerChange();
-  EventHandlerResult onNameQuery();
   EventHandlerResult onFocusEvent(const char *input);
 
   static bool isUninitialized();
   static void updateColorIndexAtPosition(uint8_t layer, uint16_t position, uint8_t palette_index);
 
+
   // This class' instance has dynamic lifetime
   //
   class TransientLEDMode : public LEDMode {
@@ -62,6 +64,11 @@ class ColormapEffect : public Plugin,
     const ColormapEffect *parent_;
   };
 
+ protected:
+  const __FlashStringHelper *getPluginName() const override {
+    return F("ColormapEffect");
+  }
+
  private:
   static uint8_t top_layer_;
   static uint8_t max_layers_;

diff --git a/plugins/Kaleidoscope-DefaultLEDModeConfig/src/kaleidoscope/plugin/DefaultLEDModeConfig.cpp b/plugins/Kaleidoscope-DefaultLEDModeConfig/src/kaleidoscope/plugin/DefaultLEDModeConfig.cpp
@@ -65,10 +65,6 @@ EventHandlerResult DefaultLEDModeConfig::onFocusEvent(const char *input) {
   return EventHandlerResult::EVENT_CONSUMED;
 }
 
-EventHandlerResult DefaultLEDModeConfig::onNameQuery() {
-  return ::Focus.sendName(F("DefaultLEDModeConfig"));
-}
-
 void DefaultLEDModeConfig::activateLEDModeIfUnconfigured(LEDModeInterface *plugin) {
   if (!Runtime.storage().isSliceUninitialized(settings_base_, sizeof(settings_)))
     return;

diff --git a/plugins/Kaleidoscope-DefaultLEDModeConfig/src/kaleidoscope/plugin/DefaultLEDModeConfig.h b/plugins/Kaleidoscope-DefaultLEDModeConfig/src/kaleidoscope/plugin/DefaultLEDModeConfig.h
@@ -22,18 +22,20 @@
 #include "kaleidoscope/event_handler_result.h"     // for EventHandlerResult
 #include "kaleidoscope/plugin.h"                   // for Plugin
 #include "kaleidoscope/plugin/LEDModeInterface.h"  // for LEDModeInterface
-
+#include "kaleidoscope/plugin/FocusPlugin.h"       // for FocusPlugin
 namespace kaleidoscope {
 namespace plugin {
 
-class DefaultLEDModeConfig : public kaleidoscope::Plugin {
+class DefaultLEDModeConfig : public kaleidoscope::Plugin, FocusPlugin {
  public:
   EventHandlerResult onSetup();
-  EventHandlerResult onNameQuery();
   EventHandlerResult onFocusEvent(const char *input);
 
   void activateLEDModeIfUnconfigured(LEDModeInterface *plugin);
 
+ protected:
+  const __FlashStringHelper *getPluginName() const override { F("DefaultLEDModeConfig"); }
+
  private:
   static uint16_t settings_base_;
   static struct settings {

diff --git a/plugins/Kaleidoscope-DynamicMacros/src/kaleidoscope/plugin/DynamicMacros.cpp b/plugins/Kaleidoscope-DynamicMacros/src/kaleidoscope/plugin/DynamicMacros.cpp
@@ -207,9 +207,6 @@ EventHandlerResult DynamicMacros::onKeyEvent(KeyEvent &event) {
   return EventHandlerResult::EVENT_CONSUMED;
 }
 
-EventHandlerResult DynamicMacros::onNameQuery() {
-  return ::Focus.sendName(F("DynamicMacros"));
-}
 
 EventHandlerResult DynamicMacros::onFocusEvent(const char *input) {
   const char *cmd_map     = PSTR("macros.map");

diff --git a/plugins/Kaleidoscope-DynamicMacros/src/kaleidoscope/plugin/DynamicMacros.h b/plugins/Kaleidoscope-DynamicMacros/src/kaleidoscope/plugin/DynamicMacros.h
@@ -24,7 +24,7 @@
 #include "kaleidoscope/event_handler_result.h"  // for EventHandlerResult
 #include "kaleidoscope/key_defs.h"              // for Key
 #include "kaleidoscope/plugin.h"                // for Plugin
-
+#include "kaleidoscope/plugin/FocusPlugin.h"    // for FocusPlugin
 #define DM(n) ::kaleidoscope::plugin::DynamicMacrosKey(n)
 
 namespace kaleidoscope {
@@ -34,9 +34,8 @@ constexpr Key DynamicMacrosKey(uint8_t n) {
   return Key(kaleidoscope::ranges::DYNAMIC_MACRO_FIRST + n);
 }
 
-class DynamicMacros : public kaleidoscope::Plugin {
+class DynamicMacros : public kaleidoscope::Plugin, public FocusPlugin {
  public:
-  EventHandlerResult onNameQuery();
   EventHandlerResult onKeyEvent(KeyEvent &event);
   EventHandlerResult onFocusEvent(const char *input);
   EventHandlerResult beforeReportingState(const KeyEvent &event) {
@@ -47,6 +46,12 @@ class DynamicMacros : public kaleidoscope::Plugin {
 
   void play(uint8_t seq_id);
 
+ protected:
+  const __FlashStringHelper *getPluginName() const override {
+    return F("LEDBrightnessConfig");
+  }
+
+
  private:
   static const uint8_t MAX_MACRO_COUNT_ = 32;
   uint16_t storage_base_;

diff --git a/plugins/Kaleidoscope-EEPROM-Keymap/src/kaleidoscope/plugin/EEPROM-Keymap.cpp b/plugins/Kaleidoscope-EEPROM-Keymap/src/kaleidoscope/plugin/EEPROM-Keymap.cpp
@@ -41,9 +41,6 @@ EventHandlerResult EEPROMKeymap::onSetup() {
   return EventHandlerResult::OK;
 }
 
-EventHandlerResult EEPROMKeymap::onNameQuery() {
-  return ::Focus.sendName(F("EEPROMKeymap"));
-}
 
 void EEPROMKeymap::setup(uint8_t max) {
   layer_count = max;

diff --git a/plugins/Kaleidoscope-EEPROM-Keymap/src/kaleidoscope/plugin/EEPROM-Keymap.h b/plugins/Kaleidoscope-EEPROM-Keymap/src/kaleidoscope/plugin/EEPROM-Keymap.h
@@ -23,18 +23,19 @@
 #include "kaleidoscope/event_handler_result.h"  // for EventHandlerResult
 #include "kaleidoscope/key_defs.h"              // for Key
 #include "kaleidoscope/plugin.h"                // for Plugin
+#include "Kaleidoscope-FocusSerial.h"           // for getting focus in our path
+#include "kaleidoscope/plugin/FocusPlugin.h"    // for FocusPlugin
 
 namespace kaleidoscope {
 namespace plugin {
-class EEPROMKeymap : public kaleidoscope::Plugin {
+class EEPROMKeymap : public kaleidoscope::Plugin, public FocusPlugin {
  public:
   enum class Mode {
     CUSTOM,
     EXTEND
   };
 
   EventHandlerResult onSetup();
-  EventHandlerResult onNameQuery();
   EventHandlerResult onFocusEvent(const char *input);
 
   static void setup(uint8_t max);
@@ -48,6 +49,9 @@ class EEPROMKeymap : public kaleidoscope::Plugin {
 
   static void updateKey(uint16_t base_pos, Key key);
 
+ protected:
+  const __FlashStringHelper *getPluginName() const override { F("EEPROMKeymap"); }
+
  private:
   static uint16_t keymap_base_;
   static uint8_t max_layers_;

diff --git a/plugins/Kaleidoscope-Escape-OneShot/src/kaleidoscope/plugin/Escape-OneShot-Config.cpp b/plugins/Kaleidoscope-Escape-OneShot/src/kaleidoscope/plugin/Escape-OneShot-Config.cpp
@@ -40,10 +40,6 @@ EventHandlerResult EscapeOneShotConfig::onSetup() {
   return EventHandlerResult::OK;
 }
 
-EventHandlerResult EscapeOneShotConfig::onNameQuery() {
-  return ::Focus.sendName(F("EscapeOneShot"));
-}
-
 EventHandlerResult EscapeOneShotConfig::onFocusEvent(const char *input) {
   const char *cmd_cancel_key = PSTR("escape_oneshot.cancel_key");
   if (::Focus.inputMatchesHelp(input))

diff --git a/plugins/Kaleidoscope-Escape-OneShot/src/kaleidoscope/plugin/Escape-OneShot.h b/plugins/Kaleidoscope-Escape-OneShot/src/kaleidoscope/plugin/Escape-OneShot.h
@@ -24,7 +24,7 @@
 #include "kaleidoscope/event_handler_result.h"  // for EventHandlerResult
 #include "kaleidoscope/key_defs.h"              // for Key, Key_Escape
 #include "kaleidoscope/plugin.h"                // for Plugin
-
+#include "kaleidoscope/plugin/FocusPlugin.h"    // for FocusPlugin
 // DEPRECATED: `OneShotCancelKey` doesn't match our normal naming, and should
 // eventually be removed.
 constexpr Key OneShotCancelKey{kaleidoscope::ranges::OS_CANCEL};
@@ -53,11 +53,13 @@ class EscapeOneShot : public kaleidoscope::Plugin {
   Settings settings_ = {.cancel_oneshot_key = Key_Escape};
 };
 
-class EscapeOneShotConfig : public Plugin {
+class EscapeOneShotConfig : public Plugin, FocusPlugin {
  public:
   EventHandlerResult onSetup();
   EventHandlerResult onFocusEvent(const char *input);
-  EventHandlerResult onNameQuery();
+
+ protected:
+  const __FlashStringHelper *getPluginName() const override { F("EscapeOneShot"); }
 
  private:
   uint16_t settings_base_;

diff --git a/plugins/Kaleidoscope-FocusSerial/src/kaleidoscope/plugin/FocusPlugin.h b/plugins/Kaleidoscope-FocusSerial/src/kaleidoscope/plugin/FocusPlugin.h
@@ -0,0 +1,22 @@
+// FocusPlugin.h
+#pragma once
+#include <Kaleidoscope-FocusSerial.h>  // for Focus, FocusSerial
+
+#include "kaleidoscope/plugin.h"  // for Plugin
+
+namespace kaleidoscope {
+namespace plugin {
+
+class FocusPlugin {
+ public:
+  EventHandlerResult onNameQuery() {
+    return ::Focus.sendName(getPluginName());
+  }
+
+ protected:
+  // New virtual method to be overridden by derived classes to return the plugin name
+  virtual const __FlashStringHelper *getPluginName() const = 0;
+};
+
+}  // namespace plugin
+}  // namespace kaleidoscope
diff --git a/plugins/Kaleidoscope-LayerFocus/src/kaleidoscope/plugin/LayerFocus.cpp b/plugins/Kaleidoscope-LayerFocus/src/kaleidoscope/plugin/LayerFocus.cpp
@@ -28,9 +28,6 @@
 namespace kaleidoscope {
 namespace plugin {
 
-EventHandlerResult LayerFocus::onNameQuery() {
-  return ::Focus.sendName(F("LayerFocus"));
-}
 
 EventHandlerResult LayerFocus::onFocusEvent(const char *input) {
   const char *cmd_activate   = PSTR("layer.activate");

diff --git a/plugins/Kaleidoscope-LayerFocus/src/kaleidoscope/plugin/LayerFocus.h b/plugins/Kaleidoscope-LayerFocus/src/kaleidoscope/plugin/LayerFocus.h
@@ -20,14 +20,16 @@
 
 #include "kaleidoscope/event_handler_result.h"  // for EventHandlerResult
 #include "kaleidoscope/plugin.h"                // for Plugin
-
+#include "kaleidoscope/plugin/FocusPlugin.h"    // for FocusPlugin
 namespace kaleidoscope {
 namespace plugin {
 
-class LayerFocus : public kaleidoscope::Plugin {
+class LayerFocus : public kaleidoscope::Plugin, public FocusPlugin {
  public:
-  EventHandlerResult onNameQuery();
   EventHandlerResult onFocusEvent(const char *input);
+
+ protected:
+  const __FlashStringHelper *getPluginName() const override { F("LayerFocus"); }
 };
 
 }  // namespace plugin

diff --git a/plugins/Kaleidoscope-Macros/src/kaleidoscope/plugin/Macros.cpp b/plugins/Kaleidoscope-Macros/src/kaleidoscope/plugin/Macros.cpp
@@ -276,9 +276,6 @@ EventHandlerResult Macros::onKeyEvent(KeyEvent &event) {
   return EventHandlerResult::OK;
 }
 
-EventHandlerResult Macros::onNameQuery() {
-  return ::Focus.sendName(F("Macros"));
-}
 
 }  // namespace plugin
 }  // namespace kaleidoscope

diff --git a/plugins/Kaleidoscope-Macros/src/kaleidoscope/plugin/Macros.h b/plugins/Kaleidoscope-Macros/src/kaleidoscope/plugin/Macros.h
@@ -25,15 +25,15 @@
 #include "kaleidoscope/key_defs.h"                  // for Key
 #include "kaleidoscope/plugin.h"                    // for Plugin
 #include "kaleidoscope/plugin/Macros/MacroSteps.h"  // for macro_t, MACRO_NONE
-
+#include "kaleidoscope/plugin/FocusPlugin.h"        // for FocusPlugin
 // =============================================================================
 // Define this function in a Kaleidoscope sketch in order to trigger Macros.
 const macro_t *macroAction(uint8_t macro_id, KeyEvent &event);
 
 namespace kaleidoscope {
 namespace plugin {
 
-class Macros : public kaleidoscope::Plugin {
+class Macros : public kaleidoscope::Plugin, public FocusPlugin {
  public:
   /// Send a key press event from a Macro
   ///
@@ -88,12 +88,14 @@ class Macros : public kaleidoscope::Plugin {
 
   // ---------------------------------------------------------------------------
   // Event handlers
-  EventHandlerResult onNameQuery();
   EventHandlerResult onKeyEvent(KeyEvent &event);
   EventHandlerResult beforeReportingState(const KeyEvent &event) {
     return ::MacroSupport.beforeReportingState(event);
   }
 
+ protected:
+  const __FlashStringHelper *getPluginName() const override { F("Macros"); }
+
  private:
   // Translate and ASCII character value to a corresponding `Key`
   Key lookupAsciiCode(uint8_t ascii_code) const;

diff --git a/plugins/Kaleidoscope-MouseKeys/src/kaleidoscope/plugin/MouseKeys.cpp b/plugins/Kaleidoscope-MouseKeys/src/kaleidoscope/plugin/MouseKeys.cpp
@@ -91,10 +91,7 @@ bool MouseKeys::isMouseWheelKey(const Key &key) const {
 // =============================================================================
 // Event Handlers
 
-// -----------------------------------------------------------------------------
-EventHandlerResult MouseKeys::onNameQuery() {
-  return ::Focus.sendName(F("MouseKeys"));
-}
+
 
 // -----------------------------------------------------------------------------
 EventHandlerResult MouseKeys::onSetup() {

diff --git a/plugins/Kaleidoscope-MouseKeys/src/kaleidoscope/plugin/MouseKeys.h b/plugins/Kaleidoscope-MouseKeys/src/kaleidoscope/plugin/MouseKeys.h
@@ -18,11 +18,11 @@
 
 #include <stdint.h>  // for uint8_t, uint16_t
 
-#include "kaleidoscope/KeyEvent.h"              // for KeyEvent
-#include "kaleidoscope/event_handler_result.h"  // for EventHandlerResult
-#include "kaleidoscope/key_defs.h"              // for Key
-#include "kaleidoscope/plugin.h"                // for Plugin
-
+#include "kaleidoscope/KeyEvent.h"                         // for KeyEvent
+#include "kaleidoscope/event_handler_result.h"             // for EventHandlerResult
+#include "kaleidoscope/key_defs.h"                         // for Key
+#include "kaleidoscope/plugin.h"                           // for Plugin
+#include "kaleidoscope/plugin/FocusPlugin.h"               // for FocusPlugin
 #include "kaleidoscope/plugin/mousekeys/MouseWarpModes.h"  // for warp modes
 // =============================================================================
 // Deprecated MousKeys code
@@ -65,7 +65,7 @@
 
 namespace kaleidoscope {
 namespace plugin {
-class MouseKeys : public kaleidoscope::Plugin {
+class MouseKeys : public kaleidoscope::Plugin, public FocusPlugin {
  public:
 #ifndef NDEPRECATED
   DEPRECATED(MOUSEKEYS_SPEED)
@@ -136,7 +136,6 @@ class MouseKeys : public kaleidoscope::Plugin {
   }
 
   EventHandlerResult onSetup();
-  EventHandlerResult onNameQuery();
   EventHandlerResult afterEachCycle();
   EventHandlerResult onKeyEvent(KeyEvent &event);
   EventHandlerResult onAddToReport(Key key);
@@ -157,6 +156,9 @@ class MouseKeys : public kaleidoscope::Plugin {
   // directly. Mainly useful for calls to `Runtime.storage.get()`/`.put()`.
   friend class MouseKeysConfig;
 
+ protected:
+  const __FlashStringHelper *getPluginName() const override { F("MouseKeys"); }
+
  private:
   static constexpr uint8_t cursor_update_interval_ = 4;
 

diff --git a/plugins/Kaleidoscope-Qukeys/src/kaleidoscope/plugin/Qukeys.cpp b/plugins/Kaleidoscope-Qukeys/src/kaleidoscope/plugin/Qukeys.cpp
@@ -33,9 +33,6 @@
 namespace kaleidoscope {
 namespace plugin {
 
-EventHandlerResult Qukeys::onNameQuery() {
-  return ::Focus.sendName(F("Qukeys"));
-}
 
 // This is the event handler. It ignores certain events, but mostly just adds
 // them to the Qukeys event queue.

diff --git a/plugins/Kaleidoscope-Qukeys/src/kaleidoscope/plugin/Qukeys.h b/plugins/Kaleidoscope-Qukeys/src/kaleidoscope/plugin/Qukeys.h
@@ -29,6 +29,7 @@
 #include "kaleidoscope/event_handler_result.h"  // for EventHandlerResult
 #include "kaleidoscope/key_defs.h"              // for Key, Key_Transparent
 #include "kaleidoscope/plugin.h"                // for Plugin
+#include "kaleidoscope/plugin/FocusPlugin.h"    // for FocusPlugin
 
 // IWYU pragma: no_include "HIDAliases.h"
 
@@ -75,7 +76,7 @@ struct Qukey {
 };
 
 
-class Qukeys : public kaleidoscope::Plugin {
+class Qukeys : public kaleidoscope::Plugin, public FocusPlugin {
 
  public:
   // Methods for turning the plugin on and off.
@@ -153,10 +154,12 @@ class Qukeys : public kaleidoscope::Plugin {
   static constexpr int8_t layer_wildcard{-1};
 
   // Kaleidoscope hook functions.
-  EventHandlerResult onNameQuery();
   EventHandlerResult onKeyswitchEvent(KeyEvent &event);
   EventHandlerResult afterEachCycle();
 
+ protected:
+  const __FlashStringHelper *getPluginName() const override { F("Qukeys"); }
+
  private:
   // An array of Qukey objects in PROGMEM.
   Qukey const *qukeys_{nullptr};