make fit on Atreus

Adapt previous to fit on the Atreus example sketch. Notably, this
makes `EEPROMKeymap::max_layers()` private so that it can be inlined.
Therefore, sketches like the `EEPROM-Keymap-Programmer` example sketch
that used that method needed to be adjusted. That method seemed obsolete
anyway, because it doesn't do some error checking that
`EEPROMKeymap::setup()` does.

Also, it removes the `settings.acceptInvalid` command, replacing it
with an optional argument to `settings.valid?`. Unfortunately, this
means that Chrysalis has no direct way to detect the presence of this
capability.

Signed-off-by: Taylor Yu <[email protected]>

Author: tlyu

examples/Features/EEPROM/EEPROM-Keymap-Programmer/EEPROM-Keymap-Programmer.ino

@@ -62,7 +62,7 @@ void setup() {
 
   Layer.getKey = EEPROMKeymap.getKey;
 
-  EEPROMKeymap.max_layers(1);
+  EEPROMKeymap.setup(1);
   EEPROMSettings.seal();
 }
 

plugins/Kaleidoscope-EEPROM-Keymap-Programmer/README.md

@@ -74,7 +74,7 @@ void setup() {
 
   Layer.getKey = EEPROMKeymap.getKey;
 
-  EEPROMKeymap.max_layers(1);
+  EEPROMKeymap.setup(1);
   EEPROMSettings.seal();
 }
 ```

plugins/Kaleidoscope-EEPROM-Keymap/src/kaleidoscope/plugin/EEPROM-Keymap.cpp

@@ -34,10 +34,8 @@ namespace plugin {
 uint16_t EEPROMKeymap::keymap_base_;
 uint8_t EEPROMKeymap::max_layers_;
 uint8_t EEPROMKeymap::progmem_layers_;
-bool EEPROMKeymap::ignore_hardcoded_;
 
 EventHandlerResult EEPROMKeymap::onSetup() {
-  ::EEPROMSettings.onSetup();
   progmem_layers_ = layer_count;
   return EventHandlerResult::OK;
 }
@@ -46,7 +44,7 @@ EventHandlerResult EEPROMKeymap::onNameQuery() {
   return ::Focus.sendName(F("EEPROMKeymap"));
 }
 
-void EEPROMKeymap::set_layers(bool ignore_hardcoded) {
+inline void EEPROMKeymap::set_layers(bool ignore_hardcoded) {
   layer_count = max_layers_;
   if (ignore_hardcoded) {
     Layer.getKey = getKey;
@@ -58,11 +56,10 @@ void EEPROMKeymap::set_layers(bool ignore_hardcoded) {
 
 void EEPROMKeymap::setup(uint8_t max) {
   max_layers(max);
-  ignore_hardcoded_ = ::EEPROMSettings.ignoreHardcodedLayers();
-  set_layers(ignore_hardcoded_);
+  set_layers(::EEPROMSettings.ignoreHardcodedLayers());
 }
 
-void EEPROMKeymap::max_layers(uint8_t max) {
+inline void EEPROMKeymap::max_layers(uint8_t max) {
   max_layers_  = max;
   keymap_base_ = ::EEPROMSettings.requestSlice(max_layers_ * Runtime.device().numKeys() * 2);
 }
@@ -73,10 +70,8 @@ void EEPROMKeymap::max_layers(uint8_t max) {
  * to avoid scrambled keymaps in some firmware update situations.
  */
 EventHandlerResult EEPROMKeymap::beforeEachCycle() {
-  if (::EEPROMSettings.ignoreHardcodedLayers() != ignore_hardcoded_) {
-    ignore_hardcoded_ = !ignore_hardcoded_;
-    set_layers(ignore_hardcoded_);
-  }
+  set_layers(::EEPROMSettings.ignoreHardcodedLayers());
+  return EventHandlerResult::OK;
 }
 
 Key EEPROMKeymap::getKey(uint8_t layer, KeyAddr key_addr) {

plugins/Kaleidoscope-EEPROM-Keymap/src/kaleidoscope/plugin/EEPROM-Keymap.h

@@ -40,8 +40,6 @@ class EEPROMKeymap : public kaleidoscope::Plugin {
 
   static void setup(uint8_t max);
 
-  static void max_layers(uint8_t max);
-
   static uint16_t keymap_base();
 
   static Key getKey(uint8_t layer, KeyAddr key_addr);
@@ -53,12 +51,12 @@ class EEPROMKeymap : public kaleidoscope::Plugin {
   static uint16_t keymap_base_;
   static uint8_t max_layers_;
   static uint8_t progmem_layers_;
-  static bool ignore_hardcoded_;
 
   static Key parseKey();
   static void printKey(Key key);
   static void dumpKeymap(uint8_t layers, Key (*getkey)(uint8_t, KeyAddr));
-  static void set_layers(bool ignore_hardcoded);
+  static inline void max_layers(uint8_t max);
+  static inline void set_layers(bool ignore_hardcoded);
 };
 
 }  // namespace plugin

plugins/Kaleidoscope-EEPROM-Settings/README.md

@@ -166,17 +166,14 @@ following commands:
 
 > Returns either `true` or `false`, depending on whether the sealed settings are
 > to be considered valid or not.
+>
+> When given an argument of `1`, accepts the current settings as valid, regardless of whether the settings layout matches.
+> Accepting also stores the current checksum, so it will be considered valid in the future.
 
 ### `settings.version`
 
 > Returns the version of the settings.
 
-### `settings.acceptInvalid 1`
-
-> Accepts the current settings as valid, regardless of whether the settings layout matches.
-> Also stores the current checksum, so it will be considered valid in the future.
-> The argument of `1` is required, to prevent accidental activation.
-
 ### `eeprom.contents`
 
 > Without argument, displays the full contents of the `EEPROM`, including the

plugins/Kaleidoscope-EEPROM-Settings/src/kaleidoscope/plugin/EEPROM-Settings.cpp

@@ -30,7 +30,7 @@
 namespace kaleidoscope {
 namespace plugin {
 
-void EEPROMSettings::fallback_layers() {
+inline void EEPROMSettings::fallback_layers() {
   settings_.ignore_hardcoded_layers = false;
   settings_.default_layer           = 0;
 }
@@ -112,8 +112,7 @@ void EEPROMSettings::seal() {
   if (settings_.version != VERSION_CURRENT) {
     is_valid_ = false;
   } else if (settings_.crc == 0xffff) {
-    settings_.crc = CRCCalculator.crc;
-    update();
+    accept_invalid();
   } else if (settings_.crc == CRCCalculator.crc) {
     is_valid_ = true;
   }
@@ -153,7 +152,6 @@ void EEPROMSettings::invalidate() {
 
 // Accept possibly corrupt settings, hopefully after user review
 void EEPROMSettings::accept_invalid() {
-  is_valid_     = true;
   settings_.crc = ::CRCCalculator.crc;
   update();
 }
@@ -175,17 +173,16 @@ EventHandlerResult FocusSettingsCommand::onFocusEvent(const char *input) {
     IS_VALID,
     GET_VERSION,
     GET_CRC,
-    ACCEPT_INVALID,
   } sub_command;
+  uint8_t v;
 
-  const char *cmd_defaultLayer  = PSTR("settings.defaultLayer");
-  const char *cmd_isValid       = PSTR("settings.valid?");
-  const char *cmd_version       = PSTR("settings.version");
-  const char *cmd_crc           = PSTR("settings.crc");
-  const char *cmd_acceptInvalid = PSTR("settings.acceptInvalid");
+  const char *cmd_defaultLayer = PSTR("settings.defaultLayer");
+  const char *cmd_isValid      = PSTR("settings.valid?");
+  const char *cmd_version      = PSTR("settings.version");
+  const char *cmd_crc          = PSTR("settings.crc");
 
   if (::Focus.inputMatchesHelp(input))
-    return ::Focus.printHelp(cmd_defaultLayer, cmd_isValid, cmd_version, cmd_crc, cmd_acceptInvalid);
+    return ::Focus.printHelp(cmd_defaultLayer, cmd_isValid, cmd_version, cmd_crc);
 
   if (::Focus.inputMatchesCommand(input, cmd_defaultLayer))
     sub_command = DEFAULT_LAYER;
@@ -195,8 +192,6 @@ EventHandlerResult FocusSettingsCommand::onFocusEvent(const char *input) {
     sub_command = GET_VERSION;
   else if (::Focus.inputMatchesCommand(input, cmd_crc))
     sub_command = GET_CRC;
-  else if (::Focus.inputMatchesCommand(input, cmd_acceptInvalid))
-    sub_command = ACCEPT_INVALID;
   else
     return EventHandlerResult::OK;
 
@@ -205,32 +200,27 @@ EventHandlerResult FocusSettingsCommand::onFocusEvent(const char *input) {
     if (::Focus.isEOL()) {
       ::Focus.send(::EEPROMSettings.default_layer());
     } else {
-      uint8_t layer;
-      ::Focus.read(layer);
-      ::EEPROMSettings.default_layer(layer);
+      ::Focus.read(v);
+      ::EEPROMSettings.default_layer(v);
     }
     break;
   }
   case IS_VALID:
-    ::Focus.send(::EEPROMSettings.isValid());
+    // `isEOL()` not needed, because `read()` will store 0 on early EOL
+    ::Focus.read(v);
+    if (v == 1) {
+      // Accept possibly corrupt settings, hopefully after user review
+      ::EEPROMSettings.accept_invalid();
+    } else {
+      ::Focus.send(::EEPROMSettings.isValid());
+    }
     break;
   case GET_VERSION:
     ::Focus.send(::EEPROMSettings.version());
     break;
   case GET_CRC:
     ::Focus.sendRaw(::CRCCalculator.crc, F("/"), ::EEPROMSettings.crc());
     break;
-  case ACCEPT_INVALID:
-    if (::Focus.isEOL()) {
-      break;
-    } else {
-      uint8_t v;
-      ::Focus.read(v);
-      if (v == 1) {
-        ::EEPROMSettings.accept_invalid();
-      }
-    }
-    break;
   }
 
   return EventHandlerResult::EVENT_CONSUMED;

plugins/Kaleidoscope-EEPROM-Settings/src/kaleidoscope/plugin/EEPROM-Settings.h

@@ -81,7 +81,7 @@ class EEPROMSettings : public kaleidoscope::Plugin {
   uint16_t next_start_ = sizeof(EEPROMSettings::Settings);
   bool is_valid_;
   bool sealed_;
-  void fallback_layers();
+  inline void fallback_layers();
 
   Settings settings_;
 };