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 Dlg_head *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 default_query_callback (Dlg_head * h, Widget * sender, dlg_msg_t msg, int parm, void *data)
  67 {
  68     switch (msg)
  69     {
  70     case DLG_RESIZE:
  71         if ((h->flags & DLG_CENTER) == 0)
  72         {
  73             Widget *wh = WIDGET (h);
  74             Dlg_head *prev_dlg = NULL;
  75             int ypos, xpos;
  76
  77             /* get dialog under h */
  78             if (top_dlg != NULL)
  79             {
  80                 if (top_dlg->data != (void *) h)
  81                     prev_dlg = (Dlg_head *) top_dlg->data;
  82                 else
  83                 {
  84                     GList *p;
  85
  86                     /* Top dialog is current if it is visible.
  87                        Get previous dialog in stack */
  88                     p = g_list_next (top_dlg);
  89                     if (p != NULL)
  90                         prev_dlg = (Dlg_head *) p->data;
  91                 }
  92             }
  93
  94             /* if previous dialog is not fullscreen'd -- overlap it */
  95             if (prev_dlg == NULL || prev_dlg->fullscreen)
  96                 ypos = LINES / 3 - (wh->lines - 3) / 2;
  97             else
  98                 ypos = WIDGET (prev_dlg)->y + 2;
  99
 100             xpos = COLS / 2 - wh->cols / 2;
 101
 102             /* set position */
 103             dlg_set_position (h, ypos, xpos, ypos + wh->lines, xpos + wh->cols);
 104
 105             return MSG_HANDLED;
 106         }
 107         /* fallthrough */
 108
 109     default:
 110         return default_dlg_callback (h, sender, msg, parm, data);
 111     }
 112 }
 113
 114 /* --------------------------------------------------------------------------------------------- */
 115 /** Create message dialog */
 116
 117 static struct Dlg_head *
 118 do_create_message (int flags, const char *title, const char *text)
 119 {
 120     char *p;
 121     Dlg_head *d;
 122
 123     /* Add empty lines before and after the message */
 124     p = g_strconcat ("\n", text, "\n", (char *) NULL);
 125     query_dialog (title, p, flags, 0);
 126     d = last_query_dlg;
 127
 128     /* do resize before initing and running */
 129     default_query_callback (d, NULL, DLG_RESIZE, 0, NULL);
 130
 131     init_dlg (d);
 132     g_free (p);
 133
 134     return d;
 135 }
 136
 137 /* --------------------------------------------------------------------------------------------- */
 138 /**
 139  * Show message dialog.  Dismiss it when any key is pressed.
 140  * Not safe to call from background.
 141  */
 142
 143 static void
 144 fg_message (int flags, const char *title, const char *text)
 145 {
 146     Dlg_head *d;
 147
 148     d = do_create_message (flags, title, text);
 149     tty_getch ();
 150     dlg_run_done (d);
 151     destroy_dlg (d);
 152 }
 153
 154
 155 /* --------------------------------------------------------------------------------------------- */
 156 /** Show message box from background */
 157
 158 #ifdef ENABLE_BACKGROUND
 159 static void
 160 bg_message (int dummy, int *flags, char *title, const char *text)
 161 {
 162     (void) dummy;
 163     title = g_strconcat (_("Background process:"), " ", title, (char *) NULL);
 164     fg_message (*flags, title, text);
 165     g_free (title);
 166 }
 167 #endif /* ENABLE_BACKGROUND */
 168
 169 /* --------------------------------------------------------------------------------------------- */
 170
 171 /**
 172  * Show dialog, not background safe.
 173  *
 174  * If the arguments "header" and "text" should be translated,
 175  * that MUST be done by the caller of fg_input_dialog_help().
 176  *
 177  * The argument "history_name" holds the name of a section
 178  * in the history file. Data entered in the input field of
 179  * the dialog box will be stored there.
 180  *
 181  */
 182 static char *
 183 fg_input_dialog_help (const char *header, const char *text, const char *help,
 184                       const char *history_name, const char *def_text, gboolean strip_password)
 185 {
 186     char *p_text;
 187     char histname[64] = "inp|";
 188     int flags = strip_password ? 4 : 0;
 189     char *my_str;
 190     int ret;
 191
 192     /* label text */
 193     p_text = g_strstrip (g_strdup (text));
 194
 195     /* input history */
 196     if (history_name != NULL && *history_name != '\0')
 197         g_strlcpy (histname + 3, history_name, sizeof (histname) - 3);
 198
 199     /* The special value of def_text is used to identify password boxes
 200        and hide characters with "*".  Don't save passwords in history! */
 201     if (def_text == INPUT_PASSWORD)
 202     {
 203         flags = 1;
 204         histname[3] = '\0';
 205         def_text = "";
 206     }
 207
 208     {
 209         quick_widget_t quick_widgets[] = {
 210         /* *INDENT-OFF* */
 211             QUICK2_LABELED_INPUT (p_text, input_label_above, def_text, flags, histname, &my_str,
 212                                   NULL),
 213             QUICK2_START_BUTTONS (TRUE, TRUE),
 214                 QUICK2_BUTTON (N_("&OK"), B_ENTER, NULL, NULL),
 215                 QUICK2_BUTTON (N_("&Cancel"), B_CANCEL, NULL, NULL),
 216             QUICK2_END
 217         /* *INDENT-OFF* */
 218         };
 219
 220         quick_dialog_t qdlg = {
 221             -1, -1, COLS / 2, header,
 222             help, quick_widgets, NULL, NULL
 223         };
 224
 225         ret = quick2_dialog (&qdlg);
 226     }
 227
 228     g_free (p_text);
 229
 230     return (ret != B_CANCEL) ? my_str : NULL;
 231 }
 232
 233 /* --------------------------------------------------------------------------------------------- */
 234
 235 #ifdef ENABLE_BACKGROUND
 236 static int
 237 wtools_parent_call (void *routine, gpointer ctx, int argc, ...)
 238 {
 239     ev_background_parent_call_t event_data;
 240
 241     event_data.routine = routine;
 242     event_data.ctx = ctx;
 243     event_data.argc = argc;
 244     va_start (event_data.ap, argc);
 245     mc_event_raise (MCEVENT_GROUP_CORE, "background_parent_call", (gpointer) & event_data);
 246     va_end (event_data.ap);
 247     return event_data.ret.i;
 248 }
 249
 250 /* --------------------------------------------------------------------------------------------- */
 251
 252 static char *
 253 wtools_parent_call_string (void *routine, int argc, ...)
 254 {
 255     ev_background_parent_call_t event_data;
 256
 257     event_data.routine = routine;
 258     event_data.argc = argc;
 259     va_start (event_data.ap, argc);
 260     mc_event_raise (MCEVENT_GROUP_CORE, "background_parent_call_string", (gpointer) & event_data);
 261     va_end (event_data.ap);
 262     return event_data.ret.s;
 263 }
 264 #endif /* ENABLE_BACKGROUND */
 265
 266 /* --------------------------------------------------------------------------------------------- */
 267 /*** public functions ****************************************************************************/
 268 /* --------------------------------------------------------------------------------------------- */
 269
 270 /** Used to ask questions to the user */
 271 int
 272 query_dialog (const char *header, const char *text, int flags, int count, ...)
 273 {
 274     va_list ap;
 275     Dlg_head *query_dlg;
 276     WButton *button;
 277     WButton *defbutton = NULL;
 278     int win_len = 0;
 279     int i;
 280     int result = -1;
 281     int cols, lines;
 282     char *cur_name;
 283     const int *query_colors = (flags & D_ERROR) != 0 ? alarm_colors : dialog_colors;
 284     dlg_flags_t dlg_flags = (flags & D_CENTER) != 0 ? (DLG_CENTER | DLG_TRYUP) : DLG_NONE;
 285
 286     if (header == MSG_ERROR)
 287         header = _("Error");
 288
 289     if (count > 0)
 290     {
 291         va_start (ap, count);
 292         for (i = 0; i < count; i++)
 293         {
 294             char *cp = va_arg (ap, char *);
 295             win_len += str_term_width1 (cp) + 6;
 296             if (strchr (cp, '&') != NULL)
 297                 win_len--;
 298         }
 299         va_end (ap);
 300     }
 301
 302     /* count coordinates */
 303     str_msg_term_size (text, &lines, &cols);
 304     cols = 6 + max (win_len, max (str_term_width1 (header), cols));
 305     lines += 4 + (count > 0 ? 2 : 0);
 306
 307     /* prepare dialog */
 308     query_dlg =
 309         create_dlg (TRUE, 0, 0, lines, cols, query_colors, default_query_callback, NULL,
 310                     "[QueryBox]", header, dlg_flags);
 311
 312     if (count > 0)
 313     {
 314         cols = (cols - win_len - 2) / 2 + 2;
 315         va_start (ap, count);
 316         for (i = 0; i < count; i++)
 317         {
 318             int xpos;
 319
 320             cur_name = va_arg (ap, char *);
 321             xpos = str_term_width1 (cur_name) + 6;
 322             if (strchr (cur_name, '&') != NULL)
 323                 xpos--;
 324
 325             button = button_new (lines - 3, cols, B_USER + i, NORMAL_BUTTON, cur_name, 0);
 326             add_widget (query_dlg, button);
 327             cols += xpos;
 328             if (i == sel_pos)
 329                 defbutton = button;
 330         }
 331         va_end (ap);
 332
 333         add_widget (query_dlg, label_new (2, 3, text));
 334
 335         /* do resize before running and selecting any widget */
 336         default_query_callback (query_dlg, NULL, DLG_RESIZE, 0, NULL);
 337
 338         if (defbutton)
 339             dlg_select_widget (defbutton);
 340
 341         /* run dialog and make result */
 342         switch (run_dlg (query_dlg))
 343         {
 344         case B_CANCEL:
 345             break;
 346         default:
 347             result = query_dlg->ret_value - B_USER;
 348         }
 349
 350         /* free used memory */
 351         destroy_dlg (query_dlg);
 352     }
 353     else
 354     {
 355         add_widget (query_dlg, label_new (2, 3, text));
 356         add_widget (query_dlg, button_new (0, 0, 0, HIDDEN_BUTTON, "-", 0));
 357         last_query_dlg = query_dlg;
 358     }
 359     sel_pos = 0;
 360     return result;
 361 }
 362
 363 /* --------------------------------------------------------------------------------------------- */
 364
 365 void
 366 query_set_sel (int new_sel)
 367 {
 368     sel_pos = new_sel;
 369 }
 370
 371 /* --------------------------------------------------------------------------------------------- */
 372 /**
 373  * Create message dialog.  The caller must call dlg_run_done() and
 374  * destroy_dlg() to dismiss it.  Not safe to call from background.
 375  */
 376
 377 struct Dlg_head *
 378 create_message (int flags, const char *title, const char *text, ...)
 379 {
 380     va_list args;
 381     Dlg_head *d;
 382     char *p;
 383
 384     va_start (args, text);
 385     p = g_strdup_vprintf (text, args);
 386     va_end (args);
 387
 388     d = do_create_message (flags, title, p);
 389     g_free (p);
 390
 391     return d;
 392 }
 393
 394 /* --------------------------------------------------------------------------------------------- */
 395 /** Show message box, background safe */
 396
 397 void
 398 message (int flags, const char *title, const char *text, ...)
 399 {
 400     char *p;
 401     va_list ap;
 402
 403     va_start (ap, text);
 404     p = g_strdup_vprintf (text, ap);
 405     va_end (ap);
 406
 407     if (title == MSG_ERROR)
 408         title = _("Error");
 409
 410 #ifdef ENABLE_BACKGROUND
 411     if (mc_global.we_are_background)
 412     {
 413         union
 414         {
 415             void *p;
 416             void (*f) (int, int *, char *, const char *);
 417         } func;
 418         func.f = bg_message;
 419
 420         wtools_parent_call (func.p, NULL, 3, sizeof (flags), &flags, strlen (title), title,
 421                             strlen (p), p);
 422     }
 423     else
 424 #endif /* ENABLE_BACKGROUND */
 425         fg_message (flags, title, p);
 426
 427     g_free (p);
 428 }
 429
 430 /* --------------------------------------------------------------------------------------------- */
 431 /**
 432  * Show input dialog, background safe.
 433  *
 434  * If the arguments "header" and "text" should be translated,
 435  * that MUST be done by the caller of these wrappers.
 436  */
 437
 438 char *
 439 input_dialog_help (const char *header, const char *text, const char *help,
 440                    const char *history_name, const char *def_text, gboolean strip_password)
 441 {
 442 #ifdef ENABLE_BACKGROUND
 443     if (mc_global.we_are_background)
 444     {
 445         union
 446         {
 447             void *p;
 448             char *(*f) (const char *, const char *, const char *, const char *, const char *,
 449                         gboolean);
 450         } func;
 451         func.f = fg_input_dialog_help;
 452         return wtools_parent_call_string (func.p, 6,
 453                                           strlen (header), header, strlen (text),
 454                                           text, strlen (help), help,
 455                                           strlen (history_name), history_name,
 456                                           strlen (def_text), def_text,
 457                                           sizeof (gboolean), strip_password);
 458     }
 459     else
 460 #endif /* ENABLE_BACKGROUND */
 461         return fg_input_dialog_help (header, text, help, history_name, def_text, strip_password);
 462 }
 463
 464 /* --------------------------------------------------------------------------------------------- */
 465 /** Show input dialog with default help, background safe */
 466
 467 char *
 468 input_dialog (const char *header, const char *text, const char *history_name, const char *def_text)
 469 {
 470     return input_dialog_help (header, text, "[Input Line Keys]", history_name, def_text, FALSE);
 471 }
 472
 473 /* --------------------------------------------------------------------------------------------- */
 474
 475 char *
 476 input_expand_dialog (const char *header, const char *text,
 477                      const char *history_name, const char *def_text)
 478 {
 479     char *result;
 480     char *expanded;
 481
 482     result = input_dialog (header, text, history_name, def_text);
 483     if (result)
 484     {
 485         expanded = tilde_expand (result);
 486         g_free (result);
 487         return expanded;
 488     }
 489     return result;
 490 }
 491
 492 /* --------------------------------------------------------------------------------------------- */