extra/config/lxdialog/dialog.h

   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, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 #include <sys/types.h>
  21 #include <fcntl.h>
  22 #include <unistd.h>
  23 #include <ctype.h>
  24 #include <stdlib.h>
  25 #include <string.h>
  26 #include <stdbool.h>
  27
  28 #ifndef KBUILD_NO_NLS
  29 # include <libintl.h>
  30 #else
  31 # define gettext(Msgid) ((const char *) (Msgid))
  32 #endif
  33
  34 #ifdef __sun__
  35 #define CURS_MACROS
  36 #endif
  37 #include CURSES_LOC
  38
  39 /*
  40  * Colors in ncurses 1.9.9e do not work properly since foreground and
  41  * background colors are OR'd rather than separately masked.  This version
  42  * of dialog was hacked to work with ncurses 1.9.9e, making it incompatible
  43  * with standard curses.  The simplest fix (to make this work with standard
  44  * curses) uses the wbkgdset() function, not used in the original hack.
  45  * Turn it off if we're building with 1.9.9e, since it just confuses things.
  46  */
  47 #if defined(NCURSES_VERSION) && defined(_NEED_WRAP) && !defined(GCC_PRINTFLIKE)
  48 #define OLD_NCURSES 1
  49 #undef  wbkgdset
  50 #define wbkgdset(w,p)           /*nothing */
  51 #else
  52 #define OLD_NCURSES 0
  53 #endif
  54
  55 #define TR(params) _tracef params
  56
  57 #define KEY_ESC 27
  58 #define TAB 9
  59 #define MAX_LEN 2048
  60 #define BUF_SIZE (10*1024)
  61 #define MIN(x,y) (x < y ? x : y)
  62 #define MAX(x,y) (x > y ? x : y)
  63
  64 #ifndef ACS_ULCORNER
  65 #define ACS_ULCORNER '+'
  66 #endif
  67 #ifndef ACS_LLCORNER
  68 #define ACS_LLCORNER '+'
  69 #endif
  70 #ifndef ACS_URCORNER
  71 #define ACS_URCORNER '+'
  72 #endif
  73 #ifndef ACS_LRCORNER
  74 #define ACS_LRCORNER '+'
  75 #endif
  76 #ifndef ACS_HLINE
  77 #define ACS_HLINE '-'
  78 #endif
  79 #ifndef ACS_VLINE
  80 #define ACS_VLINE '|'
  81 #endif
  82 #ifndef ACS_LTEE
  83 #define ACS_LTEE '+'
  84 #endif
  85 #ifndef ACS_RTEE
  86 #define ACS_RTEE '+'
  87 #endif
  88 #ifndef ACS_UARROW
  89 #define ACS_UARROW '^'
  90 #endif
  91 #ifndef ACS_DARROW
  92 #define ACS_DARROW 'v'
  93 #endif
  94
  95 /* error return codes */
  96 #define ERRDISPLAYTOOSMALL (KEY_MAX + 1)
  97
  98 /*
  99  *   Color definitions
 100  */
 101 struct dialog_color {
 102         chtype atr;     /* Color attribute */
 103         int fg;         /* foreground */
 104         int bg;         /* background */
 105         int hl;         /* highlight this item */
 106 };
 107
 108 struct dialog_info {
 109         const char *backtitle;
 110         struct dialog_color screen;
 111         struct dialog_color shadow;
 112         struct dialog_color dialog;
 113         struct dialog_color title;
 114         struct dialog_color border;
 115         struct dialog_color button_active;
 116         struct dialog_color button_inactive;
 117         struct dialog_color button_key_active;
 118         struct dialog_color button_key_inactive;
 119         struct dialog_color button_label_active;
 120         struct dialog_color button_label_inactive;
 121         struct dialog_color inputbox;
 122         struct dialog_color inputbox_border;
 123         struct dialog_color searchbox;
 124         struct dialog_color searchbox_title;
 125         struct dialog_color searchbox_border;
 126         struct dialog_color position_indicator;
 127         struct dialog_color menubox;
 128         struct dialog_color menubox_border;
 129         struct dialog_color item;
 130         struct dialog_color item_selected;
 131         struct dialog_color tag;
 132         struct dialog_color tag_selected;
 133         struct dialog_color tag_key;
 134         struct dialog_color tag_key_selected;
 135         struct dialog_color check;
 136         struct dialog_color check_selected;
 137         struct dialog_color uarrow;
 138         struct dialog_color darrow;
 139 };
 140
 141 /*
 142  * Global variables
 143  */
 144 extern struct dialog_info dlg;
 145 extern char dialog_input_result[];
 146
 147 /*
 148  * Function prototypes
 149  */
 150
 151 /* item list as used by checklist and menubox */
 152 void item_reset(void);
 153 void item_make(const char *fmt, ...);
 154 void item_add_str(const char *fmt, ...);
 155 void item_set_tag(char tag);
 156 void item_set_data(void *p);
 157 void item_set_selected(int val);
 158 int item_activate_selected(void);
 159 void *item_data(void);
 160 char item_tag(void);
 161
 162 /* item list manipulation for lxdialog use */
 163 #define MAXITEMSTR 200
 164 struct dialog_item {
 165         char str[MAXITEMSTR];   /* promtp displayed */
 166         char tag;
 167         void *data;     /* pointer to menu item - used by menubox+checklist */
 168         int selected;   /* Set to 1 by dialog_*() function if selected. */
 169 };
 170
 171 /* list of lialog_items */
 172 struct dialog_list {
 173         struct dialog_item node;
 174         struct dialog_list *next;
 175 };
 176
 177 extern struct dialog_list *item_cur;
 178 extern struct dialog_list item_nil;
 179 extern struct dialog_list *item_head;
 180
 181 int item_count(void);
 182 void item_set(int n);
 183 int item_n(void);
 184 const char *item_str(void);
 185 int item_is_selected(void);
 186 int item_is_tag(char tag);
 187 #define item_foreach() \
 188         for (item_cur = item_head ? item_head: item_cur; \
 189              item_cur && (item_cur != &item_nil); item_cur = item_cur->next)
 190
 191 /* generic key handlers */
 192 int on_key_esc(WINDOW *win);
 193 int on_key_resize(void);
 194
 195 int init_dialog(const char *backtitle);
 196 void set_dialog_backtitle(const char *backtitle);
 197 void end_dialog(int x, int y);
 198 void attr_clear(WINDOW * win, int height, int width, chtype attr);
 199 void dialog_clear(void);
 200 void print_autowrap(WINDOW * win, const char *prompt, int width, int y, int x);
 201 void print_button(WINDOW * win, const char *label, int y, int x, int selected);
 202 void print_title(WINDOW *dialog, const char *title, int width);
 203 void draw_box(WINDOW * win, int y, int x, int height, int width, chtype box,
 204               chtype border);
 205 void draw_shadow(WINDOW * win, int y, int x, int height, int width);
 206
 207 int first_alpha(const char *string, const char *exempt);
 208 int dialog_yesno(const char *title, const char *prompt, int height, int width);
 209 int dialog_msgbox(const char *title, const char *prompt, int height,
 210                   int width, int pause);
 211 int dialog_textbox(const char *title, const char *file, int height, int width);
 212 int dialog_menu(const char *title, const char *prompt,
 213                 const void *selected, int *s_scroll);
 214 int dialog_checklist(const char *title, const char *prompt, int height,
 215                      int width, int list_height);
 216 extern char dialog_input_result[];
 217 int dialog_inputbox(const char *title, const char *prompt, int height,
 218                     int width, const char *init);
 219
 220 /*
 221  * This is the base for fictitious keys, which activate
 222  * the buttons.
 223  *
 224  * Mouse-generated keys are the following:
 225  *   -- the first 32 are used as numbers, in addition to '0'-'9'
 226  *   -- the lowercase are used to signal mouse-enter events (M_EVENT + 'o')
 227  *   -- uppercase chars are used to invoke the button (M_EVENT + 'O')
 228  */
 229 #define M_EVENT (KEY_MAX+1)