More settings rendering

source/Core/Src/settingsGUI.cpp

@@ -120,17 +120,12 @@ static bool showHallEffect(void);
 
 #if defined(POW_DC) || defined(POW_QC)
 static void displayPowerMenu(void);
-static bool enterPowerMenu(void);
 #endif /* POW_DC or POW_QC */
 
 static void displaySolderingMenu(void);
-static bool enterSolderingMenu(void);
 static void displayPowerSavingMenu(void);
-static bool enterPowerSavingMenu(void);
 static void displayUIMenu(void);
-static bool enterUIMenu(void);
 static void displayAdvancedMenu(void);
-static bool enterAdvancedMenu(void);
 
 /*
  * Root Settings Menu
@@ -216,16 +211,16 @@ const menuitem rootSettingsMenu[] {
    */
 #if defined(POW_DC) || defined(POW_QC)
   /* Power */
-  {0, enterPowerMenu, displayPowerMenu, nullptr, SettingsOptions::SettingsOptionsLength, SettingsItemIndex::NUM_ITEMS, 0},
+  {0, nullptr, displayPowerMenu, nullptr, SettingsOptions::SettingsOptionsLength, SettingsItemIndex::NUM_ITEMS, 0},
 #endif
   /* Soldering */
-  {0, enterSolderingMenu, displaySolderingMenu, nullptr, SettingsOptions::SettingsOptionsLength, SettingsItemIndex::NUM_ITEMS, 0},
+  {0, nullptr, displaySolderingMenu, nullptr, SettingsOptions::SettingsOptionsLength, SettingsItemIndex::NUM_ITEMS, 0},
   /* Sleep Options Menu */
-  {0, enterPowerSavingMenu, displayPowerSavingMenu, nullptr, SettingsOptions::SettingsOptionsLength, SettingsItemIndex::NUM_ITEMS, 0},
+  {0, nullptr, displayPowerSavingMenu, nullptr, SettingsOptions::SettingsOptionsLength, SettingsItemIndex::NUM_ITEMS, 0},
   /* UI Menu */
-  {0, enterUIMenu, displayUIMenu, nullptr, SettingsOptions::SettingsOptionsLength, SettingsItemIndex::NUM_ITEMS, 0},
+  {0, nullptr, displayUIMenu, nullptr, SettingsOptions::SettingsOptionsLength, SettingsItemIndex::NUM_ITEMS, 0},
   /* Advanced Menu */
-  {0, enterAdvancedMenu, displayAdvancedMenu, nullptr, SettingsOptions::SettingsOptionsLength, SettingsItemIndex::NUM_ITEMS, 0},
+  {0, nullptr, displayAdvancedMenu, nullptr, SettingsOptions::SettingsOptionsLength, SettingsItemIndex::NUM_ITEMS, 0},
   /* Language Switch */
   {0, settings_setLanguageSwitch, settings_displayLanguageSwitch, settings_showLanguageSwitch, SettingsOptions::SettingsOptionsLength, SettingsItemIndex::NUM_ITEMS, 0},
   /* vvvv end of menu marker. DO NOT REMOVE vvvv */
@@ -440,7 +435,7 @@ const menuitem advancedMenu[] = {
 
 /* clang-format on */
 
-extern const menuitem *subSettingsMenus[] {
+const menuitem *subSettingsMenus[] {
 #if defined(POW_DC) || defined(POW_QC) || defined(POW_PD)
   powerMenu,
 #endif
@@ -1029,214 +1024,3 @@ static bool enterAdvancedMenu(void) {
   gui_Menu(advancedMenu);
   return false;
 }
-
-uint8_t gui_getMenuLength(const menuitem *menu) {
-  uint8_t scrollContentSize = 0;
-  for (uint8_t i = 0; menu[i].draw != nullptr; i++) {
-    if (menu[i].isVisible == nullptr) {
-      scrollContentSize += 1; // Always visible
-    } else if (menu[i].isVisible()) {
-      scrollContentSize += 1; // Selectively visible and chosen to show
-    }
-  }
-  return scrollContentSize;
-}
-
-void gui_Menu(const menuitem *menu) {
-  // Draw the settings menu and provide iteration support etc
-
-  // This is used to detect whether a menu-exit transition should be played.
-  static bool wasInGuiMenu;
-  wasInGuiMenu = true;
-
-  enum class NavState {
-    Idle,
-    Entering,
-    ScrollingDown,
-    Exiting,
-  };
-
-  uint8_t    currentScreen          = 0; // Current screen index in the menu struct
-  uint8_t    screensSkipped         = 0; // Number of screens skipped due to being disabled
-  TickType_t autoRepeatTimer        = 0;
-  TickType_t autoRepeatAcceleration = 0;
-  bool       earlyExit              = false;
-  bool       lcdRefresh             = true;
-
-  ButtonState lastButtonState   = BUTTON_NONE;
-  uint8_t     scrollContentSize = gui_getMenuLength(menu);
-
-  bool     scrollBlink = false;
-  bool     lastValue   = false;
-  NavState navState    = NavState::Entering;
-
-  ScrollMessage scrollMessage;
-
-  while ((menu[currentScreen].draw != nullptr) && earlyExit == false) {
-    bool valueChanged = false;
-    // Handle menu transition:
-    if (navState != NavState::Idle) {
-      // Check if this menu item shall be skipped. If it shall be skipped,
-      // `draw()` returns true. Draw on the secondary framebuffer as we want
-      // to keep the primary framebuffer intact for the upcoming transition
-      // animation.
-      OLED::useSecondaryFramebuffer(true);
-      if (menu[currentScreen].isVisible != nullptr) {
-        if (!menu[currentScreen].isVisible()) {
-          currentScreen++;
-          screensSkipped++;
-          OLED::useSecondaryFramebuffer(false);
-          continue;
-        }
-      }
-
-      animOpenState = true;
-      // The menu entering/exiting transition uses the secondary framebuffer,
-      // but the scroll down transition does not.
-      OLED::setCursor(0, 0);
-      OLED::clearScreen();
-      if (menu[currentScreen].shortDescriptionSize > 0) {
-        printShortDescription(menu[currentScreen].shortDescriptionIndex, menu[currentScreen].shortDescriptionSize);
-      }
-      menu[currentScreen].draw();
-      if (navState == NavState::ScrollingDown) {
-        // Play the scroll down animation.
-        OLED::maskScrollIndicatorOnOLED();
-        OLED::transitionScrollDown();
-        OLED::useSecondaryFramebuffer(false);
-      } else {
-        // The menu was drawn in a secondary framebuffer.
-        // Now we play a transition from the pre-drawn primary
-        // framebuffer to the new buffer.
-        // The extra buffer is discarded at the end of the transition.
-        OLED::useSecondaryFramebuffer(false);
-        OLED::transitionSecondaryFramebuffer(navState == NavState::Entering);
-      }
-      animOpenState = false;
-      navState      = NavState::Idle;
-    }
-
-    // If the user has hesitated for >=3 seconds, show the long text
-    // Otherwise "draw" the option
-    if ((xTaskGetTickCount() - lastButtonTime < (TICKS_SECOND * 3)) || menu[currentScreen].description == 0) {
-      lcdRefresh = true;
-      OLED::setCursor(0, 0);
-      OLED::clearScreen();
-      if (menu[currentScreen].shortDescriptionSize > 0) {
-        printShortDescription(menu[currentScreen].shortDescriptionIndex, menu[currentScreen].shortDescriptionSize);
-      }
-      menu[currentScreen].draw();
-      uint8_t indicatorHeight = OLED_HEIGHT / scrollContentSize;
-      uint8_t position        = OLED_HEIGHT * (currentScreen - screensSkipped) / scrollContentSize;
-      if (lastValue) {
-        scrollBlink = !scrollBlink;
-      }
-      if (!lastValue || !scrollBlink) {
-        OLED::drawScrollIndicator(position, indicatorHeight);
-      }
-    } else {
-      // Draw description
-      const char *description = translatedString(Tr->SettingsDescriptions[menu[currentScreen].description - 1]);
-      lcdRefresh |= scrollMessage.drawUpdate(description, xTaskGetTickCount());
-    }
-
-    if (lcdRefresh) {
-      OLED::refresh(); // update the LCD
-      osDelay(40);
-      lcdRefresh = false;
-    }
-
-    ButtonState buttons = getButtonState();
-
-    if (buttons != lastButtonState) {
-      autoRepeatAcceleration = 0;
-      lastButtonState        = buttons;
-    }
-
-    auto callIncrementHandler = [&]() {
-      wasInGuiMenu = false;
-      valueChanged = true;
-      bool res     = false;
-      if ((int)menu[currentScreen].autoSettingOption < (int)SettingsOptions::SettingsOptionsLength) {
-        res = nextSettingValue(menu[currentScreen].autoSettingOption);
-      } else if (menu[currentScreen].incrementHandler != nullptr) {
-        res = menu[currentScreen].incrementHandler();
-      } else {
-        earlyExit = true;
-      }
-      if (wasInGuiMenu) {
-        navState = NavState::Exiting;
-      }
-      wasInGuiMenu = true;
-      return res;
-    };
-
-    switch (buttons) {
-    case BUTTON_BOTH:
-      earlyExit = true; // will make us exit next loop
-      scrollMessage.reset();
-      break;
-    case BUTTON_F_SHORT:
-      // increment
-      if (scrollMessage.isReset()) {
-        lastValue = callIncrementHandler();
-      } else {
-        scrollMessage.reset();
-      }
-      break;
-    case BUTTON_B_SHORT:
-      if (scrollMessage.isReset()) {
-        currentScreen++;
-        navState  = NavState::ScrollingDown;
-        lastValue = false;
-      } else {
-        scrollMessage.reset();
-      }
-      break;
-    case BUTTON_F_LONG:
-      if (xTaskGetTickCount() + autoRepeatAcceleration > autoRepeatTimer + PRESS_ACCEL_INTERVAL_MAX) {
-        if ((lastValue = callIncrementHandler())) {
-          autoRepeatTimer = 1000;
-        } else {
-          autoRepeatTimer = 0;
-        }
-        autoRepeatTimer += xTaskGetTickCount();
-        scrollMessage.reset();
-        autoRepeatAcceleration += PRESS_ACCEL_STEP;
-      }
-      break;
-    case BUTTON_B_LONG:
-      if (xTaskGetTickCount() - autoRepeatTimer + autoRepeatAcceleration > PRESS_ACCEL_INTERVAL_MAX) {
-        currentScreen++;
-        navState        = NavState::ScrollingDown;
-        autoRepeatTimer = xTaskGetTickCount();
-        scrollMessage.reset();
-        autoRepeatAcceleration += PRESS_ACCEL_STEP;
-      }
-      break;
-    case BUTTON_NONE:
-    default:
-      break;
-    }
-
-    if ((PRESS_ACCEL_INTERVAL_MAX - autoRepeatAcceleration) < PRESS_ACCEL_INTERVAL_MIN) {
-      autoRepeatAcceleration = PRESS_ACCEL_INTERVAL_MAX - PRESS_ACCEL_INTERVAL_MIN;
-    }
-
-    if ((xTaskGetTickCount() - lastButtonTime) > (TICKS_SECOND * 2 * 60)) {
-      // If user has not pressed any buttons in 30 seconds, exit back a menu layer
-      // This will trickle the user back to the main screen eventually
-      earlyExit = true;
-      scrollMessage.reset();
-    }
-    if (valueChanged) {
-      // If user changed value, update the scroll content size
-      scrollContentSize = gui_getMenuLength(menu);
-    }
-  }
-}
-
-void enterSettingsMenu() {
-  gui_Menu(rootSettingsMenu); // Call the root menu
-  saveSettings();
-}

source/Core/Threads/OperatingModes/SettingsMenu.cpp

@@ -1,5 +1,6 @@
 #include "OperatingModes.h"
 #include "ScrollMessage.hpp"
+#include "bflb_platform.h"
 
 #define HELP_TEXT_TIMEOUT_TICKS (TICKS_SECOND * 3)
 /*
@@ -40,6 +41,9 @@ void render_menu(const menuitem *item, guiContext *cxt) {
     }
     item->draw();
   } else {
+
+    uint16_t *wasRenderingHelp = &(cxt->scratch_state.state6);
+    *wasRenderingHelp          = 1;
     // Draw description
     const char *description = translatedString(Tr->SettingsDescriptions[item->description - 1]);
     drawScrollingText(description, xTaskGetTickCount() - lastButtonTime);
@@ -48,9 +52,13 @@ void render_menu(const menuitem *item, guiContext *cxt) {
 
 uint16_t getMenuLength(const menuitem *menu) {
   // walk this menu to find the length
+  uint16_t counter = 0;
   for (uint16_t pos = 0; pos < 64; pos++) {
-    if (menu[pos].draw == NULL) {
+    if (menu[pos].draw == nullptr) {
-      return pos + 1;
+      return counter;
+    }
+    if (menu[pos].isVisible == nullptr || menu[pos].isVisible()) {
+      counter++;
     }
   }
   return 0; // Cant find length, be safe
@@ -65,6 +73,7 @@ OperatingMode gui_SettingsMenu(const ButtonState buttons, guiContext *cxt) {
   uint16_t *mainEntry         = &(cxt->scratch_state.state1);
   uint16_t *subEntry          = &(cxt->scratch_state.state2);
   uint16_t *currentMenuLength = &(cxt->scratch_state.state5);
+  uint16_t *wasRenderingHelp  = &(cxt->scratch_state.state6);
 
   const menuitem *currentMenu;
   // Draw the currently on screen item
@@ -76,7 +85,7 @@ OperatingMode gui_SettingsMenu(const ButtonState buttons, guiContext *cxt) {
   } else {
     // Drawing sub menu
     currentMenu   = subSettingsMenus[*mainEntry];
-    currentScreen = *subEntry;
+    currentScreen = (*subEntry) - 1;
   }
   render_menu(&(currentMenu[currentScreen]), cxt);
 
@@ -95,6 +104,16 @@ OperatingMode gui_SettingsMenu(const ButtonState buttons, guiContext *cxt) {
 
   // Now handle user button input
 
+  auto callIncrementHandler = [&]() {
+    if ((int)currentMenu[currentScreen].autoSettingOption < (int)SettingsOptions::SettingsOptionsLength) {
+      nextSettingValue(currentMenu[currentScreen].autoSettingOption);
+    } else if (currentMenu[currentScreen].incrementHandler != nullptr) {
+      currentMenu[currentScreen].incrementHandler();
+    }
+  };
+
+  //
+
   switch (buttons) {
   case BUTTON_NONE:
     break;
@@ -103,17 +122,57 @@ OperatingMode gui_SettingsMenu(const ButtonState buttons, guiContext *cxt) {
     break;
 
   case BUTTON_B_LONG:
+
     break;
   case BUTTON_F_LONG:
 
     break;
   case BUTTON_F_SHORT:
+    // Increment setting
+    if (*wasRenderingHelp) {
+      *wasRenderingHelp = 0;
+    } else {
+      if (*subEntry == 0) {
+        // In a root menu, if its null handler we enter the menu
+        if (currentMenu[currentScreen].incrementHandler != nullptr) {
+          currentMenu[currentScreen].incrementHandler();
+        } else {
+          (*subEntry) += 1;
+        }
+      } else {
+        callIncrementHandler();
+      }
+    }
     break;
   case BUTTON_B_SHORT:
+    // Increment menu item
+    if (*wasRenderingHelp) {
+      *wasRenderingHelp = 0;
+    } else {
+      // Scroll down
+      if (currentScreen < (*currentMenuLength) - 1) {
+        // We can increment freely
+        if (*subEntry == 0) {
+          (*mainEntry) += 1;
+        } else {
+          (*subEntry) += 1;
+        }
+      } else {
+        // We are at an end somewhere, increment as appropriate
+        if (*subEntry == 0) {
+          // This is end of the list
+          return OperatingMode::HomeScreen;
+        } else {
+          (*subEntry) = 0;
+          (*mainEntry) += 1;
+        }
+      }
+    }
     break;
   default:
     break;
   }
+
   // Otherwise we stay put for next render iteration
   return OperatingMode::SettingsMenu;
 }