The following changes consolidates the fringe handling from
[bpt/emacs.git] / src / gtkutil.c
CommitLineData
f392e843
JD
1/* Functions for creating and updating GTK widgets.
2 Copyright (C) 2003
3 Free Software Foundation, Inc.
4
5This file is part of GNU Emacs.
6
7GNU Emacs is free software; you can redistribute it and/or modify
8it under the terms of the GNU General Public License as published by
9the Free Software Foundation; either version 2, or (at your option)
10any later version.
11
12GNU Emacs is distributed in the hope that it will be useful,
13but WITHOUT ANY WARRANTY; without even the implied warranty of
14MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15GNU General Public License for more details.
16
17You should have received a copy of the GNU General Public License
18along with GNU Emacs; see the file COPYING. If not, write to
19the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20Boston, MA 02111-1307, USA. */
21
22#include "config.h"
23
24#ifdef USE_GTK
e8794476
JD
25#include <string.h>
26#include <stdio.h>
f392e843
JD
27#include "lisp.h"
28#include "xterm.h"
29#include "blockinput.h"
30#include "window.h"
31#include "atimer.h"
32#include "gtkutil.h"
33#include "termhooks.h"
f392e843
JD
34#include <gdk/gdkkeysyms.h>
35
36#define FRAME_TOTAL_PIXEL_HEIGHT(f) \
37 (PIXEL_HEIGHT (f) + FRAME_MENUBAR_HEIGHT (f) + FRAME_TOOLBAR_HEIGHT (f))
38\f
39/***********************************************************************
40 Utility functions
41 ***********************************************************************/
42/* The timer for scroll bar repetition and menu bar timeouts.
43 NULL if no timer is started. */
44static struct atimer *xg_timer;
45
46/* The cursor used for scroll bars and popup menus.
47 We only have one cursor for all scroll bars and all popup menus. */
48static GdkCursor *xg_left_ptr_cursor;
49
50
51/* The next two variables and functions are taken from lwlib. */
52static widget_value *widget_value_free_list;
53static int malloc_cpt;
54
55/* Allocate a widget_value structure, either by taking one from the
56 widget_value_free_list or by malloc:ing a new one.
57
58 Return a pointer to the allocated structure. */
59widget_value *
60malloc_widget_value ()
61{
62 widget_value *wv;
63 if (widget_value_free_list)
64 {
65 wv = widget_value_free_list;
66 widget_value_free_list = wv->free_list;
67 wv->free_list = 0;
68 }
69 else
70 {
71 wv = (widget_value *) malloc (sizeof (widget_value));
72 malloc_cpt++;
73 }
74 memset (wv, 0, sizeof (widget_value));
75 return wv;
76}
77
78/* This is analogous to free. It frees only what was allocated
79 by malloc_widget_value, and no substructures. */
80void
81free_widget_value (wv)
82 widget_value *wv;
83{
84 if (wv->free_list)
85 abort ();
86
87 if (malloc_cpt > 25)
88 {
89 /* When the number of already allocated cells is too big,
90 We free it. */
91 free (wv);
92 malloc_cpt--;
93 }
94 else
95 {
96 wv->free_list = widget_value_free_list;
97 widget_value_free_list = wv;
98 }
99}
100
101/* Set *CURSOR on W and all widgets W contain. We must do like this
102 for scroll bars and menu because they create widgets internally,
103 and it is those widgets that are visible.
104
105 If *CURSOR is NULL, create a GDK_LEFT_PTR cursor and set *CURSOR to
106 the created cursor. */
107void
108xg_set_cursor (w, cursor)
109 GtkWidget *w;
110 GdkCursor **cursor;
111{
112 GList *children = gdk_window_peek_children (w->window);
113
114 /* Create the cursor unless already created. */
115 if (! *cursor)
116 *cursor = gdk_cursor_new (GDK_LEFT_PTR);
117
118 gdk_window_set_cursor (w->window, *cursor);
119
120 /* The scroll bar widget has more than one GDK window (had to look at
121 the source to figure this out), and there is no way to set cursor
122 on widgets in GTK. So we must set the cursor for all GDK windows.
123 Ditto for menus. */
124
125 for ( ; children; children = g_list_next (children))
126 gdk_window_set_cursor (GDK_WINDOW (children->data), *cursor);
127}
128
129/* Timer function called when a timeout occurs for xg_timer.
130 This function processes all GTK events in a recursive event loop.
131 This is done because GTK timer events are not seen by Emacs event
132 detection, Emacs only looks for X events. When a scroll bar has the
133 pointer (detected by button press/release events below) an Emacs
134 timer is started, and this function can then check if the GTK timer
135 has expired by calling the GTK event loop.
136 Also, when a menu is active, it has a small timeout before it
137 pops down the sub menu under it. */
138static void
139xg_process_timeouts (timer)
140 struct atimer *timer;
141{
142 BLOCK_INPUT;
143 /* Ideally we would like to just handle timer events, like the Xt version
144 of this does in xterm.c, but there is no such feature in GTK. */
145 while (gtk_events_pending ())
146 gtk_main_iteration ();
147 UNBLOCK_INPUT;
148}
149
150/* Start the xg_timer with an interval of 0.1 seconds, if not already started.
151 xg_process_timeouts is called when the timer expires. The timer
152 stared is continuous, i.e. runs until xg_stop_timer is called. */
153static void
154xg_start_timer ()
155{
156 if (! xg_timer)
157 {
158 EMACS_TIME interval;
159 EMACS_SET_SECS_USECS (interval, 0, 100000);
160 xg_timer = start_atimer (ATIMER_CONTINUOUS,
161 interval,
162 xg_process_timeouts,
163 0);
164 }
165}
166
167/* Stop the xg_timer if started. */
168static void
169xg_stop_timer ()
170{
171 if (xg_timer)
172 {
173 cancel_atimer (xg_timer);
174 xg_timer = 0;
175 }
176}
177
178/* Insert NODE into linked LIST. */
179static void
180xg_list_insert (xg_list_node *list, xg_list_node *node)
181{
182 xg_list_node *list_start = list->next;
177c0ea7 183
f392e843
JD
184 if (list_start) list_start->prev = node;
185 node->next = list_start;
186 node->prev = 0;
187 list->next = node;
188}
189
190/* Remove NODE from linked LIST. */
191static void
192xg_list_remove (xg_list_node *list, xg_list_node *node)
193{
194 xg_list_node *list_start = list->next;
195 if (node == list_start)
196 {
197 list->next = node->next;
198 if (list->next) list->next->prev = 0;
199 }
200 else
201 {
202 node->prev->next = node->next;
203 if (node->next) node->next->prev = node->prev;
204 }
205}
206
207/* Allocate and return a utf8 version of STR. If STR is already
208 utf8 or NULL, just return STR.
209 If not, a new string is allocated and the caller must free the result
210 with g_free. */
211static char *
212get_utf8_string (str)
213 char *str;
214{
215 char *utf8_str = str;
177c0ea7 216
f392e843
JD
217 /* If not UTF-8, try current locale. */
218 if (str && !g_utf8_validate (str, -1, NULL))
219 utf8_str = g_locale_to_utf8 (str, -1, 0, 0, 0);
220
221 return utf8_str;
222}
223
224
225\f
226/***********************************************************************
227 General functions for creating widgets, resizing, events, e.t.c.
228 ***********************************************************************/
229
230/* Make a geometry string and pass that to GTK. It seems this is the
231 only way to get geometry position right if the user explicitly
232 asked for a position when starting Emacs.
233 F is the frame we shall set geometry for. */
234static void
235xg_set_geometry (f)
236 FRAME_PTR f;
237{
238 if (f->output_data.x->size_hint_flags & USPosition)
239 {
240 int left = f->output_data.x->left_pos;
241 int xneg = f->output_data.x->size_hint_flags & XNegative;
242 int top = f->output_data.x->top_pos;
243 int yneg = f->output_data.x->size_hint_flags & YNegative;
244 char geom_str[32];
177c0ea7 245
f392e843
JD
246 if (xneg)
247 left = -left;
248 if (yneg)
249 top = -top;
250
251 sprintf (geom_str, "=%dx%d%c%d%c%d",
252 PIXEL_WIDTH (f),
253 FRAME_TOTAL_PIXEL_HEIGHT (f),
254 (xneg ? '-' : '+'), left,
255 (yneg ? '-' : '+'), top);
256
257 if (!gtk_window_parse_geometry (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)),
258 geom_str))
259 fprintf (stderr, "Failed to parse: '%s'\n", geom_str);
260 }
261}
262
177c0ea7 263
f392e843
JD
264/* Resize the outer window of frame F after chainging the height.
265 This happend when the menu bar or the tool bar is added or removed.
266 COLUMNS/ROWS is the size the edit area shall have after the resize. */
267static void
268xg_resize_outer_widget (f, columns, rows)
269 FRAME_PTR f;
270 int columns;
271 int rows;
272{
273 gtk_window_resize (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)),
274 PIXEL_WIDTH (f), FRAME_TOTAL_PIXEL_HEIGHT (f));
275
276 /* base_height is now changed. */
277 x_wm_set_size_hint (f, 0, 0);
278
279 /* If we are not mapped yet, set geometry once again, as window
280 height now have changed. */
281 if (! GTK_WIDGET_MAPPED (FRAME_GTK_OUTER_WIDGET (f)))
282 xg_set_geometry (f);
283
284 xg_frame_set_char_size (f, columns, rows);
285 gdk_window_process_all_updates ();
286}
287
288/* Function to handle resize of our widgets. Since Emacs has some layouts
289 that does not fit well with GTK standard containers, we do most layout
290 manually.
291 F is the frame to resize.
292 PIXELWIDTH, PIXELHEIGHT is the new size in pixels. */
293void
294xg_resize_widgets (f, pixelwidth, pixelheight)
295 FRAME_PTR f;
296 int pixelwidth, pixelheight;
297{
298 int mbheight = FRAME_MENUBAR_HEIGHT (f);
299 int tbheight = FRAME_TOOLBAR_HEIGHT (f);
300 int rows = PIXEL_TO_CHAR_HEIGHT (f, pixelheight - mbheight - tbheight);
301 int columns = PIXEL_TO_CHAR_WIDTH (f, pixelwidth);
177c0ea7 302
f392e843
JD
303 if (FRAME_GTK_WIDGET (f)
304 && (columns != FRAME_WIDTH (f) || rows != FRAME_HEIGHT (f)
305 || pixelwidth != PIXEL_WIDTH (f) || pixelheight != PIXEL_HEIGHT (f)))
306 {
307 struct x_output *x = f->output_data.x;
308 GtkAllocation all;
309
310 all.y = mbheight + tbheight;
311 all.x = 0;
312
313 all.width = pixelwidth;
314 all.height = pixelheight - mbheight - tbheight;
315
316 gtk_widget_size_allocate (x->edit_widget, &all);
317 gdk_window_process_all_updates ();
318
319 change_frame_size (f, rows, columns, 0, 1, 0);
320 SET_FRAME_GARBAGED (f);
321 cancel_mouse_face (f);
322 }
323}
324
325
326/* Update our widget size to be COLS/ROWS characters for frame F. */
327void
328xg_frame_set_char_size (f, cols, rows)
329 FRAME_PTR f;
330 int cols;
331 int rows;
332{
333 int pixelheight = CHAR_TO_PIXEL_HEIGHT (f, rows)
334 + FRAME_MENUBAR_HEIGHT (f) + FRAME_TOOLBAR_HEIGHT (f);
335 int pixelwidth = CHAR_TO_PIXEL_WIDTH (f, cols);
177c0ea7 336
f392e843
JD
337 /* Take into account the size of the scroll bar. Always use the
338 number of columns occupied by the scroll bar here otherwise we
339 might end up with a frame width that is not a multiple of the
340 frame's character width which is bad for vertically split
341 windows. */
342 f->output_data.x->vertical_scroll_bar_extra
343 = (!FRAME_HAS_VERTICAL_SCROLL_BARS (f)
344 ? 0
345 : (FRAME_SCROLL_BAR_COLS (f)
346 * FONT_WIDTH (f->output_data.x->font)));
347
348 x_compute_fringe_widths (f, 0);
349
350 /* Must resize our top level widget. Font size may have changed,
351 but not rows/cols. */
352 gtk_window_resize (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)),
353 pixelwidth, pixelheight);
354 xg_resize_widgets (f, pixelwidth, pixelheight);
355}
356
357/* Convert an X Window WSESC to its corresponding GtkWidget.
358 Must be done like this, because GtkWidget:s can have "hidden"
359 X Window that aren't accessible.
360
361 Return 0 if no widget match WDESC. */
362GtkWidget *
363xg_win_to_widget (wdesc)
364 Window wdesc;
365{
366 gpointer gdkwin;
367 GtkWidget *gwdesc = 0;
368
369 BLOCK_INPUT;
370 gdkwin = gdk_xid_table_lookup (wdesc);
371 if (gdkwin)
372 {
373 GdkEvent event;
374 event.any.window = gdkwin;
375 gwdesc = gtk_get_event_widget (&event);
376 }
177c0ea7 377
f392e843
JD
378 UNBLOCK_INPUT;
379 return gwdesc;
380}
381
382/* Fill in the GdkColor C so that it represents PIXEL.
383 W is the widget that color will be used for. Used to find colormap. */
384static void
385xg_pix_to_gcolor (w, pixel, c)
386 GtkWidget *w;
387 unsigned long pixel;
388 GdkColor *c;
389{
390 GdkColormap *map = gtk_widget_get_colormap (w);
391 gdk_colormap_query_color (map, pixel, c);
392}
393
394/* Create and set up the GTK widgets for frame F.
395 Return 0 if creation failed, non-zero otherwise. */
396int
397xg_create_frame_widgets (f)
398 FRAME_PTR f;
399{
400 GtkWidget *wtop;
401 GtkWidget *wvbox;
402 GtkWidget *wfixed;
403 GdkColor bg;
404 GtkRcStyle *style;
405 int i;
406 char *title = 0;
177c0ea7 407
f392e843
JD
408 BLOCK_INPUT;
409
410 wtop = gtk_window_new (GTK_WINDOW_TOPLEVEL);
411 wvbox = gtk_vbox_new (FALSE, 0);
412 wfixed = gtk_fixed_new (); /* Must have this to place scroll bars */
177c0ea7 413
f392e843
JD
414 if (! wtop || ! wvbox || ! wfixed)
415 {
416 if (wtop) gtk_widget_destroy (wtop);
417 if (wvbox) gtk_widget_destroy (wvbox);
418 if (wfixed) gtk_widget_destroy (wfixed);
419
420 return 0;
421 }
422
423 /* Use same names as the Xt port does. I.e. Emacs.pane.emacs by default */
424 gtk_widget_set_name (wtop, EMACS_CLASS);
425 gtk_widget_set_name (wvbox, "pane");
426 gtk_widget_set_name (wfixed, SDATA (Vx_resource_name));
427
428 /* If this frame has a title or name, set it in the title bar. */
429 if (! NILP (f->title)) title = SDATA (f->title);
430 else if (! NILP (f->name)) title = SDATA (f->name);
431
432 if (title) gtk_window_set_title (GTK_WINDOW (wtop), title);
177c0ea7 433
f392e843
JD
434 FRAME_GTK_OUTER_WIDGET (f) = wtop;
435 FRAME_GTK_WIDGET (f) = wfixed;
436 f->output_data.x->vbox_widget = wvbox;
437
438 gtk_fixed_set_has_window (GTK_FIXED (wfixed), TRUE);
439
440 gtk_widget_set_size_request (wfixed,
441 PIXEL_WIDTH (f),
442 PIXEL_HEIGHT (f));
177c0ea7 443
f392e843
JD
444 gtk_container_add (GTK_CONTAINER (wtop), wvbox);
445 gtk_box_pack_end (GTK_BOX (wvbox), wfixed, TRUE, TRUE, 0);
446
447 if (FRAME_EXTERNAL_TOOL_BAR (f))
448 update_frame_tool_bar (f);
449
450 /* The tool bar is created but first there are no items in it.
451 This causes it to be zero height. Later items are added, but then
452 the frame is already mapped, so there is a "jumping" resize.
453 This makes geometry handling difficult, for example -0-0 will end
454 up in the wrong place as tool bar height has not been taken into account.
455 So we cheat a bit by setting a height that is what it will have
456 later on when tool bar items are added. */
b73e73bf 457 if (FRAME_EXTERNAL_TOOL_BAR (f) && FRAME_TOOLBAR_HEIGHT (f) == 0)
f392e843 458 FRAME_TOOLBAR_HEIGHT (f) = 34;
177c0ea7 459
f392e843
JD
460 gtk_widget_set_double_buffered (wvbox, FALSE);
461 gtk_widget_set_double_buffered (wfixed, FALSE);
462 gtk_widget_set_double_buffered (wtop, FALSE);
177c0ea7 463
f392e843
JD
464 /* GTK documents says use gtk_window_set_resizable. But then a user
465 can't shrink the window from its starting size. */
466 gtk_window_set_policy (GTK_WINDOW (wtop), TRUE, TRUE, TRUE);
467 gtk_window_set_wmclass (GTK_WINDOW (wtop),
468 SDATA (Vx_resource_name),
469 SDATA (Vx_resource_class));
470
471 /* Add callback to do nothing on WM_DELETE_WINDOW. The default in
472 GTK is to destroy the widget. We want Emacs to do that instead. */
473 g_signal_connect (G_OBJECT (wtop), "delete-event",
474 G_CALLBACK (gtk_true), 0);
177c0ea7 475
f392e843
JD
476 /* Convert our geometry parameters into a geometry string
477 and specify it.
478 GTK will itself handle calculating the real position this way. */
479 xg_set_geometry (f);
480
481 gtk_widget_add_events (wfixed,
482 GDK_POINTER_MOTION_MASK
483 | GDK_EXPOSURE_MASK
484 | GDK_BUTTON_PRESS_MASK
485 | GDK_BUTTON_RELEASE_MASK
486 | GDK_KEY_PRESS_MASK
487 | GDK_ENTER_NOTIFY_MASK
488 | GDK_LEAVE_NOTIFY_MASK
489 | GDK_FOCUS_CHANGE_MASK
490 | GDK_STRUCTURE_MASK
491 | GDK_VISIBILITY_NOTIFY_MASK);
492
493 /* Must realize the windows so the X window gets created. It is used
494 by callers of this function. */
495 gtk_widget_realize (wfixed);
496 FRAME_X_WINDOW (f) = GTK_WIDGET_TO_X_WIN (wfixed);
497
498 /* Since GTK clears its window by filling with the background color,
499 we must keep X and GTK background in sync. */
500 xg_pix_to_gcolor (wfixed, f->output_data.x->background_pixel, &bg);
501 gtk_widget_modify_bg (wfixed, GTK_STATE_NORMAL, &bg);
502
503 /* Also, do not let any background pixmap to be set, this looks very
504 bad as Emacs overwrites the background pixmap with its own idea
505 of background color. */
506 style = gtk_widget_get_modifier_style (wfixed);
507
508 /* Must use g_strdup because gtk_widget_modify_style does g_free. */
509 style->bg_pixmap_name[GTK_STATE_NORMAL] = g_strdup ("<none>");
510 gtk_widget_modify_style (wfixed, style);
177c0ea7 511
f392e843
JD
512 /* GTK does not set any border, and they look bad with GTK. */
513 f->output_data.x->border_width = 0;
514 f->output_data.x->internal_border_width = 0;
515
516 UNBLOCK_INPUT;
517
518 return 1;
519}
520
521/* Set the normal size hints for the window manager, for frame F.
522 FLAGS is the flags word to use--or 0 meaning preserve the flags
523 that the window now has.
524 If USER_POSITION is nonzero, we set the User Position
525 flag (this is useful when FLAGS is 0). */
526void
527x_wm_set_size_hint (f, flags, user_position)
528 FRAME_PTR f;
529 long flags;
530 int user_position;
531{
532 if (FRAME_GTK_OUTER_WIDGET (f))
533 {
534 /* Must use GTK routines here, otherwise GTK resets the size hints
535 to its own defaults. */
536 GdkGeometry size_hints;
537 gint hint_flags = 0;
538 int base_width, base_height;
539 int min_rows = 0, min_cols = 0;
540 int win_gravity = f->output_data.x->win_gravity;
177c0ea7 541
f392e843
JD
542 if (flags)
543 {
544 memset (&size_hints, 0, sizeof (size_hints));
545 f->output_data.x->size_hints = size_hints;
546 f->output_data.x->hint_flags = hint_flags;
547 }
548 else
549 flags = f->output_data.x->size_hint_flags;
177c0ea7 550
f392e843
JD
551 size_hints = f->output_data.x->size_hints;
552 hint_flags = f->output_data.x->hint_flags;
553
554 hint_flags |= GDK_HINT_RESIZE_INC | GDK_HINT_MIN_SIZE;
555 size_hints.width_inc = FONT_WIDTH (f->output_data.x->font);
556 size_hints.height_inc = f->output_data.x->line_height;
557
558 hint_flags |= GDK_HINT_BASE_SIZE;
559 base_width = CHAR_TO_PIXEL_WIDTH (f, 0);
560 base_height = CHAR_TO_PIXEL_HEIGHT (f, 0)
561 + FRAME_MENUBAR_HEIGHT (f) + FRAME_TOOLBAR_HEIGHT (f);
562
563 check_frame_size (f, &min_rows, &min_cols);
564
565 size_hints.base_width = base_width;
566 size_hints.base_height = base_height;
567 size_hints.min_width = base_width + min_cols * size_hints.width_inc;
568 size_hints.min_height = base_height + min_rows * size_hints.height_inc;
569
177c0ea7 570
f392e843
JD
571 /* These currently have a one to one mapping with the X values, but I
572 don't think we should rely on that. */
573 hint_flags |= GDK_HINT_WIN_GRAVITY;
574 size_hints.win_gravity = 0;
575 if (win_gravity == NorthWestGravity)
576 size_hints.win_gravity = GDK_GRAVITY_NORTH_WEST;
577 else if (win_gravity == NorthGravity)
578 size_hints.win_gravity = GDK_GRAVITY_NORTH;
579 else if (win_gravity == NorthEastGravity)
580 size_hints.win_gravity = GDK_GRAVITY_NORTH_EAST;
581 else if (win_gravity == WestGravity)
582 size_hints.win_gravity = GDK_GRAVITY_WEST;
583 else if (win_gravity == CenterGravity)
584 size_hints.win_gravity = GDK_GRAVITY_CENTER;
585 else if (win_gravity == EastGravity)
586 size_hints.win_gravity = GDK_GRAVITY_EAST;
587 else if (win_gravity == SouthWestGravity)
588 size_hints.win_gravity = GDK_GRAVITY_SOUTH_WEST;
589 else if (win_gravity == SouthGravity)
590 size_hints.win_gravity = GDK_GRAVITY_SOUTH;
591 else if (win_gravity == SouthEastGravity)
592 size_hints.win_gravity = GDK_GRAVITY_SOUTH_EAST;
593 else if (win_gravity == StaticGravity)
594 size_hints.win_gravity = GDK_GRAVITY_STATIC;
595
596 if (flags & PPosition) hint_flags |= GDK_HINT_POS;
597 if (flags & USPosition) hint_flags |= GDK_HINT_USER_POS;
598 if (flags & USSize) hint_flags |= GDK_HINT_USER_SIZE;
599
600 if (user_position)
601 {
602 hint_flags &= ~GDK_HINT_POS;
603 hint_flags |= GDK_HINT_USER_POS;
604 }
605
606 BLOCK_INPUT;
607
608 gtk_window_set_geometry_hints (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)),
609 FRAME_GTK_OUTER_WIDGET (f),
610 &size_hints,
611 hint_flags);
612
613 f->output_data.x->size_hints = size_hints;
614 f->output_data.x->hint_flags = hint_flags;
615 UNBLOCK_INPUT;
616 }
617}
618
619/* Change background color of a frame.
620 Since GTK uses the background colour to clear the window, we must
621 keep the GTK and X colors in sync.
622 F is the frame to change,
623 BG is the pixel value to change to. */
624void
625xg_set_background_color (f, bg)
626 FRAME_PTR f;
627 unsigned long bg;
628{
629 if (FRAME_GTK_WIDGET (f))
630 {
631 GdkColor gdk_bg;
632
633 BLOCK_INPUT;
634 xg_pix_to_gcolor (FRAME_GTK_WIDGET (f), bg, &gdk_bg);
635 gtk_widget_modify_bg (FRAME_GTK_WIDGET (f), GTK_STATE_NORMAL, &gdk_bg);
636 UNBLOCK_INPUT;
637 }
638}
639
640
641\f
642/***********************************************************************
643 Dialog functions
644 ***********************************************************************/
645/* Return the dialog title to use for a dialog of type KEY.
646 This is the encoding used by lwlib. We use the same for GTK. */
647static char *
648get_dialog_title (char key)
649{
650 char *title = "";
177c0ea7 651
f392e843
JD
652 switch (key) {
653 case 'E': case 'e':
654 title = "Error";
655 break;
656
657 case 'I': case 'i':
658 title = "Information";
659 break;
660
661 case 'L': case 'l':
662 title = "Prompt";
663 break;
664
665 case 'P': case 'p':
666 title = "Prompt";
667 break;
668
669 case 'Q': case 'q':
670 title = "Question";
671 break;
672 }
673
674 return title;
675}
676
677/* Callback for dialogs that get WM_DELETE_WINDOW. We pop down
678 the dialog, but return TRUE so the event does not propagate further
679 in GTK. This prevents GTK from destroying the dialog widget automatically
680 and we can always destrou the widget manually, regardles of how
681 it was popped down (button press or WM_DELETE_WINDOW).
682 W is the dialog widget.
683 EVENT is the GdkEvent that represents WM_DELETE_WINDOW (not used).
684 user_data is NULL (not used).
685
686 Returns TRUE to end propagation of event. */
687static gboolean
688dialog_delete_callback (w, event, user_data)
689 GtkWidget *w;
690 GdkEvent *event;
691 gpointer user_data;
692{
693 gtk_widget_unmap (w);
694 return TRUE;
695}
696
697/* Create a popup dialog window. See also xg_create_widget below.
698 WV is a widget_value describing the dialog.
699 SELECT_CB is the callback to use when a button has been pressed.
700 DEACTIVATE_CB is the callback to use when the dialog pops down.
701
702 Returns the GTK dialog widget. */
703static GtkWidget *
704create_dialog (wv, select_cb, deactivate_cb)
705 widget_value *wv;
706 GCallback select_cb;
707 GCallback deactivate_cb;
708{
709 char *title = get_dialog_title (wv->name[0]);
710 int total_buttons = wv->name[1] - '0';
711 int right_buttons = wv->name[4] - '0';
712 int left_buttons;
713 int button_nr = 0;
714 int button_spacing = 10;
715 GtkWidget *wdialog = gtk_dialog_new ();
716 widget_value *item;
717 GtkBox *cur_box;
718 GtkWidget *wvbox;
719 GtkWidget *whbox_up;
720 GtkWidget *whbox_down;
721
722 /* If the number of buttons is greater than 4, make two rows of buttons
723 instead. This looks better. */
724 int make_two_rows = total_buttons > 4;
725
726 if (right_buttons == 0) right_buttons = total_buttons/2;
727 left_buttons = total_buttons - right_buttons;
728
729 gtk_window_set_title (GTK_WINDOW (wdialog), title);
730 gtk_widget_set_name (wdialog, "emacs-dialog");
731
732 cur_box = GTK_BOX (GTK_DIALOG (wdialog)->action_area);
733
734 if (make_two_rows)
735 {
736 wvbox = gtk_vbox_new (TRUE, button_spacing);
737 whbox_up = gtk_hbox_new (FALSE, 0);
738 whbox_down = gtk_hbox_new (FALSE, 0);
739
740 gtk_box_pack_start (cur_box, wvbox, FALSE, FALSE, 0);
741 gtk_box_pack_start (GTK_BOX (wvbox), whbox_up, FALSE, FALSE, 0);
742 gtk_box_pack_start (GTK_BOX (wvbox), whbox_down, FALSE, FALSE, 0);
743
744 cur_box = GTK_BOX (whbox_up);
745 }
746
747 g_signal_connect (G_OBJECT (wdialog), "delete-event",
748 G_CALLBACK (dialog_delete_callback), 0);
177c0ea7 749
f392e843
JD
750 if (deactivate_cb)
751 {
752 g_signal_connect (G_OBJECT (wdialog), "close", deactivate_cb, 0);
753 g_signal_connect (G_OBJECT (wdialog), "response", deactivate_cb, 0);
754 }
755
756 for (item = wv->contents; item; item = item->next)
757 {
758 char *utf8_label = get_utf8_string (item->value);
759 GtkWidget *w;
760 GtkRequisition req;
761
0a1d6de0 762 if (item->name && strcmp (item->name, "message") == 0)
f392e843
JD
763 {
764 /* This is the text part of the dialog. */
765 w = gtk_label_new (utf8_label);
766 gtk_box_pack_start (GTK_BOX (GTK_DIALOG (wdialog)->vbox),
767 gtk_label_new (""),
768 FALSE, FALSE, 0);
769 gtk_box_pack_start (GTK_BOX (GTK_DIALOG (wdialog)->vbox), w,
770 TRUE, TRUE, 0);
771 gtk_misc_set_alignment (GTK_MISC (w), 0.1, 0.5);
772
773 /* Try to make dialog look better. Must realize first so
774 the widget can calculate the size it needs. */
775 gtk_widget_realize (w);
776 gtk_widget_size_request (w, &req);
777 gtk_box_set_spacing (GTK_BOX (GTK_DIALOG (wdialog)->vbox),
778 req.height);
0a1d6de0 779 if (item->value && strlen (item->value) > 0)
f392e843
JD
780 button_spacing = 2*req.width/strlen (item->value);
781 }
782 else
783 {
784 /* This is one button to add to the dialog. */
785 w = gtk_button_new_with_mnemonic (utf8_label);
786 if (! item->enabled)
787 gtk_widget_set_sensitive (w, FALSE);
788 if (select_cb)
789 g_signal_connect (G_OBJECT (w), "clicked",
790 select_cb, item->call_data);
791
792 gtk_box_pack_start (cur_box, w, TRUE, TRUE, button_spacing);
793 if (++button_nr == left_buttons)
794 {
795 if (make_two_rows)
796 cur_box = GTK_BOX (whbox_down);
797 else
798 gtk_box_pack_start (cur_box,
799 gtk_label_new (""),
800 TRUE, TRUE,
801 button_spacing);
802 }
803 }
804
805 if (utf8_label && utf8_label != item->value)
806 g_free (utf8_label);
807 }
808
809 return wdialog;
810}
811
812
813enum
814{
815 XG_FILE_NOT_DONE,
816 XG_FILE_OK,
817 XG_FILE_CANCEL,
818 XG_FILE_DESTROYED,
819};
820
821/* Callback function invoked when the Ok button is pressed in
822 a file dialog.
823 W is the file dialog widget,
824 ARG points to an integer where we record what has happend. */
825static void
826xg_file_sel_ok (w, arg)
827 GtkWidget *w;
828 gpointer arg;
829{
830 *(int*)arg = XG_FILE_OK;
831}
832
833/* Callback function invoked when the Cancel button is pressed in
834 a file dialog.
835 W is the file dialog widget,
836 ARG points to an integer where we record what has happend. */
837static void
838xg_file_sel_cancel (w, arg)
839 GtkWidget *w;
840 gpointer arg;
841{
842 *(int*)arg = XG_FILE_CANCEL;
843}
844
845/* Callback function invoked when the file dialog is destroyed (i.e.
846 popped down). We must keep track of this, because if this
847 happens, GTK destroys the widget. But if for example, Ok is pressed,
848 the dialog is popped down, but the dialog widget is not destroyed.
849 W is the file dialog widget,
850 ARG points to an integer where we record what has happend. */
851static void
852xg_file_sel_destroy (w, arg)
853 GtkWidget *w;
854 gpointer arg;
855{
856 *(int*)arg = XG_FILE_DESTROYED;
857}
858
859/* Read a file name from the user using a file dialog.
860 F is the current frame.
861 PROMPT is a prompt to show to the user. May not be NULL.
862 DEFAULT_FILENAME is a default selection to be displayed. May be NULL.
863 If MUSTMATCH_P is non-zero, the returned file name must be an existing
864 file.
865
866 Returns a file name or NULL if no file was selected.
867 The returned string must be freed by the caller. */
868char *
869xg_get_file_name (f, prompt, default_filename, mustmatch_p)
870 FRAME_PTR f;
871 char *prompt;
872 char *default_filename;
873 int mustmatch_p;
874{
875 GtkWidget *filewin;
876 GtkFileSelection *filesel;
877 int filesel_done = XG_FILE_NOT_DONE;
878 char *fn = 0;
177c0ea7 879
f392e843
JD
880 filewin = gtk_file_selection_new (prompt);
881 filesel = GTK_FILE_SELECTION (filewin);
882
883 gtk_widget_set_name (filewin, "emacs-filedialog");
884
885 gtk_window_set_transient_for (GTK_WINDOW (filewin),
886 GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)));
887 gtk_window_set_destroy_with_parent (GTK_WINDOW (filewin), TRUE);
888
889 g_signal_connect (G_OBJECT (filesel->ok_button),
890 "clicked",
891 G_CALLBACK (xg_file_sel_ok),
892 &filesel_done);
893 g_signal_connect (G_OBJECT (filesel->cancel_button),
894 "clicked",
895 G_CALLBACK (xg_file_sel_cancel),
896 &filesel_done);
897 g_signal_connect (G_OBJECT (filesel),
898 "destroy",
899 G_CALLBACK (xg_file_sel_destroy),
900 &filesel_done);
901
902 if (default_filename)
903 gtk_file_selection_set_filename (filesel, default_filename);
904
905 if (mustmatch_p)
906 {
907 /* The selection_entry part of filesel is not documented. */
908 gtk_widget_set_sensitive (filesel->selection_entry, FALSE);
909 gtk_file_selection_hide_fileop_buttons (filesel);
910 }
911
177c0ea7 912
f392e843 913 gtk_widget_show_all (filewin);
177c0ea7 914
f392e843
JD
915 while (filesel_done == XG_FILE_NOT_DONE)
916 gtk_main_iteration ();
917
918 if (filesel_done == XG_FILE_OK)
919 fn = xstrdup ((char*) gtk_file_selection_get_filename (filesel));
920
921 if (filesel_done != XG_FILE_DESTROYED)
922 gtk_widget_destroy (filewin);
923
924 return fn;
925}
926
927\f
928/***********************************************************************
929 Menu functions.
930 ***********************************************************************/
931
932/* The name of menu items that can be used for citomization. Since GTK
933 RC files are very crude and primitive, we have to set this on all
934 menu item names so a user can easily cutomize menu items. */
935
936#define MENU_ITEM_NAME "emacs-menuitem"
937
938
939/* Linked list of all allocated struct xg_menu_cb_data. Used for marking
940 during GC. The next member points to the items. */
941static xg_list_node xg_menu_cb_list;
942
943/* Linked list of all allocated struct xg_menu_item_cb_data. Used for marking
944 during GC. The next member points to the items. */
945static xg_list_node xg_menu_item_cb_list;
946
947/* Allocate and initialize CL_DATA if NULL, otherwise increase ref_count.
948 F is the frame CL_DATA will be initialized for.
949 HIGHLIGHT_CB is the callback to call when entering/leaving menu items.
950
951 The menu bar and all sub menus under the menu bar in a frame
952 share the same structure, hence the reference count.
177c0ea7 953
f392e843
JD
954 Returns CL_DATA if CL_DATA is not NULL, or a pointer to a newly
955 allocated xg_menu_cb_data if CL_DATA is NULL. */
956static xg_menu_cb_data *
957make_cl_data (cl_data, f, highlight_cb)
958 xg_menu_cb_data *cl_data;
959 FRAME_PTR f;
960 GCallback highlight_cb;
961{
962 if (! cl_data)
963 {
964 cl_data = (xg_menu_cb_data*) xmalloc (sizeof (*cl_data));
965 cl_data->f = f;
966 cl_data->menu_bar_vector = f->menu_bar_vector;
967 cl_data->menu_bar_items_used = f->menu_bar_items_used;
968 cl_data->highlight_cb = highlight_cb;
969 cl_data->ref_count = 0;
970
971 xg_list_insert (&xg_menu_cb_list, &cl_data->ptrs);
972 }
973
974 cl_data->ref_count++;
975
976 return cl_data;
977}
978
979/* Update CL_DATA with values from frame F and with HIGHLIGHT_CB.
980 HIGHLIGHT_CB is the callback to call when entering/leaving menu items.
981
982 When the menu bar is updated, menu items may have been added and/or
983 removed, so menu_bar_vector and menu_bar_items_used change. We must
984 then update CL_DATA since it is used to determine which menu
985 item that is invoked in the menu.
986 HIGHLIGHT_CB could change, there is no check that the same
987 function is given when modifying a menu bar as was given when
988 creating the menu bar. */
989static void
990update_cl_data (cl_data, f, highlight_cb)
991 xg_menu_cb_data *cl_data;
992 FRAME_PTR f;
993 GCallback highlight_cb;
994{
995 if (cl_data)
996 {
997 cl_data->f = f;
998 cl_data->menu_bar_vector = f->menu_bar_vector;
999 cl_data->menu_bar_items_used = f->menu_bar_items_used;
1000 cl_data->highlight_cb = highlight_cb;
1001 }
1002}
1003
1004/* Decrease reference count for CL_DATA.
1005 If reference count is zero, free CL_DATA. */
1006static void
1007unref_cl_data (cl_data)
1008 xg_menu_cb_data *cl_data;
1009{
1010 if (cl_data && cl_data->ref_count > 0)
1011 {
1012 cl_data->ref_count--;
1013 if (cl_data->ref_count == 0)
1014 {
1015 xg_list_remove (&xg_menu_cb_list, &cl_data->ptrs);
1016 xfree (cl_data);
1017 }
1018 }
1019}
1020
1021/* Function that marks all lisp data during GC. */
1022void
1023xg_mark_data ()
1024{
1025 xg_list_node *iter;
1026
1027 for (iter = xg_menu_cb_list.next; iter; iter = iter->next)
1028 mark_object (&((xg_menu_cb_data *) iter)->menu_bar_vector);
1029
1030 for (iter = xg_menu_item_cb_list.next; iter; iter = iter->next)
1031 {
1032 xg_menu_item_cb_data *cb_data = (xg_menu_item_cb_data *) iter;
1033
1034 if (! NILP (cb_data->help))
1035 mark_object (&cb_data->help);
1036 }
1037}
1038
1039
1040/* Callback called when a menu item is destroyed. Used to free data.
1041 W is the widget that is being destroyed (not used).
1042 CLIENT_DATA points to the xg_menu_item_cb_data associated with the W. */
1043static void
1044menuitem_destroy_callback (w, client_data)
1045 GtkWidget *w;
1046 gpointer client_data;
1047{
1048 if (client_data)
1049 {
1050 xg_menu_item_cb_data *data = (xg_menu_item_cb_data*) client_data;
1051 xg_list_remove (&xg_menu_item_cb_list, &data->ptrs);
1052 xfree (data);
1053 }
1054}
1055
1056/* Callback called when the pointer enters/leaves a menu item.
1057 W is the menu item.
1058 EVENT is either an enter event or leave event.
1059 CLIENT_DATA points to the xg_menu_item_cb_data associated with the W.
1060
1061 Returns FALSE to tell GTK to keep processing this event. */
1062static gboolean
1063menuitem_highlight_callback (w, event, client_data)
1064 GtkWidget *w;
1065 GdkEventCrossing *event;
1066 gpointer client_data;
1067{
1068 if (client_data)
1069 {
1070 xg_menu_item_cb_data *data = (xg_menu_item_cb_data*) client_data;
1071 gpointer call_data = event->type == GDK_LEAVE_NOTIFY ? 0 : client_data;
177c0ea7 1072
f392e843
JD
1073 if (! NILP (data->help) && data->cl_data->highlight_cb)
1074 {
1075 GtkCallback func = (GtkCallback) data->cl_data->highlight_cb;
1076 (*func) (w, call_data);
1077 }
1078 }
1079
1080 return FALSE;
1081}
1082
1083/* Callback called when a menu is destroyed. Used to free data.
1084 W is the widget that is being destroyed (not used).
1085 CLIENT_DATA points to the xg_menu_cb_data associated with W. */
1086static void
1087menu_destroy_callback (w, client_data)
1088 GtkWidget *w;
1089 gpointer client_data;
1090{
1091 unref_cl_data ((xg_menu_cb_data*) client_data);
1092}
1093
1094/* Callback called when a menu does a grab or ungrab. That means the
1095 menu has been activated or deactivated.
1096 Used to start a timer so the small timeout the menus in GTK uses before
1097 popping down a menu is seen by Emacs (see xg_process_timeouts above).
1098 W is the widget that does the grab (not used).
1099 UNGRAB_P is TRUE if this is an ungrab, FALSE if it is a grab.
1100 CLIENT_DATA is NULL (not used). */
1101static void
1102menu_grab_callback (GtkWidget *widget,
1103 gboolean ungrab_p,
1104 gpointer client_data)
1105{
1106 /* Keep track of total number of grabs. */
1107 static int cnt;
1108
1109 if (ungrab_p) cnt--;
1110 else cnt++;
1111
1112 if (cnt > 0 && ! xg_timer) xg_start_timer ();
1113 else if (cnt == 0 && xg_timer) xg_stop_timer ();
1114}
1115
1116/* Make a GTK widget that contains both UTF8_LABEL and UTF8_KEY (both
1117 must be non-NULL) and can be inserted into a menu item.
1118
1119 Returns the GtkHBox. */
1120static GtkWidget *
1121make_widget_for_menu_item (utf8_label, utf8_key)
1122 char *utf8_label;
1123 char *utf8_key;
1124{
1125 GtkWidget *wlbl;
1126 GtkWidget *wkey;
1127 GtkWidget *wbox;
177c0ea7 1128
f392e843
JD
1129 wbox = gtk_hbox_new (FALSE, 0);
1130 wlbl = gtk_label_new_with_mnemonic (utf8_label);
1131 wkey = gtk_label_new (utf8_key);
1132
1133 gtk_misc_set_alignment (GTK_MISC (wlbl), 0.0, 0.5);
1134 gtk_misc_set_alignment (GTK_MISC (wkey), 0.0, 0.5);
177c0ea7 1135
f392e843
JD
1136 gtk_box_pack_start (GTK_BOX (wbox), wlbl, TRUE, TRUE, 0);
1137 gtk_box_pack_start (GTK_BOX (wbox), wkey, FALSE, FALSE, 0);
1138
1139 gtk_widget_set_name (wlbl, MENU_ITEM_NAME);
1140 gtk_widget_set_name (wkey, MENU_ITEM_NAME);
1141
1142 return wbox;
1143}
1144
1145/* Make and return a menu item widget with the key to the right.
1146 UTF8_LABEL is the text for the menu item (GTK uses UTF8 internally).
1147 UTF8_KEY is the text representing the key binding.
1148 ITEM is the widget_value describing the menu item.
177c0ea7 1149
f392e843
JD
1150 GROUP is an in/out parameter. If the menu item to be created is not
1151 part of any radio menu group, *GROUP contains NULL on entry and exit.
1152 If the menu item to be created is part of a radio menu group, on entry
1153 *GROUP contains the group to use, or NULL if this is the first item
1154 in the group. On exit, *GROUP contains the radio item group.
1155
1156 Unfortunately, keys don't line up as nicely as in Motif,
1157 but the MacOS X version doesn't either, so I guess that is OK. */
1158static GtkWidget *
1159make_menu_item (utf8_label, utf8_key, item, group)
1160 char *utf8_label;
1161 char *utf8_key;
1162 widget_value *item;
1163 GSList **group;
1164{
1165 GtkWidget *w;
1166 GtkWidget *wtoadd = 0;
177c0ea7 1167
f392e843
JD
1168 if (utf8_key)
1169 wtoadd = make_widget_for_menu_item (utf8_label, utf8_key);
177c0ea7 1170
f392e843
JD
1171 if (item->button_type == BUTTON_TYPE_TOGGLE)
1172 {
1173 *group = NULL;
1174 if (utf8_key) w = gtk_check_menu_item_new ();
1175 else w = gtk_check_menu_item_new_with_mnemonic (utf8_label);
1176 gtk_check_menu_item_set_active (GTK_CHECK_MENU_ITEM (w), item->selected);
1177 }
1178 else if (item->button_type == BUTTON_TYPE_RADIO)
1179 {
1180 if (utf8_key) w = gtk_radio_menu_item_new (*group);
1181 else w = gtk_radio_menu_item_new_with_mnemonic (*group, utf8_label);
1182 *group = gtk_radio_menu_item_get_group (GTK_RADIO_MENU_ITEM (w));
1183 if (item->selected)
1184 gtk_check_menu_item_set_active (GTK_CHECK_MENU_ITEM (w), TRUE);
1185 }
1186 else
1187 {
1188 *group = NULL;
1189 if (utf8_key) w = gtk_menu_item_new ();
1190 else w = gtk_menu_item_new_with_mnemonic (utf8_label);
1191 }
177c0ea7 1192
f392e843
JD
1193 if (wtoadd) gtk_container_add (GTK_CONTAINER (w), wtoadd);
1194 if (! item->enabled) gtk_widget_set_sensitive (w, FALSE);
1195
1196 return w;
1197}
1198
1199/* Return non-zero if NAME specifies a separator (GTK only has one
1200 separator type) */
1201static int
1202xg_separator_p (char *name)
1203{
0a1d6de0
JD
1204 if (! name) return 0;
1205
f392e843 1206 return strcmp (name, "--") == 0
0a1d6de0 1207 || strncmp (name, "--:", 3) == 0
f392e843
JD
1208 || strcmp (name, "---") == 0;
1209}
1210
1211GtkWidget *xg_did_tearoff;
1212
1213/* Callback invoked when a detached menu window is removed. Here we
1214 delete the popup menu.
1215 WIDGET is the top level window that is removed (the parent of the menu).
1216 EVENT is the event that triggers the window removal.
1217 CLIENT_DATA points to the menu that is detached.
1218
1219 Returns TRUE to tell GTK to stop processing this event. */
1220static gboolean
1221tearoff_remove (widget, event, client_data)
1222 GtkWidget *widget;
1223 GdkEvent *event;
1224 gpointer client_data;
1225{
1226 gtk_widget_destroy (GTK_WIDGET (client_data));
1227 return TRUE;
1228}
1229
1230/* Callback invoked when a menu is detached. It sets the xg_did_tearoff
1231 variable.
1232 WIDGET is the GtkTearoffMenuItem.
177c0ea7 1233 CLIENT_DATA is not used. */
f392e843
JD
1234static void
1235tearoff_activate (widget, client_data)
1236 GtkWidget *widget;
1237 gpointer client_data;
1238{
1239 GtkWidget *menu = gtk_widget_get_parent (widget);
1240 if (! gtk_menu_get_tearoff_state (GTK_MENU (menu)))
1241 return;
1242
1243 xg_did_tearoff = menu;
1244}
1245
1246/* If a detach of a popup menu is done, this function should be called
1247 to keep the menu around until the detached window is removed.
1248 MENU is the top level menu for the popup,
1249 SUBMENU is the menu that got detached (that is MENU or a
1250 submenu of MENU), see the xg_did_tearoff variable. */
1251void
1252xg_keep_popup (menu, submenu)
1253 GtkWidget *menu;
1254 GtkWidget *submenu;
1255{
1256 GtkWidget *p;
1257
1258 /* Find the top widget for the detached menu. */
1259 p = gtk_widget_get_toplevel (submenu);
177c0ea7 1260
f392e843
JD
1261 /* Delay destroying the menu until the detached menu is removed. */
1262 g_signal_connect (G_OBJECT (p), "unmap_event",
1263 G_CALLBACK (tearoff_remove), menu);
1264}
1265
1266int xg_debug = 0;
1267
1268/* Create a menu item widget, and connect the callbacks.
1269 ITEM decribes the menu item.
1270 F is the frame the created menu belongs to.
1271 SELECT_CB is the callback to use when a menu item is selected.
1272 HIGHLIGHT_CB is the callback to call when entering/leaving menu items.
1273 CL_DATA points to the callback data to be used for this menu.
1274 GROUP is an in/out parameter. If the menu item to be created is not
1275 part of any radio menu group, *GROUP contains NULL on entry and exit.
1276 If the menu item to be created is part of a radio menu group, on entry
1277 *GROUP contains the group to use, or NULL if this is the first item
1278 in the group. On exit, *GROUP contains the radio item group.
1279
1280 Returns the created GtkWidget. */
1281static GtkWidget *
1282xg_create_one_menuitem (item, f, select_cb, highlight_cb, cl_data, group)
1283 widget_value *item;
1284 FRAME_PTR f;
1285 GCallback select_cb;
1286 GCallback highlight_cb;
1287 xg_menu_cb_data *cl_data;
1288 GSList **group;
1289{
1290 char *utf8_label;
1291 char *utf8_key;
1292 GtkWidget *w;
1293 xg_menu_item_cb_data *cb_data;
1294
1295 utf8_label = get_utf8_string (item->name);
1296 utf8_key = get_utf8_string (item->key);
1297
1298 w = make_menu_item (utf8_label, utf8_key, item, group);
1299
1300 if (utf8_label && utf8_label != item->name) g_free (utf8_label);
1301 if (utf8_key && utf8_key != item->key) g_free (utf8_key);
1302
1303 cb_data = xmalloc (sizeof (xg_menu_item_cb_data));
1304
1305 xg_list_insert (&xg_menu_item_cb_list, &cb_data->ptrs);
1306
1307 cb_data->unhighlight_id = cb_data->highlight_id = cb_data->select_id = 0;
1308 cb_data->help = item->help;
1309 cb_data->cl_data = cl_data;
1310 cb_data->call_data = item->call_data;
177c0ea7 1311
f392e843
JD
1312 g_signal_connect (G_OBJECT (w),
1313 "destroy",
1314 G_CALLBACK (menuitem_destroy_callback),
1315 cb_data);
1316
1317 /* Put cb_data in widget, so we can get at it when modifying menubar */
1318 g_object_set_data (G_OBJECT (w), XG_ITEM_DATA, cb_data);
1319
1320 /* final item, not a submenu */
1321 if (item->call_data && ! item->contents)
1322 {
1323 if (select_cb)
1324 cb_data->select_id
1325 = g_signal_connect (G_OBJECT (w), "activate", select_cb, cb_data);
1326 }
1327
1328 if (! NILP (item->help) && highlight_cb)
1329 {
1330 /* We use enter/leave notify instead of select/deselect because
1331 select/deselect doesn't go well with detached menus. */
1332 cb_data->highlight_id
1333 = g_signal_connect (G_OBJECT (w),
1334 "enter-notify-event",
1335 G_CALLBACK (menuitem_highlight_callback),
1336 cb_data);
1337 cb_data->unhighlight_id
1338 = g_signal_connect (G_OBJECT (w),
1339 "leave-notify-event",
1340 G_CALLBACK (menuitem_highlight_callback),
1341 cb_data);
1342 }
1343
1344 return w;
1345}
1346
1347/* Create a full menu tree specified by DATA.
1348 F is the frame the created menu belongs to.
1349 SELECT_CB is the callback to use when a menu item is selected.
1350 DEACTIVATE_CB is the callback to use when a sub menu is not shown anymore.
1351 HIGHLIGHT_CB is the callback to call when entering/leaving menu items.
1352 POP_UP_P is non-zero if we shall create a popup menu.
1353 MENU_BAR_P is non-zero if we shall create a menu bar.
1354 ADD_TEAROFF_P is non-zero if we shall add a teroff menu item. Ignored
1355 if MENU_BAR_P is non-zero.
1356 TOPMENU is the topmost GtkWidget that others shall be placed under.
1357 It may be NULL, in that case we create the appropriate widget
1358 (menu bar or menu item depending on POP_UP_P and MENU_BAR_P)
1359 CL_DATA is the callback data we shall use for this menu, or NULL
1360 if we haven't set the first callback yet.
1361 NAME is the name to give to the top level menu if this function
1362 creates it. May be NULL to not set any name.
1363
1364 Returns the top level GtkWidget. This is TOPLEVEL if TOPLEVEL is
1365 not NULL.
1366
1367 This function calls itself to create submenus. */
1368
1369static GtkWidget *
1370create_menus (data, f, select_cb, deactivate_cb, highlight_cb,
1371 pop_up_p, menu_bar_p, add_tearoff_p, topmenu, cl_data, name)
1372 widget_value *data;
1373 FRAME_PTR f;
1374 GCallback select_cb;
1375 GCallback deactivate_cb;
1376 GCallback highlight_cb;
1377 int pop_up_p;
1378 int menu_bar_p;
1379 int add_tearoff_p;
1380 GtkWidget *topmenu;
1381 xg_menu_cb_data *cl_data;
1382 char *name;
1383{
1384 widget_value *item;
1385 GtkWidget *wmenu = topmenu;
1386 GSList *group = NULL;
1387
1388 if (! topmenu)
1389 {
1390 if (! menu_bar_p) wmenu = gtk_menu_new ();
1391 else wmenu = gtk_menu_bar_new ();
1392
1393 /* Put cl_data on the top menu for easier access. */
1394 cl_data = make_cl_data (cl_data, f, highlight_cb);
1395 g_object_set_data (G_OBJECT (wmenu), XG_FRAME_DATA, (gpointer)cl_data);
1396 g_signal_connect (G_OBJECT (wmenu), "destroy",
1397 G_CALLBACK (menu_destroy_callback), cl_data);
177c0ea7 1398
f392e843
JD
1399 if (name)
1400 gtk_widget_set_name (wmenu, name);
1401
1402 if (deactivate_cb)
1403 g_signal_connect (G_OBJECT (wmenu),
1404 "deactivate", deactivate_cb, 0);
1405
1406 g_signal_connect (G_OBJECT (wmenu),
1407 "grab-notify", G_CALLBACK (menu_grab_callback), 0);
1408 }
177c0ea7 1409
f392e843
JD
1410 if (! menu_bar_p && add_tearoff_p)
1411 {
1412 GtkWidget *tearoff = gtk_tearoff_menu_item_new ();
1413 gtk_menu_shell_append (GTK_MENU_SHELL (wmenu), tearoff);
1414
1415 g_signal_connect (G_OBJECT (tearoff), "activate",
1416 G_CALLBACK (tearoff_activate), 0);
1417 }
1418
1419 for (item = data; item; item = item->next)
1420 {
1421 GtkWidget *w;
177c0ea7 1422
f392e843
JD
1423 if (pop_up_p && !item->contents && !item->call_data
1424 && !xg_separator_p (item->name))
1425 {
1426 char *utf8_label;
1427 /* A title for a popup. We do the same as GTK does when
1428 creating titles, but it does not look good. */
1429 group = NULL;
1430 utf8_label = get_utf8_string (item->name);
1431
1432 gtk_menu_set_title (GTK_MENU (wmenu), utf8_label);
1433 w = gtk_menu_item_new_with_mnemonic (utf8_label);
1434 gtk_widget_set_sensitive (w, FALSE);
1435 if (utf8_label && utf8_label != item->name) g_free (utf8_label);
1436 }
1437 else if (xg_separator_p (item->name))
1438 {
1439 group = NULL;
1440 /* GTK only have one separator type. */
1441 w = gtk_separator_menu_item_new ();
1442 }
1443 else
1444 {
1445 w = xg_create_one_menuitem (item,
1446 f,
1447 item->contents ? 0 : select_cb,
1448 highlight_cb,
1449 cl_data,
1450 &group);
1451
1452 if (item->contents)
1453 {
1454 GtkWidget *submenu = create_menus (item->contents,
1455 f,
1456 select_cb,
1457 deactivate_cb,
1458 highlight_cb,
1459 0,
1460 0,
1461 1,
1462 0,
1463 cl_data,
1464 0);
1465 gtk_menu_item_set_submenu (GTK_MENU_ITEM (w), submenu);
1466 }
f392e843
JD
1467 }
1468
1469 gtk_menu_shell_append (GTK_MENU_SHELL (wmenu), w);
1470 gtk_widget_set_name (w, MENU_ITEM_NAME);
1471 }
1472
1473 return wmenu;
1474}
1475
1476/* Create a menubar, popup menu or dialog, depending on the TYPE argument.
1477 TYPE can be "menubar", "popup" for popup menu, or "dialog" for a dialog
1478 with some text and buttons.
1479 F is the frame the created item belongs to.
1480 NAME is the name to use for the top widget.
1481 VAL is a widget_value structure describing items to be created.
1482 SELECT_CB is the callback to use when a menu item is selected or
1483 a dialog button is pressed.
1484 DEACTIVATE_CB is the callback to use when an item is deactivated.
1485 For a menu, when a sub menu is not shown anymore, for a dialog it is
1486 called when the dialog is popped down.
1487 HIGHLIGHT_CB is the callback to call when entering/leaving menu items.
1488
1489 Returns the widget created. */
1490GtkWidget *
1491xg_create_widget (type, name, f, val,
1492 select_cb, deactivate_cb, highlight_cb)
1493 char *type;
1494 char *name;
1495 FRAME_PTR f;
1496 widget_value *val;
1497 GCallback select_cb;
1498 GCallback deactivate_cb;
1499 GCallback highlight_cb;
1500{
1501 GtkWidget *w = 0;
1502 if (strcmp (type, "dialog") == 0)
1503 {
1504 w = create_dialog (val, select_cb, deactivate_cb);
1505 gtk_window_set_transient_for (GTK_WINDOW (w),
1506 GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)));
1507 gtk_window_set_destroy_with_parent (GTK_WINDOW (w), TRUE);
1508
1509 if (w)
1510 gtk_widget_set_name (w, "emacs-dialog");
1511 }
1512 else if (strcmp (type, "menubar") == 0 || strcmp (type, "popup") == 0)
1513 {
1514 w = create_menus (val->contents,
1515 f,
1516 select_cb,
1517 deactivate_cb,
1518 highlight_cb,
1519 strcmp (type, "popup") == 0,
1520 strcmp (type, "menubar") == 0,
1521 1,
1522 0,
1523 0,
1524 name);
1525
1526 /* Set the cursor to an arrow for popup menus when they are mapped.
1527 This is done by default for menu bar menus. */
1528 if (strcmp (type, "popup") == 0)
1529 {
1530 /* Must realize so the GdkWindow inside the widget is created. */
1531 gtk_widget_realize (w);
1532 xg_set_cursor (w, &xg_left_ptr_cursor);
1533 }
1534 }
1535 else
1536 {
1537 fprintf (stderr, "bad type in xg_create_widget: %s, doing nothing\n",
1538 type);
1539 }
1540
1541 return w;
1542}
1543
0a1d6de0 1544/* Return the label for menu item WITEM. */
f392e843
JD
1545static const char *
1546xg_get_menu_item_label (witem)
1547 GtkMenuItem *witem;
1548{
1549 GtkLabel *wlabel = GTK_LABEL (gtk_bin_get_child (GTK_BIN (witem)));
1550 return gtk_label_get_label (wlabel);
1551}
1552
0a1d6de0 1553/* Return non-zero if the menu item WITEM has the text LABEL. */
f392e843
JD
1554static int
1555xg_item_label_same_p (witem, label)
1556 GtkMenuItem *witem;
1557 char *label;
1558{
0a1d6de0 1559 int is_same = 0;
f392e843 1560 char *utf8_label = get_utf8_string (label);
0a1d6de0
JD
1561 const char *old_label = witem ? xg_get_menu_item_label (witem) : 0;
1562
1563 if (! old_label && ! utf8_label)
1564 is_same = 1;
1565 else if (old_label && utf8_label)
1566 is_same = strcmp (utf8_label, old_label) == 0;
1567
1568 if (utf8_label && utf8_label != label) g_free (utf8_label);
f392e843
JD
1569
1570 return is_same;
1571}
1572
1573/* Remove widgets in LIST from container WCONT. */
1574static void
1575remove_from_container (wcont, list)
1576 GtkWidget *wcont;
1577 GList *list;
1578{
f392e843
JD
1579 GList *iter;
1580
49853a4d 1581 for (iter = list; iter; iter = g_list_next (iter))
f392e843
JD
1582 {
1583 GtkWidget *w = GTK_WIDGET (iter->data);
1584
1585 /* Add a ref to w so we can explicitly destroy it later. */
1586 gtk_widget_ref (w);
1587 gtk_container_remove (GTK_CONTAINER (wcont), w);
177c0ea7 1588
f392e843
JD
1589 /* If there is a menu under this widget that has been detached,
1590 there is a reference to it, and just removing w from the
1591 container does not destroy the submenu. By explicitly
1592 destroying w we make sure the submenu is destroyed, thus
1593 removing the detached window also if there was one. */
1594 gtk_widget_destroy (w);
1595 }
f392e843
JD
1596}
1597
1598/* Update the top level names in MENUBAR (i.e. not submenus).
1599 F is the frame the menu bar belongs to.
49853a4d
JD
1600 *LIST is a list with the current menu bar names (menu item widgets).
1601 ITER is the item within *LIST that shall be updated.
1602 POS is the numerical position, starting at 0, of ITER in *LIST.
f392e843
JD
1603 VAL describes what the menu bar shall look like after the update.
1604 SELECT_CB is the callback to use when a menu item is selected.
1605 HIGHLIGHT_CB is the callback to call when entering/leaving menu items.
49853a4d 1606 CL_DATA points to the callback data to be used for this menu bar.
f392e843
JD
1607
1608 This function calls itself to walk through the menu bar names. */
1609static void
49853a4d
JD
1610xg_update_menubar (menubar, f, list, iter, pos, val,
1611 select_cb, highlight_cb, cl_data)
f392e843
JD
1612 GtkWidget *menubar;
1613 FRAME_PTR f;
49853a4d
JD
1614 GList **list;
1615 GList *iter;
1616 int pos;
f392e843
JD
1617 widget_value *val;
1618 GCallback select_cb;
1619 GCallback highlight_cb;
1620 xg_menu_cb_data *cl_data;
1621{
49853a4d 1622 if (! iter && ! val)
f392e843 1623 return;
49853a4d 1624 else if (iter && ! val)
f392e843 1625 {
49853a4d
JD
1626 /* Item(s) have been removed. Remove all remaining items. */
1627 remove_from_container (menubar, iter);
f392e843
JD
1628
1629 /* All updated. */
1630 val = 0;
49853a4d 1631 iter = 0;
f392e843 1632 }
49853a4d 1633 else if (! iter && val)
f392e843
JD
1634 {
1635 /* Item(s) added. Add all new items in one call. */
1636 create_menus (val, f, select_cb, 0, highlight_cb,
1637 0, 1, 0, menubar, cl_data, 0);
1638
1639 /* All updated. */
1640 val = 0;
49853a4d 1641 iter = 0;
f392e843 1642 }
49853a4d
JD
1643 /* Below this neither iter or val is NULL */
1644 else if (xg_item_label_same_p (GTK_MENU_ITEM (iter->data), val->name))
f392e843
JD
1645 {
1646 /* This item is still the same, check next item. */
1647 val = val->next;
49853a4d
JD
1648 iter = g_list_next (iter);
1649 ++pos;
f392e843
JD
1650 }
1651 else /* This item is changed. */
1652 {
49853a4d 1653 GtkMenuItem *witem = GTK_MENU_ITEM (iter->data);
f392e843 1654 GtkMenuItem *witem2 = 0;
f392e843 1655 int val_in_menubar = 0;
49853a4d
JD
1656 int iter_in_new_menubar = 0;
1657 GList *iter2;
f392e843
JD
1658 widget_value *cur;
1659
f392e843 1660 /* See if the changed entry (val) is present later in the menu bar */
49853a4d
JD
1661 for (iter2 = iter;
1662 iter2 && ! val_in_menubar;
1663 iter2 = g_list_next (iter2))
f392e843 1664 {
49853a4d 1665 witem2 = GTK_MENU_ITEM (iter2->data);
f392e843
JD
1666 val_in_menubar = xg_item_label_same_p (witem2, val->name);
1667 }
1668
49853a4d 1669 /* See if the current entry (iter) is present later in the
f392e843 1670 specification for the new menu bar. */
49853a4d
JD
1671 for (cur = val; cur && ! iter_in_new_menubar; cur = cur->next)
1672 iter_in_new_menubar = xg_item_label_same_p (witem, cur->name);
f392e843 1673
49853a4d 1674 if (val_in_menubar && ! iter_in_new_menubar)
f392e843 1675 {
49853a4d
JD
1676 int nr = pos;
1677
f392e843
JD
1678 /* This corresponds to:
1679 Current: A B C
1680 New: A C
1681 Remove B. */
177c0ea7 1682
f392e843
JD
1683 gtk_widget_ref (GTK_WIDGET (witem));
1684 gtk_container_remove (GTK_CONTAINER (menubar), GTK_WIDGET (witem));
1685 gtk_widget_destroy (GTK_WIDGET (witem));
1686
1687 /* Must get new list since the old changed. */
49853a4d
JD
1688 g_list_free (*list);
1689 *list = iter = gtk_container_get_children (GTK_CONTAINER (menubar));
1690 while (nr-- > 0) iter = g_list_next (iter);
f392e843 1691 }
49853a4d 1692 else if (! val_in_menubar && ! iter_in_new_menubar)
f392e843
JD
1693 {
1694 /* This corresponds to:
1695 Current: A B C
1696 New: A X C
1697 Rename B to X. This might seem to be a strange thing to do,
1698 since if there is a menu under B it will be totally wrong for X.
1699 But consider editing a C file. Then there is a C-mode menu
1700 (corresponds to B above).
1701 If then doing C-x C-f the minibuf menu (X above) replaces the
1702 C-mode menu. When returning from the minibuffer, we get
1703 back the C-mode menu. Thus we do:
1704 Rename B to X (C-mode to minibuf menu)
1705 Rename X to B (minibuf to C-mode menu).
1706 If the X menu hasn't been invoked, the menu under B
1707 is up to date when leaving the minibuffer. */
1708 GtkLabel *wlabel = GTK_LABEL (gtk_bin_get_child (GTK_BIN (witem)));
1709 char *utf8_label = get_utf8_string (val->name);
177c0ea7 1710
f392e843
JD
1711 gtk_label_set_text_with_mnemonic (wlabel, utf8_label);
1712
49853a4d 1713 iter = g_list_next (iter);
f392e843 1714 val = val->next;
49853a4d 1715 ++pos;
f392e843 1716 }
49853a4d 1717 else if (! val_in_menubar && iter_in_new_menubar)
f392e843
JD
1718 {
1719 /* This corresponds to:
1720 Current: A B C
1721 New: A X B C
1722 Insert X. */
1723
49853a4d 1724 int nr = pos;
f392e843
JD
1725 GList *group = 0;
1726 GtkWidget *w = xg_create_one_menuitem (val,
1727 f,
1728 select_cb,
1729 highlight_cb,
1730 cl_data,
1731 &group);
1732
1733 gtk_widget_set_name (w, MENU_ITEM_NAME);
1734 gtk_menu_shell_insert (GTK_MENU_SHELL (menubar), w, pos);
1735
49853a4d
JD
1736 g_list_free (*list);
1737 *list = iter = gtk_container_get_children (GTK_CONTAINER (menubar));
1738 while (nr-- > 0) iter = g_list_next (iter);
1739 iter = g_list_next (iter);
f392e843 1740 val = val->next;
49853a4d 1741 ++pos;
f392e843 1742 }
49853a4d 1743 else /* if (val_in_menubar && iter_in_new_menubar) */
f392e843 1744 {
49853a4d 1745 int nr = pos;
f392e843
JD
1746 /* This corresponds to:
1747 Current: A B C
1748 New: A C B
1749 Move C before B */
1750
1751 gtk_widget_ref (GTK_WIDGET (witem2));
1752 gtk_container_remove (GTK_CONTAINER (menubar), GTK_WIDGET (witem2));
1753 gtk_menu_shell_insert (GTK_MENU_SHELL (menubar),
1754 GTK_WIDGET (witem2), pos);
1755 gtk_widget_unref (GTK_WIDGET (witem2));
1756
49853a4d
JD
1757 g_list_free (*list);
1758 *list = iter = gtk_container_get_children (GTK_CONTAINER (menubar));
1759 while (nr-- > 0) iter = g_list_next (iter);
f392e843 1760 val = val->next;
49853a4d 1761 ++pos;
f392e843 1762 }
f392e843
JD
1763 }
1764
1765 /* Update the rest of the menu bar. */
49853a4d
JD
1766 xg_update_menubar (menubar, f, list, iter, pos, val,
1767 select_cb, highlight_cb, cl_data);
f392e843
JD
1768}
1769
1770/* Update the menu item W so it corresponds to VAL.
1771 SELECT_CB is the callback to use when a menu item is selected.
1772 HIGHLIGHT_CB is the callback to call when entering/leaving menu items.
1773 CL_DATA is the data to set in the widget for menu invokation. */
1774static void
1775xg_update_menu_item (val, w, select_cb, highlight_cb, cl_data)
1776 widget_value *val;
1777 GtkWidget *w;
1778 GCallback select_cb;
1779 GCallback highlight_cb;
1780 xg_menu_cb_data *cl_data;
1781{
1782 GtkWidget *wchild;
1783 GtkLabel *wlbl = 0;
1784 GtkLabel *wkey = 0;
1785 char *utf8_label;
1786 char *utf8_key;
0a1d6de0
JD
1787 const char *old_label = 0;
1788 const char *old_key = 0;
f392e843 1789 xg_menu_item_cb_data *cb_data;
177c0ea7
JB
1790
1791 wchild = gtk_bin_get_child (GTK_BIN (w));
f392e843
JD
1792 utf8_label = get_utf8_string (val->name);
1793 utf8_key = get_utf8_string (val->key);
1794
1795 /* See if W is a menu item with a key. See make_menu_item above. */
1796 if (GTK_IS_HBOX (wchild))
1797 {
1798 GList *list = gtk_container_get_children (GTK_CONTAINER (wchild));
1799
1800 wlbl = GTK_LABEL (list->data);
1801 wkey = GTK_LABEL (list->next->data);
49853a4d
JD
1802 g_list_free (list);
1803
f392e843
JD
1804 if (! utf8_key)
1805 {
1806 /* Remove the key and keep just the label. */
1807 gtk_widget_ref (GTK_WIDGET (wlbl));
1808 gtk_container_remove (GTK_CONTAINER (w), wchild);
1809 gtk_container_add (GTK_CONTAINER (w), GTK_WIDGET (wlbl));
1810 wkey = 0;
1811 }
49853a4d 1812
f392e843
JD
1813 }
1814 else /* Just a label. */
1815 {
1816 wlbl = GTK_LABEL (wchild);
1817
1818 /* Check if there is now a key. */
1819 if (utf8_key)
1820 {
1821 GtkWidget *wtoadd = make_widget_for_menu_item (utf8_label, utf8_key);
1822 GList *list = gtk_container_get_children (GTK_CONTAINER (wtoadd));
49853a4d 1823
f392e843
JD
1824 wlbl = GTK_LABEL (list->data);
1825 wkey = GTK_LABEL (list->next->data);
49853a4d 1826 g_list_free (list);
f392e843
JD
1827
1828 gtk_container_remove (GTK_CONTAINER (w), wchild);
1829 gtk_container_add (GTK_CONTAINER (w), wtoadd);
1830 }
1831 }
1832
177c0ea7 1833
0a1d6de0
JD
1834 if (wkey) old_key = gtk_label_get_label (wkey);
1835 if (wlbl) old_label = gtk_label_get_label (wlbl);
177c0ea7 1836
0a1d6de0 1837 if (wkey && utf8_key && (! old_key || strcmp (utf8_key, old_key) != 0))
f392e843
JD
1838 gtk_label_set_text (wkey, utf8_key);
1839
0a1d6de0 1840 if (! old_label || strcmp (utf8_label, old_label) != 0)
f392e843
JD
1841 gtk_label_set_text_with_mnemonic (wlbl, utf8_label);
1842
0a1d6de0
JD
1843 if (utf8_key && utf8_key != val->key) g_free (utf8_key);
1844 if (utf8_label && utf8_label != val->name) g_free (utf8_label);
177c0ea7 1845
f392e843
JD
1846 if (! val->enabled && GTK_WIDGET_SENSITIVE (w))
1847 gtk_widget_set_sensitive (w, FALSE);
1848 else if (val->enabled && ! GTK_WIDGET_SENSITIVE (w))
1849 gtk_widget_set_sensitive (w, TRUE);
1850
1851 cb_data = (xg_menu_item_cb_data*) g_object_get_data (G_OBJECT (w),
1852 XG_ITEM_DATA);
1853 if (cb_data)
1854 {
1855 cb_data->call_data = val->call_data;
1856 cb_data->help = val->help;
1857 cb_data->cl_data = cl_data;
177c0ea7 1858
f392e843
JD
1859 /* We assume the callback functions don't change. */
1860 if (val->call_data && ! val->contents)
1861 {
1862 /* This item shall have a select callback. */
1863 if (! cb_data->select_id)
1864 cb_data->select_id
1865 = g_signal_connect (G_OBJECT (w), "activate",
1866 select_cb, cb_data);
1867 }
1868 else if (cb_data->select_id)
1869 {
1870 g_signal_handler_disconnect (w, cb_data->select_id);
1871 cb_data->select_id = 0;
1872 }
1873
1874 if (NILP (cb_data->help))
1875 {
1876 /* Shall not have help. Remove if any existed previously. */
1877 if (cb_data->highlight_id)
1878 {
1879 g_signal_handler_disconnect (G_OBJECT (w),
1880 cb_data->highlight_id);
1881 cb_data->highlight_id = 0;
1882 }
1883 if (cb_data->unhighlight_id)
1884 {
1885 g_signal_handler_disconnect (G_OBJECT (w),
1886 cb_data->unhighlight_id);
1887 cb_data->unhighlight_id = 0;
1888 }
1889 }
1890 else if (! cb_data->highlight_id && highlight_cb)
1891 {
1892 /* Have help now, but didn't previously. Add callback. */
1893 cb_data->highlight_id
1894 = g_signal_connect (G_OBJECT (w),
1895 "enter-notify-event",
1896 G_CALLBACK (menuitem_highlight_callback),
1897 cb_data);
1898 cb_data->unhighlight_id
1899 = g_signal_connect (G_OBJECT (w),
1900 "leave-notify-event",
1901 G_CALLBACK (menuitem_highlight_callback),
1902 cb_data);
1903 }
1904 }
1905}
1906
1907/* Update the toggle menu item W so it corresponds to VAL. */
1908static void
1909xg_update_toggle_item (val, w)
1910 widget_value *val;
1911 GtkWidget *w;
1912{
1913 gtk_check_menu_item_set_active (GTK_CHECK_MENU_ITEM (w), val->selected);
1914}
1915
1916/* Update the radio menu item W so it corresponds to VAL. */
1917static void
1918xg_update_radio_item (val, w)
1919 widget_value *val;
1920 GtkWidget *w;
1921{
1922 gtk_check_menu_item_set_active (GTK_CHECK_MENU_ITEM (w), val->selected);
1923}
1924
1925/* Update the sub menu SUBMENU and all its children so it corresponds to VAL.
1926 SUBMENU may be NULL, in that case a new menu is created.
1927 F is the frame the menu bar belongs to.
1928 VAL describes the contents of the menu bar.
1929 SELECT_CB is the callback to use when a menu item is selected.
1930 DEACTIVATE_CB is the callback to use when a sub menu is not shown anymore.
1931 HIGHLIGHT_CB is the callback to call when entering/leaving menu items.
1932 CL_DATA is the call back data to use for any newly created items.
1933
1934 Returns the updated submenu widget, that is SUBMENU unless SUBMENU
1935 was NULL. */
1936
1937static GtkWidget *
1938xg_update_submenu (submenu, f, val,
1939 select_cb, deactivate_cb, highlight_cb, cl_data)
1940 GtkWidget *submenu;
1941 FRAME_PTR f;
1942 widget_value *val;
1943 GCallback select_cb;
1944 GCallback deactivate_cb;
1945 GCallback highlight_cb;
1946 xg_menu_cb_data *cl_data;
1947{
1948 GtkWidget *newsub = submenu;
1949 GList *list = 0;
1950 GList *iter;
1951 widget_value *cur;
1952 int has_tearoff_p = 0;
1953 GList *first_radio = 0;
177c0ea7 1954
f392e843
JD
1955 if (submenu)
1956 list = gtk_container_get_children (GTK_CONTAINER (submenu));
177c0ea7 1957
f392e843
JD
1958 for (cur = val, iter = list;
1959 cur && iter;
1960 iter = g_list_next (iter), cur = cur->next)
1961 {
1962 GtkWidget *w = GTK_WIDGET (iter->data);
1963
1964 /* Skip tearoff items, they have no counterpart in val. */
1965 if (GTK_IS_TEAROFF_MENU_ITEM (w))
1966 {
1967 has_tearoff_p = 1;
1968 iter = g_list_next (iter);
1969 if (iter) w = GTK_WIDGET (iter->data);
1970 else break;
1971 }
1972
1973 /* Remember first radio button in a group. If we get a mismatch in
1974 a radio group we must rebuild the whole group so that the connections
1975 in GTK becomes correct. */
1976 if (cur->button_type == BUTTON_TYPE_RADIO && ! first_radio)
1977 first_radio = iter;
1978 else if (cur->button_type != BUTTON_TYPE_RADIO
1979 && ! GTK_IS_RADIO_MENU_ITEM (w))
1980 first_radio = 0;
1981
1982 if (GTK_IS_SEPARATOR_MENU_ITEM (w))
1983 {
1984 if (! xg_separator_p (cur->name))
1985 break;
1986 }
1987 else if (GTK_IS_CHECK_MENU_ITEM (w))
1988 {
1989 if (cur->button_type != BUTTON_TYPE_TOGGLE)
1990 break;
1991 xg_update_toggle_item (cur, w);
1992 xg_update_menu_item (cur, w, select_cb, highlight_cb, cl_data);
1993 }
1994 else if (GTK_IS_RADIO_MENU_ITEM (w))
1995 {
1996 if (cur->button_type != BUTTON_TYPE_RADIO)
1997 break;
1998 xg_update_radio_item (cur, w);
1999 xg_update_menu_item (cur, w, select_cb, highlight_cb, cl_data);
2000 }
2001 else if (GTK_IS_MENU_ITEM (w))
2002 {
2003 GtkMenuItem *witem = GTK_MENU_ITEM (w);
2004 GtkWidget *sub;
2005
2006 if (cur->button_type != BUTTON_TYPE_NONE ||
2007 xg_separator_p (cur->name))
2008 break;
2009
2010 xg_update_menu_item (cur, w, select_cb, highlight_cb, cl_data);
2011
2012 sub = gtk_menu_item_get_submenu (witem);
2013 if (sub && ! cur->contents)
2014 {
2015 /* Not a submenu anymore. */
2016 gtk_widget_ref (sub);
2017 gtk_menu_item_remove_submenu (witem);
2018 gtk_widget_destroy (sub);
2019 }
2020 else if (cur->contents)
2021 {
2022 GtkWidget *nsub;
2023
2024 nsub = xg_update_submenu (sub, f, cur->contents,
2025 select_cb, deactivate_cb,
2026 highlight_cb, cl_data);
2027
2028 /* If this item just became a submenu, we must set it. */
2029 if (nsub != sub)
2030 gtk_menu_item_set_submenu (witem, nsub);
2031 }
2032 }
2033 else
2034 {
2035 /* Structural difference. Remove everything from here and down
2036 in SUBMENU. */
2037 break;
2038 }
2039 }
2040
2041 /* Remove widgets from first structual change. */
2042 if (iter)
2043 {
2044 /* If we are adding new menu items below, we must remove from
2045 first radio button so that radio groups become correct. */
2046 if (cur && first_radio) remove_from_container (submenu, first_radio);
2047 else remove_from_container (submenu, iter);
2048 }
177c0ea7 2049
f392e843
JD
2050 if (cur)
2051 {
2052 /* More items added. Create them. */
2053 newsub = create_menus (cur,
2054 f,
2055 select_cb,
2056 deactivate_cb,
2057 highlight_cb,
2058 0,
2059 0,
2060 ! has_tearoff_p,
2061 submenu,
2062 cl_data,
2063 0);
2064 }
177c0ea7 2065
49853a4d
JD
2066 if (list) g_list_free (list);
2067
f392e843
JD
2068 return newsub;
2069}
2070
2071/* Update the MENUBAR.
2072 F is the frame the menu bar belongs to.
2073 VAL describes the contents of the menu bar.
2074 If DEEP_P is non-zero, rebuild all but the top level menu names in
2075 the MENUBAR. If DEEP_P is zero, just rebuild the names in the menubar.
2076 SELECT_CB is the callback to use when a menu item is selected.
2077 DEACTIVATE_CB is the callback to use when a sub menu is not shown anymore.
2078 HIGHLIGHT_CB is the callback to call when entering/leaving menu items. */
2079void
2080xg_modify_menubar_widgets (menubar, f, val, deep_p,
2081 select_cb, deactivate_cb, highlight_cb)
2082 GtkWidget *menubar;
2083 FRAME_PTR f;
2084 widget_value *val;
2085 int deep_p;
2086 GCallback select_cb;
2087 GCallback deactivate_cb;
2088 GCallback highlight_cb;
2089{
2090 xg_menu_cb_data *cl_data;
2091 GList *list = gtk_container_get_children (GTK_CONTAINER (menubar));
f392e843
JD
2092
2093 if (! list) return;
177c0ea7 2094
f392e843
JD
2095 cl_data = (xg_menu_cb_data*) g_object_get_data (G_OBJECT (menubar),
2096 XG_FRAME_DATA);
2097
2098 if (! deep_p)
2099 {
2100 widget_value *cur = val->contents;
49853a4d 2101 xg_update_menubar (menubar, f, &list, list, 0, cur,
f392e843
JD
2102 select_cb, highlight_cb, cl_data);
2103 }
2104 else
2105 {
2106 widget_value *cur;
2107
2108 /* Update all sub menus.
2109 We must keep the submenu names (GTK menu item widgets) since the
2110 X Window in the XEvent that activates the menu are those widgets. */
2111
2112 /* Update cl_data, menu_item things in F may have changed. */
2113 update_cl_data (cl_data, f, highlight_cb);
2114
2115 for (cur = val->contents; cur; cur = cur->next)
2116 {
49853a4d 2117 GList *iter;
f392e843
JD
2118 GtkWidget *sub = 0;
2119 GtkWidget *newsub;
2120 GtkMenuItem *witem;
2121
2122 /* Find sub menu that corresponds to val and update it. */
2123 for (iter = list ; iter; iter = g_list_next (iter))
2124 {
2125 witem = GTK_MENU_ITEM (iter->data);
2126 if (xg_item_label_same_p (witem, cur->name))
2127 {
2128 sub = gtk_menu_item_get_submenu (witem);
2129 break;
2130 }
2131 }
177c0ea7 2132
f392e843
JD
2133 newsub = xg_update_submenu (sub,
2134 f,
2135 cur->contents,
2136 select_cb,
2137 deactivate_cb,
2138 highlight_cb,
2139 cl_data);
2140 /* sub may still be NULL. If we just updated non deep and added
2141 a new menu bar item, it has no sub menu yet. So we set the
2142 newly created sub menu under witem. */
2143 if (newsub != sub)
2144 gtk_menu_item_set_submenu (witem, newsub);
2145
2146 }
2147 }
2148
49853a4d 2149 g_list_free (list);
f392e843
JD
2150 gtk_widget_show_all (menubar);
2151}
2152
2153/* Recompute all the widgets of frame F, when the menu bar has been
2154 changed. Value is non-zero if widgets were updated. */
2155
2156int
2157xg_update_frame_menubar (f)
2158 FRAME_PTR f;
2159{
2160 struct x_output *x = f->output_data.x;
2161 GtkRequisition req;
177c0ea7 2162
f392e843
JD
2163 if (!x->menubar_widget || GTK_WIDGET_MAPPED (x->menubar_widget))
2164 return 0;
2165
2166 BLOCK_INPUT;
2167
2168 gtk_box_pack_start (GTK_BOX (x->vbox_widget), x->menubar_widget,
2169 FALSE, FALSE, 0);
2170 gtk_box_reorder_child (GTK_BOX (x->vbox_widget), x->menubar_widget, 0);
2171
2172 gtk_widget_show_all (x->menubar_widget);
2173 gtk_widget_size_request (x->menubar_widget, &req);
2174
2175 FRAME_MENUBAR_HEIGHT (f) = req.height;
2176
2177 /* The height has changed, resize outer widget and set columns
2178 rows to what we had before adding the menu bar. */
2179 xg_resize_outer_widget (f, FRAME_WIDTH (f), FRAME_HEIGHT (f));
177c0ea7 2180
f392e843
JD
2181 SET_FRAME_GARBAGED (f);
2182 UNBLOCK_INPUT;
2183}
2184
2185/* Get rid of the menu bar of frame F, and free its storage.
2186 This is used when deleting a frame, and when turning off the menu bar. */
2187
2188void
2189free_frame_menubar (f)
2190 FRAME_PTR f;
2191{
2192 struct x_output *x = f->output_data.x;
2193
2194 if (x->menubar_widget)
2195 {
2196 BLOCK_INPUT;
2197
2198 gtk_container_remove (GTK_CONTAINER (x->vbox_widget), x->menubar_widget);
2199 /* The menubar and its children shall be deleted when removed from
2200 the container. */
2201 x->menubar_widget = 0;
2202 FRAME_MENUBAR_HEIGHT (f) = 0;
2203
2204 /* The height has changed, resize outer widget and set columns
2205 rows to what we had before removing the menu bar. */
2206 xg_resize_outer_widget (f, FRAME_WIDTH (f), FRAME_HEIGHT (f));
2207
2208 SET_FRAME_GARBAGED (f);
2209 UNBLOCK_INPUT;
2210 }
2211}
2212
2213
2214\f
2215/***********************************************************************
2216 Scroll bar functions
2217 ***********************************************************************/
2218
2219
2220/* Setting scroll bar values invokes the callback. Use this variable
2221 to indicate that callback should do nothing. */
2222int xg_ignore_gtk_scrollbar;
2223
2224/* After we send a scroll bar event, x_set_toolkit_scroll_bar_thumb will
2225 be called. For some reason that needs to be debugged, it gets called
2226 with bad values. Thus, we set this variable to ignore those calls. */
2227int xg_ignore_next_thumb;
2228
2229/* SET_SCROLL_BAR_X_WINDOW assumes the second argument fits in
2230 32 bits. But we want to store pointers, and they may be larger
2231 than 32 bits. Keep a mapping from integer index to widget pointers
2232 to get around the 32 bit limitation. */
2233static struct
2234{
2235 GtkWidget **widgets;
2236 int max_size;
2237 int used;
81e302ef 2238} id_to_widget;
f392e843
JD
2239
2240/* Grow this much every time we need to allocate more */
2241#define ID_TO_WIDGET_INCR 32
2242
2243/* Store the widget pointer W in id_to_widget and return the integer index. */
2244static int
2245xg_store_widget_in_map (w)
2246 GtkWidget *w;
2247{
2248 int i;
2249
2250 if (id_to_widget.max_size == id_to_widget.used)
2251 {
2252 int new_size = id_to_widget.max_size + ID_TO_WIDGET_INCR;
2253
2254 id_to_widget.widgets = xrealloc (id_to_widget.widgets,
2255 sizeof (GtkWidget *)*new_size);
2256
2257 for (i = id_to_widget.max_size; i < new_size; ++i)
2258 id_to_widget.widgets[i] = 0;
2259 id_to_widget.max_size = new_size;
2260 }
2261
2262 /* Just loop over the array and find a free place. After all,
2263 how many scroll bars are we creating? Should be a small number.
2264 The check above guarantees we will find a free place. */
2265 for (i = 0; i < id_to_widget.max_size; ++i)
2266 {
2267 if (! id_to_widget.widgets[i])
2268 {
2269 id_to_widget.widgets[i] = w;
2270 ++id_to_widget.used;
2271
2272 return i;
2273 }
2274 }
2275
2276 /* Should never end up here */
2277 abort ();
2278}
2279
2280/* Remove pointer at IDX from id_to_widget.
2281 Called when scroll bar is destroyed. */
2282static void
2283xg_remove_widget_from_map (idx)
2284 int idx;
2285{
2286 if (idx < id_to_widget.max_size && id_to_widget.widgets[idx] != 0)
2287 {
2288 id_to_widget.widgets[idx] = 0;
2289 --id_to_widget.used;
2290 }
2291}
2292
2293/* Get the widget pointer at IDX from id_to_widget. */
2294static GtkWidget *
2295xg_get_widget_from_map (idx)
2296 int idx;
2297{
2298 if (idx < id_to_widget.max_size && id_to_widget.widgets[idx] != 0)
2299 return id_to_widget.widgets[idx];
2300
2301 return 0;
2302}
2303
3a8a22fc
JD
2304/* Return the scrollbar id for X Window WID.
2305 Return -1 if WID not in id_to_widget. */
2306int
2307xg_get_scroll_id_for_window (wid)
2308 Window wid;
2309{
2310 int idx;
2311 GtkWidget *w;
2312
2313 w = xg_win_to_widget (wid);
2314
2315 if (w)
2316 {
2317 for (idx = 0; idx < id_to_widget.max_size; ++idx)
2318 if (id_to_widget.widgets[idx] == w)
2319 return idx;
2320 }
2321
2322 return -1;
2323}
2324
f392e843
JD
2325/* Callback invoked when scroll bar WIDGET is destroyed.
2326 DATA is the index into id_to_widget for WIDGET.
2327 We free pointer to last scroll bar value here and remove the index. */
2328static void
2329xg_gtk_scroll_destroy (widget, data)
2330 GtkWidget *widget;
2331 gpointer data;
2332{
2333 gpointer p;
2334 int id = (int)data;
177c0ea7 2335
f392e843
JD
2336 p = g_object_get_data (G_OBJECT (widget), XG_LAST_SB_DATA);
2337 if (p) xfree (p);
2338 xg_remove_widget_from_map (id);
2339}
2340
2341/* Callback for button press/release events. Used to start timer so that
2342 the scroll bar repetition timer in GTK gets handeled.
2343 WIDGET is the scroll bar widget the event is for (not used).
2344 EVENT contains the event.
2345 USER_DATA is 0 (not used).
2346
2347 Returns FALSE to tell GTK that it shall continue propagate the event
2348 to widgets. */
2349static gboolean
2350scroll_bar_button_cb (widget, event, user_data)
2351 GtkWidget *widget;
2352 GdkEventButton *event;
2353 gpointer user_data;
2354{
2355 if (event->type == GDK_BUTTON_PRESS && ! xg_timer)
2356 xg_start_timer ();
2357 else if (event->type == GDK_BUTTON_RELEASE && xg_timer)
2358 xg_stop_timer ();
2359
2360 return FALSE;
2361}
2362
2363/* Create a scroll bar widget for frame F. Store the scroll bar
2364 in BAR.
2365 SCROLL_CALLBACK is the callback to invoke when the value of the
2366 bar changes.
2367 SCROLL_BAR_NAME is the name we use for the scroll bar. Can be used
2368 to set resources for the widget. */
2369void
2370xg_create_scroll_bar (f, bar, scroll_callback, scroll_bar_name)
2371 FRAME_PTR f;
2372 struct scroll_bar *bar;
2373 GCallback scroll_callback;
2374 char *scroll_bar_name;
2375{
2376 GtkWidget *wscroll;
2377 GtkObject *vadj;
2378 int scroll_id;
177c0ea7 2379
f392e843
JD
2380 /* Page, step increment values are not so important here, they
2381 will be corrected in x_set_toolkit_scroll_bar_thumb. */
2382 vadj = gtk_adjustment_new (XG_SB_MIN, XG_SB_MIN, XG_SB_MAX,
2383 0.1, 0.1, 0.1);
2384
2385 wscroll = gtk_vscrollbar_new (GTK_ADJUSTMENT (vadj));
2386 gtk_widget_set_name (wscroll, scroll_bar_name);
2387 gtk_range_set_update_policy (GTK_RANGE (wscroll), GTK_UPDATE_CONTINUOUS);
177c0ea7 2388
f392e843 2389 scroll_id = xg_store_widget_in_map (wscroll);
177c0ea7 2390
f392e843
JD
2391 g_signal_connect (G_OBJECT (vadj),
2392 "value-changed",
2393 scroll_callback,
2394 (gpointer)bar);
2395 g_signal_connect (G_OBJECT (wscroll),
2396 "destroy",
2397 G_CALLBACK (xg_gtk_scroll_destroy),
2398 (gpointer)scroll_id);
2399
2400 /* Connect to button press and button release to detect if any scroll bar
2401 has the pointer. */
2402 g_signal_connect (G_OBJECT (wscroll),
2403 "button-press-event",
2404 G_CALLBACK (scroll_bar_button_cb),
3a8a22fc 2405 0);
f392e843
JD
2406 g_signal_connect (G_OBJECT (wscroll),
2407 "button-release-event",
2408 G_CALLBACK (scroll_bar_button_cb),
2409 0);
177c0ea7 2410
f392e843
JD
2411 gtk_fixed_put (GTK_FIXED (f->output_data.x->edit_widget),
2412 wscroll, 0, 0);
2413
2414 /* Set the cursor to an arrow. */
2415 xg_set_cursor (wscroll, &xg_left_ptr_cursor);
2416
2417 SET_SCROLL_BAR_X_WINDOW (bar, scroll_id);
2418}
2419
2420/* Make the scroll bar represented by SCROLLBAR_ID visible. */
2421void
2422xg_show_scroll_bar (scrollbar_id)
2423 int scrollbar_id;
2424{
2425 GtkWidget *w = xg_get_widget_from_map (scrollbar_id);
2426 if (w)
2427 gtk_widget_show (w);
2428}
2429
2430/* Remove the scroll bar represented by SCROLLBAR_ID from the frame F. */
2431void
2432xg_remove_scroll_bar (f, scrollbar_id)
2433 FRAME_PTR f;
2434 int scrollbar_id;
2435{
2436 GtkWidget *w = xg_get_widget_from_map (scrollbar_id);
2437 if (w)
2438 {
2439 gtk_widget_destroy (w);
2440 SET_FRAME_GARBAGED (f);
2441 }
2442}
2443
2444
2445/* Update the position of the vertical scroll bar represented by SCROLLBAR_ID
2446 in frame F.
2447 TOP/LEFT are the new pixel positions where the bar shall appear.
2448 WIDTH, HEIGHT is the size in pixels the bar shall have. */
2449void
177c0ea7 2450xg_update_scrollbar_pos (f, scrollbar_id, top, left, width, height)
f392e843
JD
2451 FRAME_PTR f;
2452 int scrollbar_id;
2453 int top;
2454 int left;
2455 int width;
2456 int height;
2457{
f392e843 2458
49853a4d
JD
2459 GtkWidget *wscroll = xg_get_widget_from_map (scrollbar_id);
2460
2461 if (wscroll)
2462 {
2463 int gheight = max (height, 1);
f392e843 2464
49853a4d
JD
2465 gtk_fixed_move (GTK_FIXED (f->output_data.x->edit_widget),
2466 wscroll, left, top);
f392e843 2467
49853a4d 2468 gtk_widget_set_size_request (wscroll, width, gheight);
f392e843 2469
49853a4d
JD
2470 /* Must force out update so wscroll gets the resize.
2471 Otherwise, the gdk_window_clear clears the old window size. */
2472 gdk_window_process_all_updates ();
f392e843 2473
49853a4d
JD
2474 /* The scroll bar doesn't explicitly redraw the whole window
2475 when a resize occurs. Since the scroll bar seems to be fixed
2476 in width it doesn't fill the space reserved, so we must clear
2477 the whole window. */
2478 gdk_window_clear (wscroll->window);
f392e843 2479
49853a4d
JD
2480 /* Since we are not using a pure gtk event loop, we must force out
2481 pending update events with this call. */
2482 gdk_window_process_all_updates ();
f392e843 2483
49853a4d
JD
2484 SET_FRAME_GARBAGED (f);
2485 cancel_mouse_face (f);
2486 }
f392e843
JD
2487}
2488
2489/* Set the thumb size and position of scroll bar BAR. We are currently
2490 displaying PORTION out of a whole WHOLE, and our position POSITION. */
2491void
2492xg_set_toolkit_scroll_bar_thumb (bar, portion, position, whole)
2493 struct scroll_bar *bar;
2494 int portion, position, whole;
2495{
2496 GtkWidget *wscroll = xg_get_widget_from_map (SCROLL_BAR_X_WINDOW (bar));
2497
2498 FRAME_PTR f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
2499
2500 BLOCK_INPUT;
2501 if (wscroll && ! xg_ignore_next_thumb)
2502 {
2503 GtkAdjustment *adj;
2504 gdouble shown;
2505 gdouble top;
2506 int size, value;
177c0ea7 2507
f392e843
JD
2508 adj = gtk_range_get_adjustment (GTK_RANGE (wscroll));
2509
2510 if (whole <= 0)
2511 top = 0, shown = 1;
2512 else
2513 {
2514 shown = (gdouble) portion / whole;
2515 top = (gdouble) position / whole;
2516 }
2517
2518 size = shown * whole;
2519 size = min (size, whole);
2520 size = max (size, 1);
2521
2522 value = top * whole;
2523 value = min (value, whole - size);
2524 value = max (value, XG_SB_MIN);
2525
2526 adj->upper = max (whole, size);
2527 adj->page_size = (int)size;
2528
2529 /* Assume a page increment is about 95% of the page size */
2530 adj->page_increment = (int) (0.95*adj->page_size);
2531
2532 /* Assume all lines are equal. */
2533 adj->step_increment = portion / max (1, FRAME_HEIGHT (f));
2534
2535 /* gtk_range_set_value invokes the callback. Set
2536 ignore_gtk_scrollbar to make the callback do nothing */
2537 xg_ignore_gtk_scrollbar = 1;
2538 gtk_range_set_value (GTK_RANGE (wscroll), (gdouble)value);
2539 xg_ignore_gtk_scrollbar = 0;
2540 }
2541
2542 /* Make sure the scroll bar is redrawn with new thumb */
2543 gtk_widget_queue_draw (wscroll);
2544 gdk_window_process_all_updates ();
2545 xg_ignore_next_thumb = 0;
2546 UNBLOCK_INPUT;
2547}
2548
2549\f
2550/***********************************************************************
2551 Tool bar functions
2552 ***********************************************************************/
2553/* The key for the data we put in the GtkImage widgets. The data is
2554 the image used by Emacs. We use this to see if we need to update
2555 the GtkImage with a new image. */
2556#define XG_TOOL_BAR_IMAGE_DATA "emacs-tool-bar-image"
2557
2558/* Callback function invoked when a tool bar item is pressed.
2559 W is the button widget in the tool bar that got pressed,
2560 CLIENT_DATA is an integer that is the index of the button in the
2561 tool bar. 0 is the first button. */
2562static void
2563xg_tool_bar_callback (w, client_data)
2564 GtkWidget *w;
2565 gpointer client_data;
2566{
2567 int idx = (int)client_data;
2568 FRAME_PTR f = (FRAME_PTR) g_object_get_data (G_OBJECT (w), XG_FRAME_DATA);
2569 Lisp_Object key, frame;
2570 struct input_event event;
2571
2572 if (! f || ! f->n_tool_bar_items || NILP (f->tool_bar_items))
2573 return;
2574
2575 idx *= TOOL_BAR_ITEM_NSLOTS;
177c0ea7 2576
f392e843
JD
2577 key = AREF (f->tool_bar_items, idx + TOOL_BAR_ITEM_KEY);
2578 XSETFRAME (frame, f);
2579 event.kind = TOOL_BAR_EVENT;
2580 event.frame_or_window = frame;
2581 event.arg = frame;
2582 kbd_buffer_store_event (&event);
2583
2584 event.kind = TOOL_BAR_EVENT;
2585 event.frame_or_window = frame;
2586 event.arg = key;
2587 event.modifiers = 0; /* These are not available. */
2588 kbd_buffer_store_event (&event);
2589}
2590
2591/* This callback is called when a tool bar is detached. We must set
2592 the height of the tool bar to zero when this happens so frame sizes
2593 are correctly calculated.
2594 WBOX is the handle box widget that enables detach/attach of the tool bar.
2595 W is the tool bar widget.
2596 CLIENT_DATA is a pointer to the frame the tool bar belongs to. */
2597static void
2598xg_tool_bar_detach_callback (wbox, w, client_data)
2599 GtkHandleBox *wbox;
2600 GtkWidget *w;
2601 gpointer client_data;
2602{
2603 FRAME_PTR f = (FRAME_PTR) client_data;
2604
2605 if (f)
2606 {
2607 /* When detaching a tool bar, not everything dissapear. There are
2608 a few pixels left that are used to drop the tool bar back into
2609 place. */
2610 int bw = gtk_container_get_border_width (GTK_CONTAINER (wbox));
2611 FRAME_TOOLBAR_HEIGHT (f) = 2;
2612
2613 /* The height has changed, resize outer widget and set columns
2614 rows to what we had before detaching the tool bar. */
2615 xg_resize_outer_widget (f, FRAME_WIDTH (f), FRAME_HEIGHT (f));
2616 }
2617}
2618
2619/* This callback is called when a tool bar is reattached. We must set
2620 the height of the tool bar when this happens so frame sizes
2621 are correctly calculated.
2622 WBOX is the handle box widget that enables detach/attach of the tool bar.
2623 W is the tool bar widget.
2624 CLIENT_DATA is a pointer to the frame the tool bar belongs to. */
2625static void
2626xg_tool_bar_attach_callback (wbox, w, client_data)
2627 GtkHandleBox *wbox;
2628 GtkWidget *w;
2629 gpointer client_data;
2630{
2631 FRAME_PTR f = (FRAME_PTR) client_data;
2632
2633 if (f)
2634 {
2635 GtkRequisition req;
2636
2637 gtk_widget_size_request (w, &req);
2638 FRAME_TOOLBAR_HEIGHT (f) = req.height;
2639
2640 /* The height has changed, resize outer widget and set columns
2641 rows to what we had before detaching the tool bar. */
2642 xg_resize_outer_widget (f, FRAME_WIDTH (f), FRAME_HEIGHT (f));
2643 }
2644}
2645
2646/* This callback is called when the mouse enters or leaves a tool bar item.
2647 It is used for displaying and hiding the help text.
2648 W is the tool bar item, a button.
2649 EVENT is either an enter event or leave event.
2650 CLIENT_DATA is an integer that is the index of the button in the
2651 tool bar. 0 is the first button.
2652
2653 Returns FALSE to tell GTK to keep processing this event. */
2654static gboolean
2655xg_tool_bar_help_callback (w, event, client_data)
2656 GtkWidget *w;
2657 GdkEventCrossing *event;
2658 gpointer client_data;
2659{
2660 int idx = (int)client_data;
2661 FRAME_PTR f = (FRAME_PTR) g_object_get_data (G_OBJECT (w), XG_FRAME_DATA);
2662 Lisp_Object help, frame;
2663
2664 if (! GTK_IS_BUTTON (w))
2665 {
2666 return FALSE;
2667 }
2668
2669 if (! f || ! f->n_tool_bar_items || NILP (f->tool_bar_items))
2670 return;
2671
2672 if (event->type == GDK_ENTER_NOTIFY)
2673 {
2674 idx *= TOOL_BAR_ITEM_NSLOTS;
2675 help = AREF (f->tool_bar_items, idx + TOOL_BAR_ITEM_HELP);
2676
2677 if (NILP (help))
2678 help = AREF (f->tool_bar_items, idx + TOOL_BAR_ITEM_CAPTION);
2679 }
2680 else
2681 help = Qnil;
2682
2683 XSETFRAME (frame, f);
2684 kbd_buffer_store_help_event (frame, help);
2685
2686 return FALSE;
2687}
2688
2689
f098b121
JD
2690/* This callback is called when a tool bar item shall be redrawn.
2691 It modifies the expose event so that the GtkImage widget redraws the
2692 whole image. This to overcome a bug that makes GtkImage draw the image
2693 in the wrong place when it tries to redraw just a part of the image.
2694 W is the GtkImage to be redrawn.
2695 EVENT is the expose event for W.
2696 CLIENT_DATA is unused.
2697
2698 Returns FALSE to tell GTK to keep processing this event. */
2699static gboolean
3a8a22fc 2700xg_tool_bar_item_expose_callback (w, event, client_data)
f098b121
JD
2701 GtkWidget *w;
2702 GdkEventExpose *event;
2703 gpointer client_data;
2704{
2705 event->area.x = event->area.y = 0;
2706 event->area.width = event->area.height = 1000;
2707 return FALSE;
2708}
2709
3a8a22fc
JD
2710/* This callback is called when a tool bar shall be redrawn.
2711 We need to update the tool bar from here in case the image cache
2712 has deleted the pixmaps used in the tool bar.
2713 W is the GtkToolbar to be redrawn.
2714 EVENT is the expose event for W.
2715 CLIENT_DATA is pointing to the frame for this tool bar.
2716
2717 Returns FALSE to tell GTK to keep processing this event. */
2718static gboolean
2719xg_tool_bar_expose_callback (w, event, client_data)
2720 GtkWidget *w;
2721 GdkEventExpose *event;
2722 gpointer client_data;
2723{
2724 update_frame_tool_bar((FRAME_PTR)client_data);
2725 return FALSE;
2726}
2727
f392e843
JD
2728static void
2729xg_create_tool_bar (f)
2730 FRAME_PTR f;
2731{
2732 struct x_output *x = f->output_data.x;
2733 GtkRequisition req;
2734 int vbox_pos = x->menubar_widget ? 1 : 0;
2735
2736 x->toolbar_widget = gtk_toolbar_new ();
2737 x->handlebox_widget = gtk_handle_box_new ();
2738 gtk_container_add (GTK_CONTAINER (x->handlebox_widget),
2739 x->toolbar_widget);
177c0ea7 2740
f392e843
JD
2741 gtk_box_pack_start (GTK_BOX (x->vbox_widget), x->handlebox_widget,
2742 FALSE, FALSE, 0);
177c0ea7 2743
f392e843
JD
2744 gtk_box_reorder_child (GTK_BOX (x->vbox_widget), x->handlebox_widget,
2745 vbox_pos);
2746
f098b121
JD
2747 gtk_widget_set_name (x->toolbar_widget, "emacs-toolbar");
2748
2749 /* We only have icons, so override any user setting. We could
2750 use the caption property of the toolbar item (see update_frame_tool_bar
2751 below), but some of those strings are long, making the toolbar so
2752 long it does not fit on the screen. The GtkToolbar widget makes every
2753 item equal size, so the longest caption determine the size of every
2754 tool bar item. I think the creators of the GtkToolbar widget
2755 counted on 4 or 5 character long strings. */
2756 gtk_toolbar_set_style (GTK_TOOLBAR (x->toolbar_widget), GTK_TOOLBAR_ICONS);
2757 gtk_toolbar_set_orientation (GTK_TOOLBAR (x->toolbar_widget),
2758 GTK_ORIENTATION_HORIZONTAL);
2759
f392e843
JD
2760 g_signal_connect (G_OBJECT (x->handlebox_widget), "child-detached",
2761 G_CALLBACK (xg_tool_bar_detach_callback), f);
2762 g_signal_connect (G_OBJECT (x->handlebox_widget), "child-attached",
2763 G_CALLBACK (xg_tool_bar_attach_callback), f);
3a8a22fc
JD
2764 g_signal_connect (G_OBJECT (x->toolbar_widget),
2765 "expose-event",
2766 G_CALLBACK (xg_tool_bar_expose_callback),
2767 f);
f392e843
JD
2768
2769 gtk_widget_show_all (x->handlebox_widget);
2770
2771 gtk_widget_size_request (x->toolbar_widget, &req);
2772 FRAME_TOOLBAR_HEIGHT (f) = req.height;
177c0ea7 2773
f392e843
JD
2774 /* The height has changed, resize outer widget and set columns
2775 rows to what we had before adding the tool bar. */
2776 xg_resize_outer_widget (f, FRAME_WIDTH (f), FRAME_HEIGHT (f));
177c0ea7 2777
f392e843
JD
2778 SET_FRAME_GARBAGED (f);
2779}
2780
2781void
2782update_frame_tool_bar (f)
2783 FRAME_PTR f;
2784{
2785 int i;
2786 GtkRequisition old_req, new_req;
2787 GList *icon_list;
49853a4d 2788 GList *iter;
f392e843
JD
2789 struct x_output *x = f->output_data.x;
2790
2791 if (! FRAME_GTK_WIDGET (f))
2792 return;
2793
2794 BLOCK_INPUT;
177c0ea7 2795
f392e843
JD
2796 if (! x->toolbar_widget)
2797 xg_create_tool_bar (f);
2798
2799 gtk_widget_size_request (x->toolbar_widget, &old_req);
2800
2801 icon_list = gtk_container_get_children (GTK_CONTAINER (x->toolbar_widget));
49853a4d 2802 iter = icon_list;
177c0ea7 2803
f392e843
JD
2804 for (i = 0; i < f->n_tool_bar_items; ++i)
2805 {
2806#define PROP(IDX) AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
2807
2808 int enabled_p = !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P));
2809 int selected_p = !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P));
2810 int idx;
2811 int img_id;
2812 struct image *img;
2813 Lisp_Object image;
49853a4d 2814 GtkWidget *wicon = iter ? GTK_WIDGET (iter->data) : 0;
26b74a0b 2815
49853a4d 2816 if (iter) iter = g_list_next (iter);
f392e843
JD
2817
2818 /* If image is a vector, choose the image according to the
2819 button state. */
2820 image = PROP (TOOL_BAR_ITEM_IMAGES);
2821 if (VECTORP (image))
2822 {
2823 if (enabled_p)
2824 idx = (selected_p
2825 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
2826 : TOOL_BAR_IMAGE_ENABLED_DESELECTED);
2827 else
2828 idx = (selected_p
2829 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
2830 : TOOL_BAR_IMAGE_DISABLED_DESELECTED);
2831
2832 xassert (ASIZE (image) >= idx);
2833 image = AREF (image, idx);
2834 }
2835 else
2836 idx = -1;
2837
2838 /* Ignore invalid image specifications. */
2839 if (!valid_image_p (image))
2840 {
2841 if (wicon) gtk_widget_hide (wicon);
2842 continue;
2843 }
2844
2845 img_id = lookup_image (f, image);
2846 img = IMAGE_FROM_ID (f, img_id);
1d1885fc 2847 prepare_image_for_display (f, img);
f392e843 2848
1d1885fc
JD
2849 if (img->load_failed_p || img->pixmap == None)
2850 {
2851 if (wicon) gtk_widget_hide (wicon);
2852 continue;
2853 }
177c0ea7 2854
f392e843
JD
2855 if (! wicon)
2856 {
2857 GdkPixmap *gpix = gdk_pixmap_foreign_new (img->pixmap);
2858 GdkBitmap *gmask = img->mask ?
2859 (GdkBitmap*) gdk_pixmap_foreign_new (img->mask) : 0;
2860
2861 GtkWidget *w = gtk_image_new_from_pixmap (gpix, gmask);
2862 gtk_toolbar_append_item (GTK_TOOLBAR (x->toolbar_widget),
2863 0, 0, 0,
2864 w,
2865 GTK_SIGNAL_FUNC (xg_tool_bar_callback),
2866 (gpointer)i);
177c0ea7 2867
f392e843
JD
2868 /* Save the image so we can see if an update is needed when
2869 this function is called again. */
2870 g_object_set_data (G_OBJECT (w), XG_TOOL_BAR_IMAGE_DATA,
26b74a0b 2871 (gpointer)img->pixmap);
f392e843 2872
f098b121 2873 /* Catch expose events to overcome an annoying redraw bug, see
3a8a22fc 2874 comment for xg_tool_bar_item_expose_callback. */
f098b121
JD
2875 g_signal_connect (G_OBJECT (w),
2876 "expose-event",
3a8a22fc 2877 G_CALLBACK (xg_tool_bar_item_expose_callback),
f098b121
JD
2878 0);
2879
f392e843
JD
2880 /* We must set sensitive on the button that is the parent
2881 of the GtkImage parent. Go upwards until we find the button. */
2882 while (! GTK_IS_BUTTON (w))
2883 w = gtk_widget_get_parent (w);
177c0ea7 2884
f392e843
JD
2885 if (w)
2886 {
2887 /* Save the frame in the button so the xg_tool_bar_callback
2888 can get at it. */
2889 g_object_set_data (G_OBJECT (w), XG_FRAME_DATA, (gpointer)f);
2890 gtk_widget_set_sensitive (w, enabled_p);
2891
2892 /* Use enter/leave notify to show help. We use the events
2893 rather than the GtkButton specific signals "enter" and
2894 "leave", so we can have only one callback. The event
2895 will tell us what kind of event it is. */
2896 g_signal_connect (G_OBJECT (w),
2897 "enter-notify-event",
2898 G_CALLBACK (xg_tool_bar_help_callback),
2899 (gpointer)i);
2900 g_signal_connect (G_OBJECT (w),
2901 "leave-notify-event",
2902 G_CALLBACK (xg_tool_bar_help_callback),
2903 (gpointer)i);
2904 }
2905 }
2906 else
2907 {
2908 /* The child of the tool bar is a button. Inside that button
2909 is a vbox. Inside that vbox is the GtkImage. */
2910 GtkWidget *wvbox = gtk_bin_get_child (GTK_BIN (wicon));
49853a4d
JD
2911 GList *chlist = gtk_container_get_children (GTK_CONTAINER (wvbox));
2912 GtkImage *wimage = GTK_IMAGE (chlist->data);
26b74a0b
JD
2913 Pixmap old_img = (Pixmap)g_object_get_data (G_OBJECT (wimage),
2914 XG_TOOL_BAR_IMAGE_DATA);
49853a4d 2915 g_list_free (chlist);
f392e843 2916
26b74a0b 2917 if (old_img != img->pixmap)
f392e843
JD
2918 {
2919 GdkPixmap *gpix = gdk_pixmap_foreign_new (img->pixmap);
2920 GdkBitmap *gmask = img->mask ?
2921 (GdkBitmap*) gdk_pixmap_foreign_new (img->mask) : 0;
2922
2923 gtk_image_set_from_pixmap (wimage, gpix, gmask);
2924 }
2925
2926 g_object_set_data (G_OBJECT (wimage), XG_TOOL_BAR_IMAGE_DATA,
26b74a0b 2927 (gpointer)img->pixmap);
f392e843
JD
2928
2929 gtk_widget_set_sensitive (wicon, enabled_p);
2930 gtk_widget_show (wicon);
2931 }
177c0ea7 2932
f392e843
JD
2933#undef PROP
2934 }
2935
2936 /* Remove buttons not longer needed. We just hide them so they
2937 can be reused later on. */
49853a4d 2938 while (iter)
f392e843 2939 {
49853a4d 2940 GtkWidget *w = GTK_WIDGET (iter->data);
f392e843 2941 gtk_widget_hide (w);
49853a4d 2942 iter = g_list_next (iter);
f392e843
JD
2943 }
2944
2945 gtk_widget_size_request (x->toolbar_widget, &new_req);
2946 if (old_req.height != new_req.height)
2947 {
2948 FRAME_TOOLBAR_HEIGHT (f) = new_req.height;
2949 xg_resize_outer_widget (f, FRAME_WIDTH (f), FRAME_HEIGHT (f));
2950 }
2951
2952 /* Must force out update so changed images gets redrawn. */
2953 gdk_window_process_all_updates ();
2954
49853a4d
JD
2955 if (icon_list) g_list_free (icon_list);
2956
f392e843
JD
2957 UNBLOCK_INPUT;
2958}
2959
2960void
2961free_frame_tool_bar (f)
2962 FRAME_PTR f;
2963{
2964 struct x_output *x = f->output_data.x;
2965
2966 if (x->toolbar_widget)
2967 {
f392e843
JD
2968 BLOCK_INPUT;
2969 gtk_container_remove (GTK_CONTAINER (x->vbox_widget),
2970 x->handlebox_widget);
2971 x->toolbar_widget = 0;
2972 x->handlebox_widget = 0;
2973 FRAME_TOOLBAR_HEIGHT (f) = 0;
2974
2975 /* The height has changed, resize outer widget and set columns
2976 rows to what we had before removing the tool bar. */
2977 xg_resize_outer_widget (f, FRAME_WIDTH (f), FRAME_HEIGHT (f));
2978
2979 SET_FRAME_GARBAGED (f);
2980 UNBLOCK_INPUT;
2981 }
2982}
2983
2984
2985\f
2986/***********************************************************************
2987 Initializing
2988 ***********************************************************************/
2989void
2990xg_initialize ()
2991{
2992 xg_ignore_gtk_scrollbar = 0;
2993 xg_ignore_next_thumb = 0;
2994 xg_left_ptr_cursor = 0;
2995 xg_did_tearoff = 0;
2996
2997 xg_menu_cb_list.prev = xg_menu_cb_list.next =
2998 xg_menu_item_cb_list.prev = xg_menu_item_cb_list.next = 0;
2999
81e302ef
JD
3000 id_to_widget.max_size = id_to_widget.used = 0;
3001 id_to_widget.widgets = 0;
3002
f392e843
JD
3003 /* Remove F10 as a menu accelerator, it does not mix well with Emacs key
3004 bindings. It doesn't seem to be any way to remove properties,
3005 so we set it to VoidSymbol which in X means "no key". */
3006 gtk_settings_set_string_property (gtk_settings_get_default (),
3007 "gtk-menu-bar-accel",
3008 "VoidSymbol",
3009 EMACS_CLASS);
81e302ef
JD
3010
3011 /* Make GTK text input widgets use Emacs style keybindings. This is
3012 Emacs after all. */
3013 gtk_settings_set_string_property (gtk_settings_get_default (),
3014 "gtk-key-theme-name",
3015 "Emacs",
3016 EMACS_CLASS);
f392e843
JD
3017}
3018
3019#endif /* USE_GTK */