menu.h 4.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147
  1. //menu.h
  2. #ifndef _MENU_H
  3. #define _MENU_H
  4. #include <inttypes.h>
  5. #include "eeprom.h"
  6. #define MENU_DATA_SIZE 32
  7. //Function pointer to menu functions.
  8. typedef void (*menu_func_t)(void);
  9. typedef struct
  10. {
  11. menu_func_t menu;
  12. int8_t position;
  13. } menu_record_t;
  14. typedef struct
  15. {
  16. //Variables used when editing values.
  17. const char* editLabel;
  18. void* editValue;
  19. int32_t minEditValue;
  20. int32_t maxEditValue;
  21. } menu_data_edit_t;
  22. extern uint8_t menu_data[MENU_DATA_SIZE];
  23. extern uint8_t menu_depth;
  24. //! definition of serious errors possibly blocking the main menu
  25. //! Use them as bit mask, so that the code may set various errors at the same time
  26. enum ESeriousErrors {
  27. SERIOUS_ERR_NONE = 0,
  28. SERIOUS_ERR_MINTEMP_HEATER = 0x01,
  29. SERIOUS_ERR_MINTEMP_BED = 0x02
  30. }; // and possibly others in the future.
  31. //! this is a flag for disabling entering the main menu. If this is set
  32. //! to anything != 0, the only the main status screen will be shown on the
  33. //! LCD and the user will be prevented from entering the menu.
  34. //! Now used only to block doing anything with the printer when there is
  35. //! the infamous MINTEMP error (SERIOUS_ERR_MINTEMP).
  36. extern uint8_t menu_block_entering_on_serious_errors;
  37. //! a pair of macros for manipulating the serious errors
  38. //! a c++ class would have been better
  39. #define menu_set_serious_error(x) menu_block_entering_on_serious_errors |= x;
  40. #define menu_unset_serious_error(x) menu_block_entering_on_serious_errors &= ~x;
  41. #define menu_is_serious_error(x) (menu_block_entering_on_serious_errors & x) != 0
  42. extern uint8_t menu_line;
  43. extern uint8_t menu_item;
  44. extern uint8_t menu_row;
  45. //scroll offset in the current menu
  46. extern uint8_t menu_top;
  47. extern uint8_t menu_clicked;
  48. extern uint8_t menu_entering;
  49. extern uint8_t menu_leaving;
  50. //function pointer to the currently active menu
  51. extern menu_func_t menu_menu;
  52. extern void menu_goto(menu_func_t menu, const uint32_t encoder, const bool feedback, bool reset_menu_state);
  53. #define MENU_BEGIN() menu_start(); for(menu_row = 0; menu_row < LCD_HEIGHT; menu_row++, menu_line++) { menu_item = 0;
  54. void menu_start(void);
  55. #define MENU_END() menu_end(); }
  56. extern void menu_end(void);
  57. extern void menu_back(void);
  58. extern void menu_back(uint8_t nLevel);
  59. extern void menu_back_if_clicked(void);
  60. extern void menu_back_if_clicked_fb(void);
  61. extern void menu_submenu(menu_func_t submenu);
  62. extern uint8_t menu_item_ret(void);
  63. //extern int menu_draw_item_printf_P(char type_char, const char* format, ...);
  64. //int menu_draw_item_puts_P_int16(char type_char, const char* str, int16_t val, );
  65. #define MENU_ITEM_DUMMY() menu_item_dummy()
  66. extern void menu_item_dummy(void);
  67. #define MENU_ITEM_TEXT_P(str) do { if (menu_item_text_P(str)) return; } while (0)
  68. extern uint8_t menu_item_text_P(const char* str);
  69. #define MENU_ITEM_SUBMENU_P(str, submenu) do { if (menu_item_submenu_P(str, submenu)) return; } while (0)
  70. extern uint8_t menu_item_submenu_P(const char* str, menu_func_t submenu);
  71. #define MENU_ITEM_SUBMENU_E(sheet, submenu) do { if (menu_item_submenu_E(sheet, submenu)) return; } while (0)
  72. extern uint8_t menu_item_submenu_E(const Sheet &sheet, menu_func_t submenu);
  73. #define MENU_ITEM_BACK_P(str) do { if (menu_item_back_P(str)) return; } while (0)
  74. extern uint8_t menu_item_back_P(const char* str);
  75. // leaving menu - this condition must be immediately before MENU_ITEM_BACK_P
  76. #define ON_MENU_LEAVE(func) do { if (((menu_item == menu_line) && menu_clicked && (lcd_encoder == menu_item)) || menu_leaving){ func } } while (0)
  77. #define MENU_ITEM_FUNCTION_P(str, func) do { if (menu_item_function_P(str, func)) return; } while (0)
  78. extern uint8_t menu_item_function_P(const char* str, menu_func_t func);
  79. #define MENU_ITEM_FUNCTION_NR_P(str, number, func, fn_par) do { if (menu_item_function_P(str, number, func, fn_par)) return; } while (0)
  80. extern uint8_t menu_item_function_P(const char* str, char number, void (*func)(uint8_t), uint8_t fn_par);
  81. #define MENU_ITEM_GCODE_P(str, str_gcode) do { if (menu_item_gcode_P(str, str_gcode)) return; } while (0)
  82. extern uint8_t menu_item_gcode_P(const char* str, const char* str_gcode);
  83. extern const char menu_fmt_int3[];
  84. extern const char menu_fmt_float31[];
  85. extern const char menu_fmt_float13[];
  86. extern void menu_draw_float31(const char* str, float val);
  87. extern void menu_draw_float13(const char* str, float val);
  88. struct SheetFormatBuffer
  89. {
  90. char c[19];
  91. };
  92. extern void menu_format_sheet_E(const Sheet &sheet_E, SheetFormatBuffer &buffer);
  93. #define MENU_ITEM_EDIT_int3_P(str, pval, minval, maxval) do { if (menu_item_edit_P(str, pval, minval, maxval)) return; } while (0)
  94. //#define MENU_ITEM_EDIT_int3_P(str, pval, minval, maxval) MENU_ITEM_EDIT(int3, str, pval, minval, maxval)
  95. template <typename T>
  96. extern uint8_t menu_item_edit_P(const char* str, T pval, int16_t min_val, int16_t max_val);
  97. #endif //_MENU_H