dialog.h 6.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238
  1. /* SPDX-License-Identifier: GPL-2.0+ */
  2. /*
  3. * dialog.h -- common declarations for all dialog modules
  4. *
  5. * AUTHOR: Savio Lam (lam836@cs.cuhk.hk)
  6. */
  7. #include <sys/types.h>
  8. #include <fcntl.h>
  9. #include <unistd.h>
  10. #include <ctype.h>
  11. #include <stdlib.h>
  12. #include <string.h>
  13. #include <stdbool.h>
  14. #ifdef __sun__
  15. #define CURS_MACROS
  16. #endif
  17. #include <ncurses.h>
  18. /*
  19. * Colors in ncurses 1.9.9e do not work properly since foreground and
  20. * background colors are OR'd rather than separately masked. This version
  21. * of dialog was hacked to work with ncurses 1.9.9e, making it incompatible
  22. * with standard curses. The simplest fix (to make this work with standard
  23. * curses) uses the wbkgdset() function, not used in the original hack.
  24. * Turn it off if we're building with 1.9.9e, since it just confuses things.
  25. */
  26. #if defined(NCURSES_VERSION) && defined(_NEED_WRAP) && !defined(GCC_PRINTFLIKE)
  27. #define OLD_NCURSES 1
  28. #undef wbkgdset
  29. #define wbkgdset(w,p) /*nothing */
  30. #else
  31. #define OLD_NCURSES 0
  32. #endif
  33. #define TR(params) _tracef params
  34. #define KEY_ESC 27
  35. #define TAB 9
  36. #define MAX_LEN 2048
  37. #define BUF_SIZE (10*1024)
  38. #define MIN(x,y) (x < y ? x : y)
  39. #define MAX(x,y) (x > y ? x : y)
  40. #ifndef ACS_ULCORNER
  41. #define ACS_ULCORNER '+'
  42. #endif
  43. #ifndef ACS_LLCORNER
  44. #define ACS_LLCORNER '+'
  45. #endif
  46. #ifndef ACS_URCORNER
  47. #define ACS_URCORNER '+'
  48. #endif
  49. #ifndef ACS_LRCORNER
  50. #define ACS_LRCORNER '+'
  51. #endif
  52. #ifndef ACS_HLINE
  53. #define ACS_HLINE '-'
  54. #endif
  55. #ifndef ACS_VLINE
  56. #define ACS_VLINE '|'
  57. #endif
  58. #ifndef ACS_LTEE
  59. #define ACS_LTEE '+'
  60. #endif
  61. #ifndef ACS_RTEE
  62. #define ACS_RTEE '+'
  63. #endif
  64. #ifndef ACS_UARROW
  65. #define ACS_UARROW '^'
  66. #endif
  67. #ifndef ACS_DARROW
  68. #define ACS_DARROW 'v'
  69. #endif
  70. /* error return codes */
  71. #define ERRDISPLAYTOOSMALL (KEY_MAX + 1)
  72. /*
  73. * Color definitions
  74. */
  75. struct dialog_color {
  76. chtype atr; /* Color attribute */
  77. int fg; /* foreground */
  78. int bg; /* background */
  79. int hl; /* highlight this item */
  80. };
  81. struct subtitle_list {
  82. struct subtitle_list *next;
  83. const char *text;
  84. };
  85. struct dialog_info {
  86. const char *backtitle;
  87. struct subtitle_list *subtitles;
  88. struct dialog_color screen;
  89. struct dialog_color shadow;
  90. struct dialog_color dialog;
  91. struct dialog_color title;
  92. struct dialog_color border;
  93. struct dialog_color button_active;
  94. struct dialog_color button_inactive;
  95. struct dialog_color button_key_active;
  96. struct dialog_color button_key_inactive;
  97. struct dialog_color button_label_active;
  98. struct dialog_color button_label_inactive;
  99. struct dialog_color inputbox;
  100. struct dialog_color inputbox_border;
  101. struct dialog_color searchbox;
  102. struct dialog_color searchbox_title;
  103. struct dialog_color searchbox_border;
  104. struct dialog_color position_indicator;
  105. struct dialog_color menubox;
  106. struct dialog_color menubox_border;
  107. struct dialog_color item;
  108. struct dialog_color item_selected;
  109. struct dialog_color tag;
  110. struct dialog_color tag_selected;
  111. struct dialog_color tag_key;
  112. struct dialog_color tag_key_selected;
  113. struct dialog_color check;
  114. struct dialog_color check_selected;
  115. struct dialog_color uarrow;
  116. struct dialog_color darrow;
  117. };
  118. /*
  119. * Global variables
  120. */
  121. extern struct dialog_info dlg;
  122. extern char dialog_input_result[];
  123. extern int saved_x, saved_y; /* Needed in signal handler in mconf.c */
  124. /*
  125. * Function prototypes
  126. */
  127. /* item list as used by checklist and menubox */
  128. void item_reset(void);
  129. void item_make(const char *fmt, ...);
  130. void item_add_str(const char *fmt, ...);
  131. void item_set_tag(char tag);
  132. void item_set_data(void *p);
  133. void item_set_selected(int val);
  134. int item_activate_selected(void);
  135. void *item_data(void);
  136. char item_tag(void);
  137. /* item list manipulation for lxdialog use */
  138. #define MAXITEMSTR 200
  139. struct dialog_item {
  140. char str[MAXITEMSTR]; /* prompt displayed */
  141. char tag;
  142. void *data; /* pointer to menu item - used by menubox+checklist */
  143. int selected; /* Set to 1 by dialog_*() function if selected. */
  144. };
  145. /* list of lialog_items */
  146. struct dialog_list {
  147. struct dialog_item node;
  148. struct dialog_list *next;
  149. };
  150. extern struct dialog_list *item_cur;
  151. extern struct dialog_list item_nil;
  152. extern struct dialog_list *item_head;
  153. int item_count(void);
  154. void item_set(int n);
  155. int item_n(void);
  156. const char *item_str(void);
  157. int item_is_selected(void);
  158. int item_is_tag(char tag);
  159. #define item_foreach() \
  160. for (item_cur = item_head ? item_head: item_cur; \
  161. item_cur && (item_cur != &item_nil); item_cur = item_cur->next)
  162. /* generic key handlers */
  163. int on_key_esc(WINDOW *win);
  164. int on_key_resize(void);
  165. /* minimum (re)size values */
  166. #define CHECKLIST_HEIGTH_MIN 6 /* For dialog_checklist() */
  167. #define CHECKLIST_WIDTH_MIN 6
  168. #define INPUTBOX_HEIGTH_MIN 2 /* For dialog_inputbox() */
  169. #define INPUTBOX_WIDTH_MIN 2
  170. #define MENUBOX_HEIGTH_MIN 15 /* For dialog_menu() */
  171. #define MENUBOX_WIDTH_MIN 65
  172. #define TEXTBOX_HEIGTH_MIN 8 /* For dialog_textbox() */
  173. #define TEXTBOX_WIDTH_MIN 8
  174. #define YESNO_HEIGTH_MIN 4 /* For dialog_yesno() */
  175. #define YESNO_WIDTH_MIN 4
  176. #define WINDOW_HEIGTH_MIN 19 /* For init_dialog() */
  177. #define WINDOW_WIDTH_MIN 80
  178. int init_dialog(const char *backtitle);
  179. void set_dialog_backtitle(const char *backtitle);
  180. void set_dialog_subtitles(struct subtitle_list *subtitles);
  181. void end_dialog(int x, int y);
  182. void attr_clear(WINDOW * win, int height, int width, chtype attr);
  183. void dialog_clear(void);
  184. void print_autowrap(WINDOW * win, const char *prompt, int width, int y, int x);
  185. void print_button(WINDOW * win, const char *label, int y, int x, int selected);
  186. void print_title(WINDOW *dialog, const char *title, int width);
  187. void draw_box(WINDOW * win, int y, int x, int height, int width, chtype box,
  188. chtype border);
  189. void draw_shadow(WINDOW * win, int y, int x, int height, int width);
  190. int first_alpha(const char *string, const char *exempt);
  191. int dialog_yesno(const char *title, const char *prompt, int height, int width);
  192. int dialog_msgbox(const char *title, const char *prompt, int height,
  193. int width, int pause);
  194. typedef void (*update_text_fn)(char *buf, size_t start, size_t end, void
  195. *_data);
  196. int dialog_textbox(const char *title, char *tbuf, int initial_height,
  197. int initial_width, int *keys, int *_vscroll, int *_hscroll,
  198. update_text_fn update_text, void *data);
  199. int dialog_menu(const char *title, const char *prompt,
  200. const void *selected, int *s_scroll);
  201. int dialog_checklist(const char *title, const char *prompt, int height,
  202. int width, int list_height);
  203. int dialog_inputbox(const char *title, const char *prompt, int height,
  204. int width, const char *init);
  205. /*
  206. * This is the base for fictitious keys, which activate
  207. * the buttons.
  208. *
  209. * Mouse-generated keys are the following:
  210. * -- the first 32 are used as numbers, in addition to '0'-'9'
  211. * -- the lowercase are used to signal mouse-enter events (M_EVENT + 'o')
  212. * -- uppercase chars are used to invoke the button (M_EVENT + 'O')
  213. */
  214. #define M_EVENT (KEY_MAX+1)