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, 2013
   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 (widget_overlapped (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 *p, *first;
 365
 366     /* close the dialog by mouse left click out of dialog area */
 367     if (mouse_close_dialog && !h->fullscreen && ((event->buttons & GPM_B_LEFT) != 0)
 368         && ((event->type & GPM_DOWN) != 0) && !mouse_global_in_widget (event, wh))
 369     {
 370         h->ret_value = B_CANCEL;
 371         dlg_stop (h);
 372         return MOU_NORMAL;
 373     }
 374
 375     if (wh->mouse != NULL)
 376     {
 377         int mou;
 378
 379         mou = wh->mouse (event, wh);
 380         if (mou != MOU_UNHANDLED)
 381             return mou;
 382     }
 383
 384     first = h->current;
 385     p = first;
 386
 387     do
 388     {
 389         Widget *w = WIDGET (p->data);
 390
 391         p = dlg_widget_prev (h, p);
 392
 393         if ((w->options & W_DISABLED) == 0 && w->mouse != NULL)
 394         {
 395             /* put global cursor position to the widget */
 396             int ret;
 397
 398             ret = w->mouse (event, w);
 399             if (ret != MOU_UNHANDLED)
 400                 return ret;
 401         }
 402     }
 403     while (p != first);
 404
 405     return MOU_UNHANDLED;
 406 }
 407
 408 /* --------------------------------------------------------------------------------------------- */
 409
 410 static cb_ret_t
 411 dlg_try_hotkey (WDialog * h, int d_key)
 412 {
 413     GList *hot_cur;
 414     Widget *current;
 415     cb_ret_t handled;
 416     int c;
 417
 418     if (h->widgets == NULL)
 419         return MSG_NOT_HANDLED;
 420
 421     if (h->current == NULL)
 422         h->current = h->widgets;
 423
 424     /*
 425      * Explanation: we don't send letter hotkeys to other widgets if
 426      * the currently selected widget is an input line
 427      */
 428
 429     current = WIDGET (h->current->data);
 430
 431     if ((current->options & W_DISABLED) != 0)
 432         return MSG_NOT_HANDLED;
 433
 434     if (current->options & W_IS_INPUT)
 435     {
 436         /* skip ascii control characters, anything else can valid character in
 437          * some encoding */
 438         if (d_key >= 32 && d_key < 256)
 439             return MSG_NOT_HANDLED;
 440     }
 441
 442     /* If it's an alt key, send the message */
 443     c = d_key & ~ALT (0);
 444     if (d_key & ALT (0) && g_ascii_isalpha (c))
 445         d_key = g_ascii_tolower (c);
 446
 447     handled = MSG_NOT_HANDLED;
 448     if ((current->options & W_WANT_HOTKEY) != 0)
 449         handled = send_message (current, NULL, MSG_HOTKEY, d_key, NULL);
 450
 451     /* If not used, send hotkey to other widgets */
 452     if (handled == MSG_HANDLED)
 453         return MSG_HANDLED;
 454
 455     hot_cur = dlg_widget_next (h, h->current);
 456
 457     /* send it to all widgets */
 458     while (h->current != hot_cur && handled == MSG_NOT_HANDLED)
 459     {
 460         current = WIDGET (hot_cur->data);
 461
 462         if ((current->options & W_WANT_HOTKEY) != 0 && (current->options & W_DISABLED) == 0)
 463             handled = send_message (current, NULL, MSG_HOTKEY, d_key, NULL);
 464
 465         if (handled == MSG_NOT_HANDLED)
 466             hot_cur = dlg_widget_next (h, hot_cur);
 467     }
 468
 469     if (handled == MSG_HANDLED)
 470         do_select_widget (h, hot_cur, SELECT_EXACT);
 471
 472     return handled;
 473 }
 474
 475 /* --------------------------------------------------------------------------------------------- */
 476
 477 static void
 478 dlg_key_event (WDialog * h, int d_key)
 479 {
 480     cb_ret_t handled;
 481
 482     if (h->widgets == NULL)
 483         return;
 484
 485     if (h->current == NULL)
 486         h->current = h->widgets;
 487
 488     /* TAB used to cycle */
 489     if ((h->flags & DLG_WANT_TAB) == 0)
 490     {
 491         if (d_key == '\t')
 492         {
 493             dlg_one_down (h);
 494             return;
 495         }
 496         else if ((d_key & ~(KEY_M_SHIFT | KEY_M_CTRL)) == '\t')
 497         {
 498             dlg_one_up (h);
 499             return;
 500         }
 501     }
 502
 503     /* first can dlg_callback handle the key */
 504     handled = send_message (h, NULL, MSG_KEY, d_key, NULL);
 505
 506     /* next try the hotkey */
 507     if (handled == MSG_NOT_HANDLED)
 508         handled = dlg_try_hotkey (h, d_key);
 509
 510     if (handled == MSG_HANDLED)
 511         send_message (h, NULL, MSG_HOTKEY_HANDLED, 0, NULL);
 512     else
 513         /* not used - then try widget_callback */
 514         handled = send_message (h->current->data, NULL, MSG_KEY, d_key, NULL);
 515
 516     /* not used- try to use the unhandled case */
 517     if (handled == MSG_NOT_HANDLED)
 518         handled = send_message (h, NULL, MSG_UNHANDLED_KEY, d_key, NULL);
 519
 520     if (handled == MSG_NOT_HANDLED)
 521         handled = dlg_handle_key (h, d_key);
 522
 523     send_message (h, NULL, MSG_POST_KEY, d_key, NULL);
 524 }
 525
 526 /* --------------------------------------------------------------------------------------------- */
 527
 528 static void
 529 frontend_dlg_run (WDialog * h)
 530 {
 531     Gpm_Event event;
 532
 533     event.x = -1;
 534
 535     /* close opened editors, viewers, etc */
 536     if (!h->modal && mc_global.midnight_shutdown)
 537     {
 538         send_message (h, NULL, MSG_VALIDATE, 0, NULL);
 539         return;
 540     }
 541
 542     while (h->state == DLG_ACTIVE)
 543     {
 544         int d_key;
 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 /** Clean the dialog area, draw the frame and the title */
 591 void
 592 dlg_default_repaint (WDialog * h)
 593 {
 594     Widget *wh = WIDGET (h);
 595
 596     int space;
 597
 598     if (h->state != DLG_ACTIVE)
 599         return;
 600
 601     space = (h->flags & DLG_COMPACT) ? 0 : 1;
 602
 603     tty_setcolor (h->color[DLG_COLOR_NORMAL]);
 604     dlg_erase (h);
 605     tty_draw_box (wh->y + space, wh->x + space, wh->lines - 2 * space, wh->cols - 2 * space, FALSE);
 606
 607     if (h->title != NULL)
 608     {
 609         tty_setcolor (h->color[DLG_COLOR_TITLE]);
 610         widget_move (h, space, (wh->cols - str_term_width1 (h->title)) / 2);
 611         tty_print_string (h->title);
 612     }
 613 }
 614
 615 /* --------------------------------------------------------------------------------------------- */
 616 /** this function allows to set dialog position */
 617
 618 void
 619 dlg_set_position (WDialog * h, int y1, int x1, int y2, int x2)
 620 {
 621     Widget *wh = WIDGET (h);
 622
 623     /* save old positions, will be used to reposition childs */
 624     int ox, oy, oc, ol;
 625     int shift_x, shift_y, scale_x, scale_y;
 626
 627     /* save old positions, will be used to reposition childs */
 628     ox = wh->x;
 629     oy = wh->y;
 630     oc = wh->cols;
 631     ol = wh->lines;
 632
 633     wh->x = x1;
 634     wh->y = y1;
 635     wh->lines = y2 - y1;
 636     wh->cols = x2 - x1;
 637
 638     /* dialog is empty */
 639     if (h->widgets == NULL)
 640         return;
 641
 642     if (h->current == NULL)
 643         h->current = h->widgets;
 644
 645     /* values by which controls should be moved */
 646     shift_x = wh->x - ox;
 647     shift_y = wh->y - oy;
 648     scale_x = wh->cols - oc;
 649     scale_y = wh->lines - ol;
 650
 651     if ((shift_x != 0) || (shift_y != 0) || (scale_x != 0) || (scale_y != 0))
 652     {
 653         GList *w;
 654
 655         for (w = h->widgets; w != NULL; w = g_list_next (w))
 656         {
 657             /* there are, mainly, 2 generally possible
 658                situations:
 659
 660                1. control sticks to one side - it
 661                should be moved
 662
 663                2. control sticks to two sides of
 664                one direction - it should be sized */
 665
 666             Widget *c = WIDGET (w->data);
 667             int x = c->x;
 668             int y = c->y;
 669             int cols = c->cols;
 670             int lines = c->lines;
 671
 672             if ((c->pos_flags & WPOS_CENTER_HORZ) != 0)
 673                 x = wh->x + (wh->cols - c->cols) / 2;
 674             else if ((c->pos_flags & WPOS_KEEP_LEFT) != 0 && (c->pos_flags & WPOS_KEEP_RIGHT) != 0)
 675             {
 676                 x += shift_x;
 677                 cols += scale_x;
 678             }
 679             else if ((c->pos_flags & WPOS_KEEP_LEFT) != 0)
 680                 x += shift_x;
 681             else if ((c->pos_flags & WPOS_KEEP_RIGHT) != 0)
 682                 x += shift_x + scale_x;
 683
 684             if ((c->pos_flags & WPOS_CENTER_VERT) != 0)
 685                 y = wh->y + (wh->lines - c->lines) / 2;
 686             else if ((c->pos_flags & WPOS_KEEP_TOP) != 0 && (c->pos_flags & WPOS_KEEP_BOTTOM) != 0)
 687             {
 688                 y += shift_y;
 689                 lines += scale_y;
 690             }
 691             else if ((c->pos_flags & WPOS_KEEP_TOP) != 0)
 692                 y += shift_y;
 693             else if ((c->pos_flags & WPOS_KEEP_BOTTOM) != 0)
 694                 y += shift_y + scale_y;
 695
 696             widget_set_size (c, y, x, lines, cols);
 697         }
 698     }
 699 }
 700
 701 /* --------------------------------------------------------------------------------------------- */
 702 /** this function sets only size, leaving positioning to automatic methods */
 703
 704 void
 705 dlg_set_size (WDialog * h, int lines, int cols)
 706 {
 707     int x = WIDGET (h)->x;
 708     int y = WIDGET (h)->y;
 709
 710     if (h->flags & DLG_CENTER)
 711     {
 712         y = (LINES - lines) / 2;
 713         x = (COLS - cols) / 2;
 714     }
 715
 716     if ((h->flags & DLG_TRYUP) && (y > 3))
 717         y -= 2;
 718
 719     dlg_set_position (h, y, x, y + lines, x + cols);
 720 }
 721
 722 /* --------------------------------------------------------------------------------------------- */
 723 /** Default dialog callback */
 724
 725 cb_ret_t
 726 dlg_default_callback (Widget * w, Widget * sender, widget_msg_t msg, int parm, void *data)
 727 {
 728     WDialog *h = DIALOG (w);
 729
 730     (void) sender;
 731     (void) parm;
 732     (void) data;
 733
 734     switch (msg)
 735     {
 736     case MSG_DRAW:
 737         if (h->color != NULL)
 738         {
 739             dlg_default_repaint (h);
 740             return MSG_HANDLED;
 741         }
 742         return MSG_NOT_HANDLED;
 743
 744     case MSG_IDLE:
 745         dlg_broadcast_msg_to (h, MSG_IDLE, FALSE, W_WANT_IDLE);
 746         return MSG_HANDLED;
 747
 748     case MSG_RESIZE:
 749         /* this is default resizing mechanism */
 750         /* the main idea of this code is to resize dialog
 751            according to flags (if any of flags require automatic
 752            resizing, like DLG_CENTER, end after that reposition
 753            controls in dialog according to flags of widget) */
 754         dlg_set_size (h, w->lines, w->cols);
 755         return MSG_HANDLED;
 756
 757     default:
 758         break;
 759     }
 760
 761     return MSG_NOT_HANDLED;
 762 }
 763
 764 /* --------------------------------------------------------------------------------------------- */
 765
 766 WDialog *
 767 dlg_create (gboolean modal, int y1, int x1, int lines, int cols,
 768             const int *colors, widget_cb_fn callback, mouse_h mouse_handler,
 769             const char *help_ctx, const char *title, dlg_flags_t flags)
 770 {
 771     WDialog *new_d;
 772     Widget *w;
 773
 774     new_d = g_new0 (WDialog, 1);
 775     w = WIDGET (new_d);
 776     widget_init (w, y1, x1, lines, cols, (callback != NULL) ? callback : dlg_default_callback,
 777                  mouse_handler);
 778     widget_want_cursor (w, FALSE);
 779
 780     new_d->state = DLG_CONSTRUCT;
 781     new_d->modal = modal;
 782     if (colors != NULL)
 783         memmove (new_d->color, colors, sizeof (dlg_colors_t));
 784     new_d->help_ctx = help_ctx;
 785     new_d->flags = flags;
 786     new_d->data = NULL;
 787
 788     dlg_set_size (new_d, lines, cols);
 789     new_d->fullscreen = (w->x == 0 && w->y == 0 && w->cols == COLS && w->lines == LINES);
 790
 791     new_d->mouse_status = MOU_UNHANDLED;
 792
 793     /* Strip existing spaces, add one space before and after the title */
 794     if (title != NULL && *title != '\0')
 795     {
 796         char *t;
 797
 798         t = g_strstrip (g_strdup (title));
 799         if (*t != '\0')
 800             new_d->title = g_strdup_printf (" %s ", t);
 801         g_free (t);
 802     }
 803
 804     /* unique name of event group for this dialog */
 805     new_d->event_group = g_strdup_printf ("%s_%p", MCEVENT_GROUP_DIALOG, (void *) new_d);
 806
 807     return new_d;
 808 }
 809
 810 /* --------------------------------------------------------------------------------------------- */
 811
 812 void
 813 dlg_set_default_colors (void)
 814 {
 815     dialog_colors[DLG_COLOR_NORMAL] = COLOR_NORMAL;
 816     dialog_colors[DLG_COLOR_FOCUS] = COLOR_FOCUS;
 817     dialog_colors[DLG_COLOR_HOT_NORMAL] = COLOR_HOT_NORMAL;
 818     dialog_colors[DLG_COLOR_HOT_FOCUS] = COLOR_HOT_FOCUS;
 819     dialog_colors[DLG_COLOR_TITLE] = COLOR_TITLE;
 820
 821     alarm_colors[DLG_COLOR_NORMAL] = ERROR_COLOR;
 822     alarm_colors[DLG_COLOR_FOCUS] = ERROR_FOCUS;
 823     alarm_colors[DLG_COLOR_HOT_NORMAL] = ERROR_HOT_NORMAL;
 824     alarm_colors[DLG_COLOR_HOT_FOCUS] = ERROR_HOT_FOCUS;
 825     alarm_colors[DLG_COLOR_TITLE] = ERROR_TITLE;
 826 }
 827
 828 /* --------------------------------------------------------------------------------------------- */
 829
 830 void
 831 dlg_erase (WDialog * h)
 832 {
 833     if ((h != NULL) && (h->state == DLG_ACTIVE))
 834     {
 835         Widget *wh = WIDGET (h);
 836
 837         tty_fill_region (wh->y, wh->x, wh->lines, wh->cols, ' ');
 838     }
 839 }
 840
 841 /* --------------------------------------------------------------------------------------------- */
 842 /**
 843  * Insert widget to dialog before requested widget. Make the widget current. Return widget ID.
 844  */
 845
 846 unsigned long
 847 add_widget_autopos (WDialog * h, void *w, widget_pos_flags_t pos_flags, const void *before)
 848 {
 849     Widget *wh = WIDGET (h);
 850     Widget *widget;
 851
 852     /* Don't accept 0 widgets */
 853     if (w == NULL)
 854         abort ();
 855
 856     widget = WIDGET (w);
 857
 858     if ((pos_flags & WPOS_CENTER_HORZ) != 0)
 859         widget->x = (wh->cols - widget->cols) / 2;
 860     widget->x += wh->x;
 861
 862     if ((pos_flags & WPOS_CENTER_VERT) != 0)
 863         widget->y = (wh->lines - widget->lines) / 2;
 864     widget->y += wh->y;
 865
 866     widget->owner = h;
 867     widget->pos_flags = pos_flags;
 868     widget->id = h->widget_id++;
 869
 870     if (h->widgets == NULL || before == NULL)
 871     {
 872         h->widgets = g_list_append (h->widgets, widget);
 873         h->current = g_list_last (h->widgets);
 874     }
 875     else
 876     {
 877         GList *b;
 878
 879         b = g_list_find (h->widgets, before);
 880
 881         /* don't accept widget not from dialog. This shouldn't happen */
 882         if (b == NULL)
 883             abort ();
 884
 885         b = g_list_next (b);
 886         h->widgets = g_list_insert_before (h->widgets, b, widget);
 887         if (b != NULL)
 888             h->current = g_list_previous (b);
 889         else
 890             h->current = g_list_last (h->widgets);
 891     }
 892
 893     /* widget has been added in runtime */
 894     if (h->state == DLG_ACTIVE)
 895     {
 896         send_message (widget, NULL, MSG_INIT, 0, NULL);
 897         send_message (widget, NULL, MSG_DRAW, 0, NULL);
 898         send_message (widget, NULL, MSG_FOCUS, 0, NULL);
 899     }
 900
 901     return widget->id;
 902 }
 903
 904 /* --------------------------------------------------------------------------------------------- */
 905 /** wrapper to simply add lefttop positioned controls */
 906
 907 unsigned long
 908 add_widget (WDialog * h, void *w)
 909 {
 910     return add_widget_autopos (h, w, WPOS_KEEP_DEFAULT,
 911                                h->current != NULL ? h->current->data : NULL);
 912 }
 913
 914 /* --------------------------------------------------------------------------------------------- */
 915
 916 unsigned long
 917 add_widget_before (WDialog * h, void *w, void *before)
 918 {
 919     return add_widget_autopos (h, w, WPOS_KEEP_DEFAULT, before);
 920 }
 921
 922 /* --------------------------------------------------------------------------------------------- */
 923
 924 /** delete widget from dialog */
 925 void
 926 del_widget (void *w)
 927 {
 928     WDialog *h;
 929     GList *d;
 930
 931     /* Don't accept NULL widget. This shouldn't happen */
 932     if (w == NULL)
 933         abort ();
 934
 935     h = WIDGET (w)->owner;
 936
 937     d = g_list_find (h->widgets, w);
 938     if (d == h->current)
 939         h->current = dlg_widget_next (h, d);
 940
 941     h->widgets = g_list_remove_link (h->widgets, d);
 942     send_message (d->data, NULL, MSG_DESTROY, 0, NULL);
 943     g_free (d->data);
 944     g_list_free_1 (d);
 945
 946     /* widget has been deleted in runtime */
 947     if (h->state == DLG_ACTIVE)
 948     {
 949         dlg_redraw (h);
 950         dlg_focus (h);
 951     }
 952 }
 953
 954 /* --------------------------------------------------------------------------------------------- */
 955
 956 void
 957 do_refresh (void)
 958 {
 959     GList *d = top_dlg;
 960
 961     if (fast_refresh)
 962     {
 963         if ((d != NULL) && (d->data != NULL))
 964             dlg_redraw (DIALOG (d->data));
 965     }
 966     else
 967     {
 968         /* Search first fullscreen dialog */
 969         for (; d != NULL; d = g_list_next (d))
 970             if (d->data != NULL && DIALOG (d->data)->fullscreen)
 971                 break;
 972         /* back to top dialog */
 973         for (; d != NULL; d = g_list_previous (d))
 974             if (d->data != NULL)
 975                 dlg_redraw (DIALOG (d->data));
 976     }
 977 }
 978
 979 /* --------------------------------------------------------------------------------------------- */
 980 /** broadcast a message to all the widgets in a dialog */
 981
 982 void
 983 dlg_broadcast_msg (WDialog * h, widget_msg_t msg)
 984 {
 985     dlg_broadcast_msg_to (h, msg, FALSE, 0);
 986 }
 987
 988 /* --------------------------------------------------------------------------------------------- */
 989
 990 gboolean
 991 dlg_focus (WDialog * h)
 992 {
 993     /* cannot focus disabled widget */
 994     if ((h->current != NULL) && (h->state == DLG_CONSTRUCT || h->state == DLG_ACTIVE))
 995     {
 996         Widget *current = WIDGET (h->current->data);
 997
 998         if (((current->options & W_DISABLED) == 0)
 999             && (send_message (current, NULL, MSG_FOCUS, 0, NULL) == MSG_HANDLED))
1000         {
1001             send_message (h, current, MSG_FOCUS, 0, NULL);
1002             return TRUE;
1003         }
1004     }
1005
1006     return FALSE;
1007 }
1008
1009 /* --------------------------------------------------------------------------------------------- */
1010 /** Find the widget with the given callback in the dialog h */
1011
1012 Widget *
1013 find_widget_type (const WDialog * h, widget_cb_fn callback)
1014 {
1015     GList *w;
1016
1017     w = g_list_find_custom (h->widgets, callback, dlg_find_widget_callback);
1018
1019     return (w == NULL) ? NULL : WIDGET (w->data);
1020 }
1021
1022 /* --------------------------------------------------------------------------------------------- */
1023 /** Find the widget with the given id */
1024
1025 Widget *
1026 dlg_find_by_id (const WDialog * h, unsigned long id)
1027 {
1028     GList *w;
1029
1030     w = g_list_find_custom (h->widgets, GUINT_TO_POINTER (id), dlg_find_widget_by_id);
1031     return w != NULL ? WIDGET (w->data) : NULL;
1032 }
1033
1034 /* --------------------------------------------------------------------------------------------- */
1035 /** Find the widget with the given id in the dialog h and select it */
1036
1037 void
1038 dlg_select_by_id (const WDialog * h, unsigned long id)
1039 {
1040     Widget *w;
1041
1042     w = dlg_find_by_id (h, id);
1043     if (w != NULL)
1044         dlg_select_widget (w);
1045 }
1046
1047 /* --------------------------------------------------------------------------------------------- */
1048 /**
1049  * Try to select widget in the dialog.
1050  */
1051
1052 void
1053 dlg_select_widget (void *w)
1054 {
1055     Widget *widget = WIDGET (w);
1056     WDialog *h = widget->owner;
1057
1058     do_select_widget (h, g_list_find (h->widgets, widget), SELECT_EXACT);
1059 }
1060
1061 /* --------------------------------------------------------------------------------------------- */
1062
1063 /**
1064  * Set widget at top of widget list and make it current.
1065  */
1066
1067 void
1068 dlg_set_top_widget (void *w)
1069 {
1070     Widget *widget = WIDGET (w);
1071     WDialog *h = widget->owner;
1072     GList *l;
1073
1074     l = g_list_find (h->widgets, w);
1075     if (l == NULL)
1076         abort ();               /* widget is not in dialog, this should not happen */
1077
1078     /* unfocus prevoius widget and focus current one before widget reordering */
1079     if (h->state == DLG_ACTIVE)
1080         do_select_widget (h, l, SELECT_EXACT);
1081
1082     /* widget reordering */
1083     h->widgets = g_list_remove_link (h->widgets, l);
1084     h->widgets = g_list_concat (h->widgets, l);
1085     h->current = l;
1086 }
1087
1088 /* --------------------------------------------------------------------------------------------- */
1089 /** Try to select previous widget in the tab order */
1090
1091 void
1092 dlg_one_up (WDialog * h)
1093 {
1094     if (h->widgets != NULL)
1095         do_select_widget (h, dlg_widget_prev (h, h->current), SELECT_PREV);
1096 }
1097
1098 /* --------------------------------------------------------------------------------------------- */
1099 /** Try to select next widget in the tab order */
1100
1101 void
1102 dlg_one_down (WDialog * h)
1103 {
1104     if (h->widgets != NULL)
1105         do_select_widget (h, dlg_widget_next (h, h->current), SELECT_NEXT);
1106 }
1107
1108 /* --------------------------------------------------------------------------------------------- */
1109
1110 void
1111 update_cursor (WDialog * h)
1112 {
1113     GList *p = h->current;
1114
1115     if ((p != NULL) && (h->state == DLG_ACTIVE))
1116     {
1117         Widget *w;
1118
1119         w = WIDGET (p->data);
1120
1121         if (((w->options & W_DISABLED) == 0) && ((w->options & W_WANT_CURSOR) != 0))
1122             send_message (w, NULL, MSG_CURSOR, 0, NULL);
1123         else
1124             do
1125             {
1126                 p = dlg_widget_next (h, p);
1127                 if (p == h->current)
1128                     break;
1129
1130                 w = WIDGET (p->data);
1131
1132                 if (((w->options & W_DISABLED) == 0) && ((w->options & W_WANT_CURSOR) != 0))
1133                     if (send_message (w, NULL, MSG_CURSOR, 0, NULL) == MSG_HANDLED)
1134                         break;
1135             }
1136             while (TRUE);
1137     }
1138 }
1139
1140 /* --------------------------------------------------------------------------------------------- */
1141 /**
1142  * Redraw the widgets in reverse order, leaving the current widget
1143  * as the last one
1144  */
1145
1146 void
1147 dlg_redraw (WDialog * h)
1148 {
1149     if (h->state != DLG_ACTIVE)
1150         return;
1151
1152     if (h->winch_pending)
1153     {
1154         h->winch_pending = FALSE;
1155         send_message (h, NULL, MSG_RESIZE, 0, NULL);
1156     }
1157
1158     send_message (h, NULL, MSG_DRAW, 0, NULL);
1159     dlg_broadcast_msg (h, MSG_DRAW);
1160     update_cursor (h);
1161 }
1162
1163 /* --------------------------------------------------------------------------------------------- */
1164
1165 void
1166 dlg_stop (WDialog * h)
1167 {
1168     h->state = DLG_CLOSED;
1169 }
1170
1171 /* --------------------------------------------------------------------------------------------- */
1172 /** Init the process */
1173
1174 void
1175 dlg_init (WDialog * h)
1176 {
1177     if (top_dlg != NULL && DIALOG (top_dlg->data)->modal)
1178         h->modal = TRUE;
1179
1180     /* add dialog to the stack */
1181     top_dlg = g_list_prepend (top_dlg, h);
1182
1183     /* Initialize dialog manager and widgets */
1184     if (h->state == DLG_CONSTRUCT)
1185     {
1186         if (!h->modal)
1187             dialog_switch_add (h);
1188
1189         send_message (h, NULL, MSG_INIT, 0, NULL);
1190         dlg_broadcast_msg (h, MSG_INIT);
1191         dlg_read_history (h);
1192     }
1193
1194     h->state = DLG_ACTIVE;
1195
1196     /* first send MSG_DRAW to dialog itself and all widgets... */
1197     dlg_redraw (h);
1198
1199     /* ...then send MSG_FOCUS to select the first widget that can take focus */
1200     while (h->current != NULL && !dlg_focus (h))
1201         h->current = dlg_widget_next (h, h->current);
1202
1203
1204     h->ret_value = 0;
1205 }
1206
1207 /* --------------------------------------------------------------------------------------------- */
1208
1209 void
1210 dlg_process_event (WDialog * h, int key, Gpm_Event * event)
1211 {
1212     if (key == EV_NONE)
1213     {
1214         if (tty_got_interrupt ())
1215             if (send_message (h, NULL, MSG_ACTION, CK_Cancel, NULL) != MSG_HANDLED)
1216                 dlg_execute_cmd (h, CK_Cancel);
1217
1218         return;
1219     }
1220
1221     if (key == EV_MOUSE)
1222         h->mouse_status = dlg_mouse_event (h, event);
1223     else
1224         dlg_key_event (h, key);
1225 }
1226
1227 /* --------------------------------------------------------------------------------------------- */
1228 /** Shutdown the dlg_run */
1229
1230 void
1231 dlg_run_done (WDialog * h)
1232 {
1233     top_dlg = g_list_remove (top_dlg, h);
1234
1235     if (h->state == DLG_CLOSED)
1236     {
1237         send_message (h, h->current->data, MSG_END, 0, NULL);
1238         if (!h->modal)
1239             dialog_switch_remove (h);
1240     }
1241 }
1242
1243 /* --------------------------------------------------------------------------------------------- */
1244 /**
1245  * Standard run dialog routine
1246  * We have to keep this routine small so that we can duplicate it's
1247  * behavior on complex routines like the file routines, this way,
1248  * they can call the dlg_process_event without rewriting all the code
1249  */
1250
1251 int
1252 dlg_run (WDialog * h)
1253 {
1254     dlg_init (h);
1255     frontend_dlg_run (h);
1256     dlg_run_done (h);
1257     return h->ret_value;
1258 }
1259
1260 /* --------------------------------------------------------------------------------------------- */
1261
1262 void
1263 dlg_destroy (WDialog * h)
1264 {
1265     /* if some widgets have history, save all history at one moment here */
1266     dlg_save_history (h);
1267     dlg_broadcast_msg (h, MSG_DESTROY);
1268     g_list_foreach (h->widgets, (GFunc) g_free, NULL);
1269     g_list_free (h->widgets);
1270     mc_event_group_del (h->event_group);
1271     g_free (h->event_group);
1272     g_free (h->title);
1273     g_free (h);
1274
1275     do_refresh ();
1276 }
1277
1278 /* --------------------------------------------------------------------------------------------- */
1279
1280 /**
1281   * Write history to the ${XDG_CACHE_HOME}/mc/history file
1282   */
1283 void
1284 dlg_save_history (WDialog * h)
1285 {
1286     char *profile;
1287     int i;
1288
1289     if (num_history_items_recorded == 0)        /* this is how to disable */
1290         return;
1291
1292     profile = mc_config_get_full_path (MC_HISTORY_FILE);
1293     i = open (profile, O_CREAT | O_EXCL, S_IRUSR | S_IWUSR);
1294     if (i != -1)
1295         close (i);
1296
1297     /* Make sure the history is only readable by the user */
1298     if (chmod (profile, S_IRUSR | S_IWUSR) != -1 || errno == ENOENT)
1299     {
1300         ev_history_load_save_t event_data;
1301
1302         event_data.cfg = mc_config_init (profile, FALSE);
1303         event_data.receiver = NULL;
1304
1305         /* get all histories in dialog */
1306         mc_event_raise (h->event_group, MCEVENT_HISTORY_SAVE, &event_data);
1307
1308         mc_config_save_file (event_data.cfg, NULL);
1309         mc_config_deinit (event_data.cfg);
1310     }
1311
1312     g_free (profile);
1313 }
1314
1315 /* --------------------------------------------------------------------------------------------- */
1316
1317 char *
1318 dlg_get_title (const WDialog * h, size_t len)
1319 {
1320     char *t;
1321
1322     if (h == NULL)
1323         abort ();
1324
1325     if (h->get_title != NULL)
1326         t = h->get_title (h, len);
1327     else
1328         t = g_strdup ("");
1329
1330     return t;
1331 }
1332
1333 /* --------------------------------------------------------------------------------------------- */