lib/widget/dialog.c

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