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 position_indicator; 95 struct dialog_color menubox; 96 struct dialog_color menubox_border; 97 struct dialog_color item; 98 struct dialog_color item_selected; 99 struct dialog_color tag; 100 struct dialog_color tag_selected; 101 struct dialog_color tag_key; 102 struct dialog_color tag_key_selected; 103 struct dialog_color check; 104 struct dialog_color check_selected; 105 struct dialog_color uarrow; 106 struct dialog_color darrow; 107}; 108 109/* 110 * Global variables 111 */ 112extern struct dialog_info dlg; 113extern char dialog_input_result[]; 114extern int saved_x, saved_y; /* Needed in signal handler in mconf.c */ 115 116/* 117 * Function prototypes 118 */ 119 120/* item list as used by checklist and menubox */ 121void item_reset(void); 122void item_make(const char *fmt, ...); 123void item_add_str(const char *fmt, ...); 124void item_set_tag(char tag); 125void item_set_data(void *p); 126void item_set_selected(int val); 127int item_activate_selected(void); 128void *item_data(void); 129char item_tag(void); 130 131/* item list manipulation for lxdialog use */ 132#define MAXITEMSTR 200 133struct dialog_item { 134 char str[MAXITEMSTR]; /* prompt displayed */ 135 char tag; 136 void *data; /* pointer to menu item - used by menubox+checklist */ 137 int selected; /* Set to 1 by dialog_*() function if selected. */ 138}; 139 140/* list of lialog_items */ 141struct dialog_list { 142 struct dialog_item node; 143 struct dialog_list *next; 144}; 145 146extern struct dialog_list *item_cur; 147extern struct dialog_list item_nil; 148extern struct dialog_list *item_head; 149 150int item_count(void); 151void item_set(int n); 152int item_n(void); 153const char *item_str(void); 154int item_is_selected(void); 155int item_is_tag(char tag); 156#define item_foreach() \ 157 for (item_cur = item_head ? item_head: item_cur; \ 158 item_cur && (item_cur != &item_nil); item_cur = item_cur->next) 159 160/* generic key handlers */ 161int on_key_esc(WINDOW *win); 162int on_key_resize(void); 163 164/* minimum (re)size values */ 165#define CHECKLIST_HEIGHT_MIN 6 /* For dialog_checklist() */ 166#define CHECKLIST_WIDTH_MIN 6 167#define INPUTBOX_HEIGHT_MIN 2 /* For dialog_inputbox() */ 168#define INPUTBOX_WIDTH_MIN 2 169#define MENUBOX_HEIGHT_MIN 15 /* For dialog_menu() */ 170#define MENUBOX_WIDTH_MIN 65 171#define TEXTBOX_HEIGHT_MIN 8 /* For dialog_textbox() */ 172#define TEXTBOX_WIDTH_MIN 8 173#define YESNO_HEIGHT_MIN 4 /* For dialog_yesno() */ 174#define YESNO_WIDTH_MIN 4 175#define WINDOW_HEIGHT_MIN 19 /* For init_dialog() */ 176#define WINDOW_WIDTH_MIN 80 177 178int init_dialog(const char *backtitle); 179void set_dialog_backtitle(const char *backtitle); 180void set_dialog_subtitles(struct subtitle_list *subtitles); 181void end_dialog(int x, int y); 182void attr_clear(WINDOW * win, int height, int width, chtype attr); 183void dialog_clear(void); 184void print_autowrap(WINDOW * win, const char *prompt, int width, int y, int x); 185void print_button(WINDOW * win, const char *label, int y, int x, int selected); 186void print_title(WINDOW *dialog, const char *title, int width); 187void draw_box(WINDOW * win, int y, int x, int height, int width, chtype box, 188 chtype border); 189void draw_shadow(WINDOW * win, int y, int x, int height, int width); 190 191int first_alpha(const char *string, const char *exempt); 192int dialog_yesno(const char *title, const char *prompt, int height, int width); 193int dialog_msgbox(const char *title, const char *prompt, int height, 194 int width, int pause); 195int dialog_textbox(const char *title, const char *tbuf, int initial_height, 196 int initial_width, int *_vscroll, int *_hscroll, 197 int (*extra_key_cb)(int, size_t, size_t, void *), void *data); 198int dialog_menu(const char *title, const char *prompt, 199 const void *selected, int *s_scroll); 200int dialog_checklist(const char *title, const char *prompt, int height, 201 int width, int list_height); 202int dialog_inputbox(const char *title, const char *prompt, int height, 203 int width, const char *init); 204