dialog.h 6.8 KB

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