menu.cpp 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548
  1. //menu.cpp
  2. #include "menu.h"
  3. #include <stdio.h>
  4. #include <string.h>
  5. #include <stdarg.h>
  6. #include <avr/pgmspace.h>
  7. #include "lcd.h"
  8. #include "Configuration.h"
  9. #include "Marlin.h"
  10. #include "ultralcd.h"
  11. #include "language.h"
  12. #include "static_assert.h"
  13. #include "sound.h"
  14. extern int32_t lcd_encoder;
  15. #define MENU_DEPTH_MAX 7
  16. static menu_record_t menu_stack[MENU_DEPTH_MAX];
  17. uint8_t menu_data[MENU_DATA_SIZE];
  18. #ifndef __AVR__
  19. #error "menu_data is non-portable to non 8bit processor"
  20. #endif
  21. uint8_t menu_depth = 0;
  22. uint8_t menu_block_entering_on_serious_errors = SERIOUS_ERR_NONE;
  23. uint8_t menu_line = 0;
  24. uint8_t menu_item = 0;
  25. uint8_t menu_row = 0;
  26. uint8_t menu_top = 0;
  27. uint8_t menu_clicked = 0;
  28. uint8_t menu_leaving = 0;
  29. menu_func_t menu_menu = 0;
  30. static_assert(sizeof(menu_data)>= sizeof(menu_data_edit_t),"menu_data_edit_t doesn't fit into menu_data");
  31. void menu_goto(menu_func_t menu, const uint32_t encoder, const bool feedback, bool reset_menu_state)
  32. {
  33. CRITICAL_SECTION_START;
  34. if (menu_menu != menu)
  35. {
  36. menu_menu = menu;
  37. lcd_encoder = encoder;
  38. CRITICAL_SECTION_END;
  39. if (reset_menu_state)
  40. {
  41. // Resets the global shared C union.
  42. // This ensures, that the menu entered will find out, that it shall initialize itself.
  43. memset(&menu_data, 0, sizeof(menu_data));
  44. }
  45. if (feedback) lcd_quick_feedback();
  46. }
  47. else
  48. CRITICAL_SECTION_END;
  49. }
  50. void menu_start(void)
  51. {
  52. if (lcd_encoder > 0x8000) lcd_encoder = 0;
  53. if (lcd_encoder < 0)
  54. {
  55. lcd_encoder = 0;
  56. Sound_MakeSound(e_SOUND_TYPE_BlindAlert);
  57. }
  58. if (lcd_encoder < menu_top)
  59. menu_top = lcd_encoder;
  60. menu_line = menu_top;
  61. menu_clicked = LCD_CLICKED;
  62. }
  63. void menu_end(void)
  64. {
  65. if (lcd_encoder >= menu_item)
  66. {
  67. lcd_encoder = menu_item - 1;
  68. Sound_MakeSound(e_SOUND_TYPE_BlindAlert);
  69. }
  70. if (((uint8_t)lcd_encoder) >= menu_top + LCD_HEIGHT)
  71. {
  72. menu_top = lcd_encoder - LCD_HEIGHT + 1;
  73. lcd_draw_update = 1;
  74. menu_line = menu_top - 1;
  75. menu_row = -1;
  76. }
  77. }
  78. void menu_back(uint8_t nLevel)
  79. {
  80. menu_depth = ((menu_depth > nLevel) ? (menu_depth - nLevel) : 0);
  81. menu_goto(menu_stack[menu_depth].menu, menu_stack[menu_depth].position, true, true);
  82. }
  83. void menu_back(void)
  84. {
  85. menu_back(1);
  86. }
  87. void menu_back_no_reset(void)
  88. {
  89. if (menu_depth > 0)
  90. {
  91. menu_depth--;
  92. menu_goto(menu_stack[menu_depth].menu, menu_stack[menu_depth].position, true, false);
  93. }
  94. }
  95. void menu_back_if_clicked(void)
  96. {
  97. if (lcd_clicked())
  98. menu_back();
  99. }
  100. void menu_back_if_clicked_fb(void)
  101. {
  102. if (lcd_clicked())
  103. {
  104. lcd_quick_feedback();
  105. menu_back();
  106. }
  107. }
  108. void menu_submenu(menu_func_t submenu)
  109. {
  110. if (menu_depth < MENU_DEPTH_MAX)
  111. {
  112. menu_stack[menu_depth].menu = menu_menu;
  113. menu_stack[menu_depth++].position = lcd_encoder;
  114. menu_goto(submenu, 0, true, true);
  115. }
  116. }
  117. void menu_submenu_no_reset(menu_func_t submenu)
  118. {
  119. if (menu_depth < MENU_DEPTH_MAX)
  120. {
  121. menu_stack[menu_depth].menu = menu_menu;
  122. menu_stack[menu_depth++].position = lcd_encoder;
  123. menu_goto(submenu, 0, true, false);
  124. }
  125. }
  126. uint8_t menu_item_ret(void)
  127. {
  128. lcd_beeper_quick_feedback();
  129. lcd_draw_update = 2;
  130. lcd_button_pressed = false;
  131. return 1;
  132. }
  133. /*
  134. int menu_draw_item_printf_P(char type_char, const char* format, ...)
  135. {
  136. va_list args;
  137. va_start(args, format);
  138. int ret = 0;
  139. lcd_set_cursor(0, menu_row);
  140. if (lcd_encoder == menu_item)
  141. lcd_print('>');
  142. else
  143. lcd_print(' ');
  144. int cnt = vfprintf_P(lcdout, format, args);
  145. for (int i = cnt; i < 18; i++)
  146. lcd_print(' ');
  147. lcd_print(type_char);
  148. va_end(args);
  149. return ret;
  150. }
  151. */
  152. static char menu_selection_mark(){
  153. return (lcd_encoder == menu_item)?'>':' ';
  154. }
  155. static void menu_draw_item_puts_P(char type_char, const char* str)
  156. {
  157. lcd_set_cursor(0, menu_row);
  158. lcd_printf_P(PSTR("%c%-18.18S%c"), menu_selection_mark(), str, type_char);
  159. }
  160. static void menu_draw_toggle_puts_P(const char* str, const char* toggle, const uint8_t settings)
  161. {
  162. //settings:
  163. //xxxxxcba
  164. //a = selection mark. If it's set(1), then '>' will be used as the first character on the line. Else leave blank
  165. //b = toggle string is from progmem
  166. //c = do not set cursor at all. Must be handled externally.
  167. char lineStr[LCD_WIDTH + 1];
  168. const char eol = (toggle == NULL)?LCD_STR_ARROW_RIGHT[0]:' ';
  169. if (toggle == NULL) toggle = _T(MSG_NA);
  170. sprintf_P(lineStr, PSTR("%c%-18.18S"), (settings & 0x01)?'>':' ', str);
  171. sprintf_P(lineStr + LCD_WIDTH - ((settings & 0x02)?strlen_P(toggle):strlen(toggle)) - 3, (settings & 0x02)?PSTR("[%S]%c"):PSTR("[%s]%c"), toggle, eol);
  172. if (!(settings & 0x04)) lcd_set_cursor(0, menu_row);
  173. fputs(lineStr, lcdout);
  174. }
  175. //! @brief Format sheet name
  176. //!
  177. //! @param[in] sheet_E Sheet in EEPROM
  178. //! @param[out] buffer for formatted output
  179. void menu_format_sheet_E(const Sheet &sheet_E, SheetFormatBuffer &buffer)
  180. {
  181. uint_least8_t index = sprintf_P(buffer.c, PSTR("%.10S "), _T(MSG_SHEET));
  182. eeprom_read_block(&(buffer.c[index]), sheet_E.name, 7);
  183. //index += 7;
  184. buffer.c[index + 7] = '\0';
  185. }
  186. //! @brief Format sheet name in select menu
  187. //!
  188. //! @param[in] sheet_E Sheet in EEPROM
  189. //! @param[out] buffer for formatted output
  190. void menu_format_sheet_select_E(const Sheet &sheet_E, SheetFormatBuffer &buffer)
  191. {
  192. uint_least8_t index = sprintf_P(buffer.c,PSTR("%-9.9S["), _T(MSG_SHEET));
  193. eeprom_read_block(&(buffer.c[index]), sheet_E.name, sizeof(sheet_E.name)/sizeof(sheet_E.name[0]));
  194. for (const uint_least8_t start = index; static_cast<uint_least8_t>(index - start) < sizeof(sheet_E.name)/sizeof(sheet_E.name[0]); ++index)
  195. {
  196. if (buffer.c[index] == '\0') break;
  197. }
  198. buffer.c[index] = ']';
  199. buffer.c[index + 1] = '\0';
  200. }
  201. static void menu_draw_item_select_sheet_E(char type_char, const Sheet &sheet)
  202. {
  203. lcd_set_cursor(0, menu_row);
  204. SheetFormatBuffer buffer;
  205. menu_format_sheet_select_E(sheet, buffer);
  206. lcd_printf_P(PSTR("%c%-18.18s%c"), menu_selection_mark(), buffer.c, type_char);
  207. }
  208. static void menu_draw_item_puts_E(char type_char, const Sheet &sheet)
  209. {
  210. lcd_set_cursor(0, menu_row);
  211. SheetFormatBuffer buffer;
  212. menu_format_sheet_E(sheet, buffer);
  213. lcd_printf_P(PSTR("%c%-18.18s%c"), menu_selection_mark(), buffer.c, type_char);
  214. }
  215. static void menu_draw_item_puts_P(char type_char, const char* str, char num)
  216. {
  217. lcd_set_cursor(0, menu_row);
  218. lcd_printf_P(PSTR("%c%-.16S "), menu_selection_mark(), str);
  219. lcd_putc(num);
  220. lcd_set_cursor(19, menu_row);
  221. lcd_putc(type_char);
  222. }
  223. /*
  224. int menu_draw_item_puts_P_int16(char type_char, const char* str, int16_t val, )
  225. {
  226. lcd_set_cursor(0, menu_row);
  227. int cnt = lcd_printf_P(PSTR("%c%-18S%c"), (lcd_encoder == menu_item)?'>':' ', str, type_char);
  228. return cnt;
  229. }
  230. */
  231. void menu_item_dummy(void)
  232. {
  233. menu_item++;
  234. }
  235. uint8_t menu_item_text_P(const char* str)
  236. {
  237. if (menu_item == menu_line)
  238. {
  239. if (lcd_draw_update) menu_draw_item_puts_P(' ', str);
  240. if (menu_clicked && (lcd_encoder == menu_item))
  241. return menu_item_ret();
  242. }
  243. menu_item++;
  244. return 0;
  245. }
  246. uint8_t menu_item_submenu_P(const char* str, menu_func_t submenu)
  247. {
  248. if (menu_item == menu_line)
  249. {
  250. if (lcd_draw_update) menu_draw_item_puts_P(LCD_STR_ARROW_RIGHT[0], str);
  251. if (menu_clicked && (lcd_encoder == menu_item))
  252. {
  253. menu_submenu(submenu);
  254. return menu_item_ret();
  255. }
  256. }
  257. menu_item++;
  258. return 0;
  259. }
  260. uint8_t menu_item_submenu_E(const Sheet &sheet, menu_func_t submenu)
  261. {
  262. if (menu_item == menu_line)
  263. {
  264. if (lcd_draw_update) menu_draw_item_puts_E(LCD_STR_ARROW_RIGHT[0], sheet);
  265. if (menu_clicked && (lcd_encoder == menu_item))
  266. {
  267. menu_submenu(submenu);
  268. return menu_item_ret();
  269. }
  270. }
  271. menu_item++;
  272. return 0;
  273. }
  274. uint8_t menu_item_function_E(const Sheet &sheet, menu_func_t func)
  275. {
  276. if (menu_item == menu_line)
  277. {
  278. if (lcd_draw_update) menu_draw_item_select_sheet_E(' ', sheet);
  279. if (menu_clicked && (lcd_encoder == menu_item))
  280. {
  281. menu_clicked = false;
  282. lcd_consume_click();
  283. lcd_update_enabled = 0;
  284. if (func) func();
  285. lcd_update_enabled = 1;
  286. return menu_item_ret();
  287. }
  288. }
  289. menu_item++;
  290. return 0;
  291. }
  292. uint8_t menu_item_back_P(const char* str)
  293. {
  294. if (menu_item == menu_line)
  295. {
  296. if (lcd_draw_update) menu_draw_item_puts_P(LCD_STR_UPLEVEL[0], str);
  297. if (menu_clicked && (lcd_encoder == menu_item))
  298. {
  299. menu_back();
  300. return menu_item_ret();
  301. }
  302. }
  303. menu_item++;
  304. return 0;
  305. }
  306. uint8_t menu_item_function_P(const char* str, menu_func_t func)
  307. {
  308. if (menu_item == menu_line)
  309. {
  310. if (lcd_draw_update) menu_draw_item_puts_P(' ', str);
  311. if (menu_clicked && (lcd_encoder == menu_item))
  312. {
  313. menu_clicked = false;
  314. lcd_consume_click();
  315. lcd_update_enabled = 0;
  316. if (func) func();
  317. lcd_update_enabled = 1;
  318. return menu_item_ret();
  319. }
  320. }
  321. menu_item++;
  322. return 0;
  323. }
  324. //! @brief Menu item function taking single parameter
  325. //!
  326. //! Ideal for numbered lists calling functions with number parameter.
  327. //! @param str Item caption
  328. //! @param number aditional character to be added after str, e.g. number
  329. //! @param func pointer to function taking uint8_t with no return value
  330. //! @param fn_par value to be passed to function
  331. //! @retval 0
  332. //! @retval 1 Item was clicked
  333. uint8_t menu_item_function_P(const char* str, char number, void (*func)(uint8_t), uint8_t fn_par)
  334. {
  335. if (menu_item == menu_line)
  336. {
  337. if (lcd_draw_update) menu_draw_item_puts_P(' ', str, number);
  338. if (menu_clicked && (lcd_encoder == menu_item))
  339. {
  340. menu_clicked = false;
  341. lcd_consume_click();
  342. lcd_update_enabled = 0;
  343. if (func) func(fn_par);
  344. lcd_update_enabled = 1;
  345. return menu_item_ret();
  346. }
  347. }
  348. menu_item++;
  349. return 0;
  350. }
  351. uint8_t menu_item_toggle_P(const char* str, const char* toggle, menu_func_t func, const uint8_t settings)
  352. {
  353. if (menu_item == menu_line)
  354. {
  355. if (lcd_draw_update) menu_draw_toggle_puts_P(str, toggle, settings | (menu_selection_mark()=='>'));
  356. if (menu_clicked && (lcd_encoder == menu_item))
  357. {
  358. if (toggle == NULL) // print N/A warning message
  359. {
  360. menu_submenu(func);
  361. return menu_item_ret();
  362. }
  363. else // do the actual toggling
  364. {
  365. menu_clicked = false;
  366. lcd_consume_click();
  367. lcd_update_enabled = 0;
  368. if (func) func();
  369. lcd_update_enabled = 1;
  370. return menu_item_ret();
  371. }
  372. }
  373. }
  374. menu_item++;
  375. return 0;
  376. }
  377. uint8_t menu_item_gcode_P(const char* str, const char* str_gcode)
  378. {
  379. if (menu_item == menu_line)
  380. {
  381. if (lcd_draw_update) menu_draw_item_puts_P(' ', str);
  382. if (menu_clicked && (lcd_encoder == menu_item))
  383. {
  384. if (str_gcode) enquecommand_P(str_gcode);
  385. return menu_item_ret();
  386. }
  387. }
  388. menu_item++;
  389. return 0;
  390. }
  391. const char menu_fmt_int3[] PROGMEM = "%c%.15S:%s%3d";
  392. const char menu_fmt_float31[] PROGMEM = "%-12.12S%+8.1f";
  393. const char menu_fmt_float13[] PROGMEM = "%c%-13.13S%+5.3f";
  394. template<typename T>
  395. static void menu_draw_P(char chr, const char* str, int16_t val);
  396. template<>
  397. void menu_draw_P<int16_t*>(char chr, const char* str, int16_t val)
  398. {
  399. int text_len = strlen_P(str);
  400. if (text_len > 15) text_len = 15;
  401. char spaces[LCD_WIDTH + 1] = {0};
  402. memset(spaces,' ', LCD_WIDTH);
  403. if (val <= -100) spaces[15 - text_len - 1] = 0;
  404. else spaces[15 - text_len] = 0;
  405. lcd_printf_P(menu_fmt_int3, chr, str, spaces, val);
  406. }
  407. template<>
  408. void menu_draw_P<uint8_t*>(char chr, const char* str, int16_t val)
  409. {
  410. menu_data_edit_t* _md = (menu_data_edit_t*)&(menu_data[0]);
  411. float factor = 1.0f + static_cast<float>(val) / 1000.0f;
  412. if (val <= _md->minEditValue)
  413. {
  414. menu_draw_toggle_puts_P(str, _T(MSG_OFF), 0x04 | 0x02 | (chr=='>'));
  415. }
  416. else
  417. {
  418. lcd_printf_P(menu_fmt_float13, chr, str, factor);
  419. }
  420. }
  421. //! @brief Draw up to 10 chars of text and a float number in format from +0.0 to +12345.0. The increased range is necessary
  422. //! for displaying large values of extruder positions, which caused text overflow in the previous implementation.
  423. //!
  424. //! @param str string label to print
  425. //! @param val value to print aligned to the right side of the display
  426. //!
  427. //! Implementation comments:
  428. //! The text needs to come with a colon ":", this function does not append it anymore.
  429. //! That resulted in a much shorter implementation (234628B -> 234476B)
  430. //! There are similar functions around which may be shortened in a similar way
  431. void menu_draw_float31(const char* str, float val)
  432. {
  433. lcd_printf_P(menu_fmt_float31, str, val);
  434. }
  435. //! @brief Draw up to 14 chars of text and a float number in format +1.234
  436. //!
  437. //! @param str string label to print
  438. //! @param val value to print aligned to the right side of the display
  439. //!
  440. //! Implementation comments:
  441. //! This function uses similar optimization principles as menu_draw_float31
  442. //! (i.e. str must include a ':' at its end)
  443. //! FLASH usage dropped 234476B -> 234392B
  444. //! Moreover, this function gets inlined in the final code, so removing it doesn't really help ;)
  445. void menu_draw_float13(const char* str, float val)
  446. {
  447. lcd_printf_P(menu_fmt_float13, ' ', str, val);
  448. }
  449. template <typename T>
  450. static void _menu_edit_P(void)
  451. {
  452. menu_data_edit_t* _md = (menu_data_edit_t*)&(menu_data[0]);
  453. if (lcd_draw_update)
  454. {
  455. if (lcd_encoder < _md->minEditValue) lcd_encoder = _md->minEditValue;
  456. if (lcd_encoder > _md->maxEditValue) lcd_encoder = _md->maxEditValue;
  457. lcd_set_cursor(0, 1);
  458. menu_draw_P<T>(' ', _md->editLabel, (int)lcd_encoder);
  459. }
  460. if (LCD_CLICKED)
  461. {
  462. *((T)(_md->editValue)) = lcd_encoder;
  463. menu_back_no_reset();
  464. }
  465. }
  466. template <typename T>
  467. uint8_t menu_item_edit_P(const char* str, T pval, int16_t min_val, int16_t max_val)
  468. {
  469. menu_data_edit_t* _md = (menu_data_edit_t*)&(menu_data[0]);
  470. if (menu_item == menu_line)
  471. {
  472. if (lcd_draw_update)
  473. {
  474. lcd_set_cursor(0, menu_row);
  475. menu_draw_P<T>(menu_selection_mark(), str, *pval);
  476. }
  477. if (menu_clicked && (lcd_encoder == menu_item))
  478. {
  479. menu_submenu_no_reset(_menu_edit_P<T>);
  480. _md->editLabel = str;
  481. _md->editValue = pval;
  482. _md->minEditValue = min_val;
  483. _md->maxEditValue = max_val;
  484. lcd_encoder = *pval;
  485. return menu_item_ret();
  486. }
  487. }
  488. menu_item++;
  489. return 0;
  490. }
  491. template uint8_t menu_item_edit_P<int16_t*>(const char* str, int16_t *pval, int16_t min_val, int16_t max_val);
  492. template uint8_t menu_item_edit_P<uint8_t*>(const char* str, uint8_t *pval, int16_t min_val, int16_t max_val);
  493. #undef _menu_data