userMenu exit option

Author: neu-rah

examples/targetSel/platformio.ini

@@ -1,22 +1,23 @@
 [platformio]
 src_dir=targetSel
 
-[env:seeeduino_lorawan]
-board=seeeduino_lorawan
-platform = atmelsam
-framework = arduino
-build_flags =
-  -DMENU_DEBUG
-
-; [env:nanoatmega328]
-; platform = atmelavr
-; board = nanoatmega328new
+; [env:seeeduino_lorawan]
+; board=seeeduino_lorawan
+; platform = atmelsam
 ; framework = arduino
-; ; upload_port=/dev/ttyUSB1
-; upload_flags=-V
 ; build_flags =
 ;   -DMENU_DEBUG
-;   -Wno-strict-aliasing -Wno-sign-compare -Wno-write-strings
+
+[env:nanoatmega328]
+platform = atmelavr
+board = nanoatmega328
+; board = nanoatmega328new
+framework = arduino
+; upload_port=/dev/ttyUSB1
+upload_flags=-V
+build_flags =
+  -DMENU_DEBUG
+  -Wno-strict-aliasing -Wno-sign-compare -Wno-write-strings
 
 ; [env:esp12e]
 ; platform = espressif8266

examples/targetSel/targetSel/targetSel.ino

@@ -51,8 +51,8 @@ Data myTargets[dataSz];//our data
 Data target;
 
 //characters allowed on name field
-char* constMEM alphaNum MEMMODE=" 0123456789.ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz,\\|!\"#$%&/()=?~*^+-{}[]€";
-char* constMEM alphaNumMask[] MEMMODE={alphaNum};
+const char* constMEM alphaNum MEMMODE=" 0123456789.ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz,\\|!\"#$%&/()=?~*^+-{}[]€";
+const char* constMEM alphaNumMask[] MEMMODE={alphaNum};
 
 //some enumeration of values allowed on some fields
 TOGGLE(target.valid,editValid,"Valid: ",doNothing,noEvent,noStyle//,doExit,enterEvent,noStyle
@@ -75,8 +75,9 @@ CHOOSE(target.chooseTest,chooseMenu,"Choose",doNothing,noEvent,noStyle
 
 //a function to save the edited data record
 result saveTarget(eventMask e,navNode& nav) {
-  _trace(MENU_DEBUG_OUT<<"saveTarget"<<endl);
-  idx_t n=nav.root->path[nav.root->level-1].sel;//get selection of previous level
+  trace(MENU_DEBUG_OUT<<"saveTarget"<<endl);
+  navNode& nn=nav.root->path[nav.root->level-1];
+  idx_t n=nn.sel;//get selection of previous level
   myTargets[n]=target;
   return quit;
 }
@@ -94,19 +95,15 @@ MENU(targetEdit,"Target edit",doNothing,noEvent,wrapStyle
 
 //handling the user menu selection
 //this will copy the selected recotd into the temp var
-result targetEvent(eventMask e,navNode& nav) {
-  _trace(MENU_DEBUG_OUT<<"copy data to temp.\n");
-  target=myTargets[nav.sel];
-  //you can store nav.sel for future reference
-  return proceed;
-}
+result targetEvent(eventMask e,navNode& nav);
 
 //the customized print of records
 //menu system wil use this to print the list of all records
 struct TargetMenu:UserMenu{
   using UserMenu::UserMenu;
 
   // override sz() function to have variable/custom size
+  // if using exit option the an extra element has to be considered...
   // inline idx_t sz() const override {return 0;}
 
   //customizing the print of user menu item (len is the availabe space)
@@ -120,7 +117,8 @@ struct TargetMenu:UserMenu{
 //build the user menu object, optionally giving a sub menu
 #ifdef MENU_USERAM
   //for non-AVR devices or when MENU_USERAM is defined at compiler level
-  TargetMenu targetsMenu("Targets",dataSz,targetEdit,targetEvent,enterEvent);
+  TargetMenu targetsMenu("Targets",dataSz,"<Back",targetEdit,targetEvent,enterEvent);
+  // TargetMenu targetsMenu("Targets",dataSz,targetEdit,targetEvent,enterEvent);//no exit option
 #else
   //menu allocation compatible with AVR flash ---------------------------------
   constMEM char targetsMenuTitle[] MEMMODE="Targets";
@@ -134,14 +132,23 @@ struct TargetMenu:UserMenu{
     NULL
   };
   constMEM menuNodeShadow& targetsMenuInfo=*(menuNodeShadow*)&targetsMenuInfoRaw;
-  TargetMenu targetsMenu(targetsMenuInfo,targetEdit);
+  TargetMenu targetsMenu(targetsMenuInfo,targetEdit,"<Back");
+  // TargetMenu targetsMenu(targetsMenuInfo,targetEdit);//no exit option
 #endif
 
 MENU(mainMenu,"Main menu",doNothing,noEvent,wrapStyle
   ,OBJ(targetsMenu)//attach the array edit menu on a macri build nenu
   ,EXIT("<Back")
 );
 
+result targetEvent(eventMask e,navNode& nav) {
+  trace(MENU_DEBUG_OUT<<"copy data to temp target:"<<(int)nav.target<<"\n");
+  if(nav.target==&targetsMenu)//only if we are on targetsMenu
+    target=myTargets[nav.sel];
+  //you can store nav.sel for future reference
+  return proceed;
+}
+
 //////////////////////////////////////////////////////////////////////////////
 // menu IO and root navigation control
 

library.properties

@@ -1,5 +1,5 @@
 name=ArduinoMenu library
-version=4.21.2
+version=4.21.3
 author=Rui Azevedo, [email protected]
 maintainer=neu-rah, [email protected]
 sentence=Generic menu/interactivity system

src/items.h

@@ -246,7 +246,7 @@
     class menuNode:public navTarget {
       public:
         inline menuNode(constMEM menuNodeShadow& s):navTarget(s) {}
-        inline menuNode(constText* text,idx_t sz,prompt* constMEM data[],action a=noAction,eventMask e=noEvent,styles style=wrapStyle,systemStyles ss=(systemStyles)(_menuData|_canNav))
+        inline menuNode(const char* text,idx_t sz,prompt* constMEM data[],action a=noAction,eventMask e=noEvent,styles style=wrapStyle,systemStyles ss=(systemStyles)(_menuData|_canNav))
           :navTarget(*new menuNodeShadow(text,sz,data,a,e,style,ss)) {}
         #ifdef MENU_FMT_WRAPS
           virtual classes type() const;

src/macros.h

@@ -45,7 +45,7 @@
   #define USING_RAM
   #define MEMMODE
   #define constMEM
-  #define constText char
+  #define constText const char
   #define memPtr(src) (src)
   #define memByte(addr) (*addr)
   #define memWord(addr) (*addr)

src/plugin/userMenu.h

@@ -16,35 +16,54 @@ namespace Menu {
   class UserMenu:public menuNode {
   public:
     menu* subMenu=NULL;
-    UserMenu(constMEM menuNodeShadow& shadow):menuNode(shadow) {}
-    UserMenu(constMEM menuNodeShadow& shadow,menu& subMenu):menuNode(shadow),subMenu(&subMenu) {}
-    UserMenu(constText* text,idx_t size,menu& subMenu,action a=noAction,eventMask e=noEvent,styles style=wrapStyle)
+    const char*backTitle=NULL;
+    UserMenu(constMEM menuNodeShadow& shadow,const char*backTitle=NULL)
+      :menuNode(shadow),backTitle(backTitle) {}
+    UserMenu(constMEM menuNodeShadow& shadow,menu& subMenu,const char*backTitle=NULL)
+      :menuNode(shadow),subMenu(&subMenu),backTitle(backTitle) {}
+    UserMenu(const char* text,idx_t size,menu& subMenu,action a=noAction,eventMask e=noEvent,styles style=wrapStyle)
       :menuNode(text,size,NULL,a,e,style,(systemStyles)(_menuData|_canNav)),subMenu(&subMenu) {}
+    UserMenu(const char* text,idx_t size,const char*backTitle,menu& subMenu,action a=noAction,eventMask e=noEvent,styles style=wrapStyle)
+      :menuNode(text,size,NULL,a,e,style,(systemStyles)(_menuData|_canNav)),subMenu(&subMenu),backTitle(backTitle) {}
+
+      inline idx_t sz() const override {return menuNode::sz()+(backTitle?1:0);}
 
     prompt& operator[](idx_t i) const override {return *(prompt*)this;}
     virtual Used printItem(menuOut& out, int idx,int len)=0;
     Used printTo(navRoot &root,bool sel,menuOut& out, idx_t idx,idx_t len,idx_t p) override {
       if(root.navFocus!=this) return menuNode::printTo(root,sel,out,idx,len,p);
-      return idx<0?
-        menuNode::printTo(root,sel,out,idx,len,p)://print the title
-        printItem(out,out.tops[root.level]+idx,len);
+      if(idx<0) return menuNode::printTo(root,sel,out,idx,len,p);//print the title
+      if(backTitle&&idx==sz()-1) return out.printText(backTitle,len);
+      trace(MENU_DEBUG_OUT<<"{"<<idx<<"}");
+      return printItem(out,out.tops[root.level]+idx/*-(backTitle?1:0)*/,len);
     }
     void doNav(navNode& nav,navCmd cmd) {
-      if(nav.root->navFocus==this&&cmd.cmd==enterCmd) {
-        _trace(MENU_DEBUG_OUT<<"no sub levels! submenu:"<<(subMenu?"yes":"no")<<" level:"<<nav.root->level<<"\n");
-        //just send the event, but do not open (as this menu is representing the item)
-        // nav.root->path[nav.root->level-1].event(enterEvent);
-        // nav.event(enterEvent);
-        // if(enterEvent&&) operator()(enterEvent, nav, *this);
-        nav.event(enterEvent);
-        if(subMenu) {
-          assert(nav.root->level<nav.root->maxDepth);
-          nav.root->active().dirty=true;
-          nav.root->level++;
-          nav.root->navFocus=nav.root->node().target=subMenu;
-          nav.root->node().sel=0;
+      if(nav.root->navFocus==this) {
+        trace(MENU_DEBUG_OUT<<" submenu:"<<(subMenu?"yes":"no")<<" level:"<<nav.root->level<<"\n");
+        switch (cmd.cmd) {
+          case selCmd:
+          case idxCmd:
+            trace(MENU_DEBUG_OUT<<"idxCmd "<<cmd.param<<endl);
+            nav.sel=cmd.param;
+          case enterCmd:
+            _trace(MENU_DEBUG_OUT<<"enterCmd");
+            if(backTitle&&nav.sel==sz()-1) nav.root->exit();
+            else {
+              nav.event(enterEvent);
+              if(subMenu) {
+                _trace(MENU_DEBUG_OUT<<"edit item");
+                assert(nav.root->level<nav.root->maxDepth);
+                nav.root->active().dirty=true;
+                nav.root->level++;
+                nav.root->navFocus=nav.root->node().target=subMenu;
+                nav.root->node().sel=0;
+              }
+            }
+            return;
+          default:break;
         }
-      } else menuNode::doNav(nav,cmd);
+      }
+      menuNode::doNav(nav,cmd);
     }
   };
 

src/shadows.h

@@ -85,7 +85,7 @@
         idx_t sz;
         prompt* constMEM* data;
       public:
-        menuNodeShadow(constText* text,idx_t sz,prompt* constMEM* data,action a,eventMask e,styles style,systemStyles ss=(systemStyles)(_menuData|_canNav))
+        menuNodeShadow(const char* text,idx_t sz,prompt* constMEM* data,action a,eventMask e,styles style,systemStyles ss=(systemStyles)(_menuData|_canNav))
         :promptShadow(text,a,e,style,ss),sz(sz),data(data) {}
         idx_t _sz() const {return (idx_t)memIdx(sz);}
         prompt* constMEM* _data() const {return (prompt* constMEM*)memPtr(data);}