contrib/dialog/inputbox.c

   1 /*
   2  *  $Id: inputbox.c,v 1.95 2021/05/30 18:41:54 tom Exp $
   3  *
   4  *  inputbox.c -- implements the input box
   5  *
   6  *  Copyright 2000-2020,2021 Thomas E. Dickey
   7  *
   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.
  11  *
  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.
  16  *
  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.
  22  *
  23  *  An earlier version of this program lists as authors:
  24  *      Savio Lam (lam836@cs.cuhk.hk)
  25  */
  26
  27 #include <dlg_internals.h>
  28 #include <dlg_keys.h>
  29
  30 #define sTEXT -1
  31
  32 #define NAVIGATE_BINDINGS \
  33         DLG_KEYS_DATA( DLGK_FIELD_NEXT, KEY_DOWN ), \
  34         DLG_KEYS_DATA( DLGK_FIELD_NEXT, KEY_RIGHT ), \
  35         DLG_KEYS_DATA( DLGK_FIELD_NEXT, TAB ), \
  36         DLG_KEYS_DATA( DLGK_FIELD_PREV, KEY_BTAB ), \
  37         DLG_KEYS_DATA( DLGK_FIELD_PREV, KEY_LEFT ), \
  38         DLG_KEYS_DATA( DLGK_FIELD_PREV, KEY_UP )
  39
  40 #define BTN_HIGH 1
  41 #define HDR_HIGH 1
  42 #define MIN_HIGH (HDR_HIGH + 1 + (BTN_HIGH + MARGIN * 2))
  43 #define MIN_WIDE 26
  44
  45 /*
  46  * Display a dialog box for entering a string
  47  */
  48 int
  49 dialog_inputbox(const char *title, const char *cprompt, int height, int width,
  50                 const char *init, const int password)
  51 {
  52     /* *INDENT-OFF* */
  53     static DLG_KEYS_BINDING binding[] = {
  54         HELPKEY_BINDINGS,
  55         ENTERKEY_BINDINGS,
  56         NAVIGATE_BINDINGS,
  57         TOGGLEKEY_BINDINGS,
  58         END_KEYS_BINDING
  59     };
  60     static DLG_KEYS_BINDING binding2[] = {
  61         INPUTSTR_BINDINGS,
  62         HELPKEY_BINDINGS,
  63         ENTERKEY_BINDINGS,
  64         NAVIGATE_BINDINGS,
  65         /* no TOGGLEKEY_BINDINGS, since that includes space... */
  66         END_KEYS_BINDING
  67     };
  68     /* *INDENT-ON* */
  69
  70 #ifdef KEY_RESIZE
  71     int old_height = height;
  72     int old_width = width;
  73 #endif
  74     int xorg, yorg;
  75     int x, y, box_y, box_x, box_width;
  76     int show_buttons;
  77     int col_offset = 0;
  78     int chr_offset = 0;
  79     int key, fkey, code;
  80     int result = DLG_EXIT_UNKNOWN;
  81     int state;
  82     int partauto;
  83     bool first;
  84     bool edited;
  85     char *input;
  86     WINDOW *dialog;
  87     WINDOW *editor;
  88     char *prompt = dlg_strclone(cprompt);
  89     const char **buttons = dlg_ok_labels();
  90
  91     dlg_does_output();
  92
  93     DLG_TRACE(("# inputbox args:\n"));
  94     DLG_TRACE2S("title", title);
  95     DLG_TRACE2S("message", cprompt);
  96     DLG_TRACE2N("height", height);
  97     DLG_TRACE2N("width", width);
  98     DLG_TRACE2S("init", init);
  99     DLG_TRACE2N("password", password);
 100
 101     dlg_tab_correct_str(prompt);
 102
 103     /* Set up the initial value */
 104     input = dlg_set_result(init);
 105     edited = FALSE;
 106
 107 #ifdef KEY_RESIZE
 108   retry:
 109 #endif
 110     show_buttons = TRUE;
 111     state = dialog_vars.default_button >= 0 ? dlg_default_button() : sTEXT;
 112     first = (state == sTEXT);
 113     key = fkey = 0;
 114
 115     partauto = ((height == 0) ^ (width == 0));
 116     if (init != NULL) {
 117         dlg_auto_size(title, prompt,
 118                       &height, &width,
 119                       MIN_HIGH + partauto,
 120                       MIN(MAX(dlg_count_columns(init) + 7, MIN_WIDE),
 121                           SCOLS - (dialog_vars.begin_set ?
 122                                    dialog_vars.begin_x : 0)));
 123         chr_offset = (int) strlen(init);
 124     } else {
 125         dlg_auto_size(title, prompt,
 126                       &height, &width,
 127                       MIN_HIGH + partauto,
 128                       MIN_WIDE);
 129     }
 130     dlg_button_layout(buttons, &width);
 131     dlg_print_size(height, width);
 132     dlg_ctl_size(height, width);
 133
 134     xorg = dlg_box_x_ordinate(width);
 135     yorg = dlg_box_y_ordinate(height);
 136
 137     dialog = dlg_new_window(height, width, yorg, xorg);
 138     dlg_register_window(dialog, "inputbox", binding);
 139     dlg_register_buttons(dialog, "inputbox", buttons);
 140
 141     dlg_mouse_setbase(xorg, yorg);
 142
 143     dlg_draw_box2(dialog, 0, 0, height, width, dialog_attr, border_attr, border2_attr);
 144     dlg_draw_bottom_box2(dialog, border_attr, border2_attr, dialog_attr);
 145     dlg_draw_title(dialog, title);
 146
 147     dlg_attrset(dialog, dialog_attr);
 148     dlg_draw_helpline(dialog, FALSE);
 149     dlg_print_autowrap(dialog, prompt, height, width);
 150
 151     /* Draw the input field box */
 152     box_width = width - 6;
 153     getyx(dialog, y, x);
 154     (void) x;
 155     box_y = y + 2;
 156     box_x = (width - box_width) / 2;
 157     dlg_mouse_mkregion(y + 1, box_x - 1, 3, box_width + 2, 'i');
 158     dlg_draw_box(dialog, y + 1, box_x - 1, 3, box_width + 2,
 159                  border_attr, border2_attr);
 160
 161     /* Make a window for the input-field, to associate bindings */
 162     editor = dlg_sub_window(dialog, 1, box_width, yorg + box_y, xorg + box_x);
 163     dlg_register_window(editor, "inputbox2", binding2);
 164
 165     if (*input != '\0') {
 166         dlg_show_string(editor, input, chr_offset, inputbox_attr,
 167                         0, 0, box_width, (bool) (password != 0), first);
 168         wsyncup(editor);
 169         wcursyncup(editor);
 170     }
 171
 172     while (result == DLG_EXIT_UNKNOWN) {
 173         /*
 174          * The last field drawn determines where the cursor is shown:
 175          */
 176         if (show_buttons) {
 177             show_buttons = FALSE;
 178             col_offset = dlg_edit_offset(input, chr_offset, box_width);
 179             (void) wmove(dialog, box_y, box_x + col_offset);
 180             dlg_draw_buttons(dialog, height - 2, 0, buttons, state, FALSE, width);
 181         }
 182
 183         if (!first) {
 184             if (*input != '\0' && !edited) {
 185                 dlg_show_string(editor, input, chr_offset, inputbox_attr,
 186                                 0, 0, box_width, (bool) (password != 0), first);
 187                 wmove(editor, 0, chr_offset);
 188                 wsyncup(editor);
 189                 wcursyncup(editor);
 190             }
 191             key = dlg_mouse_wgetch((state == sTEXT) ? editor : dialog, &fkey);
 192             if (dlg_result_key(key, fkey, &result)) {
 193                 if (!dlg_button_key(result, &code, &key, &fkey))
 194                     break;
 195             }
 196         }
 197
 198         /*
 199          * Handle mouse clicks first, since we want to know if this is a button,
 200          * or something that dlg_edit_string() should handle.
 201          */
 202         if (fkey
 203             && is_DLGK_MOUSE(key)
 204             && (code = dlg_ok_buttoncode(key - M_EVENT)) >= 0) {
 205             result = code;
 206             continue;
 207         }
 208
 209         if (state == sTEXT) {   /* Input box selected */
 210             int edit = dlg_edit_string(input, &chr_offset, key, fkey, first);
 211
 212             if (edit) {
 213                 dlg_show_string(editor, input, chr_offset, inputbox_attr,
 214                                 0, 0, box_width, (bool) (password != 0), first);
 215                 wsyncup(editor);
 216                 wcursyncup(editor);
 217                 first = FALSE;
 218                 edited = TRUE;
 219                 continue;
 220             } else if (first) {
 221                 first = FALSE;
 222                 continue;
 223             }
 224         }
 225
 226         /* handle non-functionkeys */
 227         if (!fkey && (code = dlg_char_to_button(key, buttons)) >= 0) {
 228             dlg_del_window(dialog);
 229             result = dlg_ok_buttoncode(code);
 230             continue;
 231         }
 232
 233         /* handle functionkeys */
 234         if (fkey) {
 235             switch (key) {
 236             case DLGK_MOUSE('i'):       /* mouse enter events */
 237                 state = 0;
 238                 /* FALLTHRU */
 239             case DLGK_FIELD_PREV:
 240                 show_buttons = TRUE;
 241                 state = dlg_prev_ok_buttonindex(state, sTEXT);
 242                 break;
 243             case DLGK_FIELD_NEXT:
 244                 show_buttons = TRUE;
 245                 state = dlg_next_ok_buttonindex(state, sTEXT);
 246                 break;
 247             case DLGK_TOGGLE:
 248             case DLGK_ENTER:
 249                 dlg_del_window(dialog);
 250                 result = (state >= 0) ? dlg_enter_buttoncode(state) : DLG_EXIT_OK;
 251                 break;
 252             case DLGK_LEAVE:
 253                 if (state >= 0)
 254                     result = dlg_ok_buttoncode(state);
 255                 break;
 256 #ifdef KEY_RESIZE
 257             case KEY_RESIZE:
 258                 dlg_will_resize(dialog);
 259                 /* reset data */
 260                 height = old_height;
 261                 width = old_width;
 262                 /* repaint */
 263                 _dlg_resize_cleanup(dialog);
 264                 goto retry;
 265 #endif
 266             default:
 267                 beep();
 268                 break;
 269             }
 270         } else if (key > 0) {
 271             beep();
 272         }
 273     }
 274     AddLastKey();
 275
 276     dlg_unregister_window(editor);
 277     dlg_del_window(dialog);
 278     dlg_mouse_free_regions();
 279     free(prompt);
 280     return result;
 281 }