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