2 * $Id: dialog.h,v 1.223 2011/03/02 10:04:09 tom Exp $
4 * dialog.h -- common declarations for all dialog modules
6 * Copyright 2000-2010,2011 Thomas E. Dickey
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU Lesser General Public License, version 2.1
10 * as published by the Free Software Foundation.
12 * This program is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with this program; if not, write to
19 * Free Software Foundation, Inc.
20 * 51 Franklin St., Fifth Floor
21 * Boston, MA 02110, USA.
23 * An earlier version of this program lists as authors
24 * Savio Lam (lam836@cs.cuhk.hk)
27 #ifndef DIALOG_H_included
28 #define DIALOG_H_included 1
31 #include <dlg_config.h>
34 #define __HP_CURSES_COMPAT /* workaround for getattrs, etc. */
37 #include <sys/types.h>
44 #include <signal.h> /* fork() etc. */
45 #include <math.h> /* sqrt() */
47 #undef ERR /* header conflict with Solaris xpg4 */
49 #if defined(HAVE_NCURSESW_NCURSES_H)
50 #include <ncursesw/ncurses.h>
51 #elif defined(HAVE_NCURSES_NCURSES_H)
52 #include <ncurses/ncurses.h>
53 #elif defined(HAVE_NCURSES_CURSES_H)
54 #include <ncurses/curses.h>
55 #elif defined(HAVE_NCURSES_H)
61 /* most curses.h headers include this, some do not */
62 #if defined(HAVE_UNCTRL_H)
66 /* Solaris xpg4 renames these */
69 #define KEY_MAX __KEY_MAX
75 #define KEY_MIN __KEY_MIN
79 /* possible conflicts with <term.h> which may be included in <curses.h> */
91 #define _(s) dgettext(PACKAGE, s)
98 #define GCC_NORETURN /*nothing*/
102 #define GCC_UNUSED /*nothing*/
105 #ifndef HAVE_WGET_WCH
106 #undef USE_WIDE_CURSES
110 * FIXME: a configure check would be useful
119 * Change these if you want
121 #define USE_SHADOW TRUE
122 #define USE_COLORS TRUE
125 #define SCOLS (COLS - (dialog_state.use_shadow ? 2 : 0))
126 #define SLINES (LINES - (dialog_state.use_shadow ? 1 : 0))
132 #define DLG_EXIT_ESC 255
133 #define DLG_EXIT_UNKNOWN -2 /* never return this (internal use) */
134 #define DLG_EXIT_ERROR -1 /* the shell sees this as 255 */
135 #define DLG_EXIT_OK 0
136 #define DLG_EXIT_CANCEL 1
137 #define DLG_EXIT_HELP 2
138 #define DLG_EXIT_EXTRA 3
139 #define DLG_EXIT_ITEM_HELP 4 /* actually DLG_EXIT_HELP */
141 #define DLG_CTRL(n) ((n) & 0x1f) /* CTRL is preferred, but conflicts */
143 #define CHR_BACKSPACE DLG_CTRL('H')
144 #define CHR_REPAINT DLG_CTRL('L')
145 #define CHR_KILL DLG_CTRL('U')
146 #define CHR_LITERAL DLG_CTRL('V')
147 #define CHR_DELETE 127
148 #define CHR_NEXT DLG_CTRL('N')
149 #define CHR_PREVIOUS DLG_CTRL('P')
150 #define CHR_TRACE DLG_CTRL('T')
153 #define TAB DLG_CTRL('I')
157 #define SHADOW_ROWS 1
158 #define SHADOW_COLS 2
162 #define BUF_SIZE (10L*1024)
165 #define MIN(x,y) ((x) < (y) ? (x) : (y))
168 #define MAX(x,y) ((x) > (y) ? (x) : (y))
170 #define DEFAULT_SEPARATE_STR "\t"
171 #define DEFAULT_ASPECT_RATIO 9
172 /* how many spaces is a tab long (default)? */
174 #define WTIMEOUT_VAL 10 /* minimum amount of time needed for curses */
177 #define A_CHARTEXT 0xff
180 #define CharOf(ch) ((ch) & 0xff)
183 #define ACS_ULCORNER '+'
186 #define ACS_LLCORNER '+'
189 #define ACS_URCORNER '+'
192 #define ACS_LRCORNER '+'
195 #define ACS_HLINE '-'
198 #define ACS_VLINE '|'
207 #define ACS_UARROW '^'
210 #define ACS_DARROW 'v'
213 #define ACS_BLOCK '#'
216 /* these definitions may work for antique versions of curses */
217 #ifndef HAVE_GETBEGYX
219 #define getbegyx(win,y,x) (y = (win)?(win)->_begy:ERR, x = (win)?(win)->_begx:ERR)
222 #ifndef HAVE_GETMAXYX
224 #define getmaxyx(win,y,x) (y = (win)?(win)->_maxy:ERR, x = (win)?(win)->_maxx:ERR)
227 #ifndef HAVE_GETPARYX
229 #define getparyx(win,y,x) (y = (win)?(win)->_pary:ERR, x = (win)?(win)->_parx:ERR)
236 /* these definitions may be needed for bleeding-edge curses implementations */
237 #if !(defined(HAVE_GETBEGX) && defined(HAVE_GETBEGY))
240 #define getbegx(win) dlg_getbegx(win)
241 #define getbegy(win) dlg_getbegy(win)
242 extern int dlg_getbegx(WINDOW * /*win*/);
243 extern int dlg_getbegy(WINDOW * /*win*/);
246 #if !(defined(HAVE_GETCURX) && defined(HAVE_GETCURY))
249 #define getcurx(win) dlg_getcurx(win)
250 #define getcury(win) dlg_getcury(win)
251 extern int dlg_getcurx(WINDOW * /*win*/);
252 extern int dlg_getcury(WINDOW * /*win*/);
255 #if !(defined(HAVE_GETMAXX) && defined(HAVE_GETMAXY))
258 #define getmaxx(win) dlg_getmaxx(win)
259 #define getmaxy(win) dlg_getmaxy(win)
260 extern int dlg_getmaxx(WINDOW * /*win*/);
261 extern int dlg_getmaxy(WINDOW * /*win*/);
264 #if !(defined(HAVE_GETPARX) && defined(HAVE_GETPARY))
267 #define getparx(win) dlg_getparx(win)
268 #define getpary(win) dlg_getpary(win)
269 extern int dlg_getparx(WINDOW * /*win*/);
270 extern int dlg_getpary(WINDOW * /*win*/);
274 * This is a list of "old" names, which should be helpful in updating
275 * applications that use libdialog. Starting with 2003/11/26, all exported
276 * symbols from libdialog have "dlg_" prefix, or "dialog_" prefix or "_dialog"
277 * suffix (or suffix "_dialog", e.g., init_dialog).
279 #ifdef __DIALOG_OLD_NAMES__
280 #define color_table dlg_color_table
281 #define attr_clear(win,h,w,a) dlg_attr_clear(win,h,w,a)
282 #define auto_size(t,s,h,w,xl,mc) dlg_auto_size(t,s,h,w,xl,mc)
283 #define auto_sizefile(t,f,h,w,xl,mc) dlg_auto_sizefile(t,f,h,w,xl,mc)
284 #define beeping() dlg_beeping()
285 #define box_x_ordinate(w) dlg_box_x_ordinate(w)
286 #define box_y_ordinate(h) dlg_box_y_ordinate(h)
287 #define calc_listh(h,lh,in) dlg_calc_listh(h,lh,in)
288 #define calc_listw(in,items,group) dlg_calc_listw(in,items,group)
289 #define color_setup() dlg_color_setup()
290 #define create_rc(f) dlg_create_rc(f)
291 #define ctl_size(h,w) dlg_ctl_size(h,w)
292 #define del_window(win) dlg_del_window(win)
293 #define dialog_clear() dlg_clear()
294 #define draw_bottom_box(win) dlg_draw_bottom_box(win)
295 #define draw_box(win,y,x,h,w,xc,bc) dlg_draw_box(win,y,x,h,w,xc,bc)
296 #define draw_shadow(win,h,w,y,x) dlg_draw_shadow(win,h,w,y,x)
297 #define draw_title(win,t) dlg_draw_title(win,t)
298 #define exiterr dlg_exiterr
299 #define killall_bg(n) dlg_killall_bg(n)
300 #define mouse_bigregion(y,x) dlg_mouse_bigregion(y,x)
301 #define mouse_free_regions() dlg_mouse_free_regions()
302 #define mouse_mkbigregion(y,x,h,w,n,ix,iy,m) dlg_mouse_mkbigregion(y,x,h,w,n,ix,iy,m)
303 #define mouse_mkregion(y,x,h,w,n) dlg_mouse_mkregion(y,x,h,w,n)
304 #define mouse_region(y,x) dlg_mouse_region(y,x)
305 #define mouse_setbase(x,y) dlg_mouse_setbase(x,y)
306 #define mouse_wgetch(w,c) dlg_mouse_wgetch(w,c)
307 #define new_window(h,w,y,x) dlg_new_window(h,w,y,x)
308 #define parse_rc() dlg_parse_rc()
309 #define print_autowrap(win,s,h,w) dlg_print_autowrap(win,s,h,w)
310 #define print_size(h,w) dlg_print_size(h,w)
311 #define put_backtitle() dlg_put_backtitle()
312 #define strclone(cprompt) dlg_strclone(cprompt)
313 #define sub_window(win,h,w,y,x) dlg_sub_window(win,h,w,y,x)
314 #define tab_correct_str(s) dlg_tab_correct_str(s)
320 #define DIALOG_ATR(n) dlg_color_table[n].atr
322 #define screen_attr DIALOG_ATR(0)
323 #define shadow_attr DIALOG_ATR(1)
324 #define dialog_attr DIALOG_ATR(2)
325 #define title_attr DIALOG_ATR(3)
326 #define border_attr DIALOG_ATR(4)
327 #define button_active_attr DIALOG_ATR(5)
328 #define button_inactive_attr DIALOG_ATR(6)
329 #define button_key_active_attr DIALOG_ATR(7)
330 #define button_key_inactive_attr DIALOG_ATR(8)
331 #define button_label_active_attr DIALOG_ATR(9)
332 #define button_label_inactive_attr DIALOG_ATR(10)
333 #define inputbox_attr DIALOG_ATR(11)
334 #define inputbox_border_attr DIALOG_ATR(12)
335 #define searchbox_attr DIALOG_ATR(13)
336 #define searchbox_title_attr DIALOG_ATR(14)
337 #define searchbox_border_attr DIALOG_ATR(15)
338 #define position_indicator_attr DIALOG_ATR(16)
339 #define menubox_attr DIALOG_ATR(17)
340 #define menubox_border_attr DIALOG_ATR(18)
341 #define item_attr DIALOG_ATR(19)
342 #define item_selected_attr DIALOG_ATR(20)
343 #define tag_attr DIALOG_ATR(21)
344 #define tag_selected_attr DIALOG_ATR(22)
345 #define tag_key_attr DIALOG_ATR(23)
346 #define tag_key_selected_attr DIALOG_ATR(24)
347 #define check_attr DIALOG_ATR(25)
348 #define check_selected_attr DIALOG_ATR(26)
349 #define uarrow_attr DIALOG_ATR(27)
350 #define darrow_attr DIALOG_ATR(28)
351 #define itemhelp_attr DIALOG_ATR(29)
352 #define form_active_text_attr DIALOG_ATR(30)
353 #define form_text_attr DIALOG_ATR(31)
354 #define form_item_readonly_attr DIALOG_ATR(32)
355 #define gauge_attr DIALOG_ATR(33)
357 #define DLGK_max (KEY_MAX + 256)
360 * Callbacks are used to implement the "background" tailbox.
362 struct _dlg_callback;
364 typedef void (*DIALOG_FREEBACK) (struct _dlg_callback * /* p */);
366 typedef struct _dlg_callback {
367 struct _dlg_callback *next;
370 bool keep_bg; /* keep in background, on exit */
371 bool bg_task; /* true if this is background task */
372 bool (*handle_getc)(struct _dlg_callback *p, int ch, int fkey, int *result);
373 bool keep_win; /* true to not erase window on exit */
374 /* data for dlg_add_callback_ref */
375 struct _dlg_callback **caller;
376 DIALOG_FREEBACK freeback;
378 bool (*handle_input)(struct _dlg_callback *p);
382 typedef struct _dlg_windows {
383 struct _dlg_windows *next;
389 * Global variables, which are initialized as needed
392 DIALOG_CALLBACK *getc_callbacks;
393 DIALOG_CALLBACK *getc_redirect;
394 DIALOG_WINDOWS *all_windows;
395 FILE *output; /* option "--output-fd fd" */
396 FILE *pipe_input; /* used for gauge widget */
397 FILE *screen_output; /* newterm(), etc. */
398 bool screen_initialized;
399 bool use_colors; /* use colors by default? */
400 bool use_scrollbar; /* option "--scrollbar" */
401 bool use_shadow; /* shadow dialog boxes by default? */
402 bool visit_items; /* option "--visit-items" */
403 char *separate_str; /* option "--separate-widget string" */
404 int aspect_ratio; /* option "--aspect ratio" */
405 int output_count; /* # of widgets that may have done output */
406 int tab_len; /* option "--tab-len n" */
408 FILE *input; /* option "--input-fd fd" */
409 #ifdef HAVE_DLG_TRACE
410 FILE *trace_output; /* option "--trace file" */
413 bool no_mouse; /* option "--no-mouse" */
416 extern DIALOG_STATE dialog_state;
419 * Global variables, which dialog resets before each widget
422 bool beep_after_signal; /* option "--beep-after" */
423 bool beep_signal; /* option "--beep" */
424 bool begin_set; /* option "--begin y x" was used */
425 bool cant_kill; /* option "--no-kill" */
426 bool colors; /* option "--colors" */
427 bool cr_wrap; /* option "--cr-wrap" */
428 bool defaultno; /* option "--defaultno" */
429 bool dlg_clear_screen; /* option "--clear" */
430 bool extra_button; /* option "--extra-button" */
431 bool help_button; /* option "--help-button" */
432 bool help_status; /* option "--help-status" */
433 bool input_menu; /* menu vs inputmenu widget */
434 bool insecure; /* option "--insecure" */
435 bool item_help; /* option "--item-help" */
436 bool keep_window; /* option "--keep-window" */
437 bool nocancel; /* option "--no-cancel" */
438 bool nocollapse; /* option "--no-collapse" */
439 bool print_siz; /* option "--print-size" */
440 bool separate_output; /* option "--separate-output" */
441 bool single_quoted; /* option "--single-quoted" */
442 bool size_err; /* option "--size-err" */
443 bool tab_correct; /* option "--tab-correct" */
444 bool trim_whitespace; /* option "--trim" */
445 char *backtitle; /* option "--backtitle backtitle" */
446 char *cancel_label; /* option "--cancel-label string" */
447 char *default_item; /* option "--default-item string" */
448 char *exit_label; /* option "--exit-label string" */
449 char *extra_label; /* option "--extra-label string" */
450 char *help_label; /* option "--help-label string" */
452 char *no_label; /* option "--no-label string" */
453 char *ok_label; /* option "--ok-label string" */
454 char *title; /* option "--title title" */
455 char *yes_label; /* option "--yes-label string" */
456 int begin_x; /* option "--begin y x" (second value) */
457 int begin_y; /* option "--begin y x" (first value) */
458 int max_input; /* option "--max-input size" */
459 int scale_factor; /* RESERVED */
460 int sleep_secs; /* option "--sleep secs" */
461 int timeout_secs; /* option "--timeout secs" */
462 unsigned input_length; /* nonzero if input_result is allocated */
464 unsigned formitem_type; /* DIALOG_FORMITEM.type in dialog_form() */
466 bool keep_tite; /* option "--keep-tite" */
467 bool ascii_lines; /* option "--ascii-lines" */
468 bool no_lines; /* option "--no-lines" */
470 bool nook; /* option "--no-ok" */
472 bool quoted; /* option "--quoted" */
473 char *column_header; /* RESERVED "--column-header" */
474 char *column_separator; /* option "--column-separator" */
475 char *output_separator; /* option "--output-separator" */
477 char *date_format; /* option "--date-format" */
478 char *time_format; /* option "--time-format" */
481 #define USE_ITEM_HELP(s) (dialog_vars.item_help && (s) != 0)
482 #define CHECKBOX_TAGS (dialog_vars.item_help ? 4 : 3)
483 #define MENUBOX_TAGS (dialog_vars.item_help ? 3 : 2)
484 #define FORMBOX_TAGS (dialog_vars.item_help ? 9 : 8)
485 #define MIXEDFORM_TAGS (FORMBOX_TAGS + 1)
486 #define MIXEDGAUGE_TAGS 2
488 extern DIALOG_VARS dialog_vars;
490 #ifndef HAVE_TYPE_CHTYPE
494 #define UCH(ch) ((unsigned char)(ch))
496 #define assert_ptr(ptr,msg) if ((ptr) == 0) dlg_exiterr("cannot allocate memory in " msg)
498 #define dlg_malloc(t,n) (t *) malloc((size_t)(n) * sizeof(t))
499 #define dlg_calloc(t,n) (t *) calloc((size_t)(n), sizeof(t))
500 #define dlg_realloc(t,n,p) (t *) realloc((p), (n) * sizeof(t))
503 * Table for attribute- and color-values.
518 extern DIALOG_COLORS dlg_color_table[];
521 * Function prototypes
523 extern const char *dialog_version(void);
525 /* widgets, each in separate files */
526 extern int dialog_calendar(const char * /*title*/, const char * /*subtitle*/, int /*height*/, int /*width*/, int /*day*/, int /*month*/, int /*year*/);
527 extern int dialog_checklist(const char * /*title*/, const char * /*cprompt*/, int /*height*/, int /*width*/, int /*list_height*/, int /*item_no*/, char ** /*items*/, int /*flag*/);
528 extern int dialog_dselect(const char * /*title*/, const char * /*path*/, int /*height*/, int /*width*/);
529 extern int dialog_editbox(const char * /*title*/, const char * /*file*/, int /*height*/, int /*width*/);
530 extern int dialog_form(const char * /*title*/, const char * /*cprompt*/, int /*height*/, int /*width*/, int /*form_height*/, int /*item_no*/, char ** /*items*/);
531 extern int dialog_fselect(const char * /*title*/, const char * /*path*/, int /*height*/, int /*width*/);
532 extern int dialog_gauge(const char * /*title*/, const char * /*cprompt*/, int /*height*/, int /*width*/, int /*percent*/);
533 extern int dialog_inputbox(const char * /*title*/, const char * /*cprompt*/, int /*height*/, int /*width*/, const char * /*init*/, const int /*password*/);
534 extern int dialog_menu(const char * /*title*/, const char * /*cprompt*/, int /*height*/, int /*width*/, int /*menu_height*/, int /*item_no*/, char ** /*items*/);
535 extern int dialog_mixedform(const char * /*title*/, const char * /*cprompt*/, int /*height*/, int /*width*/, int /*form_height*/, int /*item_no*/, char ** /*items*/);
536 extern int dialog_mixedgauge(const char * /*title*/, const char * /*cprompt*/, int /*height*/, int /*width*/, int /*percent*/, int /*item_no*/, char ** /*items*/);
537 extern int dialog_msgbox(const char * /*title*/, const char * /*cprompt*/, int /*height*/, int /*width*/, int /*pauseopt*/);
538 extern int dialog_pause(const char * /*title*/, const char * /*cprompt*/, int /*height*/, int /*width*/, int /*seconds*/);
539 extern int dialog_prgbox(const char * /*title*/, const char * /*cprompt*/, const char * /*command*/, int /*height*/, int /*width*/, int /*pauseopt*/);
540 extern int dialog_progressbox(const char * /*title*/, const char * /*cprompt*/, int /*height*/, int /*width*/);
541 extern int dialog_tailbox(const char * /*title*/, const char * /*file*/, int /*height*/, int /*width*/, int /*bg_task*/);
542 extern int dialog_textbox(const char * /*title*/, const char * /*file*/, int /*height*/, int /*width*/);
543 extern int dialog_timebox(const char * /*title*/, const char * /*subtitle*/, int /*height*/, int /*width*/, int /*hour*/, int /*minute*/, int /*second*/);
544 extern int dialog_yesno(const char * /*title*/, const char * /*cprompt*/, int /*height*/, int /*width*/);
546 /* some widgets have alternate entrypoints, to allow list manipulation */
555 unsigned type; /* the field type (0=input, 1=password) */
556 char *name; /* the field label */
557 int name_len; /* ...its length */
558 int name_y; /* ...its y-ordinate */
559 int name_x; /* ...its x-ordinate */
560 bool name_free; /* ...true if .name can be freed */
561 char *text; /* the field contents */
562 int text_len; /* ...its length on the screen */
563 int text_y; /* ...its y-ordinate */
564 int text_x; /* ...its x-ordinate */
565 int text_flen; /* ...its length on screen, or 0 if no input allowed */
566 int text_ilen; /* ...its limit on amount to be entered */
567 bool text_free; /* ...true if .text can be freed */
568 char *help; /* help-message, if any */
569 bool help_free; /* ...true if .help can be freed */
572 typedef int (DIALOG_INPUTMENU) (DIALOG_LISTITEM * /*items*/, int /*current*/, char * /*newtext*/);
574 extern int dlg_checklist(const char * /*title*/, const char * /*cprompt*/, int /*height*/, int /*width*/, int /*list_height*/, int /*item_no*/, DIALOG_LISTITEM * /*items*/, const char * /*states*/, int /*flag*/, int * /*current_item*/);
575 extern int dlg_form(const char * /*title*/, const char * /*cprompt*/, int /*height*/, int /*width*/, int /*form_height*/, int /*item_no*/, DIALOG_FORMITEM * /*items*/, int * /*current_item*/);
576 extern int dlg_menu(const char * /*title*/, const char * /*cprompt*/, int /*height*/, int /*width*/, int /*menu_height*/, int /*item_no*/, DIALOG_LISTITEM * /*items*/, int * /*current_item*/, DIALOG_INPUTMENU /*rename_menu*/);
577 extern int dlg_progressbox(const char * /*title*/, const char * /*cprompt*/, int /*height*/, int /*width*/, int /*pauseopt*/, FILE * /* fp */);
580 extern char ** dlg_string_to_argv(char * /* blob */);
581 extern int dlg_count_argv(char ** /* argv */);
582 extern int dlg_eat_argv(int * /* argcp */, char *** /* argvp */, int /* start */, int /* count */);
585 extern void dlg_draw_arrows(WINDOW * /*dialog*/, int /*top_arrow*/, int /*bottom_arrow*/, int /*x*/, int /*top*/, int /*bottom*/);
586 extern void dlg_draw_arrows2(WINDOW * /*dialog*/, int /*top_arrow*/, int /*bottom_arrow*/, int /*x*/, int /*top*/, int /*bottom*/, chtype /*attr*/, chtype /*borderattr*/);
587 extern void dlg_draw_scrollbar(WINDOW * /*dialog*/, long /* first_data */, long /* this_data */, long /* next_data */, long /* total_data */, int /* left */, int /* right */, int /*top*/, int /*bottom*/, chtype /*attr*/, chtype /*borderattr*/);
590 extern const char ** dlg_exit_label(void);
591 extern const char ** dlg_ok_label(void);
592 extern const char ** dlg_ok_labels(void);
593 extern const char ** dlg_yes_labels(void);
594 extern int dlg_button_count(const char ** /*labels*/);
595 extern int dlg_button_to_char(const char * /*label*/);
596 extern int dlg_button_x_step(const char ** /*labels*/, int /*limit*/, int * /*gap*/, int * /*margin*/, int * /*step*/);
597 extern int dlg_char_to_button(int /*ch*/, const char ** /*labels*/);
598 extern int dlg_exit_buttoncode(int /*button*/);
599 extern int dlg_match_char(int /*ch*/, const char * /*string*/);
600 extern int dlg_next_button(const char ** /*labels*/, int /*button*/);
601 extern int dlg_next_ok_buttonindex(int /*current*/, int /*extra*/);
602 extern int dlg_ok_buttoncode(int /*button*/);
603 extern int dlg_prev_button(const char ** /*labels*/, int /*button*/);
604 extern int dlg_prev_ok_buttonindex(int /*current*/, int /*extra*/);
605 extern int dlg_yes_buttoncode(int /*button*/);
606 extern void dlg_button_layout(const char ** /*labels*/, int * /*limit*/);
607 extern void dlg_button_sizes(const char ** /*labels*/, int /*vertical*/, int * /*longest*/, int * /*length*/);
608 extern void dlg_draw_buttons(WINDOW * /*win*/, int /*y*/, int /*x*/, const char ** /*labels*/, int /*selected*/, int /*vertical*/, int /*limit*/);
611 extern void dlg_align_columns(char ** /* target */, int /* per_row */, int /* num_rows */);
612 extern void dlg_free_columns(char ** /* target */, int /* per_row */, int /* num_rows */);
615 extern int dlg_editbox(const char */*title*/, char ***/*list*/, int */*rows*/, int /*height*/, int /*width*/);
618 extern int dlg_default_formitem(DIALOG_FORMITEM * /*items*/);
619 extern int dlg_ordinate(const char * /*s*/);
620 extern void dlg_free_formitems(DIALOG_FORMITEM * /*items*/);
623 extern bool dlg_edit_string(char * /*string*/, int * /*offset*/, int /*key*/, int /*fkey*/, bool /*force*/);
624 extern const int * dlg_index_columns(const char * /*string*/);
625 extern const int * dlg_index_wchars(const char * /*string*/);
626 extern int dlg_count_columns(const char * /*string*/);
627 extern int dlg_count_wchars(const char * /*string*/);
628 extern int dlg_edit_offset(char * /*string*/, int /*offset*/, int /*x_last*/);
629 extern int dlg_find_index(const int * /*list*/, int /*limit*/, int /*to_find*/);
630 extern int dlg_limit_columns(const char * /*string*/, int /*limit*/, int /*offset*/);
631 extern void dlg_show_string(WINDOW * /*win*/, const char * /*string*/, int /*offset*/, chtype /*attr*/, int /*y_base*/, int /*x_base*/, int /*x_last*/, bool /*hidden*/, bool /*force*/);
635 extern int dlg_parse_rc(void);
636 extern void dlg_create_rc(const char * /*filename*/);
640 extern int dlg_getc(WINDOW * /*win*/, int * /*fkey*/);
641 extern int dlg_getc_callbacks(int /*ch*/, int /*fkey*/, int * /*result*/);
642 extern int dlg_last_getc(void);
643 extern void dlg_add_callback(DIALOG_CALLBACK * /*p*/);
644 extern void dlg_add_callback_ref(DIALOG_CALLBACK ** /*p*/, DIALOG_FREEBACK /* cleanup */);
645 extern void dlg_flush_getc(void);
646 extern void dlg_remove_callback(DIALOG_CALLBACK * /*p*/);
647 extern void dlg_killall_bg(int *retval);
650 extern WINDOW * dlg_new_modal_window(WINDOW * /*parent*/, int /*height*/, int /*width*/, int /*y*/, int /*x*/);
651 extern WINDOW * dlg_new_window(int /*height*/, int /*width*/, int /*y*/, int /*x*/);
652 extern WINDOW * dlg_sub_window(WINDOW * /*win*/, int /*height*/, int /*width*/, int /*y*/, int /*x*/);
653 extern bool dlg_need_separator(void);
654 extern char * dlg_set_result(const char * /*string*/);
655 extern char * dlg_strclone(const char * /*cprompt*/);
656 extern char * dlg_strempty(void);
657 extern chtype dlg_asciibox(chtype /*ch*/);
658 extern chtype dlg_boxchar(chtype /*ch*/);
659 extern chtype dlg_get_attrs(WINDOW * /*win*/);
660 extern const char * dlg_print_line(WINDOW */*win*/, chtype */*attr*/, const char */*prompt*/, int /*lm*/, int /*rm*/, int */*x*/);
661 extern int dlg_box_x_ordinate(int /*width*/);
662 extern int dlg_box_y_ordinate(int /*height*/);
663 extern int dlg_calc_list_width(int /*item_no*/, DIALOG_LISTITEM * /*items*/);
664 extern int dlg_calc_listw(int /*item_no*/, char ** /*items*/, int /*group*/);
665 extern int dlg_check_scrolled(int /* key */, int /* last */, int /* page */, bool */* show */, int */* offset */);
666 extern int dlg_default_item(char ** /*items*/, int /*llen*/);
667 extern int dlg_default_listitem(DIALOG_LISTITEM * /*items*/);
668 extern int dlg_defaultno_button(void);
669 extern int dlg_max_input(int /*max_len*/);
670 extern int dlg_print_scrolled(WINDOW * /* win */, const char * /* prompt */, int /* offset */, int /* height */, int /* width */, int /* pauseopt */);
671 extern void dlg_add_quoted(char * /*string*/);
672 extern void dlg_add_result(const char * /*string*/);
673 extern void dlg_add_separator(void);
674 extern void dlg_add_string(char * /*string*/);
675 extern void dlg_attr_clear(WINDOW * /*win*/, int /*height*/, int /*width*/, chtype /*attr*/);
676 extern void dlg_auto_size(const char * /*title*/, const char * /*prompt*/, int * /*height*/, int * /*width*/, int /*boxlines*/, int /*mincols*/);
677 extern void dlg_auto_sizefile(const char * /*title*/, const char * /*file*/, int * /*height*/, int * /*width*/, int /*boxlines*/, int /*mincols*/);
678 extern void dlg_beeping(void);
679 extern void dlg_calc_listh(int * /*height*/, int * /*list_height*/, int /*item_no*/);
680 extern void dlg_clear(void);
681 extern void dlg_clr_result(void);
682 extern void dlg_ctl_size(int /*height*/, int /*width*/);
683 extern void dlg_del_window(WINDOW * /*win*/);
684 extern void dlg_does_output(void);
685 extern void dlg_draw_bottom_box(WINDOW * /*win*/);
686 extern void dlg_draw_box(WINDOW * /*win*/, int /*y*/, int /*x*/, int /*height*/, int /*width*/, chtype /*boxchar*/, chtype /*borderchar*/);
687 extern void dlg_draw_title(WINDOW *win, const char *title);
688 extern void dlg_exit(int /*code*/) GCC_NORETURN;
689 extern void dlg_item_help(const char * /*txt*/);
690 extern void dlg_print_autowrap(WINDOW * /*win*/, const char * /*prompt*/, int /*height*/, int /*width*/);
691 extern void dlg_print_size(int /*height*/, int /*width*/);
692 extern void dlg_print_text(WINDOW * /*win*/, const char * /*txt*/, int /*len*/, chtype * /*attr*/);
693 extern void dlg_put_backtitle(void);
694 extern void dlg_restore_vars(DIALOG_VARS * /* save */);
695 extern void dlg_save_vars(DIALOG_VARS * /* save */);
696 extern void dlg_set_focus(WINDOW * /*parent*/, WINDOW * /*win*/);
697 extern void dlg_tab_correct_str(char * /*prompt*/);
698 extern void dlg_trim_string(char * /*src*/);
699 extern void end_dialog(void);
700 extern void init_dialog(FILE * /*input*/, FILE * /*output*/);
702 extern void dlg_exiterr(const char *, ...) GCC_NORETURN
703 #if defined(__GNUC__) && !defined(printf)
704 __attribute__((format(printf,1,2)))
709 extern chtype dlg_color_pair(int /*foreground*/, int /*background*/);
710 extern int dlg_color_count(void);
711 extern void dlg_color_setup(void);
712 extern void dlg_draw_shadow(WINDOW * /*win*/, int /*height*/, int /*width*/, int /*y*/, int /*x*/);
715 #ifdef HAVE_STRCASECMP
716 #define dlg_strcmp(a,b) strcasecmp(a,b)
718 extern int dlg_strcmp(const char * /*a*/, const char * /*b*/);
721 #ifdef HAVE_DLG_TRACE
722 #define DLG_TRACE(params) dlg_trace_msg params
723 extern void dlg_trace_msg(const char *fmt, ...)
725 __attribute__((format(printf,1,2)))
728 extern void dlg_trace_win(WINDOW * /*win*/);
729 extern void dlg_trace_chr(int /*ch*/, int /*fkey*/);
730 extern void dlg_trace(const char * /*fname*/);
732 #define DLG_TRACE(params) /* nothing */
733 #define dlg_trace_win(win) /* nothing */
734 #define dlg_trace_chr(ch,fkey) /* nothing */
735 #define dlg_trace(fname) /* nothing */
739 extern void dlg_move_window(WINDOW * /*win*/, int /*height*/, int /*width*/, int /*y*/, int /*x*/);
743 * The following stuff is needed for mouse support
745 typedef struct mseRegion {
746 int x, y, X, Y, code;
747 int mode, step_x, step_y;
748 struct mseRegion *next;
751 #if defined(NCURSES_MOUSE_VERSION)
753 #define mouse_open() mousemask(BUTTON1_CLICKED, (mmask_t *) 0)
754 #define mouse_close() mousemask(0, (mmask_t *) 0)
756 extern mseRegion * dlg_mouse_mkregion (int /*y*/, int /*x*/, int /*height*/, int /*width*/, int /*code*/);
757 extern void dlg_mouse_free_regions (void);
758 extern void dlg_mouse_mkbigregion (int /*y*/, int /*x*/, int /*height*/, int /*width*/, int /*code*/, int /*step_x*/, int /*step_y*/, int /*mode*/);
759 extern void dlg_mouse_setbase (int /*x*/, int /*y*/);
765 #define mouse_open() /*nothing*/
766 #define mouse_close() /*nothing*/
767 #define dlg_mouse_free_regions() /* nothing */
768 #define dlg_mouse_mkregion(y, x, height, width, code) /*nothing*/
769 #define dlg_mouse_mkbigregion(y, x, height, width, code, step_x, step_y, mode) /*nothing*/
770 #define dlg_mouse_setbase(x, y) /*nothing*/
776 extern mseRegion *dlg_mouse_region (int /*y*/, int /*x*/);
777 extern mseRegion *dlg_mouse_bigregion (int /*y*/, int /*x*/);
778 extern int dlg_mouse_wgetch (WINDOW * /*win*/, int * /*fkey*/);
779 extern int dlg_mouse_wgetch_nowait (WINDOW * /*win*/, int * /*fkey*/);
781 #define mouse_mkbutton(y,x,len,code) dlg_mouse_mkregion(y,x,1,len,code);
784 * This is the base for fictitious keys, which activate
787 * Mouse-generated keys are the following:
788 * -- the first 32 are used as numbers, in addition to '0'-'9'
789 * -- uppercase chars are used to invoke the button (M_EVENT + 'O')
791 #define M_EVENT (DLGK_max + 1)
794 * The `flag' parameter in checklist is used to select between
795 * radiolist and checklist
801 * This is used only for debugging (FIXME: should have a separate header).
804 extern void _dlg_inputstr_leaks(void);
805 #if defined(NCURSES_VERSION) && defined(HAVE__NC_FREE_AND_EXIT)
806 extern void _nc_free_and_exit(int); /* nc_alloc.h normally not installed */
815 #endif /* DIALOG_H_included */