menu.cpp 15 KB

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