lib/widget/wtools.c

   1 /*
   2    Widget based utility functions.
   3
   4    Copyright (C) 1994, 1995, 1998, 1999, 2000, 2001, 2002, 2003, 2004,
   5    2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012
   6    The Free Software Foundation, Inc.
   7
   8    Authors:
   9    Miguel de Icaza, 1994, 1995, 1996
  10    Radek Doulik, 1994, 1995
  11    Jakub Jelinek, 1995
  12    Andrej Borsenkow, 1995
  13    Andrew Borodin <aborodin@vmail.ru>, 2009, 2010, 2012
  14
  15    This file is part of the Midnight Commander.
  16
  17    The Midnight Commander is free software: you can redistribute it
  18    and/or modify it under the terms of the GNU General Public License as
  19    published by the Free Software Foundation, either version 3 of the License,
  20    or (at your option) any later version.
  21
  22    The Midnight Commander is distributed in the hope that it will be useful,
  23    but WITHOUT ANY WARRANTY; without even the implied warranty of
  24    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  25    GNU General Public License for more details.
  26
  27    You should have received a copy of the GNU General Public License
  28    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  29  */
  30
  31 /** \file wtools.c
  32  *  \brief Source: widget based utility functions
  33  */
  34
  35 #include <config.h>
  36
  37 #include <stdarg.h>
  38 #include <stdlib.h>
  39
  40 #include "lib/global.h"
  41 #include "lib/tty/tty.h"
  42 #include "lib/tty/key.h"        /* tty_getch() */
  43 #include "lib/strutil.h"
  44 #include "lib/util.h"           /* tilde_expand() */
  45 #include "lib/widget.h"
  46 #include "lib/event.h"          /* mc_event_raise() */
  47
  48 /*** global variables ****************************************************************************/
  49
  50 /*** file scope macro definitions ****************************************************************/
  51
  52 /*** file scope type declarations ****************************************************************/
  53
  54 /*** file scope variables ************************************************************************/
  55
  56 static WDialog *last_query_dlg;
  57
  58 static int sel_pos = 0;
  59
  60 /*** file scope functions ************************************************************************/
  61 /* --------------------------------------------------------------------------------------------- */
  62
  63 /** default query callback, used to reposition query */
  64
  65 static cb_ret_t
  66 query_default_callback (Widget * w, Widget * sender, widget_msg_t msg, int parm, void *data)
  67 {
  68     WDialog *h = DIALOG (w);
  69
  70     switch (msg)
  71     {
  72     case MSG_RESIZE:
  73         if ((h->flags & DLG_CENTER) == 0)
  74         {
  75             WDialog *prev_dlg = NULL;
  76             int ypos, xpos;
  77
  78             /* get dialog under h */
  79             if (top_dlg != NULL)
  80             {
  81                 if (top_dlg->data != (void *) h)
  82                     prev_dlg = DIALOG (top_dlg->data);
  83                 else
  84                 {
  85                     GList *p;
  86
  87                     /* Top dialog is current if it is visible.
  88                        Get previous dialog in stack */
  89                     p = g_list_next (top_dlg);
  90                     if (p != NULL)
  91                         prev_dlg = DIALOG (p->data);
  92                 }
  93             }
  94
  95             /* if previous dialog is not fullscreen'd -- overlap it */
  96             if (prev_dlg == NULL || prev_dlg->fullscreen)
  97                 ypos = LINES / 3 - (w->lines - 3) / 2;
  98             else
  99                 ypos = WIDGET (prev_dlg)->y + 2;
 100
 101             xpos = COLS / 2 - w->cols / 2;
 102
 103             /* set position */
 104             dlg_set_position (h, ypos, xpos, ypos + w->lines, xpos + w->cols);
 105
 106             return MSG_HANDLED;
 107         }
 108         /* fallthrough */
 109
 110     default:
 111         return dlg_default_callback (w, sender, msg, parm, data);
 112     }
 113 }
 114
 115 /* --------------------------------------------------------------------------------------------- */
 116 /** Create message dialog */
 117
 118 static struct WDialog *
 119 do_create_message (int flags, const char *title, const char *text)
 120 {
 121     char *p;
 122     WDialog *d;
 123
 124     /* Add empty lines before and after the message */
 125     p = g_strconcat ("\n", text, "\n", (char *) NULL);
 126     query_dialog (title, p, flags, 0);
 127     d = last_query_dlg;
 128
 129     /* do resize before initing and running */
 130     send_message (d, NULL, MSG_RESIZE, 0, NULL);
 131
 132     init_dlg (d);
 133     g_free (p);
 134
 135     return d;
 136 }
 137
 138 /* --------------------------------------------------------------------------------------------- */
 139 /**
 140  * Show message dialog.  Dismiss it when any key is pressed.
 141  * Not safe to call from background.
 142  */
 143
 144 static void
 145 fg_message (int flags, const char *title, const char *text)
 146 {
 147     WDialog *d;
 148
 149     d = do_create_message (flags, title, text);
 150     tty_getch ();
 151     dlg_run_done (d);
 152     destroy_dlg (d);
 153 }
 154
 155
 156 /* --------------------------------------------------------------------------------------------- */
 157 /** Show message box from background */
 158
 159 #ifdef ENABLE_BACKGROUND
 160 static void
 161 bg_message (int dummy, int *flags, char *title, const char *text)
 162 {
 163     (void) dummy;
 164     title = g_strconcat (_("Background process:"), " ", title, (char *) NULL);
 165     fg_message (*flags, title, text);
 166     g_free (title);
 167 }
 168 #endif /* ENABLE_BACKGROUND */
 169
 170 /* --------------------------------------------------------------------------------------------- */
 171
 172 /**
 173  * Show dialog, not background safe.
 174  *
 175  * If the arguments "header" and "text" should be translated,
 176  * that MUST be done by the caller of fg_input_dialog_help().
 177  *
 178  * The argument "history_name" holds the name of a section
 179  * in the history file. Data entered in the input field of
 180  * the dialog box will be stored there.
 181  *
 182  */
 183 static char *
 184 fg_input_dialog_help (const char *header, const char *text, const char *help,
 185                       const char *history_name, const char *def_text, gboolean strip_password)
 186 {
 187     char *p_text;
 188     char histname[64] = "inp|";
 189     int flags = strip_password ? 4 : 0;
 190     char *my_str;
 191     int ret;
 192
 193     /* label text */
 194     p_text = g_strstrip (g_strdup (text));
 195
 196     /* input history */
 197     if (history_name != NULL && *history_name != '\0')
 198         g_strlcpy (histname + 3, history_name, sizeof (histname) - 3);
 199
 200     /* The special value of def_text is used to identify password boxes
 201        and hide characters with "*".  Don't save passwords in history! */
 202     if (def_text == INPUT_PASSWORD)
 203     {
 204         flags = 1;
 205         histname[3] = '\0';
 206         def_text = "";
 207     }
 208
 209     {
 210         quick_widget_t quick_widgets[] = {
 211             /* *INDENT-OFF* */
 212             QUICK_LABELED_INPUT (p_text, input_label_above, def_text, flags, histname, &my_str,
 213                                  NULL),
 214             QUICK_BUTTONS_OK_CANCEL,
 215             QUICK_END
 216             /* *INDENT-ON* */
 217         };
 218
 219         quick_dialog_t qdlg = {
 220             -1, -1, COLS / 2, header,
 221             help, quick_widgets, NULL, NULL
 222         };
 223
 224         ret = quick_dialog (&qdlg);
 225     }
 226
 227     g_free (p_text);
 228
 229     return (ret != B_CANCEL) ? my_str : NULL;
 230 }
 231
 232 /* --------------------------------------------------------------------------------------------- */
 233
 234 #ifdef ENABLE_BACKGROUND
 235 static int
 236 wtools_parent_call (void *routine, gpointer ctx, int argc, ...)
 237 {
 238     ev_background_parent_call_t event_data;
 239
 240     event_data.routine = routine;
 241     event_data.ctx = ctx;
 242     event_data.argc = argc;
 243     va_start (event_data.ap, argc);
 244     mc_event_raise (MCEVENT_GROUP_CORE, "background_parent_call", (gpointer) & event_data);
 245     va_end (event_data.ap);
 246     return event_data.ret.i;
 247 }
 248
 249 /* --------------------------------------------------------------------------------------------- */
 250
 251 static char *
 252 wtools_parent_call_string (void *routine, int argc, ...)
 253 {
 254     ev_background_parent_call_t event_data;
 255
 256     event_data.routine = routine;
 257     event_data.argc = argc;
 258     va_start (event_data.ap, argc);
 259     mc_event_raise (MCEVENT_GROUP_CORE, "background_parent_call_string", (gpointer) & event_data);
 260     va_end (event_data.ap);
 261     return event_data.ret.s;
 262 }
 263 #endif /* ENABLE_BACKGROUND */
 264
 265 /* --------------------------------------------------------------------------------------------- */
 266 /*** public functions ****************************************************************************/
 267 /* --------------------------------------------------------------------------------------------- */
 268
 269 /** Used to ask questions to the user */
 270 int
 271 query_dialog (const char *header, const char *text, int flags, int count, ...)
 272 {
 273     va_list ap;
 274     WDialog *query_dlg;
 275     WButton *button;
 276     WButton *defbutton = NULL;
 277     int win_len = 0;
 278     int i;
 279     int result = -1;
 280     int cols, lines;
 281     char *cur_name;
 282     const int *query_colors = (flags & D_ERROR) != 0 ? alarm_colors : dialog_colors;
 283     dlg_flags_t dlg_flags = (flags & D_CENTER) != 0 ? (DLG_CENTER | DLG_TRYUP) : DLG_NONE;
 284
 285     if (header == MSG_ERROR)
 286         header = _("Error");
 287
 288     if (count > 0)
 289     {
 290         va_start (ap, count);
 291         for (i = 0; i < count; i++)
 292         {
 293             char *cp = va_arg (ap, char *);
 294             win_len += str_term_width1 (cp) + 6;
 295             if (strchr (cp, '&') != NULL)
 296                 win_len--;
 297         }
 298         va_end (ap);
 299     }
 300
 301     /* count coordinates */
 302     str_msg_term_size (text, &lines, &cols);
 303     cols = 6 + max (win_len, max (str_term_width1 (header), cols));
 304     lines += 4 + (count > 0 ? 2 : 0);
 305
 306     /* prepare dialog */
 307     query_dlg =
 308         create_dlg (TRUE, 0, 0, lines, cols, query_colors, query_default_callback, NULL,
 309                     "[QueryBox]", header, dlg_flags);
 310
 311     if (count > 0)
 312     {
 313         add_widget_autopos (query_dlg, label_new (2, 3, text), WPOS_KEEP_TOP | WPOS_CENTER_HORZ,
 314                             NULL);
 315
 316         add_widget (query_dlg, hline_new (lines - 4, -1, -1));
 317
 318         cols = (cols - win_len - 2) / 2 + 2;
 319         va_start (ap, count);
 320         for (i = 0; i < count; i++)
 321         {
 322             int xpos;
 323
 324             cur_name = va_arg (ap, char *);
 325             xpos = str_term_width1 (cur_name) + 6;
 326             if (strchr (cur_name, '&') != NULL)
 327                 xpos--;
 328
 329             button = button_new (lines - 3, cols, B_USER + i, NORMAL_BUTTON, cur_name, NULL);
 330             add_widget (query_dlg, button);
 331             cols += xpos;
 332             if (i == sel_pos)
 333                 defbutton = button;
 334         }
 335         va_end (ap);
 336
 337         /* do resize before running and selecting any widget */
 338         send_message (query_dlg, NULL, MSG_RESIZE, 0, NULL);
 339
 340         if (defbutton != NULL)
 341             dlg_select_widget (defbutton);
 342
 343         /* run dialog and make result */
 344         switch (run_dlg (query_dlg))
 345         {
 346         case B_CANCEL:
 347             break;
 348         default:
 349             result = query_dlg->ret_value - B_USER;
 350         }
 351
 352         /* free used memory */
 353         destroy_dlg (query_dlg);
 354     }
 355     else
 356     {
 357         add_widget_autopos (query_dlg, label_new (2, 3, text), WPOS_KEEP_TOP | WPOS_CENTER_HORZ,
 358                             NULL);
 359         add_widget (query_dlg, button_new (0, 0, 0, HIDDEN_BUTTON, "-", NULL));
 360         last_query_dlg = query_dlg;
 361     }
 362     sel_pos = 0;
 363     return result;
 364 }
 365
 366 /* --------------------------------------------------------------------------------------------- */
 367
 368 void
 369 query_set_sel (int new_sel)
 370 {
 371     sel_pos = new_sel;
 372 }
 373
 374 /* --------------------------------------------------------------------------------------------- */
 375 /**
 376  * Create message dialog.  The caller must call dlg_run_done() and
 377  * destroy_dlg() to dismiss it.  Not safe to call from background.
 378  */
 379
 380 struct WDialog *
 381 create_message (int flags, const char *title, const char *text, ...)
 382 {
 383     va_list args;
 384     WDialog *d;
 385     char *p;
 386
 387     va_start (args, text);
 388     p = g_strdup_vprintf (text, args);
 389     va_end (args);
 390
 391     d = do_create_message (flags, title, p);
 392     g_free (p);
 393
 394     return d;
 395 }
 396
 397 /* --------------------------------------------------------------------------------------------- */
 398 /** Show message box, background safe */
 399
 400 void
 401 message (int flags, const char *title, const char *text, ...)
 402 {
 403     char *p;
 404     va_list ap;
 405
 406     va_start (ap, text);
 407     p = g_strdup_vprintf (text, ap);
 408     va_end (ap);
 409
 410     if (title == MSG_ERROR)
 411         title = _("Error");
 412
 413 #ifdef ENABLE_BACKGROUND
 414     if (mc_global.we_are_background)
 415     {
 416         union
 417         {
 418             void *p;
 419             void (*f) (int, int *, char *, const char *);
 420         } func;
 421         func.f = bg_message;
 422
 423         wtools_parent_call (func.p, NULL, 3, sizeof (flags), &flags, strlen (title), title,
 424                             strlen (p), p);
 425     }
 426     else
 427 #endif /* ENABLE_BACKGROUND */
 428         fg_message (flags, title, p);
 429
 430     g_free (p);
 431 }
 432
 433 /* --------------------------------------------------------------------------------------------- */
 434 /**
 435  * Show input dialog, background safe.
 436  *
 437  * If the arguments "header" and "text" should be translated,
 438  * that MUST be done by the caller of these wrappers.
 439  */
 440
 441 char *
 442 input_dialog_help (const char *header, const char *text, const char *help,
 443                    const char *history_name, const char *def_text, gboolean strip_password)
 444 {
 445 #ifdef ENABLE_BACKGROUND
 446     if (mc_global.we_are_background)
 447     {
 448         union
 449         {
 450             void *p;
 451             char *(*f) (const char *, const char *, const char *, const char *, const char *,
 452                         gboolean);
 453         } func;
 454         func.f = fg_input_dialog_help;
 455         return wtools_parent_call_string (func.p, 6,
 456                                           strlen (header), header, strlen (text),
 457                                           text, strlen (help), help,
 458                                           strlen (history_name), history_name,
 459                                           strlen (def_text), def_text,
 460                                           sizeof (gboolean), strip_password);
 461     }
 462     else
 463 #endif /* ENABLE_BACKGROUND */
 464         return fg_input_dialog_help (header, text, help, history_name, def_text, strip_password);
 465 }
 466
 467 /* --------------------------------------------------------------------------------------------- */
 468 /** Show input dialog with default help, background safe */
 469
 470 char *
 471 input_dialog (const char *header, const char *text, const char *history_name, const char *def_text)
 472 {
 473     return input_dialog_help (header, text, "[Input Line Keys]", history_name, def_text, FALSE);
 474 }
 475
 476 /* --------------------------------------------------------------------------------------------- */
 477
 478 char *
 479 input_expand_dialog (const char *header, const char *text,
 480                      const char *history_name, const char *def_text)
 481 {
 482     char *result;
 483     char *expanded;
 484
 485     result = input_dialog (header, text, history_name, def_text);
 486     if (result)
 487     {
 488         expanded = tilde_expand (result);
 489         g_free (result);
 490         return expanded;
 491     }
 492     return result;
 493 }
 494
 495 /* --------------------------------------------------------------------------------------------- */