#75 ensure that reset callback works properly

Author: dave

src/BaseRenderers.cpp

@@ -46,7 +46,7 @@ BaseMenuRenderer::BaseMenuRenderer(int bufferSize) : MenuRenderer(RENDERER_TYPE_
 }
 
 void BaseMenuRenderer::initialise() {
-	ticksToReset = MAX_TICKS;
+	ticksToReset = resetValInTicks;
 	renderCallback = NULL;
 	redrawMode = MENUDRAW_COMPLETE_REDRAW;
 

src/tcMenu.cpp

@@ -314,7 +314,10 @@ void MenuManager::addMenuAfter(MenuItem *existing, MenuItem* toAdd, bool silent)
 
 void MenuManager::addChangeNotification(MenuManagerObserver *observer) {
     for(auto & i : structureNotifier) {
-        if(i == nullptr) i = observer;
+        if(i == nullptr) {
+            i = observer;
+            return;
+        }
     }
 }
 
@@ -333,7 +336,9 @@ void MenuManager::load(EepromAbstraction &eeprom, uint16_t magicKey, TimerFn onE
 
 void MenuManager::notifyEditEnd(MenuItem *item) {
     for(auto & obs : structureNotifier) {
-        if(obs != nullptr) obs->menuEditEnded(item);
+        if(obs != nullptr) {
+            obs->menuEditEnded(item);
+        }
     }
 }
 
@@ -349,6 +354,8 @@ bool MenuManager::notifyEditStarting(MenuItem *item) {
 
 void MenuManager::notifyStructureChanged() {
     for(auto & i : structureNotifier) {
-        if(i != nullptr) i->structureHasChanged();
+        if(i != nullptr) {
+            i->structureHasChanged();
+        }
     }
 }

src/tcMenu.h

@@ -68,7 +68,9 @@ class CommitCallbackObserver : public MenuManagerObserver {
 
     void structureHasChanged() override {}
     bool menuEditStarting(MenuItem*) override { return true; }
-    void menuEditEnded(MenuItem* item) override { commitCb(item->getId()); }
+    void menuEditEnded(MenuItem* item) override {
+        commitCb(item->getId());
+    }
 };
 
 #ifndef MAX_MENU_NOTIFIERS

tests/tcMenuCoreTests/menuManagerTests.cpp

@@ -75,13 +75,14 @@ class TestMenuMgrObserver : public MenuManagerObserver {
     bool editStartedCalled{};
     bool editEndedCalled{};
     bool startReturnValue{};
+    bool originalCommitCalled{};
 public:
     TestMenuMgrObserver() = default;
 
     void setStartReturn(bool toReturn) { startReturnValue = toReturn; }
 
     void reset() {
-        structureChangedCalled = editStartedCalled = editEndedCalled = false;
+        structureChangedCalled = editStartedCalled = editEndedCalled = originalCommitCalled = false;
     }
 
     void structureHasChanged() override {
@@ -97,11 +98,20 @@ class TestMenuMgrObserver : public MenuManagerObserver {
         editEndedCalled = true;
     }
 
+    void originalCommitWasCalled() {
+        originalCommitCalled = true;
+    }
+
     bool didTriggerStructure() const { return structureChangedCalled; }
     bool didTriggerStartEdit() const { return editStartedCalled; }
     bool didTriggerEndEdit() const { return editEndedCalled; }
+    bool didOriginalCommitTrigger() const { return originalCommitCalled; }
 } menuMgrObserver;
 
+void originalCommitCb(int itemId) {
+    menuMgrObserver.originalCommitWasCalled();
+}
+
 const PROGMEM AnyMenuInfo testActionInfo = { "ActTest", 2394, 0xffff,  0, NO_CALLBACK };
 ActionMenuItem testActionItem(&testActionInfo, nullptr);
 
@@ -112,6 +122,7 @@ test(addingItemsAndMenuCallbacks) {
     menuMgr.setRootMenu(&textMenuItem1);
     menuMgr.initWithoutInput(&noRenderer, &textMenuItem1);
     menuMgr.addChangeNotification(&menuMgrObserver);
+    menuMgr.setItemCommittedHook(originalCommitCb);
 
     // first we add some menu items at the end of the menu and test the structure change call is made
     menuMgr.addMenuAfter(&menuNumTwoDp, &testActionItem, true);
@@ -135,6 +146,7 @@ test(addingItemsAndMenuCallbacks) {
     menuMgr.onMenuSelect(false);
 
     assertTrue(menuMgrObserver.didTriggerEndEdit());
+    assertTrue(menuMgrObserver.didOriginalCommitTrigger());
     assertTrue(menuMgrObserver.didTriggerStartEdit());
     assertTrue(boolItem1.getBoolean() != currentMenuValue);
 
@@ -157,6 +169,7 @@ test(addingItemsAndMenuCallbacks) {
     menuMgr.valueChanged(1); // we are now editing, change the actual enum
     menuMgr.onMenuSelect(false); // stop editing
     assertTrue(menuMgrObserver.didTriggerEndEdit());
+    assertTrue(menuMgrObserver.didOriginalCommitTrigger());
     assertEqual((uint16_t)1, menuEnum1.getCurrentValue());
 
     // lastly try an enum item that does not go into editing because the callback returned false.
@@ -166,6 +179,5 @@ test(addingItemsAndMenuCallbacks) {
     menuMgr.onMenuSelect(false);
     assertTrue(menuMgrObserver.didTriggerStartEdit());
     assertFalse(menuEnum1.isEditing());
-
 }