blob: 8dea47f9d3e49a36803ed4c90223d9858a83d3de [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
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
28#ifdef __sun__
29#define CURS_MACROS
30#endif
31#include CURSES_LOC
32
33/*
34 * Colors in ncurses 1.9.9e do not work properly since foreground and
35 * background colors are OR'd rather than separately masked. This version
36 * of dialog was hacked to work with ncurses 1.9.9e, making it incompatible
37 * with standard curses. The simplest fix (to make this work with standard
38 * curses) uses the wbkgdset() function, not used in the original hack.
39 * Turn it off if we're building with 1.9.9e, since it just confuses things.
40 */
41#if defined(NCURSES_VERSION) && defined(_NEED_WRAP) && !defined(GCC_PRINTFLIKE)
42#define OLD_NCURSES 1
43#undef wbkgdset
Sam Ravnborgb1c5f1c2005-11-19 19:13:34 +010044#define wbkgdset(w,p) /*nothing */
Linus Torvalds1da177e2005-04-16 15:20:36 -070045#else
46#define OLD_NCURSES 0
47#endif
48
49#define TR(params) _tracef params
50
Sam Ravnborgf3cbcdc2006-07-28 23:57:48 +020051#define KEY_ESC 27
Linus Torvalds1da177e2005-04-16 15:20:36 -070052#define TAB 9
53#define MAX_LEN 2048
54#define BUF_SIZE (10*1024)
55#define MIN(x,y) (x < y ? x : y)
56#define MAX(x,y) (x > y ? x : y)
57
Linus Torvalds1da177e2005-04-16 15:20:36 -070058#ifndef ACS_ULCORNER
59#define ACS_ULCORNER '+'
60#endif
61#ifndef ACS_LLCORNER
62#define ACS_LLCORNER '+'
63#endif
64#ifndef ACS_URCORNER
65#define ACS_URCORNER '+'
66#endif
67#ifndef ACS_LRCORNER
68#define ACS_LRCORNER '+'
69#endif
70#ifndef ACS_HLINE
71#define ACS_HLINE '-'
72#endif
73#ifndef ACS_VLINE
74#define ACS_VLINE '|'
75#endif
76#ifndef ACS_LTEE
77#define ACS_LTEE '+'
78#endif
79#ifndef ACS_RTEE
80#define ACS_RTEE '+'
81#endif
82#ifndef ACS_UARROW
83#define ACS_UARROW '^'
84#endif
85#ifndef ACS_DARROW
86#define ACS_DARROW 'v'
87#endif
88
Sam Ravnborgc8dc68a2006-07-29 22:48:57 +020089/* error return codes */
90#define ERRDISPLAYTOOSMALL (KEY_MAX + 1)
91
Sam Ravnborgdec69da2005-11-19 21:56:20 +010092/*
Sam Ravnborg98e5a152006-07-24 21:40:46 +020093 * Color definitions
Linus Torvalds1da177e2005-04-16 15:20:36 -070094 */
Sam Ravnborg98e5a152006-07-24 21:40:46 +020095struct dialog_color {
96 chtype atr; /* Color attribute */
97 int fg; /* foreground */
98 int bg; /* background */
99 int hl; /* highlight this item */
100};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101
Sam Ravnborg98e5a152006-07-24 21:40:46 +0200102struct dialog_info {
103 const char *backtitle;
104 struct dialog_color screen;
105 struct dialog_color shadow;
106 struct dialog_color dialog;
107 struct dialog_color title;
108 struct dialog_color border;
109 struct dialog_color button_active;
110 struct dialog_color button_inactive;
111 struct dialog_color button_key_active;
112 struct dialog_color button_key_inactive;
113 struct dialog_color button_label_active;
114 struct dialog_color button_label_inactive;
115 struct dialog_color inputbox;
116 struct dialog_color inputbox_border;
117 struct dialog_color searchbox;
118 struct dialog_color searchbox_title;
119 struct dialog_color searchbox_border;
120 struct dialog_color position_indicator;
121 struct dialog_color menubox;
122 struct dialog_color menubox_border;
123 struct dialog_color item;
124 struct dialog_color item_selected;
125 struct dialog_color tag;
126 struct dialog_color tag_selected;
127 struct dialog_color tag_key;
128 struct dialog_color tag_key_selected;
129 struct dialog_color check;
130 struct dialog_color check_selected;
131 struct dialog_color uarrow;
132 struct dialog_color darrow;
133};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700134
135/*
136 * Global variables
137 */
Sam Ravnborg98e5a152006-07-24 21:40:46 +0200138extern struct dialog_info dlg;
Sam Ravnborg2982de62006-07-27 22:10:27 +0200139extern char dialog_input_result[];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700140
141/*
142 * Function prototypes
143 */
Sam Ravnborg2982de62006-07-27 22:10:27 +0200144
145/* item list as used by checklist and menubox */
146void item_reset(void);
147void item_make(const char *fmt, ...);
148void item_add_str(const char *fmt, ...);
149void item_set_tag(char tag);
150void item_set_data(void *p);
151void item_set_selected(int val);
152int item_activate_selected(void);
153void *item_data(void);
154char item_tag(void);
155
156/* item list manipulation for lxdialog use */
157#define MAXITEMSTR 200
158struct dialog_item {
159 char str[MAXITEMSTR]; /* promtp displayed */
160 char tag;
161 void *data; /* pointer to menu item - used by menubox+checklist */
162 int selected; /* Set to 1 by dialog_*() function if selected. */
163};
164
165/* list of lialog_items */
166struct dialog_list {
167 struct dialog_item node;
168 struct dialog_list *next;
169};
170
171extern struct dialog_list *item_cur;
172extern struct dialog_list item_nil;
173extern struct dialog_list *item_head;
174
175int item_count(void);
176void item_set(int n);
177int item_n(void);
178const char *item_str(void);
179int item_is_selected(void);
180int item_is_tag(char tag);
181#define item_foreach() \
182 for (item_cur = item_head ? item_head: item_cur; \
183 item_cur && (item_cur != &item_nil); item_cur = item_cur->next)
184
Sam Ravnborgf3cbcdc2006-07-28 23:57:48 +0200185/* generic key handlers */
186int on_key_esc(WINDOW *win);
Sam Ravnborgc8dc68a2006-07-29 22:48:57 +0200187int on_key_resize(void);
Sam Ravnborg2982de62006-07-27 22:10:27 +0200188
189void init_dialog(const char *backtitle);
190void reset_dialog(void);
Sam Ravnborgb1c5f1c2005-11-19 19:13:34 +0100191void end_dialog(void);
192void attr_clear(WINDOW * win, int height, int width, chtype attr);
193void dialog_clear(void);
Sam Ravnborgb1c5f1c2005-11-19 19:13:34 +0100194void print_autowrap(WINDOW * win, const char *prompt, int width, int y, int x);
195void print_button(WINDOW * win, const char *label, int y, int x, int selected);
Sam Ravnborgfa7009d2005-11-19 23:38:06 +0100196void print_title(WINDOW *dialog, const char *title, int width);
Sam Ravnborgb1c5f1c2005-11-19 19:13:34 +0100197void draw_box(WINDOW * win, int y, int x, int height, int width, chtype box,
198 chtype border);
199void draw_shadow(WINDOW * win, int y, int x, int height, int width);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700200
Sam Ravnborgb1c5f1c2005-11-19 19:13:34 +0100201int first_alpha(const char *string, const char *exempt);
202int dialog_yesno(const char *title, const char *prompt, int height, int width);
203int dialog_msgbox(const char *title, const char *prompt, int height,
204 int width, int pause);
205int dialog_textbox(const char *title, const char *file, int height, int width);
Sam Ravnborgc8dc68a2006-07-29 22:48:57 +0200206int dialog_menu(const char *title, const char *prompt,
207 const void *selected, int *s_scroll);
Sam Ravnborgb1c5f1c2005-11-19 19:13:34 +0100208int dialog_checklist(const char *title, const char *prompt, int height,
Sam Ravnborg2982de62006-07-27 22:10:27 +0200209 int width, int list_height);
Keenan Pepper84c2a2e2005-07-27 14:14:00 -0400210extern char dialog_input_result[];
Sam Ravnborgb1c5f1c2005-11-19 19:13:34 +0100211int dialog_inputbox(const char *title, const char *prompt, int height,
212 int width, const char *init);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700213
214/*
215 * This is the base for fictitious keys, which activate
216 * the buttons.
217 *
218 * Mouse-generated keys are the following:
219 * -- the first 32 are used as numbers, in addition to '0'-'9'
220 * -- the lowercase are used to signal mouse-enter events (M_EVENT + 'o')
221 * -- uppercase chars are used to invoke the button (M_EVENT + 'O')
222 */
223#define M_EVENT (KEY_MAX+1)