auto selection of pgm mode if available for board

Author: neu-rah

README.md

@@ -208,7 +208,7 @@ SUBMENU(id)
 
 link in a submenu as option of the current one
 
-**id**: the submenu id
+**id**: of element to be used as a submenu, can be a menu, toggle, select or choose
 
 #### Menu
 ```c++
@@ -227,17 +227,21 @@ define menu structure
 
 **name**: menu name to use as submenu title
 
+## Saving RAM
+
+By default PROGMEM is used on platforms where it is available.
+
 ## Include files
 
-**chainStream.h** - join multiple input stream to be used as one
+**chainStream.h** - join multiple input stream to be used as one, this is used to join quadEncoder stream with a keyboard (encoder button).
 
-**ClickEncoderStream.h** - using encoder https://github.com/0xPIT/encoder
+**ClickEncoderStream.h** - using alternative encoder https://github.com/0xPIT/encoder
 
-**genericKeyboard.h** - use a custom keyboard by providing a reader function.
+**genericKeyboard.h** - make a custom keyboard by providing a reader function.
 
 **keyStream.h** - simple digital keyboard driver doing digitalRead of pins. this driver can miss clicks on heavy load.
 
-**macros.h** - macro definitions to help building complex menu structure (included by menu.h)
+_**macros.h** - macro definitions to help building complex menu structure (included by menu.h)_
 
 **menuFields.h** - allows the menu system to alter/monitor your variables, this file defines the behavior of FIELD, TOGGLE, SELECT and CHOOSE.
 

examples/LCD_Demo/LCD_Demo.ino

@@ -1,4 +1,3 @@
-
 /********************
 Arduino generic menu system
 LCD menu - unsing arduino classic LCD library
@@ -16,8 +15,6 @@ Extensible: Yes
 
 //#define DEBUG
 
-#define USEPGM
-
 #include <HardwareSerial.h>
 #include <LiquidCrystal.h>
 #include <menu.h>//menu macros and objects
@@ -68,16 +65,6 @@ double fps=0;
 unsigned long lastFpsChk=0;
 int counter=0;
 
-void scrSaver() {
-  if (scrSaverEnter) {
-    lcd1.clear();
-    lcd1.print("|www.r-site.net|");
-    lcd1.setCursor(0,1);
-    lcd1.print("|click to enter|");
-    scrSaverEnter=false;
-  }
-}
-
 ///////////////////////////////////////////////////////////////////////////
 //functions to wire as menu actions
 bool pauseMenu() {
@@ -96,6 +83,11 @@ bool ledOff() {
   return false;
 }
 
+bool quit() {
+  Serial.println("Quiting after action call");
+  return true;
+}
+
 /////////////////////////////////////////////////////////////////////////
 // MENU DEFINITION
 // here we define the menu structure and wire actions functions to it
@@ -125,18 +117,40 @@ CHOOSE(chooseTest,chooseMenu,"Choose ",
   VALUE("Last",-1)
 );
 
+MENU(subMenu,"SubMenu"
+  ,OP("A",quit)
+  ,OP("B",quit)
+  ,OP("C",quit)
+  ,OP("D",quit)
+  ,OP("E",quit)
+  ,OP("F",quit)
+  ,OP("G",quit)
+  ,OP("H",quit)
+);
+
 MENU(mainMenu,"Main menu",
   SUBMENU(setLed),
   OP("LED On",ledOn),
   OP("LED Off",ledOff),
   SUBMENU(selMenu),
   SUBMENU(chooseMenu),
+  SUBMENU(subMenu),
   FIELD(percent,"Percent","%",0,100,10,1),
   FIELD(fps,"fps [","]",0,0,0,0),
   FIELD(counter,"counter [","]",0,0,0,0),
   OP("Exit",pauseMenu)
 );
 
+void scrSaver() {
+  if (scrSaverEnter) {
+    lcd1.clear();
+    lcd1.print("|www.r-site.net|");
+    lcd1.setCursor(0,1);
+    lcd1.print("|click to enter|");
+    scrSaverEnter=false;
+  }
+}
+
 //the quadEncoder
 quadEncoder quadEncoder(encA,encB);//simple quad encoder driver
 quadEncoderStream enc(quadEncoder,2);// simple quad encoder fake Stream
@@ -172,8 +186,8 @@ void setup() {
 
   pinMode(LEDPIN,OUTPUT);
 
-  ((prompt*)pgm_read_ptr_near(&mainMenu.data[6]))->enabled=false;
-  ((prompt*)pgm_read_ptr_near(&mainMenu.data[7]))->enabled=false;
+  mainMenu[7].disable();
+  mainMenu[8].disable();
 
   delay(300);
 }

examples/UTFT_menu/UTFT_menu.ino

@@ -16,11 +16,11 @@ UTFT library from:
 UTouch library from:
   http://henningkarlsen.com/electronics/library.php?id=56
 */
-#define DEBUG
+//#define DEBUG
 #include <UTFT.h>
 #include <UTouch.h>
 #ifdef DEBUG
-//#include <streamFlow.h>
+#include <streamFlow.h>
 #endif
 #include <menu.h>
 #include <menuUTFT.h>

src/macros.h

@@ -1,16 +1,15 @@
-#ifdef USEPGM
+//#include <avr/pgmspace.h>
+
+#ifdef pgm_read_ptr_near
   //storing some values into avr flash memory (saving ram space)
-  #include <avr/pgmspace.h>
   #define MEMMODE PROGMEM
   #define pgmPtrNear(addr) pgm_read_ptr_near(addr)
   #define pgmByteNear(addr) (pgm_read_byte_near(addr))
-  //#error USEPGM (just checking)
 #else
   //use ram for non-avr devices
   #define MEMMODE
   #define pgmPtrNear(addr) (addr)
-  #define pgmByteNear(addr) (*(uint8_t*)addr)
-  #error NO USEPGM (this mem mode is under development)
+  #define pgmByteNear(addr) (*addr)
 #endif
 
 class prompt;

src/menu.cpp

@@ -16,6 +16,13 @@ v2.0 mods - calling action on every element
 #include <Arduino.h>
 #include "menu.h"
 
+//#define DEBUG
+#ifdef DEBUG
+#include <streamFlow.h>
+#include <menuPrint.h>
+menuPrint debugOut(Serial);
+#endif
+
 const char menu::exit[] MEMMODE="Exit";
 char menu::escCode='/';
 char menu::enterCode='*';
@@ -54,10 +61,16 @@ int menu::menuKeys(menuOut &p,Stream& c,bool canExit) {
       if (sel<0) {
         if (wrapMenus) {
           sel=sz-(canExit?0:1);
-          if (sel+1>=p.maxY) p.top=sel-p.maxY+1;
+          if (sel+1>=p.maxY) {
+            p.top=sel-p.maxY+1;
+            Serial<<"menuKeys top1:"<<p.top<<endl;
+          }
         } else sel=0;
       }
-      if (p.top>sel) p.top=sel;
+      if (p.top>sel) {
+        p.top=sel;
+        Serial<<"menuKeys top2:"<<p.top<<endl;
+      }
     } else if (ch==menu::upCode) {
       sel++;
       if (sel>(sz-(canExit?0:1))) {
@@ -66,7 +79,10 @@ int menu::menuKeys(menuOut &p,Stream& c,bool canExit) {
           p.top=0;
         } else sel=sz-(canExit?0:1);
       }
-      if (sel+1>p.maxY) p.top=sel-p.maxY+1;
+      if (sel+1-p.top>p.maxY) {
+        p.top=sel-p.maxY+1;
+        Serial<<"menuKeys top3:"<<p.top<<endl;
+      }
     } else if (ch==menu::escCode) {
     	op=-1;
     } else {
@@ -106,6 +122,10 @@ promptFeedback menu::activate(menuOut& p,Stream& c,bool canExit) {
       if (cp->activate(p,c,true)) {
         p.clear();
       	activeNode=previousMenu;
+        //print_P(debugOut,this->text);
+        //Serial<<"->";
+        //print_P(debugOut,this->operator[](sel).text);
+        //Serial<<" quiting... "<<p.lastSel<<endl;
         return true;
       }
     }

src/menu.h

@@ -25,9 +25,6 @@ v2.1 - Add full support of SetPosition(x,y) to move the menu inside the screen (
 #ifndef RSITE_ARDUINO_MENU_SYSTEM
   #define RSITE_ARDUINO_MENU_SYSTEM
 
-  //PGM activated by default, non pgm mode is not working ok
-  #define USEPGM
-
 	#include <Stream.h>
 	#include <HardwareSerial.h>
 
@@ -119,13 +116,15 @@ v2.1 - Add full support of SetPosition(x,y) to move the menu inside the screen (
 	//a menu is also a prompt so we can have sub-menus
   class prompt {
     public:
-    const char* text MEMMODE;
+    const char* text;// MEMMODE; memmode is defined by the source, here its only a pointer
     promptAction action;
     static promptFeedback nothing() {return false;}
     bool enabled;
     inline prompt(const char * text):text(text),enabled(true),action(nothing) {}
     inline prompt(const char * text,promptAction action)
     	:text(text),action(action),enabled(true) {}
+    inline void enable() {enabled=true;}
+    inline void disable() {enabled=false;}
     virtual void printTo(menuOut& p) {
 			//p.print(text);
       print_P(p,text);
@@ -170,11 +169,13 @@ v2.1 - Add full support of SetPosition(x,y) to move the menu inside the screen (
     bool canExit;//store last canExit value for inner reference
     menu(const char * text,int sz,prompt* const data[]):menuNode(text),sz(sz),data(data),canExit(false) {}
 
+    inline prompt& operator[](int i) {return *(prompt*)pgmPtrNear(&data[i]);}
     inline void setPosition(int x,int y) {ox=x;oy=y;}
     int menuKeys(menuOut &p,Stream& c,bool drawExit);
-    inline void printMenu(menuOut& p,bool drawExit) {
+    inline void printMenu(menuOut& p,bool drawExit=false) {
     	p.printMenu(*this,drawExit);
     }
+    //virtual bool needRedraw(menuOut& o,bool) {return o.drawn!=true;}
     //force menu redraw on selected device
     inline void redraw(menuOut& p,Stream& c,bool canExit=false) {p.drawn=NULL;poll(p,c,canExit);}
     //set the focus to menu->Option idx, the focused menu will exit to the current

src/menuLCD.h

@@ -39,8 +39,8 @@ www.r-site.net
 		}
 		virtual void printMenu(menu& m,bool drawExit) {
 			if (drawn!=&m) clear();//clear screen when changing menu
-			if (m.sel-top>=maxY) top=m.sel-maxY+1;//selected option outside device (bottom)
-			else if (m.sel<top) top=m.sel;//selected option outside device (top)
+			if (m.sel<top) top=m.sel;//selected option outside device (top)
+			else if (m.sel-top>=maxY) top=m.sel-maxY+1;//selected option outside device (bottom)
 			int i=0;for(;i<m.sz;i++) {
 				if ((i>=top)&&((i-top)<maxY)) {
 				  if (needRedraw(m,i)) {

src/menuU8G.h

@@ -80,11 +80,13 @@ www.r-site.net
         o.printTo(*this);
     }
 		virtual void printMenu(menu& m,bool drawExit) {
-      //if (drawn!=&m) clear();//clear all screen when changing menu - not ok for U8Glib
-  		if (m.sel-top >= maxY)
-        top = m.sel - maxY + resY + 1; //selected option outside device (bottom)
-			else if (m.sel < top)
-        top = m.sel + resY; //selected option outside device (top)
+			//Serial<<"printing menu "<<m<<" top:"<<top<<endl;
+			//Serial<<*menu::activeNode<<" <-> "<<*drawn<<endl;
+			if (m.sel < top) {
+				top = m.sel;//+ resY; //selected option outside device (top)
+			} else if (m.sel-top >= maxY) {
+        top = m.sel - maxY + 1;//resY-1; //selected option outside device (bottom)
+			}
       int i = top;
       for (; i < m.sz; i++) {
 			  if (i-top >= maxY) break;
@@ -96,6 +98,7 @@ www.r-site.net
 				printPrompt(menu::exitOption,m.sel==m.sz,0,m.ox,(i-top)+m.oy,m.width);
 			lastTop = top;
 			lastSel = m.sel;
+			//Serial<<"menuU8G::printMenu top:"<<top<<endl;
 			//drawn=&m;  // if commented, equals to have gfx.redraw() in loop - not ok for U8Glib
 		}
   };