lib/widget/dialog.c

   1 /*
   2    Dialog box features module for the Midnight Commander
   3
   4    Copyright (C) 1994-2019
   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
  47 #include "lib/widget.h"
  48 #include "lib/widget/mouse.h"
  49
  50 /*** global variables ****************************************************************************/
  51
  52 /* Color styles for normal and error dialogs */
  53 dlg_colors_t dialog_colors;
  54 dlg_colors_t alarm_colors;
  55 dlg_colors_t listbox_colors;
  56
  57 /* Primitive way to check if the the current dialog is our dialog */
  58 /* This is needed by async routines like load_prompt */
  59 GList *top_dlg = NULL;
  60
  61 /* A hook list for idle events */
  62 hook_t *idle_hook = NULL;
  63
  64 /* If set then dialogs just clean the screen when refreshing, else */
  65 /* they do a complete refresh, refreshing all the parts of the program */
  66 gboolean fast_refresh = FALSE;
  67
  68 /* left click outside of dialog closes it */
  69 gboolean mouse_close_dialog = FALSE;
  70
  71 const global_keymap_t *dialog_map = NULL;
  72
  73 /*** file scope macro definitions ****************************************************************/
  74
  75 /*** file scope type declarations ****************************************************************/
  76
  77 /* Control widget positions in dialog */
  78 typedef struct
  79 {
  80     int shift_x;
  81     int scale_x;
  82     int shift_y;
  83     int scale_y;
  84 } widget_shift_scale_t;
  85
  86 /*** file scope variables ************************************************************************/
  87
  88 /* --------------------------------------------------------------------------------------------- */
  89 /*** file scope functions ************************************************************************/
  90 /* --------------------------------------------------------------------------------------------- */
  91
  92 static GList *
  93 dlg_get_next_or_prev_of (const GList * list, gboolean next)
  94 {
  95     GList *l = NULL;
  96
  97     if (list != NULL)
  98     {
  99         const WDialog *owner = CONST_WIDGET (list->data)->owner;
 100
 101         if (owner != NULL)
 102         {
 103             if (next)
 104             {
 105                 l = g_list_next (list);
 106                 if (l == NULL)
 107                     l = owner->widgets;
 108             }
 109             else
 110             {
 111                 l = g_list_previous (list);
 112                 if (l == NULL)
 113                     l = g_list_last (owner->widgets);
 114             }
 115         }
 116     }
 117
 118     return l;
 119 }
 120
 121 /* --------------------------------------------------------------------------------------------- */
 122
 123 static void
 124 dlg_select_next_or_prev (WDialog * h, gboolean next)
 125 {
 126     if (h->widgets != NULL && h->current != NULL)
 127     {
 128         GList *l = h->current;
 129         Widget *w;
 130
 131         do
 132         {
 133             l = dlg_get_next_or_prev_of (l, next);
 134             w = WIDGET (l->data);
 135         }
 136         while ((widget_get_state (w, WST_DISABLED) || !widget_get_options (w, WOP_SELECTABLE))
 137                && l != h->current);
 138
 139         widget_select (l->data);
 140     }
 141 }
 142
 143 /* --------------------------------------------------------------------------------------------- */
 144 /**
 145  * broadcast a message to all the widgets in a dialog that have
 146  * the options set to flags. If flags is zero, the message is sent
 147  * to all widgets.
 148  */
 149
 150 static void
 151 dlg_broadcast_msg_to (WDialog * h, widget_msg_t msg, gboolean reverse, widget_options_t flags)
 152 {
 153     GList *p, *first;
 154
 155     if (h->widgets == NULL)
 156         return;
 157
 158     if (h->current == NULL)
 159         h->current = h->widgets;
 160
 161     p = dlg_get_next_or_prev_of (h->current, !reverse);
 162     first = p;
 163
 164     do
 165     {
 166         Widget *w = WIDGET (p->data);
 167
 168         p = dlg_get_next_or_prev_of (p, !reverse);
 169
 170         if ((flags == 0) || ((flags & w->options) != 0))
 171             send_message (w, NULL, msg, 0, NULL);
 172     }
 173     while (first != p);
 174 }
 175
 176 /* --------------------------------------------------------------------------------------------- */
 177
 178 /**
 179   * Read histories from the ${XDG_CACHE_HOME}/mc/history file
 180   */
 181 static void
 182 dlg_read_history (WDialog * h)
 183 {
 184     char *profile;
 185     ev_history_load_save_t event_data;
 186
 187     if (num_history_items_recorded == 0)        /* this is how to disable */
 188         return;
 189
 190     profile = mc_config_get_full_path (MC_HISTORY_FILE);
 191     event_data.cfg = mc_config_init (profile, TRUE);
 192     event_data.receiver = NULL;
 193
 194     /* create all histories in dialog */
 195     mc_event_raise (h->event_group, MCEVENT_HISTORY_LOAD, &event_data);
 196
 197     mc_config_deinit (event_data.cfg);
 198     g_free (profile);
 199 }
 200
 201 /* --------------------------------------------------------------------------------------------- */
 202
 203 static int
 204 dlg_find_widget_callback (const void *a, const void *b)
 205 {
 206     const Widget *w = CONST_WIDGET (a);
 207     const widget_cb_fn f = b;
 208
 209     return (w->callback == f) ? 0 : 1;
 210 }
 211
 212 /* --------------------------------------------------------------------------------------------- */
 213
 214 static void
 215 refresh_cmd (void)
 216 {
 217 #ifdef HAVE_SLANG
 218     tty_touch_screen ();
 219     mc_refresh ();
 220 #else
 221     /* Use this if the refreshes fail */
 222     clr_scr ();
 223     repaint_screen ();
 224 #endif /* HAVE_SLANG */
 225 }
 226
 227 /* --------------------------------------------------------------------------------------------- */
 228
 229 static cb_ret_t
 230 dlg_execute_cmd (WDialog * h, long command)
 231 {
 232     cb_ret_t ret = MSG_HANDLED;
 233     switch (command)
 234     {
 235     case CK_Ok:
 236         h->ret_value = B_ENTER;
 237         dlg_stop (h);
 238         break;
 239     case CK_Cancel:
 240         h->ret_value = B_CANCEL;
 241         dlg_stop (h);
 242         break;
 243
 244     case CK_Up:
 245     case CK_Left:
 246         dlg_select_prev_widget (h);
 247         break;
 248     case CK_Down:
 249     case CK_Right:
 250         dlg_select_next_widget (h);
 251         break;
 252
 253     case CK_Help:
 254         {
 255             ev_help_t event_data = { NULL, h->help_ctx };
 256             mc_event_raise (MCEVENT_GROUP_CORE, "help", &event_data);
 257         }
 258         break;
 259
 260     case CK_Suspend:
 261         mc_event_raise (MCEVENT_GROUP_CORE, "suspend", NULL);
 262         refresh_cmd ();
 263         break;
 264     case CK_Refresh:
 265         refresh_cmd ();
 266         break;
 267
 268     case CK_ScreenList:
 269         if (!widget_get_state (WIDGET (h), WST_MODAL))
 270             dialog_switch_list ();
 271         else
 272             ret = MSG_NOT_HANDLED;
 273         break;
 274     case CK_ScreenNext:
 275         if (!widget_get_state (WIDGET (h), WST_MODAL))
 276             dialog_switch_next ();
 277         else
 278             ret = MSG_NOT_HANDLED;
 279         break;
 280     case CK_ScreenPrev:
 281         if (!widget_get_state (WIDGET (h), WST_MODAL))
 282             dialog_switch_prev ();
 283         else
 284             ret = MSG_NOT_HANDLED;
 285         break;
 286
 287     default:
 288         ret = MSG_NOT_HANDLED;
 289     }
 290
 291     return ret;
 292 }
 293
 294 /* --------------------------------------------------------------------------------------------- */
 295
 296 static cb_ret_t
 297 dlg_handle_key (WDialog * h, int d_key)
 298 {
 299     long command;
 300
 301     command = keybind_lookup_keymap_command (dialog_map, d_key);
 302
 303     if (command == CK_IgnoreKey)
 304         return MSG_NOT_HANDLED;
 305
 306     if (send_message (h, NULL, MSG_ACTION, command, NULL) == MSG_HANDLED
 307         || dlg_execute_cmd (h, command) == MSG_HANDLED)
 308         return MSG_HANDLED;
 309
 310     return MSG_NOT_HANDLED;
 311 }
 312
 313 /* --------------------------------------------------------------------------------------------- */
 314 /**
 315  * This is the low-level mouse handler.
 316  * It receives a Gpm_Event event and translates it into a higher level protocol.
 317  */
 318 static int
 319 dlg_mouse_translator (Gpm_Event * event, Widget * w)
 320 {
 321     mouse_event_t me;
 322
 323     me = mouse_translate_event (w, event);
 324
 325     return mouse_process_event (w, &me);
 326 }
 327
 328 /* --------------------------------------------------------------------------------------------- */
 329
 330 static int
 331 dlg_mouse_event (WDialog * h, Gpm_Event * event)
 332 {
 333     Widget *wh = WIDGET (h);
 334
 335     GList *p;
 336
 337     /* close the dialog by mouse left click out of dialog area */
 338     if (mouse_close_dialog && (wh->pos_flags & WPOS_FULLSCREEN) == 0
 339         && ((event->buttons & GPM_B_LEFT) != 0) && ((event->type & GPM_DOWN) != 0)
 340         && !mouse_global_in_widget (event, wh))
 341     {
 342         h->ret_value = B_CANCEL;
 343         dlg_stop (h);
 344         return MOU_NORMAL;
 345     }
 346
 347     if (wh->mouse_callback != NULL)
 348     {
 349         int mou;
 350
 351         mou = dlg_mouse_translator (event, wh);
 352         if (mou != MOU_UNHANDLED)
 353             return mou;
 354     }
 355
 356     if (h->widgets == NULL)
 357         return MOU_UNHANDLED;
 358
 359     /* send the event to widgets in reverse Z-order */
 360     p = g_list_last (h->widgets);
 361     do
 362     {
 363         Widget *w = WIDGET (p->data);
 364
 365         if (!widget_get_state (w, WST_DISABLED) && w->mouse_callback != NULL)
 366         {
 367             /* put global cursor position to the widget */
 368             int ret;
 369
 370             ret = dlg_mouse_translator (event, w);
 371             if (ret != MOU_UNHANDLED)
 372                 return ret;
 373         }
 374
 375         p = g_list_previous (p);
 376     }
 377     while (p != NULL);
 378
 379     return MOU_UNHANDLED;
 380 }
 381
 382 /* --------------------------------------------------------------------------------------------- */
 383
 384 static cb_ret_t
 385 dlg_try_hotkey (WDialog * h, int d_key)
 386 {
 387     GList *hot_cur;
 388     Widget *current;
 389     cb_ret_t handled;
 390     int c;
 391
 392     if (h->widgets == NULL)
 393         return MSG_NOT_HANDLED;
 394
 395     if (h->current == NULL)
 396         h->current = h->widgets;
 397
 398     /*
 399      * Explanation: we don't send letter hotkeys to other widgets if
 400      * the currently selected widget is an input line
 401      */
 402
 403     current = WIDGET (h->current->data);
 404
 405     if (widget_get_state (current, WST_DISABLED))
 406         return MSG_NOT_HANDLED;
 407
 408     if (widget_get_options (current, WOP_IS_INPUT))
 409     {
 410         /* skip ascii control characters, anything else can valid character in
 411          * some encoding */
 412         if (d_key >= 32 && d_key < 256)
 413             return MSG_NOT_HANDLED;
 414     }
 415
 416     /* If it's an alt key, send the message */
 417     c = d_key & ~ALT (0);
 418     if (d_key & ALT (0) && g_ascii_isalpha (c))
 419         d_key = g_ascii_tolower (c);
 420
 421     handled = MSG_NOT_HANDLED;
 422     if (widget_get_options (current, WOP_WANT_HOTKEY))
 423         handled = send_message (current, NULL, MSG_HOTKEY, d_key, NULL);
 424
 425     /* If not used, send hotkey to other widgets */
 426     if (handled == MSG_HANDLED)
 427         return MSG_HANDLED;
 428
 429     hot_cur = dlg_get_widget_next_of (h->current);
 430
 431     /* send it to all widgets */
 432     while (h->current != hot_cur && handled == MSG_NOT_HANDLED)
 433     {
 434         current = WIDGET (hot_cur->data);
 435
 436         if (widget_get_options (current, WOP_WANT_HOTKEY)
 437             && !widget_get_state (current, WST_DISABLED))
 438             handled = send_message (current, NULL, MSG_HOTKEY, d_key, NULL);
 439
 440         if (handled == MSG_NOT_HANDLED)
 441             hot_cur = dlg_get_widget_next_of (hot_cur);
 442     }
 443
 444     if (handled == MSG_HANDLED)
 445         widget_select (WIDGET (hot_cur->data));
 446
 447     return handled;
 448 }
 449
 450 /* --------------------------------------------------------------------------------------------- */
 451
 452 static void
 453 dlg_key_event (WDialog * h, int d_key)
 454 {
 455     cb_ret_t handled;
 456
 457     if (h->widgets == NULL)
 458         return;
 459
 460     if (h->current == NULL)
 461         h->current = h->widgets;
 462
 463     /* TAB used to cycle */
 464     if (!widget_get_options (WIDGET (h), WOP_WANT_TAB))
 465     {
 466         if (d_key == '\t')
 467         {
 468             dlg_select_next_widget (h);
 469             return;
 470         }
 471         else if ((d_key & ~(KEY_M_SHIFT | KEY_M_CTRL)) == '\t')
 472         {
 473             dlg_select_prev_widget (h);
 474             return;
 475         }
 476     }
 477
 478     /* first can dlg_callback handle the key */
 479     handled = send_message (h, NULL, MSG_KEY, d_key, NULL);
 480
 481     /* next try the hotkey */
 482     if (handled == MSG_NOT_HANDLED)
 483         handled = dlg_try_hotkey (h, d_key);
 484
 485     if (handled == MSG_HANDLED)
 486         send_message (h, NULL, MSG_HOTKEY_HANDLED, 0, NULL);
 487     else
 488         /* not used - then try widget_callback */
 489         handled = send_message (h->current->data, NULL, MSG_KEY, d_key, NULL);
 490
 491     /* not used- try to use the unhandled case */
 492     if (handled == MSG_NOT_HANDLED)
 493         handled = send_message (h, NULL, MSG_UNHANDLED_KEY, d_key, NULL);
 494
 495     if (handled == MSG_NOT_HANDLED)
 496         handled = dlg_handle_key (h, d_key);
 497
 498     (void) handled;
 499     send_message (h, NULL, MSG_POST_KEY, d_key, NULL);
 500 }
 501
 502 /* --------------------------------------------------------------------------------------------- */
 503
 504 static void
 505 frontend_dlg_run (WDialog * h)
 506 {
 507     Widget *wh = WIDGET (h);
 508     Gpm_Event event;
 509
 510     event.x = -1;
 511
 512     /* close opened editors, viewers, etc */
 513     if (!widget_get_state (wh, WST_MODAL) && mc_global.midnight_shutdown)
 514     {
 515         send_message (h, NULL, MSG_VALIDATE, 0, NULL);
 516         return;
 517     }
 518
 519     while (widget_get_state (wh, WST_ACTIVE))
 520     {
 521         int d_key;
 522
 523         if (mc_global.tty.winch_flag != 0)
 524             dialog_change_screen_size ();
 525
 526         if (is_idle ())
 527         {
 528             if (idle_hook)
 529                 execute_hooks (idle_hook);
 530
 531             while (widget_get_state (wh, WST_IDLE) && is_idle ())
 532                 send_message (wh, NULL, MSG_IDLE, 0, NULL);
 533
 534             /* Allow terminating the dialog from the idle handler */
 535             if (!widget_get_state (wh, WST_ACTIVE))
 536                 break;
 537         }
 538
 539         update_cursor (h);
 540
 541         /* Clear interrupt flag */
 542         tty_got_interrupt ();
 543         d_key = tty_get_event (&event, h->mouse_status == MOU_REPEAT, TRUE);
 544
 545         dlg_process_event (h, d_key, &event);
 546
 547         if (widget_get_state (wh, WST_CLOSED))
 548             send_message (h, NULL, MSG_VALIDATE, 0, NULL);
 549     }
 550 }
 551
 552 /* --------------------------------------------------------------------------------------------- */
 553
 554 static int
 555 dlg_find_widget_by_id (gconstpointer a, gconstpointer b)
 556 {
 557     const Widget *w = CONST_WIDGET (a);
 558     unsigned long id = GPOINTER_TO_UINT (b);
 559
 560     return w->id == id ? 0 : 1;
 561 }
 562
 563 /* --------------------------------------------------------------------------------------------- */
 564 static void
 565 dlg_widget_set_position (gpointer data, gpointer user_data)
 566 {
 567     /* there are, mainly, 2 generally possible situations:
 568      * 1. control sticks to one side - it should be moved
 569      * 2. control sticks to two sides of one direction - it should be sized
 570      */
 571
 572     Widget *c = WIDGET (data);
 573     Widget *wh = WIDGET (c->owner);
 574     const widget_shift_scale_t *wss = (const widget_shift_scale_t *) user_data;
 575     int x = c->x;
 576     int y = c->y;
 577     int cols = c->cols;
 578     int lines = c->lines;
 579
 580     if ((c->pos_flags & WPOS_CENTER_HORZ) != 0)
 581         x = wh->x + (wh->cols - c->cols) / 2;
 582     else if ((c->pos_flags & WPOS_KEEP_LEFT) != 0 && (c->pos_flags & WPOS_KEEP_RIGHT) != 0)
 583     {
 584         x += wss->shift_x;
 585         cols += wss->scale_x;
 586     }
 587     else if ((c->pos_flags & WPOS_KEEP_LEFT) != 0)
 588         x += wss->shift_x;
 589     else if ((c->pos_flags & WPOS_KEEP_RIGHT) != 0)
 590         x += wss->shift_x + wss->scale_x;
 591
 592     if ((c->pos_flags & WPOS_CENTER_VERT) != 0)
 593         y = wh->y + (wh->lines - c->lines) / 2;
 594     else if ((c->pos_flags & WPOS_KEEP_TOP) != 0 && (c->pos_flags & WPOS_KEEP_BOTTOM) != 0)
 595     {
 596         y += wss->shift_y;
 597         lines += wss->scale_y;
 598     }
 599     else if ((c->pos_flags & WPOS_KEEP_TOP) != 0)
 600         y += wss->shift_y;
 601     else if ((c->pos_flags & WPOS_KEEP_BOTTOM) != 0)
 602         y += wss->shift_y + wss->scale_y;
 603
 604     widget_set_size (c, y, x, lines, cols);
 605 }
 606
 607 /* --------------------------------------------------------------------------------------------- */
 608
 609 static void
 610 dlg_adjust_position (widget_pos_flags_t pos_flags, int *y, int *x, int *lines, int *cols)
 611 {
 612     if ((pos_flags & WPOS_FULLSCREEN) != 0)
 613     {
 614         *y = 0;
 615         *x = 0;
 616         *lines = LINES;
 617         *cols = COLS;
 618     }
 619     else
 620     {
 621         if ((pos_flags & WPOS_CENTER_HORZ) != 0)
 622             *x = (COLS - *cols) / 2;
 623
 624         if ((pos_flags & WPOS_CENTER_VERT) != 0)
 625             *y = (LINES - *lines) / 2;
 626
 627         if ((pos_flags & WPOS_TRYUP) != 0)
 628         {
 629             if (*y > 3)
 630                 *y -= 2;
 631             else if (*y == 3)
 632                 *y = 2;
 633         }
 634     }
 635 }
 636
 637 /* --------------------------------------------------------------------------------------------- */
 638 /*** public functions ****************************************************************************/
 639 /* --------------------------------------------------------------------------------------------- */
 640
 641 /** Clean the dialog area, draw the frame and the title */
 642 void
 643 dlg_default_repaint (WDialog * h)
 644 {
 645     Widget *wh = WIDGET (h);
 646
 647     int space;
 648
 649     if (!widget_get_state (wh, WST_ACTIVE))
 650         return;
 651
 652     space = h->compact ? 0 : 1;
 653
 654     tty_setcolor (h->color[DLG_COLOR_NORMAL]);
 655     dlg_erase (h);
 656     tty_draw_box (wh->y + space, wh->x + space, wh->lines - 2 * space, wh->cols - 2 * space, FALSE);
 657
 658     if (h->title != NULL)
 659     {
 660         /* TODO: truncate long title */
 661         tty_setcolor (h->color[DLG_COLOR_TITLE]);
 662         widget_move (h, space, (wh->cols - str_term_width1 (h->title)) / 2);
 663         tty_print_string (h->title);
 664     }
 665 }
 666
 667 /* --------------------------------------------------------------------------------------------- */
 668 /** this function allows to set dialog position */
 669
 670 void
 671 dlg_set_position (WDialog * h, int y, int x, int lines, int cols)
 672 {
 673     Widget *wh = WIDGET (h);
 674     widget_shift_scale_t wss;
 675
 676     /* save old positions, will be used to reposition childs */
 677     int ox, oy, oc, ol;
 678
 679     /* save old positions, will be used to reposition childs */
 680     ox = wh->x;
 681     oy = wh->y;
 682     oc = wh->cols;
 683     ol = wh->lines;
 684
 685     wh->x = x;
 686     wh->y = y;
 687     wh->lines = lines;
 688     wh->cols = cols;
 689
 690     /* dialog is empty */
 691     if (h->widgets == NULL)
 692         return;
 693
 694     if (h->current == NULL)
 695         h->current = h->widgets;
 696
 697     /* values by which controls should be moved */
 698     wss.shift_x = wh->x - ox;
 699     wss.scale_x = wh->cols - oc;
 700     wss.shift_y = wh->y - oy;
 701     wss.scale_y = wh->lines - ol;
 702
 703     if (wss.shift_x != 0 || wss.shift_y != 0 || wss.scale_x != 0 || wss.scale_y != 0)
 704         g_list_foreach (h->widgets, dlg_widget_set_position, &wss);
 705 }
 706
 707 /* --------------------------------------------------------------------------------------------- */
 708 /** Set dialog size and position */
 709
 710 void
 711 dlg_set_size (WDialog * h, int lines, int cols)
 712 {
 713     int x = 0, y = 0;
 714
 715     dlg_adjust_position (WIDGET (h)->pos_flags, &y, &x, &lines, &cols);
 716     dlg_set_position (h, y, x, lines, cols);
 717 }
 718
 719 /* --------------------------------------------------------------------------------------------- */
 720 /** Default dialog callback */
 721
 722 cb_ret_t
 723 dlg_default_callback (Widget * w, Widget * sender, widget_msg_t msg, int parm, void *data)
 724 {
 725     WDialog *h = DIALOG (w);
 726
 727     (void) sender;
 728     (void) parm;
 729     (void) data;
 730
 731     switch (msg)
 732     {
 733     case MSG_DRAW:
 734         if (h->color != NULL)
 735         {
 736             dlg_default_repaint (h);
 737             return MSG_HANDLED;
 738         }
 739         return MSG_NOT_HANDLED;
 740
 741     case MSG_IDLE:
 742         /* we don't want endless loop */
 743         widget_idle (w, FALSE);
 744         return MSG_HANDLED;
 745
 746     case MSG_RESIZE:
 747         /* this is default resizing mechanism */
 748         /* the main idea of this code is to resize dialog
 749            according to flags (if any of flags require automatic
 750            resizing, like WPOS_CENTER, end after that reposition
 751            controls in dialog according to flags of widget) */
 752         dlg_set_size (h, w->lines, w->cols);
 753         return MSG_HANDLED;
 754
 755     default:
 756         break;
 757     }
 758
 759     return MSG_NOT_HANDLED;
 760 }
 761
 762 /* --------------------------------------------------------------------------------------------- */
 763
 764 WDialog *
 765 dlg_create (gboolean modal, int y1, int x1, int lines, int cols, widget_pos_flags_t pos_flags,
 766             gboolean compact, const int *colors, widget_cb_fn callback,
 767             widget_mouse_cb_fn mouse_callback, const char *help_ctx, const char *title)
 768 {
 769     WDialog *new_d;
 770     Widget *w;
 771
 772     new_d = g_new0 (WDialog, 1);
 773     w = WIDGET (new_d);
 774     dlg_adjust_position (pos_flags, &y1, &x1, &lines, &cols);
 775     widget_init (w, y1, x1, lines, cols, (callback != NULL) ? callback : dlg_default_callback,
 776                  mouse_callback);
 777     w->pos_flags = pos_flags;
 778     w->options |= WOP_SELECTABLE | WOP_TOP_SELECT;
 779
 780     w->state |= WST_CONSTRUCT | WST_FOCUSED;
 781     if (modal)
 782         w->state |= WST_MODAL;
 783
 784     new_d->color = colors;
 785     new_d->help_ctx = help_ctx;
 786     new_d->compact = compact;
 787     new_d->data = NULL;
 788
 789     new_d->mouse_status = MOU_UNHANDLED;
 790
 791     dlg_set_title (new_d, title);
 792
 793     /* unique name of event group for this dialog */
 794     new_d->event_group = g_strdup_printf ("%s_%p", MCEVENT_GROUP_DIALOG, (void *) new_d);
 795
 796     return new_d;
 797 }
 798
 799 /* --------------------------------------------------------------------------------------------- */
 800
 801 void
 802 dlg_set_default_colors (void)
 803 {
 804     dialog_colors[DLG_COLOR_NORMAL] = COLOR_NORMAL;
 805     dialog_colors[DLG_COLOR_FOCUS] = COLOR_FOCUS;
 806     dialog_colors[DLG_COLOR_HOT_NORMAL] = COLOR_HOT_NORMAL;
 807     dialog_colors[DLG_COLOR_HOT_FOCUS] = COLOR_HOT_FOCUS;
 808     dialog_colors[DLG_COLOR_TITLE] = COLOR_TITLE;
 809
 810     alarm_colors[DLG_COLOR_NORMAL] = ERROR_COLOR;
 811     alarm_colors[DLG_COLOR_FOCUS] = ERROR_FOCUS;
 812     alarm_colors[DLG_COLOR_HOT_NORMAL] = ERROR_HOT_NORMAL;
 813     alarm_colors[DLG_COLOR_HOT_FOCUS] = ERROR_HOT_FOCUS;
 814     alarm_colors[DLG_COLOR_TITLE] = ERROR_TITLE;
 815
 816     listbox_colors[DLG_COLOR_NORMAL] = PMENU_ENTRY_COLOR;
 817     listbox_colors[DLG_COLOR_FOCUS] = PMENU_SELECTED_COLOR;
 818     listbox_colors[DLG_COLOR_HOT_NORMAL] = PMENU_ENTRY_COLOR;
 819     listbox_colors[DLG_COLOR_HOT_FOCUS] = PMENU_SELECTED_COLOR;
 820     listbox_colors[DLG_COLOR_TITLE] = PMENU_TITLE_COLOR;
 821 }
 822
 823 /* --------------------------------------------------------------------------------------------- */
 824
 825 void
 826 dlg_erase (WDialog * h)
 827 {
 828     Widget *wh = WIDGET (h);
 829
 830     if (wh != NULL && widget_get_state (wh, WST_ACTIVE))
 831         tty_fill_region (wh->y, wh->x, wh->lines, wh->cols, ' ');
 832 }
 833
 834 /* --------------------------------------------------------------------------------------------- */
 835 /**
 836  * Insert widget to dialog before requested widget. Make the widget current. Return widget ID.
 837  */
 838
 839 unsigned long
 840 add_widget_autopos (WDialog * h, void *w, widget_pos_flags_t pos_flags, const void *before)
 841 {
 842     Widget *wh = WIDGET (h);
 843     Widget *widget;
 844     GList *new_current;
 845
 846     /* Don't accept 0 widgets */
 847     if (w == NULL)
 848         abort ();
 849
 850     widget = WIDGET (w);
 851
 852     if ((pos_flags & WPOS_CENTER_HORZ) != 0)
 853         widget->x = (wh->cols - widget->cols) / 2;
 854     widget->x += wh->x;
 855
 856     if ((pos_flags & WPOS_CENTER_VERT) != 0)
 857         widget->y = (wh->lines - widget->lines) / 2;
 858     widget->y += wh->y;
 859
 860     widget->owner = h;
 861     widget->pos_flags = pos_flags;
 862     widget->id = h->widget_id++;
 863
 864     if (h->widgets == NULL || before == NULL)
 865     {
 866         h->widgets = g_list_append (h->widgets, widget);
 867         new_current = g_list_last (h->widgets);
 868     }
 869     else
 870     {
 871         GList *b;
 872
 873         b = g_list_find (h->widgets, before);
 874
 875         /* don't accept widget not from dialog. This shouldn't happen */
 876         if (b == NULL)
 877             abort ();
 878
 879         b = g_list_next (b);
 880         h->widgets = g_list_insert_before (h->widgets, b, widget);
 881         if (b != NULL)
 882             new_current = g_list_previous (b);
 883         else
 884             new_current = g_list_last (h->widgets);
 885     }
 886
 887     /* widget has been added at runtime */
 888     if (widget_get_state (wh, WST_ACTIVE))
 889     {
 890         send_message (widget, NULL, MSG_INIT, 0, NULL);
 891         widget_select (widget);
 892     }
 893     else
 894         h->current = new_current;
 895
 896     return widget->id;
 897 }
 898
 899 /* --------------------------------------------------------------------------------------------- */
 900 /** wrapper to simply add lefttop positioned controls */
 901
 902 unsigned long
 903 add_widget (WDialog * h, void *w)
 904 {
 905     return add_widget_autopos (h, w, WPOS_KEEP_DEFAULT,
 906                                h->current != NULL ? h->current->data : NULL);
 907 }
 908
 909 /* --------------------------------------------------------------------------------------------- */
 910
 911 unsigned long
 912 add_widget_before (WDialog * h, void *w, void *before)
 913 {
 914     return add_widget_autopos (h, w, WPOS_KEEP_DEFAULT, before);
 915 }
 916
 917 /* --------------------------------------------------------------------------------------------- */
 918
 919 /** delete widget from dialog */
 920 void
 921 del_widget (void *w)
 922 {
 923     WDialog *h;
 924     GList *d;
 925
 926     /* Don't accept NULL widget. This shouldn't happen */
 927     if (w == NULL)
 928         abort ();
 929
 930     h = WIDGET (w)->owner;
 931
 932     d = g_list_find (h->widgets, w);
 933     if (d == h->current)
 934         dlg_set_current_widget_next (h);
 935
 936     h->widgets = g_list_remove_link (h->widgets, d);
 937     if (h->widgets == NULL)
 938         h->current = NULL;
 939     send_message (d->data, NULL, MSG_DESTROY, 0, NULL);
 940     g_free (d->data);
 941     g_list_free_1 (d);
 942
 943     /* widget has been deleted in runtime */
 944     if (widget_get_state (WIDGET (h), WST_ACTIVE))
 945     {
 946         dlg_redraw (h);
 947         dlg_select_current_widget (h);
 948     }
 949 }
 950
 951 /* --------------------------------------------------------------------------------------------- */
 952
 953 void
 954 do_refresh (void)
 955 {
 956     GList *d = top_dlg;
 957
 958     if (fast_refresh)
 959     {
 960         if (d != NULL)
 961             dlg_redraw (DIALOG (d->data));
 962     }
 963     else
 964     {
 965         /* Search first fullscreen dialog */
 966         for (; d != NULL; d = g_list_next (d))
 967             if ((WIDGET (d->data)->pos_flags & WPOS_FULLSCREEN) != 0)
 968                 break;
 969         /* back to top dialog */
 970         for (; d != NULL; d = g_list_previous (d))
 971             dlg_redraw (DIALOG (d->data));
 972     }
 973 }
 974
 975 /* --------------------------------------------------------------------------------------------- */
 976 /** broadcast a message to all the widgets in a dialog */
 977
 978 void
 979 dlg_broadcast_msg (WDialog * h, widget_msg_t msg)
 980 {
 981     dlg_broadcast_msg_to (h, msg, FALSE, 0);
 982 }
 983
 984 /* --------------------------------------------------------------------------------------------- */
 985 /** Find the widget with the given callback in the dialog h */
 986
 987 Widget *
 988 find_widget_type (const WDialog * h, widget_cb_fn callback)
 989 {
 990     GList *w;
 991
 992     w = g_list_find_custom (h->widgets, (gconstpointer) callback, dlg_find_widget_callback);
 993
 994     return (w == NULL) ? NULL : WIDGET (w->data);
 995 }
 996
 997 /* --------------------------------------------------------------------------------------------- */
 998
 999 GList *
1000 dlg_find (const WDialog * h, const Widget * w)
1001 {
1002     return (w->owner == NULL || w->owner != h) ? NULL : g_list_find (h->widgets, w);
1003 }
1004
1005 /* --------------------------------------------------------------------------------------------- */
1006 /** Find the widget with the given id */
1007
1008 Widget *
1009 dlg_find_by_id (const WDialog * h, unsigned long id)
1010 {
1011     GList *w;
1012
1013     w = g_list_find_custom (h->widgets, GUINT_TO_POINTER (id), dlg_find_widget_by_id);
1014     return w != NULL ? WIDGET (w->data) : NULL;
1015 }
1016
1017 /* --------------------------------------------------------------------------------------------- */
1018 /** Find the widget with the given id in the dialog h and select it */
1019
1020 void
1021 dlg_select_by_id (const WDialog * h, unsigned long id)
1022 {
1023     Widget *w;
1024
1025     w = dlg_find_by_id (h, id);
1026     if (w != NULL)
1027         widget_select (w);
1028 }
1029
1030 /* --------------------------------------------------------------------------------------------- */
1031 /** Try to select previous widget in the tab order */
1032
1033 void
1034 dlg_select_prev_widget (WDialog * h)
1035 {
1036     dlg_select_next_or_prev (h, FALSE);
1037 }
1038
1039 /* --------------------------------------------------------------------------------------------- */
1040 /** Try to select next widget in the tab order */
1041
1042 void
1043 dlg_select_next_widget (WDialog * h)
1044 {
1045     dlg_select_next_or_prev (h, TRUE);
1046 }
1047
1048 /* --------------------------------------------------------------------------------------------- */
1049
1050 void
1051 update_cursor (WDialog * h)
1052 {
1053     GList *p = h->current;
1054
1055     if (p != NULL && widget_get_state (WIDGET (h), WST_ACTIVE))
1056     {
1057         Widget *w = WIDGET (p->data);
1058
1059         if (!widget_get_state (w, WST_DISABLED) && widget_get_options (w, WOP_WANT_CURSOR))
1060             send_message (w, NULL, MSG_CURSOR, 0, NULL);
1061         else
1062             do
1063             {
1064                 p = dlg_get_widget_next_of (p);
1065                 if (p == h->current)
1066                     break;
1067
1068                 w = WIDGET (p->data);
1069
1070                 if (!widget_get_state (w, WST_DISABLED) && widget_get_options (w, WOP_WANT_CURSOR)
1071                     && send_message (w, NULL, MSG_CURSOR, 0, NULL) == MSG_HANDLED)
1072                     break;
1073             }
1074             while (TRUE);
1075     }
1076 }
1077
1078 /* --------------------------------------------------------------------------------------------- */
1079 /**
1080  * Redraw the widgets in reverse order, leaving the current widget
1081  * as the last one
1082  */
1083
1084 void
1085 dlg_redraw (WDialog * h)
1086 {
1087     if (!widget_get_state (WIDGET (h), WST_ACTIVE))
1088         return;
1089
1090     if (h->winch_pending)
1091     {
1092         h->winch_pending = FALSE;
1093         send_message (h, NULL, MSG_RESIZE, 0, NULL);
1094     }
1095
1096     send_message (h, NULL, MSG_DRAW, 0, NULL);
1097     dlg_broadcast_msg (h, MSG_DRAW);
1098     update_cursor (h);
1099 }
1100
1101 /* --------------------------------------------------------------------------------------------- */
1102
1103 void
1104 dlg_stop (WDialog * h)
1105 {
1106     widget_set_state (WIDGET (h), WST_CLOSED, TRUE);
1107 }
1108
1109 /* --------------------------------------------------------------------------------------------- */
1110 /** Init the process */
1111
1112 void
1113 dlg_init (WDialog * h)
1114 {
1115     Widget *wh = WIDGET (h);
1116
1117     if (top_dlg != NULL && widget_get_state (WIDGET (top_dlg->data), WST_MODAL))
1118         widget_set_state (wh, WST_MODAL, TRUE);
1119
1120     /* add dialog to the stack */
1121     top_dlg = g_list_prepend (top_dlg, h);
1122
1123     /* Initialize dialog manager and widgets */
1124     if (widget_get_state (wh, WST_CONSTRUCT))
1125     {
1126         if (!widget_get_state (wh, WST_MODAL))
1127             dialog_switch_add (h);
1128
1129         send_message (h, NULL, MSG_INIT, 0, NULL);
1130         dlg_broadcast_msg (h, MSG_INIT);
1131         dlg_read_history (h);
1132     }
1133
1134     /* Select the first widget that takes focus */
1135     while (h->current != NULL && !widget_get_options (WIDGET (h->current->data), WOP_SELECTABLE)
1136            && !widget_get_state (WIDGET (h->current->data), WST_DISABLED))
1137         dlg_set_current_widget_next (h);
1138
1139     widget_set_state (wh, WST_ACTIVE, TRUE);
1140     dlg_redraw (h);
1141     /* focus found widget */
1142     if (h->current != NULL)
1143         widget_set_state (WIDGET (h->current->data), WST_FOCUSED, TRUE);
1144
1145     h->ret_value = 0;
1146 }
1147
1148 /* --------------------------------------------------------------------------------------------- */
1149
1150 void
1151 dlg_process_event (WDialog * h, int key, Gpm_Event * event)
1152 {
1153     if (key == EV_NONE)
1154     {
1155         if (tty_got_interrupt ())
1156             if (send_message (h, NULL, MSG_ACTION, CK_Cancel, NULL) != MSG_HANDLED)
1157                 dlg_execute_cmd (h, CK_Cancel);
1158     }
1159     else if (key == EV_MOUSE)
1160         h->mouse_status = dlg_mouse_event (h, event);
1161     else
1162         dlg_key_event (h, key);
1163 }
1164
1165 /* --------------------------------------------------------------------------------------------- */
1166 /** Shutdown the dlg_run */
1167
1168 void
1169 dlg_run_done (WDialog * h)
1170 {
1171     top_dlg = g_list_remove (top_dlg, h);
1172
1173     if (widget_get_state (WIDGET (h), WST_CLOSED))
1174     {
1175         send_message (h, h->current == NULL ? NULL : WIDGET (h->current->data), MSG_END, 0, NULL);
1176         if (!widget_get_state (WIDGET (h), WST_MODAL))
1177             dialog_switch_remove (h);
1178     }
1179 }
1180
1181 /* --------------------------------------------------------------------------------------------- */
1182 /**
1183  * Standard run dialog routine
1184  * We have to keep this routine small so that we can duplicate it's
1185  * behavior on complex routines like the file routines, this way,
1186  * they can call the dlg_process_event without rewriting all the code
1187  */
1188
1189 int
1190 dlg_run (WDialog * h)
1191 {
1192     dlg_init (h);
1193     frontend_dlg_run (h);
1194     dlg_run_done (h);
1195     return h->ret_value;
1196 }
1197
1198 /* --------------------------------------------------------------------------------------------- */
1199
1200 void
1201 dlg_destroy (WDialog * h)
1202 {
1203     /* if some widgets have history, save all history at one moment here */
1204     dlg_save_history (h);
1205     dlg_broadcast_msg (h, MSG_DESTROY);
1206     g_list_free_full (h->widgets, g_free);
1207     mc_event_group_del (h->event_group);
1208     g_free (h->event_group);
1209     g_free (h->title);
1210     g_free (h);
1211
1212     do_refresh ();
1213 }
1214
1215 /* --------------------------------------------------------------------------------------------- */
1216
1217 /**
1218   * Write history to the ${XDG_CACHE_HOME}/mc/history file
1219   */
1220 void
1221 dlg_save_history (WDialog * h)
1222 {
1223     char *profile;
1224     int i;
1225
1226     if (num_history_items_recorded == 0)        /* this is how to disable */
1227         return;
1228
1229     profile = mc_config_get_full_path (MC_HISTORY_FILE);
1230     i = open (profile, O_CREAT | O_EXCL, S_IRUSR | S_IWUSR);
1231     if (i != -1)
1232         close (i);
1233
1234     /* Make sure the history is only readable by the user */
1235     if (chmod (profile, S_IRUSR | S_IWUSR) != -1 || errno == ENOENT)
1236     {
1237         ev_history_load_save_t event_data;
1238
1239         event_data.cfg = mc_config_init (profile, FALSE);
1240         event_data.receiver = NULL;
1241
1242         /* get all histories in dialog */
1243         mc_event_raise (h->event_group, MCEVENT_HISTORY_SAVE, &event_data);
1244
1245         mc_config_save_file (event_data.cfg, NULL);
1246         mc_config_deinit (event_data.cfg);
1247     }
1248
1249     g_free (profile);
1250 }
1251
1252 /* --------------------------------------------------------------------------------------------- */
1253
1254 void
1255 dlg_set_title (WDialog * h, const char *title)
1256 {
1257     MC_PTR_FREE (h->title);
1258
1259     /* Strip existing spaces, add one space before and after the title */
1260     if (title != NULL && title[0] != '\0')
1261     {
1262         char *t;
1263
1264         t = g_strstrip (g_strdup (title));
1265         if (t[0] != '\0')
1266             h->title = g_strdup_printf (" %s ", t);
1267         g_free (t);
1268     }
1269 }
1270
1271 /* --------------------------------------------------------------------------------------------- */
1272
1273 char *
1274 dlg_get_title (const WDialog * h, size_t len)
1275 {
1276     char *t;
1277
1278     if (h == NULL)
1279         abort ();
1280
1281     if (h->get_title != NULL)
1282         t = h->get_title (h, len);
1283     else
1284         t = g_strdup ("");
1285
1286     return t;
1287 }
1288
1289 /* --------------------------------------------------------------------------------------------- */
1290
1291 /**
1292  * Switch current widget to widget after current in dialog.
1293  *
1294  * @param h WDialog widget
1295  */
1296
1297 void
1298 dlg_set_current_widget_next (WDialog * h)
1299 {
1300     h->current = dlg_get_next_or_prev_of (h->current, TRUE);
1301 }
1302
1303 /* --------------------------------------------------------------------------------------------- */
1304
1305 /**
1306  * Switch current widget to widget before current in dialog.
1307  *
1308  * @param h WDialog widget
1309  */
1310
1311 void
1312 dlg_set_current_widget_prev (WDialog * h)
1313 {
1314     h->current = dlg_get_next_or_prev_of (h->current, FALSE);
1315 }
1316
1317 /* --------------------------------------------------------------------------------------------- */
1318
1319 /**
1320  * Get widget that is after specified widget in dialog.
1321  *
1322  * @param w widget holder
1323  *
1324  * @return widget that is after "w" or NULL if "w" is NULL or widget doesn't have owner
1325  */
1326
1327 GList *
1328 dlg_get_widget_next_of (GList * w)
1329 {
1330     return dlg_get_next_or_prev_of (w, TRUE);
1331 }
1332
1333 /* --------------------------------------------------------------------------------------------- */
1334
1335 /**
1336  * Get widget that is before specified widget in dialog.
1337  *
1338  * @param w widget holder
1339  *
1340  * @return widget that is before "w" or NULL if "w" is NULL or widget doesn't have owner
1341  */
1342
1343 GList *
1344 dlg_get_widget_prev_of (GList * w)
1345 {
1346     return dlg_get_next_or_prev_of (w, FALSE);
1347 }
1348
1349 /* --------------------------------------------------------------------------------------------- */