Fix race conditions with signal handlers and errno.
[emacs.git] / src / gtkutil.c
blob3bce5be9cd01fc3a5585caf7093fd5bdb08c7ef3
1 /* Functions for creating and updating GTK widgets.
3 Copyright (C) 2003-2012 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
20 #include <config.h>
22 #ifdef USE_GTK
23 #include <float.h>
24 #include <signal.h>
25 #include <stdio.h>
26 #include <setjmp.h>
28 #include <c-ctype.h>
30 #include "lisp.h"
31 #include "xterm.h"
32 #include "blockinput.h"
33 #include "syssignal.h"
34 #include "window.h"
35 #include "gtkutil.h"
36 #include "termhooks.h"
37 #include "keyboard.h"
38 #include "charset.h"
39 #include "coding.h"
40 #include <gdk/gdkkeysyms.h>
41 #include "xsettings.h"
43 #ifdef HAVE_XFT
44 #include <X11/Xft/Xft.h>
45 #endif
47 #ifdef HAVE_GTK3
48 #include <gtk/gtkx.h>
49 #include "emacsgtkfixed.h"
50 #endif
52 #define FRAME_TOTAL_PIXEL_HEIGHT(f) \
53 (FRAME_PIXEL_HEIGHT (f) + FRAME_MENUBAR_HEIGHT (f) + FRAME_TOOLBAR_HEIGHT (f))
55 #define FRAME_TOTAL_PIXEL_WIDTH(f) \
56 (FRAME_PIXEL_WIDTH (f) + FRAME_TOOLBAR_WIDTH (f))
58 #ifndef HAVE_GTK_WIDGET_SET_HAS_WINDOW
59 #define gtk_widget_set_has_window(w, b) \
60 (gtk_fixed_set_has_window (GTK_FIXED (w), b))
61 #endif
62 #ifndef HAVE_GTK_DIALOG_GET_ACTION_AREA
63 #define gtk_dialog_get_action_area(w) ((w)->action_area)
64 #define gtk_dialog_get_content_area(w) ((w)->vbox)
65 #endif
66 #ifndef HAVE_GTK_WIDGET_GET_SENSITIVE
67 #define gtk_widget_get_sensitive(w) (GTK_WIDGET_SENSITIVE (w))
68 #endif
69 #ifndef HAVE_GTK_ADJUSTMENT_GET_PAGE_SIZE
70 #define gtk_adjustment_set_page_size(w, s) ((w)->page_size = (s))
71 #define gtk_adjustment_set_page_increment(w, s) ((w)->page_increment = (s))
72 #define gtk_adjustment_get_step_increment(w) ((w)->step_increment)
73 #define gtk_adjustment_set_step_increment(w, s) ((w)->step_increment = (s))
74 #endif
75 #if GTK_MAJOR_VERSION > 2 || GTK_MINOR_VERSION > 11
76 #define remove_submenu(w) gtk_menu_item_set_submenu ((w), NULL)
77 #else
78 #define remove_submenu(w) gtk_menu_item_remove_submenu ((w))
79 #endif
81 #if GTK_MAJOR_VERSION > 3 || (GTK_MAJOR_VERSION == 3 && GTK_MINOR_VERSION >= 2)
82 #define USE_NEW_GTK_FONT_CHOOSER 1
83 #else
84 #define USE_NEW_GTK_FONT_CHOOSER 0
85 #define gtk_font_chooser_dialog_new(x, y) \
86 gtk_font_selection_dialog_new (x)
87 #undef GTK_FONT_CHOOSER
88 #define GTK_FONT_CHOOSER(x) GTK_FONT_SELECTION_DIALOG (x)
89 #define gtk_font_chooser_set_font(x, y) \
90 gtk_font_selection_dialog_set_font_name (x, y)
91 #endif
93 #ifndef HAVE_GTK3
94 #ifdef USE_GTK_TOOLTIP
95 #define gdk_window_get_screen(w) gdk_drawable_get_screen (w)
96 #endif
97 #define gdk_window_get_geometry(w, a, b, c, d) \
98 gdk_window_get_geometry (w, a, b, c, d, 0)
99 #define gdk_x11_window_lookup_for_display(d, w) \
100 gdk_xid_table_lookup_for_display (d, w)
101 #define gtk_box_new(ori, spacing) \
102 ((ori) == GTK_ORIENTATION_HORIZONTAL \
103 ? gtk_hbox_new (FALSE, (spacing)) : gtk_vbox_new (FALSE, (spacing)))
104 #define gtk_scrollbar_new(ori, spacing) \
105 ((ori) == GTK_ORIENTATION_HORIZONTAL \
106 ? gtk_hscrollbar_new ((spacing)) : gtk_vscrollbar_new ((spacing)))
107 #ifndef GDK_KEY_g
108 #define GDK_KEY_g GDK_g
109 #endif
110 #endif /* HAVE_GTK3 */
112 #define XG_BIN_CHILD(x) gtk_bin_get_child (GTK_BIN (x))
114 static void update_theme_scrollbar_width (void);
116 #define TB_INFO_KEY "xg_frame_tb_info"
117 struct xg_frame_tb_info
119 Lisp_Object last_tool_bar;
120 Lisp_Object style;
121 int n_last_items;
122 int hmargin, vmargin;
123 GtkTextDirection dir;
127 /***********************************************************************
128 Display handling functions
129 ***********************************************************************/
131 /* Keep track of the default display, or NULL if there is none. Emacs
132 may close all its displays. */
134 static GdkDisplay *gdpy_def;
136 /* When the GTK widget W is to be created on a display for F that
137 is not the default display, set the display for W.
138 W can be a GtkMenu or a GtkWindow widget. */
140 static void
141 xg_set_screen (GtkWidget *w, FRAME_PTR f)
143 if (FRAME_X_DISPLAY (f) != DEFAULT_GDK_DISPLAY ())
145 GdkDisplay *gdpy = gdk_x11_lookup_xdisplay (FRAME_X_DISPLAY (f));
146 GdkScreen *gscreen = gdk_display_get_default_screen (gdpy);
148 if (GTK_IS_MENU (w))
149 gtk_menu_set_screen (GTK_MENU (w), gscreen);
150 else
151 gtk_window_set_screen (GTK_WINDOW (w), gscreen);
156 /* Open a display named by DISPLAY_NAME. The display is returned in *DPY.
157 *DPY is set to NULL if the display can't be opened.
159 Returns non-zero if display could be opened, zero if display could not
160 be opened, and less than zero if the GTK version doesn't support
161 multiple displays. */
163 void
164 xg_display_open (char *display_name, Display **dpy)
166 GdkDisplay *gdpy;
168 gdpy = gdk_display_open (display_name);
169 if (!gdpy_def && gdpy)
171 gdpy_def = gdpy;
172 gdk_display_manager_set_default_display (gdk_display_manager_get (),
173 gdpy);
176 *dpy = gdpy ? GDK_DISPLAY_XDISPLAY (gdpy) : NULL;
180 /* Close display DPY. */
182 void
183 xg_display_close (Display *dpy)
185 GdkDisplay *gdpy = gdk_x11_lookup_xdisplay (dpy);
187 /* If this is the default display, try to change it before closing.
188 If there is no other display to use, gdpy_def is set to NULL, and
189 the next call to xg_display_open resets the default display. */
190 if (gdk_display_get_default () == gdpy)
192 struct x_display_info *dpyinfo;
193 GdkDisplay *gdpy_new = NULL;
195 /* Find another display. */
196 for (dpyinfo = x_display_list; dpyinfo; dpyinfo = dpyinfo->next)
197 if (dpyinfo->display != dpy)
199 gdpy_new = gdk_x11_lookup_xdisplay (dpyinfo->display);
200 gdk_display_manager_set_default_display (gdk_display_manager_get (),
201 gdpy_new);
202 break;
204 gdpy_def = gdpy_new;
207 #if GTK_MAJOR_VERSION == 2 && GTK_MINOR_VERSION < 10
208 /* GTK 2.2-2.8 has a bug that makes gdk_display_close crash (bug
209 http://bugzilla.gnome.org/show_bug.cgi?id=85715). This way we
210 can continue running, but there will be memory leaks. */
211 g_object_run_dispose (G_OBJECT (gdpy));
212 #else
213 /* This seems to be fixed in GTK 2.10. */
214 gdk_display_close (gdpy);
215 #endif
219 /***********************************************************************
220 Utility functions
221 ***********************************************************************/
222 /* The next two variables and functions are taken from lwlib. */
223 static widget_value *widget_value_free_list;
224 static int malloc_cpt;
226 /* Allocate a widget_value structure, either by taking one from the
227 widget_value_free_list or by malloc:ing a new one.
229 Return a pointer to the allocated structure. */
231 widget_value *
232 malloc_widget_value (void)
234 widget_value *wv;
235 if (widget_value_free_list)
237 wv = widget_value_free_list;
238 widget_value_free_list = wv->free_list;
239 wv->free_list = 0;
241 else
243 wv = xmalloc (sizeof *wv);
244 malloc_cpt++;
246 memset (wv, 0, sizeof (widget_value));
247 return wv;
250 /* This is analogous to free. It frees only what was allocated
251 by malloc_widget_value, and no substructures. */
253 void
254 free_widget_value (widget_value *wv)
256 if (wv->free_list)
257 emacs_abort ();
259 if (malloc_cpt > 25)
261 /* When the number of already allocated cells is too big,
262 We free it. */
263 xfree (wv);
264 malloc_cpt--;
266 else
268 wv->free_list = widget_value_free_list;
269 widget_value_free_list = wv;
274 /* Create and return the cursor to be used for popup menus and
275 scroll bars on display DPY. */
277 GdkCursor *
278 xg_create_default_cursor (Display *dpy)
280 GdkDisplay *gdpy = gdk_x11_lookup_xdisplay (dpy);
281 return gdk_cursor_new_for_display (gdpy, GDK_LEFT_PTR);
284 static GdkPixbuf *
285 xg_get_pixbuf_from_pixmap (FRAME_PTR f, Pixmap pix)
287 int iunused;
288 GdkPixbuf *tmp_buf;
289 Window wunused;
290 unsigned int width, height, uunused;
291 XImage *xim;
293 XGetGeometry (FRAME_X_DISPLAY (f), pix, &wunused, &iunused, &iunused,
294 &width, &height, &uunused, &uunused);
296 xim = XGetImage (FRAME_X_DISPLAY (f), pix, 0, 0, width, height,
297 ~0, XYPixmap);
298 if (!xim) return 0;
300 tmp_buf = gdk_pixbuf_new_from_data ((guchar *) xim->data,
301 GDK_COLORSPACE_RGB,
302 FALSE,
303 xim->bitmap_unit,
304 width,
305 height,
306 xim->bytes_per_line,
307 NULL,
308 NULL);
309 XDestroyImage (xim);
310 return tmp_buf;
313 /* Apply GMASK to GPIX and return a GdkPixbuf with an alpha channel. */
315 static GdkPixbuf *
316 xg_get_pixbuf_from_pix_and_mask (FRAME_PTR f,
317 Pixmap pix,
318 Pixmap mask)
320 int width, height;
321 GdkPixbuf *icon_buf, *tmp_buf;
323 tmp_buf = xg_get_pixbuf_from_pixmap (f, pix);
324 icon_buf = gdk_pixbuf_add_alpha (tmp_buf, FALSE, 0, 0, 0);
325 g_object_unref (G_OBJECT (tmp_buf));
327 width = gdk_pixbuf_get_width (icon_buf);
328 height = gdk_pixbuf_get_height (icon_buf);
330 if (mask)
332 GdkPixbuf *mask_buf = xg_get_pixbuf_from_pixmap (f, mask);
333 guchar *pixels = gdk_pixbuf_get_pixels (icon_buf);
334 guchar *mask_pixels = gdk_pixbuf_get_pixels (mask_buf);
335 int rowstride = gdk_pixbuf_get_rowstride (icon_buf);
336 int mask_rowstride = gdk_pixbuf_get_rowstride (mask_buf);
337 int y;
339 for (y = 0; y < height; ++y)
341 guchar *iconptr, *maskptr;
342 int x;
344 iconptr = pixels + y * rowstride;
345 maskptr = mask_pixels + y * mask_rowstride;
347 for (x = 0; x < width; ++x)
349 /* In a bitmap, RGB is either 255/255/255 or 0/0/0. Checking
350 just R is sufficient. */
351 if (maskptr[0] == 0)
352 iconptr[3] = 0; /* 0, 1, 2 is R, G, B. 3 is alpha. */
354 iconptr += rowstride/width;
355 maskptr += mask_rowstride/width;
359 g_object_unref (G_OBJECT (mask_buf));
362 return icon_buf;
365 static Lisp_Object
366 file_for_image (Lisp_Object image)
368 Lisp_Object specified_file = Qnil;
369 Lisp_Object tail;
371 for (tail = XCDR (image);
372 NILP (specified_file) && CONSP (tail) && CONSP (XCDR (tail));
373 tail = XCDR (XCDR (tail)))
374 if (EQ (XCAR (tail), QCfile))
375 specified_file = XCAR (XCDR (tail));
377 return specified_file;
380 /* For the image defined in IMG, make and return a GtkImage. For displays with
381 8 planes or less we must make a GdkPixbuf and apply the mask manually.
382 Otherwise the highlighting and dimming the tool bar code in GTK does
383 will look bad. For display with more than 8 planes we just use the
384 pixmap and mask directly. For monochrome displays, GTK doesn't seem
385 able to use external pixmaps, it looks bad whatever we do.
386 The image is defined on the display where frame F is.
387 WIDGET is used to find the GdkColormap to use for the GdkPixbuf.
388 If OLD_WIDGET is NULL, a new widget is constructed and returned.
389 If OLD_WIDGET is not NULL, that widget is modified. */
391 static GtkWidget *
392 xg_get_image_for_pixmap (FRAME_PTR f,
393 struct image *img,
394 GtkWidget *widget,
395 GtkImage *old_widget)
397 GdkPixbuf *icon_buf;
399 /* If we have a file, let GTK do all the image handling.
400 This seems to be the only way to make insensitive and activated icons
401 look good in all cases. */
402 Lisp_Object specified_file = file_for_image (img->spec);
403 Lisp_Object file;
405 /* We already loaded the image once before calling this
406 function, so this only fails if the image file has been removed.
407 In that case, use the pixmap already loaded. */
409 if (STRINGP (specified_file)
410 && STRINGP (file = x_find_image_file (specified_file)))
412 if (! old_widget)
413 old_widget = GTK_IMAGE (gtk_image_new_from_file (SSDATA (file)));
414 else
415 gtk_image_set_from_file (old_widget, SSDATA (file));
417 return GTK_WIDGET (old_widget);
420 /* No file, do the image handling ourselves. This will look very bad
421 on a monochrome display, and sometimes bad on all displays with
422 certain themes. */
424 /* This is a workaround to make icons look good on pseudo color
425 displays. Apparently GTK expects the images to have an alpha
426 channel. If they don't, insensitive and activated icons will
427 look bad. This workaround does not work on monochrome displays,
428 and is strictly not needed on true color/static color displays (i.e.
429 16 bits and higher). But we do it anyway so we get a pixbuf that is
430 not associated with the img->pixmap. The img->pixmap may be removed
431 by clearing the image cache and then the tool bar redraw fails, since
432 Gtk+ assumes the pixmap is always there. */
433 icon_buf = xg_get_pixbuf_from_pix_and_mask (f, img->pixmap, img->mask);
435 if (icon_buf)
437 if (! old_widget)
438 old_widget = GTK_IMAGE (gtk_image_new_from_pixbuf (icon_buf));
439 else
440 gtk_image_set_from_pixbuf (old_widget, icon_buf);
442 g_object_unref (G_OBJECT (icon_buf));
445 return GTK_WIDGET (old_widget);
449 /* Set CURSOR on W and all widgets W contain. We must do like this
450 for scroll bars and menu because they create widgets internally,
451 and it is those widgets that are visible. */
453 static void
454 xg_set_cursor (GtkWidget *w, GdkCursor *cursor)
456 GdkWindow *window = gtk_widget_get_window (w);
457 GList *children = gdk_window_peek_children (window);
459 gdk_window_set_cursor (window, cursor);
461 /* The scroll bar widget has more than one GDK window (had to look at
462 the source to figure this out), and there is no way to set cursor
463 on widgets in GTK. So we must set the cursor for all GDK windows.
464 Ditto for menus. */
466 for ( ; children; children = g_list_next (children))
467 gdk_window_set_cursor (GDK_WINDOW (children->data), cursor);
470 /* Insert NODE into linked LIST. */
472 static void
473 xg_list_insert (xg_list_node *list, xg_list_node *node)
475 xg_list_node *list_start = list->next;
477 if (list_start) list_start->prev = node;
478 node->next = list_start;
479 node->prev = 0;
480 list->next = node;
483 /* Remove NODE from linked LIST. */
485 static void
486 xg_list_remove (xg_list_node *list, xg_list_node *node)
488 xg_list_node *list_start = list->next;
489 if (node == list_start)
491 list->next = node->next;
492 if (list->next) list->next->prev = 0;
494 else
496 node->prev->next = node->next;
497 if (node->next) node->next->prev = node->prev;
501 /* Allocate and return a utf8 version of STR. If STR is already
502 utf8 or NULL, just return a copy of STR.
503 A new string is allocated and the caller must free the result
504 with g_free. */
506 static char *
507 get_utf8_string (const char *str)
509 char *utf8_str;
511 if (!str) return NULL;
513 /* If not UTF-8, try current locale. */
514 if (!g_utf8_validate (str, -1, NULL))
515 utf8_str = g_locale_to_utf8 (str, -1, 0, 0, 0);
516 else
517 return g_strdup (str);
519 if (!utf8_str)
521 /* Probably some control characters in str. Escape them. */
522 ptrdiff_t len;
523 ptrdiff_t nr_bad = 0;
524 gsize bytes_read;
525 gsize bytes_written;
526 unsigned char *p = (unsigned char *)str;
527 char *cp, *up;
528 GError *err = NULL;
530 while (! (cp = g_locale_to_utf8 ((char *)p, -1, &bytes_read,
531 &bytes_written, &err))
532 && err->code == G_CONVERT_ERROR_ILLEGAL_SEQUENCE)
534 ++nr_bad;
535 p += bytes_written+1;
536 g_error_free (err);
537 err = NULL;
540 if (err)
542 g_error_free (err);
543 err = NULL;
545 if (cp) g_free (cp);
547 len = strlen (str);
548 if ((min (PTRDIFF_MAX, SIZE_MAX) - len - 1) / 4 < nr_bad)
549 memory_full (SIZE_MAX);
550 up = utf8_str = xmalloc (len + nr_bad * 4 + 1);
551 p = (unsigned char *)str;
553 while (! (cp = g_locale_to_utf8 ((char *)p, -1, &bytes_read,
554 &bytes_written, &err))
555 && err->code == G_CONVERT_ERROR_ILLEGAL_SEQUENCE)
557 memcpy (up, p, bytes_written);
558 sprintf (up + bytes_written, "\\%03o", p[bytes_written]);
559 up += bytes_written+4;
560 p += bytes_written+1;
561 g_error_free (err);
562 err = NULL;
565 if (cp)
567 strcat (utf8_str, cp);
568 g_free (cp);
570 if (err)
572 g_error_free (err);
573 err = NULL;
576 return utf8_str;
579 /* Check for special colors used in face spec for region face.
580 The colors are fetched from the Gtk+ theme.
581 Return 1 if color was found, 0 if not. */
584 xg_check_special_colors (struct frame *f,
585 const char *color_name,
586 XColor *color)
588 int success_p = 0;
589 int get_bg = strcmp ("gtk_selection_bg_color", color_name) == 0;
590 int get_fg = !get_bg && strcmp ("gtk_selection_fg_color", color_name) == 0;
592 if (! FRAME_GTK_WIDGET (f) || ! (get_bg || get_fg))
593 return success_p;
595 BLOCK_INPUT;
597 #ifdef HAVE_GTK3
598 GtkStyleContext *gsty
599 = gtk_widget_get_style_context (FRAME_GTK_OUTER_WIDGET (f));
600 GdkRGBA col;
601 char buf[sizeof "rgbi://" + 3 * (DBL_MAX_10_EXP + sizeof "-1.000000" - 1)];
602 int state = GTK_STATE_FLAG_SELECTED|GTK_STATE_FLAG_FOCUSED;
603 if (get_fg)
604 gtk_style_context_get_color (gsty, state, &col);
605 else
606 gtk_style_context_get_background_color (gsty, state, &col);
608 sprintf (buf, "rgbi:%lf/%lf/%lf", col.red, col.green, col.blue);
609 success_p = XParseColor (FRAME_X_DISPLAY (f), FRAME_X_COLORMAP (f),
610 buf, color);
611 #else
612 GtkStyle *gsty = gtk_widget_get_style (FRAME_GTK_WIDGET (f));
613 GdkColor *grgb = get_bg
614 ? &gsty->bg[GTK_STATE_SELECTED]
615 : &gsty->fg[GTK_STATE_SELECTED];
617 color->red = grgb->red;
618 color->green = grgb->green;
619 color->blue = grgb->blue;
620 color->pixel = grgb->pixel;
621 success_p = 1;
622 #endif
625 UNBLOCK_INPUT;
626 return success_p;
631 /***********************************************************************
632 Tooltips
633 ***********************************************************************/
634 /* Gtk+ calls this callback when the parent of our tooltip dummy changes.
635 We use that to pop down the tooltip. This happens if Gtk+ for some
636 reason wants to change or hide the tooltip. */
638 #ifdef USE_GTK_TOOLTIP
640 static void
641 hierarchy_ch_cb (GtkWidget *widget,
642 GtkWidget *previous_toplevel,
643 gpointer user_data)
645 FRAME_PTR f = (FRAME_PTR) user_data;
646 struct x_output *x = f->output_data.x;
647 GtkWidget *top = gtk_widget_get_toplevel (x->ttip_lbl);
649 if (! top || ! GTK_IS_WINDOW (top))
650 gtk_widget_hide (previous_toplevel);
653 /* Callback called when Gtk+ thinks a tooltip should be displayed.
654 We use it to get the tooltip window and the tooltip widget so
655 we can manipulate the ourselves.
657 Return FALSE ensures that the tooltip is not shown. */
659 static gboolean
660 qttip_cb (GtkWidget *widget,
661 gint xpos,
662 gint ypos,
663 gboolean keyboard_mode,
664 GtkTooltip *tooltip,
665 gpointer user_data)
667 FRAME_PTR f = (FRAME_PTR) user_data;
668 struct x_output *x = f->output_data.x;
669 if (x->ttip_widget == NULL)
671 GtkWidget *p;
672 GList *list, *iter;
674 g_object_set (G_OBJECT (widget), "has-tooltip", FALSE, NULL);
675 x->ttip_widget = tooltip;
676 g_object_ref (G_OBJECT (tooltip));
677 x->ttip_lbl = gtk_label_new ("");
678 g_object_ref (G_OBJECT (x->ttip_lbl));
679 gtk_tooltip_set_custom (tooltip, x->ttip_lbl);
680 x->ttip_window = GTK_WINDOW (gtk_widget_get_toplevel (x->ttip_lbl));
682 /* Change stupid Gtk+ default line wrapping. */
683 p = gtk_widget_get_parent (x->ttip_lbl);
684 list = gtk_container_get_children (GTK_CONTAINER (p));
685 for (iter = list; iter; iter = g_list_next (iter))
687 GtkWidget *w = GTK_WIDGET (iter->data);
688 if (GTK_IS_LABEL (w))
689 gtk_label_set_line_wrap (GTK_LABEL (w), FALSE);
691 g_list_free (list);
693 /* ATK needs an empty title for some reason. */
694 gtk_window_set_title (x->ttip_window, "");
695 /* Realize so we can safely get screen later on. */
696 gtk_widget_realize (GTK_WIDGET (x->ttip_window));
697 gtk_widget_realize (x->ttip_lbl);
699 g_signal_connect (x->ttip_lbl, "hierarchy-changed",
700 G_CALLBACK (hierarchy_ch_cb), f);
702 return FALSE;
705 #endif /* USE_GTK_TOOLTIP */
707 /* Prepare a tooltip to be shown, i.e. calculate WIDTH and HEIGHT.
708 Return zero if no system tooltip available, non-zero otherwise. */
711 xg_prepare_tooltip (FRAME_PTR f,
712 Lisp_Object string,
713 int *width,
714 int *height)
716 #ifndef USE_GTK_TOOLTIP
717 return 0;
718 #else
719 struct x_output *x = f->output_data.x;
720 GtkWidget *widget;
721 GdkWindow *gwin;
722 GdkScreen *screen;
723 GtkSettings *settings;
724 gboolean tt_enabled = TRUE;
725 GtkRequisition req;
726 Lisp_Object encoded_string;
728 if (!x->ttip_lbl) return 0;
730 BLOCK_INPUT;
731 encoded_string = ENCODE_UTF_8 (string);
732 widget = GTK_WIDGET (x->ttip_lbl);
733 gwin = gtk_widget_get_window (GTK_WIDGET (x->ttip_window));
734 screen = gdk_window_get_screen (gwin);
735 settings = gtk_settings_get_for_screen (screen);
736 g_object_get (settings, "gtk-enable-tooltips", &tt_enabled, NULL);
737 if (tt_enabled)
739 g_object_set (settings, "gtk-enable-tooltips", FALSE, NULL);
740 /* Record that we disabled it so it can be enabled again. */
741 g_object_set_data (G_OBJECT (x->ttip_window), "restore-tt",
742 (gpointer)f);
745 /* Prevent Gtk+ from hiding tooltip on mouse move and such. */
746 g_object_set_data (G_OBJECT
747 (gtk_widget_get_display (GTK_WIDGET (x->ttip_window))),
748 "gdk-display-current-tooltip", NULL);
750 /* Put our dummy widget in so we can get callbacks for unrealize and
751 hierarchy-changed. */
752 gtk_tooltip_set_custom (x->ttip_widget, widget);
753 gtk_tooltip_set_text (x->ttip_widget, SSDATA (encoded_string));
754 gtk_widget_get_preferred_size (GTK_WIDGET (x->ttip_window), NULL, &req);
755 if (width) *width = req.width;
756 if (height) *height = req.height;
758 UNBLOCK_INPUT;
760 return 1;
761 #endif /* USE_GTK_TOOLTIP */
764 /* Show the tooltip at ROOT_X and ROOT_Y.
765 xg_prepare_tooltip must have been called before this function. */
767 void
768 xg_show_tooltip (FRAME_PTR f, int root_x, int root_y)
770 #ifdef USE_GTK_TOOLTIP
771 struct x_output *x = f->output_data.x;
772 if (x->ttip_window)
774 BLOCK_INPUT;
775 gtk_window_move (x->ttip_window, root_x, root_y);
776 gtk_widget_show_all (GTK_WIDGET (x->ttip_window));
777 UNBLOCK_INPUT;
779 #endif
782 /* Hide tooltip if shown. Do nothing if not shown.
783 Return non-zero if tip was hidden, non-zero if not (i.e. not using
784 system tooltips). */
787 xg_hide_tooltip (FRAME_PTR f)
789 int ret = 0;
790 #ifdef USE_GTK_TOOLTIP
791 if (f->output_data.x->ttip_window)
793 GtkWindow *win = f->output_data.x->ttip_window;
794 BLOCK_INPUT;
795 gtk_widget_hide (GTK_WIDGET (win));
797 if (g_object_get_data (G_OBJECT (win), "restore-tt"))
799 GdkWindow *gwin = gtk_widget_get_window (GTK_WIDGET (win));
800 GdkScreen *screen = gdk_window_get_screen (gwin);
801 GtkSettings *settings = gtk_settings_get_for_screen (screen);
802 g_object_set (settings, "gtk-enable-tooltips", TRUE, NULL);
804 UNBLOCK_INPUT;
806 ret = 1;
808 #endif
809 return ret;
813 /***********************************************************************
814 General functions for creating widgets, resizing, events, e.t.c.
815 ***********************************************************************/
817 /* Make a geometry string and pass that to GTK. It seems this is the
818 only way to get geometry position right if the user explicitly
819 asked for a position when starting Emacs.
820 F is the frame we shall set geometry for. */
822 static void
823 xg_set_geometry (FRAME_PTR f)
825 if (f->size_hint_flags & (USPosition | PPosition))
827 int left = f->left_pos;
828 int xneg = f->size_hint_flags & XNegative;
829 int top = f->top_pos;
830 int yneg = f->size_hint_flags & YNegative;
831 char geom_str[sizeof "=x--" + 4 * INT_STRLEN_BOUND (int)];
833 if (xneg)
834 left = -left;
835 if (yneg)
836 top = -top;
838 sprintf (geom_str, "=%dx%d%c%d%c%d",
839 FRAME_PIXEL_WIDTH (f),
840 FRAME_PIXEL_HEIGHT (f),
841 (xneg ? '-' : '+'), left,
842 (yneg ? '-' : '+'), top);
844 if (!gtk_window_parse_geometry (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)),
845 geom_str))
846 fprintf (stderr, "Failed to parse: '%s'\n", geom_str);
850 /* Clear under internal border if any. As we use a mix of Gtk+ and X calls
851 and use a GtkFixed widget, this doesn't happen automatically. */
853 static void
854 xg_clear_under_internal_border (FRAME_PTR f)
856 if (FRAME_INTERNAL_BORDER_WIDTH (f) > 0)
858 GtkWidget *wfixed = f->output_data.x->edit_widget;
859 gtk_widget_queue_draw (wfixed);
860 gdk_window_process_all_updates ();
861 x_clear_area (FRAME_X_DISPLAY (f),
862 FRAME_X_WINDOW (f),
863 0, 0,
864 FRAME_PIXEL_WIDTH (f),
865 FRAME_INTERNAL_BORDER_WIDTH (f), 0);
866 x_clear_area (FRAME_X_DISPLAY (f),
867 FRAME_X_WINDOW (f),
868 0, 0,
869 FRAME_INTERNAL_BORDER_WIDTH (f),
870 FRAME_PIXEL_HEIGHT (f), 0);
871 x_clear_area (FRAME_X_DISPLAY (f),
872 FRAME_X_WINDOW (f),
873 0, FRAME_PIXEL_HEIGHT (f) - FRAME_INTERNAL_BORDER_WIDTH (f),
874 FRAME_PIXEL_WIDTH (f),
875 FRAME_INTERNAL_BORDER_WIDTH (f), 0);
876 x_clear_area (FRAME_X_DISPLAY (f),
877 FRAME_X_WINDOW (f),
878 FRAME_PIXEL_WIDTH (f) - FRAME_INTERNAL_BORDER_WIDTH (f),
880 FRAME_INTERNAL_BORDER_WIDTH (f),
881 FRAME_PIXEL_HEIGHT (f), 0);
885 /* Function to handle resize of our frame. As we have a Gtk+ tool bar
886 and a Gtk+ menu bar, we get resize events for the edit part of the
887 frame only. We let Gtk+ deal with the Gtk+ parts.
888 F is the frame to resize.
889 PIXELWIDTH, PIXELHEIGHT is the new size in pixels. */
891 void
892 xg_frame_resized (FRAME_PTR f, int pixelwidth, int pixelheight)
894 int rows, columns;
896 if (pixelwidth == -1 && pixelheight == -1)
898 if (FRAME_GTK_WIDGET (f) && gtk_widget_get_mapped (FRAME_GTK_WIDGET (f)))
899 gdk_window_get_geometry (gtk_widget_get_window (FRAME_GTK_WIDGET (f)),
900 0, 0,
901 &pixelwidth, &pixelheight);
902 else return;
906 rows = FRAME_PIXEL_HEIGHT_TO_TEXT_LINES (f, pixelheight);
907 columns = FRAME_PIXEL_WIDTH_TO_TEXT_COLS (f, pixelwidth);
909 if (columns != FRAME_COLS (f)
910 || rows != FRAME_LINES (f)
911 || pixelwidth != FRAME_PIXEL_WIDTH (f)
912 || pixelheight != FRAME_PIXEL_HEIGHT (f))
914 FRAME_PIXEL_WIDTH (f) = pixelwidth;
915 FRAME_PIXEL_HEIGHT (f) = pixelheight;
917 xg_clear_under_internal_border (f);
918 change_frame_size (f, rows, columns, 0, 1, 0);
919 SET_FRAME_GARBAGED (f);
920 cancel_mouse_face (f);
924 /* Resize the outer window of frame F after changing the height.
925 COLUMNS/ROWS is the size the edit area shall have after the resize. */
927 void
928 xg_frame_set_char_size (FRAME_PTR f, int cols, int rows)
930 int pixelheight = FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, rows)
931 + FRAME_MENUBAR_HEIGHT (f) + FRAME_TOOLBAR_HEIGHT (f);
932 int pixelwidth;
934 if (FRAME_PIXEL_HEIGHT (f) == 0)
935 return;
937 /* Take into account the size of the scroll bar. Always use the
938 number of columns occupied by the scroll bar here otherwise we
939 might end up with a frame width that is not a multiple of the
940 frame's character width which is bad for vertically split
941 windows. */
942 f->scroll_bar_actual_width
943 = FRAME_SCROLL_BAR_COLS (f) * FRAME_COLUMN_WIDTH (f);
945 compute_fringe_widths (f, 0);
947 /* FRAME_TEXT_COLS_TO_PIXEL_WIDTH uses scroll_bar_actual_width, so call it
948 after calculating that value. */
949 pixelwidth = FRAME_TEXT_COLS_TO_PIXEL_WIDTH (f, cols)
950 + FRAME_TOOLBAR_WIDTH (f);
953 /* Do this before resize, as we don't know yet if we will be resized. */
954 xg_clear_under_internal_border (f);
956 /* Must resize our top level widget. Font size may have changed,
957 but not rows/cols. */
958 gtk_window_resize (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)),
959 pixelwidth, pixelheight);
960 x_wm_set_size_hint (f, 0, 0);
962 SET_FRAME_GARBAGED (f);
963 cancel_mouse_face (f);
965 /* We can not call change_frame_size for a mapped frame,
966 we can not set pixel width/height either. The window manager may
967 override our resize request, XMonad does this all the time.
968 The best we can do is try to sync, so lisp code sees the updated
969 size as fast as possible.
970 For unmapped windows, we can set rows/cols. When
971 the frame is mapped again we will (hopefully) get the correct size. */
972 if (f->async_visible)
974 /* Must call this to flush out events */
975 (void)gtk_events_pending ();
976 gdk_flush ();
977 x_wait_for_event (f, ConfigureNotify);
979 else
981 change_frame_size (f, rows, cols, 0, 1, 0);
982 FRAME_PIXEL_WIDTH (f) = pixelwidth;
983 FRAME_PIXEL_HEIGHT (f) = pixelheight;
987 /* Handle height/width changes (i.e. add/remove/move menu/toolbar).
988 The policy is to keep the number of editable lines. */
990 static void
991 xg_height_or_width_changed (FRAME_PTR f)
993 gtk_window_resize (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)),
994 FRAME_TOTAL_PIXEL_WIDTH (f),
995 FRAME_TOTAL_PIXEL_HEIGHT (f));
996 f->output_data.x->hint_flags = 0;
997 x_wm_set_size_hint (f, 0, 0);
1000 /* Convert an X Window WSESC on display DPY to its corresponding GtkWidget.
1001 Must be done like this, because GtkWidget:s can have "hidden"
1002 X Window that aren't accessible.
1004 Return 0 if no widget match WDESC. */
1006 GtkWidget *
1007 xg_win_to_widget (Display *dpy, Window wdesc)
1009 gpointer gdkwin;
1010 GtkWidget *gwdesc = 0;
1012 BLOCK_INPUT;
1014 gdkwin = gdk_x11_window_lookup_for_display (gdk_x11_lookup_xdisplay (dpy),
1015 wdesc);
1016 if (gdkwin)
1018 GdkEvent event;
1019 event.any.window = gdkwin;
1020 event.any.type = GDK_NOTHING;
1021 gwdesc = gtk_get_event_widget (&event);
1024 UNBLOCK_INPUT;
1025 return gwdesc;
1028 /* Set the background of widget W to PIXEL. */
1030 static void
1031 xg_set_widget_bg (FRAME_PTR f, GtkWidget *w, long unsigned int pixel)
1033 #ifdef HAVE_GTK3
1034 GdkRGBA bg;
1035 XColor xbg;
1036 xbg.pixel = pixel;
1037 if (XQueryColor (FRAME_X_DISPLAY (f), FRAME_X_COLORMAP (f), &xbg))
1039 bg.red = (double)xbg.red/65536.0;
1040 bg.green = (double)xbg.green/65536.0;
1041 bg.blue = (double)xbg.blue/65536.0;
1042 bg.alpha = 1.0;
1043 gtk_widget_override_background_color (w, GTK_STATE_FLAG_NORMAL, &bg);
1045 #else
1046 GdkColor bg;
1047 GdkColormap *map = gtk_widget_get_colormap (w);
1048 gdk_colormap_query_color (map, pixel, &bg);
1049 gtk_widget_modify_bg (FRAME_GTK_WIDGET (f), GTK_STATE_NORMAL, &bg);
1050 #endif
1053 /* Callback called when the gtk theme changes.
1054 We notify lisp code so it can fix faces used for region for example. */
1056 static void
1057 style_changed_cb (GObject *go,
1058 GParamSpec *spec,
1059 gpointer user_data)
1061 struct input_event event;
1062 GdkDisplay *gdpy = (GdkDisplay *) user_data;
1063 const char *display_name = gdk_display_get_name (gdpy);
1064 Display *dpy = GDK_DISPLAY_XDISPLAY (gdpy);
1066 EVENT_INIT (event);
1067 event.kind = CONFIG_CHANGED_EVENT;
1068 event.frame_or_window = build_string (display_name);
1069 /* Theme doesn't change often, so intern is called seldom. */
1070 event.arg = intern ("theme-name");
1071 kbd_buffer_store_event (&event);
1073 update_theme_scrollbar_width ();
1075 /* If scroll bar width changed, we need set the new size on all frames
1076 on this display. */
1077 if (dpy)
1079 Lisp_Object rest, frame;
1080 FOR_EACH_FRAME (rest, frame)
1082 FRAME_PTR f = XFRAME (frame);
1083 if (FRAME_X_DISPLAY (f) == dpy)
1085 x_set_scroll_bar_default_width (f);
1086 xg_frame_set_char_size (f, FRAME_COLS (f), FRAME_LINES (f));
1092 /* Called when a delete-event occurs on WIDGET. */
1094 static gboolean
1095 delete_cb (GtkWidget *widget,
1096 GdkEvent *event,
1097 gpointer user_data)
1099 #ifdef HAVE_GTK3
1100 /* The event doesn't arrive in the normal event loop. Send event
1101 here. */
1102 FRAME_PTR f = (FRAME_PTR) user_data;
1103 struct input_event ie;
1105 EVENT_INIT (ie);
1106 ie.kind = DELETE_WINDOW_EVENT;
1107 XSETFRAME (ie.frame_or_window, f);
1108 kbd_buffer_store_event (&ie);
1109 #endif
1111 return TRUE;
1114 /* Create and set up the GTK widgets for frame F.
1115 Return 0 if creation failed, non-zero otherwise. */
1118 xg_create_frame_widgets (FRAME_PTR f)
1120 GtkWidget *wtop;
1121 GtkWidget *wvbox, *whbox;
1122 GtkWidget *wfixed;
1123 #ifndef HAVE_GTK3
1124 GtkRcStyle *style;
1125 #endif
1126 char *title = 0;
1128 BLOCK_INPUT;
1130 if (FRAME_X_EMBEDDED_P (f))
1132 GdkDisplay *gdpy = gdk_x11_lookup_xdisplay (FRAME_X_DISPLAY (f));
1133 wtop = gtk_plug_new_for_display (gdpy, f->output_data.x->parent_desc);
1135 else
1136 wtop = gtk_window_new (GTK_WINDOW_TOPLEVEL);
1138 /* gtk_window_set_has_resize_grip is a Gtk+ 3.0 function but Ubuntu
1139 has backported it to Gtk+ 2.0 and they add the resize grip for
1140 Gtk+ 2.0 applications also. But it has a bug that makes Emacs loop
1141 forever, so disable the grip. */
1142 #if GTK_MAJOR_VERSION < 3 && defined (HAVE_GTK_WINDOW_SET_HAS_RESIZE_GRIP)
1143 gtk_window_set_has_resize_grip (GTK_WINDOW (wtop), FALSE);
1144 #endif
1146 xg_set_screen (wtop, f);
1148 wvbox = gtk_box_new (GTK_ORIENTATION_VERTICAL, 0);
1149 whbox = gtk_box_new (GTK_ORIENTATION_HORIZONTAL, 0);
1150 gtk_box_set_homogeneous (GTK_BOX (wvbox), FALSE);
1151 gtk_box_set_homogeneous (GTK_BOX (whbox), FALSE);
1153 #ifdef HAVE_GTK3
1154 wfixed = emacs_fixed_new (f);
1155 #else
1156 wfixed = gtk_fixed_new ();
1157 #endif
1159 if (! wtop || ! wvbox || ! whbox || ! wfixed)
1161 if (wtop) gtk_widget_destroy (wtop);
1162 if (wvbox) gtk_widget_destroy (wvbox);
1163 if (whbox) gtk_widget_destroy (whbox);
1164 if (wfixed) gtk_widget_destroy (wfixed);
1166 UNBLOCK_INPUT;
1167 return 0;
1170 /* Use same names as the Xt port does. I.e. Emacs.pane.emacs by default */
1171 gtk_widget_set_name (wtop, EMACS_CLASS);
1172 gtk_widget_set_name (wvbox, "pane");
1173 gtk_widget_set_name (wfixed, SSDATA (Vx_resource_name));
1175 /* If this frame has a title or name, set it in the title bar. */
1176 if (! NILP (f->title))
1177 title = SSDATA (ENCODE_UTF_8 (f->title));
1178 else if (! NILP (f->name))
1179 title = SSDATA (ENCODE_UTF_8 (f->name));
1181 if (title) gtk_window_set_title (GTK_WINDOW (wtop), title);
1183 FRAME_GTK_OUTER_WIDGET (f) = wtop;
1184 FRAME_GTK_WIDGET (f) = wfixed;
1185 f->output_data.x->vbox_widget = wvbox;
1186 f->output_data.x->hbox_widget = whbox;
1188 gtk_widget_set_has_window (wfixed, TRUE);
1190 gtk_container_add (GTK_CONTAINER (wtop), wvbox);
1191 gtk_box_pack_start (GTK_BOX (wvbox), whbox, TRUE, TRUE, 0);
1192 gtk_box_pack_start (GTK_BOX (whbox), wfixed, TRUE, TRUE, 0);
1194 if (FRAME_EXTERNAL_TOOL_BAR (f))
1195 update_frame_tool_bar (f);
1197 /* We don't want this widget double buffered, because we draw on it
1198 with regular X drawing primitives, so from a GTK/GDK point of
1199 view, the widget is totally blank. When an expose comes, this
1200 will make the widget blank, and then Emacs redraws it. This flickers
1201 a lot, so we turn off double buffering. */
1202 gtk_widget_set_double_buffered (wfixed, FALSE);
1204 gtk_window_set_wmclass (GTK_WINDOW (wtop),
1205 SSDATA (Vx_resource_name),
1206 SSDATA (Vx_resource_class));
1208 /* Add callback to do nothing on WM_DELETE_WINDOW. The default in
1209 GTK is to destroy the widget. We want Emacs to do that instead. */
1210 g_signal_connect (G_OBJECT (wtop), "delete-event",
1211 G_CALLBACK (delete_cb), f);
1213 /* Convert our geometry parameters into a geometry string
1214 and specify it.
1215 GTK will itself handle calculating the real position this way. */
1216 xg_set_geometry (f);
1217 f->win_gravity
1218 = gtk_window_get_gravity (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)));
1220 gtk_widget_add_events (wfixed,
1221 GDK_POINTER_MOTION_MASK
1222 | GDK_EXPOSURE_MASK
1223 | GDK_BUTTON_PRESS_MASK
1224 | GDK_BUTTON_RELEASE_MASK
1225 | GDK_KEY_PRESS_MASK
1226 | GDK_ENTER_NOTIFY_MASK
1227 | GDK_LEAVE_NOTIFY_MASK
1228 | GDK_FOCUS_CHANGE_MASK
1229 | GDK_STRUCTURE_MASK
1230 | GDK_VISIBILITY_NOTIFY_MASK);
1232 /* Must realize the windows so the X window gets created. It is used
1233 by callers of this function. */
1234 gtk_widget_realize (wfixed);
1235 FRAME_X_WINDOW (f) = GTK_WIDGET_TO_X_WIN (wfixed);
1237 /* Since GTK clears its window by filling with the background color,
1238 we must keep X and GTK background in sync. */
1239 xg_set_widget_bg (f, wfixed, FRAME_BACKGROUND_PIXEL (f));
1241 #ifndef HAVE_GTK3
1242 /* Also, do not let any background pixmap to be set, this looks very
1243 bad as Emacs overwrites the background pixmap with its own idea
1244 of background color. */
1245 style = gtk_widget_get_modifier_style (wfixed);
1247 /* Must use g_strdup because gtk_widget_modify_style does g_free. */
1248 style->bg_pixmap_name[GTK_STATE_NORMAL] = g_strdup ("<none>");
1249 gtk_widget_modify_style (wfixed, style);
1250 #else
1251 gtk_widget_set_can_focus (wfixed, TRUE);
1252 gtk_window_set_resizable (GTK_WINDOW (wtop), TRUE);
1253 #endif
1255 #ifdef USE_GTK_TOOLTIP
1256 /* Steal a tool tip window we can move ourselves. */
1257 f->output_data.x->ttip_widget = 0;
1258 f->output_data.x->ttip_lbl = 0;
1259 f->output_data.x->ttip_window = 0;
1260 gtk_widget_set_tooltip_text (wtop, "Dummy text");
1261 g_signal_connect (wtop, "query-tooltip", G_CALLBACK (qttip_cb), f);
1262 #endif
1265 GdkScreen *screen = gtk_widget_get_screen (wtop);
1266 GtkSettings *gs = gtk_settings_get_for_screen (screen);
1267 /* Only connect this signal once per screen. */
1268 if (! g_signal_handler_find (G_OBJECT (gs),
1269 G_SIGNAL_MATCH_FUNC,
1270 0, 0, 0,
1271 G_CALLBACK (style_changed_cb),
1274 g_signal_connect (G_OBJECT (gs), "notify::gtk-theme-name",
1275 G_CALLBACK (style_changed_cb),
1276 gdk_screen_get_display (screen));
1280 UNBLOCK_INPUT;
1282 return 1;
1285 void
1286 xg_free_frame_widgets (FRAME_PTR f)
1288 if (FRAME_GTK_OUTER_WIDGET (f))
1290 #ifdef USE_GTK_TOOLTIP
1291 struct x_output *x = f->output_data.x;
1292 #endif
1293 struct xg_frame_tb_info *tbinfo
1294 = g_object_get_data (G_OBJECT (FRAME_GTK_OUTER_WIDGET (f)),
1295 TB_INFO_KEY);
1296 if (tbinfo)
1297 xfree (tbinfo);
1299 gtk_widget_destroy (FRAME_GTK_OUTER_WIDGET (f));
1300 FRAME_X_WINDOW (f) = 0; /* Set to avoid XDestroyWindow in xterm.c */
1301 FRAME_GTK_OUTER_WIDGET (f) = 0;
1302 #ifdef USE_GTK_TOOLTIP
1303 if (x->ttip_lbl)
1304 gtk_widget_destroy (x->ttip_lbl);
1305 if (x->ttip_widget)
1306 g_object_unref (G_OBJECT (x->ttip_widget));
1307 #endif
1311 /* Set the normal size hints for the window manager, for frame F.
1312 FLAGS is the flags word to use--or 0 meaning preserve the flags
1313 that the window now has.
1314 If USER_POSITION is nonzero, we set the User Position
1315 flag (this is useful when FLAGS is 0). */
1317 void
1318 x_wm_set_size_hint (FRAME_PTR f, long int flags, int user_position)
1320 /* Must use GTK routines here, otherwise GTK resets the size hints
1321 to its own defaults. */
1322 GdkGeometry size_hints;
1323 gint hint_flags = 0;
1324 int base_width, base_height;
1325 int min_rows = 0, min_cols = 0;
1326 int win_gravity = f->win_gravity;
1328 /* Don't set size hints during initialization; that apparently leads
1329 to a race condition. See the thread at
1330 http://lists.gnu.org/archive/html/emacs-devel/2008-10/msg00033.html */
1331 if (NILP (Vafter_init_time) || !FRAME_GTK_OUTER_WIDGET (f))
1332 return;
1334 if (flags)
1336 memset (&size_hints, 0, sizeof (size_hints));
1337 f->output_data.x->size_hints = size_hints;
1338 f->output_data.x->hint_flags = hint_flags;
1340 else
1341 flags = f->size_hint_flags;
1343 size_hints = f->output_data.x->size_hints;
1344 hint_flags = f->output_data.x->hint_flags;
1346 hint_flags |= GDK_HINT_RESIZE_INC | GDK_HINT_MIN_SIZE;
1347 size_hints.width_inc = FRAME_COLUMN_WIDTH (f);
1348 size_hints.height_inc = FRAME_LINE_HEIGHT (f);
1350 hint_flags |= GDK_HINT_BASE_SIZE;
1351 /* Use one row/col here so base_height/width does not become zero.
1352 Gtk+ and/or Unity on Ubuntu 12.04 can't handle it. */
1353 base_width = FRAME_TEXT_COLS_TO_PIXEL_WIDTH (f, 1) + FRAME_TOOLBAR_WIDTH (f);
1354 base_height = FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, 1)
1355 + FRAME_MENUBAR_HEIGHT (f) + FRAME_TOOLBAR_HEIGHT (f);
1357 check_frame_size (f, &min_rows, &min_cols);
1358 if (min_cols > 0) --min_cols; /* We used one col in base_width = ... 1); */
1359 if (min_rows > 0) --min_rows; /* We used one row in base_height = ... 1); */
1361 size_hints.base_width = base_width;
1362 size_hints.base_height = base_height;
1363 size_hints.min_width = base_width + min_cols * size_hints.width_inc;
1364 size_hints.min_height = base_height + min_rows * size_hints.height_inc;
1366 /* These currently have a one to one mapping with the X values, but I
1367 don't think we should rely on that. */
1368 hint_flags |= GDK_HINT_WIN_GRAVITY;
1369 size_hints.win_gravity = 0;
1370 if (win_gravity == NorthWestGravity)
1371 size_hints.win_gravity = GDK_GRAVITY_NORTH_WEST;
1372 else if (win_gravity == NorthGravity)
1373 size_hints.win_gravity = GDK_GRAVITY_NORTH;
1374 else if (win_gravity == NorthEastGravity)
1375 size_hints.win_gravity = GDK_GRAVITY_NORTH_EAST;
1376 else if (win_gravity == WestGravity)
1377 size_hints.win_gravity = GDK_GRAVITY_WEST;
1378 else if (win_gravity == CenterGravity)
1379 size_hints.win_gravity = GDK_GRAVITY_CENTER;
1380 else if (win_gravity == EastGravity)
1381 size_hints.win_gravity = GDK_GRAVITY_EAST;
1382 else if (win_gravity == SouthWestGravity)
1383 size_hints.win_gravity = GDK_GRAVITY_SOUTH_WEST;
1384 else if (win_gravity == SouthGravity)
1385 size_hints.win_gravity = GDK_GRAVITY_SOUTH;
1386 else if (win_gravity == SouthEastGravity)
1387 size_hints.win_gravity = GDK_GRAVITY_SOUTH_EAST;
1388 else if (win_gravity == StaticGravity)
1389 size_hints.win_gravity = GDK_GRAVITY_STATIC;
1391 if (user_position)
1393 hint_flags &= ~GDK_HINT_POS;
1394 hint_flags |= GDK_HINT_USER_POS;
1397 if (hint_flags != f->output_data.x->hint_flags
1398 || memcmp (&size_hints,
1399 &f->output_data.x->size_hints,
1400 sizeof (size_hints)) != 0)
1402 BLOCK_INPUT;
1403 gtk_window_set_geometry_hints (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)),
1404 NULL, &size_hints, hint_flags);
1405 f->output_data.x->size_hints = size_hints;
1406 f->output_data.x->hint_flags = hint_flags;
1407 UNBLOCK_INPUT;
1411 /* Change background color of a frame.
1412 Since GTK uses the background color to clear the window, we must
1413 keep the GTK and X colors in sync.
1414 F is the frame to change,
1415 BG is the pixel value to change to. */
1417 void
1418 xg_set_background_color (FRAME_PTR f, long unsigned int bg)
1420 if (FRAME_GTK_WIDGET (f))
1422 BLOCK_INPUT;
1423 xg_set_widget_bg (f, FRAME_GTK_WIDGET (f), FRAME_BACKGROUND_PIXEL (f));
1424 UNBLOCK_INPUT;
1429 /* Set the frame icon to ICON_PIXMAP/MASK. This must be done with GTK
1430 functions so GTK does not overwrite the icon. */
1432 void
1433 xg_set_frame_icon (FRAME_PTR f, Pixmap icon_pixmap, Pixmap icon_mask)
1435 GdkPixbuf *gp = xg_get_pixbuf_from_pix_and_mask (f,
1436 icon_pixmap,
1437 icon_mask);
1438 if (gp)
1439 gtk_window_set_icon (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)), gp);
1444 /***********************************************************************
1445 Dialog functions
1446 ***********************************************************************/
1447 /* Return the dialog title to use for a dialog of type KEY.
1448 This is the encoding used by lwlib. We use the same for GTK. */
1450 static const char *
1451 get_dialog_title (char key)
1453 const char *title = "";
1455 switch (key) {
1456 case 'E': case 'e':
1457 title = "Error";
1458 break;
1460 case 'I': case 'i':
1461 title = "Information";
1462 break;
1464 case 'L': case 'l':
1465 title = "Prompt";
1466 break;
1468 case 'P': case 'p':
1469 title = "Prompt";
1470 break;
1472 case 'Q': case 'q':
1473 title = "Question";
1474 break;
1477 return title;
1480 /* Callback for dialogs that get WM_DELETE_WINDOW. We pop down
1481 the dialog, but return TRUE so the event does not propagate further
1482 in GTK. This prevents GTK from destroying the dialog widget automatically
1483 and we can always destroy the widget manually, regardless of how
1484 it was popped down (button press or WM_DELETE_WINDOW).
1485 W is the dialog widget.
1486 EVENT is the GdkEvent that represents WM_DELETE_WINDOW (not used).
1487 user_data is NULL (not used).
1489 Returns TRUE to end propagation of event. */
1491 static gboolean
1492 dialog_delete_callback (GtkWidget *w, GdkEvent *event, gpointer user_data)
1494 gtk_widget_unmap (w);
1495 return TRUE;
1498 /* Create a popup dialog window. See also xg_create_widget below.
1499 WV is a widget_value describing the dialog.
1500 SELECT_CB is the callback to use when a button has been pressed.
1501 DEACTIVATE_CB is the callback to use when the dialog pops down.
1503 Returns the GTK dialog widget. */
1505 static GtkWidget *
1506 create_dialog (widget_value *wv,
1507 GCallback select_cb,
1508 GCallback deactivate_cb)
1510 const char *title = get_dialog_title (wv->name[0]);
1511 int total_buttons = wv->name[1] - '0';
1512 int right_buttons = wv->name[4] - '0';
1513 int left_buttons;
1514 int button_nr = 0;
1515 int button_spacing = 10;
1516 GtkWidget *wdialog = gtk_dialog_new ();
1517 GtkDialog *wd = GTK_DIALOG (wdialog);
1518 GtkBox *cur_box = GTK_BOX (gtk_dialog_get_action_area (wd));
1519 widget_value *item;
1520 GtkWidget *whbox_down;
1522 /* If the number of buttons is greater than 4, make two rows of buttons
1523 instead. This looks better. */
1524 int make_two_rows = total_buttons > 4;
1526 if (right_buttons == 0) right_buttons = total_buttons/2;
1527 left_buttons = total_buttons - right_buttons;
1529 gtk_window_set_title (GTK_WINDOW (wdialog), title);
1530 gtk_widget_set_name (wdialog, "emacs-dialog");
1533 if (make_two_rows)
1535 GtkWidget *wvbox = gtk_box_new (GTK_ORIENTATION_VERTICAL, button_spacing);
1536 GtkWidget *whbox_up = gtk_box_new (GTK_ORIENTATION_HORIZONTAL, 0);
1537 gtk_box_set_homogeneous (GTK_BOX (wvbox), TRUE);
1538 gtk_box_set_homogeneous (GTK_BOX (whbox_up), FALSE);
1539 whbox_down = gtk_box_new (GTK_ORIENTATION_HORIZONTAL, 0);
1540 gtk_box_set_homogeneous (GTK_BOX (whbox_down), FALSE);
1542 gtk_box_pack_start (cur_box, wvbox, FALSE, FALSE, 0);
1543 gtk_box_pack_start (GTK_BOX (wvbox), whbox_up, FALSE, FALSE, 0);
1544 gtk_box_pack_start (GTK_BOX (wvbox), whbox_down, FALSE, FALSE, 0);
1546 cur_box = GTK_BOX (whbox_up);
1549 g_signal_connect (G_OBJECT (wdialog), "delete-event",
1550 G_CALLBACK (dialog_delete_callback), 0);
1552 if (deactivate_cb)
1554 g_signal_connect (G_OBJECT (wdialog), "close", deactivate_cb, 0);
1555 g_signal_connect (G_OBJECT (wdialog), "response", deactivate_cb, 0);
1558 for (item = wv->contents; item; item = item->next)
1560 char *utf8_label = get_utf8_string (item->value);
1561 GtkWidget *w;
1562 GtkRequisition req;
1564 if (item->name && strcmp (item->name, "message") == 0)
1566 GtkBox *wvbox = GTK_BOX (gtk_dialog_get_content_area (wd));
1567 /* This is the text part of the dialog. */
1568 w = gtk_label_new (utf8_label);
1569 gtk_box_pack_start (wvbox, gtk_label_new (""), FALSE, FALSE, 0);
1570 gtk_box_pack_start (wvbox, w, TRUE, TRUE, 0);
1571 gtk_misc_set_alignment (GTK_MISC (w), 0.1, 0.5);
1573 /* Try to make dialog look better. Must realize first so
1574 the widget can calculate the size it needs. */
1575 gtk_widget_realize (w);
1576 gtk_widget_get_preferred_size (w, NULL, &req);
1577 gtk_box_set_spacing (wvbox, req.height);
1578 if (item->value && strlen (item->value) > 0)
1579 button_spacing = 2*req.width/strlen (item->value);
1581 else
1583 /* This is one button to add to the dialog. */
1584 w = gtk_button_new_with_label (utf8_label);
1585 if (! item->enabled)
1586 gtk_widget_set_sensitive (w, FALSE);
1587 if (select_cb)
1588 g_signal_connect (G_OBJECT (w), "clicked",
1589 select_cb, item->call_data);
1591 gtk_box_pack_start (cur_box, w, TRUE, TRUE, button_spacing);
1592 if (++button_nr == left_buttons)
1594 if (make_two_rows)
1595 cur_box = GTK_BOX (whbox_down);
1596 else
1597 gtk_box_pack_start (cur_box,
1598 gtk_label_new (""),
1599 TRUE, TRUE,
1600 button_spacing);
1604 if (utf8_label)
1605 g_free (utf8_label);
1608 return wdialog;
1611 struct xg_dialog_data
1613 GMainLoop *loop;
1614 int response;
1615 GtkWidget *w;
1616 guint timerid;
1619 /* Function that is called when the file or font dialogs pop down.
1620 W is the dialog widget, RESPONSE is the response code.
1621 USER_DATA is what we passed in to g_signal_connect. */
1623 static void
1624 xg_dialog_response_cb (GtkDialog *w,
1625 gint response,
1626 gpointer user_data)
1628 struct xg_dialog_data *dd = (struct xg_dialog_data *)user_data;
1629 dd->response = response;
1630 g_main_loop_quit (dd->loop);
1634 /* Destroy the dialog. This makes it pop down. */
1636 static Lisp_Object
1637 pop_down_dialog (Lisp_Object arg)
1639 struct Lisp_Save_Value *p = XSAVE_VALUE (arg);
1640 struct xg_dialog_data *dd = (struct xg_dialog_data *) p->pointer;
1642 BLOCK_INPUT;
1643 if (dd->w) gtk_widget_destroy (dd->w);
1644 if (dd->timerid != 0) g_source_remove (dd->timerid);
1646 g_main_loop_quit (dd->loop);
1647 g_main_loop_unref (dd->loop);
1649 UNBLOCK_INPUT;
1651 return Qnil;
1654 /* If there are any emacs timers pending, add a timeout to main loop in DATA.
1655 We pass in DATA as gpointer* so we can use this as a callback. */
1657 static gboolean
1658 xg_maybe_add_timer (gpointer data)
1660 struct xg_dialog_data *dd = (struct xg_dialog_data *) data;
1661 EMACS_TIME next_time = timer_check ();
1663 dd->timerid = 0;
1665 if (EMACS_TIME_VALID_P (next_time))
1667 time_t s = EMACS_SECS (next_time);
1668 int per_ms = EMACS_TIME_RESOLUTION / 1000;
1669 int ms = (EMACS_NSECS (next_time) + per_ms - 1) / per_ms;
1670 if (s <= ((guint) -1 - ms) / 1000)
1671 dd->timerid = g_timeout_add (s * 1000 + ms, xg_maybe_add_timer, dd);
1673 return FALSE;
1677 /* Pops up a modal dialog W and waits for response.
1678 We don't use gtk_dialog_run because we want to process emacs timers.
1679 The dialog W is not destroyed when this function returns. */
1681 static int
1682 xg_dialog_run (FRAME_PTR f, GtkWidget *w)
1684 ptrdiff_t count = SPECPDL_INDEX ();
1685 struct xg_dialog_data dd;
1687 xg_set_screen (w, f);
1688 gtk_window_set_transient_for (GTK_WINDOW (w),
1689 GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)));
1690 gtk_window_set_destroy_with_parent (GTK_WINDOW (w), TRUE);
1691 gtk_window_set_modal (GTK_WINDOW (w), TRUE);
1693 dd.loop = g_main_loop_new (NULL, FALSE);
1694 dd.response = GTK_RESPONSE_CANCEL;
1695 dd.w = w;
1696 dd.timerid = 0;
1698 g_signal_connect (G_OBJECT (w),
1699 "response",
1700 G_CALLBACK (xg_dialog_response_cb),
1701 &dd);
1702 /* Don't destroy the widget if closed by the window manager close button. */
1703 g_signal_connect (G_OBJECT (w), "delete-event", G_CALLBACK (gtk_true), NULL);
1704 gtk_widget_show (w);
1706 record_unwind_protect (pop_down_dialog, make_save_value (&dd, 0));
1708 (void) xg_maybe_add_timer (&dd);
1709 g_main_loop_run (dd.loop);
1711 dd.w = 0;
1712 unbind_to (count, Qnil);
1714 return dd.response;
1718 /***********************************************************************
1719 File dialog functions
1720 ***********************************************************************/
1721 /* Return non-zero if the old file selection dialog is being used.
1722 Return zero if not. */
1725 xg_uses_old_file_dialog (void)
1727 #ifdef HAVE_GTK_FILE_SELECTION_NEW
1728 return x_gtk_use_old_file_dialog;
1729 #else
1730 return 0;
1731 #endif
1735 typedef char * (*xg_get_file_func) (GtkWidget *);
1737 /* Return the selected file for file chooser dialog W.
1738 The returned string must be free:d. */
1740 static char *
1741 xg_get_file_name_from_chooser (GtkWidget *w)
1743 return gtk_file_chooser_get_filename (GTK_FILE_CHOOSER (w));
1746 /* Callback called when the "Show hidden files" toggle is pressed.
1747 WIDGET is the toggle widget, DATA is the file chooser dialog. */
1749 static void
1750 xg_toggle_visibility_cb (GtkWidget *widget, gpointer data)
1752 GtkFileChooser *dialog = GTK_FILE_CHOOSER (data);
1753 gboolean visible;
1754 g_object_get (G_OBJECT (dialog), "show-hidden", &visible, NULL);
1755 g_object_set (G_OBJECT (dialog), "show-hidden", !visible, NULL);
1759 /* Callback called when a property changes in a file chooser.
1760 GOBJECT is the file chooser dialog, ARG1 describes the property.
1761 USER_DATA is the toggle widget in the file chooser dialog.
1762 We use this to update the "Show hidden files" toggle when the user
1763 changes that property by right clicking in the file list. */
1765 static void
1766 xg_toggle_notify_cb (GObject *gobject, GParamSpec *arg1, gpointer user_data)
1768 if (strcmp (arg1->name, "show-hidden") == 0)
1770 GtkWidget *wtoggle = GTK_WIDGET (user_data);
1771 gboolean visible, toggle_on;
1773 g_object_get (G_OBJECT (gobject), "show-hidden", &visible, NULL);
1774 toggle_on = gtk_toggle_button_get_active (GTK_TOGGLE_BUTTON (wtoggle));
1776 if (!!visible != !!toggle_on)
1778 g_signal_handlers_block_by_func (G_OBJECT (wtoggle),
1779 G_CALLBACK (xg_toggle_visibility_cb),
1780 gobject);
1781 gtk_toggle_button_set_active (GTK_TOGGLE_BUTTON (wtoggle), visible);
1782 g_signal_handlers_unblock_by_func
1783 (G_OBJECT (wtoggle),
1784 G_CALLBACK (xg_toggle_visibility_cb),
1785 gobject);
1787 x_gtk_show_hidden_files = visible;
1791 /* Read a file name from the user using a file chooser dialog.
1792 F is the current frame.
1793 PROMPT is a prompt to show to the user. May not be NULL.
1794 DEFAULT_FILENAME is a default selection to be displayed. May be NULL.
1795 If MUSTMATCH_P is non-zero, the returned file name must be an existing
1796 file. (Actually, this only has cosmetic effects, the user can
1797 still enter a non-existing file.) *FUNC is set to a function that
1798 can be used to retrieve the selected file name from the returned widget.
1800 Returns the created widget. */
1802 static GtkWidget *
1803 xg_get_file_with_chooser (FRAME_PTR f,
1804 char *prompt,
1805 char *default_filename,
1806 int mustmatch_p, int only_dir_p,
1807 xg_get_file_func *func)
1809 char msgbuf[1024];
1811 GtkWidget *filewin, *wtoggle, *wbox, *wmessage IF_LINT (= NULL);
1812 GtkWindow *gwin = GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f));
1813 GtkFileChooserAction action = (mustmatch_p ?
1814 GTK_FILE_CHOOSER_ACTION_OPEN :
1815 GTK_FILE_CHOOSER_ACTION_SAVE);
1817 if (only_dir_p)
1818 action = GTK_FILE_CHOOSER_ACTION_SELECT_FOLDER;
1820 filewin = gtk_file_chooser_dialog_new (prompt, gwin, action,
1821 GTK_STOCK_CANCEL, GTK_RESPONSE_CANCEL,
1822 (mustmatch_p || only_dir_p ?
1823 GTK_STOCK_OPEN : GTK_STOCK_OK),
1824 GTK_RESPONSE_OK,
1825 NULL);
1826 gtk_file_chooser_set_local_only (GTK_FILE_CHOOSER (filewin), TRUE);
1828 wbox = gtk_box_new (GTK_ORIENTATION_VERTICAL, 0);
1829 gtk_box_set_homogeneous (GTK_BOX (wbox), FALSE);
1830 gtk_widget_show (wbox);
1831 wtoggle = gtk_check_button_new_with_label ("Show hidden files.");
1833 if (x_gtk_show_hidden_files)
1835 g_object_set (G_OBJECT (filewin), "show-hidden", TRUE, NULL);
1836 gtk_toggle_button_set_active (GTK_TOGGLE_BUTTON (wtoggle), TRUE);
1838 gtk_widget_show (wtoggle);
1839 g_signal_connect (G_OBJECT (wtoggle), "clicked",
1840 G_CALLBACK (xg_toggle_visibility_cb), filewin);
1841 g_signal_connect (G_OBJECT (filewin), "notify",
1842 G_CALLBACK (xg_toggle_notify_cb), wtoggle);
1844 if (x_gtk_file_dialog_help_text)
1846 msgbuf[0] = '\0';
1847 /* Gtk+ 2.10 has the file name text entry box integrated in the dialog.
1848 Show the C-l help text only for versions < 2.10. */
1849 if (gtk_check_version (2, 10, 0) && action != GTK_FILE_CHOOSER_ACTION_SAVE)
1850 strcat (msgbuf, "\nType C-l to display a file name text entry box.\n");
1851 strcat (msgbuf, "\nIf you don't like this file selector, use the "
1852 "corresponding\nkey binding or customize "
1853 "use-file-dialog to turn it off.");
1855 wmessage = gtk_label_new (msgbuf);
1856 gtk_widget_show (wmessage);
1859 gtk_box_pack_start (GTK_BOX (wbox), wtoggle, FALSE, FALSE, 0);
1860 if (x_gtk_file_dialog_help_text)
1861 gtk_box_pack_start (GTK_BOX (wbox), wmessage, FALSE, FALSE, 0);
1862 gtk_file_chooser_set_extra_widget (GTK_FILE_CHOOSER (filewin), wbox);
1864 if (default_filename)
1866 Lisp_Object file;
1867 struct gcpro gcpro1;
1868 char *utf8_filename;
1869 GCPRO1 (file);
1871 file = build_string (default_filename);
1873 /* File chooser does not understand ~/... in the file name. It must be
1874 an absolute name starting with /. */
1875 if (default_filename[0] != '/')
1876 file = Fexpand_file_name (file, Qnil);
1878 utf8_filename = SSDATA (ENCODE_UTF_8 (file));
1879 if (! NILP (Ffile_directory_p (file)))
1880 gtk_file_chooser_set_current_folder (GTK_FILE_CHOOSER (filewin),
1881 utf8_filename);
1882 else
1884 gtk_file_chooser_set_filename (GTK_FILE_CHOOSER (filewin),
1885 utf8_filename);
1886 if (action == GTK_FILE_CHOOSER_ACTION_SAVE)
1888 char *cp = strrchr (utf8_filename, '/');
1889 if (cp) ++cp;
1890 else cp = utf8_filename;
1891 gtk_file_chooser_set_current_name (GTK_FILE_CHOOSER (filewin), cp);
1895 UNGCPRO;
1898 *func = xg_get_file_name_from_chooser;
1899 return filewin;
1902 #ifdef HAVE_GTK_FILE_SELECTION_NEW
1904 /* Return the selected file for file selector dialog W.
1905 The returned string must be free:d. */
1907 static char *
1908 xg_get_file_name_from_selector (GtkWidget *w)
1910 GtkFileSelection *filesel = GTK_FILE_SELECTION (w);
1911 return xstrdup ((char*) gtk_file_selection_get_filename (filesel));
1914 /* Create a file selection dialog.
1915 F is the current frame.
1916 PROMPT is a prompt to show to the user. May not be NULL.
1917 DEFAULT_FILENAME is a default selection to be displayed. May be NULL.
1918 If MUSTMATCH_P is non-zero, the returned file name must be an existing
1919 file. *FUNC is set to a function that can be used to retrieve the
1920 selected file name from the returned widget.
1922 Returns the created widget. */
1924 static GtkWidget *
1925 xg_get_file_with_selection (FRAME_PTR f,
1926 char *prompt,
1927 char *default_filename,
1928 int mustmatch_p, int only_dir_p,
1929 xg_get_file_func *func)
1931 GtkWidget *filewin;
1932 GtkFileSelection *filesel;
1934 filewin = gtk_file_selection_new (prompt);
1935 filesel = GTK_FILE_SELECTION (filewin);
1937 if (default_filename)
1938 gtk_file_selection_set_filename (filesel, default_filename);
1940 if (mustmatch_p)
1942 /* The selection_entry part of filesel is not documented. */
1943 gtk_widget_set_sensitive (filesel->selection_entry, FALSE);
1944 gtk_file_selection_hide_fileop_buttons (filesel);
1947 *func = xg_get_file_name_from_selector;
1949 return filewin;
1951 #endif /* HAVE_GTK_FILE_SELECTION_NEW */
1953 /* Read a file name from the user using a file dialog, either the old
1954 file selection dialog, or the new file chooser dialog. Which to use
1955 depends on what the GTK version used has, and what the value of
1956 gtk-use-old-file-dialog.
1957 F is the current frame.
1958 PROMPT is a prompt to show to the user. May not be NULL.
1959 DEFAULT_FILENAME is a default selection to be displayed. May be NULL.
1960 If MUSTMATCH_P is non-zero, the returned file name must be an existing
1961 file.
1963 Returns a file name or NULL if no file was selected.
1964 The returned string must be freed by the caller. */
1966 char *
1967 xg_get_file_name (FRAME_PTR f,
1968 char *prompt,
1969 char *default_filename,
1970 int mustmatch_p,
1971 int only_dir_p)
1973 GtkWidget *w = 0;
1974 char *fn = 0;
1975 int filesel_done = 0;
1976 xg_get_file_func func;
1978 #if defined (HAVE_PTHREAD) && defined (__SIGRTMIN)
1979 /* I really don't know why this is needed, but without this the GLIBC add on
1980 library linuxthreads hangs when the Gnome file chooser backend creates
1981 threads. */
1982 sigblock (sigmask (__SIGRTMIN));
1983 #endif /* HAVE_PTHREAD */
1985 #ifdef HAVE_GTK_FILE_SELECTION_NEW
1987 if (xg_uses_old_file_dialog ())
1988 w = xg_get_file_with_selection (f, prompt, default_filename,
1989 mustmatch_p, only_dir_p, &func);
1990 else
1991 w = xg_get_file_with_chooser (f, prompt, default_filename,
1992 mustmatch_p, only_dir_p, &func);
1994 #else /* not HAVE_GTK_FILE_SELECTION_NEW */
1995 w = xg_get_file_with_chooser (f, prompt, default_filename,
1996 mustmatch_p, only_dir_p, &func);
1997 #endif /* not HAVE_GTK_FILE_SELECTION_NEW */
1999 gtk_widget_set_name (w, "emacs-filedialog");
2001 filesel_done = xg_dialog_run (f, w);
2003 #if defined (HAVE_PTHREAD) && defined (__SIGRTMIN)
2004 sigunblock (sigmask (__SIGRTMIN));
2005 #endif
2007 if (filesel_done == GTK_RESPONSE_OK)
2008 fn = (*func) (w);
2010 gtk_widget_destroy (w);
2011 return fn;
2014 /***********************************************************************
2015 GTK font chooser
2016 ***********************************************************************/
2018 #ifdef HAVE_FREETYPE
2020 #if USE_NEW_GTK_FONT_CHOOSER
2022 #define XG_WEIGHT_TO_SYMBOL(w) \
2023 (w <= PANGO_WEIGHT_THIN ? Qextra_light \
2024 : w <= PANGO_WEIGHT_ULTRALIGHT ? Qlight \
2025 : w <= PANGO_WEIGHT_LIGHT ? Qsemi_light \
2026 : w < PANGO_WEIGHT_MEDIUM ? Qnormal \
2027 : w <= PANGO_WEIGHT_SEMIBOLD ? Qsemi_bold \
2028 : w <= PANGO_WEIGHT_BOLD ? Qbold \
2029 : w <= PANGO_WEIGHT_HEAVY ? Qextra_bold \
2030 : Qultra_bold)
2032 #define XG_STYLE_TO_SYMBOL(s) \
2033 (s == PANGO_STYLE_OBLIQUE ? Qoblique \
2034 : s == PANGO_STYLE_ITALIC ? Qitalic \
2035 : Qnormal)
2037 #endif /* USE_NEW_GTK_FONT_CHOOSER */
2040 static char *x_last_font_name;
2041 extern Lisp_Object Qxft;
2043 /* Pop up a GTK font selector and return the name of the font the user
2044 selects, as a C string. The returned font name follows GTK's own
2045 format:
2047 `FAMILY [VALUE1 VALUE2] SIZE'
2049 This can be parsed using font_parse_fcname in font.c.
2050 DEFAULT_NAME, if non-zero, is the default font name. */
2052 Lisp_Object
2053 xg_get_font (FRAME_PTR f, const char *default_name)
2055 GtkWidget *w;
2056 int done = 0;
2057 Lisp_Object font = Qnil;
2059 #if defined (HAVE_PTHREAD) && defined (__SIGRTMIN)
2060 sigblock (sigmask (__SIGRTMIN));
2061 #endif /* HAVE_PTHREAD */
2063 w = gtk_font_chooser_dialog_new
2064 ("Pick a font", GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)));
2066 if (default_name)
2068 /* Convert fontconfig names to Gtk names, i.e. remove - before
2069 number */
2070 char *p = strrchr (default_name, '-');
2071 if (p)
2073 char *ep = p+1;
2074 while (c_isdigit (*ep))
2075 ++ep;
2076 if (*ep == '\0') *p = ' ';
2079 else if (x_last_font_name)
2080 default_name = x_last_font_name;
2082 if (default_name)
2083 gtk_font_chooser_set_font (GTK_FONT_CHOOSER (w), default_name);
2085 gtk_widget_set_name (w, "emacs-fontdialog");
2086 done = xg_dialog_run (f, w);
2088 #if defined (HAVE_PTHREAD) && defined (__SIGRTMIN)
2089 sigunblock (sigmask (__SIGRTMIN));
2090 #endif
2092 if (done == GTK_RESPONSE_OK)
2094 #if USE_NEW_GTK_FONT_CHOOSER
2095 /* Use the GTK3 font chooser. */
2096 PangoFontDescription *desc
2097 = gtk_font_chooser_get_font_desc (GTK_FONT_CHOOSER (w));
2099 if (desc)
2101 Lisp_Object args[10];
2102 const char *name = pango_font_description_get_family (desc);
2103 gint size = pango_font_description_get_size (desc);
2104 PangoWeight weight = pango_font_description_get_weight (desc);
2105 PangoStyle style = pango_font_description_get_style (desc);
2107 args[0] = QCname;
2108 args[1] = build_string (name);
2110 args[2] = QCsize;
2111 args[3] = make_float (pango_units_to_double (size));
2113 args[4] = QCweight;
2114 args[5] = XG_WEIGHT_TO_SYMBOL (weight);
2116 args[6] = QCslant;
2117 args[7] = XG_STYLE_TO_SYMBOL (style);
2119 args[8] = QCtype;
2120 args[9] = Qxft;
2122 font = Ffont_spec (8, args);
2124 pango_font_description_free (desc);
2125 xfree (x_last_font_name);
2126 x_last_font_name = xstrdup (name);
2129 #else /* Use old font selector, which just returns the font name. */
2131 char *font_name
2132 = gtk_font_selection_dialog_get_font_name (GTK_FONT_CHOOSER (w));
2134 if (font_name)
2136 font = build_string (font_name);
2137 g_free (x_last_font_name);
2138 x_last_font_name = font_name;
2140 #endif /* USE_NEW_GTK_FONT_CHOOSER */
2143 gtk_widget_destroy (w);
2144 return font;
2146 #endif /* HAVE_FREETYPE */
2150 /***********************************************************************
2151 Menu functions.
2152 ***********************************************************************/
2154 /* The name of menu items that can be used for customization. Since GTK
2155 RC files are very crude and primitive, we have to set this on all
2156 menu item names so a user can easily customize menu items. */
2158 #define MENU_ITEM_NAME "emacs-menuitem"
2161 /* Linked list of all allocated struct xg_menu_cb_data. Used for marking
2162 during GC. The next member points to the items. */
2163 static xg_list_node xg_menu_cb_list;
2165 /* Linked list of all allocated struct xg_menu_item_cb_data. Used for marking
2166 during GC. The next member points to the items. */
2167 static xg_list_node xg_menu_item_cb_list;
2169 /* Allocate and initialize CL_DATA if NULL, otherwise increase ref_count.
2170 F is the frame CL_DATA will be initialized for.
2171 HIGHLIGHT_CB is the callback to call when entering/leaving menu items.
2173 The menu bar and all sub menus under the menu bar in a frame
2174 share the same structure, hence the reference count.
2176 Returns CL_DATA if CL_DATA is not NULL, or a pointer to a newly
2177 allocated xg_menu_cb_data if CL_DATA is NULL. */
2179 static xg_menu_cb_data *
2180 make_cl_data (xg_menu_cb_data *cl_data, FRAME_PTR f, GCallback highlight_cb)
2182 if (! cl_data)
2184 cl_data = xmalloc (sizeof *cl_data);
2185 cl_data->f = f;
2186 cl_data->menu_bar_vector = f->menu_bar_vector;
2187 cl_data->menu_bar_items_used = f->menu_bar_items_used;
2188 cl_data->highlight_cb = highlight_cb;
2189 cl_data->ref_count = 0;
2191 xg_list_insert (&xg_menu_cb_list, &cl_data->ptrs);
2194 cl_data->ref_count++;
2196 return cl_data;
2199 /* Update CL_DATA with values from frame F and with HIGHLIGHT_CB.
2200 HIGHLIGHT_CB is the callback to call when entering/leaving menu items.
2202 When the menu bar is updated, menu items may have been added and/or
2203 removed, so menu_bar_vector and menu_bar_items_used change. We must
2204 then update CL_DATA since it is used to determine which menu
2205 item that is invoked in the menu.
2206 HIGHLIGHT_CB could change, there is no check that the same
2207 function is given when modifying a menu bar as was given when
2208 creating the menu bar. */
2210 static void
2211 update_cl_data (xg_menu_cb_data *cl_data,
2212 FRAME_PTR f,
2213 GCallback highlight_cb)
2215 if (cl_data)
2217 cl_data->f = f;
2218 cl_data->menu_bar_vector = f->menu_bar_vector;
2219 cl_data->menu_bar_items_used = f->menu_bar_items_used;
2220 cl_data->highlight_cb = highlight_cb;
2224 /* Decrease reference count for CL_DATA.
2225 If reference count is zero, free CL_DATA. */
2227 static void
2228 unref_cl_data (xg_menu_cb_data *cl_data)
2230 if (cl_data && cl_data->ref_count > 0)
2232 cl_data->ref_count--;
2233 if (cl_data->ref_count == 0)
2235 xg_list_remove (&xg_menu_cb_list, &cl_data->ptrs);
2236 xfree (cl_data);
2241 /* Function that marks all lisp data during GC. */
2243 void
2244 xg_mark_data (void)
2246 xg_list_node *iter;
2247 Lisp_Object rest, frame;
2249 for (iter = xg_menu_cb_list.next; iter; iter = iter->next)
2250 mark_object (((xg_menu_cb_data *) iter)->menu_bar_vector);
2252 for (iter = xg_menu_item_cb_list.next; iter; iter = iter->next)
2254 xg_menu_item_cb_data *cb_data = (xg_menu_item_cb_data *) iter;
2256 if (! NILP (cb_data->help))
2257 mark_object (cb_data->help);
2260 FOR_EACH_FRAME (rest, frame)
2262 FRAME_PTR f = XFRAME (frame);
2264 if (FRAME_X_P (f) && FRAME_GTK_OUTER_WIDGET (f))
2266 struct xg_frame_tb_info *tbinfo
2267 = g_object_get_data (G_OBJECT (FRAME_GTK_OUTER_WIDGET (f)),
2268 TB_INFO_KEY);
2269 if (tbinfo)
2271 mark_object (tbinfo->last_tool_bar);
2272 mark_object (tbinfo->style);
2279 /* Callback called when a menu item is destroyed. Used to free data.
2280 W is the widget that is being destroyed (not used).
2281 CLIENT_DATA points to the xg_menu_item_cb_data associated with the W. */
2283 static void
2284 menuitem_destroy_callback (GtkWidget *w, gpointer client_data)
2286 if (client_data)
2288 xg_menu_item_cb_data *data = (xg_menu_item_cb_data*) client_data;
2289 xg_list_remove (&xg_menu_item_cb_list, &data->ptrs);
2290 xfree (data);
2294 /* Callback called when the pointer enters/leaves a menu item.
2295 W is the parent of the menu item.
2296 EVENT is either an enter event or leave event.
2297 CLIENT_DATA is not used.
2299 Returns FALSE to tell GTK to keep processing this event. */
2301 static gboolean
2302 menuitem_highlight_callback (GtkWidget *w,
2303 GdkEventCrossing *event,
2304 gpointer client_data)
2306 GdkEvent ev;
2307 GtkWidget *subwidget;
2308 xg_menu_item_cb_data *data;
2310 ev.crossing = *event;
2311 subwidget = gtk_get_event_widget (&ev);
2312 data = (xg_menu_item_cb_data *) g_object_get_data (G_OBJECT (subwidget),
2313 XG_ITEM_DATA);
2314 if (data)
2316 if (! NILP (data->help) && data->cl_data->highlight_cb)
2318 gpointer call_data = event->type == GDK_LEAVE_NOTIFY ? 0 : data;
2319 GtkCallback func = (GtkCallback) data->cl_data->highlight_cb;
2320 (*func) (subwidget, call_data);
2324 return FALSE;
2327 /* Callback called when a menu is destroyed. Used to free data.
2328 W is the widget that is being destroyed (not used).
2329 CLIENT_DATA points to the xg_menu_cb_data associated with W. */
2331 static void
2332 menu_destroy_callback (GtkWidget *w, gpointer client_data)
2334 unref_cl_data ((xg_menu_cb_data*) client_data);
2337 /* Make a GTK widget that contains both UTF8_LABEL and UTF8_KEY (both
2338 must be non-NULL) and can be inserted into a menu item.
2340 Returns the GtkHBox. */
2342 static GtkWidget *
2343 make_widget_for_menu_item (const char *utf8_label, const char *utf8_key)
2345 GtkWidget *wlbl;
2346 GtkWidget *wkey;
2347 GtkWidget *wbox;
2349 wbox = gtk_box_new (GTK_ORIENTATION_HORIZONTAL, 0);
2350 gtk_box_set_homogeneous (GTK_BOX (wbox), FALSE);
2351 wlbl = gtk_label_new (utf8_label);
2352 wkey = gtk_label_new (utf8_key);
2354 gtk_misc_set_alignment (GTK_MISC (wlbl), 0.0, 0.5);
2355 gtk_misc_set_alignment (GTK_MISC (wkey), 0.0, 0.5);
2357 gtk_box_pack_start (GTK_BOX (wbox), wlbl, TRUE, TRUE, 0);
2358 gtk_box_pack_start (GTK_BOX (wbox), wkey, FALSE, FALSE, 0);
2360 gtk_widget_set_name (wlbl, MENU_ITEM_NAME);
2361 gtk_widget_set_name (wkey, MENU_ITEM_NAME);
2362 gtk_widget_set_name (wbox, MENU_ITEM_NAME);
2364 return wbox;
2367 /* Make and return a menu item widget with the key to the right.
2368 UTF8_LABEL is the text for the menu item (GTK uses UTF8 internally).
2369 UTF8_KEY is the text representing the key binding.
2370 ITEM is the widget_value describing the menu item.
2372 GROUP is an in/out parameter. If the menu item to be created is not
2373 part of any radio menu group, *GROUP contains NULL on entry and exit.
2374 If the menu item to be created is part of a radio menu group, on entry
2375 *GROUP contains the group to use, or NULL if this is the first item
2376 in the group. On exit, *GROUP contains the radio item group.
2378 Unfortunately, keys don't line up as nicely as in Motif,
2379 but the MacOS X version doesn't either, so I guess that is OK. */
2381 static GtkWidget *
2382 make_menu_item (const char *utf8_label,
2383 const char *utf8_key,
2384 widget_value *item,
2385 GSList **group)
2387 GtkWidget *w;
2388 GtkWidget *wtoadd = 0;
2390 /* It has been observed that some menu items have a NULL name field.
2391 This will lead to this function being called with a NULL utf8_label.
2392 GTK crashes on that so we set a blank label. Why there is a NULL
2393 name remains to be investigated. */
2394 if (! utf8_label) utf8_label = " ";
2396 if (utf8_key)
2397 wtoadd = make_widget_for_menu_item (utf8_label, utf8_key);
2399 if (item->button_type == BUTTON_TYPE_TOGGLE)
2401 *group = NULL;
2402 if (utf8_key) w = gtk_check_menu_item_new ();
2403 else w = gtk_check_menu_item_new_with_label (utf8_label);
2404 gtk_check_menu_item_set_active (GTK_CHECK_MENU_ITEM (w), item->selected);
2406 else if (item->button_type == BUTTON_TYPE_RADIO)
2408 if (utf8_key) w = gtk_radio_menu_item_new (*group);
2409 else w = gtk_radio_menu_item_new_with_label (*group, utf8_label);
2410 *group = gtk_radio_menu_item_get_group (GTK_RADIO_MENU_ITEM (w));
2411 if (item->selected)
2412 gtk_check_menu_item_set_active (GTK_CHECK_MENU_ITEM (w), TRUE);
2414 else
2416 *group = NULL;
2417 if (utf8_key) w = gtk_menu_item_new ();
2418 else w = gtk_menu_item_new_with_label (utf8_label);
2421 if (wtoadd) gtk_container_add (GTK_CONTAINER (w), wtoadd);
2422 if (! item->enabled) gtk_widget_set_sensitive (w, FALSE);
2424 return w;
2427 static int xg_detached_menus;
2429 /* Returns non-zero if there are detached menus. */
2432 xg_have_tear_offs (void)
2434 return xg_detached_menus > 0;
2437 /* Callback invoked when a detached menu window is removed. Here we
2438 decrease the xg_detached_menus count.
2439 WIDGET is the top level window that is removed (the parent of the menu).
2440 CLIENT_DATA is not used. */
2442 static void
2443 tearoff_remove (GtkWidget *widget, gpointer client_data)
2445 if (xg_detached_menus > 0) --xg_detached_menus;
2448 /* Callback invoked when a menu is detached. It increases the
2449 xg_detached_menus count.
2450 WIDGET is the GtkTearoffMenuItem.
2451 CLIENT_DATA is not used. */
2453 static void
2454 tearoff_activate (GtkWidget *widget, gpointer client_data)
2456 GtkWidget *menu = gtk_widget_get_parent (widget);
2457 if (gtk_menu_get_tearoff_state (GTK_MENU (menu)))
2459 ++xg_detached_menus;
2460 g_signal_connect (G_OBJECT (gtk_widget_get_toplevel (widget)),
2461 "destroy",
2462 G_CALLBACK (tearoff_remove), 0);
2467 /* Create a menu item widget, and connect the callbacks.
2468 ITEM describes the menu item.
2469 F is the frame the created menu belongs to.
2470 SELECT_CB is the callback to use when a menu item is selected.
2471 HIGHLIGHT_CB is the callback to call when entering/leaving menu items.
2472 CL_DATA points to the callback data to be used for this menu.
2473 GROUP is an in/out parameter. If the menu item to be created is not
2474 part of any radio menu group, *GROUP contains NULL on entry and exit.
2475 If the menu item to be created is part of a radio menu group, on entry
2476 *GROUP contains the group to use, or NULL if this is the first item
2477 in the group. On exit, *GROUP contains the radio item group.
2479 Returns the created GtkWidget. */
2481 static GtkWidget *
2482 xg_create_one_menuitem (widget_value *item,
2483 FRAME_PTR f,
2484 GCallback select_cb,
2485 GCallback highlight_cb,
2486 xg_menu_cb_data *cl_data,
2487 GSList **group)
2489 char *utf8_label;
2490 char *utf8_key;
2491 GtkWidget *w;
2492 xg_menu_item_cb_data *cb_data;
2494 utf8_label = get_utf8_string (item->name);
2495 utf8_key = get_utf8_string (item->key);
2497 w = make_menu_item (utf8_label, utf8_key, item, group);
2499 if (utf8_label) g_free (utf8_label);
2500 if (utf8_key) g_free (utf8_key);
2502 cb_data = xmalloc (sizeof *cb_data);
2504 xg_list_insert (&xg_menu_item_cb_list, &cb_data->ptrs);
2506 cb_data->select_id = 0;
2507 cb_data->help = item->help;
2508 cb_data->cl_data = cl_data;
2509 cb_data->call_data = item->call_data;
2511 g_signal_connect (G_OBJECT (w),
2512 "destroy",
2513 G_CALLBACK (menuitem_destroy_callback),
2514 cb_data);
2516 /* Put cb_data in widget, so we can get at it when modifying menubar */
2517 g_object_set_data (G_OBJECT (w), XG_ITEM_DATA, cb_data);
2519 /* final item, not a submenu */
2520 if (item->call_data && ! item->contents)
2522 if (select_cb)
2523 cb_data->select_id
2524 = g_signal_connect (G_OBJECT (w), "activate", select_cb, cb_data);
2527 return w;
2530 /* Create a full menu tree specified by DATA.
2531 F is the frame the created menu belongs to.
2532 SELECT_CB is the callback to use when a menu item is selected.
2533 DEACTIVATE_CB is the callback to use when a sub menu is not shown anymore.
2534 HIGHLIGHT_CB is the callback to call when entering/leaving menu items.
2535 POP_UP_P is non-zero if we shall create a popup menu.
2536 MENU_BAR_P is non-zero if we shall create a menu bar.
2537 ADD_TEAROFF_P is non-zero if we shall add a tearoff menu item. Ignored
2538 if MENU_BAR_P is non-zero.
2539 TOPMENU is the topmost GtkWidget that others shall be placed under.
2540 It may be NULL, in that case we create the appropriate widget
2541 (menu bar or menu item depending on POP_UP_P and MENU_BAR_P)
2542 CL_DATA is the callback data we shall use for this menu, or NULL
2543 if we haven't set the first callback yet.
2544 NAME is the name to give to the top level menu if this function
2545 creates it. May be NULL to not set any name.
2547 Returns the top level GtkWidget. This is TOPLEVEL if TOPLEVEL is
2548 not NULL.
2550 This function calls itself to create submenus. */
2552 static GtkWidget *
2553 create_menus (widget_value *data,
2554 FRAME_PTR f,
2555 GCallback select_cb,
2556 GCallback deactivate_cb,
2557 GCallback highlight_cb,
2558 int pop_up_p,
2559 int menu_bar_p,
2560 int add_tearoff_p,
2561 GtkWidget *topmenu,
2562 xg_menu_cb_data *cl_data,
2563 const char *name)
2565 widget_value *item;
2566 GtkWidget *wmenu = topmenu;
2567 GSList *group = NULL;
2569 if (! topmenu)
2571 if (! menu_bar_p)
2573 wmenu = gtk_menu_new ();
2574 xg_set_screen (wmenu, f);
2575 /* Connect this to the menu instead of items so we get enter/leave for
2576 disabled items also. TODO: Still does not get enter/leave for
2577 disabled items in detached menus. */
2578 g_signal_connect (G_OBJECT (wmenu),
2579 "enter-notify-event",
2580 G_CALLBACK (menuitem_highlight_callback),
2581 NULL);
2582 g_signal_connect (G_OBJECT (wmenu),
2583 "leave-notify-event",
2584 G_CALLBACK (menuitem_highlight_callback),
2585 NULL);
2587 else
2589 wmenu = gtk_menu_bar_new ();
2590 /* Set width of menu bar to a small value so it doesn't enlarge
2591 a small initial frame size. The width will be set to the
2592 width of the frame later on when it is added to a container.
2593 height -1: Natural height. */
2594 gtk_widget_set_size_request (wmenu, 1, -1);
2597 /* Put cl_data on the top menu for easier access. */
2598 cl_data = make_cl_data (cl_data, f, highlight_cb);
2599 g_object_set_data (G_OBJECT (wmenu), XG_FRAME_DATA, (gpointer)cl_data);
2600 g_signal_connect (G_OBJECT (wmenu), "destroy",
2601 G_CALLBACK (menu_destroy_callback), cl_data);
2603 if (name)
2604 gtk_widget_set_name (wmenu, name);
2606 if (deactivate_cb)
2607 g_signal_connect (G_OBJECT (wmenu),
2608 "selection-done", deactivate_cb, 0);
2611 if (! menu_bar_p && add_tearoff_p)
2613 GtkWidget *tearoff = gtk_tearoff_menu_item_new ();
2614 gtk_menu_shell_append (GTK_MENU_SHELL (wmenu), tearoff);
2616 g_signal_connect (G_OBJECT (tearoff), "activate",
2617 G_CALLBACK (tearoff_activate), 0);
2620 for (item = data; item; item = item->next)
2622 GtkWidget *w;
2624 if (pop_up_p && !item->contents && !item->call_data
2625 && !menu_separator_name_p (item->name))
2627 char *utf8_label;
2628 /* A title for a popup. We do the same as GTK does when
2629 creating titles, but it does not look good. */
2630 group = NULL;
2631 utf8_label = get_utf8_string (item->name);
2633 gtk_menu_set_title (GTK_MENU (wmenu), utf8_label);
2634 w = gtk_menu_item_new_with_label (utf8_label);
2635 gtk_widget_set_sensitive (w, FALSE);
2636 if (utf8_label) g_free (utf8_label);
2638 else if (menu_separator_name_p (item->name))
2640 group = NULL;
2641 /* GTK only have one separator type. */
2642 w = gtk_separator_menu_item_new ();
2644 else
2646 w = xg_create_one_menuitem (item,
2648 item->contents ? 0 : select_cb,
2649 highlight_cb,
2650 cl_data,
2651 &group);
2653 /* Create a possibly empty submenu for menu bar items, since some
2654 themes don't highlight items correctly without it. */
2655 if (item->contents || menu_bar_p)
2657 GtkWidget *submenu = create_menus (item->contents,
2659 select_cb,
2660 deactivate_cb,
2661 highlight_cb,
2664 add_tearoff_p,
2666 cl_data,
2668 gtk_menu_item_set_submenu (GTK_MENU_ITEM (w), submenu);
2672 gtk_menu_shell_append (GTK_MENU_SHELL (wmenu), w);
2673 gtk_widget_set_name (w, MENU_ITEM_NAME);
2676 return wmenu;
2679 /* Create a menubar, popup menu or dialog, depending on the TYPE argument.
2680 TYPE can be "menubar", "popup" for popup menu, or "dialog" for a dialog
2681 with some text and buttons.
2682 F is the frame the created item belongs to.
2683 NAME is the name to use for the top widget.
2684 VAL is a widget_value structure describing items to be created.
2685 SELECT_CB is the callback to use when a menu item is selected or
2686 a dialog button is pressed.
2687 DEACTIVATE_CB is the callback to use when an item is deactivated.
2688 For a menu, when a sub menu is not shown anymore, for a dialog it is
2689 called when the dialog is popped down.
2690 HIGHLIGHT_CB is the callback to call when entering/leaving menu items.
2692 Returns the widget created. */
2694 GtkWidget *
2695 xg_create_widget (const char *type, const char *name, FRAME_PTR f, widget_value *val,
2696 GCallback select_cb, GCallback deactivate_cb,
2697 GCallback highlight_cb)
2699 GtkWidget *w = 0;
2700 int menu_bar_p = strcmp (type, "menubar") == 0;
2701 int pop_up_p = strcmp (type, "popup") == 0;
2703 if (strcmp (type, "dialog") == 0)
2705 w = create_dialog (val, select_cb, deactivate_cb);
2706 xg_set_screen (w, f);
2707 gtk_window_set_transient_for (GTK_WINDOW (w),
2708 GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)));
2709 gtk_window_set_destroy_with_parent (GTK_WINDOW (w), TRUE);
2710 gtk_widget_set_name (w, "emacs-dialog");
2711 gtk_window_set_modal (GTK_WINDOW (w), TRUE);
2713 else if (menu_bar_p || pop_up_p)
2715 w = create_menus (val->contents,
2717 select_cb,
2718 deactivate_cb,
2719 highlight_cb,
2720 pop_up_p,
2721 menu_bar_p,
2722 menu_bar_p,
2725 name);
2727 /* Set the cursor to an arrow for popup menus when they are mapped.
2728 This is done by default for menu bar menus. */
2729 if (pop_up_p)
2731 /* Must realize so the GdkWindow inside the widget is created. */
2732 gtk_widget_realize (w);
2733 xg_set_cursor (w, FRAME_X_DISPLAY_INFO (f)->xg_cursor);
2736 else
2738 fprintf (stderr, "bad type in xg_create_widget: %s, doing nothing\n",
2739 type);
2742 return w;
2745 /* Return the label for menu item WITEM. */
2747 static const char *
2748 xg_get_menu_item_label (GtkMenuItem *witem)
2750 GtkLabel *wlabel = GTK_LABEL (XG_BIN_CHILD (witem));
2751 return gtk_label_get_label (wlabel);
2754 /* Return non-zero if the menu item WITEM has the text LABEL. */
2756 static int
2757 xg_item_label_same_p (GtkMenuItem *witem, const char *label)
2759 int is_same = 0;
2760 char *utf8_label = get_utf8_string (label);
2761 const char *old_label = witem ? xg_get_menu_item_label (witem) : 0;
2763 if (! old_label && ! utf8_label)
2764 is_same = 1;
2765 else if (old_label && utf8_label)
2766 is_same = strcmp (utf8_label, old_label) == 0;
2768 if (utf8_label) g_free (utf8_label);
2770 return is_same;
2773 /* Destroy widgets in LIST. */
2775 static void
2776 xg_destroy_widgets (GList *list)
2778 GList *iter;
2780 for (iter = list; iter; iter = g_list_next (iter))
2782 GtkWidget *w = GTK_WIDGET (iter->data);
2784 /* Destroying the widget will remove it from the container it is in. */
2785 gtk_widget_destroy (w);
2789 /* Update the top level names in MENUBAR (i.e. not submenus).
2790 F is the frame the menu bar belongs to.
2791 *LIST is a list with the current menu bar names (menu item widgets).
2792 ITER is the item within *LIST that shall be updated.
2793 POS is the numerical position, starting at 0, of ITER in *LIST.
2794 VAL describes what the menu bar shall look like after the update.
2795 SELECT_CB is the callback to use when a menu item is selected.
2796 HIGHLIGHT_CB is the callback to call when entering/leaving menu items.
2797 CL_DATA points to the callback data to be used for this menu bar.
2799 This function calls itself to walk through the menu bar names. */
2801 static void
2802 xg_update_menubar (GtkWidget *menubar,
2803 FRAME_PTR f,
2804 GList **list,
2805 GList *iter,
2806 int pos,
2807 widget_value *val,
2808 GCallback select_cb,
2809 GCallback deactivate_cb,
2810 GCallback highlight_cb,
2811 xg_menu_cb_data *cl_data)
2813 if (! iter && ! val)
2814 return;
2815 else if (iter && ! val)
2817 /* Item(s) have been removed. Remove all remaining items. */
2818 xg_destroy_widgets (iter);
2820 /* Add a blank entry so the menubar doesn't collapse to nothing. */
2821 gtk_menu_shell_insert (GTK_MENU_SHELL (menubar),
2822 gtk_menu_item_new_with_label (""),
2824 /* All updated. */
2825 val = 0;
2826 iter = 0;
2828 else if (! iter && val)
2830 /* Item(s) added. Add all new items in one call. */
2831 create_menus (val, f, select_cb, deactivate_cb, highlight_cb,
2832 0, 1, 0, menubar, cl_data, 0);
2834 /* All updated. */
2835 val = 0;
2836 iter = 0;
2838 /* Below this neither iter or val is NULL */
2839 else if (xg_item_label_same_p (GTK_MENU_ITEM (iter->data), val->name))
2841 /* This item is still the same, check next item. */
2842 val = val->next;
2843 iter = g_list_next (iter);
2844 ++pos;
2846 else /* This item is changed. */
2848 GtkMenuItem *witem = GTK_MENU_ITEM (iter->data);
2849 GtkMenuItem *witem2 = 0;
2850 int val_in_menubar = 0;
2851 int iter_in_new_menubar = 0;
2852 GList *iter2;
2853 widget_value *cur;
2855 /* See if the changed entry (val) is present later in the menu bar */
2856 for (iter2 = iter;
2857 iter2 && ! val_in_menubar;
2858 iter2 = g_list_next (iter2))
2860 witem2 = GTK_MENU_ITEM (iter2->data);
2861 val_in_menubar = xg_item_label_same_p (witem2, val->name);
2864 /* See if the current entry (iter) is present later in the
2865 specification for the new menu bar. */
2866 for (cur = val; cur && ! iter_in_new_menubar; cur = cur->next)
2867 iter_in_new_menubar = xg_item_label_same_p (witem, cur->name);
2869 if (val_in_menubar && ! iter_in_new_menubar)
2871 int nr = pos;
2873 /* This corresponds to:
2874 Current: A B C
2875 New: A C
2876 Remove B. */
2878 g_object_ref (G_OBJECT (witem));
2879 gtk_container_remove (GTK_CONTAINER (menubar), GTK_WIDGET (witem));
2880 gtk_widget_destroy (GTK_WIDGET (witem));
2882 /* Must get new list since the old changed. */
2883 g_list_free (*list);
2884 *list = iter = gtk_container_get_children (GTK_CONTAINER (menubar));
2885 while (nr-- > 0) iter = g_list_next (iter);
2887 else if (! val_in_menubar && ! iter_in_new_menubar)
2889 /* This corresponds to:
2890 Current: A B C
2891 New: A X C
2892 Rename B to X. This might seem to be a strange thing to do,
2893 since if there is a menu under B it will be totally wrong for X.
2894 But consider editing a C file. Then there is a C-mode menu
2895 (corresponds to B above).
2896 If then doing C-x C-f the minibuf menu (X above) replaces the
2897 C-mode menu. When returning from the minibuffer, we get
2898 back the C-mode menu. Thus we do:
2899 Rename B to X (C-mode to minibuf menu)
2900 Rename X to B (minibuf to C-mode menu).
2901 If the X menu hasn't been invoked, the menu under B
2902 is up to date when leaving the minibuffer. */
2903 GtkLabel *wlabel = GTK_LABEL (XG_BIN_CHILD (witem));
2904 char *utf8_label = get_utf8_string (val->name);
2905 GtkWidget *submenu = gtk_menu_item_get_submenu (witem);
2907 gtk_label_set_text (wlabel, utf8_label);
2909 /* If this item has a submenu that has been detached, change
2910 the title in the WM decorations also. */
2911 if (submenu && gtk_menu_get_tearoff_state (GTK_MENU (submenu)))
2912 /* Set the title of the detached window. */
2913 gtk_menu_set_title (GTK_MENU (submenu), utf8_label);
2915 if (utf8_label) g_free (utf8_label);
2916 iter = g_list_next (iter);
2917 val = val->next;
2918 ++pos;
2920 else if (! val_in_menubar && iter_in_new_menubar)
2922 /* This corresponds to:
2923 Current: A B C
2924 New: A X B C
2925 Insert X. */
2927 int nr = pos;
2928 GSList *group = 0;
2929 GtkWidget *w = xg_create_one_menuitem (val,
2931 select_cb,
2932 highlight_cb,
2933 cl_data,
2934 &group);
2936 /* Create a possibly empty submenu for menu bar items, since some
2937 themes don't highlight items correctly without it. */
2938 GtkWidget *submenu = create_menus (NULL, f,
2939 select_cb, deactivate_cb,
2940 highlight_cb,
2941 0, 0, 0, 0, cl_data, 0);
2942 gtk_widget_set_name (w, MENU_ITEM_NAME);
2943 gtk_menu_shell_insert (GTK_MENU_SHELL (menubar), w, pos);
2944 gtk_menu_item_set_submenu (GTK_MENU_ITEM (w), submenu);
2946 g_list_free (*list);
2947 *list = iter = gtk_container_get_children (GTK_CONTAINER (menubar));
2948 while (nr-- > 0) iter = g_list_next (iter);
2949 iter = g_list_next (iter);
2950 val = val->next;
2951 ++pos;
2953 else /* if (val_in_menubar && iter_in_new_menubar) */
2955 int nr = pos;
2956 /* This corresponds to:
2957 Current: A B C
2958 New: A C B
2959 Move C before B */
2961 g_object_ref (G_OBJECT (witem2));
2962 gtk_container_remove (GTK_CONTAINER (menubar), GTK_WIDGET (witem2));
2963 gtk_menu_shell_insert (GTK_MENU_SHELL (menubar),
2964 GTK_WIDGET (witem2), pos);
2965 g_object_unref (G_OBJECT (witem2));
2967 g_list_free (*list);
2968 *list = iter = gtk_container_get_children (GTK_CONTAINER (menubar));
2969 while (nr-- > 0) iter = g_list_next (iter);
2970 if (iter) iter = g_list_next (iter);
2971 val = val->next;
2972 ++pos;
2976 /* Update the rest of the menu bar. */
2977 xg_update_menubar (menubar, f, list, iter, pos, val,
2978 select_cb, deactivate_cb, highlight_cb, cl_data);
2981 /* Update the menu item W so it corresponds to VAL.
2982 SELECT_CB is the callback to use when a menu item is selected.
2983 HIGHLIGHT_CB is the callback to call when entering/leaving menu items.
2984 CL_DATA is the data to set in the widget for menu invocation. */
2986 static void
2987 xg_update_menu_item (widget_value *val,
2988 GtkWidget *w,
2989 GCallback select_cb,
2990 GCallback highlight_cb,
2991 xg_menu_cb_data *cl_data)
2993 GtkWidget *wchild;
2994 GtkLabel *wlbl = 0;
2995 GtkLabel *wkey = 0;
2996 char *utf8_label;
2997 char *utf8_key;
2998 const char *old_label = 0;
2999 const char *old_key = 0;
3000 xg_menu_item_cb_data *cb_data;
3002 wchild = XG_BIN_CHILD (w);
3003 utf8_label = get_utf8_string (val->name);
3004 utf8_key = get_utf8_string (val->key);
3006 /* See if W is a menu item with a key. See make_menu_item above. */
3007 if (GTK_IS_BOX (wchild))
3009 GList *list = gtk_container_get_children (GTK_CONTAINER (wchild));
3011 wlbl = GTK_LABEL (list->data);
3012 wkey = GTK_LABEL (list->next->data);
3013 g_list_free (list);
3015 if (! utf8_key)
3017 /* Remove the key and keep just the label. */
3018 g_object_ref (G_OBJECT (wlbl));
3019 gtk_container_remove (GTK_CONTAINER (w), wchild);
3020 gtk_container_add (GTK_CONTAINER (w), GTK_WIDGET (wlbl));
3021 g_object_unref (G_OBJECT (wlbl));
3022 wkey = 0;
3026 else /* Just a label. */
3028 wlbl = GTK_LABEL (wchild);
3030 /* Check if there is now a key. */
3031 if (utf8_key)
3033 GtkWidget *wtoadd = make_widget_for_menu_item (utf8_label, utf8_key);
3034 GList *list = gtk_container_get_children (GTK_CONTAINER (wtoadd));
3036 wlbl = GTK_LABEL (list->data);
3037 wkey = GTK_LABEL (list->next->data);
3038 g_list_free (list);
3040 gtk_container_remove (GTK_CONTAINER (w), wchild);
3041 gtk_container_add (GTK_CONTAINER (w), wtoadd);
3046 if (wkey) old_key = gtk_label_get_label (wkey);
3047 if (wlbl) old_label = gtk_label_get_label (wlbl);
3049 if (wkey && utf8_key && (! old_key || strcmp (utf8_key, old_key) != 0))
3050 gtk_label_set_text (wkey, utf8_key);
3052 if (! old_label || strcmp (utf8_label, old_label) != 0)
3053 gtk_label_set_text (wlbl, utf8_label);
3055 if (utf8_key) g_free (utf8_key);
3056 if (utf8_label) g_free (utf8_label);
3058 if (! val->enabled && gtk_widget_get_sensitive (w))
3059 gtk_widget_set_sensitive (w, FALSE);
3060 else if (val->enabled && ! gtk_widget_get_sensitive (w))
3061 gtk_widget_set_sensitive (w, TRUE);
3063 cb_data = (xg_menu_item_cb_data*) g_object_get_data (G_OBJECT (w),
3064 XG_ITEM_DATA);
3065 if (cb_data)
3067 cb_data->call_data = val->call_data;
3068 cb_data->help = val->help;
3069 cb_data->cl_data = cl_data;
3071 /* We assume the callback functions don't change. */
3072 if (val->call_data && ! val->contents)
3074 /* This item shall have a select callback. */
3075 if (! cb_data->select_id)
3076 cb_data->select_id
3077 = g_signal_connect (G_OBJECT (w), "activate",
3078 select_cb, cb_data);
3080 else if (cb_data->select_id)
3082 g_signal_handler_disconnect (w, cb_data->select_id);
3083 cb_data->select_id = 0;
3088 /* Update the toggle menu item W so it corresponds to VAL. */
3090 static void
3091 xg_update_toggle_item (widget_value *val, GtkWidget *w)
3093 gtk_check_menu_item_set_active (GTK_CHECK_MENU_ITEM (w), val->selected);
3096 /* Update the radio menu item W so it corresponds to VAL. */
3098 static void
3099 xg_update_radio_item (widget_value *val, GtkWidget *w)
3101 gtk_check_menu_item_set_active (GTK_CHECK_MENU_ITEM (w), val->selected);
3104 /* Update the sub menu SUBMENU and all its children so it corresponds to VAL.
3105 SUBMENU may be NULL, in that case a new menu is created.
3106 F is the frame the menu bar belongs to.
3107 VAL describes the contents of the menu bar.
3108 SELECT_CB is the callback to use when a menu item is selected.
3109 DEACTIVATE_CB is the callback to use when a sub menu is not shown anymore.
3110 HIGHLIGHT_CB is the callback to call when entering/leaving menu items.
3111 CL_DATA is the call back data to use for any newly created items.
3113 Returns the updated submenu widget, that is SUBMENU unless SUBMENU
3114 was NULL. */
3116 static GtkWidget *
3117 xg_update_submenu (GtkWidget *submenu,
3118 FRAME_PTR f,
3119 widget_value *val,
3120 GCallback select_cb,
3121 GCallback deactivate_cb,
3122 GCallback highlight_cb,
3123 xg_menu_cb_data *cl_data)
3125 GtkWidget *newsub = submenu;
3126 GList *list = 0;
3127 GList *iter;
3128 widget_value *cur;
3129 int has_tearoff_p = 0;
3130 GList *first_radio = 0;
3132 if (submenu)
3133 list = gtk_container_get_children (GTK_CONTAINER (submenu));
3135 for (cur = val, iter = list;
3136 cur && iter;
3137 iter = g_list_next (iter), cur = cur->next)
3139 GtkWidget *w = GTK_WIDGET (iter->data);
3141 /* Skip tearoff items, they have no counterpart in val. */
3142 if (GTK_IS_TEAROFF_MENU_ITEM (w))
3144 has_tearoff_p = 1;
3145 iter = g_list_next (iter);
3146 if (iter) w = GTK_WIDGET (iter->data);
3147 else break;
3150 /* Remember first radio button in a group. If we get a mismatch in
3151 a radio group we must rebuild the whole group so that the connections
3152 in GTK becomes correct. */
3153 if (cur->button_type == BUTTON_TYPE_RADIO && ! first_radio)
3154 first_radio = iter;
3155 else if (cur->button_type != BUTTON_TYPE_RADIO
3156 && ! GTK_IS_RADIO_MENU_ITEM (w))
3157 first_radio = 0;
3159 if (GTK_IS_SEPARATOR_MENU_ITEM (w))
3161 if (! menu_separator_name_p (cur->name))
3162 break;
3164 else if (GTK_IS_CHECK_MENU_ITEM (w))
3166 if (cur->button_type != BUTTON_TYPE_TOGGLE)
3167 break;
3168 xg_update_toggle_item (cur, w);
3169 xg_update_menu_item (cur, w, select_cb, highlight_cb, cl_data);
3171 else if (GTK_IS_RADIO_MENU_ITEM (w))
3173 if (cur->button_type != BUTTON_TYPE_RADIO)
3174 break;
3175 xg_update_radio_item (cur, w);
3176 xg_update_menu_item (cur, w, select_cb, highlight_cb, cl_data);
3178 else if (GTK_IS_MENU_ITEM (w))
3180 GtkMenuItem *witem = GTK_MENU_ITEM (w);
3181 GtkWidget *sub;
3183 if (cur->button_type != BUTTON_TYPE_NONE ||
3184 menu_separator_name_p (cur->name))
3185 break;
3187 xg_update_menu_item (cur, w, select_cb, highlight_cb, cl_data);
3189 sub = gtk_menu_item_get_submenu (witem);
3190 if (sub && ! cur->contents)
3192 /* Not a submenu anymore. */
3193 g_object_ref (G_OBJECT (sub));
3194 remove_submenu (witem);
3195 gtk_widget_destroy (sub);
3197 else if (cur->contents)
3199 GtkWidget *nsub;
3201 nsub = xg_update_submenu (sub, f, cur->contents,
3202 select_cb, deactivate_cb,
3203 highlight_cb, cl_data);
3205 /* If this item just became a submenu, we must set it. */
3206 if (nsub != sub)
3207 gtk_menu_item_set_submenu (witem, nsub);
3210 else
3212 /* Structural difference. Remove everything from here and down
3213 in SUBMENU. */
3214 break;
3218 /* Remove widgets from first structural change. */
3219 if (iter)
3221 /* If we are adding new menu items below, we must remove from
3222 first radio button so that radio groups become correct. */
3223 if (cur && first_radio) xg_destroy_widgets (first_radio);
3224 else xg_destroy_widgets (iter);
3227 if (cur)
3229 /* More items added. Create them. */
3230 newsub = create_menus (cur,
3232 select_cb,
3233 deactivate_cb,
3234 highlight_cb,
3237 ! has_tearoff_p,
3238 submenu,
3239 cl_data,
3243 if (list) g_list_free (list);
3245 return newsub;
3248 /* Update the MENUBAR.
3249 F is the frame the menu bar belongs to.
3250 VAL describes the contents of the menu bar.
3251 If DEEP_P is non-zero, rebuild all but the top level menu names in
3252 the MENUBAR. If DEEP_P is zero, just rebuild the names in the menubar.
3253 SELECT_CB is the callback to use when a menu item is selected.
3254 DEACTIVATE_CB is the callback to use when a sub menu is not shown anymore.
3255 HIGHLIGHT_CB is the callback to call when entering/leaving menu items. */
3257 void
3258 xg_modify_menubar_widgets (GtkWidget *menubar, FRAME_PTR f, widget_value *val,
3259 int deep_p,
3260 GCallback select_cb, GCallback deactivate_cb,
3261 GCallback highlight_cb)
3263 xg_menu_cb_data *cl_data;
3264 GList *list = gtk_container_get_children (GTK_CONTAINER (menubar));
3266 if (! list) return;
3268 cl_data = (xg_menu_cb_data*) g_object_get_data (G_OBJECT (menubar),
3269 XG_FRAME_DATA);
3271 xg_update_menubar (menubar, f, &list, list, 0, val->contents,
3272 select_cb, deactivate_cb, highlight_cb, cl_data);
3274 if (deep_p)
3276 widget_value *cur;
3278 /* Update all sub menus.
3279 We must keep the submenus (GTK menu item widgets) since the
3280 X Window in the XEvent that activates the menu are those widgets. */
3282 /* Update cl_data, menu_item things in F may have changed. */
3283 update_cl_data (cl_data, f, highlight_cb);
3285 for (cur = val->contents; cur; cur = cur->next)
3287 GList *iter;
3288 GtkWidget *sub = 0;
3289 GtkWidget *newsub;
3290 GtkMenuItem *witem = 0;
3292 /* Find sub menu that corresponds to val and update it. */
3293 for (iter = list ; iter; iter = g_list_next (iter))
3295 witem = GTK_MENU_ITEM (iter->data);
3296 if (xg_item_label_same_p (witem, cur->name))
3298 sub = gtk_menu_item_get_submenu (witem);
3299 break;
3303 newsub = xg_update_submenu (sub,
3305 cur->contents,
3306 select_cb,
3307 deactivate_cb,
3308 highlight_cb,
3309 cl_data);
3310 /* sub may still be NULL. If we just updated non deep and added
3311 a new menu bar item, it has no sub menu yet. So we set the
3312 newly created sub menu under witem. */
3313 if (newsub != sub && witem != 0)
3315 xg_set_screen (newsub, f);
3316 gtk_menu_item_set_submenu (witem, newsub);
3321 g_list_free (list);
3322 gtk_widget_show_all (menubar);
3325 /* Callback called when the menu bar W is mapped.
3326 Used to find the height of the menu bar if we didn't get it
3327 after showing the widget. */
3329 static void
3330 menubar_map_cb (GtkWidget *w, gpointer user_data)
3332 GtkRequisition req;
3333 FRAME_PTR f = (FRAME_PTR) user_data;
3334 gtk_widget_get_preferred_size (w, NULL, &req);
3335 if (FRAME_MENUBAR_HEIGHT (f) != req.height)
3337 FRAME_MENUBAR_HEIGHT (f) = req.height;
3338 xg_height_or_width_changed (f);
3342 /* Recompute all the widgets of frame F, when the menu bar has been
3343 changed. Value is non-zero if widgets were updated. */
3346 xg_update_frame_menubar (FRAME_PTR f)
3348 struct x_output *x = f->output_data.x;
3349 GtkRequisition req;
3351 if (!x->menubar_widget || gtk_widget_get_mapped (x->menubar_widget))
3352 return 0;
3354 if (x->menubar_widget && gtk_widget_get_parent (x->menubar_widget))
3355 return 0; /* Already done this, happens for frames created invisible. */
3357 BLOCK_INPUT;
3359 gtk_box_pack_start (GTK_BOX (x->vbox_widget), x->menubar_widget,
3360 FALSE, FALSE, 0);
3361 gtk_box_reorder_child (GTK_BOX (x->vbox_widget), x->menubar_widget, 0);
3363 g_signal_connect (x->menubar_widget, "map", G_CALLBACK (menubar_map_cb), f);
3364 gtk_widget_show_all (x->menubar_widget);
3365 gtk_widget_get_preferred_size (x->menubar_widget, NULL, &req);
3367 /* If menu bar doesn't know its height yet, cheat a little so the frame
3368 doesn't jump so much when resized later in menubar_map_cb. */
3369 if (req.height == 0)
3370 req.height = 23;
3372 if (FRAME_MENUBAR_HEIGHT (f) != req.height)
3374 FRAME_MENUBAR_HEIGHT (f) = req.height;
3375 xg_height_or_width_changed (f);
3377 UNBLOCK_INPUT;
3379 return 1;
3382 /* Get rid of the menu bar of frame F, and free its storage.
3383 This is used when deleting a frame, and when turning off the menu bar. */
3385 void
3386 free_frame_menubar (FRAME_PTR f)
3388 struct x_output *x = f->output_data.x;
3390 if (x->menubar_widget)
3392 BLOCK_INPUT;
3394 gtk_container_remove (GTK_CONTAINER (x->vbox_widget), x->menubar_widget);
3395 /* The menubar and its children shall be deleted when removed from
3396 the container. */
3397 x->menubar_widget = 0;
3398 FRAME_MENUBAR_HEIGHT (f) = 0;
3399 xg_height_or_width_changed (f);
3400 UNBLOCK_INPUT;
3405 xg_event_is_for_menubar (FRAME_PTR f, XEvent *event)
3407 struct x_output *x = f->output_data.x;
3408 GList *iter;
3409 GdkRectangle rec;
3410 GList *list;
3411 GdkDisplay *gdpy;
3412 GdkWindow *gw;
3413 GdkEvent gevent;
3414 GtkWidget *gwdesc;
3416 if (! x->menubar_widget) return 0;
3418 if (! (event->xbutton.x >= 0
3419 && event->xbutton.x < FRAME_PIXEL_WIDTH (f)
3420 && event->xbutton.y >= 0
3421 && event->xbutton.y < f->output_data.x->menubar_height
3422 && event->xbutton.same_screen))
3423 return 0;
3425 gdpy = gdk_x11_lookup_xdisplay (FRAME_X_DISPLAY (f));
3426 gw = gdk_x11_window_lookup_for_display (gdpy, event->xbutton.window);
3427 if (! gw) return 0;
3428 gevent.any.window = gw;
3429 gevent.any.type = GDK_NOTHING;
3430 gwdesc = gtk_get_event_widget (&gevent);
3431 if (! gwdesc) return 0;
3432 if (! GTK_IS_MENU_BAR (gwdesc)
3433 && ! GTK_IS_MENU_ITEM (gwdesc)
3434 && ! gtk_widget_is_ancestor (x->menubar_widget, gwdesc))
3435 return 0;
3437 list = gtk_container_get_children (GTK_CONTAINER (x->menubar_widget));
3438 if (! list) return 0;
3439 rec.x = event->xbutton.x;
3440 rec.y = event->xbutton.y;
3441 rec.width = 1;
3442 rec.height = 1;
3444 for (iter = list ; iter; iter = g_list_next (iter))
3446 GtkWidget *w = GTK_WIDGET (iter->data);
3447 if (gtk_widget_get_mapped (w) && gtk_widget_intersect (w, &rec, NULL))
3448 break;
3450 g_list_free (list);
3451 return iter == 0 ? 0 : 1;
3456 /***********************************************************************
3457 Scroll bar functions
3458 ***********************************************************************/
3461 /* Setting scroll bar values invokes the callback. Use this variable
3462 to indicate that callback should do nothing. */
3464 int xg_ignore_gtk_scrollbar;
3466 /* The width of the scroll bar for the current theme. */
3468 static int scroll_bar_width_for_theme;
3470 /* Xlib's `Window' fits in 32 bits. But we want to store pointers, and they
3471 may be larger than 32 bits. Keep a mapping from integer index to widget
3472 pointers to get around the 32 bit limitation. */
3474 static struct
3476 GtkWidget **widgets;
3477 ptrdiff_t max_size;
3478 ptrdiff_t used;
3479 } id_to_widget;
3481 /* Grow this much every time we need to allocate more */
3483 #define ID_TO_WIDGET_INCR 32
3485 /* Store the widget pointer W in id_to_widget and return the integer index. */
3487 static ptrdiff_t
3488 xg_store_widget_in_map (GtkWidget *w)
3490 ptrdiff_t i;
3492 if (id_to_widget.max_size == id_to_widget.used)
3494 ptrdiff_t new_size;
3495 if (TYPE_MAXIMUM (Window) - ID_TO_WIDGET_INCR < id_to_widget.max_size)
3496 memory_full (SIZE_MAX);
3498 new_size = id_to_widget.max_size + ID_TO_WIDGET_INCR;
3499 id_to_widget.widgets = xnrealloc (id_to_widget.widgets,
3500 new_size, sizeof (GtkWidget *));
3502 for (i = id_to_widget.max_size; i < new_size; ++i)
3503 id_to_widget.widgets[i] = 0;
3504 id_to_widget.max_size = new_size;
3507 /* Just loop over the array and find a free place. After all,
3508 how many scroll bars are we creating? Should be a small number.
3509 The check above guarantees we will find a free place. */
3510 for (i = 0; i < id_to_widget.max_size; ++i)
3512 if (! id_to_widget.widgets[i])
3514 id_to_widget.widgets[i] = w;
3515 ++id_to_widget.used;
3517 return i;
3521 /* Should never end up here */
3522 emacs_abort ();
3525 /* Remove pointer at IDX from id_to_widget.
3526 Called when scroll bar is destroyed. */
3528 static void
3529 xg_remove_widget_from_map (ptrdiff_t idx)
3531 if (idx < id_to_widget.max_size && id_to_widget.widgets[idx] != 0)
3533 id_to_widget.widgets[idx] = 0;
3534 --id_to_widget.used;
3538 /* Get the widget pointer at IDX from id_to_widget. */
3540 static GtkWidget *
3541 xg_get_widget_from_map (ptrdiff_t idx)
3543 if (idx < id_to_widget.max_size && id_to_widget.widgets[idx] != 0)
3544 return id_to_widget.widgets[idx];
3546 return 0;
3549 static void
3550 update_theme_scrollbar_width (void)
3552 #ifdef HAVE_GTK3
3553 GtkAdjustment *vadj;
3554 #else
3555 GtkObject *vadj;
3556 #endif
3557 GtkWidget *wscroll;
3558 int w = 0, b = 0;
3560 vadj = gtk_adjustment_new (XG_SB_MIN, XG_SB_MIN, XG_SB_MAX, 0.1, 0.1, 0.1);
3561 wscroll = gtk_scrollbar_new (GTK_ORIENTATION_VERTICAL, GTK_ADJUSTMENT (vadj));
3562 g_object_ref_sink (G_OBJECT (wscroll));
3563 gtk_widget_style_get (wscroll, "slider-width", &w, "trough-border", &b, NULL);
3564 gtk_widget_destroy (wscroll);
3565 g_object_unref (G_OBJECT (wscroll));
3566 w += 2*b;
3567 if (w < 16) w = 16;
3568 scroll_bar_width_for_theme = w;
3572 xg_get_default_scrollbar_width (void)
3574 return scroll_bar_width_for_theme;
3577 /* Return the scrollbar id for X Window WID on display DPY.
3578 Return -1 if WID not in id_to_widget. */
3580 ptrdiff_t
3581 xg_get_scroll_id_for_window (Display *dpy, Window wid)
3583 ptrdiff_t idx;
3584 GtkWidget *w;
3586 w = xg_win_to_widget (dpy, wid);
3588 if (w)
3590 for (idx = 0; idx < id_to_widget.max_size; ++idx)
3591 if (id_to_widget.widgets[idx] == w)
3592 return idx;
3595 return -1;
3598 /* Callback invoked when scroll bar WIDGET is destroyed.
3599 DATA is the index into id_to_widget for WIDGET.
3600 We free pointer to last scroll bar values here and remove the index. */
3602 static void
3603 xg_gtk_scroll_destroy (GtkWidget *widget, gpointer data)
3605 intptr_t id = (intptr_t) data;
3606 xg_remove_widget_from_map (id);
3609 /* Create a scroll bar widget for frame F. Store the scroll bar
3610 in BAR.
3611 SCROLL_CALLBACK is the callback to invoke when the value of the
3612 bar changes.
3613 END_CALLBACK is the callback to invoke when scrolling ends.
3614 SCROLL_BAR_NAME is the name we use for the scroll bar. Can be used
3615 to set resources for the widget. */
3617 void
3618 xg_create_scroll_bar (FRAME_PTR f,
3619 struct scroll_bar *bar,
3620 GCallback scroll_callback,
3621 GCallback end_callback,
3622 const char *scroll_bar_name)
3624 GtkWidget *wscroll;
3625 GtkWidget *webox;
3626 intptr_t scroll_id;
3627 #ifdef HAVE_GTK3
3628 GtkAdjustment *vadj;
3629 #else
3630 GtkObject *vadj;
3631 #endif
3633 /* Page, step increment values are not so important here, they
3634 will be corrected in x_set_toolkit_scroll_bar_thumb. */
3635 vadj = gtk_adjustment_new (XG_SB_MIN, XG_SB_MIN, XG_SB_MAX,
3636 0.1, 0.1, 0.1);
3638 wscroll = gtk_scrollbar_new (GTK_ORIENTATION_VERTICAL, GTK_ADJUSTMENT (vadj));
3639 webox = gtk_event_box_new ();
3640 gtk_widget_set_name (wscroll, scroll_bar_name);
3641 #ifndef HAVE_GTK3
3642 gtk_range_set_update_policy (GTK_RANGE (wscroll), GTK_UPDATE_CONTINUOUS);
3643 #endif
3644 g_object_set_data (G_OBJECT (wscroll), XG_FRAME_DATA, (gpointer)f);
3646 scroll_id = xg_store_widget_in_map (wscroll);
3648 g_signal_connect (G_OBJECT (wscroll),
3649 "destroy",
3650 G_CALLBACK (xg_gtk_scroll_destroy),
3651 (gpointer) scroll_id);
3652 g_signal_connect (G_OBJECT (wscroll),
3653 "change-value",
3654 scroll_callback,
3655 (gpointer) bar);
3656 g_signal_connect (G_OBJECT (wscroll),
3657 "button-release-event",
3658 end_callback,
3659 (gpointer) bar);
3661 /* The scroll bar widget does not draw on a window of its own. Instead
3662 it draws on the parent window, in this case the edit widget. So
3663 whenever the edit widget is cleared, the scroll bar needs to redraw
3664 also, which causes flicker. Put an event box between the edit widget
3665 and the scroll bar, so the scroll bar instead draws itself on the
3666 event box window. */
3667 gtk_fixed_put (GTK_FIXED (f->output_data.x->edit_widget), webox, -1, -1);
3668 gtk_container_add (GTK_CONTAINER (webox), wscroll);
3671 /* Set the cursor to an arrow. */
3672 xg_set_cursor (webox, FRAME_X_DISPLAY_INFO (f)->xg_cursor);
3674 bar->x_window = scroll_id;
3677 /* Remove the scroll bar represented by SCROLLBAR_ID from the frame F. */
3679 void
3680 xg_remove_scroll_bar (FRAME_PTR f, ptrdiff_t scrollbar_id)
3682 GtkWidget *w = xg_get_widget_from_map (scrollbar_id);
3683 if (w)
3685 GtkWidget *wparent = gtk_widget_get_parent (w);
3686 gtk_widget_destroy (w);
3687 gtk_widget_destroy (wparent);
3688 SET_FRAME_GARBAGED (f);
3692 /* Update the position of the vertical scroll bar represented by SCROLLBAR_ID
3693 in frame F.
3694 TOP/LEFT are the new pixel positions where the bar shall appear.
3695 WIDTH, HEIGHT is the size in pixels the bar shall have. */
3697 void
3698 xg_update_scrollbar_pos (FRAME_PTR f,
3699 ptrdiff_t scrollbar_id,
3700 int top,
3701 int left,
3702 int width,
3703 int height)
3706 GtkWidget *wscroll = xg_get_widget_from_map (scrollbar_id);
3708 if (wscroll)
3710 GtkWidget *wfixed = f->output_data.x->edit_widget;
3711 GtkWidget *wparent = gtk_widget_get_parent (wscroll);
3712 gint msl;
3714 /* Clear out old position. */
3715 int oldx = -1, oldy = -1, oldw, oldh;
3716 if (gtk_widget_get_parent (wparent) == wfixed)
3718 gtk_container_child_get (GTK_CONTAINER (wfixed), wparent,
3719 "x", &oldx, "y", &oldy, NULL);
3720 gtk_widget_get_size_request (wscroll, &oldw, &oldh);
3723 /* Move and resize to new values. */
3724 gtk_fixed_move (GTK_FIXED (wfixed), wparent, left, top);
3725 gtk_widget_style_get (wscroll, "min-slider-length", &msl, NULL);
3726 if (msl > height)
3728 /* No room. Hide scroll bar as some themes output a warning if
3729 the height is less than the min size. */
3730 gtk_widget_hide (wparent);
3731 gtk_widget_hide (wscroll);
3733 else
3735 gtk_widget_show_all (wparent);
3736 gtk_widget_set_size_request (wscroll, width, height);
3738 gtk_widget_queue_draw (wfixed);
3739 gdk_window_process_all_updates ();
3740 if (oldx != -1 && oldw > 0 && oldh > 0)
3742 /* Clear under old scroll bar position. This must be done after
3743 the gtk_widget_queue_draw and gdk_window_process_all_updates
3744 above. */
3745 x_clear_area (FRAME_X_DISPLAY (f),
3746 FRAME_X_WINDOW (f),
3747 oldx, oldy, oldw, oldh, 0);
3750 /* GTK does not redraw until the main loop is entered again, but
3751 if there are no X events pending we will not enter it. So we sync
3752 here to get some events. */
3754 x_sync (f);
3755 SET_FRAME_GARBAGED (f);
3756 cancel_mouse_face (f);
3760 /* Get the current value of the range, truncated to an integer. */
3762 static int
3763 int_gtk_range_get_value (GtkRange *range)
3765 return gtk_range_get_value (range);
3769 /* Set the thumb size and position of scroll bar BAR. We are currently
3770 displaying PORTION out of a whole WHOLE, and our position POSITION. */
3772 void
3773 xg_set_toolkit_scroll_bar_thumb (struct scroll_bar *bar,
3774 int portion,
3775 int position,
3776 int whole)
3778 GtkWidget *wscroll = xg_get_widget_from_map (bar->x_window);
3780 FRAME_PTR f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
3782 if (wscroll && NILP (bar->dragging))
3784 GtkAdjustment *adj;
3785 gdouble shown;
3786 gdouble top;
3787 int size, value;
3788 int old_size;
3789 int new_step;
3790 int changed = 0;
3792 adj = gtk_range_get_adjustment (GTK_RANGE (wscroll));
3794 /* We do the same as for MOTIF in xterm.c, assume 30 chars per line
3795 rather than the real portion value. This makes the thumb less likely
3796 to resize and that looks better. */
3797 portion = WINDOW_TOTAL_LINES (XWINDOW (bar->window)) * 30;
3798 /* When the thumb is at the bottom, position == whole.
3799 So we need to increase `whole' to make space for the thumb. */
3800 whole += portion;
3802 if (whole <= 0)
3803 top = 0, shown = 1;
3804 else
3806 top = (gdouble) position / whole;
3807 shown = (gdouble) portion / whole;
3810 size = shown * XG_SB_RANGE;
3811 size = min (size, XG_SB_RANGE);
3812 size = max (size, 1);
3814 value = top * XG_SB_RANGE;
3815 value = min (value, XG_SB_MAX - size);
3816 value = max (value, XG_SB_MIN);
3818 /* Assume all lines are of equal size. */
3819 new_step = size / max (1, FRAME_LINES (f));
3821 old_size = gtk_adjustment_get_page_size (adj);
3822 if (old_size != size)
3824 int old_step = gtk_adjustment_get_step_increment (adj);
3825 if (old_step != new_step)
3827 gtk_adjustment_set_page_size (adj, size);
3828 gtk_adjustment_set_step_increment (adj, new_step);
3829 /* Assume a page increment is about 95% of the page size */
3830 gtk_adjustment_set_page_increment (adj, size - size / 20);
3831 changed = 1;
3835 if (changed || int_gtk_range_get_value (GTK_RANGE (wscroll)) != value)
3837 BLOCK_INPUT;
3839 /* gtk_range_set_value invokes the callback. Set
3840 ignore_gtk_scrollbar to make the callback do nothing */
3841 xg_ignore_gtk_scrollbar = 1;
3843 if (int_gtk_range_get_value (GTK_RANGE (wscroll)) != value)
3844 gtk_range_set_value (GTK_RANGE (wscroll), (gdouble)value);
3845 else if (changed)
3846 gtk_adjustment_changed (adj);
3848 xg_ignore_gtk_scrollbar = 0;
3850 UNBLOCK_INPUT;
3855 /* Return non-zero if EVENT is for a scroll bar in frame F.
3856 When the same X window is used for several Gtk+ widgets, we cannot
3857 say for sure based on the X window alone if an event is for the
3858 frame. This function does additional checks.
3860 Return non-zero if the event is for a scroll bar, zero otherwise. */
3863 xg_event_is_for_scrollbar (FRAME_PTR f, XEvent *event)
3865 int retval = 0;
3867 if (f && event->type == ButtonPress && event->xbutton.button < 4)
3869 /* Check if press occurred outside the edit widget. */
3870 GdkDisplay *gdpy = gdk_x11_lookup_xdisplay (FRAME_X_DISPLAY (f));
3871 GdkWindow *gwin;
3872 #ifdef HAVE_GTK3
3873 GdkDevice *gdev = gdk_device_manager_get_client_pointer
3874 (gdk_display_get_device_manager (gdpy));
3875 gwin = gdk_device_get_window_at_position (gdev, NULL, NULL);
3876 #else
3877 gwin = gdk_display_get_window_at_pointer (gdpy, NULL, NULL);
3878 #endif
3879 retval = gwin != gtk_widget_get_window (f->output_data.x->edit_widget);
3881 else if (f
3882 && ((event->type == ButtonRelease && event->xbutton.button < 4)
3883 || event->type == MotionNotify))
3885 /* If we are releasing or moving the scroll bar, it has the grab. */
3886 GtkWidget *w = gtk_grab_get_current ();
3887 retval = w != 0 && GTK_IS_SCROLLBAR (w);
3890 return retval;
3895 /***********************************************************************
3896 Tool bar functions
3897 ***********************************************************************/
3898 /* The key for the data we put in the GtkImage widgets. The data is
3899 the image used by Emacs. We use this to see if we need to update
3900 the GtkImage with a new image. */
3901 #define XG_TOOL_BAR_IMAGE_DATA "emacs-tool-bar-image"
3903 /* The key for storing the latest modifiers so the activate callback can
3904 get them. */
3905 #define XG_TOOL_BAR_LAST_MODIFIER "emacs-tool-bar-modifier"
3907 /* The key for storing the button widget in its proxy menu item. */
3908 #define XG_TOOL_BAR_PROXY_BUTTON "emacs-tool-bar-proxy-button"
3910 /* The key for the data we put in the GtkImage widgets. The data is
3911 the stock name used by Emacs. We use this to see if we need to update
3912 the GtkImage with a new image. */
3913 #define XG_TOOL_BAR_STOCK_NAME "emacs-tool-bar-stock-name"
3915 /* As above, but this is used for named theme widgets, as opposed to
3916 stock items. */
3917 #define XG_TOOL_BAR_ICON_NAME "emacs-tool-bar-icon-name"
3919 /* Callback function invoked when a tool bar item is pressed.
3920 W is the button widget in the tool bar that got pressed,
3921 CLIENT_DATA is an integer that is the index of the button in the
3922 tool bar. 0 is the first button. */
3924 static gboolean
3925 xg_tool_bar_button_cb (GtkWidget *widget,
3926 GdkEventButton *event,
3927 gpointer user_data)
3929 intptr_t state = event->state;
3930 gpointer ptr = (gpointer) state;
3931 g_object_set_data (G_OBJECT (widget), XG_TOOL_BAR_LAST_MODIFIER, ptr);
3932 return FALSE;
3936 /* Callback function invoked when a tool bar item is pressed.
3937 W is the button widget in the tool bar that got pressed,
3938 CLIENT_DATA is an integer that is the index of the button in the
3939 tool bar. 0 is the first button. */
3941 static void
3942 xg_tool_bar_callback (GtkWidget *w, gpointer client_data)
3944 intptr_t idx = (intptr_t) client_data;
3945 gpointer gmod = g_object_get_data (G_OBJECT (w), XG_TOOL_BAR_LAST_MODIFIER);
3946 intptr_t mod = (intptr_t) gmod;
3948 FRAME_PTR f = (FRAME_PTR) g_object_get_data (G_OBJECT (w), XG_FRAME_DATA);
3949 Lisp_Object key, frame;
3950 struct input_event event;
3951 EVENT_INIT (event);
3953 if (! f || ! f->n_tool_bar_items || NILP (f->tool_bar_items))
3954 return;
3956 idx *= TOOL_BAR_ITEM_NSLOTS;
3958 key = AREF (f->tool_bar_items, idx + TOOL_BAR_ITEM_KEY);
3959 XSETFRAME (frame, f);
3961 /* We generate two events here. The first one is to set the prefix
3962 to `(tool_bar)', see keyboard.c. */
3963 event.kind = TOOL_BAR_EVENT;
3964 event.frame_or_window = frame;
3965 event.arg = frame;
3966 kbd_buffer_store_event (&event);
3968 event.kind = TOOL_BAR_EVENT;
3969 event.frame_or_window = frame;
3970 event.arg = key;
3971 /* Convert between the modifier bits GDK uses and the modifier bits
3972 Emacs uses. This assumes GDK and X masks are the same, which they are when
3973 this is written. */
3974 event.modifiers = x_x_to_emacs_modifiers (FRAME_X_DISPLAY_INFO (f), mod);
3975 kbd_buffer_store_event (&event);
3977 /* Return focus to the frame after we have clicked on a detached
3978 tool bar button. */
3979 Fx_focus_frame (frame);
3982 /* Callback function invoked when a tool bar item is pressed in a detached
3983 tool bar or the overflow drop down menu.
3984 We just call xg_tool_bar_callback.
3985 W is the menu item widget that got pressed,
3986 CLIENT_DATA is an integer that is the index of the button in the
3987 tool bar. 0 is the first button. */
3989 static void
3990 xg_tool_bar_proxy_callback (GtkWidget *w, gpointer client_data)
3992 GtkWidget *wbutton = GTK_WIDGET (g_object_get_data (G_OBJECT (w),
3993 XG_TOOL_BAR_PROXY_BUTTON));
3994 xg_tool_bar_callback (wbutton, client_data);
3998 static gboolean
3999 xg_tool_bar_help_callback (GtkWidget *w,
4000 GdkEventCrossing *event,
4001 gpointer client_data);
4003 /* This callback is called when a help is to be shown for an item in
4004 the detached tool bar when the detached tool bar it is not expanded. */
4006 static gboolean
4007 xg_tool_bar_proxy_help_callback (GtkWidget *w,
4008 GdkEventCrossing *event,
4009 gpointer client_data)
4011 GtkWidget *wbutton = GTK_WIDGET (g_object_get_data (G_OBJECT (w),
4012 XG_TOOL_BAR_PROXY_BUTTON));
4014 return xg_tool_bar_help_callback (wbutton, event, client_data);
4017 static GtkWidget *
4018 xg_get_tool_bar_widgets (GtkWidget *vb, GtkWidget **wimage)
4020 GList *clist = gtk_container_get_children (GTK_CONTAINER (vb));
4021 GtkWidget *c1 = (GtkWidget *) clist->data;
4022 GtkWidget *c2 = clist->next ? (GtkWidget *) clist->next->data : NULL;
4024 *wimage = GTK_IS_IMAGE (c1) ? c1 : c2;
4025 g_list_free (clist);
4026 return GTK_IS_LABEL (c1) ? c1 : c2;
4030 /* This callback is called when a tool item should create a proxy item,
4031 such as for the overflow menu. Also called when the tool bar is detached.
4032 If we don't create a proxy menu item, the detached tool bar will be
4033 blank. */
4035 static gboolean
4036 xg_tool_bar_menu_proxy (GtkToolItem *toolitem, gpointer user_data)
4038 GtkButton *wbutton = GTK_BUTTON (XG_BIN_CHILD (XG_BIN_CHILD (toolitem)));
4039 GtkWidget *vb = XG_BIN_CHILD (wbutton);
4040 GtkWidget *c1;
4041 GtkLabel *wlbl = GTK_LABEL (xg_get_tool_bar_widgets (vb, &c1));
4042 GtkImage *wimage = GTK_IMAGE (c1);
4043 GtkWidget *wmenuitem = gtk_image_menu_item_new_with_label
4044 (wlbl ? gtk_label_get_text (wlbl) : "");
4045 GtkWidget *wmenuimage;
4048 if (gtk_button_get_use_stock (wbutton))
4049 wmenuimage = gtk_image_new_from_stock (gtk_button_get_label (wbutton),
4050 GTK_ICON_SIZE_MENU);
4051 else
4053 GtkSettings *settings = gtk_widget_get_settings (GTK_WIDGET (wbutton));
4054 GtkImageType store_type = gtk_image_get_storage_type (wimage);
4056 g_object_set (G_OBJECT (settings), "gtk-menu-images", TRUE, NULL);
4058 if (store_type == GTK_IMAGE_STOCK)
4060 gchar *stock_id;
4061 gtk_image_get_stock (wimage, &stock_id, NULL);
4062 wmenuimage = gtk_image_new_from_stock (stock_id, GTK_ICON_SIZE_MENU);
4064 else if (store_type == GTK_IMAGE_ICON_SET)
4066 GtkIconSet *icon_set;
4067 gtk_image_get_icon_set (wimage, &icon_set, NULL);
4068 wmenuimage = gtk_image_new_from_icon_set (icon_set,
4069 GTK_ICON_SIZE_MENU);
4071 else if (store_type == GTK_IMAGE_PIXBUF)
4073 gint width, height;
4075 if (settings &&
4076 gtk_icon_size_lookup_for_settings (settings, GTK_ICON_SIZE_MENU,
4077 &width, &height))
4079 GdkPixbuf *src_pixbuf, *dest_pixbuf;
4081 src_pixbuf = gtk_image_get_pixbuf (wimage);
4082 dest_pixbuf = gdk_pixbuf_scale_simple (src_pixbuf, width, height,
4083 GDK_INTERP_BILINEAR);
4085 wmenuimage = gtk_image_new_from_pixbuf (dest_pixbuf);
4087 else
4089 fprintf (stderr, "internal error: GTK_IMAGE_PIXBUF failed\n");
4090 emacs_abort ();
4093 else if (store_type == GTK_IMAGE_ICON_NAME)
4095 const gchar *icon_name;
4096 GtkIconSize icon_size;
4098 gtk_image_get_icon_name (wimage, &icon_name, &icon_size);
4099 wmenuimage = gtk_image_new_from_icon_name (icon_name,
4100 GTK_ICON_SIZE_MENU);
4102 else
4104 fprintf (stderr, "internal error: store_type is %d\n", store_type);
4105 emacs_abort ();
4108 if (wmenuimage)
4109 gtk_image_menu_item_set_image (GTK_IMAGE_MENU_ITEM (wmenuitem), wmenuimage);
4111 g_signal_connect (G_OBJECT (wmenuitem),
4112 "activate",
4113 G_CALLBACK (xg_tool_bar_proxy_callback),
4114 user_data);
4117 g_object_set_data (G_OBJECT (wmenuitem), XG_TOOL_BAR_PROXY_BUTTON,
4118 (gpointer) wbutton);
4119 gtk_tool_item_set_proxy_menu_item (toolitem, "Emacs toolbar item", wmenuitem);
4120 gtk_widget_set_sensitive (wmenuitem,
4121 gtk_widget_get_sensitive (GTK_WIDGET (wbutton)));
4123 /* Use enter/leave notify to show help. We use the events
4124 rather than the GtkButton specific signals "enter" and
4125 "leave", so we can have only one callback. The event
4126 will tell us what kind of event it is. */
4127 g_signal_connect (G_OBJECT (wmenuitem),
4128 "enter-notify-event",
4129 G_CALLBACK (xg_tool_bar_proxy_help_callback),
4130 user_data);
4131 g_signal_connect (G_OBJECT (wmenuitem),
4132 "leave-notify-event",
4133 G_CALLBACK (xg_tool_bar_proxy_help_callback),
4134 user_data);
4136 return TRUE;
4139 /* This callback is called when a tool bar is detached. We must set
4140 the height of the tool bar to zero when this happens so frame sizes
4141 are correctly calculated.
4142 WBOX is the handle box widget that enables detach/attach of the tool bar.
4143 W is the tool bar widget.
4144 CLIENT_DATA is a pointer to the frame the tool bar belongs to. */
4146 static void
4147 xg_tool_bar_detach_callback (GtkHandleBox *wbox,
4148 GtkWidget *w,
4149 gpointer client_data)
4151 FRAME_PTR f = (FRAME_PTR) client_data;
4153 g_object_set (G_OBJECT (w), "show-arrow", !x_gtk_whole_detached_tool_bar,
4154 NULL);
4156 if (f)
4158 GtkRequisition req, req2;
4159 FRAME_X_OUTPUT (f)->toolbar_detached = 1;
4160 gtk_widget_get_preferred_size (GTK_WIDGET (wbox), NULL, &req);
4161 gtk_widget_get_preferred_size (w, NULL, &req2);
4162 req.width -= req2.width;
4163 req.height -= req2.height;
4164 if (FRAME_TOOLBAR_TOP_HEIGHT (f) != 0)
4165 FRAME_TOOLBAR_TOP_HEIGHT (f) = req.height;
4166 else if (FRAME_TOOLBAR_BOTTOM_HEIGHT (f) != 0)
4167 FRAME_TOOLBAR_BOTTOM_HEIGHT (f) = req.height;
4168 else if (FRAME_TOOLBAR_RIGHT_WIDTH (f) != 0)
4169 FRAME_TOOLBAR_RIGHT_WIDTH (f) = req.width;
4170 else if (FRAME_TOOLBAR_LEFT_WIDTH (f) != 0)
4171 FRAME_TOOLBAR_LEFT_WIDTH (f) = req.width;
4172 xg_height_or_width_changed (f);
4176 /* This callback is called when a tool bar is reattached. We must set
4177 the height of the tool bar when this happens so frame sizes
4178 are correctly calculated.
4179 WBOX is the handle box widget that enables detach/attach of the tool bar.
4180 W is the tool bar widget.
4181 CLIENT_DATA is a pointer to the frame the tool bar belongs to. */
4183 static void
4184 xg_tool_bar_attach_callback (GtkHandleBox *wbox,
4185 GtkWidget *w,
4186 gpointer client_data)
4188 FRAME_PTR f = (FRAME_PTR) client_data;
4189 g_object_set (G_OBJECT (w), "show-arrow", TRUE, NULL);
4191 if (f)
4193 GtkRequisition req, req2;
4194 FRAME_X_OUTPUT (f)->toolbar_detached = 0;
4195 gtk_widget_get_preferred_size (GTK_WIDGET (wbox), NULL, &req);
4196 gtk_widget_get_preferred_size (w, NULL, &req2);
4197 req.width += req2.width;
4198 req.height += req2.height;
4199 if (FRAME_TOOLBAR_TOP_HEIGHT (f) != 0)
4200 FRAME_TOOLBAR_TOP_HEIGHT (f) = req.height;
4201 else if (FRAME_TOOLBAR_BOTTOM_HEIGHT (f) != 0)
4202 FRAME_TOOLBAR_BOTTOM_HEIGHT (f) = req.height;
4203 else if (FRAME_TOOLBAR_RIGHT_WIDTH (f) != 0)
4204 FRAME_TOOLBAR_RIGHT_WIDTH (f) = req.width;
4205 else if (FRAME_TOOLBAR_LEFT_WIDTH (f) != 0)
4206 FRAME_TOOLBAR_LEFT_WIDTH (f) = req.width;
4207 xg_height_or_width_changed (f);
4211 /* This callback is called when the mouse enters or leaves a tool bar item.
4212 It is used for displaying and hiding the help text.
4213 W is the tool bar item, a button.
4214 EVENT is either an enter event or leave event.
4215 CLIENT_DATA is an integer that is the index of the button in the
4216 tool bar. 0 is the first button.
4218 Returns FALSE to tell GTK to keep processing this event. */
4220 static gboolean
4221 xg_tool_bar_help_callback (GtkWidget *w,
4222 GdkEventCrossing *event,
4223 gpointer client_data)
4225 intptr_t idx = (intptr_t) client_data;
4226 FRAME_PTR f = (FRAME_PTR) g_object_get_data (G_OBJECT (w), XG_FRAME_DATA);
4227 Lisp_Object help, frame;
4229 if (! f || ! f->n_tool_bar_items || NILP (f->tool_bar_items))
4230 return FALSE;
4232 if (event->type == GDK_ENTER_NOTIFY)
4234 idx *= TOOL_BAR_ITEM_NSLOTS;
4235 help = AREF (f->tool_bar_items, idx + TOOL_BAR_ITEM_HELP);
4237 if (NILP (help))
4238 help = AREF (f->tool_bar_items, idx + TOOL_BAR_ITEM_CAPTION);
4240 else
4241 help = Qnil;
4243 XSETFRAME (frame, f);
4244 kbd_buffer_store_help_event (frame, help);
4246 return FALSE;
4250 /* This callback is called when a tool bar item shall be redrawn.
4251 It modifies the expose event so that the GtkImage widget redraws the
4252 whole image. This to overcome a bug that makes GtkImage draw the image
4253 in the wrong place when it tries to redraw just a part of the image.
4254 W is the GtkImage to be redrawn.
4255 EVENT is the expose event for W.
4256 CLIENT_DATA is unused.
4258 Returns FALSE to tell GTK to keep processing this event. */
4260 #ifndef HAVE_GTK3
4261 static gboolean
4262 xg_tool_bar_item_expose_callback (GtkWidget *w,
4263 GdkEventExpose *event,
4264 gpointer client_data)
4266 gint width, height;
4268 gdk_drawable_get_size (event->window, &width, &height);
4269 event->area.x -= width > event->area.width ? width-event->area.width : 0;
4270 event->area.y -= height > event->area.height ? height-event->area.height : 0;
4272 event->area.x = max (0, event->area.x);
4273 event->area.y = max (0, event->area.y);
4275 event->area.width = max (width, event->area.width);
4276 event->area.height = max (height, event->area.height);
4278 return FALSE;
4280 #endif
4282 #ifdef HAVE_GTK_ORIENTABLE_SET_ORIENTATION
4283 #define toolbar_set_orientation(w, o) \
4284 gtk_orientable_set_orientation (GTK_ORIENTABLE (w), o)
4285 #else
4286 #define toolbar_set_orientation(w, o) \
4287 gtk_toolbar_set_orientation (GTK_TOOLBAR (w), o)
4288 #endif
4290 /* Attach a tool bar to frame F. */
4292 static void
4293 xg_pack_tool_bar (FRAME_PTR f, Lisp_Object pos)
4295 struct x_output *x = f->output_data.x;
4296 int into_hbox = EQ (pos, Qleft) || EQ (pos, Qright);
4298 toolbar_set_orientation (x->toolbar_widget,
4299 into_hbox
4300 ? GTK_ORIENTATION_VERTICAL
4301 : GTK_ORIENTATION_HORIZONTAL);
4302 if (!x->handlebox_widget)
4304 x->handlebox_widget = gtk_handle_box_new ();
4305 g_signal_connect (G_OBJECT (x->handlebox_widget), "child-detached",
4306 G_CALLBACK (xg_tool_bar_detach_callback), f);
4307 g_signal_connect (G_OBJECT (x->handlebox_widget), "child-attached",
4308 G_CALLBACK (xg_tool_bar_attach_callback), f);
4309 gtk_container_add (GTK_CONTAINER (x->handlebox_widget),
4310 x->toolbar_widget);
4313 if (into_hbox)
4315 gtk_handle_box_set_handle_position (GTK_HANDLE_BOX (x->handlebox_widget),
4316 GTK_POS_TOP);
4317 gtk_box_pack_start (GTK_BOX (x->hbox_widget), x->handlebox_widget,
4318 FALSE, FALSE, 0);
4320 if (EQ (pos, Qleft))
4321 gtk_box_reorder_child (GTK_BOX (x->hbox_widget),
4322 x->handlebox_widget,
4324 x->toolbar_in_hbox = 1;
4326 else
4328 int vbox_pos = x->menubar_widget ? 1 : 0;
4329 gtk_handle_box_set_handle_position (GTK_HANDLE_BOX (x->handlebox_widget),
4330 GTK_POS_LEFT);
4331 gtk_box_pack_start (GTK_BOX (x->vbox_widget), x->handlebox_widget,
4332 FALSE, FALSE, 0);
4334 if (EQ (pos, Qtop))
4335 gtk_box_reorder_child (GTK_BOX (x->vbox_widget),
4336 x->handlebox_widget,
4337 vbox_pos);
4338 x->toolbar_in_hbox = 0;
4342 /* Create a tool bar for frame F. */
4344 static void
4345 xg_create_tool_bar (FRAME_PTR f)
4347 struct x_output *x = f->output_data.x;
4348 #if GTK_CHECK_VERSION (3, 3, 6)
4349 GtkStyleContext *gsty;
4350 #endif
4351 struct xg_frame_tb_info *tbinfo
4352 = g_object_get_data (G_OBJECT (FRAME_GTK_OUTER_WIDGET (f)),
4353 TB_INFO_KEY);
4354 if (! tbinfo)
4356 tbinfo = xmalloc (sizeof (*tbinfo));
4357 tbinfo->last_tool_bar = Qnil;
4358 tbinfo->style = Qnil;
4359 tbinfo->hmargin = tbinfo->vmargin = 0;
4360 tbinfo->dir = GTK_TEXT_DIR_NONE;
4361 tbinfo->n_last_items = 0;
4362 g_object_set_data (G_OBJECT (FRAME_GTK_OUTER_WIDGET (f)),
4363 TB_INFO_KEY,
4364 tbinfo);
4367 x->toolbar_widget = gtk_toolbar_new ();
4368 x->toolbar_detached = 0;
4370 gtk_widget_set_name (x->toolbar_widget, "emacs-toolbar");
4372 gtk_toolbar_set_style (GTK_TOOLBAR (x->toolbar_widget), GTK_TOOLBAR_ICONS);
4373 toolbar_set_orientation (x->toolbar_widget, GTK_ORIENTATION_HORIZONTAL);
4374 #if GTK_CHECK_VERSION (3, 3, 6)
4375 gsty = gtk_widget_get_style_context (x->toolbar_widget);
4376 gtk_style_context_add_class (gsty, "primary-toolbar");
4377 #endif
4381 #define PROP(IDX) AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
4383 /* Find the right-to-left image named by RTL in the tool bar images for F.
4384 Returns IMAGE if RTL is not found. */
4386 static Lisp_Object
4387 find_rtl_image (FRAME_PTR f, Lisp_Object image, Lisp_Object rtl)
4389 int i;
4390 Lisp_Object file, rtl_name;
4391 struct gcpro gcpro1, gcpro2;
4392 GCPRO2 (file, rtl_name);
4394 rtl_name = Ffile_name_nondirectory (rtl);
4396 for (i = 0; i < f->n_tool_bar_items; ++i)
4398 Lisp_Object rtl_image = PROP (TOOL_BAR_ITEM_IMAGES);
4399 if (!NILP (file = file_for_image (rtl_image)))
4401 file = call1 (intern ("file-name-sans-extension"),
4402 Ffile_name_nondirectory (file));
4403 if (! NILP (Fequal (file, rtl_name)))
4405 image = rtl_image;
4406 break;
4411 return image;
4414 static GtkToolItem *
4415 xg_make_tool_item (FRAME_PTR f,
4416 GtkWidget *wimage,
4417 GtkWidget **wbutton,
4418 const char *label,
4419 int i, int horiz, int text_image)
4421 GtkToolItem *ti = gtk_tool_item_new ();
4422 GtkWidget *vb = gtk_box_new (horiz
4423 ? GTK_ORIENTATION_HORIZONTAL
4424 : GTK_ORIENTATION_VERTICAL,
4426 GtkWidget *wb = gtk_button_new ();
4427 /* The eventbox is here so we can have tooltips on disabled items. */
4428 GtkWidget *weventbox = gtk_event_box_new ();
4429 #if GTK_CHECK_VERSION (3, 3, 6)
4430 GtkCssProvider *css_prov = gtk_css_provider_new ();
4431 GtkStyleContext *gsty;
4433 gtk_css_provider_load_from_data (css_prov,
4434 "GtkEventBox {"
4435 " background-color: transparent;"
4436 "}",
4437 -1, NULL);
4439 gsty = gtk_widget_get_style_context (weventbox);
4440 gtk_style_context_add_provider (gsty,
4441 GTK_STYLE_PROVIDER (css_prov),
4442 GTK_STYLE_PROVIDER_PRIORITY_USER);
4443 g_object_unref (css_prov);
4444 #endif
4446 gtk_box_set_homogeneous (GTK_BOX (vb), FALSE);
4448 if (wimage && !text_image)
4449 gtk_box_pack_start (GTK_BOX (vb), wimage, TRUE, TRUE, 0);
4450 if (label)
4451 gtk_box_pack_start (GTK_BOX (vb), gtk_label_new (label), TRUE, TRUE, 0);
4452 if (wimage && text_image)
4453 gtk_box_pack_start (GTK_BOX (vb), wimage, TRUE, TRUE, 0);
4455 gtk_button_set_focus_on_click (GTK_BUTTON (wb), FALSE);
4456 gtk_button_set_relief (GTK_BUTTON (wb), GTK_RELIEF_NONE);
4457 gtk_container_add (GTK_CONTAINER (wb), vb);
4458 gtk_container_add (GTK_CONTAINER (weventbox), wb);
4459 gtk_container_add (GTK_CONTAINER (ti), weventbox);
4461 if (wimage || label)
4463 intptr_t ii = i;
4464 gpointer gi = (gpointer) ii;
4466 g_signal_connect (G_OBJECT (ti), "create-menu-proxy",
4467 G_CALLBACK (xg_tool_bar_menu_proxy),
4468 gi);
4470 g_signal_connect (G_OBJECT (wb), "clicked",
4471 G_CALLBACK (xg_tool_bar_callback),
4472 gi);
4474 g_object_set_data (G_OBJECT (weventbox), XG_FRAME_DATA, (gpointer)f);
4476 #ifndef HAVE_GTK3
4477 /* Catch expose events to overcome an annoying redraw bug, see
4478 comment for xg_tool_bar_item_expose_callback. */
4479 g_signal_connect (G_OBJECT (ti),
4480 "expose-event",
4481 G_CALLBACK (xg_tool_bar_item_expose_callback),
4483 #endif
4484 gtk_tool_item_set_homogeneous (ti, FALSE);
4486 /* Callback to save modifier mask (Shift/Control, etc). GTK makes
4487 no distinction based on modifiers in the activate callback,
4488 so we have to do it ourselves. */
4489 g_signal_connect (wb, "button-release-event",
4490 G_CALLBACK (xg_tool_bar_button_cb),
4491 NULL);
4493 g_object_set_data (G_OBJECT (wb), XG_FRAME_DATA, (gpointer)f);
4495 /* Use enter/leave notify to show help. We use the events
4496 rather than the GtkButton specific signals "enter" and
4497 "leave", so we can have only one callback. The event
4498 will tell us what kind of event it is. */
4499 g_signal_connect (G_OBJECT (weventbox),
4500 "enter-notify-event",
4501 G_CALLBACK (xg_tool_bar_help_callback),
4502 gi);
4503 g_signal_connect (G_OBJECT (weventbox),
4504 "leave-notify-event",
4505 G_CALLBACK (xg_tool_bar_help_callback),
4506 gi);
4509 if (wbutton) *wbutton = wb;
4511 return ti;
4514 static int
4515 is_box_type (GtkWidget *vb, int is_horizontal)
4517 #ifdef HAVE_GTK3
4518 int ret = 0;
4519 if (GTK_IS_BOX (vb))
4521 GtkOrientation ori = gtk_orientable_get_orientation (GTK_ORIENTABLE (vb));
4522 ret = (ori == GTK_ORIENTATION_HORIZONTAL && is_horizontal)
4523 || (ori == GTK_ORIENTATION_VERTICAL && ! is_horizontal);
4525 return ret;
4526 #else
4527 return is_horizontal ? GTK_IS_VBOX (vb) : GTK_IS_HBOX (vb);
4528 #endif
4532 static int
4533 xg_tool_item_stale_p (GtkWidget *wbutton, const char *stock_name,
4534 const char *icon_name, const struct image *img,
4535 const char *label, int horiz)
4537 gpointer old;
4538 GtkWidget *wimage;
4539 GtkWidget *vb = XG_BIN_CHILD (wbutton);
4540 GtkWidget *wlbl = xg_get_tool_bar_widgets (vb, &wimage);
4542 /* Check if the tool icon matches. */
4543 if (stock_name && wimage)
4545 old = g_object_get_data (G_OBJECT (wimage),
4546 XG_TOOL_BAR_STOCK_NAME);
4547 if (!old || strcmp (old, stock_name))
4548 return 1;
4550 else if (icon_name && wimage)
4552 old = g_object_get_data (G_OBJECT (wimage),
4553 XG_TOOL_BAR_ICON_NAME);
4554 if (!old || strcmp (old, icon_name))
4555 return 1;
4557 else if (wimage)
4559 gpointer gold_img = g_object_get_data (G_OBJECT (wimage),
4560 XG_TOOL_BAR_IMAGE_DATA);
4561 Pixmap old_img = (Pixmap) gold_img;
4562 if (old_img != img->pixmap)
4563 return 1;
4566 /* Check button configuration and label. */
4567 if (is_box_type (vb, horiz)
4568 || (label ? (wlbl == NULL) : (wlbl != NULL)))
4569 return 1;
4571 /* Ensure label is correct. */
4572 if (label && wlbl)
4573 gtk_label_set_text (GTK_LABEL (wlbl), label);
4574 return 0;
4577 static int
4578 xg_update_tool_bar_sizes (FRAME_PTR f)
4580 struct x_output *x = f->output_data.x;
4581 GtkRequisition req;
4582 int nl = 0, nr = 0, nt = 0, nb = 0;
4584 gtk_widget_get_preferred_size (GTK_WIDGET (x->handlebox_widget), NULL, &req);
4585 if (x->toolbar_in_hbox)
4587 int pos;
4588 gtk_container_child_get (GTK_CONTAINER (x->hbox_widget),
4589 x->handlebox_widget,
4590 "position", &pos, NULL);
4591 if (pos == 0) nl = req.width;
4592 else nr = req.width;
4594 else
4596 int pos;
4597 gtk_container_child_get (GTK_CONTAINER (x->vbox_widget),
4598 x->handlebox_widget,
4599 "position", &pos, NULL);
4600 if (pos == 0 || (pos == 1 && x->menubar_widget)) nt = req.height;
4601 else nb = req.height;
4604 if (nl != FRAME_TOOLBAR_LEFT_WIDTH (f)
4605 || nr != FRAME_TOOLBAR_RIGHT_WIDTH (f)
4606 || nt != FRAME_TOOLBAR_TOP_HEIGHT (f)
4607 || nb != FRAME_TOOLBAR_BOTTOM_HEIGHT (f))
4609 FRAME_TOOLBAR_RIGHT_WIDTH (f) = FRAME_TOOLBAR_LEFT_WIDTH (f)
4610 = FRAME_TOOLBAR_TOP_HEIGHT (f) = FRAME_TOOLBAR_BOTTOM_HEIGHT (f) = 0;
4611 FRAME_TOOLBAR_LEFT_WIDTH (f) = nl;
4612 FRAME_TOOLBAR_RIGHT_WIDTH (f) = nr;
4613 FRAME_TOOLBAR_TOP_HEIGHT (f) = nt;
4614 FRAME_TOOLBAR_BOTTOM_HEIGHT (f) = nb;
4615 return 1;
4618 return 0;
4622 /* Update the tool bar for frame F. Add new buttons and remove old. */
4624 void
4625 update_frame_tool_bar (FRAME_PTR f)
4627 int i, j;
4628 struct x_output *x = f->output_data.x;
4629 int hmargin = 0, vmargin = 0;
4630 GtkToolbar *wtoolbar;
4631 GtkToolItem *ti;
4632 GtkTextDirection dir;
4633 int pack_tool_bar = x->handlebox_widget == NULL;
4634 Lisp_Object style;
4635 int text_image, horiz;
4636 struct xg_frame_tb_info *tbinfo;
4638 if (! FRAME_GTK_WIDGET (f))
4639 return;
4641 BLOCK_INPUT;
4643 if (RANGED_INTEGERP (1, Vtool_bar_button_margin, INT_MAX))
4645 hmargin = XFASTINT (Vtool_bar_button_margin);
4646 vmargin = XFASTINT (Vtool_bar_button_margin);
4648 else if (CONSP (Vtool_bar_button_margin))
4650 if (RANGED_INTEGERP (1, XCAR (Vtool_bar_button_margin), INT_MAX))
4651 hmargin = XFASTINT (XCAR (Vtool_bar_button_margin));
4653 if (RANGED_INTEGERP (1, XCDR (Vtool_bar_button_margin), INT_MAX))
4654 vmargin = XFASTINT (XCDR (Vtool_bar_button_margin));
4657 /* The natural size (i.e. when GTK uses 0 as margin) looks best,
4658 so take DEFAULT_TOOL_BAR_BUTTON_MARGIN to mean "default for GTK",
4659 i.e. zero. This means that margins less than
4660 DEFAULT_TOOL_BAR_BUTTON_MARGIN has no effect. */
4661 hmargin = max (0, hmargin - DEFAULT_TOOL_BAR_BUTTON_MARGIN);
4662 vmargin = max (0, vmargin - DEFAULT_TOOL_BAR_BUTTON_MARGIN);
4664 if (! x->toolbar_widget)
4665 xg_create_tool_bar (f);
4667 wtoolbar = GTK_TOOLBAR (x->toolbar_widget);
4668 dir = gtk_widget_get_direction (GTK_WIDGET (wtoolbar));
4670 style = Ftool_bar_get_system_style ();
4672 /* Are we up to date? */
4673 tbinfo = g_object_get_data (G_OBJECT (FRAME_GTK_OUTER_WIDGET (f)),
4674 TB_INFO_KEY);
4676 if (! NILP (tbinfo->last_tool_bar) && ! NILP (f->tool_bar_items)
4677 && tbinfo->n_last_items == f->n_tool_bar_items
4678 && tbinfo->hmargin == hmargin && tbinfo->vmargin == vmargin
4679 && tbinfo->dir == dir
4680 && ! NILP (Fequal (tbinfo->style, style))
4681 && ! NILP (Fequal (tbinfo->last_tool_bar, f->tool_bar_items)))
4683 UNBLOCK_INPUT;
4684 return;
4687 tbinfo->last_tool_bar = f->tool_bar_items;
4688 tbinfo->n_last_items = f->n_tool_bar_items;
4689 tbinfo->style = style;
4690 tbinfo->hmargin = hmargin;
4691 tbinfo->vmargin = vmargin;
4692 tbinfo->dir = dir;
4694 text_image = EQ (style, Qtext_image_horiz);
4695 horiz = EQ (style, Qboth_horiz) || text_image;
4697 for (i = j = 0; i < f->n_tool_bar_items; ++i)
4699 int enabled_p = !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P));
4700 int selected_p = !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P));
4701 int idx;
4702 ptrdiff_t img_id;
4703 int icon_size = 0;
4704 struct image *img = NULL;
4705 Lisp_Object image;
4706 Lisp_Object stock = Qnil;
4707 GtkStockItem stock_item;
4708 char *stock_name = NULL;
4709 char *icon_name = NULL;
4710 Lisp_Object rtl;
4711 GtkWidget *wbutton = NULL;
4712 Lisp_Object specified_file;
4713 int vert_only = ! NILP (PROP (TOOL_BAR_ITEM_VERT_ONLY));
4714 const char *label
4715 = (EQ (style, Qimage) || (vert_only && horiz)) ? NULL
4716 : STRINGP (PROP (TOOL_BAR_ITEM_LABEL))
4717 ? SSDATA (PROP (TOOL_BAR_ITEM_LABEL))
4718 : "";
4720 ti = gtk_toolbar_get_nth_item (GTK_TOOLBAR (wtoolbar), j);
4722 /* If this is a separator, use a gtk separator item. */
4723 if (EQ (PROP (TOOL_BAR_ITEM_TYPE), Qt))
4725 if (ti == NULL || !GTK_IS_SEPARATOR_TOOL_ITEM (ti))
4727 if (ti)
4728 gtk_container_remove (GTK_CONTAINER (wtoolbar),
4729 GTK_WIDGET (ti));
4730 ti = gtk_separator_tool_item_new ();
4731 gtk_toolbar_insert (GTK_TOOLBAR (wtoolbar), ti, j);
4733 j++;
4734 continue;
4737 /* Otherwise, the tool-bar item is an ordinary button. */
4739 if (ti && GTK_IS_SEPARATOR_TOOL_ITEM (ti))
4741 gtk_container_remove (GTK_CONTAINER (wtoolbar), GTK_WIDGET (ti));
4742 ti = NULL;
4745 if (ti) wbutton = XG_BIN_CHILD (XG_BIN_CHILD (ti));
4747 /* Ignore invalid image specifications. */
4748 image = PROP (TOOL_BAR_ITEM_IMAGES);
4749 if (!valid_image_p (image))
4751 if (ti)
4752 gtk_container_remove (GTK_CONTAINER (wtoolbar),
4753 GTK_WIDGET (ti));
4754 continue;
4757 specified_file = file_for_image (image);
4758 if (!NILP (specified_file) && !NILP (Ffboundp (Qx_gtk_map_stock)))
4759 stock = call1 (Qx_gtk_map_stock, specified_file);
4761 if (STRINGP (stock))
4763 stock_name = SSDATA (stock);
4764 if (stock_name[0] == 'n' && stock_name[1] == ':')
4766 GdkScreen *screen = gtk_widget_get_screen (GTK_WIDGET (wtoolbar));
4767 GtkIconTheme *icon_theme = gtk_icon_theme_get_for_screen (screen);
4769 icon_name = stock_name + 2;
4770 stock_name = NULL;
4771 stock = Qnil;
4773 if (! gtk_icon_theme_has_icon (icon_theme, icon_name))
4774 icon_name = NULL;
4775 else
4776 icon_size = gtk_toolbar_get_icon_size (wtoolbar);
4778 else if (gtk_stock_lookup (SSDATA (stock), &stock_item))
4779 icon_size = gtk_toolbar_get_icon_size (wtoolbar);
4780 else
4782 stock = Qnil;
4783 stock_name = NULL;
4787 if (stock_name == NULL && icon_name == NULL)
4789 /* No stock image, or stock item not known. Try regular
4790 image. If image is a vector, choose it according to the
4791 button state. */
4792 if (dir == GTK_TEXT_DIR_RTL
4793 && !NILP (rtl = PROP (TOOL_BAR_ITEM_RTL_IMAGE))
4794 && STRINGP (rtl))
4795 image = find_rtl_image (f, image, rtl);
4797 if (VECTORP (image))
4799 if (enabled_p)
4800 idx = (selected_p
4801 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
4802 : TOOL_BAR_IMAGE_ENABLED_DESELECTED);
4803 else
4804 idx = (selected_p
4805 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
4806 : TOOL_BAR_IMAGE_DISABLED_DESELECTED);
4808 eassert (ASIZE (image) >= idx);
4809 image = AREF (image, idx);
4811 else
4812 idx = -1;
4814 img_id = lookup_image (f, image);
4815 img = IMAGE_FROM_ID (f, img_id);
4816 prepare_image_for_display (f, img);
4818 if (img->load_failed_p || img->pixmap == None)
4820 if (ti)
4821 gtk_container_remove (GTK_CONTAINER (wtoolbar),
4822 GTK_WIDGET (ti));
4823 continue;
4827 /* If there is an existing widget, check if it's stale; if so,
4828 remove it and make a new tool item from scratch. */
4829 if (ti && xg_tool_item_stale_p (wbutton, stock_name, icon_name,
4830 img, label, horiz))
4832 gtk_container_remove (GTK_CONTAINER (wtoolbar),
4833 GTK_WIDGET (ti));
4834 ti = NULL;
4837 if (ti == NULL)
4839 GtkWidget *w;
4841 /* Save the image so we can see if an update is needed the
4842 next time we call xg_tool_item_match_p. */
4843 if (EQ (style, Qtext))
4844 w = NULL;
4845 else if (stock_name)
4847 w = gtk_image_new_from_stock (stock_name, icon_size);
4848 g_object_set_data_full (G_OBJECT (w), XG_TOOL_BAR_STOCK_NAME,
4849 (gpointer) xstrdup (stock_name),
4850 (GDestroyNotify) xfree);
4852 else if (icon_name)
4854 w = gtk_image_new_from_icon_name (icon_name, icon_size);
4855 g_object_set_data_full (G_OBJECT (w), XG_TOOL_BAR_ICON_NAME,
4856 (gpointer) xstrdup (icon_name),
4857 (GDestroyNotify) xfree);
4859 else
4861 w = xg_get_image_for_pixmap (f, img, x->widget, NULL);
4862 g_object_set_data (G_OBJECT (w), XG_TOOL_BAR_IMAGE_DATA,
4863 (gpointer)img->pixmap);
4866 if (w) gtk_misc_set_padding (GTK_MISC (w), hmargin, vmargin);
4867 ti = xg_make_tool_item (f, w, &wbutton, label, i, horiz, text_image);
4868 gtk_toolbar_insert (GTK_TOOLBAR (wtoolbar), ti, j);
4871 #undef PROP
4873 gtk_widget_set_sensitive (wbutton, enabled_p);
4874 j++;
4877 /* Remove buttons not longer needed. */
4880 ti = gtk_toolbar_get_nth_item (GTK_TOOLBAR (wtoolbar), j);
4881 if (ti)
4882 gtk_container_remove (GTK_CONTAINER (wtoolbar), GTK_WIDGET (ti));
4883 } while (ti != NULL);
4885 if (f->n_tool_bar_items != 0)
4887 if (pack_tool_bar)
4888 xg_pack_tool_bar (f, f->tool_bar_position);
4889 gtk_widget_show_all (GTK_WIDGET (x->handlebox_widget));
4890 if (xg_update_tool_bar_sizes (f))
4891 xg_height_or_width_changed (f);
4894 UNBLOCK_INPUT;
4897 /* Deallocate all resources for the tool bar on frame F.
4898 Remove the tool bar. */
4900 void
4901 free_frame_tool_bar (FRAME_PTR f)
4903 struct x_output *x = f->output_data.x;
4905 if (x->toolbar_widget)
4907 struct xg_frame_tb_info *tbinfo;
4908 int is_packed = x->handlebox_widget != 0;
4909 BLOCK_INPUT;
4910 /* We may have created the toolbar_widget in xg_create_tool_bar, but
4911 not the x->handlebox_widget which is created in xg_pack_tool_bar. */
4912 if (is_packed)
4914 if (x->toolbar_in_hbox)
4915 gtk_container_remove (GTK_CONTAINER (x->hbox_widget),
4916 x->handlebox_widget);
4917 else
4918 gtk_container_remove (GTK_CONTAINER (x->vbox_widget),
4919 x->handlebox_widget);
4921 else
4922 gtk_widget_destroy (x->toolbar_widget);
4924 x->toolbar_widget = 0;
4925 x->handlebox_widget = 0;
4926 FRAME_TOOLBAR_TOP_HEIGHT (f) = FRAME_TOOLBAR_BOTTOM_HEIGHT (f) = 0;
4927 FRAME_TOOLBAR_LEFT_WIDTH (f) = FRAME_TOOLBAR_RIGHT_WIDTH (f) = 0;
4929 tbinfo = g_object_get_data (G_OBJECT (FRAME_GTK_OUTER_WIDGET (f)),
4930 TB_INFO_KEY);
4931 if (tbinfo)
4933 xfree (tbinfo);
4934 g_object_set_data (G_OBJECT (FRAME_GTK_OUTER_WIDGET (f)),
4935 TB_INFO_KEY,
4936 NULL);
4939 xg_height_or_width_changed (f);
4941 UNBLOCK_INPUT;
4946 xg_change_toolbar_position (FRAME_PTR f, Lisp_Object pos)
4948 struct x_output *x = f->output_data.x;
4950 if (! x->toolbar_widget || ! x->handlebox_widget)
4951 return 1;
4953 BLOCK_INPUT;
4954 g_object_ref (x->handlebox_widget);
4955 if (x->toolbar_in_hbox)
4956 gtk_container_remove (GTK_CONTAINER (x->hbox_widget),
4957 x->handlebox_widget);
4958 else
4959 gtk_container_remove (GTK_CONTAINER (x->vbox_widget),
4960 x->handlebox_widget);
4961 xg_pack_tool_bar (f, pos);
4962 g_object_unref (x->handlebox_widget);
4963 if (xg_update_tool_bar_sizes (f))
4964 xg_height_or_width_changed (f);
4966 UNBLOCK_INPUT;
4967 return 1;
4972 /***********************************************************************
4973 Initializing
4974 ***********************************************************************/
4975 void
4976 xg_initialize (void)
4978 GtkBindingSet *binding_set;
4979 GtkSettings *settings;
4981 #if HAVE_XFT
4982 /* Work around a bug with corrupted data if libXft gets unloaded. This way
4983 we keep it permanently linked in. */
4984 XftInit (0);
4985 #endif
4987 gdpy_def = NULL;
4988 xg_ignore_gtk_scrollbar = 0;
4989 xg_detached_menus = 0;
4990 xg_menu_cb_list.prev = xg_menu_cb_list.next =
4991 xg_menu_item_cb_list.prev = xg_menu_item_cb_list.next = 0;
4993 id_to_widget.max_size = id_to_widget.used = 0;
4994 id_to_widget.widgets = 0;
4996 settings = gtk_settings_get_for_screen (gdk_display_get_default_screen
4997 (gdk_display_get_default ()));
4998 /* Remove F10 as a menu accelerator, it does not mix well with Emacs key
4999 bindings. It doesn't seem to be any way to remove properties,
5000 so we set it to VoidSymbol which in X means "no key". */
5001 gtk_settings_set_string_property (settings,
5002 "gtk-menu-bar-accel",
5003 "VoidSymbol",
5004 EMACS_CLASS);
5006 /* Make GTK text input widgets use Emacs style keybindings. This is
5007 Emacs after all. */
5008 gtk_settings_set_string_property (settings,
5009 "gtk-key-theme-name",
5010 "Emacs",
5011 EMACS_CLASS);
5013 /* Make dialogs close on C-g. Since file dialog inherits from
5014 dialog, this works for them also. */
5015 binding_set = gtk_binding_set_by_class (g_type_class_ref (GTK_TYPE_DIALOG));
5016 gtk_binding_entry_add_signal (binding_set, GDK_KEY_g, GDK_CONTROL_MASK,
5017 "close", 0);
5019 /* Make menus close on C-g. */
5020 binding_set = gtk_binding_set_by_class (g_type_class_ref
5021 (GTK_TYPE_MENU_SHELL));
5022 gtk_binding_entry_add_signal (binding_set, GDK_KEY_g, GDK_CONTROL_MASK,
5023 "cancel", 0);
5024 update_theme_scrollbar_width ();
5026 x_last_font_name = NULL;
5029 #endif /* USE_GTK */