2 Widget based utility functions.
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.
9 Miguel de Icaza, 1994, 1995, 1996
10 Radek Doulik, 1994, 1995
12 Andrej Borsenkow, 1995
13 Andrew Borodin <aborodin@vmail.ru>, 2009, 2010, 2012
15 This file is part of the Midnight Commander.
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.
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.
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/>.
32 * \brief Source: widget based utility functions
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() */
48 /*** global variables ****************************************************************************/
50 /*** file scope macro definitions ****************************************************************/
52 /*** file scope type declarations ****************************************************************/
54 /*** file scope variables ************************************************************************/
56 static WDialog
*last_query_dlg
;
58 static int sel_pos
= 0;
60 /*** file scope functions ************************************************************************/
61 /* --------------------------------------------------------------------------------------------- */
63 /** default query callback, used to reposition query */
66 query_default_callback (Widget
* w
, Widget
* sender
, widget_msg_t msg
, int parm
, void *data
)
68 WDialog
*h
= DIALOG (w
);
73 if ((h
->flags
& DLG_CENTER
) == 0)
75 WDialog
*prev_dlg
= NULL
;
78 /* get dialog under h */
81 if (top_dlg
->data
!= (void *) h
)
82 prev_dlg
= DIALOG (top_dlg
->data
);
87 /* Top dialog is current if it is visible.
88 Get previous dialog in stack */
89 p
= g_list_next (top_dlg
);
91 prev_dlg
= DIALOG (p
->data
);
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;
99 ypos
= WIDGET (prev_dlg
)->y
+ 2;
101 xpos
= COLS
/ 2 - w
->cols
/ 2;
104 dlg_set_position (h
, ypos
, xpos
, ypos
+ w
->lines
, xpos
+ w
->cols
);
111 return dlg_default_callback (w
, sender
, msg
, parm
, data
);
115 /* --------------------------------------------------------------------------------------------- */
116 /** Create message dialog */
118 static struct WDialog
*
119 do_create_message (int flags
, const char *title
, const char *text
)
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);
129 /* do resize before initing and running */
130 send_message (d
, NULL
, MSG_RESIZE
, 0, NULL
);
138 /* --------------------------------------------------------------------------------------------- */
140 * Show message dialog. Dismiss it when any key is pressed.
141 * Not safe to call from background.
145 fg_message (int flags
, const char *title
, const char *text
)
149 d
= do_create_message (flags
, title
, text
);
156 /* --------------------------------------------------------------------------------------------- */
157 /** Show message box from background */
159 #ifdef ENABLE_BACKGROUND
161 bg_message (int dummy
, int *flags
, char *title
, const char *text
)
164 title
= g_strconcat (_("Background process:"), " ", title
, (char *) NULL
);
165 fg_message (*flags
, title
, text
);
168 #endif /* ENABLE_BACKGROUND */
170 /* --------------------------------------------------------------------------------------------- */
173 * Show dialog, not background safe.
175 * If the arguments "header" and "text" should be translated,
176 * that MUST be done by the caller of fg_input_dialog_help().
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.
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 input_complete_t completion_flags
)
189 char histname
[64] = "inp|";
190 gboolean is_passwd
= FALSE
;
195 p_text
= g_strstrip (g_strdup (text
));
198 if (history_name
!= NULL
&& *history_name
!= '\0')
199 g_strlcpy (histname
+ 3, history_name
, sizeof (histname
) - 3);
201 /* The special value of def_text is used to identify password boxes
202 and hide characters with "*". Don't save passwords in history! */
203 if (def_text
== INPUT_PASSWORD
)
211 quick_widget_t quick_widgets
[] = {
213 QUICK_LABELED_INPUT (p_text
, input_label_above
, def_text
, histname
, &my_str
,
214 NULL
, is_passwd
, strip_password
, completion_flags
),
215 QUICK_BUTTONS_OK_CANCEL
,
220 quick_dialog_t qdlg
= {
221 -1, -1, COLS
/ 2, header
,
222 help
, quick_widgets
, NULL
, NULL
225 ret
= quick_dialog (&qdlg
);
230 return (ret
!= B_CANCEL
) ? my_str
: NULL
;
233 /* --------------------------------------------------------------------------------------------- */
235 #ifdef ENABLE_BACKGROUND
237 wtools_parent_call (void *routine
, gpointer ctx
, int argc
, ...)
239 ev_background_parent_call_t event_data
;
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
;
250 /* --------------------------------------------------------------------------------------------- */
253 wtools_parent_call_string (void *routine
, int argc
, ...)
255 ev_background_parent_call_t event_data
;
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
;
264 #endif /* ENABLE_BACKGROUND */
266 /* --------------------------------------------------------------------------------------------- */
267 /*** public functions ****************************************************************************/
268 /* --------------------------------------------------------------------------------------------- */
270 /** Used to ask questions to the user */
272 query_dialog (const char *header
, const char *text
, int flags
, int count
, ...)
277 WButton
*defbutton
= NULL
;
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
;
286 if (header
== MSG_ERROR
)
291 va_start (ap
, count
);
292 for (i
= 0; i
< count
; i
++)
294 char *cp
= va_arg (ap
, char *);
295 win_len
+= str_term_width1 (cp
) + 6;
296 if (strchr (cp
, '&') != NULL
)
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);
309 create_dlg (TRUE
, 0, 0, lines
, cols
, query_colors
, query_default_callback
, NULL
,
310 "[QueryBox]", header
, dlg_flags
);
314 add_widget_autopos (query_dlg
, label_new (2, 3, text
), WPOS_KEEP_TOP
| WPOS_CENTER_HORZ
,
317 add_widget (query_dlg
, hline_new (lines
- 4, -1, -1));
319 cols
= (cols
- win_len
- 2) / 2 + 2;
320 va_start (ap
, count
);
321 for (i
= 0; i
< count
; i
++)
325 cur_name
= va_arg (ap
, char *);
326 xpos
= str_term_width1 (cur_name
) + 6;
327 if (strchr (cur_name
, '&') != NULL
)
330 button
= button_new (lines
- 3, cols
, B_USER
+ i
, NORMAL_BUTTON
, cur_name
, NULL
);
331 add_widget (query_dlg
, button
);
338 /* do resize before running and selecting any widget */
339 send_message (query_dlg
, NULL
, MSG_RESIZE
, 0, NULL
);
341 if (defbutton
!= NULL
)
342 dlg_select_widget (defbutton
);
344 /* run dialog and make result */
345 switch (run_dlg (query_dlg
))
350 result
= query_dlg
->ret_value
- B_USER
;
353 /* free used memory */
354 destroy_dlg (query_dlg
);
358 add_widget_autopos (query_dlg
, label_new (2, 3, text
), WPOS_KEEP_TOP
| WPOS_CENTER_HORZ
,
360 add_widget (query_dlg
, button_new (0, 0, 0, HIDDEN_BUTTON
, "-", NULL
));
361 last_query_dlg
= query_dlg
;
367 /* --------------------------------------------------------------------------------------------- */
370 query_set_sel (int new_sel
)
375 /* --------------------------------------------------------------------------------------------- */
377 * Create message dialog. The caller must call dlg_run_done() and
378 * destroy_dlg() to dismiss it. Not safe to call from background.
382 create_message (int flags
, const char *title
, const char *text
, ...)
388 va_start (args
, text
);
389 p
= g_strdup_vprintf (text
, args
);
392 d
= do_create_message (flags
, title
, p
);
398 /* --------------------------------------------------------------------------------------------- */
399 /** Show message box, background safe */
402 message (int flags
, const char *title
, const char *text
, ...)
408 p
= g_strdup_vprintf (text
, ap
);
411 if (title
== MSG_ERROR
)
414 #ifdef ENABLE_BACKGROUND
415 if (mc_global
.we_are_background
)
420 void (*f
) (int, int *, char *, const char *);
424 wtools_parent_call (func
.p
, NULL
, 3, sizeof (flags
), &flags
, strlen (title
), title
,
428 #endif /* ENABLE_BACKGROUND */
429 fg_message (flags
, title
, p
);
434 /* --------------------------------------------------------------------------------------------- */
436 * Show input dialog, background safe.
438 * If the arguments "header" and "text" should be translated,
439 * that MUST be done by the caller of these wrappers.
443 input_dialog_help (const char *header
, const char *text
, const char *help
,
444 const char *history_name
, const char *def_text
, gboolean strip_password
,
445 input_complete_t completion_flags
)
447 #ifdef ENABLE_BACKGROUND
448 if (mc_global
.we_are_background
)
453 char *(*f
) (const char *, const char *, const char *, const char *, const char *,
454 gboolean
, input_complete_t
);
456 func
.f
= fg_input_dialog_help
;
457 return wtools_parent_call_string (func
.p
, 7,
458 strlen (header
), header
, strlen (text
),
459 text
, strlen (help
), help
,
460 strlen (history_name
), history_name
,
461 strlen (def_text
), def_text
,
462 sizeof (gboolean
), strip_password
,
463 sizeof (input_complete_t
), completion_flags
);
466 #endif /* ENABLE_BACKGROUND */
467 return fg_input_dialog_help (header
, text
, help
, history_name
, def_text
, strip_password
,
471 /* --------------------------------------------------------------------------------------------- */
472 /** Show input dialog with default help, background safe */
475 input_dialog (const char *header
, const char *text
, const char *history_name
, const char *def_text
,
476 input_complete_t completion_flags
)
478 return input_dialog_help (header
, text
, "[Input Line Keys]", history_name
, def_text
, FALSE
,
482 /* --------------------------------------------------------------------------------------------- */
485 input_expand_dialog (const char *header
, const char *text
,
486 const char *history_name
, const char *def_text
,
487 input_complete_t completion_flags
)
492 result
= input_dialog (header
, text
, history_name
, def_text
, completion_flags
);
495 expanded
= tilde_expand (result
);
502 /* --------------------------------------------------------------------------------------------- */