#74 #55 finishing off the scroll, rgb and sub menu refactoring.

Author: dave

src/BaseRenderers.cpp

@@ -10,7 +10,25 @@
 #include "BaseRenderers.h"
 #include "BaseDialog.h"
 
-MenuRenderer* MenuRenderer::theInstance = NULL;
+MenuRenderer* MenuRenderer::theInstance = nullptr;
+
+class RenderingMenuMgrObserver : public MenuManagerObserver {
+public:
+    void structureHasChanged() override {
+        auto myRenderer = MenuRenderer::getInstance();
+        if(myRenderer->getRendererType() == RENDERER_TYPE_BASE) {
+            serdebugF("Completely invalidate the display");
+            reinterpret_cast<BaseMenuRenderer*>(myRenderer)->invalidateAll();
+        }
+    }
+
+    bool menuEditStarting(MenuItem *item) override {
+        return true;
+    }
+
+    void menuEditEnded(MenuItem *item) override {}
+} menuMgrListener;
+
 
 BaseMenuRenderer::BaseMenuRenderer(int bufferSize) : MenuRenderer(RENDERER_TYPE_BASE, bufferSize) {
 	ticksToReset = 0;
@@ -35,6 +53,7 @@ void BaseMenuRenderer::initialise() {
 	resetToDefault();
 
 	taskManager.scheduleFixedRate(SCREEN_DRAW_INTERVAL, this);
+	menuMgr.addChangeNotification(&menuMgrListener);
 }
 
 bool BaseMenuRenderer::tryTakeSelectIfNeeded(int currentReading, RenderPressMode pressType) {

src/BaseRenderers.h

@@ -393,6 +393,11 @@ class BaseMenuRenderer : public MenuRenderer, Executable {
      */
     void menuValueToText(MenuItem* item, MenuDrawJustification justification);
 
+    /**
+     * Completely invalidate all drawing and instigate a complete redraw of all elements.
+     */
+    void invalidateAll() { redrawMode = MENUDRAW_COMPLETE_REDRAW; }
+
 protected:
 	/**
 	 * set up a countdown to default back to the submenu

src/MessageProcessors.cpp

@@ -178,6 +178,16 @@ bool processValueChangeField(FieldAndValue* field, MessageProcessorInfo* info) {
 		numItem->setLargeNumberFromString(field->value);
 		serdebugF2("Large num change: ", field->value);
 	}
+    else if(info->value.item->getMenuType() == MENUTYPE_COLOR_VALUE) {
+        auto rgb = reinterpret_cast<Rgb32MenuItem*>(info->value.item);
+        rgb->setColorData(RgbColor32(field->value));
+        serdebugF4("RGB change ", rgb->getUnderlying()->red, rgb->getUnderlying()->green, rgb->getUnderlying()->blue );
+    }
+    else if(info->value.item->getMenuType() == MENUTYPE_SCROLLER_VALUE) {
+        auto sc = reinterpret_cast<ScrollChoiceMenuItem*>(info->value.item);
+        sc->setFromRemote(field->value);
+        serdebugF2("Scroller change ", sc->getCurrentValue());
+    }
     return true;
 }
 

src/RemoteConnector.cpp

@@ -24,6 +24,7 @@
 #include "BaseDialog.h"
 #include "BaseRenderers.h"
 #include "EditableLargeNumberMenuItem.h"
+#include "ScrollChoiceMenuItem.h"
 
 const char PGM_TCM pmemBootStartText[] = "START";
 const char PGM_TCM pmemBootEndText[] = "END";
@@ -324,6 +325,12 @@ void TagValueRemoteConnector::nextBootstrap() {
 	case MENUTYPE_ACTION_VALUE:
 		encodeActionMenu(parentId, (ActionMenuItem*)bootItem);
 		break;
+	case MENUTYPE_COLOR_VALUE:
+	    encodeColorMenuItem(parentId, reinterpret_cast<Rgb32MenuItem*>(bootItem));
+	    break;
+	case MENUTYPE_SCROLLER_VALUE:
+	    encodeScrollMenuItem(parentId, reinterpret_cast<ScrollChoiceMenuItem*>(bootItem));
+	    break;
 	default:
 		break;
 	}
@@ -413,6 +420,31 @@ void TagValueRemoteConnector::encodeAnalogItem(int parentId, AnalogMenuItem* ite
     transport->endMsg();
 }
 
+void TagValueRemoteConnector::encodeScrollMenuItem(int id, ScrollChoiceMenuItem *pItem) {
+    if(!prepareWriteMsg(MSG_BOOT_SCROLL_CHOICE)) return;
+    encodeBaseMenuFields(id, pItem);
+    transport->writeFieldInt(FIELD_NO_CHOICES, pItem->getNumberOfRows());
+    transport->writeFieldInt(FIELD_WIDTH, pItem->getItemWidth());
+    transport->writeFieldInt(FIELD_EDIT_MODE, pItem->getMemMode());
+
+    char sz[32];
+    pItem->copyTransportText(sz, sizeof(sz));
+
+    transport->writeField(FIELD_CURRENT_VAL, sz);
+
+    transport->endMsg();
+}
+
+void TagValueRemoteConnector::encodeColorMenuItem(int id, Rgb32MenuItem *pItem) {
+    if(!prepareWriteMsg(MSG_BOOT_RGB_COLOR)) return;
+    encodeBaseMenuFields(id, pItem);
+    transport->writeFieldInt(FIELD_ALPHA, pItem->isAlphaInUse());
+    char sz[12];
+    pItem->getUnderlying()->asHtmlString(sz, sizeof sz, true);
+    transport->writeField(FIELD_CURRENT_VAL, sz);
+    transport->endMsg();
+}
+
 void TagValueRemoteConnector::encodeLargeNumberMenuItem(int parentId, EditableLargeNumberMenuItem* item) {
 	if (!prepareWriteMsg(MSG_BOOT_LARGENUM)) return;
 	encodeBaseMenuFields(parentId, item);
@@ -545,7 +577,8 @@ void TagValueRemoteConnector::encodeActionMenu(int parentId, ActionMenuItem* ite
 }
 
 void TagValueRemoteConnector::encodeChangeValue(MenuItem* theItem) {
-	if(!prepareWriteMsg(MSG_CHANGE_INT)) return;
+    char sz[32];
+    if(!prepareWriteMsg(MSG_CHANGE_INT)) return;
     transport->writeFieldInt(FIELD_ID, theItem->getId());
     switch(theItem->getMenuType()) {
     case MENUTYPE_ENUM_VALUE:
@@ -558,8 +591,21 @@ void TagValueRemoteConnector::encodeChangeValue(MenuItem* theItem) {
     case MENUTYPE_TIME:
     case MENUTYPE_DATE:
 	case MENUTYPE_LARGENUM_VALUE:
+	case MENUTYPE_COLOR_VALUE: {
+	    auto rgb = reinterpret_cast<Rgb32MenuItem*>(theItem);
+	    rgb->getUnderlying()->asHtmlString(sz, sizeof sz, true);
+	    transport->writeField(FIELD_CURRENT_VAL, sz);
+	    transport->writeFieldInt(FIELD_CHANGE_TYPE, CHANGE_ABSOLUTE);
+	    break;
+	}
+	case MENUTYPE_SCROLLER_VALUE: {
+	    auto sc = reinterpret_cast<ScrollChoiceMenuItem*>(theItem);
+	    sc->copyTransportText(sz, sizeof sz);
+	    transport->writeField(FIELD_CURRENT_VAL, sz);
+	    transport->writeFieldInt(FIELD_CHANGE_TYPE, CHANGE_ABSOLUTE);
+	    break;
+	}
 	case MENUTYPE_TEXT_VALUE: {
-		char sz[20];
 		((RuntimeMenuItem*)theItem)->copyValue(sz, sizeof(sz));
 		transport->writeField(FIELD_CURRENT_VAL, sz);
         transport->writeFieldInt(FIELD_CHANGE_TYPE, CHANGE_ABSOLUTE); // menu host always sends absolute!

src/RemoteConnector.h

@@ -18,6 +18,7 @@
 #include "RuntimeMenuItem.h"
 #include "MessageProcessors.h"
 #include "MenuIterator.h"
+#include "ScrollChoiceMenuItem.h"
 
 #define TAG_VAL_PROTOCOL 0x01
 #define START_OF_MESSAGE 0x01
@@ -327,7 +328,21 @@ class TagValueRemoteConnector {
      */
     void encodeAcknowledgement(uint32_t correlation, AckResponseStatus status);
 
-	/**
+    /**
+     * Encodes a color RGB to the remote as a boot command.
+     * @param id the parent ID
+     * @param pItem the item to be transferred
+     */
+    void encodeColorMenuItem(int id, Rgb32MenuItem *pItem);
+
+    /**
+     * Encodes a scroll choice to the remote as a boot command
+     * @param id parent id
+     * @param pItem the item to be sent
+     */
+    void encodeScrollMenuItem(int id, ScrollChoiceMenuItem *pItem);
+
+    /**
 	 * Called frequently to perform all functions, this is arranged interally by
 	 * registering a taskManager task.
 	 */

src/RemoteTypes.h

@@ -43,7 +43,7 @@ enum AckResponseStatus {
 /**
  * Converts a message field as two separate entities into a single word.
  */
-#define msgFieldToWord(a,b)  ( (((uint16_t)a)<<8) | ((uint16_t)b) )
+#define msgFieldToWord(a,b)  ( (((uint16_t)(a))<<8U) | ((uint16_t)(b)) )
 
 /*
  * Definitions for an unknown field key or part thereof.
@@ -81,6 +81,10 @@ enum AckResponseStatus {
 #define MSG_BOOT_LARGENUM msgFieldToWord('B', 'N')
 /** Message type definition for floating point bootstrap message */
 #define MSG_BOOT_FLOAT msgFieldToWord('B','F')
+/** Message type definition for RGB color bootstrap message */
+#define MSG_BOOT_RGB_COLOR msgFieldToWord('B', 'R')
+/** Message type definition for scroll bootstrap message */
+#define MSG_BOOT_SCROLL_CHOICE msgFieldToWord('B', 'Z')
 /** Message type definition for remote status bootstrap message */
 #define MSG_BOOT_REMOTE msgFieldToWord('B','R')
 /** Message type definition for ip address field bootstrap */
@@ -124,6 +128,8 @@ enum AckResponseStatus {
 #define FIELD_BUFFER      msgFieldToWord('B', 'U')
 #define FIELD_MODE        msgFieldToWord('M', 'O')
 #define FIELD_EDIT_MODE   msgFieldToWord('E', 'M')
+#define FIELD_ALPHA       msgFieldToWord('R', 'A')
+#define FIELD_WIDTH       msgFieldToWord('W', 'I')
 
 #define FIELD_PREPEND_CHOICE 'C'
 #define FIELD_PREPEND_NAMECHOICE 'c'

src/ScrollChoiceMenuItem.cpp

@@ -82,6 +82,21 @@ void ScrollChoiceMenuItem::valueAtPosition(char *buffer, size_t bufferSize, int
     }
 }
 
+void ScrollChoiceMenuItem::copyTransportText(char *buffer, size_t bufferSize) {
+    ltoaClrBuff(buffer, getCurrentValue(), 3, NOT_PADDED, bufferSize);
+    appendChar(buffer, '-', bufferSize);
+    size_t len = strlen(buffer);
+    copyValue(&buffer[len], (int)(bufferSize - len));
+    buffer[bufferSize - 1] = 0;
+}
+
+long parseIntUntilSeparator(const char* ptr, int& offset);
+
+void ScrollChoiceMenuItem::setFromRemote(const char *buffer) {
+    int pos = 0;
+    setCurrentValue((int)parseIntUntilSeparator(buffer, pos));
+}
+
 int enumItemRenderFn(RuntimeMenuItem *item, uint8_t row, RenderFnMode mode, char *buffer, int bufferSize) {
     if (item->getMenuType() != MENUTYPE_SCROLLER_VALUE) return 0;
     auto scrollItem = reinterpret_cast<ScrollChoiceMenuItem*>(item);

src/ScrollChoiceMenuItem.h

@@ -106,10 +106,16 @@ class ScrollChoiceMenuItem : public RuntimeMenuItem {
 
     int getItemWidth() const { return itemSize; }
 
+    EnumMemMode getMemMode() const { return memMode; }
+
     /**
      * @return integer of the current choice
      */
     int getCurrentValue() { return itemPosition; }
+
+    void copyTransportText(char *string, size_t i);
+
+    void setFromRemote(const char* buffer);
 };
 
 /**
@@ -193,7 +199,11 @@ class Rgb32MenuItem : public EditableMultiPartMenuItem<RgbColor32> {
      * copy the color data provided as the latest
      * @param other the new color data
      */
-    void setColorData(const RgbColor32& other) { data = other; }
+    void setColorData(const RgbColor32& other) {
+        data = other;
+        setSendRemoteNeededAll();
+        setChanged(true);
+    }
 
     /**
      * @return true if the alpha channel is in use for this menuitem, otherwise false.

tests/tcMenuCoreTests/ScrollChoiceMenuItemTests.cpp

@@ -68,6 +68,9 @@ test(testValueAtPositionEeeprom) {
 
     choice.valueAtPosition(buffer, sizeof buffer, 2);
     assertStringCaseEqual("", buffer);
+
+    choice.copyTransportText(buffer, sizeof buffer);
+    assertStringCaseEqual("0-computer12", buffer);
 }
 
 bool renderingInvoked = false;
@@ -116,6 +119,9 @@ test(testValueAtPositionCustom) {
     choice.setCurrentValue(1);
     assertTrue(renderingInvoked);
     assertEqual(1, choice.getCurrentValue());
+
+    choice.copyTransportText(buffer, sizeof buffer);
+    assertStringCaseEqual("1-1", buffer);
 }
 
 int colorCbCount = 0;