lib/widget/dialog.c

   1 /*
   2    Dialog box features module for the Midnight Commander
   3
   4    Copyright (C) 1994-2023
   5    Free Software Foundation, Inc.
   6
   7    This file is part of the Midnight Commander.
   8
   9    The Midnight Commander is free software: you can redistribute it
  10    and/or modify it under the terms of the GNU General Public License as
  11    published by the Free Software Foundation, either version 3 of the License,
  12    or (at your option) any later version.
  13
  14    The Midnight Commander is distributed in the hope that it will be useful,
  15    but WITHOUT ANY WARRANTY; without even the implied warranty of
  16    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17    GNU General Public License for more details.
  18
  19    You should have received a copy of the GNU General Public License
  20    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  21  */
  22
  23 /** \file dialog.c
  24  *  \brief Source: dialog box features module
  25  */
  26
  27 #include <config.h>
  28
  29 #include <ctype.h>
  30 #include <errno.h>
  31 #include <stdlib.h>
  32 #include <stdio.h>
  33 #include <string.h>
  34 #include <sys/types.h>
  35 #include <sys/stat.h>
  36
  37 #include "lib/global.h"
  38
  39 #include "lib/tty/tty.h"
  40 #include "lib/skin.h"
  41 #include "lib/tty/key.h"
  42 #include "lib/strutil.h"
  43 #include "lib/fileloc.h"        /* MC_HISTORY_FILE */
  44 #include "lib/event.h"          /* mc_event_raise() */
  45 #include "lib/util.h"           /* MC_PTR_FREE */
  46 #include "lib/mcconfig.h"       /* num_history_items_recorded */
  47
  48 #include "lib/widget.h"
  49 #include "lib/widget/mouse.h"
  50
  51 /*** global variables ****************************************************************************/
  52
  53 /* Color styles for normal and error dialogs */
  54 dlg_colors_t dialog_colors;
  55 dlg_colors_t alarm_colors;
  56 dlg_colors_t listbox_colors;
  57
  58 /* A hook list for idle events */
  59 hook_t *idle_hook = NULL;
  60
  61 /* left click outside of dialog closes it */
  62 gboolean mouse_close_dialog = FALSE;
  63
  64 const global_keymap_t *dialog_map = NULL;
  65
  66 /*** file scope macro definitions ****************************************************************/
  67
  68 /*** file scope type declarations ****************************************************************/
  69
  70 /*** forward declarations (file scope functions) *************************************************/
  71
  72 /*** file scope variables ************************************************************************/
  73
  74 /* --------------------------------------------------------------------------------------------- */
  75 /*** file scope functions ************************************************************************/
  76 /* --------------------------------------------------------------------------------------------- */
  77
  78 static const int *
  79 dlg_default_get_colors (const Widget * w)
  80 {
  81     return CONST_DIALOG (w)->colors;
  82 }
  83
  84 /* --------------------------------------------------------------------------------------------- */
  85 /**
  86   * Read histories from the ${XDG_DATA_HOME}/mc/history file
  87   */
  88 static void
  89 dlg_read_history (WDialog * h)
  90 {
  91     char *profile;
  92     ev_history_load_save_t event_data;
  93
  94     if (num_history_items_recorded == 0)        /* this is how to disable */
  95         return;
  96
  97     profile = mc_config_get_full_path (MC_HISTORY_FILE);
  98     event_data.cfg = mc_config_init (profile, TRUE);
  99     event_data.receiver = NULL;
 100
 101     /* create all histories in dialog */
 102     mc_event_raise (h->event_group, MCEVENT_HISTORY_LOAD, &event_data);
 103
 104     mc_config_deinit (event_data.cfg);
 105     g_free (profile);
 106 }
 107
 108 /* --------------------------------------------------------------------------------------------- */
 109
 110 static void
 111 refresh_cmd (void)
 112 {
 113 #ifdef HAVE_SLANG
 114     tty_touch_screen ();
 115     mc_refresh ();
 116 #else
 117     /* Use this if the refreshes fail */
 118     tty_clear_screen ();
 119     repaint_screen ();
 120 #endif /* HAVE_SLANG */
 121 }
 122
 123 /* --------------------------------------------------------------------------------------------- */
 124
 125 static cb_ret_t
 126 dlg_execute_cmd (WDialog * h, long command)
 127 {
 128     WGroup *g = GROUP (h);
 129     cb_ret_t ret = MSG_HANDLED;
 130
 131     if (send_message (h, NULL, MSG_ACTION, command, NULL) == MSG_HANDLED)
 132         return MSG_HANDLED;
 133
 134     switch (command)
 135     {
 136     case CK_Ok:
 137         h->ret_value = B_ENTER;
 138         dlg_close (h);
 139         break;
 140     case CK_Cancel:
 141         h->ret_value = B_CANCEL;
 142         dlg_close (h);
 143         break;
 144
 145     case CK_Up:
 146     case CK_Left:
 147         group_select_prev_widget (g);
 148         break;
 149     case CK_Down:
 150     case CK_Right:
 151         group_select_next_widget (g);
 152         break;
 153
 154     case CK_Help:
 155         {
 156             ev_help_t event_data = { NULL, h->help_ctx };
 157             mc_event_raise (MCEVENT_GROUP_CORE, "help", &event_data);
 158         }
 159         break;
 160
 161     case CK_Suspend:
 162         mc_event_raise (MCEVENT_GROUP_CORE, "suspend", NULL);
 163         refresh_cmd ();
 164         break;
 165     case CK_Refresh:
 166         refresh_cmd ();
 167         break;
 168
 169     case CK_ScreenList:
 170         if (!widget_get_state (WIDGET (h), WST_MODAL))
 171             dialog_switch_list ();
 172         else
 173             ret = MSG_NOT_HANDLED;
 174         break;
 175     case CK_ScreenNext:
 176         if (!widget_get_state (WIDGET (h), WST_MODAL))
 177             dialog_switch_next ();
 178         else
 179             ret = MSG_NOT_HANDLED;
 180         break;
 181     case CK_ScreenPrev:
 182         if (!widget_get_state (WIDGET (h), WST_MODAL))
 183             dialog_switch_prev ();
 184         else
 185             ret = MSG_NOT_HANDLED;
 186         break;
 187
 188     default:
 189         ret = MSG_NOT_HANDLED;
 190     }
 191
 192     return ret;
 193 }
 194
 195 /* --------------------------------------------------------------------------------------------- */
 196
 197 static cb_ret_t
 198 dlg_handle_key (WDialog * h, int d_key)
 199 {
 200     long command;
 201
 202     command = widget_lookup_key (WIDGET (h), d_key);
 203     if (command == CK_IgnoreKey)
 204         command = keybind_lookup_keymap_command (dialog_map, d_key);
 205     if (command != CK_IgnoreKey)
 206         return dlg_execute_cmd (h, command);
 207
 208     return MSG_NOT_HANDLED;
 209 }
 210
 211 /* --------------------------------------------------------------------------------------------- */
 212
 213 static void
 214 dlg_key_event (WDialog * h, int d_key)
 215 {
 216     Widget *w = WIDGET (h);
 217     WGroup *g = GROUP (h);
 218     cb_ret_t handled;
 219
 220     if (g->widgets == NULL)
 221         return;
 222
 223     if (g->current == NULL)
 224         g->current = g->widgets;
 225
 226     /* TAB used to cycle */
 227     if (!widget_get_options (w, WOP_WANT_TAB))
 228     {
 229         if (d_key == '\t')
 230         {
 231             group_select_next_widget (g);
 232             return;
 233         }
 234         else if ((d_key & ~(KEY_M_SHIFT | KEY_M_CTRL)) == '\t')
 235         {
 236             group_select_prev_widget (g);
 237             return;
 238         }
 239     }
 240
 241     /* first can dlalog handle the key itself */
 242     handled = send_message (h, NULL, MSG_KEY, d_key, NULL);
 243
 244     if (handled == MSG_NOT_HANDLED)
 245         handled = group_default_callback (w, NULL, MSG_KEY, d_key, NULL);
 246
 247     if (handled == MSG_NOT_HANDLED)
 248         handled = dlg_handle_key (h, d_key);
 249
 250     (void) handled;
 251     send_message (h, NULL, MSG_POST_KEY, d_key, NULL);
 252 }
 253
 254 /* --------------------------------------------------------------------------------------------- */
 255
 256 static int
 257 dlg_handle_mouse_event (Widget * w, Gpm_Event * event)
 258 {
 259     if (w->mouse_callback != NULL)
 260     {
 261         int mou;
 262
 263         mou = mouse_handle_event (w, event);
 264         if (mou != MOU_UNHANDLED)
 265             return mou;
 266     }
 267
 268     return group_handle_mouse_event (w, event);
 269 }
 270
 271 /* --------------------------------------------------------------------------------------------- */
 272
 273 static void
 274 frontend_dlg_run (WDialog * h)
 275 {
 276     Widget *wh = WIDGET (h);
 277     Gpm_Event event;
 278
 279     event.x = -1;
 280
 281     /* close opened editors, viewers, etc */
 282     if (!widget_get_state (wh, WST_MODAL) && mc_global.midnight_shutdown)
 283     {
 284         send_message (h, NULL, MSG_VALIDATE, 0, NULL);
 285         return;
 286     }
 287
 288     while (widget_get_state (wh, WST_ACTIVE))
 289     {
 290         int d_key;
 291
 292         if (tty_got_winch ())
 293             dialog_change_screen_size ();
 294
 295         if (is_idle ())
 296         {
 297             if (idle_hook)
 298                 execute_hooks (idle_hook);
 299
 300             while (widget_get_state (wh, WST_IDLE) && is_idle ())
 301                 send_message (wh, NULL, MSG_IDLE, 0, NULL);
 302
 303             /* Allow terminating the dialog from the idle handler */
 304             if (!widget_get_state (wh, WST_ACTIVE))
 305                 break;
 306         }
 307
 308         widget_update_cursor (wh);
 309
 310         /* Clear interrupt flag */
 311         tty_got_interrupt ();
 312         d_key = tty_get_event (&event, GROUP (h)->mouse_status == MOU_REPEAT, TRUE);
 313
 314         dlg_process_event (h, d_key, &event);
 315
 316         if (widget_get_state (wh, WST_CLOSED))
 317             send_message (h, NULL, MSG_VALIDATE, 0, NULL);
 318     }
 319 }
 320
 321 /* --------------------------------------------------------------------------------------------- */
 322
 323 static void
 324 dlg_default_destroy (Widget * w)
 325 {
 326     WDialog *h = DIALOG (w);
 327
 328     /* if some widgets have history, save all histories at one moment here */
 329     dlg_save_history (h);
 330     group_default_callback (w, NULL, MSG_DESTROY, 0, NULL);
 331     send_message (w, NULL, MSG_DESTROY, 0, NULL);
 332     mc_event_group_del (h->event_group);
 333     g_free (h->event_group);
 334     g_free (h);
 335
 336     do_refresh ();
 337 }
 338
 339 /* --------------------------------------------------------------------------------------------- */
 340 /*** public functions ****************************************************************************/
 341 /* --------------------------------------------------------------------------------------------- */
 342 /** Default dialog callback */
 343
 344 cb_ret_t
 345 dlg_default_callback (Widget * w, Widget * sender, widget_msg_t msg, int parm, void *data)
 346 {
 347     switch (msg)
 348     {
 349     case MSG_INIT:
 350         /* nothing to init in dialog itself */
 351         return MSG_HANDLED;
 352
 353     case MSG_IDLE:
 354         /* we don't want endless loop */
 355         widget_idle (w, FALSE);
 356         return MSG_HANDLED;
 357
 358     case MSG_DESTROY:
 359         /* nothing to deinit in dialog itself */
 360         return MSG_HANDLED;
 361
 362     default:
 363         return group_default_callback (w, sender, msg, parm, data);
 364     }
 365 }
 366
 367 /* --------------------------------------------------------------------------------------------- */
 368
 369 void
 370 dlg_default_mouse_callback (Widget * w, mouse_msg_t msg, mouse_event_t * event)
 371 {
 372     switch (msg)
 373     {
 374     case MSG_MOUSE_CLICK:
 375         if (event->y < 0 || event->y >= w->rect.lines || event->x < 0 || event->x >= w->rect.cols)
 376         {
 377             DIALOG (w)->ret_value = B_CANCEL;
 378             dlg_close (DIALOG (w));
 379         }
 380         break;
 381
 382     default:
 383         /* return MOU_UNHANDLED */
 384         event->result.abort = TRUE;
 385         break;
 386     }
 387 }
 388
 389 /* --------------------------------------------------------------------------------------------- */
 390
 391 WDialog *
 392 dlg_create (gboolean modal, int y1, int x1, int lines, int cols, widget_pos_flags_t pos_flags,
 393             gboolean compact, const int *colors, widget_cb_fn callback,
 394             widget_mouse_cb_fn mouse_callback, const char *help_ctx, const char *title)
 395 {
 396     WRect r = { y1, x1, lines, cols };
 397     WDialog *new_d;
 398     Widget *w;
 399     WGroup *g;
 400
 401     new_d = g_new0 (WDialog, 1);
 402     w = WIDGET (new_d);
 403     g = GROUP (new_d);
 404     widget_adjust_position (pos_flags, &r);
 405     group_init (g, &r, callback != NULL ? callback : dlg_default_callback,
 406                 mouse_callback != NULL ? mouse_callback : dlg_default_mouse_callback);
 407
 408     w->pos_flags = pos_flags;
 409     w->options |= WOP_SELECTABLE | WOP_TOP_SELECT;
 410     w->state |= WST_FOCUSED;
 411     /* Temporary hack: dialog doesn't have an owner, own itself. */
 412     w->owner = g;
 413
 414     w->keymap = dialog_map;
 415
 416     w->mouse_handler = dlg_handle_mouse_event;
 417     w->mouse.forced_capture = mouse_close_dialog && (w->pos_flags & WPOS_FULLSCREEN) == 0;
 418
 419     w->destroy = dlg_default_destroy;
 420     w->get_colors = dlg_default_get_colors;
 421
 422     new_d->colors = colors;
 423     new_d->help_ctx = help_ctx;
 424     new_d->compact = compact;
 425     new_d->data.p = NULL;
 426
 427     if (modal)
 428     {
 429         w->state |= WST_MODAL;
 430
 431         new_d->bg =
 432             WIDGET (frame_new (0, 0, w->rect.lines, w->rect.cols, title, FALSE, new_d->compact));
 433         group_add_widget (g, new_d->bg);
 434         frame_set_title (FRAME (new_d->bg), title);
 435     }
 436
 437     /* unique name of event group for this dialog */
 438     new_d->event_group = g_strdup_printf ("%s_%p", MCEVENT_GROUP_DIALOG, (void *) new_d);
 439
 440     return new_d;
 441 }
 442
 443 /* --------------------------------------------------------------------------------------------- */
 444
 445 void
 446 dlg_set_default_colors (void)
 447 {
 448     dialog_colors[DLG_COLOR_NORMAL] = COLOR_NORMAL;
 449     dialog_colors[DLG_COLOR_FOCUS] = COLOR_FOCUS;
 450     dialog_colors[DLG_COLOR_HOT_NORMAL] = COLOR_HOT_NORMAL;
 451     dialog_colors[DLG_COLOR_HOT_FOCUS] = COLOR_HOT_FOCUS;
 452     dialog_colors[DLG_COLOR_TITLE] = COLOR_TITLE;
 453
 454     alarm_colors[DLG_COLOR_NORMAL] = ERROR_COLOR;
 455     alarm_colors[DLG_COLOR_FOCUS] = ERROR_FOCUS;
 456     alarm_colors[DLG_COLOR_HOT_NORMAL] = ERROR_HOT_NORMAL;
 457     alarm_colors[DLG_COLOR_HOT_FOCUS] = ERROR_HOT_FOCUS;
 458     alarm_colors[DLG_COLOR_TITLE] = ERROR_TITLE;
 459
 460     listbox_colors[DLG_COLOR_NORMAL] = PMENU_ENTRY_COLOR;
 461     listbox_colors[DLG_COLOR_FOCUS] = PMENU_SELECTED_COLOR;
 462     listbox_colors[DLG_COLOR_HOT_NORMAL] = PMENU_ENTRY_COLOR;
 463     listbox_colors[DLG_COLOR_HOT_FOCUS] = PMENU_SELECTED_COLOR;
 464     listbox_colors[DLG_COLOR_TITLE] = PMENU_TITLE_COLOR;
 465 }
 466
 467 /* --------------------------------------------------------------------------------------------- */
 468
 469 void
 470 dlg_close (WDialog * h)
 471 {
 472     widget_set_state (WIDGET (h), WST_CLOSED, TRUE);
 473 }
 474
 475 /* --------------------------------------------------------------------------------------------- */
 476 /** Init the process */
 477
 478 void
 479 dlg_init (WDialog * h)
 480 {
 481     WGroup *g = GROUP (h);
 482     Widget *wh = WIDGET (h);
 483
 484     if (top_dlg != NULL && widget_get_state (WIDGET (top_dlg->data), WST_MODAL))
 485         widget_set_state (wh, WST_MODAL, TRUE);
 486
 487     /* add dialog to the stack */
 488     top_dlg = g_list_prepend (top_dlg, h);
 489
 490     /* Initialize dialog manager and widgets */
 491     if (widget_get_state (wh, WST_CONSTRUCT))
 492     {
 493         if (!widget_get_state (wh, WST_MODAL))
 494             dialog_switch_add (h);
 495
 496         send_message (h, NULL, MSG_INIT, 0, NULL);
 497         group_default_callback (wh, NULL, MSG_INIT, 0, NULL);
 498         dlg_read_history (h);
 499     }
 500
 501     /* Select the first widget that takes focus */
 502     while (g->current != NULL && !widget_is_focusable (g->current->data))
 503         group_set_current_widget_next (g);
 504
 505     widget_set_state (wh, WST_ACTIVE, TRUE);
 506     widget_draw (wh);
 507
 508     h->ret_value = 0;
 509 }
 510
 511 /* --------------------------------------------------------------------------------------------- */
 512
 513 void
 514 dlg_process_event (WDialog * h, int key, Gpm_Event * event)
 515 {
 516     switch (key)
 517     {
 518     case EV_NONE:
 519         if (tty_got_interrupt ())
 520             dlg_execute_cmd (h, CK_Cancel);
 521         break;
 522
 523     case EV_MOUSE:
 524         {
 525             Widget *w = WIDGET (h);
 526
 527             GROUP (h)->mouse_status = w->mouse_handler (w, event);
 528             break;
 529         }
 530
 531     default:
 532         dlg_key_event (h, key);
 533         break;
 534     }
 535 }
 536
 537 /* --------------------------------------------------------------------------------------------- */
 538 /** Shutdown the dlg_run */
 539
 540 void
 541 dlg_run_done (WDialog * h)
 542 {
 543     top_dlg = g_list_remove (top_dlg, h);
 544
 545     if (widget_get_state (WIDGET (h), WST_CLOSED))
 546     {
 547         send_message (h, GROUP (h)->current == NULL ? NULL : WIDGET (GROUP (h)->current->data),
 548                       MSG_END, 0, NULL);
 549         if (!widget_get_state (WIDGET (h), WST_MODAL))
 550             dialog_switch_remove (h);
 551     }
 552 }
 553
 554 /* --------------------------------------------------------------------------------------------- */
 555 /**
 556  * Standard run dialog routine
 557  * We have to keep this routine small so that we can duplicate it's
 558  * behavior on complex routines like the file routines, this way,
 559  * they can call the dlg_process_event without rewriting all the code
 560  */
 561
 562 int
 563 dlg_run (WDialog * h)
 564 {
 565     dlg_init (h);
 566     frontend_dlg_run (h);
 567     dlg_run_done (h);
 568     return h->ret_value;
 569 }
 570
 571 /* --------------------------------------------------------------------------------------------- */
 572
 573 /**
 574   * Write history to the ${XDG_DATA_HOME}/mc/history file
 575   */
 576 void
 577 dlg_save_history (WDialog * h)
 578 {
 579     char *profile;
 580     int i;
 581
 582     if (num_history_items_recorded == 0)        /* this is how to disable */
 583         return;
 584
 585     profile = mc_config_get_full_path (MC_HISTORY_FILE);
 586     i = open (profile, O_CREAT | O_EXCL, S_IRUSR | S_IWUSR);
 587     if (i != -1)
 588         close (i);
 589
 590     /* Make sure the history is only readable by the user */
 591     if (chmod (profile, S_IRUSR | S_IWUSR) != -1 || errno == ENOENT)
 592     {
 593         ev_history_load_save_t event_data;
 594
 595         event_data.cfg = mc_config_init (profile, FALSE);
 596         event_data.receiver = NULL;
 597
 598         /* get all histories in dialog */
 599         mc_event_raise (h->event_group, MCEVENT_HISTORY_SAVE, &event_data);
 600
 601         mc_config_save_file (event_data.cfg, NULL);
 602         mc_config_deinit (event_data.cfg);
 603     }
 604
 605     g_free (profile);
 606 }
 607
 608 /* --------------------------------------------------------------------------------------------- */
 609
 610 char *
 611 dlg_get_title (const WDialog * h, size_t len)
 612 {
 613     char *t;
 614
 615     if (h == NULL)
 616         abort ();
 617
 618     if (h->get_title != NULL)
 619         t = h->get_title (h, len);
 620     else
 621         t = g_strdup ("");
 622
 623     return t;
 624 }
 625
 626 /* --------------------------------------------------------------------------------------------- */