#204 introduce a ROOT item so we can differentiate between menu outside of structure and ROOT.

Author: dave

examples/arduino32/stm32DuinoDemo/stm32DuinoDemo.ino

@@ -125,7 +125,6 @@ void setup() {
     // lastly, we set the card layout for the main "root" menu. The last parameter is an optional touch screen interface
     // that the card layout will interact with, to "flip" between cards. Set to null when no touch screen available.
     renderer.enableCardLayout(iconLeft, iconRight, nullptr, true);
-    renderer.setCardLayoutStatusForSubMenu(&rootMenuItem(), true);
 
     // now we set up the layouts to make the card view look right.
     setupGridLayoutForCardView();

src/MenuHistoryNavigator.cpp

@@ -7,11 +7,12 @@
 #include "MenuHistoryNavigator.h"
 #include "MenuIterator.h"
 #include "RuntimeMenuItem.h"
+#include "tcMenu.h"
 
 void tcnav::MenuNavigationStore::setRootItem(MenuItem *item) {
     root = item;
     currentRoot = root;
-    currentSub = nullptr;
+    currentSub = &MenuManager::ROOT;
     navIdx = 0;
     currentIsCustom = false;
     triggerNavigationListener(false);
@@ -38,7 +39,7 @@ MenuItem *tcnav::MenuNavigationStore::popNavigationGetActive() {
     currentIsCustom = false;
     if(navIdx == 0) {
         serlogF(SER_TCMENU_INFO, "Nav pop root");
-        currentSub = nullptr;
+        currentSub = &MenuManager::ROOT;
         currentRoot = root;
         triggerNavigationListener(false);
         return root;

src/MenuIterator.cpp

@@ -217,6 +217,6 @@ MenuItem* getSubRecurse(MenuItem* toSearch, MenuItem* subMenu, MenuItem* current
 }
 
 MenuItem* getSubMenuFor(MenuItem* current) {
-    if(current == nullptr) return nullptr;
-    return getSubRecurse(menuMgr.getRoot(), nullptr, current);
+    if(current == nullptr) return nullptr; // we cannot traverse: null -> null
+    return getSubRecurse(&MenuManager::ROOT, nullptr, current);
 }

src/graphics/CardLayoutPanel.cpp

@@ -16,18 +16,19 @@ CardLayoutPane::CardLayoutPane(const DrawableIcon *left, const DrawableIcon *rig
 }
 
 bool CardLayoutPane::isSubMenuCardLayout(MenuItem *item) {
-    menuid_t itemId = item != nullptr ? item->getId() : 0;
-    SubMenuUsingCardLayout* sc = usingCardLayout.getByKey(itemId);
+    if(item == nullptr) return false; // it is an unmanaged menu, so cannot be card layout.
+    SubMenuUsingCardLayout* sc = usingCardLayout.getByKey(item->getId());
     return (sc && sc->getState());
 }
 
 void CardLayoutPane::setEnablementForSub(MenuItem *item, bool onOrOff) {
-    menuid_t itemId = item != nullptr ? item->getId() : 0;
-    SubMenuUsingCardLayout* existing = usingCardLayout.getByKey(itemId);
+    if(item == nullptr) return;
+
+    SubMenuUsingCardLayout* existing = usingCardLayout.getByKey(item->getId());
     if(existing != nullptr) {
         existing->setState(onOrOff);
     } else {
-        usingCardLayout.add(SubMenuUsingCardLayout(itemId, onOrOff));
+        usingCardLayout.add(SubMenuUsingCardLayout(item->getId(), onOrOff));
     }
 }
 

src/tcMenu.cpp

@@ -15,6 +15,9 @@
 
 MenuManager menuMgr;
 
+const SubMenuInfo TCGLB_ROOT_SUB_INFO PROGMEM = { "ROOT", 0, (uint16_t)-1, 1, nullptr };
+SubMenuItem MenuManager::ROOT(&TCGLB_ROOT_SUB_INFO, nullptr);
+
 class Digital4WayPassThruListener : public SwitchListener {
 private:
     pinid_t backPin = -1, nextPin = -1;
@@ -47,7 +50,7 @@ class Digital4WayPassThruListener : public SwitchListener {
 void MenuManager::initFor4WayJoystick(MenuRenderer* renderer, MenuItem* root, pinid_t downPin, pinid_t upPin, pinid_t leftPin,
                          pinid_t rightPin, pinid_t okPin, int speed) {
     this->renderer = renderer;
-    navigator.setRootItem(root);
+    setRootItem(root);
     fourWayPassThru.init(leftPin, rightPin);
 
     if(okPin == 0xffU) {
@@ -62,14 +65,14 @@ void MenuManager::initFor4WayJoystick(MenuRenderer* renderer, MenuItem* root, pi
 
 void MenuManager::initForTwoButton(MenuRenderer *r, MenuItem *root, pinid_t upPin, pinid_t downPin) {
     this->renderer = r;
-    navigator.setRootItem(root);
+    setRootItem(root);
     switches.setEncoder(new TwoButtonSwitchEncoder(upPin, downPin, [](int v) { menuMgr.valueChanged(v); }));
     renderer->initialise();
 }
 
 void MenuManager::initForUpDownOk(MenuRenderer* renderer, MenuItem* root, pinid_t pinDown, pinid_t pinUp, pinid_t pinOk, int speed) {
     this->renderer = renderer;
-    navigator.setRootItem(root);
+    setRootItem(root);
 
     switches.addSwitch(pinOk, nullptr);
     switches.onRelease(pinOk, [](pinid_t /*key*/, bool held) { menuMgr.onMenuSelect(held); });
@@ -79,7 +82,7 @@ void MenuManager::initForUpDownOk(MenuRenderer* renderer, MenuItem* root, pinid_
 
 void MenuManager::initForEncoder(MenuRenderer* renderer,  MenuItem* root, pinid_t encoderPinA, pinid_t encoderPinB, pinid_t encoderButton, EncoderType type) {
 	this->renderer = renderer;
-    navigator.setRootItem(root);
+    setRootItem(root);
 
 	switches.addSwitch(encoderButton, nullptr);
     switches.onRelease(encoderButton, [](pinid_t /*key*/, bool held) { menuMgr.onMenuSelect(held); });
@@ -130,7 +133,7 @@ void MenuManager::performDirectionMove(bool dirIsBack) {
 
 void MenuManager::initWithoutInput(MenuRenderer* renderer, MenuItem* root) {
 	this->renderer = renderer;
-    navigator.setRootItem(root);
+    setRootItem(root);
 	renderer->initialise();
 }
 
@@ -475,7 +478,7 @@ void MenuManager::resetMenu(bool completeReset) {
 
     MenuItem* currentActive;
     if(completeReset) {
-        navigator.setRootItem(navigator.getRoot());
+        setRootItem(navigator.getRoot());
         currentActive = nullptr;
     } else {
         currentActive = navigator.popNavigationGetActive();
@@ -527,6 +530,11 @@ MenuItem *MenuManager::findCurrentActive() {
     return bmr->getMenuItemAtIndex(getCurrentMenu(), idx);
 }
 
+void MenuManager::setRootItem(MenuItem *pItem) {
+    ROOT.setChild(pItem);
+    navigator.setRootItem(pItem);
+}
+
 void CurrentEditorRenderingHints::changeEditingParams(CurrentEditorRenderingHints::EditorRenderingType ty, int startOffset, int endOffset) {
     if(renderingType == EDITOR_OVERRIDE_LOCK) return;
     renderingType = ty;

src/tcMenu.h

@@ -149,6 +149,7 @@ class MenuManager {
     BtreeList<menuid_t, EncoderWrapOverride> encoderWrapOverrides;
     CurrentEditorRenderingHints renderingHints;
 public:
+    static SubMenuItem ROOT;
 	MenuManager();
 
     /**
@@ -361,7 +362,7 @@ class MenuManager {
 	/**
 	 * Get the root of all menus, the first menu item basically
 	 */
-	MenuItem* getRoot() { return navigator.getRoot(); }
+	MenuItem* getRoot() { return ROOT.getChild(); }
 
     /**
      * Get the renderer that this menu is using
@@ -515,6 +516,8 @@ class MenuManager {
 
     void notifyEditEnd(MenuItem *pItem);
     bool notifyEditStarting(MenuItem *pItem);
+
+    void setRootItem(MenuItem *pItem);
 };
 
 inline bool editorHintNeedsCursor(CurrentEditorRenderingHints::EditorRenderingType ty) {