2 Widget based utility functions.
4 Copyright (C) 1994-2016
5 Free Software Foundation, Inc.
8 Miguel de Icaza, 1994, 1995, 1996
9 Radek Doulik, 1994, 1995
11 Andrej Borsenkow, 1995
12 Andrew Borodin <aborodin@vmail.ru>, 2009-2014
14 This file is part of the Midnight Commander.
16 The Midnight Commander is free software: you can redistribute it
17 and/or modify it under the terms of the GNU General Public License as
18 published by the Free Software Foundation, either version 3 of the License,
19 or (at your option) any later version.
21 The Midnight Commander is distributed in the hope that it will be useful,
22 but WITHOUT ANY WARRANTY; without even the implied warranty of
23 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
24 GNU General Public License for more details.
26 You should have received a copy of the GNU General Public License
27 along with this program. If not, see <http://www.gnu.org/licenses/>.
31 * \brief Source: widget based utility functions
39 #include "lib/global.h"
40 #include "lib/tty/tty.h"
41 #include "lib/tty/key.h" /* tty_getch() */
42 #include "lib/strutil.h"
43 #include "lib/util.h" /* tilde_expand() */
44 #include "lib/widget.h"
45 #include "lib/event.h" /* mc_event_raise() */
47 /*** global variables ****************************************************************************/
49 /*** file scope macro definitions ****************************************************************/
51 /*** file scope type declarations ****************************************************************/
53 /*** file scope variables ************************************************************************/
55 static WDialog
*last_query_dlg
;
57 static int sel_pos
= 0;
59 /* --------------------------------------------------------------------------------------------- */
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 ((w
->pos_flags
& WPOS_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
|| (WIDGET (prev_dlg
)->pos_flags
& WPOS_FULLSCREEN
) != 0)
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
, w
->lines
, w
->cols
);
111 return dlg_default_callback (w
, sender
, msg
, parm
, data
);
115 /* --------------------------------------------------------------------------------------------- */
116 /** Create message dialog */
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
, ...)
281 const int *query_colors
= (flags
& D_ERROR
) != 0 ? alarm_colors
: dialog_colors
;
282 widget_pos_flags_t pos_flags
=
283 (flags
& D_CENTER
) != 0 ? (WPOS_CENTER
| WPOS_TRYUP
) : WPOS_KEEP_DEFAULT
;
285 if (header
== MSG_ERROR
)
290 va_start (ap
, count
);
291 for (i
= 0; i
< count
; i
++)
293 char *cp
= va_arg (ap
, char *);
294 win_len
+= str_term_width1 (cp
) + 6;
295 if (strchr (cp
, '&') != NULL
)
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);
308 dlg_create (TRUE
, 0, 0, lines
, cols
, pos_flags
, FALSE
, query_colors
, query_default_callback
,
309 NULL
, "[QueryBox]", header
);
313 WButton
*defbutton
= NULL
;
315 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
++)
326 cur_name
= va_arg (ap
, char *);
327 xpos
= str_term_width1 (cur_name
) + 6;
328 if (strchr (cur_name
, '&') != NULL
)
331 button
= button_new (lines
- 3, cols
, B_USER
+ i
, NORMAL_BUTTON
, cur_name
, NULL
);
332 add_widget (query_dlg
, button
);
339 /* do resize before running and selecting any widget */
340 send_message (query_dlg
, NULL
, MSG_RESIZE
, 0, NULL
);
342 if (defbutton
!= NULL
)
343 widget_select (WIDGET (defbutton
));
345 /* run dialog and make result */
346 switch (dlg_run (query_dlg
))
351 result
= query_dlg
->ret_value
- B_USER
;
354 /* free used memory */
355 dlg_destroy (query_dlg
);
359 add_widget_autopos (query_dlg
, label_new (2, 3, text
), WPOS_KEEP_TOP
| WPOS_CENTER_HORZ
,
361 add_widget (query_dlg
, button_new (0, 0, 0, HIDDEN_BUTTON
, "-", NULL
));
362 last_query_dlg
= query_dlg
;
368 /* --------------------------------------------------------------------------------------------- */
371 query_set_sel (int new_sel
)
376 /* --------------------------------------------------------------------------------------------- */
378 * Create message dialog. The caller must call dlg_run_done() and
379 * dlg_destroy() to dismiss it. Not safe to call from background.
383 create_message (int flags
, const char *title
, const char *text
, ...)
389 va_start (args
, text
);
390 p
= g_strdup_vprintf (text
, args
);
393 d
= do_create_message (flags
, title
, p
);
399 /* --------------------------------------------------------------------------------------------- */
400 /** Show message box, background safe */
403 message (int flags
, const char *title
, const char *text
, ...)
409 p
= g_strdup_vprintf (text
, ap
);
412 if (title
== MSG_ERROR
)
415 #ifdef ENABLE_BACKGROUND
416 if (mc_global
.we_are_background
)
421 void (*f
) (int, int *, char *, const char *);
425 wtools_parent_call (func
.p
, NULL
, 3, sizeof (flags
), &flags
, strlen (title
), title
,
429 #endif /* ENABLE_BACKGROUND */
430 fg_message (flags
, title
, p
);
435 /* --------------------------------------------------------------------------------------------- */
436 /** Show error message box */
439 mc_error_message (GError
** mcerror
, int *code
)
441 if (mcerror
== NULL
|| *mcerror
== NULL
)
444 if ((*mcerror
)->code
== 0)
445 message (D_ERROR
, MSG_ERROR
, "%s", (*mcerror
)->message
);
447 message (D_ERROR
, MSG_ERROR
, _("%s (%d)"), (*mcerror
)->message
, (*mcerror
)->code
);
450 *code
= (*mcerror
)->code
;
452 g_error_free (*mcerror
);
458 /* --------------------------------------------------------------------------------------------- */
460 * Show input dialog, background safe.
462 * If the arguments "header" and "text" should be translated,
463 * that MUST be done by the caller of these wrappers.
467 input_dialog_help (const char *header
, const char *text
, const char *help
,
468 const char *history_name
, const char *def_text
, gboolean strip_password
,
469 input_complete_t completion_flags
)
471 #ifdef ENABLE_BACKGROUND
472 if (mc_global
.we_are_background
)
477 char *(*f
) (const char *, const char *, const char *, const char *, const char *,
478 gboolean
, input_complete_t
);
480 func
.f
= fg_input_dialog_help
;
481 return wtools_parent_call_string (func
.p
, 7,
482 strlen (header
), header
, strlen (text
),
483 text
, strlen (help
), help
,
484 strlen (history_name
), history_name
,
485 strlen (def_text
), def_text
,
486 sizeof (gboolean
), strip_password
,
487 sizeof (input_complete_t
), completion_flags
);
490 #endif /* ENABLE_BACKGROUND */
491 return fg_input_dialog_help (header
, text
, help
, history_name
, def_text
, strip_password
,
495 /* --------------------------------------------------------------------------------------------- */
496 /** Show input dialog with default help, background safe */
499 input_dialog (const char *header
, const char *text
, const char *history_name
, const char *def_text
,
500 input_complete_t completion_flags
)
502 return input_dialog_help (header
, text
, "[Input Line Keys]", history_name
, def_text
, FALSE
,
506 /* --------------------------------------------------------------------------------------------- */
509 input_expand_dialog (const char *header
, const char *text
,
510 const char *history_name
, const char *def_text
,
511 input_complete_t completion_flags
)
515 result
= input_dialog (header
, text
, history_name
, def_text
, completion_flags
);
520 expanded
= tilde_expand (result
);
527 /* --------------------------------------------------------------------------------------------- */
529 * Create status message window object and initialize it
531 * @param title window title
532 * @param delay initial delay to raise window in seconds
533 * @param init_cb callback to initialize user-defined part of status message
534 * @param update_cb callback to update of status message
535 * @param deinit_cb callback to deinitialize user-defined part of status message
537 * @return newly allocate status message window
541 status_msg_create (const char *title
, double delay
, status_msg_cb init_cb
,
542 status_msg_update_cb update_cb
, status_msg_cb deinit_cb
)
546 sm
= g_try_new (status_msg_t
, 1);
547 status_msg_init (sm
, title
, delay
, init_cb
, update_cb
, deinit_cb
);
552 /* --------------------------------------------------------------------------------------------- */
554 * Destroy status message window object
556 * @param sm status message window object
560 status_msg_destroy (status_msg_t
* sm
)
562 status_msg_deinit (sm
);
566 /* --------------------------------------------------------------------------------------------- */
568 * Initialize already created status message window object
570 * @param sm status message window object
571 * @param title window title
572 * @param delay initial delay to raise window in seconds
573 * @param init_cb callback to initialize user-defined part of status message
574 * @param update_cb callback to update of status message
575 * @param deinit_cb callback to deinitialize user-defined part of status message
579 status_msg_init (status_msg_t
* sm
, const char *title
, double delay
, status_msg_cb init_cb
,
580 status_msg_update_cb update_cb
, status_msg_cb deinit_cb
)
584 /* repaint screen to remove previous finished dialog */
587 start
= mc_timer_elapsed (mc_global
.timer
);
589 sm
->dlg
= dlg_create (TRUE
, 0, 0, 7, MIN (MAX (40, COLS
/ 2), COLS
), WPOS_CENTER
, FALSE
,
590 dialog_colors
, NULL
, NULL
, NULL
, title
);
592 sm
->delay
= (guint64
) (delay
* G_USEC_PER_SEC
);
596 sm
->update
= update_cb
;
597 sm
->deinit
= deinit_cb
;
599 if (sm
->init
!= NULL
)
602 if (mc_time_elapsed (&start
, sm
->delay
))
604 /* We will manage the dialog without any help, that's why we have to call dlg_init */
609 /* --------------------------------------------------------------------------------------------- */
611 * Deinitialize status message window object
613 * @param sm status message window object
617 status_msg_deinit (status_msg_t
* sm
)
622 if (sm
->deinit
!= NULL
)
625 /* close and destroy dialog */
626 dlg_run_done (sm
->dlg
);
627 dlg_destroy (sm
->dlg
);
630 /* --------------------------------------------------------------------------------------------- */
632 * Update status message window
634 * @param sm status message window object
636 * @return value of pressed key
640 status_msg_common_update (status_msg_t
* sm
)
648 /* This should not happen, but... */
652 if (widget_get_state (WIDGET (sm
->dlg
), WST_CONSTRUCT
))
654 /* dialog is not shown yet */
656 /* do not change sm->start */
657 guint64 start
= sm
->start
;
659 if (mc_time_elapsed (&start
, sm
->delay
))
665 event
.x
= -1; /* Don't show the GPM cursor */
666 c
= tty_get_event (&event
, FALSE
, sm
->block
);
670 /* Reinitialize by non-B_CANCEL value to avoid old values
671 after events other than selecting a button */
672 sm
->dlg
->ret_value
= B_ENTER
;
673 dlg_process_event (sm
->dlg
, c
, &event
);
675 return sm
->dlg
->ret_value
;
678 /* --------------------------------------------------------------------------------------------- */
680 * Callback to initialize already created simple status message window object
682 * @param sm status message window object
686 simple_status_msg_init_cb (status_msg_t
* sm
)
688 simple_status_msg_t
*ssm
= SIMPLE_STATUS_MSG (sm
);
689 Widget
*wd
= WIDGET (sm
->dlg
);
691 const char *b_name
= N_("&Abort");
700 b_width
= str_term_width1 (b_name
) + 4;
701 wd_width
= MAX (wd
->cols
, b_width
+ 6);
704 ssm
->label
= label_new (y
++, 3, "");
705 add_widget_autopos (sm
->dlg
, ssm
->label
, WPOS_KEEP_TOP
| WPOS_CENTER_HORZ
, NULL
);
706 add_widget (sm
->dlg
, hline_new (y
++, -1, -1));
707 b
= WIDGET (button_new (y
++, 3, B_CANCEL
, NORMAL_BUTTON
, b_name
, NULL
));
708 add_widget_autopos (sm
->dlg
, b
, WPOS_KEEP_TOP
| WPOS_CENTER_HORZ
, NULL
);
710 widget_set_size (wd
, wd
->y
, wd
->x
, y
+ 2, wd_width
);
713 /* --------------------------------------------------------------------------------------------- */