contrib/dialog/timebox.c

   1 /*
   2  * $Id: timebox.c,v 1.59 2018/06/19 22:57:01 tom Exp $
   3  *
   4  *  timebox.c -- implements the timebox dialog
   5  *
   6  *  Copyright 2001-2016,2018   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
  24 #include <dialog.h>
  25 #include <dlg_keys.h>
  26
  27 #include <time.h>
  28
  29 #define ONE_HIGH 1
  30 #define ONE_WIDE 2
  31 #define BTN_HIGH 2
  32
  33 #define MIN_HIGH (ONE_HIGH + BTN_HIGH + (4 * MARGIN))
  34 #define MIN_WIDE ((3 * (ONE_WIDE + 2 * MARGIN)) + 2 + (2 * MARGIN))
  35
  36 typedef enum {
  37     sHR = -3
  38     ,sMN = -2
  39     ,sSC = -1
  40 } STATES;
  41
  42 struct _box;
  43
  44 typedef struct _box {
  45     WINDOW *parent;
  46     WINDOW *window;
  47     int x;
  48     int y;
  49     int width;
  50     int height;
  51     int period;
  52     int value;
  53 } BOX;
  54
  55 static int
  56 next_or_previous(int key)
  57 {
  58     int result = 0;
  59
  60     switch (key) {
  61     case DLGK_ITEM_PREV:
  62         result = -1;
  63         break;
  64     case DLGK_ITEM_NEXT:
  65         result = 1;
  66         break;
  67     default:
  68         beep();
  69         break;
  70     }
  71     return result;
  72 }
  73 /*
  74  * Draw the hour-of-month selection box
  75  */
  76 static int
  77 draw_cell(BOX * data)
  78 {
  79     werase(data->window);
  80     dlg_draw_box(data->parent,
  81                  data->y - MARGIN, data->x - MARGIN,
  82                  data->height + (2 * MARGIN), data->width + (2 * MARGIN),
  83                  menubox_border_attr, menubox_border2_attr);
  84
  85     dlg_attrset(data->window, item_attr);
  86     wprintw(data->window, "%02d", data->value);
  87     return 0;
  88 }
  89
  90 static int
  91 init_object(BOX * data,
  92             WINDOW *parent,
  93             int x, int y,
  94             int width, int height,
  95             int period, int value,
  96             int code)
  97 {
  98     (void) code;
  99
 100     data->parent = parent;
 101     data->x = x;
 102     data->y = y;
 103     data->width = width;
 104     data->height = height;
 105     data->period = period;
 106     data->value = value % period;
 107
 108     data->window = derwin(data->parent,
 109                           data->height, data->width,
 110                           data->y, data->x);
 111     if (data->window == 0)
 112         return -1;
 113     (void) keypad(data->window, TRUE);
 114
 115     dlg_mouse_setbase(getbegx(parent), getbegy(parent));
 116     dlg_mouse_mkregion(y, x, height, width, code);
 117
 118     return 0;
 119 }
 120
 121 static int
 122 CleanupResult(int code, WINDOW *dialog, char *prompt, DIALOG_VARS * save_vars)
 123 {
 124     dlg_del_window(dialog);
 125     dlg_mouse_free_regions();
 126     free(prompt);
 127     dlg_restore_vars(save_vars);
 128
 129     return code;
 130 }
 131
 132 #define DrawObject(data) draw_cell(data)
 133
 134 /*
 135  * Display a dialog box for entering a date
 136  */
 137 int
 138 dialog_timebox(const char *title,
 139                const char *subtitle,
 140                int height,
 141                int width,
 142                int hour,
 143                int minute,
 144                int second)
 145 {
 146     /* *INDENT-OFF* */
 147     static DLG_KEYS_BINDING binding[] = {
 148         DLG_KEYS_DATA( DLGK_DELETE_RIGHT,KEY_DC ),
 149         HELPKEY_BINDINGS,
 150         ENTERKEY_BINDINGS,
 151         TOGGLEKEY_BINDINGS,
 152         DLG_KEYS_DATA( DLGK_FIELD_FIRST,KEY_HOME ),
 153         DLG_KEYS_DATA( DLGK_FIELD_LAST, KEY_END ),
 154         DLG_KEYS_DATA( DLGK_FIELD_LAST, KEY_LL ),
 155         DLG_KEYS_DATA( DLGK_FIELD_NEXT, CHR_NEXT ),
 156         DLG_KEYS_DATA( DLGK_FIELD_NEXT, KEY_RIGHT ),
 157         DLG_KEYS_DATA( DLGK_FIELD_NEXT, TAB ),
 158         DLG_KEYS_DATA( DLGK_FIELD_PREV, CHR_BACKSPACE ),
 159         DLG_KEYS_DATA( DLGK_FIELD_PREV, CHR_PREVIOUS ),
 160         DLG_KEYS_DATA( DLGK_FIELD_PREV, KEY_BTAB ),
 161         DLG_KEYS_DATA( DLGK_FIELD_PREV, KEY_LEFT ),
 162         DLG_KEYS_DATA( DLGK_ITEM_NEXT,  '+'),
 163         DLG_KEYS_DATA( DLGK_ITEM_NEXT,  KEY_DOWN),
 164         DLG_KEYS_DATA( DLGK_ITEM_NEXT,  KEY_NEXT),
 165         DLG_KEYS_DATA( DLGK_ITEM_NEXT,  KEY_NPAGE),
 166         DLG_KEYS_DATA( DLGK_ITEM_PREV,  '-' ),
 167         DLG_KEYS_DATA( DLGK_ITEM_PREV,  KEY_PPAGE ),
 168         DLG_KEYS_DATA( DLGK_ITEM_PREV,  KEY_PREVIOUS ),
 169         DLG_KEYS_DATA( DLGK_ITEM_PREV,  KEY_UP ),
 170         END_KEYS_BINDING
 171     };
 172     /* *INDENT-ON* */
 173
 174 #ifdef KEY_RESIZE
 175     int old_height = height;
 176     int old_width = width;
 177 #endif
 178     BOX hr_box, mn_box, sc_box;
 179     int key = 0, key2, fkey;
 180     int button;
 181     int result = DLG_EXIT_UNKNOWN;
 182     WINDOW *dialog;
 183     time_t now_time = time((time_t *) 0);
 184     struct tm current;
 185     int state = dlg_default_button();
 186     const char **buttons = dlg_ok_labels();
 187     char *prompt;
 188     char buffer[MAX_LEN];
 189     DIALOG_VARS save_vars;
 190
 191     DLG_TRACE(("# timebox args:\n"));
 192     DLG_TRACE2S("title", title);
 193     DLG_TRACE2S("message", subtitle);
 194     DLG_TRACE2N("height", height);
 195     DLG_TRACE2N("width", width);
 196     DLG_TRACE2N("hour", hour);
 197     DLG_TRACE2N("minute", minute);
 198     DLG_TRACE2N("second", second);
 199
 200     now_time = time((time_t *) 0);
 201     current = *localtime(&now_time);
 202
 203     dlg_save_vars(&save_vars);
 204     dialog_vars.separate_output = TRUE;
 205
 206     dlg_does_output();
 207
 208 #ifdef KEY_RESIZE
 209   retry:
 210 #endif
 211
 212     prompt = dlg_strclone(subtitle);
 213     dlg_auto_size(title, prompt, &height, &width, 0, 0);
 214
 215     height += MIN_HIGH;
 216     if (width < MIN_WIDE)
 217         width = MIN_WIDE;
 218     dlg_button_layout(buttons, &width);
 219     dlg_print_size(height, width);
 220     dlg_ctl_size(height, width);
 221
 222     dialog = dlg_new_window(height, width,
 223                             dlg_box_y_ordinate(height),
 224                             dlg_box_x_ordinate(width));
 225
 226     if (hour >= 24 || minute >= 60 || second >= 60) {
 227         return CleanupResult(DLG_EXIT_ERROR, dialog, prompt, &save_vars);
 228     }
 229
 230     dlg_register_window(dialog, "timebox", binding);
 231     dlg_register_buttons(dialog, "timebox", buttons);
 232
 233     dlg_draw_box2(dialog, 0, 0, height, width, dialog_attr, border_attr, border2_attr);
 234     dlg_draw_bottom_box2(dialog, border_attr, border2_attr, dialog_attr);
 235     dlg_draw_title(dialog, title);
 236     dlg_draw_helpline(dialog, FALSE);
 237
 238     dlg_attrset(dialog, dialog_attr);
 239     dlg_print_autowrap(dialog, prompt, height, width);
 240
 241     /* compute positions of hour, month and year boxes */
 242     memset(&hr_box, 0, sizeof(hr_box));
 243     memset(&mn_box, 0, sizeof(mn_box));
 244     memset(&sc_box, 0, sizeof(sc_box));
 245
 246     if (init_object(&hr_box,
 247                     dialog,
 248                     (width - MIN_WIDE + 1) / 2 + MARGIN,
 249                     (height - MIN_HIGH + MARGIN),
 250                     ONE_WIDE,
 251                     ONE_HIGH,
 252                     24,
 253                     hour >= 0 ? hour : current.tm_hour,
 254                     'H') < 0
 255         || DrawObject(&hr_box) < 0) {
 256         return CleanupResult(DLG_EXIT_ERROR, dialog, prompt, &save_vars);
 257     }
 258
 259     mvwprintw(dialog, hr_box.y, hr_box.x + ONE_WIDE + MARGIN, ":");
 260     if (init_object(&mn_box,
 261                     dialog,
 262                     hr_box.x + (ONE_WIDE + 2 * MARGIN + 1),
 263                     hr_box.y,
 264                     hr_box.width,
 265                     hr_box.height,
 266                     60,
 267                     minute >= 0 ? minute : current.tm_min,
 268                     'M') < 0
 269         || DrawObject(&mn_box) < 0) {
 270         return CleanupResult(DLG_EXIT_ERROR, dialog, prompt, &save_vars);
 271     }
 272
 273     mvwprintw(dialog, mn_box.y, mn_box.x + ONE_WIDE + MARGIN, ":");
 274     if (init_object(&sc_box,
 275                     dialog,
 276                     mn_box.x + (ONE_WIDE + 2 * MARGIN + 1),
 277                     mn_box.y,
 278                     mn_box.width,
 279                     mn_box.height,
 280                     60,
 281                     second >= 0 ? second : current.tm_sec,
 282                     'S') < 0
 283         || DrawObject(&sc_box) < 0) {
 284         return CleanupResult(DLG_EXIT_ERROR, dialog, prompt, &save_vars);
 285     }
 286
 287     dlg_trace_win(dialog);
 288     while (result == DLG_EXIT_UNKNOWN) {
 289         BOX *obj = (state == sHR ? &hr_box
 290                     : (state == sMN ? &mn_box :
 291                        (state == sSC ? &sc_box : 0)));
 292
 293         button = (state < 0) ? 0 : state;
 294         dlg_draw_buttons(dialog, height - 2, 0, buttons, button, FALSE, width);
 295         if (obj != 0)
 296             dlg_set_focus(dialog, obj->window);
 297
 298         key = dlg_mouse_wgetch(dialog, &fkey);
 299         if (dlg_result_key(key, fkey, &result))
 300             break;
 301
 302         if ((key2 = dlg_char_to_button(key, buttons)) >= 0) {
 303             result = key2;
 304         } else {
 305             /* handle function-keys */
 306             if (fkey) {
 307                 switch (key) {
 308                 case DLGK_MOUSE('H'):
 309                     state = sHR;
 310                     break;
 311                 case DLGK_MOUSE('M'):
 312                     state = sMN;
 313                     break;
 314                 case DLGK_MOUSE('S'):
 315                     state = sSC;
 316                     break;
 317                 case DLGK_TOGGLE:
 318                 case DLGK_ENTER:
 319                     result = dlg_ok_buttoncode(button);
 320                     break;
 321                 case DLGK_FIELD_PREV:
 322                     state = dlg_prev_ok_buttonindex(state, sHR);
 323                     break;
 324                 case DLGK_FIELD_NEXT:
 325                     state = dlg_next_ok_buttonindex(state, sHR);
 326                     break;
 327                 case DLGK_FIELD_FIRST:
 328                     if (obj != 0) {
 329                         obj->value = 0;
 330                         (void) DrawObject(obj);
 331                     }
 332                     break;
 333                 case DLGK_FIELD_LAST:
 334                     if (obj != 0) {
 335                         switch (state) {
 336                         case sHR:
 337                             obj->value = 23;
 338                             break;
 339                         case sMN:
 340                         case sSC:
 341                             obj->value = 59;
 342                             break;
 343                         }
 344                         (void) DrawObject(obj);
 345                     }
 346                     break;
 347                 case DLGK_DELETE_RIGHT:
 348                     if (obj != 0) {
 349                         obj->value /= 10;
 350                         (void) DrawObject(obj);
 351                     }
 352                     break;
 353 #ifdef KEY_RESIZE
 354                 case KEY_RESIZE:
 355                     dlg_will_resize(dialog);
 356                     /* reset data */
 357                     height = old_height;
 358                     width = old_width;
 359                     hour = hr_box.value;
 360                     minute = mn_box.value;
 361                     second = sc_box.value;
 362                     /* repaint */
 363                     free(prompt);
 364                     dlg_clear();
 365                     dlg_del_window(dialog);
 366                     dlg_mouse_free_regions();
 367                     goto retry;
 368 #endif
 369                 default:
 370                     if (is_DLGK_MOUSE(key)) {
 371                         result = dlg_ok_buttoncode(key - M_EVENT);
 372                         if (result < 0)
 373                             result = DLG_EXIT_OK;
 374                     } else if (obj != 0) {
 375                         int step = next_or_previous(key);
 376                         if (step != 0) {
 377                             obj->value += step;
 378                             while (obj->value < 0)
 379                                 obj->value += obj->period;
 380                             obj->value %= obj->period;
 381                             (void) DrawObject(obj);
 382                         }
 383                     }
 384                     break;
 385                 }
 386             } else if (isdigit(key)) {
 387                 if (obj != 0) {
 388                     int digit = (key - '0');
 389                     int value = (obj->value * 10) + digit;
 390                     if (value < obj->period) {
 391                         obj->value = value;
 392                         (void) DrawObject(obj);
 393                     } else {
 394                         beep();
 395                     }
 396                 }
 397             } else {
 398                 beep();
 399             }
 400         }
 401     }
 402
 403 #define DefaultFormat(dst, src) \
 404         sprintf(dst, "%02d:%02d:%02d", \
 405                 hr_box.value, mn_box.value, sc_box.value)
 406
 407 #if defined(HAVE_STRFTIME)
 408     if (dialog_vars.time_format != 0) {
 409         size_t used;
 410         time_t now = time((time_t *) 0);
 411         struct tm *parts = localtime(&now);
 412
 413         parts->tm_sec = sc_box.value;
 414         parts->tm_min = mn_box.value;
 415         parts->tm_hour = hr_box.value;
 416         used = strftime(buffer,
 417                         sizeof(buffer) - 1,
 418                         dialog_vars.time_format,
 419                         parts);
 420         if (used == 0 || *buffer == '\0')
 421             DefaultFormat(buffer, hr_box);
 422     } else
 423 #endif
 424         DefaultFormat(buffer, hr_box);
 425
 426     dlg_add_result(buffer);
 427     dlg_add_separator();
 428     dlg_add_last_key(-1);
 429
 430     return CleanupResult(result, dialog, prompt, &save_vars);
 431 }