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             QUICK_LABELED_INPUT (p_text, input_label_above, def_text, flags, histname, &my_str,
 212                                  NULL),
 213             QUICK_BUTTONS_OK_CANCEL,
 214             QUICK_END
 215             /* *INDENT-ON* */
 216         };
 217
 218         quick_dialog_t qdlg = {
 219             -1, -1, COLS / 2, header,
 220             help, quick_widgets, NULL, NULL
 221         };
 222
 223         ret = quick_dialog (&qdlg);
 224     }
 225
 226     g_free (p_text);
 227
 228     return (ret != B_CANCEL) ? my_str : NULL;
 229 }
 230
 231 /* --------------------------------------------------------------------------------------------- */
 232
 233 #ifdef ENABLE_BACKGROUND
 234 static int
 235 wtools_parent_call (void *routine, gpointer ctx, int argc, ...)
 236 {
 237     ev_background_parent_call_t event_data;
 238
 239     event_data.routine = routine;
 240     event_data.ctx = ctx;
 241     event_data.argc = argc;
 242     va_start (event_data.ap, argc);
 243     mc_event_raise (MCEVENT_GROUP_CORE, "background_parent_call", (gpointer) & event_data);
 244     va_end (event_data.ap);
 245     return event_data.ret.i;
 246 }
 247
 248 /* --------------------------------------------------------------------------------------------- */
 249
 250 static char *
 251 wtools_parent_call_string (void *routine, int argc, ...)
 252 {
 253     ev_background_parent_call_t event_data;
 254
 255     event_data.routine = routine;
 256     event_data.argc = argc;
 257     va_start (event_data.ap, argc);
 258     mc_event_raise (MCEVENT_GROUP_CORE, "background_parent_call_string", (gpointer) & event_data);
 259     va_end (event_data.ap);
 260     return event_data.ret.s;
 261 }
 262 #endif /* ENABLE_BACKGROUND */
 263
 264 /* --------------------------------------------------------------------------------------------- */
 265 /*** public functions ****************************************************************************/
 266 /* --------------------------------------------------------------------------------------------- */
 267
 268 /** Used to ask questions to the user */
 269 int
 270 query_dialog (const char *header, const char *text, int flags, int count, ...)
 271 {
 272     va_list ap;
 273     Dlg_head *query_dlg;
 274     WButton *button;
 275     WButton *defbutton = NULL;
 276     int win_len = 0;
 277     int i;
 278     int result = -1;
 279     int cols, lines;
 280     char *cur_name;
 281     const int *query_colors = (flags & D_ERROR) != 0 ? alarm_colors : dialog_colors;
 282     dlg_flags_t dlg_flags = (flags & D_CENTER) != 0 ? (DLG_CENTER | DLG_TRYUP) : DLG_NONE;
 283
 284     if (header == MSG_ERROR)
 285         header = _("Error");
 286
 287     if (count > 0)
 288     {
 289         va_start (ap, count);
 290         for (i = 0; i < count; i++)
 291         {
 292             char *cp = va_arg (ap, char *);
 293             win_len += str_term_width1 (cp) + 6;
 294             if (strchr (cp, '&') != NULL)
 295                 win_len--;
 296         }
 297         va_end (ap);
 298     }
 299
 300     /* count coordinates */
 301     str_msg_term_size (text, &lines, &cols);
 302     cols = 6 + max (win_len, max (str_term_width1 (header), cols));
 303     lines += 4 + (count > 0 ? 2 : 0);
 304
 305     /* prepare dialog */
 306     query_dlg =
 307         create_dlg (TRUE, 0, 0, lines, cols, query_colors, default_query_callback, NULL,
 308                     "[QueryBox]", header, dlg_flags);
 309
 310     if (count > 0)
 311     {
 312         add_widget (query_dlg, label_new (2, 3, text));
 313
 314         add_widget (query_dlg, hline_new (lines - 4, -1, -1));
 315
 316         cols = (cols - win_len - 2) / 2 + 2;
 317         va_start (ap, count);
 318         for (i = 0; i < count; i++)
 319         {
 320             int xpos;
 321
 322             cur_name = va_arg (ap, char *);
 323             xpos = str_term_width1 (cur_name) + 6;
 324             if (strchr (cur_name, '&') != NULL)
 325                 xpos--;
 326
 327             button = button_new (lines - 3, cols, B_USER + i, NORMAL_BUTTON, cur_name, 0);
 328             add_widget (query_dlg, button);
 329             cols += xpos;
 330             if (i == sel_pos)
 331                 defbutton = button;
 332         }
 333         va_end (ap);
 334
 335
 336         /* do resize before running and selecting any widget */
 337         default_query_callback (query_dlg, NULL, DLG_RESIZE, 0, NULL);
 338
 339         if (defbutton)
 340             dlg_select_widget (defbutton);
 341
 342         /* run dialog and make result */
 343         switch (run_dlg (query_dlg))
 344         {
 345         case B_CANCEL:
 346             break;
 347         default:
 348             result = query_dlg->ret_value - B_USER;
 349         }
 350
 351         /* free used memory */
 352         destroy_dlg (query_dlg);
 353     }
 354     else
 355     {
 356         add_widget (query_dlg, label_new (2, 3, text));
 357         add_widget (query_dlg, button_new (0, 0, 0, HIDDEN_BUTTON, "-", 0));
 358         last_query_dlg = query_dlg;
 359     }
 360     sel_pos = 0;
 361     return result;
 362 }
 363
 364 /* --------------------------------------------------------------------------------------------- */
 365
 366 void
 367 query_set_sel (int new_sel)
 368 {
 369     sel_pos = new_sel;
 370 }
 371
 372 /* --------------------------------------------------------------------------------------------- */
 373 /**
 374  * Create message dialog.  The caller must call dlg_run_done() and
 375  * destroy_dlg() to dismiss it.  Not safe to call from background.
 376  */
 377
 378 struct Dlg_head *
 379 create_message (int flags, const char *title, const char *text, ...)
 380 {
 381     va_list args;
 382     Dlg_head *d;
 383     char *p;
 384
 385     va_start (args, text);
 386     p = g_strdup_vprintf (text, args);
 387     va_end (args);
 388
 389     d = do_create_message (flags, title, p);
 390     g_free (p);
 391
 392     return d;
 393 }
 394
 395 /* --------------------------------------------------------------------------------------------- */
 396 /** Show message box, background safe */
 397
 398 void
 399 message (int flags, const char *title, const char *text, ...)
 400 {
 401     char *p;
 402     va_list ap;
 403
 404     va_start (ap, text);
 405     p = g_strdup_vprintf (text, ap);
 406     va_end (ap);
 407
 408     if (title == MSG_ERROR)
 409         title = _("Error");
 410
 411 #ifdef ENABLE_BACKGROUND
 412     if (mc_global.we_are_background)
 413     {
 414         union
 415         {
 416             void *p;
 417             void (*f) (int, int *, char *, const char *);
 418         } func;
 419         func.f = bg_message;
 420
 421         wtools_parent_call (func.p, NULL, 3, sizeof (flags), &flags, strlen (title), title,
 422                             strlen (p), p);
 423     }
 424     else
 425 #endif /* ENABLE_BACKGROUND */
 426         fg_message (flags, title, p);
 427
 428     g_free (p);
 429 }
 430
 431 /* --------------------------------------------------------------------------------------------- */
 432 /**
 433  * Show input dialog, background safe.
 434  *
 435  * If the arguments "header" and "text" should be translated,
 436  * that MUST be done by the caller of these wrappers.
 437  */
 438
 439 char *
 440 input_dialog_help (const char *header, const char *text, const char *help,
 441                    const char *history_name, const char *def_text, gboolean strip_password)
 442 {
 443 #ifdef ENABLE_BACKGROUND
 444     if (mc_global.we_are_background)
 445     {
 446         union
 447         {
 448             void *p;
 449             char *(*f) (const char *, const char *, const char *, const char *, const char *,
 450                         gboolean);
 451         } func;
 452         func.f = fg_input_dialog_help;
 453         return wtools_parent_call_string (func.p, 6,
 454                                           strlen (header), header, strlen (text),
 455                                           text, strlen (help), help,
 456                                           strlen (history_name), history_name,
 457                                           strlen (def_text), def_text,
 458                                           sizeof (gboolean), strip_password);
 459     }
 460     else
 461 #endif /* ENABLE_BACKGROUND */
 462         return fg_input_dialog_help (header, text, help, history_name, def_text, strip_password);
 463 }
 464
 465 /* --------------------------------------------------------------------------------------------- */
 466 /** Show input dialog with default help, background safe */
 467
 468 char *
 469 input_dialog (const char *header, const char *text, const char *history_name, const char *def_text)
 470 {
 471     return input_dialog_help (header, text, "[Input Line Keys]", history_name, def_text, FALSE);
 472 }
 473
 474 /* --------------------------------------------------------------------------------------------- */
 475
 476 char *
 477 input_expand_dialog (const char *header, const char *text,
 478                      const char *history_name, const char *def_text)
 479 {
 480     char *result;
 481     char *expanded;
 482
 483     result = input_dialog (header, text, history_name, def_text);
 484     if (result)
 485     {
 486         expanded = tilde_expand (result);
 487         g_free (result);
 488         return expanded;
 489     }
 490     return result;
 491 }
 492
 493 /* --------------------------------------------------------------------------------------------- */