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