menu.cpp 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511
  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. //! @brief Format sheet name
  162. //!
  163. //! @param[in] sheet_E Sheet in EEPROM
  164. //! @param[out] buffer for formatted output
  165. void menu_format_sheet_E(const Sheet &sheet_E, SheetFormatBuffer &buffer)
  166. {
  167. uint_least8_t index = sprintf_P(buffer.c, PSTR("%.10S "), _T(MSG_SHEET));
  168. eeprom_read_block(&(buffer.c[index]), sheet_E.name, 7);
  169. //index += 7;
  170. buffer.c[index + 7] = '\0';
  171. }
  172. //! @brief Format sheet name in select menu
  173. //!
  174. //! @param[in] sheet_E Sheet in EEPROM
  175. //! @param[out] buffer for formatted output
  176. void menu_format_sheet_select_E(const Sheet &sheet_E, SheetFormatBuffer &buffer)
  177. {
  178. uint_least8_t index = sprintf_P(buffer.c,PSTR("%-9.9S["), _T(MSG_SHEET));
  179. eeprom_read_block(&(buffer.c[index]), sheet_E.name, sizeof(sheet_E.name)/sizeof(sheet_E.name[0]));
  180. for (const uint_least8_t start = index; static_cast<uint_least8_t>(index - start) < sizeof(sheet_E.name)/sizeof(sheet_E.name[0]); ++index)
  181. {
  182. if (buffer.c[index] == '\0') break;
  183. }
  184. buffer.c[index] = ']';
  185. buffer.c[index + 1] = '\0';
  186. }
  187. static void menu_draw_item_select_sheet_E(char type_char, const Sheet &sheet)
  188. {
  189. lcd_set_cursor(0, menu_row);
  190. SheetFormatBuffer buffer;
  191. menu_format_sheet_select_E(sheet, buffer);
  192. lcd_printf_P(PSTR("%c%-18.18s%c"), menu_selection_mark(), buffer.c, type_char);
  193. }
  194. static void menu_draw_item_puts_E(char type_char, const Sheet &sheet)
  195. {
  196. lcd_set_cursor(0, menu_row);
  197. SheetFormatBuffer buffer;
  198. menu_format_sheet_E(sheet, buffer);
  199. lcd_printf_P(PSTR("%c%-18.18s%c"), menu_selection_mark(), buffer.c, type_char);
  200. }
  201. static void menu_draw_item_puts_P(char type_char, const char* str, char num)
  202. {
  203. lcd_set_cursor(0, menu_row);
  204. lcd_printf_P(PSTR("%c%-.16S "), menu_selection_mark(), str);
  205. lcd_putc(num);
  206. lcd_set_cursor(19, menu_row);
  207. lcd_putc(type_char);
  208. }
  209. /*
  210. int menu_draw_item_puts_P_int16(char type_char, const char* str, int16_t val, )
  211. {
  212. lcd_set_cursor(0, menu_row);
  213. int cnt = lcd_printf_P(PSTR("%c%-18S%c"), (lcd_encoder == menu_item)?'>':' ', str, type_char);
  214. return cnt;
  215. }
  216. */
  217. void menu_item_dummy(void)
  218. {
  219. menu_item++;
  220. }
  221. uint8_t menu_item_text_P(const char* str)
  222. {
  223. if (menu_item == menu_line)
  224. {
  225. if (lcd_draw_update) menu_draw_item_puts_P(' ', str);
  226. if (menu_clicked && (lcd_encoder == menu_item))
  227. return menu_item_ret();
  228. }
  229. menu_item++;
  230. return 0;
  231. }
  232. uint8_t menu_item_submenu_P(const char* str, menu_func_t submenu)
  233. {
  234. if (menu_item == menu_line)
  235. {
  236. if (lcd_draw_update) menu_draw_item_puts_P(LCD_STR_ARROW_RIGHT[0], str);
  237. if (menu_clicked && (lcd_encoder == menu_item))
  238. {
  239. menu_submenu(submenu);
  240. return menu_item_ret();
  241. }
  242. }
  243. menu_item++;
  244. return 0;
  245. }
  246. uint8_t menu_item_submenu_E(const Sheet &sheet, menu_func_t submenu)
  247. {
  248. if (menu_item == menu_line)
  249. {
  250. if (lcd_draw_update) menu_draw_item_puts_E(LCD_STR_ARROW_RIGHT[0], sheet);
  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_function_E(const Sheet &sheet, menu_func_t func)
  261. {
  262. if (menu_item == menu_line)
  263. {
  264. if (lcd_draw_update) menu_draw_item_select_sheet_E(' ', sheet);
  265. if (menu_clicked && (lcd_encoder == menu_item))
  266. {
  267. menu_clicked = false;
  268. lcd_consume_click();
  269. lcd_update_enabled = 0;
  270. if (func) func();
  271. lcd_update_enabled = 1;
  272. return menu_item_ret();
  273. }
  274. }
  275. menu_item++;
  276. return 0;
  277. }
  278. uint8_t menu_item_back_P(const char* str)
  279. {
  280. if (menu_item == menu_line)
  281. {
  282. if (lcd_draw_update) menu_draw_item_puts_P(LCD_STR_UPLEVEL[0], str);
  283. if (menu_clicked && (lcd_encoder == menu_item))
  284. {
  285. menu_back();
  286. return menu_item_ret();
  287. }
  288. }
  289. menu_item++;
  290. return 0;
  291. }
  292. uint8_t menu_item_function_P(const char* str, menu_func_t func)
  293. {
  294. if (menu_item == menu_line)
  295. {
  296. if (lcd_draw_update) menu_draw_item_puts_P(' ', str);
  297. if (menu_clicked && (lcd_encoder == menu_item))
  298. {
  299. menu_clicked = false;
  300. lcd_consume_click();
  301. lcd_update_enabled = 0;
  302. if (func) func();
  303. lcd_update_enabled = 1;
  304. return menu_item_ret();
  305. }
  306. }
  307. menu_item++;
  308. return 0;
  309. }
  310. //! @brief Menu item function taking single parameter
  311. //!
  312. //! Ideal for numbered lists calling functions with number parameter.
  313. //! @param str Item caption
  314. //! @param number aditional character to be added after str, e.g. number
  315. //! @param func pointer to function taking uint8_t with no return value
  316. //! @param fn_par value to be passed to function
  317. //! @retval 0
  318. //! @retval 1 Item was clicked
  319. uint8_t menu_item_function_P(const char* str, char number, void (*func)(uint8_t), uint8_t fn_par)
  320. {
  321. if (menu_item == menu_line)
  322. {
  323. if (lcd_draw_update) menu_draw_item_puts_P(' ', str, number);
  324. if (menu_clicked && (lcd_encoder == menu_item))
  325. {
  326. menu_clicked = false;
  327. lcd_consume_click();
  328. lcd_update_enabled = 0;
  329. if (func) func(fn_par);
  330. lcd_update_enabled = 1;
  331. return menu_item_ret();
  332. }
  333. }
  334. menu_item++;
  335. return 0;
  336. }
  337. uint8_t menu_item_gcode_P(const char* str, const char* str_gcode)
  338. {
  339. if (menu_item == menu_line)
  340. {
  341. if (lcd_draw_update) menu_draw_item_puts_P(' ', str);
  342. if (menu_clicked && (lcd_encoder == menu_item))
  343. {
  344. if (str_gcode) enquecommand_P(str_gcode);
  345. return menu_item_ret();
  346. }
  347. }
  348. menu_item++;
  349. return 0;
  350. }
  351. const char menu_20x_space[] PROGMEM = " ";
  352. const char menu_fmt_int3[] PROGMEM = "%c%.15S:%s%3d";
  353. const char menu_fmt_float31[] PROGMEM = "%-12.12S%+8.1f";
  354. const char menu_fmt_float13[] PROGMEM = "%c%-13.13S%+5.3f";
  355. const char menu_fmt_float13off[] PROGMEM = "%c%-13.13S%6.6S";
  356. template<typename T>
  357. static void menu_draw_P(char chr, const char* str, int16_t val);
  358. template<>
  359. void menu_draw_P<int16_t*>(char chr, const char* str, int16_t val)
  360. {
  361. int text_len = strlen_P(str);
  362. if (text_len > 15) text_len = 15;
  363. char spaces[21];
  364. strcpy_P(spaces, menu_20x_space);
  365. if (val <= -100) spaces[15 - text_len - 1] = 0;
  366. else spaces[15 - text_len] = 0;
  367. lcd_printf_P(menu_fmt_int3, chr, str, spaces, val);
  368. }
  369. template<>
  370. void menu_draw_P<uint8_t*>(char chr, const char* str, int16_t val)
  371. {
  372. menu_data_edit_t* _md = (menu_data_edit_t*)&(menu_data[0]);
  373. float factor = 1.0f + static_cast<float>(val) / 1000.0f;
  374. if (val <= _md->minEditValue)
  375. {
  376. lcd_printf_P(menu_fmt_float13off, chr, str, _i(" [off]"));
  377. }
  378. else
  379. {
  380. lcd_printf_P(menu_fmt_float13, chr, str, factor);
  381. }
  382. }
  383. //! @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
  384. //! for displaying large values of extruder positions, which caused text overflow in the previous implementation.
  385. //!
  386. //! @param str string label to print
  387. //! @param val value to print aligned to the right side of the display
  388. //!
  389. //! Implementation comments:
  390. //! The text needs to come with a colon ":", this function does not append it anymore.
  391. //! That resulted in a much shorter implementation (234628B -> 234476B)
  392. //! There are similar functions around which may be shortened in a similar way
  393. void menu_draw_float31(const char* str, float val)
  394. {
  395. lcd_printf_P(menu_fmt_float31, str, val);
  396. }
  397. //! @brief Draw up to 14 chars of text and a float number in format +1.234
  398. //!
  399. //! @param str string label to print
  400. //! @param val value to print aligned to the right side of the display
  401. //!
  402. //! Implementation comments:
  403. //! This function uses similar optimization principles as menu_draw_float31
  404. //! (i.e. str must include a ':' at its end)
  405. //! FLASH usage dropped 234476B -> 234392B
  406. //! Moreover, this function gets inlined in the final code, so removing it doesn't really help ;)
  407. void menu_draw_float13(const char* str, float val)
  408. {
  409. lcd_printf_P(menu_fmt_float13, ' ', str, val);
  410. }
  411. template <typename T>
  412. static void _menu_edit_P(void)
  413. {
  414. menu_data_edit_t* _md = (menu_data_edit_t*)&(menu_data[0]);
  415. if (lcd_draw_update)
  416. {
  417. if (lcd_encoder < _md->minEditValue) lcd_encoder = _md->minEditValue;
  418. if (lcd_encoder > _md->maxEditValue) lcd_encoder = _md->maxEditValue;
  419. lcd_set_cursor(0, 1);
  420. menu_draw_P<T>(' ', _md->editLabel, (int)lcd_encoder);
  421. }
  422. if (LCD_CLICKED)
  423. {
  424. *((T)(_md->editValue)) = lcd_encoder;
  425. menu_back_no_reset();
  426. }
  427. }
  428. template <typename T>
  429. uint8_t menu_item_edit_P(const char* str, T pval, int16_t min_val, int16_t max_val)
  430. {
  431. menu_data_edit_t* _md = (menu_data_edit_t*)&(menu_data[0]);
  432. if (menu_item == menu_line)
  433. {
  434. if (lcd_draw_update)
  435. {
  436. lcd_set_cursor(0, menu_row);
  437. menu_draw_P<T>(menu_selection_mark(), str, *pval);
  438. }
  439. if (menu_clicked && (lcd_encoder == menu_item))
  440. {
  441. menu_submenu_no_reset(_menu_edit_P<T>);
  442. _md->editLabel = str;
  443. _md->editValue = pval;
  444. _md->minEditValue = min_val;
  445. _md->maxEditValue = max_val;
  446. lcd_encoder = *pval;
  447. return menu_item_ret();
  448. }
  449. }
  450. menu_item++;
  451. return 0;
  452. }
  453. template uint8_t menu_item_edit_P<int16_t*>(const char* str, int16_t *pval, int16_t min_val, int16_t max_val);
  454. template uint8_t menu_item_edit_P<uint8_t*>(const char* str, uint8_t *pval, int16_t min_val, int16_t max_val);
  455. #undef _menu_data