menu.cpp 14 KB

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