2 * $Id: dialog.h,v 1.296 2020/03/27 18:28:35 tom Exp $
4 * dialog.h -- common declarations for all dialog modules
6 * Copyright 2000-2019,2020 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 /* header conflict with Solaris xpg4 versus <sys/regset.h> */
48 #if defined(ERR) && (ERR == 13)
52 #if defined(HAVE_NCURSESW_NCURSES_H)
53 #include <ncursesw/ncurses.h>
54 #elif defined(HAVE_NCURSES_NCURSES_H)
55 #include <ncurses/ncurses.h>
56 #elif defined(HAVE_NCURSES_CURSES_H)
57 #include <ncurses/curses.h>
58 #elif defined(HAVE_NCURSES_H)
62 #if defined(HAVE_UNCTRL_H)
63 #include <unctrl.h> /* most curses.h headers include this, some do not */
67 /* Solaris xpg4 renames these */
70 #define KEY_MAX __KEY_MAX
76 #define KEY_MIN __KEY_MIN
80 /* possible conflicts with <term.h> which may be included in <curses.h> */
92 #define _(s) dgettext(PACKAGE, s)
98 #ifndef GCC_PRINTFLIKE
99 #define GCC_PRINTFLIKE(fmt,var) /*nothing*/
103 #define GCC_NORETURN /*nothing*/
107 #define GCC_UNUSED /*nothing*/
110 #ifndef HAVE_WGET_WCH
111 #undef USE_WIDE_CURSES
115 * FIXME: a configure check would be useful
124 * Change these if you want
126 #define USE_SHADOW TRUE
127 #define USE_COLORS TRUE
130 * These allow using the print-formatting code before curses is initialized.
132 #define DLG_COLS (COLS ? COLS : dialog_state.screen_width)
133 #define DLG_LINES (LINES ? LINES : dialog_state.screen_height)
136 * Define the usable size of a window, discounting the area needed for shadow.
139 #define SCOLS (DLG_COLS - (dialog_state.use_shadow ? SHADOW_COLS : 0))
140 #define SLINES (DLG_LINES - (dialog_state.use_shadow ? SHADOW_ROWS : 0))
147 * These are the default values for exit-codes, which can be overridden by
148 * environment variables, e.g., $DIALOG_CANCEL for DLG_EXIT_CANCEL.
150 #define DLG_EXIT_ESC 255
151 #define DLG_EXIT_UNKNOWN -2 /* never return this (internal use) */
152 #define DLG_EXIT_ERROR -1 /* the shell sees this as 255 */
153 #define DLG_EXIT_OK 0
154 #define DLG_EXIT_CANCEL 1
155 #define DLG_EXIT_HELP 2
156 #define DLG_EXIT_EXTRA 3
157 #define DLG_EXIT_ITEM_HELP 4 /* actually DLG_EXIT_HELP */
159 #define DLG_CTRL(n) ((n) & 0x1f) /* CTRL is preferred, but conflicts */
161 #define CHR_HELP DLG_CTRL('E')
162 #define CHR_BACKSPACE DLG_CTRL('H')
163 #define CHR_REPAINT DLG_CTRL('L')
164 #define CHR_KILL DLG_CTRL('U')
165 #define CHR_LITERAL DLG_CTRL('V')
166 #define CHR_DELETE 127
167 #define CHR_NEXT DLG_CTRL('N')
168 #define CHR_PREVIOUS DLG_CTRL('P')
169 #define CHR_TRACE DLG_CTRL('T')
170 #define CHR_SPACE ' '
173 #define TAB DLG_CTRL('I')
175 #define MARGIN 1 /* width of the line drawn around each box */
176 #define GUTTER 2 /* minimum columns between name/description in menu */
177 #define SHADOW_ROWS 1 /* rows to reserve for window's shadow */
178 #define SHADOW_COLS 2 /* columns to reserve for window's shadow */
179 #define ARROWS_COL 5 /* distance from left margin to up/down arrows */
182 #define BUF_SIZE (10L*1024)
185 #define MIN(x,y) ((x) < (y) ? (x) : (y))
188 #define MAX(x,y) ((x) > (y) ? (x) : (y))
190 #define DEFAULT_SEPARATE_STR "\t"
191 #define DEFAULT_ASPECT_RATIO 9
192 /* how many spaces is a tab long (default)? */
194 #define WTIMEOUT_VAL 10 /* minimum amount of time needed for curses */
195 #define WTIMEOUT_OFF -1 /* value to disable timeout */
198 #define A_CHARTEXT 0xff
201 #define CharOf(ch) ((ch) & 0xff)
204 #define ACS_ULCORNER '+'
207 #define ACS_LLCORNER '+'
210 #define ACS_URCORNER '+'
213 #define ACS_LRCORNER '+'
216 #define ACS_HLINE '-'
219 #define ACS_VLINE '|'
228 #define ACS_UARROW '^'
231 #define ACS_DARROW 'v'
234 #define ACS_BLOCK '#'
237 /* these definitions may work for antique versions of curses */
238 #ifndef HAVE_GETBEGYX
240 #define getbegyx(win,y,x) (y = (win)?(win)->_begy:ERR, x = (win)?(win)->_begx:ERR)
243 #ifndef HAVE_GETMAXYX
245 #define getmaxyx(win,y,x) (y = (win)?(win)->_maxy:ERR, x = (win)?(win)->_maxx:ERR)
248 #ifndef HAVE_GETPARYX
250 #define getparyx(win,y,x) (y = (win)?(win)->_pary:ERR, x = (win)?(win)->_parx:ERR)
253 #if !defined(HAVE_WGETPARENT) && defined(HAVE_WINDOW__PARENT)
255 #define wgetparent(win) ((win) ? (win)->_parent : 0)
258 #if !defined(HAVE_WSYNCUP)
260 #define wsyncup(win) /* nothing */
263 #if !defined(HAVE_WCURSYNCUP)
265 #define wcursyncup(win) /* nothing */
272 /* these definitions may be needed for bleeding-edge curses implementations */
273 #if !(defined(HAVE_GETBEGX) && defined(HAVE_GETBEGY))
276 #define getbegx(win) dlg_getbegx(win)
277 #define getbegy(win) dlg_getbegy(win)
278 extern int dlg_getbegx(WINDOW * /*win*/);
279 extern int dlg_getbegy(WINDOW * /*win*/);
282 #if !(defined(HAVE_GETCURX) && defined(HAVE_GETCURY))
285 #define getcurx(win) dlg_getcurx(win)
286 #define getcury(win) dlg_getcury(win)
287 extern int dlg_getcurx(WINDOW * /*win*/);
288 extern int dlg_getcury(WINDOW * /*win*/);
291 #if !(defined(HAVE_GETMAXX) && defined(HAVE_GETMAXY))
294 #define getmaxx(win) dlg_getmaxx(win)
295 #define getmaxy(win) dlg_getmaxy(win)
296 extern int dlg_getmaxx(WINDOW * /*win*/);
297 extern int dlg_getmaxy(WINDOW * /*win*/);
300 #if !(defined(HAVE_GETPARX) && defined(HAVE_GETPARY))
303 #define getparx(win) dlg_getparx(win)
304 #define getpary(win) dlg_getpary(win)
305 extern int dlg_getparx(WINDOW * /*win*/);
306 extern int dlg_getpary(WINDOW * /*win*/);
309 #if !(defined(HAVE_WGETPARENT) && defined(HAVE_WINDOW__PARENT))
311 #define wgetparent(win) dlg_wgetparent(win)
312 extern WINDOW * dlg_wgetparent(WINDOW * /*win*/);
316 * This is a list of "old" names, which should be helpful in updating
317 * applications that use libdialog. Starting with 2003/11/26, all exported
318 * symbols from libdialog have "dlg_" prefix, or "dialog_" prefix or "_dialog"
319 * suffix (or suffix "_dialog", e.g., init_dialog).
321 #ifdef __DIALOG_OLD_NAMES__
322 #define color_table dlg_color_table
323 #define attr_clear(win,h,w,a) dlg_attr_clear(win,h,w,a)
324 #define auto_size(t,s,h,w,xl,mc) dlg_auto_size(t,s,h,w,xl,mc)
325 #define auto_sizefile(t,f,h,w,xl,mc) dlg_auto_sizefile(t,f,h,w,xl,mc)
326 #define beeping() dlg_beeping()
327 #define box_x_ordinate(w) dlg_box_x_ordinate(w)
328 #define box_y_ordinate(h) dlg_box_y_ordinate(h)
329 #define calc_listh(h,lh,in) dlg_calc_listh(h,lh,in)
330 #define calc_listw(in,items,group) dlg_calc_listw(in,items,group)
331 #define color_setup() dlg_color_setup()
332 #define create_rc(f) dlg_create_rc(f)
333 #define ctl_size(h,w) dlg_ctl_size(h,w)
334 #define del_window(win) dlg_del_window(win)
335 #define dialog_clear() dlg_clear()
336 #define draw_bottom_box(win) dlg_draw_bottom_box(win)
337 #define draw_box(win,y,x,h,w,xc,bc) dlg_draw_box(win,y,x,h,w,xc,bc)
338 #define draw_shadow(win,h,w,y,x) dlg_draw_shadow(win,h,w,y,x)
339 #define draw_title(win,t) dlg_draw_title(win,t)
340 #define exiterr dlg_exiterr
341 #define killall_bg(n) dlg_killall_bg(n)
342 #define mouse_bigregion(y,x) dlg_mouse_bigregion(y,x)
343 #define mouse_free_regions() dlg_mouse_free_regions()
344 #define mouse_mkbigregion(y,x,h,w,n,ix,iy,m) dlg_mouse_mkbigregion(y,x,h,w,n,ix,iy,m)
345 #define mouse_mkregion(y,x,h,w,n) dlg_mouse_mkregion(y,x,h,w,n)
346 #define mouse_region(y,x) dlg_mouse_region(y,x)
347 #define mouse_setbase(x,y) dlg_mouse_setbase(x,y)
348 #define mouse_setcode(c) dlg_mouse_setcode(c)
349 #define mouse_wgetch(w,c) dlg_mouse_wgetch(w,c)
350 #define new_window(h,w,y,x) dlg_new_window(h,w,y,x)
351 #define parse_rc() dlg_parse_rc()
352 #define print_autowrap(win,s,h,w) dlg_print_autowrap(win,s,h,w)
353 #define print_size(h,w) dlg_print_size(h,w)
354 #define put_backtitle() dlg_put_backtitle()
355 #define strclone(cprompt) dlg_strclone(cprompt)
356 #define sub_window(win,h,w,y,x) dlg_sub_window(win,h,w,y,x)
357 #define tab_correct_str(s) dlg_tab_correct_str(s)
363 #define DIALOG_ATR(n) dlg_color_table[n].atr
365 #define screen_attr DIALOG_ATR(0)
366 #define shadow_attr DIALOG_ATR(1)
367 #define dialog_attr DIALOG_ATR(2)
368 #define title_attr DIALOG_ATR(3)
369 #define border_attr DIALOG_ATR(4)
370 #define button_active_attr DIALOG_ATR(5)
371 #define button_inactive_attr DIALOG_ATR(6)
372 #define button_key_active_attr DIALOG_ATR(7)
373 #define button_key_inactive_attr DIALOG_ATR(8)
374 #define button_label_active_attr DIALOG_ATR(9)
375 #define button_label_inactive_attr DIALOG_ATR(10)
376 #define inputbox_attr DIALOG_ATR(11)
377 #define inputbox_border_attr DIALOG_ATR(12)
378 #define searchbox_attr DIALOG_ATR(13)
379 #define searchbox_title_attr DIALOG_ATR(14)
380 #define searchbox_border_attr DIALOG_ATR(15)
381 #define position_indicator_attr DIALOG_ATR(16)
382 #define menubox_attr DIALOG_ATR(17)
383 #define menubox_border_attr DIALOG_ATR(18)
384 #define item_attr DIALOG_ATR(19)
385 #define item_selected_attr DIALOG_ATR(20)
386 #define tag_attr DIALOG_ATR(21)
387 #define tag_selected_attr DIALOG_ATR(22)
388 #define tag_key_attr DIALOG_ATR(23)
389 #define tag_key_selected_attr DIALOG_ATR(24)
390 #define check_attr DIALOG_ATR(25)
391 #define check_selected_attr DIALOG_ATR(26)
392 #define uarrow_attr DIALOG_ATR(27)
393 #define darrow_attr DIALOG_ATR(28)
394 #define itemhelp_attr DIALOG_ATR(29)
395 #define form_active_text_attr DIALOG_ATR(30)
396 #define form_text_attr DIALOG_ATR(31)
397 #define form_item_readonly_attr DIALOG_ATR(32)
398 #define gauge_attr DIALOG_ATR(33)
399 #define border2_attr DIALOG_ATR(34)
400 #define inputbox_border2_attr DIALOG_ATR(35)
401 #define searchbox_border2_attr DIALOG_ATR(36)
402 #define menubox_border2_attr DIALOG_ATR(37)
404 #define DLGK_max (KEY_MAX + 256)
410 #define dlg_attrset(w,a) (void) wattrset((w), (a))
411 #define dlg_attron(w,a) (void) wattron((w), (a))
412 #define dlg_attroff(w,a) (void) wattroff((w), (a))
414 #define dlg_attrset(w,a) (void) wattrset((w), (int)(a))
415 #define dlg_attron(w,a) (void) wattron((w), (int)(a))
416 #define dlg_attroff(w,a) (void) wattroff((w), (int)(a))
420 * Callbacks are used to implement the "background" tailbox.
422 struct _dlg_callback;
424 typedef void (*DIALOG_FREEBACK) (struct _dlg_callback * /* p */);
426 typedef struct _dlg_callback {
427 struct _dlg_callback *next;
430 bool keep_bg; /* keep in background, on exit */
431 bool bg_task; /* true if this is background task */
432 bool (*handle_getc)(struct _dlg_callback *p, int ch, int fkey, int *result);
433 bool keep_win; /* true to not erase window on exit */
434 /* data for dlg_add_callback_ref */
435 struct _dlg_callback **caller;
436 DIALOG_FREEBACK freeback;
438 bool (*handle_input)(struct _dlg_callback *p);
442 typedef struct _dlg_windows {
443 struct _dlg_windows *next;
450 * Global variables, which are initialized as needed
453 DIALOG_CALLBACK *getc_callbacks;
454 DIALOG_CALLBACK *getc_redirect;
455 DIALOG_WINDOWS *all_windows;
456 DIALOG_WINDOWS *all_subwindows;
457 FILE *output; /* option "--output-fd fd" */
458 FILE *pipe_input; /* used for gauge widget */
459 FILE *screen_output; /* newterm(), etc. */
460 bool screen_initialized;
461 bool use_colors; /* use colors by default? */
462 bool use_scrollbar; /* option "--scrollbar" */
463 bool use_shadow; /* shadow dialog boxes by default? */
464 bool visit_items; /* option "--visit-items" */
465 char *separate_str; /* option "--separate-widget string" */
466 int aspect_ratio; /* option "--aspect ratio" */
467 int output_count; /* # of widgets that may have done output */
468 int tab_len; /* option "--tab-len n" */
470 FILE *input; /* option "--input-fd fd" */
471 #ifdef HAVE_DLG_TRACE
472 FILE *trace_output; /* option "--trace file" */
475 bool no_mouse; /* option "--no-mouse" */
476 int visit_cols; /* option "--visit-items" */
478 bool finish_string; /* caching optimization for gauge */
480 bool plain_buttons; /* true to suppress button-label highlight */
482 bool text_only; /* option "--print-text-only", etc. */
490 bool had_resize; /* ERR may follow KEY_RESIZE when polling */
494 extern DIALOG_STATE dialog_state;
497 * Global variables, which dialog resets before each widget
500 bool beep_after_signal; /* option "--beep-after" */
501 bool beep_signal; /* option "--beep" */
502 bool begin_set; /* option "--begin y x" was used */
503 bool cant_kill; /* option "--no-kill" */
504 bool colors; /* option "--colors" */
505 bool cr_wrap; /* option "--cr-wrap" */
506 bool defaultno; /* option "--defaultno" */
507 bool dlg_clear_screen; /* option "--clear" */
508 bool extra_button; /* option "--extra-button" */
509 bool help_button; /* option "--help-button" */
510 bool help_status; /* option "--help-status" */
511 bool input_menu; /* menu vs inputmenu widget */
512 bool insecure; /* option "--insecure" */
513 bool item_help; /* option "--item-help" */
514 bool keep_window; /* option "--keep-window" */
515 bool nocancel; /* option "--no-cancel" */
516 bool nocollapse; /* option "--no-collapse" */
517 bool print_siz; /* option "--print-size" */
518 bool separate_output; /* option "--separate-output" */
519 bool single_quoted; /* option "--single-quoted" */
520 bool size_err; /* option "--size-err" */
521 bool tab_correct; /* option "--tab-correct" */
522 bool trim_whitespace; /* option "--trim" */
523 char *backtitle; /* option "--backtitle backtitle" */
524 char *cancel_label; /* option "--cancel-label string" */
525 char *default_item; /* option "--default-item string" */
526 char *exit_label; /* option "--exit-label string" */
527 char *extra_label; /* option "--extra-label string" */
528 char *help_label; /* option "--help-label string" */
530 char *no_label; /* option "--no-label string" */
531 char *ok_label; /* option "--ok-label string" */
532 char *title; /* option "--title title" */
533 char *yes_label; /* option "--yes-label string" */
534 int begin_x; /* option "--begin y x" (second value) */
535 int begin_y; /* option "--begin y x" (first value) */
536 int max_input; /* option "--max-input size" */
537 int scale_factor; /* RESERVED */
538 int sleep_secs; /* option "--sleep secs" */
539 int timeout_secs; /* option "--timeout secs" */
540 unsigned input_length; /* nonzero if input_result is allocated */
542 unsigned formitem_type; /* DIALOG_FORMITEM.type in dialog_form() */
544 bool keep_tite; /* option "--keep-tite" */
545 bool ascii_lines; /* option "--ascii-lines" */
546 bool no_lines; /* option "--no-lines" */
548 bool nook; /* option "--no-ok" */
550 bool quoted; /* option "--quoted" */
551 char *column_header; /* RESERVED "--column-header" */
552 char *column_separator; /* option "--column-separator" */
553 char *output_separator; /* option "--output-separator" */
555 char *date_format; /* option "--date-format" */
556 char *time_format; /* option "--time-format" */
558 char *help_line; /* option "--hline" */
559 char *help_file; /* option "--hfile" */
560 bool in_helpfile; /* flag to prevent recursion in --hfile */
561 bool no_nl_expand; /* option "--no-nl-expand" */
563 int default_button; /* option "--default-button" (exit code) */
565 bool no_tags; /* option "--no-tags" */
566 bool no_items; /* option "--no-items" */
568 bool last_key; /* option "--last-key" */
570 bool help_tags; /* option "--help-tags" */
572 char *week_start; /* option "--week-start" */
574 bool iso_week; /* option "--iso-week" */
576 bool reorder; /* option "--reorder" */
579 #define USE_ITEM_HELP(s) (dialog_vars.item_help && (s) != 0)
582 * Some settings change the number of data items per row which dialog reads
585 #define DLG__NO_ITEMS (dialog_vars.no_items ? 0 : 1)
586 #define DLG__ITEM_HELP (dialog_vars.item_help ? 1 : 0)
589 * These are the total number of data items per row used for each widget type.
591 #define CHECKBOX_TAGS (2 + DLG__ITEM_HELP + DLG__NO_ITEMS)
592 #define MENUBOX_TAGS (1 + DLG__ITEM_HELP + DLG__NO_ITEMS)
593 #define FORMBOX_TAGS (8 + DLG__ITEM_HELP)
594 #define MIXEDFORM_TAGS (1 + FORMBOX_TAGS)
595 #define MIXEDGAUGE_TAGS 2
596 #define TREEVIEW_TAGS (3 + DLG__ITEM_HELP + DLG__NO_ITEMS)
598 extern DIALOG_VARS dialog_vars;
600 #ifndef HAVE_TYPE_CHTYPE
605 #define isblank(c) ((c) == ' ' || (c) == TAB)
608 #define UCH(ch) ((unsigned char)(ch))
610 #define assert_ptr(ptr,msg) if ((ptr) == 0) dlg_exiterr("cannot allocate memory in " msg)
612 #define dlg_malloc(t,n) (t *) malloc((size_t)(n) * sizeof(t))
613 #define dlg_calloc(t,n) (t *) calloc((size_t)(n), sizeof(t))
614 #define dlg_realloc(t,n,p) (t *) realloc((p), (n) * sizeof(t))
617 * Table for attribute- and color-values.
620 chtype atr; /* attribute corresponding to fg, bg, etc */
622 int fg; /* foreground color-number */
623 int bg; /* background color-number */
624 int hilite; /* true if bold */
626 int ul; /* true if underline */
627 int rv; /* true if reverse */
628 #endif /* HAVE_RC_FILE2 */
629 #endif /* HAVE_COLOR */
636 extern DIALOG_COLORS dlg_color_table[];
639 * Function prototypes
641 extern const char *dialog_version(void);
643 /* widgets, each in separate files */
644 extern int dialog_buildlist(const char * /*title*/, const char * /*cprompt*/, int /*height*/, int /*width*/, int /*list_height*/, int /*item_no*/, char ** /*items*/, int /*order_mode*/);
645 extern int dialog_calendar(const char * /*title*/, const char * /*subtitle*/, int /*height*/, int /*width*/, int /*day*/, int /*month*/, int /*year*/);
646 extern int dialog_checklist(const char * /*title*/, const char * /*cprompt*/, int /*height*/, int /*width*/, int /*list_height*/, int /*item_no*/, char ** /*items*/, int /*flag*/);
647 extern int dialog_dselect(const char * /*title*/, const char * /*path*/, int /*height*/, int /*width*/);
648 extern int dialog_editbox(const char * /*title*/, const char * /*file*/, int /*height*/, int /*width*/);
649 extern int dialog_form(const char * /*title*/, const char * /*cprompt*/, int /*height*/, int /*width*/, int /*form_height*/, int /*item_no*/, char ** /*items*/);
650 extern int dialog_fselect(const char * /*title*/, const char * /*path*/, int /*height*/, int /*width*/);
651 extern int dialog_gauge(const char * /*title*/, const char * /*cprompt*/, int /*height*/, int /*width*/, int /*percent*/);
652 extern int dialog_helpfile(const char * /*title*/, const char * /*file*/, int /*height*/, int /*width*/);
653 extern int dialog_inputbox(const char * /*title*/, const char * /*cprompt*/, int /*height*/, int /*width*/, const char * /*init*/, const int /*password*/);
654 extern int dialog_menu(const char * /*title*/, const char * /*cprompt*/, int /*height*/, int /*width*/, int /*menu_height*/, int /*item_no*/, char ** /*items*/);
655 extern int dialog_mixedform(const char * /*title*/, const char * /*cprompt*/, int /*height*/, int /*width*/, int /*form_height*/, int /*item_no*/, char ** /*items*/);
656 extern int dialog_mixedgauge(const char * /*title*/, const char * /*cprompt*/, int /*height*/, int /*width*/, int /*percent*/, int /*item_no*/, char ** /*items*/);
657 extern int dialog_msgbox(const char * /*title*/, const char * /*cprompt*/, int /*height*/, int /*width*/, int /*pauseopt*/);
658 extern int dialog_pause(const char * /*title*/, const char * /*cprompt*/, int /*height*/, int /*width*/, int /*seconds*/);
659 extern int dialog_prgbox(const char * /*title*/, const char * /*cprompt*/, const char * /*command*/, int /*height*/, int /*width*/, int /*pauseopt*/);
660 extern int dialog_progressbox(const char * /*title*/, const char * /*cprompt*/, int /*height*/, int /*width*/);
661 extern int dialog_rangebox(const char * /*title*/, const char * /*file*/, int /*height*/, int /*width*/, int /*min_value*/, int /*max_value*/, int /*default_value*/);
662 extern int dialog_tailbox(const char * /*title*/, const char * /*file*/, int /*height*/, int /*width*/, int /*bg_task*/);
663 extern int dialog_textbox(const char * /*title*/, const char * /*file*/, int /*height*/, int /*width*/);
664 extern int dialog_timebox(const char * /*title*/, const char * /*subtitle*/, int /*height*/, int /*width*/, int /*hour*/, int /*minute*/, int /*second*/);
665 extern int dialog_treeview(const char * /*title*/, const char * /*subtitle*/, int /*height*/, int /*width*/, int /*list_height*/, int /*item_no*/, char ** /*items*/, int /*flag*/);
666 extern int dialog_yesno(const char * /*title*/, const char * /*cprompt*/, int /*height*/, int /*width*/);
668 /* some widgets have alternate entrypoints, to allow list manipulation */
677 unsigned type; /* the field type (0=input, 1=password) */
678 char *name; /* the field label */
679 int name_len; /* ...its length */
680 int name_y; /* ...its y-ordinate */
681 int name_x; /* ...its x-ordinate */
682 bool name_free; /* ...true if .name can be freed */
683 char *text; /* the field contents */
684 int text_len; /* ...its length on the screen */
685 int text_y; /* ...its y-ordinate */
686 int text_x; /* ...its x-ordinate */
687 int text_flen; /* ...its length on screen, or 0 if no input allowed */
688 int text_ilen; /* ...its limit on amount to be entered */
689 bool text_free; /* ...true if .text can be freed */
690 char *help; /* help-message, if any */
691 bool help_free; /* ...true if .help can be freed */
694 typedef int (DIALOG_INPUTMENU) (DIALOG_LISTITEM * /*items*/, int /*current*/, char * /*newtext*/);
696 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*/);
697 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*/);
698 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*/);
699 extern int dlg_progressbox(const char * /*title*/, const char * /*cprompt*/, int /*height*/, int /*width*/, int /*pauseopt*/, FILE * /* fp */);
702 extern char ** dlg_string_to_argv(char * /* blob */);
703 extern int dlg_count_argv(char ** /* argv */);
704 extern int dlg_eat_argv(int * /* argcp */, char *** /* argvp */, int /* start */, int /* count */);
707 extern void dlg_draw_arrows(WINDOW * /*dialog*/, int /*top_arrow*/, int /*bottom_arrow*/, int /*x*/, int /*top*/, int /*bottom*/);
708 extern void dlg_draw_arrows2(WINDOW * /*dialog*/, int /*top_arrow*/, int /*bottom_arrow*/, int /*x*/, int /*top*/, int /*bottom*/, chtype /*attr*/, chtype /*borderattr*/);
709 extern void dlg_draw_helpline(WINDOW * /*dialog*/, bool /*decorations*/);
710 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*/);
713 extern int dlg_buildlist(const char * /*title*/, const char * /*cprompt*/, int /*height*/, int /*width*/, int /*list_height*/, int /*item_no*/, DIALOG_LISTITEM * /*items*/, const char * /*states*/, int /*order_mode*/, int * /*current_item*/);
716 extern const char ** dlg_exit_label(void);
717 extern const char ** dlg_ok_label(void);
718 extern const char ** dlg_ok_labels(void);
719 extern const char ** dlg_yes_labels(void);
720 extern int dlg_button_count(const char ** /*labels*/);
721 extern int dlg_button_to_char(const char * /*label*/);
722 extern int dlg_button_x_step(const char ** /*labels*/, int /*limit*/, int * /*gap*/, int * /*margin*/, int * /*step*/);
723 extern int dlg_char_to_button(int /*ch*/, const char ** /*labels*/);
724 extern int dlg_exit_buttoncode(int /*button*/);
725 extern int dlg_match_char(int /*ch*/, const char * /*string*/);
726 extern int dlg_next_button(const char ** /*labels*/, int /*button*/);
727 extern int dlg_next_ok_buttonindex(int /*current*/, int /*extra*/);
728 extern int dlg_ok_buttoncode(int /*button*/);
729 extern int dlg_prev_button(const char ** /*labels*/, int /*button*/);
730 extern int dlg_prev_ok_buttonindex(int /*current*/, int /*extra*/);
731 extern int dlg_yes_buttoncode(int /*button*/);
732 extern void dlg_button_layout(const char ** /*labels*/, int * /*limit*/);
733 extern void dlg_button_sizes(const char ** /*labels*/, int /*vertical*/, int * /*longest*/, int * /*length*/);
734 extern void dlg_draw_buttons(WINDOW * /*win*/, int /*y*/, int /*x*/, const char ** /*labels*/, int /*selected*/, int /*vertical*/, int /*limit*/);
737 extern void dlg_align_columns(char ** /* target */, int /* per_row */, int /* num_rows */);
738 extern void dlg_free_columns(char ** /* target */, int /* per_row */, int /* num_rows */);
741 extern int dlg_editbox(const char * /*title*/, char *** /*list*/, int * /*rows*/, int /*height*/, int /*width*/);
744 extern int dlg_default_formitem(DIALOG_FORMITEM * /*items*/);
745 extern int dlg_ordinate(const char * /*s*/);
746 extern void dlg_free_formitems(DIALOG_FORMITEM * /*items*/);
749 extern void * dlg_allocate_gauge(const char * /* title */, const char * /* cprompt */, int /* height */, int /* width */, int /* percent */);
750 extern void * dlg_reallocate_gauge(void * /* objptr */, const char * /* title */, const char * /* cprompt */, int /* height */, int /* width */, int /* percent */);
751 extern void dlg_free_gauge(void * /* objptr */);
752 extern void dlg_update_gauge(void * /* objptr */, int /* percent */);
755 extern bool dlg_edit_string(char * /*string*/, int * /*offset*/, int /*key*/, int /*fkey*/, bool /*force*/);
756 extern const int * dlg_index_columns(const char * /*string*/);
757 extern const int * dlg_index_wchars(const char * /*string*/);
758 extern int dlg_count_columns(const char * /*string*/);
759 extern int dlg_count_wchars(const char * /*string*/);
760 extern int dlg_edit_offset(char * /*string*/, int /*offset*/, int /*x_last*/);
761 extern int dlg_find_index(const int * /*list*/, int /*limit*/, int /*to_find*/);
762 extern int dlg_limit_columns(const char * /*string*/, int /*limit*/, int /*offset*/);
763 extern void dlg_finish_string(const char * /* string */);
764 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*/);
767 extern int dlg_dummy_menutext(DIALOG_LISTITEM * /*items*/, int /*current*/, char * /*newtext*/);
768 extern int dlg_renamed_menutext(DIALOG_LISTITEM * /*items*/, int /*current*/, char * /*newtext*/);
771 extern FILE * dlg_popen(const char * /*command */, const char * /*type */);
775 extern int dlg_parse_rc(void);
776 extern void dlg_create_rc(const char * /*filename*/);
780 extern int dlg_treeview(const char * /*title*/, const char * /*cprompt*/, int /*height*/, int /*width*/, int /*list_height*/, int /*item_no*/, DIALOG_LISTITEM * /*items*/, const char * /*states*/, int * /*depths*/, int /*flag*/, int * /*current_item*/);
783 extern int dlg_ttysize(int /* fd */, int * /* height */, int * /* width */);
786 extern int dlg_getc(WINDOW * /*win*/, int * /*fkey*/);
787 extern int dlg_getc_callbacks(int /*ch*/, int /*fkey*/, int * /*result*/);
788 extern int dlg_last_getc(void);
789 extern void dlg_add_last_key(int /*mode*/);
790 extern void dlg_add_callback(DIALOG_CALLBACK * /*p*/);
791 extern void dlg_add_callback_ref(DIALOG_CALLBACK ** /*p*/, DIALOG_FREEBACK /* cleanup */);
792 extern void dlg_flush_getc(void);
793 extern void dlg_remove_callback(DIALOG_CALLBACK * /*p*/);
794 extern void dlg_killall_bg(int *retval);
797 extern WINDOW * dlg_new_modal_window(WINDOW * /*parent*/, int /*height*/, int /*width*/, int /*y*/, int /*x*/);
798 extern WINDOW * dlg_new_window(int /*height*/, int /*width*/, int /*y*/, int /*x*/);
799 extern WINDOW * dlg_sub_window(WINDOW * /*win*/, int /*height*/, int /*width*/, int /*y*/, int /*x*/);
800 extern bool dlg_need_separator(void);
801 extern char * dlg_set_result(const char * /*string*/);
802 extern char * dlg_strclone(const char * /*cprompt*/);
803 extern char * dlg_strempty(void);
804 extern chtype dlg_asciibox(chtype /*ch*/);
805 extern chtype dlg_boxchar(chtype /*ch*/);
806 extern chtype dlg_get_attrs(WINDOW * /*win*/);
807 extern const char * dlg_exitcode2s(int /*code*/);
808 extern const char * dlg_print_line(WINDOW * /*win*/, chtype * /*attr*/, const char * /*prompt*/, int /*lm*/, int /*rm*/, int * /*x*/);
809 extern int dlg_box_x_ordinate(int /*width*/);
810 extern int dlg_box_y_ordinate(int /*height*/);
811 extern int dlg_calc_list_width(int /*item_no*/, DIALOG_LISTITEM * /*items*/);
812 extern int dlg_calc_listw(int /*item_no*/, char ** /*items*/, int /*group*/);
813 extern int dlg_check_scrolled(int /* key */, int /* last */, int /* page */, bool * /* show */, int * /* offset */);
814 extern int dlg_count_real_columns(const char * /*text*/);
815 extern int dlg_default_item(char ** /*items*/, int /*llen*/);
816 extern int dlg_default_listitem(DIALOG_LISTITEM * /*items*/);
817 extern int dlg_defaultno_button(void);
818 extern int dlg_default_button(void);
819 extern int dlg_exitname2n(const char * /*name*/);
820 extern int dlg_max_input(int /*max_len*/);
821 extern int dlg_print_scrolled(WINDOW * /* win */, const char * /* prompt */, int /* offset */, int /* height */, int /* width */, int /* pauseopt */);
822 extern int dlg_set_timeout(WINDOW * /* win */, bool /* will_getc */);
823 extern void dlg_add_help_formitem(int * /* result */, char ** /* tag */, DIALOG_FORMITEM * /* item */);
824 extern void dlg_add_help_listitem(int * /* result */, char ** /* tag */, DIALOG_LISTITEM * /* item */);
825 extern void dlg_add_quoted(char * /*string*/);
826 extern void dlg_add_result(const char * /*string*/);
827 extern void dlg_add_separator(void);
828 extern void dlg_add_string(char * /*string*/);
829 extern void dlg_attr_clear(WINDOW * /*win*/, int /*height*/, int /*width*/, chtype /*attr*/);
830 extern void dlg_auto_size(const char * /*title*/, const char * /*prompt*/, int * /*height*/, int * /*width*/, int /*boxlines*/, int /*mincols*/);
831 extern void dlg_auto_sizefile(const char * /*title*/, const char * /*file*/, int * /*height*/, int * /*width*/, int /*boxlines*/, int /*mincols*/);
832 extern void dlg_beeping(void);
833 extern void dlg_calc_listh(int * /*height*/, int * /*list_height*/, int /*item_no*/);
834 extern void dlg_clear(void);
835 extern void dlg_clr_result(void);
836 extern void dlg_ctl_size(int /*height*/, int /*width*/);
837 extern void dlg_del_window(WINDOW * /*win*/);
838 extern void dlg_does_output(void);
839 extern void dlg_draw_bottom_box(WINDOW * /*win*/);
840 extern void dlg_draw_bottom_box2(WINDOW * /*win*/, chtype /*on_left*/, chtype /*on_right*/, chtype /*on_inside*/);
841 extern void dlg_draw_box(WINDOW * /*win*/, int /*y*/, int /*x*/, int /*height*/, int /*width*/, chtype /*boxchar*/, chtype /*borderchar*/);
842 extern void dlg_draw_box2(WINDOW * /*win*/, int /*y*/, int /*x*/, int /*height*/, int /*width*/, chtype /*boxchar*/, chtype /*borderchar*/, chtype /*borderchar2*/);
843 extern void dlg_draw_title(WINDOW *win, const char *title);
844 extern void dlg_exit(int /*code*/) GCC_NORETURN;
845 extern void dlg_item_help(const char * /*txt*/);
846 extern void dlg_print_autowrap(WINDOW * /*win*/, const char * /*prompt*/, int /*height*/, int /*width*/);
847 extern void dlg_print_listitem(WINDOW * /*win*/, const char * /*text*/, int /*climit*/, bool /*first*/, int /*selected*/);
848 extern void dlg_print_size(int /*height*/, int /*width*/);
849 extern void dlg_print_text(WINDOW * /*win*/, const char * /*txt*/, int /*len*/, chtype * /*attr*/);
850 extern void dlg_put_backtitle(void);
851 extern void dlg_reset_timeout(WINDOW * /* win */);
852 extern void dlg_restore_vars(DIALOG_VARS * /* save */);
853 extern void dlg_save_vars(DIALOG_VARS * /* save */);
854 extern void dlg_set_focus(WINDOW * /*parent*/, WINDOW * /*win*/);
855 extern void dlg_tab_correct_str(char * /*prompt*/);
856 extern void dlg_trim_string(char * /*src*/);
857 extern void end_dialog(void);
858 extern void init_dialog(FILE * /*input*/, FILE * /*output*/);
860 extern void dlg_exiterr(const char *, ...) GCC_NORETURN GCC_PRINTFLIKE(1,2);
863 extern chtype dlg_color_pair(int /*foreground*/, int /*background*/);
864 extern int dlg_color_count(void);
865 extern void dlg_color_setup(void);
866 extern void dlg_draw_shadow(WINDOW * /*win*/, int /*height*/, int /*width*/, int /*y*/, int /*x*/);
869 #ifdef HAVE_STRCASECMP
870 #define dlg_strcmp(a,b) strcasecmp(a,b)
872 extern int dlg_strcmp(const char * /*a*/, const char * /*b*/);
875 #ifdef HAVE_DLG_TRACE
876 #define DLG_TRACE(params) dlg_trace_msg params
877 extern void dlg_trace_msg(const char *fmt, ...) GCC_PRINTFLIKE(1,2);
878 extern void dlg_trace_va_msg(const char *fmt, va_list ap);
879 #define DLG_TRACE2S(name,value) dlg_trace_2s (name,value)
880 #define DLG_TRACE2N(name,value) dlg_trace_2n (name,value)
881 extern void dlg_trace_2s(const char * /*name*/, const char * /*value*/);
882 extern void dlg_trace_2n(const char * /*name*/, int /*value*/);
883 extern void dlg_trace_win(WINDOW * /*win*/);
884 extern void dlg_trace_chr(int /*ch*/, int /*fkey*/);
885 extern void dlg_trace(const char * /*fname*/);
887 #define DLG_TRACE(params) /* nothing */
888 #define DLG_TRACE2S(name,value) /* nothing */
889 #define DLG_TRACE2N(name,value) /* nothing */
890 #define dlg_trace_va_msg(fmt, ap) /* nothing */
891 #define dlg_trace_win(win) /* nothing */
892 #define dlg_trace_chr(ch,fkey) /* nothing */
893 #define dlg_trace(fname) /* nothing */
897 extern void _dlg_resize_cleanup(WINDOW * /*win*/);
898 extern void dlg_move_window(WINDOW * /*win*/, int /*height*/, int /*width*/, int /*y*/, int /*x*/);
899 extern void dlg_will_resize(WINDOW * /*win*/);
903 * Normally "enter" means "ok". Use this macro to handle the explicit
904 * check for DLGK_ENTER:
906 #define dlg_enter_buttoncode(code) (dialog_vars.nook ? DLG_EXIT_OK : dlg_ok_buttoncode(code))
909 * The following stuff is needed for mouse support
911 typedef struct mseRegion {
912 int x, y, X, Y, code;
913 int mode, step_x, step_y;
914 struct mseRegion *next;
917 #if defined(NCURSES_MOUSE_VERSION)
919 #define mouse_open() mousemask(BUTTON1_PRESSED, (mmask_t *) 0)
920 #define mouse_close() mousemask(0, (mmask_t *) 0)
922 extern mseRegion * dlg_mouse_mkregion (int /*y*/, int /*x*/, int /*height*/, int /*width*/, int /*code*/);
923 extern void dlg_mouse_free_regions (void);
924 extern void dlg_mouse_mkbigregion (int /*y*/, int /*x*/, int /*height*/, int /*width*/, int /*code*/, int /*step_x*/, int /*step_y*/, int /*mode*/);
925 extern void dlg_mouse_setbase (int /*x*/, int /*y*/);
926 extern void dlg_mouse_setcode (int /*code*/);
932 #define mouse_open() /*nothing*/
933 #define mouse_close() /*nothing*/
934 #define dlg_mouse_free_regions() /* nothing */
935 #define dlg_mouse_mkregion(y, x, height, width, code) /*nothing*/
936 #define dlg_mouse_mkbigregion(y, x, height, width, code, step_x, step_y, mode) /*nothing*/
937 #define dlg_mouse_setbase(x, y) /*nothing*/
938 #define dlg_mouse_setcode(c) /*nothing*/
944 extern mseRegion *dlg_mouse_region (int /*y*/, int /*x*/);
945 extern mseRegion *dlg_mouse_bigregion (int /*y*/, int /*x*/);
946 extern int dlg_mouse_wgetch (WINDOW * /*win*/, int * /*fkey*/);
947 extern int dlg_mouse_wgetch_nowait (WINDOW * /*win*/, int * /*fkey*/);
949 #define mouse_mkbutton(y,x,len,code) dlg_mouse_mkregion(y,x,1,len,code);
952 * This is the base for fictitious keys, which activate
955 * Mouse-generated keys are the following:
956 * -- the first 32 are used as numbers, in addition to '0'-'9'
957 * -- uppercase chars are used to invoke the button (M_EVENT + 'O')
959 #define M_EVENT (DLGK_max + 1)
962 * The `flag' parameter in checklist is used to select between
963 * radiolist and checklist
969 * This is used only for debugging (FIXME: should have a separate header).
972 extern void _dlg_inputstr_leaks(void);
973 #if defined(NCURSES_VERSION)
974 #if defined(HAVE_CURSES_EXIT)
975 /* just use curses_exit() */
976 #elif defined(HAVE__NC_FREE_AND_EXIT)
977 extern void _nc_free_and_exit(int); /* nc_alloc.h normally not installed */
978 #define curses_exit(code) _nc_free_and_exit(code)
980 #endif /* NCURSES_VERSION */
981 #endif /* NO_LEAKS */
988 #endif /* DIALOG_H_included */