lib/widget/dialog.c

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