1 /* Dialog box features module for the Midnight Commander
2 Copyright (C) 1994, 1995, 1998, 1999, 2000, 2001, 2002, 2003, 2004,
3 2005, 2007 Free Software Foundation, Inc.
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation; either version 2 of the License, or
8 (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software
17 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
21 * \brief Source: dialog box features module
32 #include "lib/global.h"
34 #include "lib/tty/tty.h"
36 #include "lib/tty/mouse.h"
37 #include "lib/tty/key.h"
38 #include "lib/strutil.h"
40 #include "help.h" /* interactive_display() */
43 #include "execute.h" /* suspend_cmd() */
44 #include "main.h" /* fast_refresh */
45 #include "setup.h" /* mouse_close_dialog */
47 /* Color styles for normal and error dialogs */
51 /* Primitive way to check if the the current dialog is our dialog */
52 /* This is needed by async routines like load_prompt */
53 Dlg_head
*current_dlg
= 0;
55 /* A hook list for idle events */
58 /* left click outside of dialog closes it */
59 int mouse_close_dialog
= 0;
61 static void dlg_broadcast_msg_to (Dlg_head
* h
, widget_msg_t message
, int reverse
, int flags
);
63 /* draw box in window */
65 draw_box (Dlg_head
* h
, int y
, int x
, int ys
, int xs
, gboolean single
)
67 tty_draw_box (h
->y
+ y
, h
->x
+ x
, ys
, xs
, single
);
71 widget_erase (Widget
* w
)
73 tty_fill_region (w
->y
, w
->x
, w
->lines
, w
->cols
, ' ');
77 dlg_erase (Dlg_head
* h
)
80 tty_fill_region (h
->y
, h
->x
, h
->lines
, h
->cols
, ' ');
84 init_widget (Widget
* w
, int y
, int x
, int lines
, int cols
,
85 callback_fn callback
, mouse_h mouse_handler
)
91 w
->callback
= callback
;
92 w
->mouse
= mouse_handler
;
95 /* Almost all widgets want to put the cursor in a suitable place */
96 w
->options
= W_WANT_CURSOR
;
99 /* Clean the dialog area, draw the frame and the title */
101 common_dialog_repaint (struct Dlg_head
*h
)
105 space
= (h
->flags
& DLG_COMPACT
) ? 0 : 1;
107 tty_setcolor (DLG_NORMALC (h
));
109 draw_box (h
, space
, space
, h
->lines
- 2 * space
, h
->cols
- 2 * space
, FALSE
);
113 tty_setcolor (DLG_HOT_NORMALC (h
));
114 dlg_move (h
, space
, (h
->cols
- str_term_width1 (h
->title
)) / 2);
115 tty_print_string (h
->title
);
119 /* this function allows to set dialog position */
121 dlg_set_position (Dlg_head
* h
, int y1
, int x1
, int y2
, int x2
)
123 /* save old positions, will be used to reposition childs */
125 int shift_x
, shift_y
, scale_x
, scale_y
;
127 /* save old positions, will be used to reposition childs */
138 /* values by which controls should be moved */
141 scale_x
= h
->cols
- oc
;
142 scale_y
= h
->lines
- ol
;
144 if (h
->current
== NULL
)
147 if ((shift_x
!= 0) || (shift_y
!= 0) || (scale_x
!= 0) || (scale_y
!= 0))
149 Widget
*c
= h
->current
;
153 /* there are, mainly, 2 generally possible
156 1. control sticks to one side - it
159 2. control sticks to two sides of
160 one direction - it should be sized */
165 int lines
= c
->lines
;
167 if ((c
->pos_flags
& WPOS_KEEP_LEFT
) && (c
->pos_flags
& WPOS_KEEP_RIGHT
))
172 else if (c
->pos_flags
& WPOS_KEEP_LEFT
)
174 else if (c
->pos_flags
& WPOS_KEEP_RIGHT
)
175 x
+= shift_x
+ scale_x
;
177 if ((c
->pos_flags
& WPOS_KEEP_TOP
) && (c
->pos_flags
& WPOS_KEEP_BOTTOM
))
182 else if (c
->pos_flags
& WPOS_KEEP_TOP
)
184 else if (c
->pos_flags
& WPOS_KEEP_BOTTOM
)
185 y
+= shift_y
+ scale_y
;
187 widget_set_size (c
, y
, x
, lines
, cols
);
191 while (h
->current
!= c
);
195 /* this function sets only size, leaving positioning to automatic methods */
197 dlg_set_size (Dlg_head
* h
, int lines
, int cols
)
202 if (h
->flags
& DLG_CENTER
)
204 y
= (LINES
- lines
) / 2;
205 x
= (COLS
- cols
) / 2;
208 if ((h
->flags
& DLG_TRYUP
) && (y
> 3))
211 dlg_set_position (h
, y
, x
, y
+ lines
, x
+ cols
);
214 /* Default dialog callback */
216 default_dlg_callback (Dlg_head
* h
, Widget
* sender
, dlg_msg_t msg
, int parm
, void *data
)
225 if (h
->color
!= NULL
)
227 common_dialog_repaint (h
);
230 return MSG_NOT_HANDLED
;
233 dlg_broadcast_msg_to (h
, WIDGET_IDLE
, 0, W_WANT_IDLE
);
237 /* this is default resizing mechanism */
238 /* the main idea of this code is to resize dialog
239 according to flags (if any of flags require automatic
240 resizing, like DLG_CENTER, end after that reposition
241 controls in dialog according to flags of widget) */
242 dlg_set_size (h
, h
->lines
, h
->cols
);
249 return MSG_NOT_HANDLED
;
253 create_dlg (int y1
, int x1
, int lines
, int cols
, const int *colors
,
254 dlg_cb_fn callback
, const char *help_ctx
, const char *title
, int flags
)
258 new_d
= g_new0 (Dlg_head
, 1);
261 new_d
->color
= g_new (int, DLG_COLOR_NUM
);
262 memmove (new_d
->color
, colors
, sizeof (int) * DLG_COLOR_NUM
);
264 new_d
->help_ctx
= help_ctx
;
265 new_d
->callback
= (callback
!= NULL
) ? callback
: default_dlg_callback
;
268 new_d
->flags
= flags
;
271 dlg_set_size (new_d
, lines
, cols
);
273 /* Strip existing spaces, add one space before and after the title */
278 t
= g_strstrip (g_strdup (title
));
280 new_d
->title
= g_strdup_printf (" %s ", t
);
288 dlg_set_default_colors (void)
290 dialog_colors
[0] = COLOR_NORMAL
;
291 dialog_colors
[1] = COLOR_FOCUS
;
292 dialog_colors
[2] = COLOR_HOT_NORMAL
;
293 dialog_colors
[3] = COLOR_HOT_FOCUS
;
295 alarm_colors
[0] = ERROR_COLOR
;
296 alarm_colors
[1] = REVERSE_COLOR
;
297 alarm_colors
[2] = ERROR_HOT_NORMAL
;
298 alarm_colors
[3] = ERROR_HOT_FOCUS
;
302 set_idle_proc (Dlg_head
* d
, int enable
)
305 d
->flags
|= DLG_WANT_IDLE
;
307 d
->flags
&= ~DLG_WANT_IDLE
;
311 * Insert widget to dialog before current widget. For dialogs populated
312 * from the bottom, make the widget current. Return widget number.
315 add_widget_autopos (Dlg_head
* h
, void *w
, widget_pos_flags_t pos_flags
)
317 Widget
*widget
= (Widget
*) w
;
319 /* Don't accept 0 widgets, and running dialogs */
320 if (!widget
|| h
->running
)
326 widget
->dlg_id
= h
->count
++;
327 widget
->pos_flags
= pos_flags
;
331 widget
->next
= h
->current
;
332 widget
->prev
= h
->current
->prev
;
333 h
->current
->prev
->next
= widget
;
334 h
->current
->prev
= widget
;
338 widget
->prev
= widget
;
339 widget
->next
= widget
;
342 if ((h
->flags
& DLG_REVERSE
) || !h
->current
)
345 return widget
->dlg_id
;
348 /* wrapper to simply add lefttop positioned controls */
350 add_widget (Dlg_head
* h
, void *w
)
352 return add_widget_autopos (h
, w
, WPOS_KEEP_LEFT
| WPOS_KEEP_TOP
);
356 do_complete_refresh (Dlg_head
* dlg
)
358 if (!dlg
->fullscreen
&& dlg
->parent
)
359 do_complete_refresh (dlg
->parent
);
371 dlg_redraw (current_dlg
);
373 do_complete_refresh (current_dlg
);
376 /* broadcast a message to all the widgets in a dialog that have
377 * the options set to flags. If flags is zero, the message is sent
381 dlg_broadcast_msg_to (Dlg_head
* h
, widget_msg_t message
, int reverse
, int flags
)
383 Widget
*p
, *first
, *wi
;
389 first
= p
= h
->current
->prev
;
391 first
= p
= h
->current
->next
;
400 if (flags
== 0 || (flags
& wi
->options
))
401 send_message (wi
, message
, 0);
406 /* broadcast a message to all the widgets in a dialog */
408 dlg_broadcast_msg (Dlg_head
* h
, widget_msg_t message
, int reverse
)
410 dlg_broadcast_msg_to (h
, message
, reverse
, 0);
414 dlg_focus (Dlg_head
* h
)
416 if ((h
->current
!= NULL
) && (send_message (h
->current
, WIDGET_FOCUS
, 0) == MSG_HANDLED
))
418 h
->callback (h
, h
->current
, DLG_FOCUS
, 0, NULL
);
425 dlg_unfocus (Dlg_head
* h
)
427 if ((h
->current
!= NULL
) && (send_message (h
->current
, WIDGET_UNFOCUS
, 0) == MSG_HANDLED
))
429 h
->callback (h
, h
->current
, DLG_UNFOCUS
, 0, NULL
);
436 /* Return true if the windows overlap */
438 dlg_overlap (Widget
* a
, Widget
* b
)
440 if ((b
->x
>= a
->x
+ a
->cols
)
441 || (a
->x
>= b
->x
+ b
->cols
) || (b
->y
>= a
->y
+ a
->lines
) || (a
->y
>= b
->y
+ b
->lines
))
447 /* Find the widget with the given callback in the dialog h */
449 find_widget_type (const Dlg_head
* h
, callback_fn callback
)
453 if ((h
!= NULL
) && (h
->current
!= NULL
))
458 for (i
= 0, item
= h
->current
; i
< h
->count
; i
++, item
= item
->next
)
460 if (item
->callback
== callback
)
471 /* Find the widget with the given dialog id in the dialog h and select it */
473 dlg_select_by_id (const Dlg_head
* h
, int id
)
492 while (w
!= h
->current
);
495 dlg_select_widget (w_found
);
499 /* What to do if the requested widget doesn't take focus */
502 SELECT_NEXT
, /* go the the next widget */
503 SELECT_PREV
, /* go the the previous widget */
504 SELECT_EXACT
/* use current widget */
508 * Try to select another widget. If forward is set, follow tab order.
509 * Otherwise go to the previous widget.
512 do_select_widget (Dlg_head
* h
, Widget
* w
, select_dir_t dir
)
514 Widget
*w0
= h
->current
;
516 if (!dlg_unfocus (h
))
528 h
->current
= h
->current
->next
;
531 h
->current
= h
->current
->prev
;
539 while (h
->current
!= w
);
541 if (dlg_overlap (w0
, h
->current
))
543 send_message (h
->current
, WIDGET_DRAW
, 0);
544 send_message (h
->current
, WIDGET_FOCUS
, 0);
550 * Try to select widget in the dialog.
553 dlg_select_widget (void *w
)
555 do_select_widget (((Widget
*) w
)->parent
, w
, SELECT_NEXT
);
559 /* Try to select previous widget in the tab order */
561 dlg_one_up (Dlg_head
* h
)
564 do_select_widget (h
, h
->current
->prev
, SELECT_PREV
);
568 /* Try to select next widget in the tab order */
570 dlg_one_down (Dlg_head
* h
)
573 do_select_widget (h
, h
->current
->next
, SELECT_NEXT
);
578 update_cursor (Dlg_head
* h
)
580 Widget
*p
= h
->current
;
584 if (p
->options
& W_WANT_CURSOR
)
585 send_message (p
, WIDGET_CURSOR
, 0);
587 while ((p
= p
->next
) != h
->current
)
588 if (p
->options
& W_WANT_CURSOR
)
589 if (send_message (p
, WIDGET_CURSOR
, 0) == MSG_HANDLED
)
594 /* Redraw the widgets in reverse order, leaving the current widget
598 dlg_redraw (Dlg_head
* h
)
600 h
->callback (h
, NULL
, DLG_DRAW
, 0, NULL
);
601 dlg_broadcast_msg (h
, WIDGET_DRAW
, 1);
606 dlg_stop (Dlg_head
* h
)
612 dialog_handle_key (Dlg_head
* h
, int d_key
)
614 if (is_abort_char (d_key
))
616 h
->ret_value
= B_CANCEL
;
625 h
->ret_value
= B_ENTER
;
640 interactive_display (NULL
, h
->help_ctx
);
653 /* Use this if the refreshes fail */
656 #endif /* HAVE_SLANG */
665 dlg_try_hotkey (Dlg_head
* h
, int d_key
)
671 if (h
->current
== NULL
)
672 return MSG_NOT_HANDLED
;
675 * Explanation: we don't send letter hotkeys to other widgets if
676 * the currently selected widget is an input line
679 if (h
->current
->options
& W_IS_INPUT
)
681 /* skip ascii control characters, anything else can valid character in
683 if (d_key
>= 32 && d_key
< 256)
684 return MSG_NOT_HANDLED
;
687 /* If it's an alt key, send the message */
688 c
= d_key
& ~ALT (0);
689 if (d_key
& ALT (0) && g_ascii_isalpha (c
))
690 d_key
= g_ascii_tolower (c
);
692 handled
= MSG_NOT_HANDLED
;
693 if (h
->current
->options
& W_WANT_HOTKEY
)
694 handled
= send_message (h
->current
, WIDGET_HOTKEY
, d_key
);
696 /* If not used, send hotkey to other widgets */
697 if (handled
== MSG_HANDLED
)
700 hot_cur
= h
->current
->next
;
702 /* send it to all widgets */
703 while (h
->current
!= hot_cur
&& handled
== MSG_NOT_HANDLED
)
705 if (hot_cur
->options
& W_WANT_HOTKEY
)
706 handled
= send_message (hot_cur
, WIDGET_HOTKEY
, d_key
);
708 if (handled
== MSG_NOT_HANDLED
)
709 hot_cur
= hot_cur
->next
;
712 if (handled
== MSG_HANDLED
)
713 do_select_widget (h
, hot_cur
, SELECT_EXACT
);
719 dlg_key_event (Dlg_head
* h
, int d_key
)
723 if (h
->current
== NULL
)
726 /* TAB used to cycle */
727 if (!(h
->flags
& DLG_WANT_TAB
))
734 else if (d_key
== KEY_BTAB
)
741 /* first can dlg_callback handle the key */
742 handled
= h
->callback (h
, NULL
, DLG_KEY
, d_key
, NULL
);
744 /* next try the hotkey */
745 if (handled
== MSG_NOT_HANDLED
)
746 handled
= dlg_try_hotkey (h
, d_key
);
748 if (handled
== MSG_HANDLED
)
749 h
->callback (h
, NULL
, DLG_HOTKEY_HANDLED
, 0, NULL
);
751 /* not used - then try widget_callback */
752 handled
= send_message (h
->current
, WIDGET_KEY
, d_key
);
754 /* not used- try to use the unhandled case */
755 if (handled
== MSG_NOT_HANDLED
)
756 handled
= h
->callback (h
, NULL
, DLG_UNHANDLED_KEY
, d_key
, NULL
);
758 if (handled
== MSG_NOT_HANDLED
)
759 dialog_handle_key (h
, d_key
);
761 h
->callback (h
, NULL
, DLG_POST_KEY
, d_key
, NULL
);
765 dlg_mouse_event (Dlg_head
* h
, Gpm_Event
* event
)
768 Widget
*starting_widget
= h
->current
;
773 /* close the dialog by mouse click out of dialog area */
774 if (mouse_close_dialog
&& !h
->fullscreen
&& ((event
->buttons
& GPM_B_LEFT
) != 0) && ((event
->type
& GPM_DOWN
) != 0) /* left click */
775 && !((x
> h
->x
) && (x
<= h
->x
+ h
->cols
) && (y
> h
->y
) && (y
<= h
->y
+ h
->lines
)))
777 h
->ret_value
= B_CANCEL
;
782 item
= starting_widget
;
790 if ((x
> widget
->x
) && (x
<= widget
->x
+ widget
->cols
)
791 && (y
> widget
->y
) && (y
<= widget
->y
+ widget
->lines
))
794 new_event
.x
-= widget
->x
;
795 new_event
.y
-= widget
->y
;
797 if (widget
->mouse
!= NULL
)
798 return widget
->mouse (&new_event
, widget
);
801 while (item
!= starting_widget
);
806 /* Run dialog routines */
808 /* Init the process */
810 init_dlg (Dlg_head
* h
)
812 /* Initialize dialog manager and widgets */
813 h
->callback (h
, NULL
, DLG_INIT
, 0, NULL
);
814 dlg_broadcast_msg (h
, WIDGET_INIT
, 0);
816 if (h
->x
== 0 && h
->y
== 0 && h
->cols
== COLS
&& h
->lines
== LINES
)
819 h
->parent
= current_dlg
;
822 /* Initialize the mouse status */
823 h
->mouse_status
= MOU_NORMAL
;
825 /* Select the first widget that takes focus */
826 while (!dlg_focus (h
) && h
->current
)
827 h
->current
= h
->current
->next
;
829 /* Redraw the screen */
836 /* Shutdown the run_dlg */
838 dlg_run_done (Dlg_head
* h
)
840 if (h
->current
!= NULL
)
841 h
->callback (h
, h
->current
, DLG_END
, 0, NULL
);
843 current_dlg
= h
->parent
;
847 dlg_process_event (Dlg_head
* h
, int key
, Gpm_Event
* event
)
851 if (tty_got_interrupt ())
858 h
->mouse_status
= dlg_mouse_event (h
, event
);
860 dlg_key_event (h
, key
);
864 frontend_run_dlg (Dlg_head
* h
)
873 change_screen_size ();
878 execute_hooks (idle_hook
);
880 while ((h
->flags
& DLG_WANT_IDLE
) && is_idle ())
881 h
->callback (h
, NULL
, DLG_IDLE
, 0, NULL
);
883 /* Allow terminating the dialog from the idle handler */
890 /* Clear interrupt flag */
891 tty_got_interrupt ();
892 d_key
= tty_get_event (&event
, h
->mouse_status
== MOU_REPEAT
, TRUE
);
894 dlg_process_event (h
, d_key
, &event
);
897 h
->callback (h
, NULL
, DLG_VALIDATE
, 0, NULL
);
901 /* Standard run dialog routine
902 * We have to keep this routine small so that we can duplicate it's
903 * behavior on complex routines like the file routines, this way,
904 * they can call the dlg_process_event without rewriting all the code
907 run_dlg (Dlg_head
* h
)
910 frontend_run_dlg (h
);
916 destroy_dlg (Dlg_head
* h
)
921 dlg_broadcast_msg (h
, WIDGET_DESTROY
, 0);
923 for (i
= 0; i
< h
->count
; i
++)
937 widget_set_size (Widget
* widget
, int y
, int x
, int lines
, int cols
)
942 widget
->lines
= lines
;
943 send_message (widget
, WIDGET_RESIZED
, 0 /* unused */ );
946 /* Replace widget old_w for widget new_w in the dialog */
948 dlg_replace_widget (Widget
* old_w
, Widget
* new_w
)
950 Dlg_head
*h
= old_w
->parent
;
951 int should_focus
= 0;
956 if (old_w
== h
->current
)
960 new_w
->dlg_id
= old_w
->dlg_id
;
962 if (old_w
== old_w
->next
)
964 /* just one widget */
970 new_w
->prev
= old_w
->prev
;
971 new_w
->next
= old_w
->next
;
972 old_w
->prev
->next
= new_w
;
973 old_w
->next
->prev
= new_w
;
979 send_message (old_w
, WIDGET_DESTROY
, 0);
980 send_message (new_w
, WIDGET_INIT
, 0);
983 dlg_select_widget (new_w
);
985 send_message (new_w
, WIDGET_DRAW
, 0);