Fixes: debbugs:19175
[emacs.git] / src / gtkutil.c
blobeddd2b535db2bdd992f7584aab4e2d1fbc9a68fc
1 /* Functions for creating and updating GTK widgets.
3 Copyright (C) 2003-2015 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 <stdio.h>
26 #include <c-ctype.h>
28 #include "lisp.h"
29 #include "xterm.h"
30 #include "blockinput.h"
31 #include "syssignal.h"
32 #include "window.h"
33 #include "gtkutil.h"
34 #include "termhooks.h"
35 #include "keyboard.h"
36 #include "charset.h"
37 #include "coding.h"
38 #include "font.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_CHECK_VERSION (2, 12, 0)
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 #ifdef HAVE_FREETYPE
82 #if GTK_CHECK_VERSION (3, 2, 0)
83 #define USE_NEW_GTK_FONT_CHOOSER 1
84 #else
85 #define USE_NEW_GTK_FONT_CHOOSER 0
86 #define gtk_font_chooser_dialog_new(x, y) \
87 gtk_font_selection_dialog_new (x)
88 #undef GTK_FONT_CHOOSER
89 #define GTK_FONT_CHOOSER(x) GTK_FONT_SELECTION_DIALOG (x)
90 #define gtk_font_chooser_set_font(x, y) \
91 gtk_font_selection_dialog_set_font_name (x, y)
92 #endif
93 #endif /* HAVE_FREETYPE */
95 #ifndef HAVE_GTK3
96 #ifdef USE_GTK_TOOLTIP
97 #define gdk_window_get_screen(w) gdk_drawable_get_screen (w)
98 #endif
99 #define gdk_window_get_geometry(w, a, b, c, d) \
100 gdk_window_get_geometry (w, a, b, c, d, 0)
101 #define gdk_x11_window_lookup_for_display(d, w) \
102 gdk_xid_table_lookup_for_display (d, w)
103 #define gtk_box_new(ori, spacing) \
104 ((ori) == GTK_ORIENTATION_HORIZONTAL \
105 ? gtk_hbox_new (FALSE, (spacing)) : gtk_vbox_new (FALSE, (spacing)))
106 #define gtk_scrollbar_new(ori, spacing) \
107 ((ori) == GTK_ORIENTATION_HORIZONTAL \
108 ? gtk_hscrollbar_new ((spacing)) : gtk_vscrollbar_new ((spacing)))
109 #ifndef GDK_KEY_g
110 #define GDK_KEY_g GDK_g
111 #endif
112 #endif /* HAVE_GTK3 */
114 #define XG_BIN_CHILD(x) gtk_bin_get_child (GTK_BIN (x))
116 static void update_theme_scrollbar_width (void);
118 #define TB_INFO_KEY "xg_frame_tb_info"
119 struct xg_frame_tb_info
121 Lisp_Object last_tool_bar;
122 Lisp_Object style;
123 int n_last_items;
124 int hmargin, vmargin;
125 GtkTextDirection dir;
129 /***********************************************************************
130 Display handling functions
131 ***********************************************************************/
133 /* Keep track of the default display, or NULL if there is none. Emacs
134 may close all its displays. */
136 static GdkDisplay *gdpy_def;
138 /* When the GTK widget W is to be created on a display for F that
139 is not the default display, set the display for W.
140 W can be a GtkMenu or a GtkWindow widget. */
142 static void
143 xg_set_screen (GtkWidget *w, struct frame *f)
145 if (FRAME_X_DISPLAY (f) != DEFAULT_GDK_DISPLAY ())
147 GdkDisplay *gdpy = gdk_x11_lookup_xdisplay (FRAME_X_DISPLAY (f));
148 GdkScreen *gscreen = gdk_display_get_default_screen (gdpy);
150 if (GTK_IS_MENU (w))
151 gtk_menu_set_screen (GTK_MENU (w), gscreen);
152 else
153 gtk_window_set_screen (GTK_WINDOW (w), gscreen);
158 /* Open a display named by DISPLAY_NAME. The display is returned in *DPY.
159 *DPY is set to NULL if the display can't be opened.
161 Returns non-zero if display could be opened, zero if display could not
162 be opened, and less than zero if the GTK version doesn't support
163 multiple displays. */
165 void
166 xg_display_open (char *display_name, Display **dpy)
168 GdkDisplay *gdpy;
170 unrequest_sigio (); // See comment in x_display_ok, xterm.c.
171 gdpy = gdk_display_open (display_name);
172 request_sigio ();
173 if (!gdpy_def && gdpy)
175 gdpy_def = gdpy;
176 gdk_display_manager_set_default_display (gdk_display_manager_get (),
177 gdpy);
180 *dpy = gdpy ? GDK_DISPLAY_XDISPLAY (gdpy) : NULL;
184 /* Close display DPY. */
186 void
187 xg_display_close (Display *dpy)
189 GdkDisplay *gdpy = gdk_x11_lookup_xdisplay (dpy);
191 /* If this is the default display, try to change it before closing.
192 If there is no other display to use, gdpy_def is set to NULL, and
193 the next call to xg_display_open resets the default display. */
194 if (gdk_display_get_default () == gdpy)
196 struct x_display_info *dpyinfo;
197 GdkDisplay *gdpy_new = NULL;
199 /* Find another display. */
200 for (dpyinfo = x_display_list; dpyinfo; dpyinfo = dpyinfo->next)
201 if (dpyinfo->display != dpy)
203 gdpy_new = gdk_x11_lookup_xdisplay (dpyinfo->display);
204 gdk_display_manager_set_default_display (gdk_display_manager_get (),
205 gdpy_new);
206 break;
208 gdpy_def = gdpy_new;
211 #if GTK_CHECK_VERSION (2, 0, 0) && ! GTK_CHECK_VERSION (2, 10, 0)
212 /* GTK 2.2-2.8 has a bug that makes gdk_display_close crash (bug
213 http://bugzilla.gnome.org/show_bug.cgi?id=85715). This way we
214 can continue running, but there will be memory leaks. */
215 g_object_run_dispose (G_OBJECT (gdpy));
216 #else
217 /* This seems to be fixed in GTK 2.10. */
218 gdk_display_close (gdpy);
219 #endif
223 /***********************************************************************
224 Utility functions
225 ***********************************************************************/
226 /* The next two variables and functions are taken from lwlib. */
227 static widget_value *widget_value_free_list;
228 static int malloc_cpt;
230 /* Allocate a widget_value structure, either by taking one from the
231 widget_value_free_list or by malloc:ing a new one.
233 Return a pointer to the allocated structure. */
235 widget_value *
236 malloc_widget_value (void)
238 widget_value *wv;
239 if (widget_value_free_list)
241 wv = widget_value_free_list;
242 widget_value_free_list = wv->free_list;
243 wv->free_list = 0;
245 else
247 wv = xmalloc (sizeof *wv);
248 malloc_cpt++;
250 memset (wv, 0, sizeof (widget_value));
251 return wv;
254 /* This is analogous to free. It frees only what was allocated
255 by malloc_widget_value, and no substructures. */
257 void
258 free_widget_value (widget_value *wv)
260 if (wv->free_list)
261 emacs_abort ();
263 if (malloc_cpt > 25)
265 /* When the number of already allocated cells is too big,
266 We free it. */
267 xfree (wv);
268 malloc_cpt--;
270 else
272 wv->free_list = widget_value_free_list;
273 widget_value_free_list = wv;
278 /* Create and return the cursor to be used for popup menus and
279 scroll bars on display DPY. */
281 GdkCursor *
282 xg_create_default_cursor (Display *dpy)
284 GdkDisplay *gdpy = gdk_x11_lookup_xdisplay (dpy);
285 return gdk_cursor_new_for_display (gdpy, GDK_LEFT_PTR);
288 static GdkPixbuf *
289 xg_get_pixbuf_from_pixmap (struct frame *f, Pixmap pix)
291 int iunused;
292 GdkPixbuf *tmp_buf;
293 Window wunused;
294 unsigned int width, height, uunused;
295 XImage *xim;
297 XGetGeometry (FRAME_X_DISPLAY (f), pix, &wunused, &iunused, &iunused,
298 &width, &height, &uunused, &uunused);
300 xim = XGetImage (FRAME_X_DISPLAY (f), pix, 0, 0, width, height,
301 ~0, XYPixmap);
302 if (!xim) return 0;
304 tmp_buf = gdk_pixbuf_new_from_data ((guchar *) xim->data,
305 GDK_COLORSPACE_RGB,
306 FALSE,
307 xim->bitmap_unit,
308 width,
309 height,
310 xim->bytes_per_line,
311 NULL,
312 NULL);
313 XDestroyImage (xim);
314 return tmp_buf;
317 /* Apply GMASK to GPIX and return a GdkPixbuf with an alpha channel. */
319 static GdkPixbuf *
320 xg_get_pixbuf_from_pix_and_mask (struct frame *f,
321 Pixmap pix,
322 Pixmap mask)
324 int width, height;
325 GdkPixbuf *icon_buf, *tmp_buf;
327 tmp_buf = xg_get_pixbuf_from_pixmap (f, pix);
328 icon_buf = gdk_pixbuf_add_alpha (tmp_buf, FALSE, 0, 0, 0);
329 g_object_unref (G_OBJECT (tmp_buf));
331 width = gdk_pixbuf_get_width (icon_buf);
332 height = gdk_pixbuf_get_height (icon_buf);
334 if (mask)
336 GdkPixbuf *mask_buf = xg_get_pixbuf_from_pixmap (f, mask);
337 guchar *pixels = gdk_pixbuf_get_pixels (icon_buf);
338 guchar *mask_pixels = gdk_pixbuf_get_pixels (mask_buf);
339 int rowstride = gdk_pixbuf_get_rowstride (icon_buf);
340 int mask_rowstride = gdk_pixbuf_get_rowstride (mask_buf);
341 int y;
343 for (y = 0; y < height; ++y)
345 guchar *iconptr, *maskptr;
346 int x;
348 iconptr = pixels + y * rowstride;
349 maskptr = mask_pixels + y * mask_rowstride;
351 for (x = 0; x < width; ++x)
353 /* In a bitmap, RGB is either 255/255/255 or 0/0/0. Checking
354 just R is sufficient. */
355 if (maskptr[0] == 0)
356 iconptr[3] = 0; /* 0, 1, 2 is R, G, B. 3 is alpha. */
358 iconptr += rowstride/width;
359 maskptr += mask_rowstride/width;
363 g_object_unref (G_OBJECT (mask_buf));
366 return icon_buf;
369 static Lisp_Object
370 file_for_image (Lisp_Object image)
372 Lisp_Object specified_file = Qnil;
373 Lisp_Object tail;
375 for (tail = XCDR (image);
376 NILP (specified_file) && CONSP (tail) && CONSP (XCDR (tail));
377 tail = XCDR (XCDR (tail)))
378 if (EQ (XCAR (tail), QCfile))
379 specified_file = XCAR (XCDR (tail));
381 return specified_file;
384 /* For the image defined in IMG, make and return a GtkImage. For displays with
385 8 planes or less we must make a GdkPixbuf and apply the mask manually.
386 Otherwise the highlighting and dimming the tool bar code in GTK does
387 will look bad. For display with more than 8 planes we just use the
388 pixmap and mask directly. For monochrome displays, GTK doesn't seem
389 able to use external pixmaps, it looks bad whatever we do.
390 The image is defined on the display where frame F is.
391 WIDGET is used to find the GdkColormap to use for the GdkPixbuf.
392 If OLD_WIDGET is NULL, a new widget is constructed and returned.
393 If OLD_WIDGET is not NULL, that widget is modified. */
395 static GtkWidget *
396 xg_get_image_for_pixmap (struct frame *f,
397 struct image *img,
398 GtkWidget *widget,
399 GtkImage *old_widget)
401 GdkPixbuf *icon_buf;
403 /* If we have a file, let GTK do all the image handling.
404 This seems to be the only way to make insensitive and activated icons
405 look good in all cases. */
406 Lisp_Object specified_file = file_for_image (img->spec);
407 Lisp_Object file;
409 /* We already loaded the image once before calling this
410 function, so this only fails if the image file has been removed.
411 In that case, use the pixmap already loaded. */
413 if (STRINGP (specified_file)
414 && STRINGP (file = x_find_image_file (specified_file)))
416 if (! old_widget)
417 old_widget = GTK_IMAGE (gtk_image_new_from_file (SSDATA (file)));
418 else
419 gtk_image_set_from_file (old_widget, SSDATA (file));
421 return GTK_WIDGET (old_widget);
424 /* No file, do the image handling ourselves. This will look very bad
425 on a monochrome display, and sometimes bad on all displays with
426 certain themes. */
428 /* This is a workaround to make icons look good on pseudo color
429 displays. Apparently GTK expects the images to have an alpha
430 channel. If they don't, insensitive and activated icons will
431 look bad. This workaround does not work on monochrome displays,
432 and is strictly not needed on true color/static color displays (i.e.
433 16 bits and higher). But we do it anyway so we get a pixbuf that is
434 not associated with the img->pixmap. The img->pixmap may be removed
435 by clearing the image cache and then the tool bar redraw fails, since
436 Gtk+ assumes the pixmap is always there. */
437 icon_buf = xg_get_pixbuf_from_pix_and_mask (f, img->pixmap, img->mask);
439 if (icon_buf)
441 if (! old_widget)
442 old_widget = GTK_IMAGE (gtk_image_new_from_pixbuf (icon_buf));
443 else
444 gtk_image_set_from_pixbuf (old_widget, icon_buf);
446 g_object_unref (G_OBJECT (icon_buf));
449 return GTK_WIDGET (old_widget);
453 /* Set CURSOR on W and all widgets W contain. We must do like this
454 for scroll bars and menu because they create widgets internally,
455 and it is those widgets that are visible. */
457 static void
458 xg_set_cursor (GtkWidget *w, GdkCursor *cursor)
460 GdkWindow *window = gtk_widget_get_window (w);
461 GList *children = gdk_window_peek_children (window);
463 gdk_window_set_cursor (window, cursor);
465 /* The scroll bar widget has more than one GDK window (had to look at
466 the source to figure this out), and there is no way to set cursor
467 on widgets in GTK. So we must set the cursor for all GDK windows.
468 Ditto for menus. */
470 for ( ; children; children = g_list_next (children))
471 gdk_window_set_cursor (GDK_WINDOW (children->data), cursor);
474 /* Insert NODE into linked LIST. */
476 static void
477 xg_list_insert (xg_list_node *list, xg_list_node *node)
479 xg_list_node *list_start = list->next;
481 if (list_start) list_start->prev = node;
482 node->next = list_start;
483 node->prev = 0;
484 list->next = node;
487 /* Remove NODE from linked LIST. */
489 static void
490 xg_list_remove (xg_list_node *list, xg_list_node *node)
492 xg_list_node *list_start = list->next;
493 if (node == list_start)
495 list->next = node->next;
496 if (list->next) list->next->prev = 0;
498 else
500 node->prev->next = node->next;
501 if (node->next) node->next->prev = node->prev;
505 /* Allocate and return a utf8 version of STR. If STR is already
506 utf8 or NULL, just return a copy of STR.
507 A new string is allocated and the caller must free the result
508 with g_free. */
510 static char *
511 get_utf8_string (const char *str)
513 char *utf8_str;
515 if (!str) return NULL;
517 /* If not UTF-8, try current locale. */
518 if (!g_utf8_validate (str, -1, NULL))
519 utf8_str = g_locale_to_utf8 (str, -1, 0, 0, 0);
520 else
521 return g_strdup (str);
523 if (!utf8_str)
525 /* Probably some control characters in str. Escape them. */
526 ptrdiff_t len;
527 ptrdiff_t nr_bad = 0;
528 gsize bytes_read;
529 gsize bytes_written;
530 unsigned char *p = (unsigned char *)str;
531 char *cp, *up;
532 GError *err = NULL;
534 while (! (cp = g_locale_to_utf8 ((char *)p, -1, &bytes_read,
535 &bytes_written, &err))
536 && err->code == G_CONVERT_ERROR_ILLEGAL_SEQUENCE)
538 ++nr_bad;
539 p += bytes_written+1;
540 g_error_free (err);
541 err = NULL;
544 if (err)
546 g_error_free (err);
547 err = NULL;
549 if (cp) g_free (cp);
551 len = strlen (str);
552 if ((min (PTRDIFF_MAX, SIZE_MAX) - len - 1) / 4 < nr_bad)
553 memory_full (SIZE_MAX);
554 up = utf8_str = xmalloc (len + nr_bad * 4 + 1);
555 p = (unsigned char *)str;
557 while (! (cp = g_locale_to_utf8 ((char *)p, -1, &bytes_read,
558 &bytes_written, &err))
559 && err->code == G_CONVERT_ERROR_ILLEGAL_SEQUENCE)
561 memcpy (up, p, bytes_written);
562 sprintf (up + bytes_written, "\\%03o", p[bytes_written]);
563 up += bytes_written+4;
564 p += bytes_written+1;
565 g_error_free (err);
566 err = NULL;
569 if (cp)
571 strcat (utf8_str, cp);
572 g_free (cp);
574 if (err)
576 g_error_free (err);
577 err = NULL;
580 return utf8_str;
583 /* Check for special colors used in face spec for region face.
584 The colors are fetched from the Gtk+ theme.
585 Return true if color was found, false if not. */
587 bool
588 xg_check_special_colors (struct frame *f,
589 const char *color_name,
590 XColor *color)
592 bool success_p = 0;
593 bool get_bg = strcmp ("gtk_selection_bg_color", color_name) == 0;
594 bool get_fg = !get_bg && strcmp ("gtk_selection_fg_color", color_name) == 0;
596 if (! FRAME_GTK_WIDGET (f) || ! (get_bg || get_fg))
597 return success_p;
599 block_input ();
601 #ifdef HAVE_GTK3
602 GtkStyleContext *gsty
603 = gtk_widget_get_style_context (FRAME_GTK_OUTER_WIDGET (f));
604 GdkRGBA col;
605 char buf[sizeof "rgb://rrrr/gggg/bbbb"];
606 int state = GTK_STATE_FLAG_SELECTED|GTK_STATE_FLAG_FOCUSED;
607 if (get_fg)
608 gtk_style_context_get_color (gsty, state, &col);
609 else
610 gtk_style_context_get_background_color (gsty, state, &col);
612 sprintf (buf, "rgb:%04x/%04x/%04x",
613 (int)(col.red * 65535),
614 (int)(col.green * 65535),
615 (int)(col.blue * 65535));
616 success_p = (XParseColor (FRAME_X_DISPLAY (f), FRAME_X_COLORMAP (f),
617 buf, color)
618 != 0);
619 #else
620 GtkStyle *gsty = gtk_widget_get_style (FRAME_GTK_WIDGET (f));
621 GdkColor *grgb = get_bg
622 ? &gsty->bg[GTK_STATE_SELECTED]
623 : &gsty->fg[GTK_STATE_SELECTED];
625 color->red = grgb->red;
626 color->green = grgb->green;
627 color->blue = grgb->blue;
628 color->pixel = grgb->pixel;
629 success_p = 1;
630 #endif
633 unblock_input ();
634 return success_p;
639 /***********************************************************************
640 Tooltips
641 ***********************************************************************/
642 /* Gtk+ calls this callback when the parent of our tooltip dummy changes.
643 We use that to pop down the tooltip. This happens if Gtk+ for some
644 reason wants to change or hide the tooltip. */
646 #ifdef USE_GTK_TOOLTIP
648 static void
649 hierarchy_ch_cb (GtkWidget *widget,
650 GtkWidget *previous_toplevel,
651 gpointer user_data)
653 struct frame *f = user_data;
654 struct x_output *x = f->output_data.x;
655 GtkWidget *top = gtk_widget_get_toplevel (x->ttip_lbl);
657 if (! top || ! GTK_IS_WINDOW (top))
658 gtk_widget_hide (previous_toplevel);
661 /* Callback called when Gtk+ thinks a tooltip should be displayed.
662 We use it to get the tooltip window and the tooltip widget so
663 we can manipulate the ourselves.
665 Return FALSE ensures that the tooltip is not shown. */
667 static gboolean
668 qttip_cb (GtkWidget *widget,
669 gint xpos,
670 gint ypos,
671 gboolean keyboard_mode,
672 GtkTooltip *tooltip,
673 gpointer user_data)
675 struct frame *f = user_data;
676 struct x_output *x = f->output_data.x;
677 if (x->ttip_widget == NULL)
679 GtkWidget *p;
680 GList *list, *iter;
682 g_object_set (G_OBJECT (widget), "has-tooltip", FALSE, NULL);
683 x->ttip_widget = tooltip;
684 g_object_ref (G_OBJECT (tooltip));
685 x->ttip_lbl = gtk_label_new ("");
686 g_object_ref (G_OBJECT (x->ttip_lbl));
687 gtk_tooltip_set_custom (tooltip, x->ttip_lbl);
688 x->ttip_window = GTK_WINDOW (gtk_widget_get_toplevel (x->ttip_lbl));
690 /* Change stupid Gtk+ default line wrapping. */
691 p = gtk_widget_get_parent (x->ttip_lbl);
692 list = gtk_container_get_children (GTK_CONTAINER (p));
693 for (iter = list; iter; iter = g_list_next (iter))
695 GtkWidget *w = GTK_WIDGET (iter->data);
696 if (GTK_IS_LABEL (w))
697 gtk_label_set_line_wrap (GTK_LABEL (w), FALSE);
699 g_list_free (list);
701 /* ATK needs an empty title for some reason. */
702 gtk_window_set_title (x->ttip_window, "");
703 /* Realize so we can safely get screen later on. */
704 gtk_widget_realize (GTK_WIDGET (x->ttip_window));
705 gtk_widget_realize (x->ttip_lbl);
707 g_signal_connect (x->ttip_lbl, "hierarchy-changed",
708 G_CALLBACK (hierarchy_ch_cb), f);
710 return FALSE;
713 #endif /* USE_GTK_TOOLTIP */
715 /* Prepare a tooltip to be shown, i.e. calculate WIDTH and HEIGHT.
716 Return true if a system tooltip is available. */
718 bool
719 xg_prepare_tooltip (struct frame *f,
720 Lisp_Object string,
721 int *width,
722 int *height)
724 #ifndef USE_GTK_TOOLTIP
725 return 0;
726 #else
727 struct x_output *x = f->output_data.x;
728 GtkWidget *widget;
729 GdkWindow *gwin;
730 GdkScreen *screen;
731 GtkSettings *settings;
732 gboolean tt_enabled = TRUE;
733 GtkRequisition req;
734 Lisp_Object encoded_string;
736 if (!x->ttip_lbl) return 0;
738 block_input ();
739 encoded_string = ENCODE_UTF_8 (string);
740 widget = GTK_WIDGET (x->ttip_lbl);
741 gwin = gtk_widget_get_window (GTK_WIDGET (x->ttip_window));
742 screen = gdk_window_get_screen (gwin);
743 settings = gtk_settings_get_for_screen (screen);
744 g_object_get (settings, "gtk-enable-tooltips", &tt_enabled, NULL);
745 if (tt_enabled)
747 g_object_set (settings, "gtk-enable-tooltips", FALSE, NULL);
748 /* Record that we disabled it so it can be enabled again. */
749 g_object_set_data (G_OBJECT (x->ttip_window), "restore-tt",
750 (gpointer)f);
753 /* Prevent Gtk+ from hiding tooltip on mouse move and such. */
754 g_object_set_data (G_OBJECT
755 (gtk_widget_get_display (GTK_WIDGET (x->ttip_window))),
756 "gdk-display-current-tooltip", NULL);
758 /* Put our dummy widget in so we can get callbacks for unrealize and
759 hierarchy-changed. */
760 gtk_tooltip_set_custom (x->ttip_widget, widget);
761 gtk_tooltip_set_text (x->ttip_widget, SSDATA (encoded_string));
762 gtk_widget_get_preferred_size (GTK_WIDGET (x->ttip_window), NULL, &req);
763 if (width) *width = req.width;
764 if (height) *height = req.height;
766 unblock_input ();
768 return 1;
769 #endif /* USE_GTK_TOOLTIP */
772 /* Show the tooltip at ROOT_X and ROOT_Y.
773 xg_prepare_tooltip must have been called before this function. */
775 void
776 xg_show_tooltip (struct frame *f, int root_x, int root_y)
778 #ifdef USE_GTK_TOOLTIP
779 struct x_output *x = f->output_data.x;
780 if (x->ttip_window)
782 block_input ();
783 gtk_window_move (x->ttip_window, root_x, root_y);
784 gtk_widget_show_all (GTK_WIDGET (x->ttip_window));
785 unblock_input ();
787 #endif
790 /* Hide tooltip if shown. Do nothing if not shown.
791 Return true if tip was hidden, false if not (i.e. not using
792 system tooltips). */
794 bool
795 xg_hide_tooltip (struct frame *f)
797 bool ret = 0;
798 #ifdef USE_GTK_TOOLTIP
799 if (f->output_data.x->ttip_window)
801 GtkWindow *win = f->output_data.x->ttip_window;
802 block_input ();
803 gtk_widget_hide (GTK_WIDGET (win));
805 if (g_object_get_data (G_OBJECT (win), "restore-tt"))
807 GdkWindow *gwin = gtk_widget_get_window (GTK_WIDGET (win));
808 GdkScreen *screen = gdk_window_get_screen (gwin);
809 GtkSettings *settings = gtk_settings_get_for_screen (screen);
810 g_object_set (settings, "gtk-enable-tooltips", TRUE, NULL);
812 unblock_input ();
814 ret = 1;
816 #endif
817 return ret;
821 /***********************************************************************
822 General functions for creating widgets, resizing, events, e.t.c.
823 ***********************************************************************/
825 static void
826 my_log_handler (const gchar *log_domain, GLogLevelFlags log_level,
827 const gchar *msg, gpointer user_data)
829 if (!strstr (msg, "visible children"))
830 fprintf (stderr, "XX %s-WARNING **: %s\n", log_domain, msg);
833 /* Make a geometry string and pass that to GTK. It seems this is the
834 only way to get geometry position right if the user explicitly
835 asked for a position when starting Emacs.
836 F is the frame we shall set geometry for. */
838 static void
839 xg_set_geometry (struct frame *f)
841 if (f->size_hint_flags & (USPosition | PPosition))
843 int left = f->left_pos;
844 int xneg = f->size_hint_flags & XNegative;
845 int top = f->top_pos;
846 int yneg = f->size_hint_flags & YNegative;
847 char geom_str[sizeof "=x--" + 4 * INT_STRLEN_BOUND (int)];
848 guint id;
850 if (xneg)
851 left = -left;
852 if (yneg)
853 top = -top;
855 sprintf (geom_str, "=%dx%d%c%d%c%d",
856 FRAME_PIXEL_WIDTH (f),
857 FRAME_PIXEL_HEIGHT (f),
858 (xneg ? '-' : '+'), left,
859 (yneg ? '-' : '+'), top);
861 /* Silence warning about visible children. */
862 id = g_log_set_handler ("Gtk", G_LOG_LEVEL_WARNING | G_LOG_FLAG_FATAL
863 | G_LOG_FLAG_RECURSION, my_log_handler, NULL);
865 if (!gtk_window_parse_geometry (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)),
866 geom_str))
867 fprintf (stderr, "Failed to parse: '%s'\n", geom_str);
869 g_log_remove_handler ("Gtk", id);
873 /* Clear under internal border if any. As we use a mix of Gtk+ and X calls
874 and use a GtkFixed widget, this doesn't happen automatically. */
876 static void
877 xg_clear_under_internal_border (struct frame *f)
879 if (FRAME_INTERNAL_BORDER_WIDTH (f) > 0)
881 GtkWidget *wfixed = f->output_data.x->edit_widget;
883 gtk_widget_queue_draw (wfixed);
884 gdk_window_process_all_updates ();
886 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), 0, 0,
887 FRAME_PIXEL_WIDTH (f), FRAME_INTERNAL_BORDER_WIDTH (f));
889 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), 0, 0,
890 FRAME_INTERNAL_BORDER_WIDTH (f), FRAME_PIXEL_HEIGHT (f));
892 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), 0,
893 FRAME_PIXEL_HEIGHT (f) - FRAME_INTERNAL_BORDER_WIDTH (f),
894 FRAME_PIXEL_WIDTH (f), FRAME_INTERNAL_BORDER_WIDTH (f));
896 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
897 FRAME_PIXEL_WIDTH (f) - FRAME_INTERNAL_BORDER_WIDTH (f),
898 0, FRAME_INTERNAL_BORDER_WIDTH (f), FRAME_PIXEL_HEIGHT (f));
902 /* Function to handle resize of our frame. As we have a Gtk+ tool bar
903 and a Gtk+ menu bar, we get resize events for the edit part of the
904 frame only. We let Gtk+ deal with the Gtk+ parts.
905 F is the frame to resize.
906 PIXELWIDTH, PIXELHEIGHT is the new size in pixels. */
908 void
909 xg_frame_resized (struct frame *f, int pixelwidth, int pixelheight)
911 int width, height;
913 if (pixelwidth == -1 && pixelheight == -1)
915 if (FRAME_GTK_WIDGET (f) && gtk_widget_get_mapped (FRAME_GTK_WIDGET (f)))
916 gdk_window_get_geometry (gtk_widget_get_window (FRAME_GTK_WIDGET (f)),
917 0, 0,
918 &pixelwidth, &pixelheight);
919 else return;
923 width = FRAME_PIXEL_TO_TEXT_WIDTH (f, pixelwidth);
924 height = FRAME_PIXEL_TO_TEXT_HEIGHT (f, pixelheight);
926 if (width != FRAME_TEXT_WIDTH (f)
927 || height != FRAME_TEXT_HEIGHT (f)
928 || pixelwidth != FRAME_PIXEL_WIDTH (f)
929 || pixelheight != FRAME_PIXEL_HEIGHT (f))
931 FRAME_PIXEL_WIDTH (f) = pixelwidth;
932 FRAME_PIXEL_HEIGHT (f) = pixelheight;
934 xg_clear_under_internal_border (f);
935 change_frame_size (f, width, height, 0, 1, 0, 1);
936 SET_FRAME_GARBAGED (f);
937 cancel_mouse_face (f);
941 /* Resize the outer window of frame F after changing the height.
942 COLUMNS/ROWS is the size the edit area shall have after the resize. */
944 void
945 xg_frame_set_char_size (struct frame *f, int width, int height)
947 int pixelwidth = FRAME_TEXT_TO_PIXEL_WIDTH (f, width);
948 int pixelheight = FRAME_TEXT_TO_PIXEL_HEIGHT (f, height);
950 if (FRAME_PIXEL_HEIGHT (f) == 0)
951 return;
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 + FRAME_TOOLBAR_WIDTH (f),
960 pixelheight + FRAME_TOOLBAR_HEIGHT (f)
961 + FRAME_MENUBAR_HEIGHT (f));
962 x_wm_set_size_hint (f, 0, 0);
964 SET_FRAME_GARBAGED (f);
965 cancel_mouse_face (f);
967 /* We can not call change_frame_size for a mapped frame,
968 we can not set pixel width/height either. The window manager may
969 override our resize request, XMonad does this all the time.
970 The best we can do is try to sync, so lisp code sees the updated
971 size as fast as possible.
972 For unmapped windows, we can set rows/cols. When
973 the frame is mapped again we will (hopefully) get the correct size. */
974 if (FRAME_VISIBLE_P (f))
976 /* Must call this to flush out events */
977 (void)gtk_events_pending ();
978 gdk_flush ();
979 x_wait_for_event (f, ConfigureNotify);
981 else
982 change_frame_size (f, width, height, 0, 1, 0, 1);
985 /* Handle height/width changes (i.e. add/remove/move menu/toolbar).
986 The policy is to keep the number of editable lines. */
988 static void
989 xg_height_or_width_changed (struct frame *f)
991 gtk_window_resize (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)),
992 FRAME_TOTAL_PIXEL_WIDTH (f),
993 FRAME_TOTAL_PIXEL_HEIGHT (f));
994 f->output_data.x->hint_flags = 0;
995 x_wm_set_size_hint (f, 0, 0);
998 /* Convert an X Window WSESC on display DPY to its corresponding GtkWidget.
999 Must be done like this, because GtkWidget:s can have "hidden"
1000 X Window that aren't accessible.
1002 Return 0 if no widget match WDESC. */
1004 GtkWidget *
1005 xg_win_to_widget (Display *dpy, Window wdesc)
1007 gpointer gdkwin;
1008 GtkWidget *gwdesc = 0;
1010 block_input ();
1012 gdkwin = gdk_x11_window_lookup_for_display (gdk_x11_lookup_xdisplay (dpy),
1013 wdesc);
1014 if (gdkwin)
1016 GdkEvent event;
1017 event.any.window = gdkwin;
1018 event.any.type = GDK_NOTHING;
1019 gwdesc = gtk_get_event_widget (&event);
1022 unblock_input ();
1023 return gwdesc;
1026 /* Set the background of widget W to PIXEL. */
1028 static void
1029 xg_set_widget_bg (struct frame *f, GtkWidget *w, unsigned long pixel)
1031 #ifdef HAVE_GTK3
1032 GdkRGBA bg;
1033 XColor xbg;
1034 xbg.pixel = pixel;
1035 if (XQueryColor (FRAME_X_DISPLAY (f), FRAME_X_COLORMAP (f), &xbg))
1037 bg.red = (double)xbg.red/65535.0;
1038 bg.green = (double)xbg.green/65535.0;
1039 bg.blue = (double)xbg.blue/65535.0;
1040 bg.alpha = 1.0;
1041 gtk_widget_override_background_color (w, GTK_STATE_FLAG_NORMAL, &bg);
1043 #else
1044 GdkColor bg;
1045 GdkColormap *map = gtk_widget_get_colormap (w);
1046 gdk_colormap_query_color (map, pixel, &bg);
1047 gtk_widget_modify_bg (FRAME_GTK_WIDGET (f), GTK_STATE_NORMAL, &bg);
1048 #endif
1051 /* Callback called when the gtk theme changes.
1052 We notify lisp code so it can fix faces used for region for example. */
1054 static void
1055 style_changed_cb (GObject *go,
1056 GParamSpec *spec,
1057 gpointer user_data)
1059 struct input_event event;
1060 GdkDisplay *gdpy = user_data;
1061 const char *display_name = gdk_display_get_name (gdpy);
1062 Display *dpy = GDK_DISPLAY_XDISPLAY (gdpy);
1064 EVENT_INIT (event);
1065 event.kind = CONFIG_CHANGED_EVENT;
1066 event.frame_or_window = build_string (display_name);
1067 /* Theme doesn't change often, so intern is called seldom. */
1068 event.arg = intern ("theme-name");
1069 kbd_buffer_store_event (&event);
1071 update_theme_scrollbar_width ();
1073 /* If scroll bar width changed, we need set the new size on all frames
1074 on this display. */
1075 if (dpy)
1077 Lisp_Object rest, frame;
1078 FOR_EACH_FRAME (rest, frame)
1080 struct frame *f = XFRAME (frame);
1081 if (FRAME_LIVE_P (f)
1082 && FRAME_X_P (f)
1083 && FRAME_X_DISPLAY (f) == dpy)
1085 x_set_scroll_bar_default_width (f);
1086 xg_frame_set_char_size (f, FRAME_TEXT_WIDTH (f), FRAME_TEXT_HEIGHT (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 struct frame *f = 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 true if creation succeeded. */
1117 bool
1118 xg_create_frame_widgets (struct frame *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_CHECK_VERSION (3, 0, 0) \
1143 && defined HAVE_GTK_WINDOW_SET_HAS_RESIZE_GRIP)
1144 gtk_window_set_has_resize_grip (GTK_WINDOW (wtop), FALSE);
1145 #endif
1147 xg_set_screen (wtop, f);
1149 wvbox = gtk_box_new (GTK_ORIENTATION_VERTICAL, 0);
1150 whbox = gtk_box_new (GTK_ORIENTATION_HORIZONTAL, 0);
1151 gtk_box_set_homogeneous (GTK_BOX (wvbox), FALSE);
1152 gtk_box_set_homogeneous (GTK_BOX (whbox), FALSE);
1154 #ifdef HAVE_GTK3
1155 wfixed = emacs_fixed_new (f);
1156 #else
1157 wfixed = gtk_fixed_new ();
1158 #endif
1160 if (! wtop || ! wvbox || ! whbox || ! wfixed)
1162 if (wtop) gtk_widget_destroy (wtop);
1163 if (wvbox) gtk_widget_destroy (wvbox);
1164 if (whbox) gtk_widget_destroy (whbox);
1165 if (wfixed) gtk_widget_destroy (wfixed);
1167 unblock_input ();
1168 return 0;
1171 /* Use same names as the Xt port does. I.e. Emacs.pane.emacs by default */
1172 gtk_widget_set_name (wtop, EMACS_CLASS);
1173 gtk_widget_set_name (wvbox, "pane");
1174 gtk_widget_set_name (wfixed, SSDATA (Vx_resource_name));
1176 /* If this frame has a title or name, set it in the title bar. */
1177 if (! NILP (f->title))
1178 title = SSDATA (ENCODE_UTF_8 (f->title));
1179 else if (! NILP (f->name))
1180 title = SSDATA (ENCODE_UTF_8 (f->name));
1182 if (title) gtk_window_set_title (GTK_WINDOW (wtop), title);
1184 FRAME_GTK_OUTER_WIDGET (f) = wtop;
1185 FRAME_GTK_WIDGET (f) = wfixed;
1186 f->output_data.x->vbox_widget = wvbox;
1187 f->output_data.x->hbox_widget = whbox;
1189 gtk_widget_set_has_window (wfixed, TRUE);
1191 gtk_container_add (GTK_CONTAINER (wtop), wvbox);
1192 gtk_box_pack_start (GTK_BOX (wvbox), whbox, TRUE, TRUE, 0);
1193 gtk_box_pack_start (GTK_BOX (whbox), wfixed, TRUE, TRUE, 0);
1195 if (FRAME_EXTERNAL_TOOL_BAR (f))
1196 update_frame_tool_bar (f);
1198 /* We don't want this widget double buffered, because we draw on it
1199 with regular X drawing primitives, so from a GTK/GDK point of
1200 view, the widget is totally blank. When an expose comes, this
1201 will make the widget blank, and then Emacs redraws it. This flickers
1202 a lot, so we turn off double buffering. */
1203 gtk_widget_set_double_buffered (wfixed, FALSE);
1205 gtk_window_set_wmclass (GTK_WINDOW (wtop),
1206 SSDATA (Vx_resource_name),
1207 SSDATA (Vx_resource_class));
1209 /* Add callback to do nothing on WM_DELETE_WINDOW. The default in
1210 GTK is to destroy the widget. We want Emacs to do that instead. */
1211 g_signal_connect (G_OBJECT (wtop), "delete-event",
1212 G_CALLBACK (delete_cb), f);
1214 /* Convert our geometry parameters into a geometry string
1215 and specify it.
1216 GTK will itself handle calculating the real position this way. */
1217 xg_set_geometry (f);
1218 f->win_gravity
1219 = gtk_window_get_gravity (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)));
1221 gtk_widget_add_events (wfixed,
1222 GDK_POINTER_MOTION_MASK
1223 | GDK_EXPOSURE_MASK
1224 | GDK_BUTTON_PRESS_MASK
1225 | GDK_BUTTON_RELEASE_MASK
1226 | GDK_KEY_PRESS_MASK
1227 | GDK_ENTER_NOTIFY_MASK
1228 | GDK_LEAVE_NOTIFY_MASK
1229 | GDK_FOCUS_CHANGE_MASK
1230 | GDK_STRUCTURE_MASK
1231 | GDK_VISIBILITY_NOTIFY_MASK);
1233 /* Must realize the windows so the X window gets created. It is used
1234 by callers of this function. */
1235 gtk_widget_realize (wfixed);
1236 FRAME_X_WINDOW (f) = GTK_WIDGET_TO_X_WIN (wfixed);
1238 /* Since GTK clears its window by filling with the background color,
1239 we must keep X and GTK background in sync. */
1240 xg_set_widget_bg (f, wfixed, FRAME_BACKGROUND_PIXEL (f));
1242 #ifndef HAVE_GTK3
1243 /* Also, do not let any background pixmap to be set, this looks very
1244 bad as Emacs overwrites the background pixmap with its own idea
1245 of background color. */
1246 style = gtk_widget_get_modifier_style (wfixed);
1248 /* Must use g_strdup because gtk_widget_modify_style does g_free. */
1249 style->bg_pixmap_name[GTK_STATE_NORMAL] = g_strdup ("<none>");
1250 gtk_widget_modify_style (wfixed, style);
1251 #else
1252 gtk_widget_set_can_focus (wfixed, TRUE);
1253 gtk_window_set_resizable (GTK_WINDOW (wtop), TRUE);
1254 #endif
1256 #ifdef USE_GTK_TOOLTIP
1257 /* Steal a tool tip window we can move ourselves. */
1258 f->output_data.x->ttip_widget = 0;
1259 f->output_data.x->ttip_lbl = 0;
1260 f->output_data.x->ttip_window = 0;
1261 gtk_widget_set_tooltip_text (wtop, "Dummy text");
1262 g_signal_connect (wtop, "query-tooltip", G_CALLBACK (qttip_cb), f);
1263 #endif
1266 GdkScreen *screen = gtk_widget_get_screen (wtop);
1267 GtkSettings *gs = gtk_settings_get_for_screen (screen);
1268 /* Only connect this signal once per screen. */
1269 if (! g_signal_handler_find (G_OBJECT (gs),
1270 G_SIGNAL_MATCH_FUNC,
1271 0, 0, 0,
1272 G_CALLBACK (style_changed_cb),
1275 g_signal_connect (G_OBJECT (gs), "notify::gtk-theme-name",
1276 G_CALLBACK (style_changed_cb),
1277 gdk_screen_get_display (screen));
1281 unblock_input ();
1283 return 1;
1286 void
1287 xg_free_frame_widgets (struct frame *f)
1289 if (FRAME_GTK_OUTER_WIDGET (f))
1291 #ifdef USE_GTK_TOOLTIP
1292 struct x_output *x = f->output_data.x;
1293 #endif
1294 struct xg_frame_tb_info *tbinfo
1295 = g_object_get_data (G_OBJECT (FRAME_GTK_OUTER_WIDGET (f)),
1296 TB_INFO_KEY);
1297 if (tbinfo)
1298 xfree (tbinfo);
1300 gtk_widget_destroy (FRAME_GTK_OUTER_WIDGET (f));
1301 FRAME_X_WINDOW (f) = 0; /* Set to avoid XDestroyWindow in xterm.c */
1302 FRAME_GTK_OUTER_WIDGET (f) = 0;
1303 #ifdef USE_GTK_TOOLTIP
1304 if (x->ttip_lbl)
1305 gtk_widget_destroy (x->ttip_lbl);
1306 if (x->ttip_widget)
1307 g_object_unref (G_OBJECT (x->ttip_widget));
1308 #endif
1312 /* Set the normal size hints for the window manager, for frame F.
1313 FLAGS is the flags word to use--or 0 meaning preserve the flags
1314 that the window now has.
1315 If USER_POSITION, set the User Position
1316 flag (this is useful when FLAGS is 0). */
1318 void
1319 x_wm_set_size_hint (struct frame *f, long int flags, bool user_position)
1321 /* Must use GTK routines here, otherwise GTK resets the size hints
1322 to its own defaults. */
1323 GdkGeometry size_hints;
1324 gint hint_flags = 0;
1325 int base_width, base_height;
1326 int min_rows = 0, min_cols = 0;
1327 int win_gravity = f->win_gravity;
1328 Lisp_Object fs_state, frame;
1330 /* Don't set size hints during initialization; that apparently leads
1331 to a race condition. See the thread at
1332 http://lists.gnu.org/archive/html/emacs-devel/2008-10/msg00033.html */
1333 if (NILP (Vafter_init_time) || !FRAME_GTK_OUTER_WIDGET (f))
1334 return;
1336 XSETFRAME (frame, f);
1337 fs_state = Fframe_parameter (frame, Qfullscreen);
1338 if (EQ (fs_state, Qmaximized) || EQ (fs_state, Qfullboth))
1340 /* Don't set hints when maximized or fullscreen. Apparently KWin and
1341 Gtk3 don't get along and the frame shrinks (!).
1343 return;
1346 if (flags)
1348 memset (&size_hints, 0, sizeof (size_hints));
1349 f->output_data.x->size_hints = size_hints;
1350 f->output_data.x->hint_flags = hint_flags;
1352 else
1353 flags = f->size_hint_flags;
1355 size_hints = f->output_data.x->size_hints;
1356 hint_flags = f->output_data.x->hint_flags;
1358 hint_flags |= GDK_HINT_RESIZE_INC | GDK_HINT_MIN_SIZE;
1359 size_hints.width_inc = frame_resize_pixelwise ? 1 : FRAME_COLUMN_WIDTH (f);
1360 size_hints.height_inc = frame_resize_pixelwise ? 1 : FRAME_LINE_HEIGHT (f);
1362 hint_flags |= GDK_HINT_BASE_SIZE;
1363 /* Use one row/col here so base_height/width does not become zero.
1364 Gtk+ and/or Unity on Ubuntu 12.04 can't handle it. */
1365 base_width = FRAME_TEXT_COLS_TO_PIXEL_WIDTH (f, 1) + FRAME_TOOLBAR_WIDTH (f);
1366 base_height = FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, 1)
1367 + FRAME_MENUBAR_HEIGHT (f) + FRAME_TOOLBAR_HEIGHT (f);
1369 check_frame_size (f, &min_cols, &min_rows, 0);
1370 if (min_cols > 0) --min_cols; /* We used one col in base_width = ... 1); */
1371 if (min_rows > 0) --min_rows; /* We used one row in base_height = ... 1); */
1373 size_hints.base_width = base_width;
1374 size_hints.base_height = base_height;
1375 size_hints.min_width = base_width + min_cols * FRAME_COLUMN_WIDTH (f);;
1376 size_hints.min_height = base_height + min_rows * FRAME_LINE_HEIGHT (f);
1378 /* These currently have a one to one mapping with the X values, but I
1379 don't think we should rely on that. */
1380 hint_flags |= GDK_HINT_WIN_GRAVITY;
1381 size_hints.win_gravity = 0;
1382 if (win_gravity == NorthWestGravity)
1383 size_hints.win_gravity = GDK_GRAVITY_NORTH_WEST;
1384 else if (win_gravity == NorthGravity)
1385 size_hints.win_gravity = GDK_GRAVITY_NORTH;
1386 else if (win_gravity == NorthEastGravity)
1387 size_hints.win_gravity = GDK_GRAVITY_NORTH_EAST;
1388 else if (win_gravity == WestGravity)
1389 size_hints.win_gravity = GDK_GRAVITY_WEST;
1390 else if (win_gravity == CenterGravity)
1391 size_hints.win_gravity = GDK_GRAVITY_CENTER;
1392 else if (win_gravity == EastGravity)
1393 size_hints.win_gravity = GDK_GRAVITY_EAST;
1394 else if (win_gravity == SouthWestGravity)
1395 size_hints.win_gravity = GDK_GRAVITY_SOUTH_WEST;
1396 else if (win_gravity == SouthGravity)
1397 size_hints.win_gravity = GDK_GRAVITY_SOUTH;
1398 else if (win_gravity == SouthEastGravity)
1399 size_hints.win_gravity = GDK_GRAVITY_SOUTH_EAST;
1400 else if (win_gravity == StaticGravity)
1401 size_hints.win_gravity = GDK_GRAVITY_STATIC;
1403 if (user_position)
1405 hint_flags &= ~GDK_HINT_POS;
1406 hint_flags |= GDK_HINT_USER_POS;
1409 if (hint_flags != f->output_data.x->hint_flags
1410 || memcmp (&size_hints,
1411 &f->output_data.x->size_hints,
1412 sizeof (size_hints)) != 0)
1414 block_input ();
1415 gtk_window_set_geometry_hints (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)),
1416 NULL, &size_hints, hint_flags);
1417 f->output_data.x->size_hints = size_hints;
1418 f->output_data.x->hint_flags = hint_flags;
1419 unblock_input ();
1423 /* Change background color of a frame.
1424 Since GTK uses the background color to clear the window, we must
1425 keep the GTK and X colors in sync.
1426 F is the frame to change,
1427 BG is the pixel value to change to. */
1429 void
1430 xg_set_background_color (struct frame *f, unsigned long bg)
1432 if (FRAME_GTK_WIDGET (f))
1434 block_input ();
1435 xg_set_widget_bg (f, FRAME_GTK_WIDGET (f), FRAME_BACKGROUND_PIXEL (f));
1436 unblock_input ();
1441 /* Set the frame icon to ICON_PIXMAP/MASK. This must be done with GTK
1442 functions so GTK does not overwrite the icon. */
1444 void
1445 xg_set_frame_icon (struct frame *f, Pixmap icon_pixmap, Pixmap icon_mask)
1447 GdkPixbuf *gp = xg_get_pixbuf_from_pix_and_mask (f,
1448 icon_pixmap,
1449 icon_mask);
1450 if (gp)
1451 gtk_window_set_icon (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)), gp);
1456 /***********************************************************************
1457 Dialog functions
1458 ***********************************************************************/
1459 /* Return the dialog title to use for a dialog of type KEY.
1460 This is the encoding used by lwlib. We use the same for GTK. */
1462 static const char *
1463 get_dialog_title (char key)
1465 const char *title = "";
1467 switch (key) {
1468 case 'E': case 'e':
1469 title = "Error";
1470 break;
1472 case 'I': case 'i':
1473 title = "Information";
1474 break;
1476 case 'L': case 'l':
1477 title = "Prompt";
1478 break;
1480 case 'P': case 'p':
1481 title = "Prompt";
1482 break;
1484 case 'Q': case 'q':
1485 title = "Question";
1486 break;
1489 return title;
1492 /* Callback for dialogs that get WM_DELETE_WINDOW. We pop down
1493 the dialog, but return TRUE so the event does not propagate further
1494 in GTK. This prevents GTK from destroying the dialog widget automatically
1495 and we can always destroy the widget manually, regardless of how
1496 it was popped down (button press or WM_DELETE_WINDOW).
1497 W is the dialog widget.
1498 EVENT is the GdkEvent that represents WM_DELETE_WINDOW (not used).
1499 user_data is NULL (not used).
1501 Returns TRUE to end propagation of event. */
1503 static gboolean
1504 dialog_delete_callback (GtkWidget *w, GdkEvent *event, gpointer user_data)
1506 gtk_widget_unmap (w);
1507 return TRUE;
1510 /* Create a popup dialog window. See also xg_create_widget below.
1511 WV is a widget_value describing the dialog.
1512 SELECT_CB is the callback to use when a button has been pressed.
1513 DEACTIVATE_CB is the callback to use when the dialog pops down.
1515 Returns the GTK dialog widget. */
1517 static GtkWidget *
1518 create_dialog (widget_value *wv,
1519 GCallback select_cb,
1520 GCallback deactivate_cb)
1522 const char *title = get_dialog_title (wv->name[0]);
1523 int total_buttons = wv->name[1] - '0';
1524 int right_buttons = wv->name[4] - '0';
1525 int left_buttons;
1526 int button_nr = 0;
1527 int button_spacing = 10;
1528 GtkWidget *wdialog = gtk_dialog_new ();
1529 GtkDialog *wd = GTK_DIALOG (wdialog);
1530 GtkBox *cur_box = GTK_BOX (gtk_dialog_get_action_area (wd));
1531 widget_value *item;
1532 GtkWidget *whbox_down;
1534 /* If the number of buttons is greater than 4, make two rows of buttons
1535 instead. This looks better. */
1536 bool make_two_rows = total_buttons > 4;
1538 if (right_buttons == 0) right_buttons = total_buttons/2;
1539 left_buttons = total_buttons - right_buttons;
1541 gtk_window_set_title (GTK_WINDOW (wdialog), title);
1542 gtk_widget_set_name (wdialog, "emacs-dialog");
1545 if (make_two_rows)
1547 GtkWidget *wvbox = gtk_box_new (GTK_ORIENTATION_VERTICAL, button_spacing);
1548 GtkWidget *whbox_up = gtk_box_new (GTK_ORIENTATION_HORIZONTAL, 0);
1549 gtk_box_set_homogeneous (GTK_BOX (wvbox), TRUE);
1550 gtk_box_set_homogeneous (GTK_BOX (whbox_up), FALSE);
1551 whbox_down = gtk_box_new (GTK_ORIENTATION_HORIZONTAL, 0);
1552 gtk_box_set_homogeneous (GTK_BOX (whbox_down), FALSE);
1554 gtk_box_pack_start (cur_box, wvbox, FALSE, FALSE, 0);
1555 gtk_box_pack_start (GTK_BOX (wvbox), whbox_up, FALSE, FALSE, 0);
1556 gtk_box_pack_start (GTK_BOX (wvbox), whbox_down, FALSE, FALSE, 0);
1558 cur_box = GTK_BOX (whbox_up);
1561 g_signal_connect (G_OBJECT (wdialog), "delete-event",
1562 G_CALLBACK (dialog_delete_callback), 0);
1564 if (deactivate_cb)
1566 g_signal_connect (G_OBJECT (wdialog), "close", deactivate_cb, 0);
1567 g_signal_connect (G_OBJECT (wdialog), "response", deactivate_cb, 0);
1570 for (item = wv->contents; item; item = item->next)
1572 char *utf8_label = get_utf8_string (item->value);
1573 GtkWidget *w;
1574 GtkRequisition req;
1576 if (item->name && strcmp (item->name, "message") == 0)
1578 GtkBox *wvbox = GTK_BOX (gtk_dialog_get_content_area (wd));
1579 /* This is the text part of the dialog. */
1580 w = gtk_label_new (utf8_label);
1581 gtk_box_pack_start (wvbox, gtk_label_new (""), FALSE, FALSE, 0);
1582 gtk_box_pack_start (wvbox, w, TRUE, TRUE, 0);
1583 gtk_misc_set_alignment (GTK_MISC (w), 0.1, 0.5);
1585 /* Try to make dialog look better. Must realize first so
1586 the widget can calculate the size it needs. */
1587 gtk_widget_realize (w);
1588 gtk_widget_get_preferred_size (w, NULL, &req);
1589 gtk_box_set_spacing (wvbox, req.height);
1590 if (item->value && strlen (item->value) > 0)
1591 button_spacing = 2*req.width/strlen (item->value);
1593 else
1595 /* This is one button to add to the dialog. */
1596 w = gtk_button_new_with_label (utf8_label);
1597 if (! item->enabled)
1598 gtk_widget_set_sensitive (w, FALSE);
1599 if (select_cb)
1600 g_signal_connect (G_OBJECT (w), "clicked",
1601 select_cb, item->call_data);
1603 gtk_box_pack_start (cur_box, w, TRUE, TRUE, button_spacing);
1604 if (++button_nr == left_buttons)
1606 if (make_two_rows)
1607 cur_box = GTK_BOX (whbox_down);
1608 else
1609 gtk_box_pack_start (cur_box,
1610 gtk_label_new (""),
1611 TRUE, TRUE,
1612 button_spacing);
1616 if (utf8_label)
1617 g_free (utf8_label);
1620 return wdialog;
1623 struct xg_dialog_data
1625 GMainLoop *loop;
1626 int response;
1627 GtkWidget *w;
1628 guint timerid;
1631 /* Function that is called when the file or font dialogs pop down.
1632 W is the dialog widget, RESPONSE is the response code.
1633 USER_DATA is what we passed in to g_signal_connect. */
1635 static void
1636 xg_dialog_response_cb (GtkDialog *w,
1637 gint response,
1638 gpointer user_data)
1640 struct xg_dialog_data *dd = user_data;
1641 dd->response = response;
1642 g_main_loop_quit (dd->loop);
1646 /* Destroy the dialog. This makes it pop down. */
1648 static void
1649 pop_down_dialog (void *arg)
1651 struct xg_dialog_data *dd = arg;
1653 block_input ();
1654 if (dd->w) gtk_widget_destroy (dd->w);
1655 if (dd->timerid != 0) g_source_remove (dd->timerid);
1657 g_main_loop_quit (dd->loop);
1658 g_main_loop_unref (dd->loop);
1660 unblock_input ();
1663 /* If there are any emacs timers pending, add a timeout to main loop in DATA.
1664 We pass in DATA as gpointer* so we can use this as a callback. */
1666 static gboolean
1667 xg_maybe_add_timer (gpointer data)
1669 struct xg_dialog_data *dd = data;
1670 struct timespec next_time = timer_check ();
1672 dd->timerid = 0;
1674 if (timespec_valid_p (next_time))
1676 time_t s = next_time.tv_sec;
1677 int per_ms = TIMESPEC_RESOLUTION / 1000;
1678 int ms = (next_time.tv_nsec + per_ms - 1) / per_ms;
1679 if (s <= ((guint) -1 - ms) / 1000)
1680 dd->timerid = g_timeout_add (s * 1000 + ms, xg_maybe_add_timer, dd);
1682 return FALSE;
1686 /* Pops up a modal dialog W and waits for response.
1687 We don't use gtk_dialog_run because we want to process emacs timers.
1688 The dialog W is not destroyed when this function returns. */
1690 static int
1691 xg_dialog_run (struct frame *f, GtkWidget *w)
1693 ptrdiff_t count = SPECPDL_INDEX ();
1694 struct xg_dialog_data dd;
1696 xg_set_screen (w, f);
1697 gtk_window_set_transient_for (GTK_WINDOW (w),
1698 GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)));
1699 gtk_window_set_destroy_with_parent (GTK_WINDOW (w), TRUE);
1700 gtk_window_set_modal (GTK_WINDOW (w), TRUE);
1702 dd.loop = g_main_loop_new (NULL, FALSE);
1703 dd.response = GTK_RESPONSE_CANCEL;
1704 dd.w = w;
1705 dd.timerid = 0;
1707 g_signal_connect (G_OBJECT (w),
1708 "response",
1709 G_CALLBACK (xg_dialog_response_cb),
1710 &dd);
1711 /* Don't destroy the widget if closed by the window manager close button. */
1712 g_signal_connect (G_OBJECT (w), "delete-event", G_CALLBACK (gtk_true), NULL);
1713 gtk_widget_show (w);
1715 record_unwind_protect_ptr (pop_down_dialog, &dd);
1717 (void) xg_maybe_add_timer (&dd);
1718 g_main_loop_run (dd.loop);
1720 dd.w = 0;
1721 unbind_to (count, Qnil);
1723 return dd.response;
1727 /***********************************************************************
1728 File dialog functions
1729 ***********************************************************************/
1730 /* Return true if the old file selection dialog is being used. */
1732 bool
1733 xg_uses_old_file_dialog (void)
1735 #ifdef HAVE_GTK_FILE_SELECTION_NEW
1736 return x_gtk_use_old_file_dialog;
1737 #else
1738 return 0;
1739 #endif
1743 typedef char * (*xg_get_file_func) (GtkWidget *);
1745 /* Return the selected file for file chooser dialog W.
1746 The returned string must be free:d. */
1748 static char *
1749 xg_get_file_name_from_chooser (GtkWidget *w)
1751 return gtk_file_chooser_get_filename (GTK_FILE_CHOOSER (w));
1754 /* Callback called when the "Show hidden files" toggle is pressed.
1755 WIDGET is the toggle widget, DATA is the file chooser dialog. */
1757 static void
1758 xg_toggle_visibility_cb (GtkWidget *widget, gpointer data)
1760 GtkFileChooser *dialog = GTK_FILE_CHOOSER (data);
1761 gboolean visible;
1762 g_object_get (G_OBJECT (dialog), "show-hidden", &visible, NULL);
1763 g_object_set (G_OBJECT (dialog), "show-hidden", !visible, NULL);
1767 /* Callback called when a property changes in a file chooser.
1768 GOBJECT is the file chooser dialog, ARG1 describes the property.
1769 USER_DATA is the toggle widget in the file chooser dialog.
1770 We use this to update the "Show hidden files" toggle when the user
1771 changes that property by right clicking in the file list. */
1773 static void
1774 xg_toggle_notify_cb (GObject *gobject, GParamSpec *arg1, gpointer user_data)
1776 if (strcmp (arg1->name, "show-hidden") == 0)
1778 GtkWidget *wtoggle = GTK_WIDGET (user_data);
1779 gboolean visible, toggle_on;
1781 g_object_get (G_OBJECT (gobject), "show-hidden", &visible, NULL);
1782 toggle_on = gtk_toggle_button_get_active (GTK_TOGGLE_BUTTON (wtoggle));
1784 if (!!visible != !!toggle_on)
1786 g_signal_handlers_block_by_func (G_OBJECT (wtoggle),
1787 G_CALLBACK (xg_toggle_visibility_cb),
1788 gobject);
1789 gtk_toggle_button_set_active (GTK_TOGGLE_BUTTON (wtoggle), visible);
1790 g_signal_handlers_unblock_by_func
1791 (G_OBJECT (wtoggle),
1792 G_CALLBACK (xg_toggle_visibility_cb),
1793 gobject);
1795 x_gtk_show_hidden_files = visible;
1799 /* Read a file name from the user using a file chooser dialog.
1800 F is the current frame.
1801 PROMPT is a prompt to show to the user. May not be NULL.
1802 DEFAULT_FILENAME is a default selection to be displayed. May be NULL.
1803 If MUSTMATCH_P, the returned file name must be an existing
1804 file. (Actually, this only has cosmetic effects, the user can
1805 still enter a non-existing file.) *FUNC is set to a function that
1806 can be used to retrieve the selected file name from the returned widget.
1808 Returns the created widget. */
1810 static GtkWidget *
1811 xg_get_file_with_chooser (struct frame *f,
1812 char *prompt,
1813 char *default_filename,
1814 bool mustmatch_p, bool only_dir_p,
1815 xg_get_file_func *func)
1817 char msgbuf[1024];
1819 GtkWidget *filewin, *wtoggle, *wbox, *wmessage IF_LINT (= NULL);
1820 GtkWindow *gwin = GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f));
1821 GtkFileChooserAction action = (mustmatch_p ?
1822 GTK_FILE_CHOOSER_ACTION_OPEN :
1823 GTK_FILE_CHOOSER_ACTION_SAVE);
1825 if (only_dir_p)
1826 action = GTK_FILE_CHOOSER_ACTION_SELECT_FOLDER;
1828 filewin = gtk_file_chooser_dialog_new (prompt, gwin, action,
1829 GTK_STOCK_CANCEL, GTK_RESPONSE_CANCEL,
1830 (mustmatch_p || only_dir_p ?
1831 GTK_STOCK_OPEN : GTK_STOCK_OK),
1832 GTK_RESPONSE_OK,
1833 NULL);
1834 gtk_file_chooser_set_local_only (GTK_FILE_CHOOSER (filewin), TRUE);
1836 wbox = gtk_box_new (GTK_ORIENTATION_VERTICAL, 0);
1837 gtk_box_set_homogeneous (GTK_BOX (wbox), FALSE);
1838 gtk_widget_show (wbox);
1839 wtoggle = gtk_check_button_new_with_label ("Show hidden files.");
1841 if (x_gtk_show_hidden_files)
1843 g_object_set (G_OBJECT (filewin), "show-hidden", TRUE, NULL);
1844 gtk_toggle_button_set_active (GTK_TOGGLE_BUTTON (wtoggle), TRUE);
1846 gtk_widget_show (wtoggle);
1847 g_signal_connect (G_OBJECT (wtoggle), "clicked",
1848 G_CALLBACK (xg_toggle_visibility_cb), filewin);
1849 g_signal_connect (G_OBJECT (filewin), "notify",
1850 G_CALLBACK (xg_toggle_notify_cb), wtoggle);
1852 if (x_gtk_file_dialog_help_text)
1854 msgbuf[0] = '\0';
1855 /* Gtk+ 2.10 has the file name text entry box integrated in the dialog.
1856 Show the C-l help text only for versions < 2.10. */
1857 if (gtk_check_version (2, 10, 0) && action != GTK_FILE_CHOOSER_ACTION_SAVE)
1858 strcat (msgbuf, "\nType C-l to display a file name text entry box.\n");
1859 strcat (msgbuf, "\nIf you don't like this file selector, use the "
1860 "corresponding\nkey binding or customize "
1861 "use-file-dialog to turn it off.");
1863 wmessage = gtk_label_new (msgbuf);
1864 gtk_widget_show (wmessage);
1867 gtk_box_pack_start (GTK_BOX (wbox), wtoggle, FALSE, FALSE, 0);
1868 if (x_gtk_file_dialog_help_text)
1869 gtk_box_pack_start (GTK_BOX (wbox), wmessage, FALSE, FALSE, 0);
1870 gtk_file_chooser_set_extra_widget (GTK_FILE_CHOOSER (filewin), wbox);
1872 if (default_filename)
1874 Lisp_Object file;
1875 struct gcpro gcpro1;
1876 char *utf8_filename;
1877 GCPRO1 (file);
1879 file = build_string (default_filename);
1881 /* File chooser does not understand ~/... in the file name. It must be
1882 an absolute name starting with /. */
1883 if (default_filename[0] != '/')
1884 file = Fexpand_file_name (file, Qnil);
1886 utf8_filename = SSDATA (ENCODE_UTF_8 (file));
1887 if (! NILP (Ffile_directory_p (file)))
1888 gtk_file_chooser_set_current_folder (GTK_FILE_CHOOSER (filewin),
1889 utf8_filename);
1890 else
1892 gtk_file_chooser_set_filename (GTK_FILE_CHOOSER (filewin),
1893 utf8_filename);
1894 if (action == GTK_FILE_CHOOSER_ACTION_SAVE)
1896 char *cp = strrchr (utf8_filename, '/');
1897 if (cp) ++cp;
1898 else cp = utf8_filename;
1899 gtk_file_chooser_set_current_name (GTK_FILE_CHOOSER (filewin), cp);
1903 UNGCPRO;
1906 *func = xg_get_file_name_from_chooser;
1907 return filewin;
1910 #ifdef HAVE_GTK_FILE_SELECTION_NEW
1912 /* Return the selected file for file selector dialog W.
1913 The returned string must be free:d. */
1915 static char *
1916 xg_get_file_name_from_selector (GtkWidget *w)
1918 GtkFileSelection *filesel = GTK_FILE_SELECTION (w);
1919 return xstrdup (gtk_file_selection_get_filename (filesel));
1922 /* Create a file selection dialog.
1923 F is the current frame.
1924 PROMPT is a prompt to show to the user. May not be NULL.
1925 DEFAULT_FILENAME is a default selection to be displayed. May be NULL.
1926 If MUSTMATCH_P, the returned file name must be an existing
1927 file. *FUNC is set to a function that can be used to retrieve the
1928 selected file name from the returned widget.
1930 Returns the created widget. */
1932 static GtkWidget *
1933 xg_get_file_with_selection (struct frame *f,
1934 char *prompt,
1935 char *default_filename,
1936 bool mustmatch_p, bool only_dir_p,
1937 xg_get_file_func *func)
1939 GtkWidget *filewin;
1940 GtkFileSelection *filesel;
1942 filewin = gtk_file_selection_new (prompt);
1943 filesel = GTK_FILE_SELECTION (filewin);
1945 if (default_filename)
1946 gtk_file_selection_set_filename (filesel, default_filename);
1948 if (mustmatch_p)
1950 /* The selection_entry part of filesel is not documented. */
1951 gtk_widget_set_sensitive (filesel->selection_entry, FALSE);
1952 gtk_file_selection_hide_fileop_buttons (filesel);
1955 *func = xg_get_file_name_from_selector;
1957 return filewin;
1959 #endif /* HAVE_GTK_FILE_SELECTION_NEW */
1961 /* Read a file name from the user using a file dialog, either the old
1962 file selection dialog, or the new file chooser dialog. Which to use
1963 depends on what the GTK version used has, and what the value of
1964 gtk-use-old-file-dialog.
1965 F is the current frame.
1966 PROMPT is a prompt to show to the user. May not be NULL.
1967 DEFAULT_FILENAME is a default selection to be displayed. May be NULL.
1968 If MUSTMATCH_P, the returned file name must be an existing
1969 file.
1971 Returns a file name or NULL if no file was selected.
1972 The returned string must be freed by the caller. */
1974 char *
1975 xg_get_file_name (struct frame *f,
1976 char *prompt,
1977 char *default_filename,
1978 bool mustmatch_p,
1979 bool only_dir_p)
1981 GtkWidget *w = 0;
1982 char *fn = 0;
1983 int filesel_done = 0;
1984 xg_get_file_func func;
1986 #ifdef HAVE_GTK_FILE_SELECTION_NEW
1988 if (xg_uses_old_file_dialog ())
1989 w = xg_get_file_with_selection (f, prompt, default_filename,
1990 mustmatch_p, only_dir_p, &func);
1991 else
1992 w = xg_get_file_with_chooser (f, prompt, default_filename,
1993 mustmatch_p, only_dir_p, &func);
1995 #else /* not HAVE_GTK_FILE_SELECTION_NEW */
1996 w = xg_get_file_with_chooser (f, prompt, default_filename,
1997 mustmatch_p, only_dir_p, &func);
1998 #endif /* not HAVE_GTK_FILE_SELECTION_NEW */
2000 gtk_widget_set_name (w, "emacs-filedialog");
2002 filesel_done = xg_dialog_run (f, w);
2003 if (filesel_done == GTK_RESPONSE_OK)
2004 fn = (*func) (w);
2006 gtk_widget_destroy (w);
2007 return fn;
2010 /***********************************************************************
2011 GTK font chooser
2012 ***********************************************************************/
2014 #ifdef HAVE_FREETYPE
2016 #if USE_NEW_GTK_FONT_CHOOSER
2018 #define XG_WEIGHT_TO_SYMBOL(w) \
2019 (w <= PANGO_WEIGHT_THIN ? Qextra_light \
2020 : w <= PANGO_WEIGHT_ULTRALIGHT ? Qlight \
2021 : w <= PANGO_WEIGHT_LIGHT ? Qsemi_light \
2022 : w < PANGO_WEIGHT_MEDIUM ? Qnormal \
2023 : w <= PANGO_WEIGHT_SEMIBOLD ? Qsemi_bold \
2024 : w <= PANGO_WEIGHT_BOLD ? Qbold \
2025 : w <= PANGO_WEIGHT_HEAVY ? Qextra_bold \
2026 : Qultra_bold)
2028 #define XG_STYLE_TO_SYMBOL(s) \
2029 (s == PANGO_STYLE_OBLIQUE ? Qoblique \
2030 : s == PANGO_STYLE_ITALIC ? Qitalic \
2031 : Qnormal)
2033 #endif /* USE_NEW_GTK_FONT_CHOOSER */
2036 static char *x_last_font_name;
2038 /* Pop up a GTK font selector and return the name of the font the user
2039 selects, as a C string. The returned font name follows GTK's own
2040 format:
2042 `FAMILY [VALUE1 VALUE2] SIZE'
2044 This can be parsed using font_parse_fcname in font.c.
2045 DEFAULT_NAME, if non-zero, is the default font name. */
2047 Lisp_Object
2048 xg_get_font (struct frame *f, const char *default_name)
2050 GtkWidget *w;
2051 int done = 0;
2052 Lisp_Object font = Qnil;
2054 w = gtk_font_chooser_dialog_new
2055 ("Pick a font", GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)));
2057 if (default_name)
2059 /* Convert fontconfig names to Gtk names, i.e. remove - before
2060 number */
2061 char *p = strrchr (default_name, '-');
2062 if (p)
2064 char *ep = p+1;
2065 while (c_isdigit (*ep))
2066 ++ep;
2067 if (*ep == '\0') *p = ' ';
2070 else if (x_last_font_name)
2071 default_name = x_last_font_name;
2073 if (default_name)
2074 gtk_font_chooser_set_font (GTK_FONT_CHOOSER (w), default_name);
2076 gtk_widget_set_name (w, "emacs-fontdialog");
2077 done = xg_dialog_run (f, w);
2078 if (done == GTK_RESPONSE_OK)
2080 #if USE_NEW_GTK_FONT_CHOOSER
2081 /* Use the GTK3 font chooser. */
2082 PangoFontDescription *desc
2083 = gtk_font_chooser_get_font_desc (GTK_FONT_CHOOSER (w));
2085 if (desc)
2087 Lisp_Object args[10];
2088 const char *name = pango_font_description_get_family (desc);
2089 gint size = pango_font_description_get_size (desc);
2090 PangoWeight weight = pango_font_description_get_weight (desc);
2091 PangoStyle style = pango_font_description_get_style (desc);
2093 args[0] = QCname;
2094 args[1] = build_string (name);
2096 args[2] = QCsize;
2097 args[3] = make_float (pango_units_to_double (size));
2099 args[4] = QCweight;
2100 args[5] = XG_WEIGHT_TO_SYMBOL (weight);
2102 args[6] = QCslant;
2103 args[7] = XG_STYLE_TO_SYMBOL (style);
2105 args[8] = QCtype;
2106 args[9] = Qxft;
2108 font = Ffont_spec (10, args);
2110 pango_font_description_free (desc);
2111 dupstring (&x_last_font_name, name);
2114 #else /* Use old font selector, which just returns the font name. */
2116 char *font_name
2117 = gtk_font_selection_dialog_get_font_name (GTK_FONT_CHOOSER (w));
2119 if (font_name)
2121 font = build_string (font_name);
2122 g_free (x_last_font_name);
2123 x_last_font_name = font_name;
2125 #endif /* USE_NEW_GTK_FONT_CHOOSER */
2128 gtk_widget_destroy (w);
2129 return font;
2131 #endif /* HAVE_FREETYPE */
2135 /***********************************************************************
2136 Menu functions.
2137 ***********************************************************************/
2139 /* The name of menu items that can be used for customization. Since GTK
2140 RC files are very crude and primitive, we have to set this on all
2141 menu item names so a user can easily customize menu items. */
2143 #define MENU_ITEM_NAME "emacs-menuitem"
2146 /* Linked list of all allocated struct xg_menu_cb_data. Used for marking
2147 during GC. The next member points to the items. */
2148 static xg_list_node xg_menu_cb_list;
2150 /* Linked list of all allocated struct xg_menu_item_cb_data. Used for marking
2151 during GC. The next member points to the items. */
2152 static xg_list_node xg_menu_item_cb_list;
2154 /* Allocate and initialize CL_DATA if NULL, otherwise increase ref_count.
2155 F is the frame CL_DATA will be initialized for.
2156 HIGHLIGHT_CB is the callback to call when entering/leaving menu items.
2158 The menu bar and all sub menus under the menu bar in a frame
2159 share the same structure, hence the reference count.
2161 Returns CL_DATA if CL_DATA is not NULL, or a pointer to a newly
2162 allocated xg_menu_cb_data if CL_DATA is NULL. */
2164 static xg_menu_cb_data *
2165 make_cl_data (xg_menu_cb_data *cl_data, struct frame *f, GCallback highlight_cb)
2167 if (! cl_data)
2169 cl_data = xmalloc (sizeof *cl_data);
2170 cl_data->f = f;
2171 cl_data->menu_bar_vector = f->menu_bar_vector;
2172 cl_data->menu_bar_items_used = f->menu_bar_items_used;
2173 cl_data->highlight_cb = highlight_cb;
2174 cl_data->ref_count = 0;
2176 xg_list_insert (&xg_menu_cb_list, &cl_data->ptrs);
2179 cl_data->ref_count++;
2181 return cl_data;
2184 /* Update CL_DATA with values from frame F and with HIGHLIGHT_CB.
2185 HIGHLIGHT_CB is the callback to call when entering/leaving menu items.
2187 When the menu bar is updated, menu items may have been added and/or
2188 removed, so menu_bar_vector and menu_bar_items_used change. We must
2189 then update CL_DATA since it is used to determine which menu
2190 item that is invoked in the menu.
2191 HIGHLIGHT_CB could change, there is no check that the same
2192 function is given when modifying a menu bar as was given when
2193 creating the menu bar. */
2195 static void
2196 update_cl_data (xg_menu_cb_data *cl_data,
2197 struct frame *f,
2198 GCallback highlight_cb)
2200 if (cl_data)
2202 cl_data->f = f;
2203 cl_data->menu_bar_vector = f->menu_bar_vector;
2204 cl_data->menu_bar_items_used = f->menu_bar_items_used;
2205 cl_data->highlight_cb = highlight_cb;
2209 /* Decrease reference count for CL_DATA.
2210 If reference count is zero, free CL_DATA. */
2212 static void
2213 unref_cl_data (xg_menu_cb_data *cl_data)
2215 if (cl_data && cl_data->ref_count > 0)
2217 cl_data->ref_count--;
2218 if (cl_data->ref_count == 0)
2220 xg_list_remove (&xg_menu_cb_list, &cl_data->ptrs);
2221 xfree (cl_data);
2226 /* Function that marks all lisp data during GC. */
2228 void
2229 xg_mark_data (void)
2231 xg_list_node *iter;
2232 Lisp_Object rest, frame;
2234 for (iter = xg_menu_cb_list.next; iter; iter = iter->next)
2235 mark_object (((xg_menu_cb_data *) iter)->menu_bar_vector);
2237 for (iter = xg_menu_item_cb_list.next; iter; iter = iter->next)
2239 xg_menu_item_cb_data *cb_data = (xg_menu_item_cb_data *) iter;
2241 if (! NILP (cb_data->help))
2242 mark_object (cb_data->help);
2245 FOR_EACH_FRAME (rest, frame)
2247 struct frame *f = XFRAME (frame);
2249 if (FRAME_X_P (f) && FRAME_GTK_OUTER_WIDGET (f))
2251 struct xg_frame_tb_info *tbinfo
2252 = g_object_get_data (G_OBJECT (FRAME_GTK_OUTER_WIDGET (f)),
2253 TB_INFO_KEY);
2254 if (tbinfo)
2256 mark_object (tbinfo->last_tool_bar);
2257 mark_object (tbinfo->style);
2264 /* Callback called when a menu item is destroyed. Used to free data.
2265 W is the widget that is being destroyed (not used).
2266 CLIENT_DATA points to the xg_menu_item_cb_data associated with the W. */
2268 static void
2269 menuitem_destroy_callback (GtkWidget *w, gpointer client_data)
2271 if (client_data)
2273 xg_menu_item_cb_data *data = client_data;
2274 xg_list_remove (&xg_menu_item_cb_list, &data->ptrs);
2275 xfree (data);
2279 /* Callback called when the pointer enters/leaves a menu item.
2280 W is the parent of the menu item.
2281 EVENT is either an enter event or leave event.
2282 CLIENT_DATA is not used.
2284 Returns FALSE to tell GTK to keep processing this event. */
2286 static gboolean
2287 menuitem_highlight_callback (GtkWidget *w,
2288 GdkEventCrossing *event,
2289 gpointer client_data)
2291 GdkEvent ev;
2292 GtkWidget *subwidget;
2293 xg_menu_item_cb_data *data;
2295 ev.crossing = *event;
2296 subwidget = gtk_get_event_widget (&ev);
2297 data = g_object_get_data (G_OBJECT (subwidget), XG_ITEM_DATA);
2298 if (data)
2300 if (! NILP (data->help) && data->cl_data->highlight_cb)
2302 gpointer call_data = event->type == GDK_LEAVE_NOTIFY ? 0 : data;
2303 GtkCallback func = (GtkCallback) data->cl_data->highlight_cb;
2304 (*func) (subwidget, call_data);
2308 return FALSE;
2311 /* Callback called when a menu is destroyed. Used to free data.
2312 W is the widget that is being destroyed (not used).
2313 CLIENT_DATA points to the xg_menu_cb_data associated with W. */
2315 static void
2316 menu_destroy_callback (GtkWidget *w, gpointer client_data)
2318 unref_cl_data (client_data);
2321 /* Make a GTK widget that contains both UTF8_LABEL and UTF8_KEY (both
2322 must be non-NULL) and can be inserted into a menu item.
2324 Returns the GtkHBox. */
2326 static GtkWidget *
2327 make_widget_for_menu_item (const char *utf8_label, const char *utf8_key)
2329 GtkWidget *wlbl;
2330 GtkWidget *wkey;
2331 GtkWidget *wbox;
2333 wbox = gtk_box_new (GTK_ORIENTATION_HORIZONTAL, 0);
2334 gtk_box_set_homogeneous (GTK_BOX (wbox), FALSE);
2335 wlbl = gtk_label_new (utf8_label);
2336 wkey = gtk_label_new (utf8_key);
2338 gtk_misc_set_alignment (GTK_MISC (wlbl), 0.0, 0.5);
2339 gtk_misc_set_alignment (GTK_MISC (wkey), 0.0, 0.5);
2341 gtk_box_pack_start (GTK_BOX (wbox), wlbl, TRUE, TRUE, 0);
2342 gtk_box_pack_start (GTK_BOX (wbox), wkey, FALSE, FALSE, 0);
2344 gtk_widget_set_name (wlbl, MENU_ITEM_NAME);
2345 gtk_widget_set_name (wkey, MENU_ITEM_NAME);
2346 gtk_widget_set_name (wbox, MENU_ITEM_NAME);
2348 return wbox;
2351 /* Make and return a menu item widget with the key to the right.
2352 UTF8_LABEL is the text for the menu item (GTK uses UTF8 internally).
2353 UTF8_KEY is the text representing the key binding.
2354 ITEM is the widget_value describing the menu item.
2356 GROUP is an in/out parameter. If the menu item to be created is not
2357 part of any radio menu group, *GROUP contains NULL on entry and exit.
2358 If the menu item to be created is part of a radio menu group, on entry
2359 *GROUP contains the group to use, or NULL if this is the first item
2360 in the group. On exit, *GROUP contains the radio item group.
2362 Unfortunately, keys don't line up as nicely as in Motif,
2363 but the MacOS X version doesn't either, so I guess that is OK. */
2365 static GtkWidget *
2366 make_menu_item (const char *utf8_label,
2367 const char *utf8_key,
2368 widget_value *item,
2369 GSList **group)
2371 GtkWidget *w;
2372 GtkWidget *wtoadd = 0;
2374 /* It has been observed that some menu items have a NULL name field.
2375 This will lead to this function being called with a NULL utf8_label.
2376 GTK crashes on that so we set a blank label. Why there is a NULL
2377 name remains to be investigated. */
2378 if (! utf8_label) utf8_label = " ";
2380 if (utf8_key)
2381 wtoadd = make_widget_for_menu_item (utf8_label, utf8_key);
2383 if (item->button_type == BUTTON_TYPE_TOGGLE)
2385 *group = NULL;
2386 if (utf8_key) w = gtk_check_menu_item_new ();
2387 else w = gtk_check_menu_item_new_with_label (utf8_label);
2388 gtk_check_menu_item_set_active (GTK_CHECK_MENU_ITEM (w), item->selected);
2390 else if (item->button_type == BUTTON_TYPE_RADIO)
2392 if (utf8_key) w = gtk_radio_menu_item_new (*group);
2393 else w = gtk_radio_menu_item_new_with_label (*group, utf8_label);
2394 *group = gtk_radio_menu_item_get_group (GTK_RADIO_MENU_ITEM (w));
2395 if (item->selected)
2396 gtk_check_menu_item_set_active (GTK_CHECK_MENU_ITEM (w), TRUE);
2398 else
2400 *group = NULL;
2401 if (utf8_key) w = gtk_menu_item_new ();
2402 else w = gtk_menu_item_new_with_label (utf8_label);
2405 if (wtoadd) gtk_container_add (GTK_CONTAINER (w), wtoadd);
2406 if (! item->enabled) gtk_widget_set_sensitive (w, FALSE);
2408 return w;
2411 #ifdef HAVE_GTK_TEAROFF_MENU_ITEM_NEW
2413 static int xg_detached_menus;
2415 /* Return true if there are detached menus. */
2417 bool
2418 xg_have_tear_offs (struct frame *f)
2420 /* If the frame's menubar height is zero, the menu bar is probably
2421 being redirected outside the window to some kind of global menu;
2422 this situation is the moral equivalent of a tear-off. */
2423 return FRAME_MENUBAR_HEIGHT (f) == 0 || xg_detached_menus > 0;
2426 /* Callback invoked when a detached menu window is removed. Here we
2427 decrease the xg_detached_menus count.
2428 WIDGET is the top level window that is removed (the parent of the menu).
2429 CLIENT_DATA is not used. */
2431 static void
2432 tearoff_remove (GtkWidget *widget, gpointer client_data)
2434 if (xg_detached_menus > 0) --xg_detached_menus;
2437 /* Callback invoked when a menu is detached. It increases the
2438 xg_detached_menus count.
2439 WIDGET is the GtkTearoffMenuItem.
2440 CLIENT_DATA is not used. */
2442 static void
2443 tearoff_activate (GtkWidget *widget, gpointer client_data)
2445 GtkWidget *menu = gtk_widget_get_parent (widget);
2446 if (gtk_menu_get_tearoff_state (GTK_MENU (menu)))
2448 ++xg_detached_menus;
2449 g_signal_connect (G_OBJECT (gtk_widget_get_toplevel (widget)),
2450 "destroy",
2451 G_CALLBACK (tearoff_remove), 0);
2454 #else /* ! HAVE_GTK_TEAROFF_MENU_ITEM_NEW */
2455 bool
2456 xg_have_tear_offs (struct frame *f)
2458 return FRAME_MENUBAR_HEIGHT (f) == 0;
2460 #endif /* ! HAVE_GTK_TEAROFF_MENU_ITEM_NEW */
2462 /* Create a menu item widget, and connect the callbacks.
2463 ITEM describes the menu item.
2464 F is the frame the created menu belongs to.
2465 SELECT_CB is the callback to use when a menu item is selected.
2466 HIGHLIGHT_CB is the callback to call when entering/leaving menu items.
2467 CL_DATA points to the callback data to be used for this menu.
2468 GROUP is an in/out parameter. If the menu item to be created is not
2469 part of any radio menu group, *GROUP contains NULL on entry and exit.
2470 If the menu item to be created is part of a radio menu group, on entry
2471 *GROUP contains the group to use, or NULL if this is the first item
2472 in the group. On exit, *GROUP contains the radio item group.
2474 Returns the created GtkWidget. */
2476 static GtkWidget *
2477 xg_create_one_menuitem (widget_value *item,
2478 struct frame *f,
2479 GCallback select_cb,
2480 GCallback highlight_cb,
2481 xg_menu_cb_data *cl_data,
2482 GSList **group)
2484 char *utf8_label;
2485 char *utf8_key;
2486 GtkWidget *w;
2487 xg_menu_item_cb_data *cb_data;
2489 utf8_label = get_utf8_string (item->name);
2490 utf8_key = get_utf8_string (item->key);
2492 w = make_menu_item (utf8_label, utf8_key, item, group);
2494 if (utf8_label) g_free (utf8_label);
2495 if (utf8_key) g_free (utf8_key);
2497 cb_data = xmalloc (sizeof *cb_data);
2499 xg_list_insert (&xg_menu_item_cb_list, &cb_data->ptrs);
2501 cb_data->select_id = 0;
2502 cb_data->help = item->help;
2503 cb_data->cl_data = cl_data;
2504 cb_data->call_data = item->call_data;
2506 g_signal_connect (G_OBJECT (w),
2507 "destroy",
2508 G_CALLBACK (menuitem_destroy_callback),
2509 cb_data);
2511 /* Put cb_data in widget, so we can get at it when modifying menubar */
2512 g_object_set_data (G_OBJECT (w), XG_ITEM_DATA, cb_data);
2514 /* final item, not a submenu */
2515 if (item->call_data && ! item->contents)
2517 if (select_cb)
2518 cb_data->select_id
2519 = g_signal_connect (G_OBJECT (w), "activate", select_cb, cb_data);
2522 return w;
2525 /* Create a full menu tree specified by DATA.
2526 F is the frame the created menu belongs to.
2527 SELECT_CB is the callback to use when a menu item is selected.
2528 DEACTIVATE_CB is the callback to use when a sub menu is not shown anymore.
2529 HIGHLIGHT_CB is the callback to call when entering/leaving menu items.
2530 If POP_UP_P, create a popup menu.
2531 If MENU_BAR_P, create a menu bar.
2532 If ADD_TEAROFF_P, add a tearoff menu item. Ignored if MENU_BAR_P or
2533 the Gtk+ version used does not have tearoffs.
2534 TOPMENU is the topmost GtkWidget that others shall be placed under.
2535 It may be NULL, in that case we create the appropriate widget
2536 (menu bar or menu item depending on POP_UP_P and MENU_BAR_P)
2537 CL_DATA is the callback data we shall use for this menu, or NULL
2538 if we haven't set the first callback yet.
2539 NAME is the name to give to the top level menu if this function
2540 creates it. May be NULL to not set any name.
2542 Returns the top level GtkWidget. This is TOPLEVEL if TOPLEVEL is
2543 not NULL.
2545 This function calls itself to create submenus. */
2547 static GtkWidget *
2548 create_menus (widget_value *data,
2549 struct frame *f,
2550 GCallback select_cb,
2551 GCallback deactivate_cb,
2552 GCallback highlight_cb,
2553 bool pop_up_p,
2554 bool menu_bar_p,
2555 bool add_tearoff_p,
2556 GtkWidget *topmenu,
2557 xg_menu_cb_data *cl_data,
2558 const char *name)
2560 widget_value *item;
2561 GtkWidget *wmenu = topmenu;
2562 GSList *group = NULL;
2564 if (! topmenu)
2566 if (! menu_bar_p)
2568 wmenu = gtk_menu_new ();
2569 xg_set_screen (wmenu, f);
2570 /* Connect this to the menu instead of items so we get enter/leave for
2571 disabled items also. TODO: Still does not get enter/leave for
2572 disabled items in detached menus. */
2573 g_signal_connect (G_OBJECT (wmenu),
2574 "enter-notify-event",
2575 G_CALLBACK (menuitem_highlight_callback),
2576 NULL);
2577 g_signal_connect (G_OBJECT (wmenu),
2578 "leave-notify-event",
2579 G_CALLBACK (menuitem_highlight_callback),
2580 NULL);
2582 else
2584 wmenu = gtk_menu_bar_new ();
2585 /* Set width of menu bar to a small value so it doesn't enlarge
2586 a small initial frame size. The width will be set to the
2587 width of the frame later on when it is added to a container.
2588 height -1: Natural height. */
2589 gtk_widget_set_size_request (wmenu, 1, -1);
2592 /* Put cl_data on the top menu for easier access. */
2593 cl_data = make_cl_data (cl_data, f, highlight_cb);
2594 g_object_set_data (G_OBJECT (wmenu), XG_FRAME_DATA, (gpointer)cl_data);
2595 g_signal_connect (G_OBJECT (wmenu), "destroy",
2596 G_CALLBACK (menu_destroy_callback), cl_data);
2598 if (name)
2599 gtk_widget_set_name (wmenu, name);
2601 if (deactivate_cb)
2602 g_signal_connect (G_OBJECT (wmenu),
2603 "selection-done", deactivate_cb, 0);
2606 #ifdef HAVE_GTK_TEAROFF_MENU_ITEM_NEW
2607 if (! menu_bar_p && add_tearoff_p)
2609 GtkWidget *tearoff = gtk_tearoff_menu_item_new ();
2610 gtk_menu_shell_append (GTK_MENU_SHELL (wmenu), tearoff);
2612 g_signal_connect (G_OBJECT (tearoff), "activate",
2613 G_CALLBACK (tearoff_activate), 0);
2615 #endif
2617 for (item = data; item; item = item->next)
2619 GtkWidget *w;
2621 if (pop_up_p && !item->contents && !item->call_data
2622 && !menu_separator_name_p (item->name))
2624 char *utf8_label;
2625 /* A title for a popup. We do the same as GTK does when
2626 creating titles, but it does not look good. */
2627 group = NULL;
2628 utf8_label = get_utf8_string (item->name);
2630 gtk_menu_set_title (GTK_MENU (wmenu), utf8_label);
2631 w = gtk_menu_item_new_with_label (utf8_label);
2632 gtk_widget_set_sensitive (w, FALSE);
2633 if (utf8_label) g_free (utf8_label);
2635 else if (menu_separator_name_p (item->name))
2637 group = NULL;
2638 /* GTK only have one separator type. */
2639 w = gtk_separator_menu_item_new ();
2641 else
2643 w = xg_create_one_menuitem (item,
2645 item->contents ? 0 : select_cb,
2646 highlight_cb,
2647 cl_data,
2648 &group);
2650 /* Create a possibly empty submenu for menu bar items, since some
2651 themes don't highlight items correctly without it. */
2652 if (item->contents || menu_bar_p)
2654 GtkWidget *submenu = create_menus (item->contents,
2656 select_cb,
2657 deactivate_cb,
2658 highlight_cb,
2661 add_tearoff_p,
2663 cl_data,
2665 gtk_menu_item_set_submenu (GTK_MENU_ITEM (w), submenu);
2669 gtk_menu_shell_append (GTK_MENU_SHELL (wmenu), w);
2670 gtk_widget_set_name (w, MENU_ITEM_NAME);
2673 return wmenu;
2676 /* Create a menubar, popup menu or dialog, depending on the TYPE argument.
2677 TYPE can be "menubar", "popup" for popup menu, or "dialog" for a dialog
2678 with some text and buttons.
2679 F is the frame the created item belongs to.
2680 NAME is the name to use for the top widget.
2681 VAL is a widget_value structure describing items to be created.
2682 SELECT_CB is the callback to use when a menu item is selected or
2683 a dialog button is pressed.
2684 DEACTIVATE_CB is the callback to use when an item is deactivated.
2685 For a menu, when a sub menu is not shown anymore, for a dialog it is
2686 called when the dialog is popped down.
2687 HIGHLIGHT_CB is the callback to call when entering/leaving menu items.
2689 Returns the widget created. */
2691 GtkWidget *
2692 xg_create_widget (const char *type, const char *name, struct frame *f,
2693 widget_value *val, GCallback select_cb,
2694 GCallback deactivate_cb, GCallback highlight_cb)
2696 GtkWidget *w = 0;
2697 bool menu_bar_p = strcmp (type, "menubar") == 0;
2698 bool pop_up_p = strcmp (type, "popup") == 0;
2700 if (strcmp (type, "dialog") == 0)
2702 w = create_dialog (val, select_cb, deactivate_cb);
2703 xg_set_screen (w, f);
2704 gtk_window_set_transient_for (GTK_WINDOW (w),
2705 GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)));
2706 gtk_window_set_destroy_with_parent (GTK_WINDOW (w), TRUE);
2707 gtk_widget_set_name (w, "emacs-dialog");
2708 gtk_window_set_modal (GTK_WINDOW (w), TRUE);
2710 else if (menu_bar_p || pop_up_p)
2712 w = create_menus (val->contents,
2714 select_cb,
2715 deactivate_cb,
2716 highlight_cb,
2717 pop_up_p,
2718 menu_bar_p,
2719 menu_bar_p,
2722 name);
2724 /* Set the cursor to an arrow for popup menus when they are mapped.
2725 This is done by default for menu bar menus. */
2726 if (pop_up_p)
2728 /* Must realize so the GdkWindow inside the widget is created. */
2729 gtk_widget_realize (w);
2730 xg_set_cursor (w, FRAME_DISPLAY_INFO (f)->xg_cursor);
2733 else
2735 fprintf (stderr, "bad type in xg_create_widget: %s, doing nothing\n",
2736 type);
2739 return w;
2742 /* Return the label for menu item WITEM. */
2744 static const char *
2745 xg_get_menu_item_label (GtkMenuItem *witem)
2747 GtkLabel *wlabel = GTK_LABEL (XG_BIN_CHILD (witem));
2748 return gtk_label_get_label (wlabel);
2751 /* Return true if the menu item WITEM has the text LABEL. */
2753 static bool
2754 xg_item_label_same_p (GtkMenuItem *witem, const char *label)
2756 bool is_same = 0;
2757 char *utf8_label = get_utf8_string (label);
2758 const char *old_label = witem ? xg_get_menu_item_label (witem) : 0;
2760 if (! old_label && ! utf8_label)
2761 is_same = 1;
2762 else if (old_label && utf8_label)
2763 is_same = strcmp (utf8_label, old_label) == 0;
2765 if (utf8_label) g_free (utf8_label);
2767 return is_same;
2770 /* Destroy widgets in LIST. */
2772 static void
2773 xg_destroy_widgets (GList *list)
2775 GList *iter;
2777 for (iter = list; iter; iter = g_list_next (iter))
2779 GtkWidget *w = GTK_WIDGET (iter->data);
2781 /* Destroying the widget will remove it from the container it is in. */
2782 gtk_widget_destroy (w);
2786 /* Update the top level names in MENUBAR (i.e. not submenus).
2787 F is the frame the menu bar belongs to.
2788 *LIST is a list with the current menu bar names (menu item widgets).
2789 ITER is the item within *LIST that shall be updated.
2790 POS is the numerical position, starting at 0, of ITER in *LIST.
2791 VAL describes what the menu bar shall look like after the update.
2792 SELECT_CB is the callback to use when a menu item is selected.
2793 HIGHLIGHT_CB is the callback to call when entering/leaving menu items.
2794 CL_DATA points to the callback data to be used for this menu bar.
2796 This function calls itself to walk through the menu bar names. */
2798 static void
2799 xg_update_menubar (GtkWidget *menubar,
2800 struct frame *f,
2801 GList **list,
2802 GList *iter,
2803 int pos,
2804 widget_value *val,
2805 GCallback select_cb,
2806 GCallback deactivate_cb,
2807 GCallback highlight_cb,
2808 xg_menu_cb_data *cl_data)
2810 if (! iter && ! val)
2811 return;
2812 else if (iter && ! val)
2814 /* Item(s) have been removed. Remove all remaining items. */
2815 xg_destroy_widgets (iter);
2817 /* Add a blank entry so the menubar doesn't collapse to nothing. */
2818 gtk_menu_shell_insert (GTK_MENU_SHELL (menubar),
2819 gtk_menu_item_new_with_label (""),
2821 /* All updated. */
2822 val = 0;
2823 iter = 0;
2825 else if (! iter && val)
2827 /* Item(s) added. Add all new items in one call. */
2828 create_menus (val, f, select_cb, deactivate_cb, highlight_cb,
2829 0, 1, 0, menubar, cl_data, 0);
2831 /* All updated. */
2832 val = 0;
2833 iter = 0;
2835 /* Below this neither iter or val is NULL */
2836 else if (xg_item_label_same_p (GTK_MENU_ITEM (iter->data), val->name))
2838 /* This item is still the same, check next item. */
2839 val = val->next;
2840 iter = g_list_next (iter);
2841 ++pos;
2843 else /* This item is changed. */
2845 GtkMenuItem *witem = GTK_MENU_ITEM (iter->data);
2846 GtkMenuItem *witem2 = 0;
2847 bool val_in_menubar = 0;
2848 bool iter_in_new_menubar = 0;
2849 GList *iter2;
2850 widget_value *cur;
2852 /* See if the changed entry (val) is present later in the menu bar */
2853 for (iter2 = iter;
2854 iter2 && ! val_in_menubar;
2855 iter2 = g_list_next (iter2))
2857 witem2 = GTK_MENU_ITEM (iter2->data);
2858 val_in_menubar = xg_item_label_same_p (witem2, val->name);
2861 /* See if the current entry (iter) is present later in the
2862 specification for the new menu bar. */
2863 for (cur = val; cur && ! iter_in_new_menubar; cur = cur->next)
2864 iter_in_new_menubar = xg_item_label_same_p (witem, cur->name);
2866 if (val_in_menubar && ! iter_in_new_menubar)
2868 int nr = pos;
2870 /* This corresponds to:
2871 Current: A B C
2872 New: A C
2873 Remove B. */
2875 g_object_ref (G_OBJECT (witem));
2876 gtk_container_remove (GTK_CONTAINER (menubar), GTK_WIDGET (witem));
2877 gtk_widget_destroy (GTK_WIDGET (witem));
2879 /* Must get new list since the old changed. */
2880 g_list_free (*list);
2881 *list = iter = gtk_container_get_children (GTK_CONTAINER (menubar));
2882 while (nr-- > 0) iter = g_list_next (iter);
2884 else if (! val_in_menubar && ! iter_in_new_menubar)
2886 /* This corresponds to:
2887 Current: A B C
2888 New: A X C
2889 Rename B to X. This might seem to be a strange thing to do,
2890 since if there is a menu under B it will be totally wrong for X.
2891 But consider editing a C file. Then there is a C-mode menu
2892 (corresponds to B above).
2893 If then doing C-x C-f the minibuf menu (X above) replaces the
2894 C-mode menu. When returning from the minibuffer, we get
2895 back the C-mode menu. Thus we do:
2896 Rename B to X (C-mode to minibuf menu)
2897 Rename X to B (minibuf to C-mode menu).
2898 If the X menu hasn't been invoked, the menu under B
2899 is up to date when leaving the minibuffer. */
2900 GtkLabel *wlabel = GTK_LABEL (XG_BIN_CHILD (witem));
2901 char *utf8_label = get_utf8_string (val->name);
2902 GtkWidget *submenu = gtk_menu_item_get_submenu (witem);
2904 /* GTK menu items don't notice when their labels have been
2905 changed from underneath them, so we have to explicitly
2906 use g_object_notify to tell listeners (e.g., a GMenuModel
2907 bridge that might be loaded) that the item's label has
2908 changed. */
2909 gtk_label_set_text (wlabel, utf8_label);
2910 g_object_notify (G_OBJECT (witem), "label");
2912 #ifdef HAVE_GTK_TEAROFF_MENU_ITEM_NEW
2913 /* If this item has a submenu that has been detached, change
2914 the title in the WM decorations also. */
2915 if (submenu && gtk_menu_get_tearoff_state (GTK_MENU (submenu)))
2916 /* Set the title of the detached window. */
2917 gtk_menu_set_title (GTK_MENU (submenu), utf8_label);
2918 #endif
2920 if (utf8_label) g_free (utf8_label);
2921 iter = g_list_next (iter);
2922 val = val->next;
2923 ++pos;
2925 else if (! val_in_menubar && iter_in_new_menubar)
2927 /* This corresponds to:
2928 Current: A B C
2929 New: A X B C
2930 Insert X. */
2932 int nr = pos;
2933 GSList *group = 0;
2934 GtkWidget *w = xg_create_one_menuitem (val,
2936 select_cb,
2937 highlight_cb,
2938 cl_data,
2939 &group);
2941 /* Create a possibly empty submenu for menu bar items, since some
2942 themes don't highlight items correctly without it. */
2943 GtkWidget *submenu = create_menus (NULL, f,
2944 select_cb, deactivate_cb,
2945 highlight_cb,
2946 0, 0, 0, 0, cl_data, 0);
2948 gtk_widget_set_name (w, MENU_ITEM_NAME);
2949 gtk_menu_shell_insert (GTK_MENU_SHELL (menubar), w, pos);
2950 gtk_menu_item_set_submenu (GTK_MENU_ITEM (w), submenu);
2952 g_list_free (*list);
2953 *list = iter = gtk_container_get_children (GTK_CONTAINER (menubar));
2954 while (nr-- > 0) iter = g_list_next (iter);
2955 iter = g_list_next (iter);
2956 val = val->next;
2957 ++pos;
2959 else /* if (val_in_menubar && iter_in_new_menubar) */
2961 int nr = pos;
2962 /* This corresponds to:
2963 Current: A B C
2964 New: A C B
2965 Move C before B */
2967 g_object_ref (G_OBJECT (witem2));
2968 gtk_container_remove (GTK_CONTAINER (menubar), GTK_WIDGET (witem2));
2969 gtk_menu_shell_insert (GTK_MENU_SHELL (menubar),
2970 GTK_WIDGET (witem2), pos);
2971 g_object_unref (G_OBJECT (witem2));
2973 g_list_free (*list);
2974 *list = iter = gtk_container_get_children (GTK_CONTAINER (menubar));
2975 while (nr-- > 0) iter = g_list_next (iter);
2976 if (iter) iter = g_list_next (iter);
2977 val = val->next;
2978 ++pos;
2982 /* Update the rest of the menu bar. */
2983 xg_update_menubar (menubar, f, list, iter, pos, val,
2984 select_cb, deactivate_cb, highlight_cb, cl_data);
2987 /* Update the menu item W so it corresponds to VAL.
2988 SELECT_CB is the callback to use when a menu item is selected.
2989 HIGHLIGHT_CB is the callback to call when entering/leaving menu items.
2990 CL_DATA is the data to set in the widget for menu invocation. */
2992 static void
2993 xg_update_menu_item (widget_value *val,
2994 GtkWidget *w,
2995 GCallback select_cb,
2996 GCallback highlight_cb,
2997 xg_menu_cb_data *cl_data)
2999 GtkWidget *wchild;
3000 GtkLabel *wlbl = 0;
3001 GtkLabel *wkey = 0;
3002 char *utf8_label;
3003 char *utf8_key;
3004 const char *old_label = 0;
3005 const char *old_key = 0;
3006 xg_menu_item_cb_data *cb_data;
3007 bool label_changed = false;
3009 wchild = XG_BIN_CHILD (w);
3010 utf8_label = get_utf8_string (val->name);
3011 utf8_key = get_utf8_string (val->key);
3013 /* See if W is a menu item with a key. See make_menu_item above. */
3014 if (GTK_IS_BOX (wchild))
3016 GList *list = gtk_container_get_children (GTK_CONTAINER (wchild));
3018 wlbl = GTK_LABEL (list->data);
3019 wkey = GTK_LABEL (list->next->data);
3020 g_list_free (list);
3022 if (! utf8_key)
3024 /* Remove the key and keep just the label. */
3025 g_object_ref (G_OBJECT (wlbl));
3026 gtk_container_remove (GTK_CONTAINER (w), wchild);
3027 gtk_container_add (GTK_CONTAINER (w), GTK_WIDGET (wlbl));
3028 g_object_unref (G_OBJECT (wlbl));
3029 wkey = 0;
3033 else /* Just a label. */
3035 wlbl = GTK_LABEL (wchild);
3037 /* Check if there is now a key. */
3038 if (utf8_key)
3040 GtkWidget *wtoadd = make_widget_for_menu_item (utf8_label, utf8_key);
3041 GList *list = gtk_container_get_children (GTK_CONTAINER (wtoadd));
3043 wlbl = GTK_LABEL (list->data);
3044 wkey = GTK_LABEL (list->next->data);
3045 g_list_free (list);
3047 gtk_container_remove (GTK_CONTAINER (w), wchild);
3048 gtk_container_add (GTK_CONTAINER (w), wtoadd);
3052 if (wkey) old_key = gtk_label_get_label (wkey);
3053 if (wlbl) old_label = gtk_label_get_label (wlbl);
3055 if (wkey && utf8_key && (! old_key || strcmp (utf8_key, old_key) != 0))
3057 label_changed = true;
3058 gtk_label_set_text (wkey, utf8_key);
3061 if (! old_label || strcmp (utf8_label, old_label) != 0)
3063 label_changed = true;
3064 gtk_label_set_text (wlbl, utf8_label);
3067 if (utf8_key) g_free (utf8_key);
3068 if (utf8_label) g_free (utf8_label);
3070 if (! val->enabled && gtk_widget_get_sensitive (w))
3071 gtk_widget_set_sensitive (w, FALSE);
3072 else if (val->enabled && ! gtk_widget_get_sensitive (w))
3073 gtk_widget_set_sensitive (w, TRUE);
3075 cb_data = g_object_get_data (G_OBJECT (w), XG_ITEM_DATA);
3076 if (cb_data)
3078 cb_data->call_data = val->call_data;
3079 cb_data->help = val->help;
3080 cb_data->cl_data = cl_data;
3082 /* We assume the callback functions don't change. */
3083 if (val->call_data && ! val->contents)
3085 /* This item shall have a select callback. */
3086 if (! cb_data->select_id)
3087 cb_data->select_id
3088 = g_signal_connect (G_OBJECT (w), "activate",
3089 select_cb, cb_data);
3091 else if (cb_data->select_id)
3093 g_signal_handler_disconnect (w, cb_data->select_id);
3094 cb_data->select_id = 0;
3098 if (label_changed) /* See comment in xg_update_menubar. */
3099 g_object_notify (G_OBJECT (w), "label");
3102 /* Update the toggle menu item W so it corresponds to VAL. */
3104 static void
3105 xg_update_toggle_item (widget_value *val, GtkWidget *w)
3107 gtk_check_menu_item_set_active (GTK_CHECK_MENU_ITEM (w), val->selected);
3110 /* Update the radio menu item W so it corresponds to VAL. */
3112 static void
3113 xg_update_radio_item (widget_value *val, GtkWidget *w)
3115 gtk_check_menu_item_set_active (GTK_CHECK_MENU_ITEM (w), val->selected);
3118 /* Update the sub menu SUBMENU and all its children so it corresponds to VAL.
3119 SUBMENU may be NULL, in that case a new menu is created.
3120 F is the frame the menu bar belongs to.
3121 VAL describes the contents of the menu bar.
3122 SELECT_CB is the callback to use when a menu item is selected.
3123 DEACTIVATE_CB is the callback to use when a sub menu is not shown anymore.
3124 HIGHLIGHT_CB is the callback to call when entering/leaving menu items.
3125 CL_DATA is the call back data to use for any newly created items.
3127 Returns the updated submenu widget, that is SUBMENU unless SUBMENU
3128 was NULL. */
3130 static GtkWidget *
3131 xg_update_submenu (GtkWidget *submenu,
3132 struct frame *f,
3133 widget_value *val,
3134 GCallback select_cb,
3135 GCallback deactivate_cb,
3136 GCallback highlight_cb,
3137 xg_menu_cb_data *cl_data)
3139 GtkWidget *newsub = submenu;
3140 GList *list = 0;
3141 GList *iter;
3142 widget_value *cur;
3143 bool has_tearoff_p = 0;
3144 GList *first_radio = 0;
3146 if (submenu)
3147 list = gtk_container_get_children (GTK_CONTAINER (submenu));
3149 for (cur = val, iter = list;
3150 cur && iter;
3151 iter = g_list_next (iter), cur = cur->next)
3153 GtkWidget *w = GTK_WIDGET (iter->data);
3155 #ifdef HAVE_GTK_TEAROFF_MENU_ITEM_NEW
3156 /* Skip tearoff items, they have no counterpart in val. */
3157 if (GTK_IS_TEAROFF_MENU_ITEM (w))
3159 has_tearoff_p = 1;
3160 iter = g_list_next (iter);
3161 if (iter) w = GTK_WIDGET (iter->data);
3162 else break;
3164 #endif
3166 /* Remember first radio button in a group. If we get a mismatch in
3167 a radio group we must rebuild the whole group so that the connections
3168 in GTK becomes correct. */
3169 if (cur->button_type == BUTTON_TYPE_RADIO && ! first_radio)
3170 first_radio = iter;
3171 else if (cur->button_type != BUTTON_TYPE_RADIO
3172 && ! GTK_IS_RADIO_MENU_ITEM (w))
3173 first_radio = 0;
3175 if (GTK_IS_SEPARATOR_MENU_ITEM (w))
3177 if (! menu_separator_name_p (cur->name))
3178 break;
3180 else if (GTK_IS_CHECK_MENU_ITEM (w))
3182 if (cur->button_type != BUTTON_TYPE_TOGGLE)
3183 break;
3184 xg_update_toggle_item (cur, w);
3185 xg_update_menu_item (cur, w, select_cb, highlight_cb, cl_data);
3187 else if (GTK_IS_RADIO_MENU_ITEM (w))
3189 if (cur->button_type != BUTTON_TYPE_RADIO)
3190 break;
3191 xg_update_radio_item (cur, w);
3192 xg_update_menu_item (cur, w, select_cb, highlight_cb, cl_data);
3194 else if (GTK_IS_MENU_ITEM (w))
3196 GtkMenuItem *witem = GTK_MENU_ITEM (w);
3197 GtkWidget *sub;
3199 if (cur->button_type != BUTTON_TYPE_NONE ||
3200 menu_separator_name_p (cur->name))
3201 break;
3203 xg_update_menu_item (cur, w, select_cb, highlight_cb, cl_data);
3205 sub = gtk_menu_item_get_submenu (witem);
3206 if (sub && ! cur->contents)
3208 /* Not a submenu anymore. */
3209 g_object_ref (G_OBJECT (sub));
3210 remove_submenu (witem);
3211 gtk_widget_destroy (sub);
3213 else if (cur->contents)
3215 GtkWidget *nsub;
3217 nsub = xg_update_submenu (sub, f, cur->contents,
3218 select_cb, deactivate_cb,
3219 highlight_cb, cl_data);
3221 /* If this item just became a submenu, we must set it. */
3222 if (nsub != sub)
3223 gtk_menu_item_set_submenu (witem, nsub);
3226 else
3228 /* Structural difference. Remove everything from here and down
3229 in SUBMENU. */
3230 break;
3234 /* Remove widgets from first structural change. */
3235 if (iter)
3237 /* If we are adding new menu items below, we must remove from
3238 first radio button so that radio groups become correct. */
3239 if (cur && first_radio) xg_destroy_widgets (first_radio);
3240 else xg_destroy_widgets (iter);
3243 if (cur)
3245 /* More items added. Create them. */
3246 newsub = create_menus (cur,
3248 select_cb,
3249 deactivate_cb,
3250 highlight_cb,
3253 ! has_tearoff_p,
3254 submenu,
3255 cl_data,
3259 if (list) g_list_free (list);
3261 return newsub;
3264 /* Update the MENUBAR.
3265 F is the frame the menu bar belongs to.
3266 VAL describes the contents of the menu bar.
3267 If DEEP_P, rebuild all but the top level menu names in
3268 the MENUBAR. If DEEP_P is zero, just rebuild the names in the menubar.
3269 SELECT_CB is the callback to use when a menu item is selected.
3270 DEACTIVATE_CB is the callback to use when a sub menu is not shown anymore.
3271 HIGHLIGHT_CB is the callback to call when entering/leaving menu items. */
3273 void
3274 xg_modify_menubar_widgets (GtkWidget *menubar, struct frame *f,
3275 widget_value *val, bool deep_p,
3276 GCallback select_cb, GCallback deactivate_cb,
3277 GCallback highlight_cb)
3279 xg_menu_cb_data *cl_data;
3280 GList *list = gtk_container_get_children (GTK_CONTAINER (menubar));
3282 if (! list) return;
3284 cl_data = g_object_get_data (G_OBJECT (menubar), XG_FRAME_DATA);
3286 xg_update_menubar (menubar, f, &list, list, 0, val->contents,
3287 select_cb, deactivate_cb, highlight_cb, cl_data);
3289 if (deep_p)
3291 widget_value *cur;
3293 /* Update all sub menus.
3294 We must keep the submenus (GTK menu item widgets) since the
3295 X Window in the XEvent that activates the menu are those widgets. */
3297 /* Update cl_data, menu_item things in F may have changed. */
3298 update_cl_data (cl_data, f, highlight_cb);
3300 for (cur = val->contents; cur; cur = cur->next)
3302 GList *iter;
3303 GtkWidget *sub = 0;
3304 GtkWidget *newsub;
3305 GtkMenuItem *witem = 0;
3307 /* Find sub menu that corresponds to val and update it. */
3308 for (iter = list ; iter; iter = g_list_next (iter))
3310 witem = GTK_MENU_ITEM (iter->data);
3311 if (xg_item_label_same_p (witem, cur->name))
3313 sub = gtk_menu_item_get_submenu (witem);
3314 break;
3318 newsub = xg_update_submenu (sub,
3320 cur->contents,
3321 select_cb,
3322 deactivate_cb,
3323 highlight_cb,
3324 cl_data);
3325 /* sub may still be NULL. If we just updated non deep and added
3326 a new menu bar item, it has no sub menu yet. So we set the
3327 newly created sub menu under witem. */
3328 if (newsub != sub && witem != 0)
3330 xg_set_screen (newsub, f);
3331 gtk_menu_item_set_submenu (witem, newsub);
3336 g_list_free (list);
3337 gtk_widget_show_all (menubar);
3340 /* Callback called when the menu bar W is mapped.
3341 Used to find the height of the menu bar if we didn't get it
3342 after showing the widget. */
3344 static void
3345 menubar_map_cb (GtkWidget *w, gpointer user_data)
3347 GtkRequisition req;
3348 struct frame *f = user_data;
3349 gtk_widget_get_preferred_size (w, NULL, &req);
3350 if (FRAME_MENUBAR_HEIGHT (f) != req.height)
3352 FRAME_MENUBAR_HEIGHT (f) = req.height;
3353 xg_height_or_width_changed (f);
3357 /* Recompute all the widgets of frame F, when the menu bar has been
3358 changed. */
3360 void
3361 xg_update_frame_menubar (struct frame *f)
3363 struct x_output *x = f->output_data.x;
3364 GtkRequisition req;
3366 if (!x->menubar_widget || gtk_widget_get_mapped (x->menubar_widget))
3367 return;
3369 if (x->menubar_widget && gtk_widget_get_parent (x->menubar_widget))
3370 return; /* Already done this, happens for frames created invisible. */
3372 block_input ();
3374 gtk_box_pack_start (GTK_BOX (x->vbox_widget), x->menubar_widget,
3375 FALSE, FALSE, 0);
3376 gtk_box_reorder_child (GTK_BOX (x->vbox_widget), x->menubar_widget, 0);
3378 g_signal_connect (x->menubar_widget, "map", G_CALLBACK (menubar_map_cb), f);
3379 gtk_widget_show_all (x->menubar_widget);
3380 gtk_widget_get_preferred_size (x->menubar_widget, NULL, &req);
3382 if (FRAME_MENUBAR_HEIGHT (f) != req.height)
3384 FRAME_MENUBAR_HEIGHT (f) = req.height;
3385 xg_height_or_width_changed (f);
3387 unblock_input ();
3390 /* Get rid of the menu bar of frame F, and free its storage.
3391 This is used when deleting a frame, and when turning off the menu bar. */
3393 void
3394 free_frame_menubar (struct frame *f)
3396 struct x_output *x = f->output_data.x;
3398 if (x->menubar_widget)
3400 block_input ();
3402 gtk_container_remove (GTK_CONTAINER (x->vbox_widget), x->menubar_widget);
3403 /* The menubar and its children shall be deleted when removed from
3404 the container. */
3405 x->menubar_widget = 0;
3406 FRAME_MENUBAR_HEIGHT (f) = 0;
3407 xg_height_or_width_changed (f);
3408 unblock_input ();
3412 bool
3413 xg_event_is_for_menubar (struct frame *f, const XEvent *event)
3415 struct x_output *x = f->output_data.x;
3416 GList *iter;
3417 GdkRectangle rec;
3418 GList *list;
3419 GdkDisplay *gdpy;
3420 GdkWindow *gw;
3421 GdkEvent gevent;
3422 GtkWidget *gwdesc;
3424 if (! x->menubar_widget) return 0;
3426 if (! (event->xbutton.x >= 0
3427 && event->xbutton.x < FRAME_PIXEL_WIDTH (f)
3428 && event->xbutton.y >= 0
3429 && event->xbutton.y < f->output_data.x->menubar_height
3430 && event->xbutton.same_screen))
3431 return 0;
3433 gdpy = gdk_x11_lookup_xdisplay (FRAME_X_DISPLAY (f));
3434 gw = gdk_x11_window_lookup_for_display (gdpy, event->xbutton.window);
3435 if (! gw) return 0;
3436 gevent.any.window = gw;
3437 gevent.any.type = GDK_NOTHING;
3438 gwdesc = gtk_get_event_widget (&gevent);
3439 if (! gwdesc) return 0;
3440 if (! GTK_IS_MENU_BAR (gwdesc)
3441 && ! GTK_IS_MENU_ITEM (gwdesc)
3442 && ! gtk_widget_is_ancestor (x->menubar_widget, gwdesc))
3443 return 0;
3445 list = gtk_container_get_children (GTK_CONTAINER (x->menubar_widget));
3446 if (! list) return 0;
3447 rec.x = event->xbutton.x;
3448 rec.y = event->xbutton.y;
3449 rec.width = 1;
3450 rec.height = 1;
3452 for (iter = list ; iter; iter = g_list_next (iter))
3454 GtkWidget *w = GTK_WIDGET (iter->data);
3455 if (gtk_widget_get_mapped (w) && gtk_widget_intersect (w, &rec, NULL))
3456 break;
3458 g_list_free (list);
3459 return iter != 0;
3464 /***********************************************************************
3465 Scroll bar functions
3466 ***********************************************************************/
3469 /* Setting scroll bar values invokes the callback. Use this variable
3470 to indicate that callback should do nothing. */
3472 bool xg_ignore_gtk_scrollbar;
3474 /* The width of the scroll bar for the current theme. */
3476 static int scroll_bar_width_for_theme;
3478 /* Xlib's `Window' fits in 32 bits. But we want to store pointers, and they
3479 may be larger than 32 bits. Keep a mapping from integer index to widget
3480 pointers to get around the 32 bit limitation. */
3482 static struct
3484 GtkWidget **widgets;
3485 ptrdiff_t max_size;
3486 ptrdiff_t used;
3487 } id_to_widget;
3489 /* Grow this much every time we need to allocate more */
3491 #define ID_TO_WIDGET_INCR 32
3493 /* Store the widget pointer W in id_to_widget and return the integer index. */
3495 static ptrdiff_t
3496 xg_store_widget_in_map (GtkWidget *w)
3498 ptrdiff_t i;
3500 if (id_to_widget.max_size == id_to_widget.used)
3502 ptrdiff_t new_size;
3503 if (TYPE_MAXIMUM (Window) - ID_TO_WIDGET_INCR < id_to_widget.max_size)
3504 memory_full (SIZE_MAX);
3506 new_size = id_to_widget.max_size + ID_TO_WIDGET_INCR;
3507 id_to_widget.widgets = xnrealloc (id_to_widget.widgets,
3508 new_size, sizeof (GtkWidget *));
3510 for (i = id_to_widget.max_size; i < new_size; ++i)
3511 id_to_widget.widgets[i] = 0;
3512 id_to_widget.max_size = new_size;
3515 /* Just loop over the array and find a free place. After all,
3516 how many scroll bars are we creating? Should be a small number.
3517 The check above guarantees we will find a free place. */
3518 for (i = 0; i < id_to_widget.max_size; ++i)
3520 if (! id_to_widget.widgets[i])
3522 id_to_widget.widgets[i] = w;
3523 ++id_to_widget.used;
3525 return i;
3529 /* Should never end up here */
3530 emacs_abort ();
3533 /* Remove pointer at IDX from id_to_widget.
3534 Called when scroll bar is destroyed. */
3536 static void
3537 xg_remove_widget_from_map (ptrdiff_t idx)
3539 if (idx < id_to_widget.max_size && id_to_widget.widgets[idx] != 0)
3541 id_to_widget.widgets[idx] = 0;
3542 --id_to_widget.used;
3546 /* Get the widget pointer at IDX from id_to_widget. */
3548 static GtkWidget *
3549 xg_get_widget_from_map (ptrdiff_t idx)
3551 if (idx < id_to_widget.max_size && id_to_widget.widgets[idx] != 0)
3552 return id_to_widget.widgets[idx];
3554 return 0;
3557 static void
3558 update_theme_scrollbar_width (void)
3560 #ifdef HAVE_GTK3
3561 GtkAdjustment *vadj;
3562 #else
3563 GtkObject *vadj;
3564 #endif
3565 GtkWidget *wscroll;
3566 int w = 0, b = 0;
3568 vadj = gtk_adjustment_new (XG_SB_MIN, XG_SB_MIN, XG_SB_MAX, 0.1, 0.1, 0.1);
3569 wscroll = gtk_scrollbar_new (GTK_ORIENTATION_VERTICAL, GTK_ADJUSTMENT (vadj));
3570 g_object_ref_sink (G_OBJECT (wscroll));
3571 gtk_widget_style_get (wscroll, "slider-width", &w, "trough-border", &b, NULL);
3572 gtk_widget_destroy (wscroll);
3573 g_object_unref (G_OBJECT (wscroll));
3574 w += 2*b;
3575 #ifndef HAVE_GTK3
3576 if (w < 16) w = 16;
3577 #endif
3578 scroll_bar_width_for_theme = w;
3582 xg_get_default_scrollbar_width (void)
3584 return scroll_bar_width_for_theme;
3587 /* Return the scrollbar id for X Window WID on display DPY.
3588 Return -1 if WID not in id_to_widget. */
3590 ptrdiff_t
3591 xg_get_scroll_id_for_window (Display *dpy, Window wid)
3593 ptrdiff_t idx;
3594 GtkWidget *w;
3596 w = xg_win_to_widget (dpy, wid);
3598 if (w)
3600 for (idx = 0; idx < id_to_widget.max_size; ++idx)
3601 if (id_to_widget.widgets[idx] == w)
3602 return idx;
3605 return -1;
3608 /* Callback invoked when scroll bar WIDGET is destroyed.
3609 DATA is the index into id_to_widget for WIDGET.
3610 We free pointer to last scroll bar values here and remove the index. */
3612 static void
3613 xg_gtk_scroll_destroy (GtkWidget *widget, gpointer data)
3615 intptr_t id = (intptr_t) data;
3616 xg_remove_widget_from_map (id);
3619 /* Create a scroll bar widget for frame F. Store the scroll bar
3620 in BAR.
3621 SCROLL_CALLBACK is the callback to invoke when the value of the
3622 bar changes.
3623 END_CALLBACK is the callback to invoke when scrolling ends.
3624 SCROLL_BAR_NAME is the name we use for the scroll bar. Can be used
3625 to set resources for the widget. */
3627 void
3628 xg_create_scroll_bar (struct frame *f,
3629 struct scroll_bar *bar,
3630 GCallback scroll_callback,
3631 GCallback end_callback,
3632 const char *scroll_bar_name)
3634 GtkWidget *wscroll;
3635 GtkWidget *webox;
3636 intptr_t scroll_id;
3637 #ifdef HAVE_GTK3
3638 GtkAdjustment *vadj;
3639 #else
3640 GtkObject *vadj;
3641 #endif
3643 /* Page, step increment values are not so important here, they
3644 will be corrected in x_set_toolkit_scroll_bar_thumb. */
3645 vadj = gtk_adjustment_new (XG_SB_MIN, XG_SB_MIN, XG_SB_MAX,
3646 0.1, 0.1, 0.1);
3648 wscroll = gtk_scrollbar_new (GTK_ORIENTATION_VERTICAL, GTK_ADJUSTMENT (vadj));
3649 webox = gtk_event_box_new ();
3650 gtk_widget_set_name (wscroll, scroll_bar_name);
3651 #ifndef HAVE_GTK3
3652 gtk_range_set_update_policy (GTK_RANGE (wscroll), GTK_UPDATE_CONTINUOUS);
3653 #endif
3654 g_object_set_data (G_OBJECT (wscroll), XG_FRAME_DATA, (gpointer)f);
3656 scroll_id = xg_store_widget_in_map (wscroll);
3658 g_signal_connect (G_OBJECT (wscroll),
3659 "destroy",
3660 G_CALLBACK (xg_gtk_scroll_destroy),
3661 (gpointer) scroll_id);
3662 g_signal_connect (G_OBJECT (wscroll),
3663 "change-value",
3664 scroll_callback,
3665 (gpointer) bar);
3666 g_signal_connect (G_OBJECT (wscroll),
3667 "button-release-event",
3668 end_callback,
3669 (gpointer) bar);
3671 /* The scroll bar widget does not draw on a window of its own. Instead
3672 it draws on the parent window, in this case the edit widget. So
3673 whenever the edit widget is cleared, the scroll bar needs to redraw
3674 also, which causes flicker. Put an event box between the edit widget
3675 and the scroll bar, so the scroll bar instead draws itself on the
3676 event box window. */
3677 gtk_fixed_put (GTK_FIXED (f->output_data.x->edit_widget), webox, -1, -1);
3678 gtk_container_add (GTK_CONTAINER (webox), wscroll);
3681 /* Set the cursor to an arrow. */
3682 xg_set_cursor (webox, FRAME_DISPLAY_INFO (f)->xg_cursor);
3684 bar->x_window = scroll_id;
3687 /* Remove the scroll bar represented by SCROLLBAR_ID from the frame F. */
3689 void
3690 xg_remove_scroll_bar (struct frame *f, ptrdiff_t scrollbar_id)
3692 GtkWidget *w = xg_get_widget_from_map (scrollbar_id);
3693 if (w)
3695 GtkWidget *wparent = gtk_widget_get_parent (w);
3696 gtk_widget_destroy (w);
3697 gtk_widget_destroy (wparent);
3698 SET_FRAME_GARBAGED (f);
3702 /* Update the position of the vertical scroll bar represented by SCROLLBAR_ID
3703 in frame F.
3704 TOP/LEFT are the new pixel positions where the bar shall appear.
3705 WIDTH, HEIGHT is the size in pixels the bar shall have. */
3707 void
3708 xg_update_scrollbar_pos (struct frame *f,
3709 ptrdiff_t scrollbar_id,
3710 int top,
3711 int left,
3712 int width,
3713 int height)
3716 GtkWidget *wscroll = xg_get_widget_from_map (scrollbar_id);
3718 if (wscroll)
3720 GtkWidget *wfixed = f->output_data.x->edit_widget;
3721 GtkWidget *wparent = gtk_widget_get_parent (wscroll);
3722 gint msl;
3724 /* Clear out old position. */
3725 int oldx = -1, oldy = -1, oldw, oldh;
3726 if (gtk_widget_get_parent (wparent) == wfixed)
3728 gtk_container_child_get (GTK_CONTAINER (wfixed), wparent,
3729 "x", &oldx, "y", &oldy, NULL);
3730 gtk_widget_get_size_request (wscroll, &oldw, &oldh);
3733 /* Move and resize to new values. */
3734 gtk_fixed_move (GTK_FIXED (wfixed), wparent, left, top);
3735 gtk_widget_style_get (wscroll, "min-slider-length", &msl, NULL);
3736 if (msl > height)
3738 /* No room. Hide scroll bar as some themes output a warning if
3739 the height is less than the min size. */
3740 gtk_widget_hide (wparent);
3741 gtk_widget_hide (wscroll);
3743 else
3745 gtk_widget_show_all (wparent);
3746 gtk_widget_set_size_request (wscroll, width, height);
3748 gtk_widget_queue_draw (wfixed);
3749 gdk_window_process_all_updates ();
3750 if (oldx != -1 && oldw > 0 && oldh > 0)
3751 /* Clear under old scroll bar position. This must be done after
3752 the gtk_widget_queue_draw and gdk_window_process_all_updates
3753 above. */
3754 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3755 oldx, oldy, oldw, oldh);
3757 /* GTK does not redraw until the main loop is entered again, but
3758 if there are no X events pending we will not enter it. So we sync
3759 here to get some events. */
3761 x_sync (f);
3762 SET_FRAME_GARBAGED (f);
3763 cancel_mouse_face (f);
3767 /* Get the current value of the range, truncated to an integer. */
3769 static int
3770 int_gtk_range_get_value (GtkRange *range)
3772 return gtk_range_get_value (range);
3776 /* Set the thumb size and position of scroll bar BAR. We are currently
3777 displaying PORTION out of a whole WHOLE, and our position POSITION. */
3779 void
3780 xg_set_toolkit_scroll_bar_thumb (struct scroll_bar *bar,
3781 int portion,
3782 int position,
3783 int whole)
3785 GtkWidget *wscroll = xg_get_widget_from_map (bar->x_window);
3787 struct frame *f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
3789 if (wscroll && bar->dragging == -1)
3791 GtkAdjustment *adj;
3792 gdouble shown;
3793 gdouble top;
3794 int size, value;
3795 int old_size;
3796 int new_step;
3797 bool changed = 0;
3799 adj = gtk_range_get_adjustment (GTK_RANGE (wscroll));
3801 if (scroll_bar_adjust_thumb_portion_p)
3803 /* We do the same as for MOTIF in xterm.c, use 30 chars per
3804 line rather than the real portion value. This makes the
3805 thumb less likely to resize and that looks better. */
3806 portion = WINDOW_TOTAL_LINES (XWINDOW (bar->window)) * 30;
3808 /* When the thumb is at the bottom, position == whole.
3809 So we need to increase `whole' to make space for the thumb. */
3810 whole += portion;
3813 if (whole <= 0)
3814 top = 0, shown = 1;
3815 else
3817 top = (gdouble) position / whole;
3818 shown = (gdouble) portion / whole;
3821 size = clip_to_bounds (1, shown * XG_SB_RANGE, XG_SB_RANGE);
3822 value = clip_to_bounds (XG_SB_MIN, top * XG_SB_RANGE, XG_SB_MAX - size);
3824 /* Assume all lines are of equal size. */
3825 new_step = size / max (1, FRAME_LINES (f));
3827 old_size = gtk_adjustment_get_page_size (adj);
3828 if (old_size != size)
3830 int old_step = gtk_adjustment_get_step_increment (adj);
3831 if (old_step != new_step)
3833 gtk_adjustment_set_page_size (adj, size);
3834 gtk_adjustment_set_step_increment (adj, new_step);
3835 /* Assume a page increment is about 95% of the page size */
3836 gtk_adjustment_set_page_increment (adj, size - size / 20);
3837 changed = 1;
3841 if (changed || int_gtk_range_get_value (GTK_RANGE (wscroll)) != value)
3843 block_input ();
3845 /* gtk_range_set_value invokes the callback. Set
3846 ignore_gtk_scrollbar to make the callback do nothing */
3847 xg_ignore_gtk_scrollbar = 1;
3849 if (int_gtk_range_get_value (GTK_RANGE (wscroll)) != value)
3850 gtk_range_set_value (GTK_RANGE (wscroll), (gdouble)value);
3851 else if (changed)
3852 gtk_adjustment_changed (adj);
3854 xg_ignore_gtk_scrollbar = 0;
3856 unblock_input ();
3861 /* Return true if EVENT is for a scroll bar in frame F.
3862 When the same X window is used for several Gtk+ widgets, we cannot
3863 say for sure based on the X window alone if an event is for the
3864 frame. This function does additional checks. */
3866 bool
3867 xg_event_is_for_scrollbar (struct frame *f, const XEvent *event)
3869 bool retval = 0;
3871 if (f && event->type == ButtonPress && event->xbutton.button < 4)
3873 /* Check if press occurred outside the edit widget. */
3874 GdkDisplay *gdpy = gdk_x11_lookup_xdisplay (FRAME_X_DISPLAY (f));
3875 GdkWindow *gwin;
3876 #ifdef HAVE_GTK3
3877 GdkDevice *gdev = gdk_device_manager_get_client_pointer
3878 (gdk_display_get_device_manager (gdpy));
3879 gwin = gdk_device_get_window_at_position (gdev, NULL, NULL);
3880 #else
3881 gwin = gdk_display_get_window_at_pointer (gdpy, NULL, NULL);
3882 #endif
3883 retval = gwin != gtk_widget_get_window (f->output_data.x->edit_widget);
3885 else if (f
3886 && ((event->type == ButtonRelease && event->xbutton.button < 4)
3887 || event->type == MotionNotify))
3889 /* If we are releasing or moving the scroll bar, it has the grab. */
3890 GtkWidget *w = gtk_grab_get_current ();
3891 retval = w != 0 && GTK_IS_SCROLLBAR (w);
3894 return retval;
3899 /***********************************************************************
3900 Tool bar functions
3901 ***********************************************************************/
3902 /* The key for the data we put in the GtkImage widgets. The data is
3903 the image used by Emacs. We use this to see if we need to update
3904 the GtkImage with a new image. */
3905 #define XG_TOOL_BAR_IMAGE_DATA "emacs-tool-bar-image"
3907 /* The key for storing the latest modifiers so the activate callback can
3908 get them. */
3909 #define XG_TOOL_BAR_LAST_MODIFIER "emacs-tool-bar-modifier"
3911 /* The key for storing the button widget in its proxy menu item. */
3912 #define XG_TOOL_BAR_PROXY_BUTTON "emacs-tool-bar-proxy-button"
3914 /* The key for the data we put in the GtkImage widgets. The data is
3915 the stock name used by Emacs. We use this to see if we need to update
3916 the GtkImage with a new image. */
3917 #define XG_TOOL_BAR_STOCK_NAME "emacs-tool-bar-stock-name"
3919 /* As above, but this is used for named theme widgets, as opposed to
3920 stock items. */
3921 #define XG_TOOL_BAR_ICON_NAME "emacs-tool-bar-icon-name"
3923 /* Callback function invoked when a tool bar item is pressed.
3924 W is the button widget in the tool bar that got pressed,
3925 CLIENT_DATA is an integer that is the index of the button in the
3926 tool bar. 0 is the first button. */
3928 static gboolean
3929 xg_tool_bar_button_cb (GtkWidget *widget,
3930 GdkEventButton *event,
3931 gpointer user_data)
3933 intptr_t state = event->state;
3934 gpointer ptr = (gpointer) state;
3935 g_object_set_data (G_OBJECT (widget), XG_TOOL_BAR_LAST_MODIFIER, ptr);
3936 return FALSE;
3940 /* Callback function invoked when a tool bar item is pressed.
3941 W is the button widget in the tool bar that got pressed,
3942 CLIENT_DATA is an integer that is the index of the button in the
3943 tool bar. 0 is the first button. */
3945 static void
3946 xg_tool_bar_callback (GtkWidget *w, gpointer client_data)
3948 intptr_t idx = (intptr_t) client_data;
3949 gpointer gmod = g_object_get_data (G_OBJECT (w), XG_TOOL_BAR_LAST_MODIFIER);
3950 intptr_t mod = (intptr_t) gmod;
3952 struct frame *f = g_object_get_data (G_OBJECT (w), XG_FRAME_DATA);
3953 Lisp_Object key, frame;
3954 struct input_event event;
3955 EVENT_INIT (event);
3957 if (! f || ! f->n_tool_bar_items || NILP (f->tool_bar_items))
3958 return;
3960 idx *= TOOL_BAR_ITEM_NSLOTS;
3962 key = AREF (f->tool_bar_items, idx + TOOL_BAR_ITEM_KEY);
3963 XSETFRAME (frame, f);
3965 /* We generate two events here. The first one is to set the prefix
3966 to `(tool_bar)', see keyboard.c. */
3967 event.kind = TOOL_BAR_EVENT;
3968 event.frame_or_window = frame;
3969 event.arg = frame;
3970 kbd_buffer_store_event (&event);
3972 event.kind = TOOL_BAR_EVENT;
3973 event.frame_or_window = frame;
3974 event.arg = key;
3975 /* Convert between the modifier bits GDK uses and the modifier bits
3976 Emacs uses. This assumes GDK and X masks are the same, which they are when
3977 this is written. */
3978 event.modifiers = x_x_to_emacs_modifiers (FRAME_DISPLAY_INFO (f), mod);
3979 kbd_buffer_store_event (&event);
3981 /* Return focus to the frame after we have clicked on a detached
3982 tool bar button. */
3983 x_focus_frame (f);
3986 /* Callback function invoked when a tool bar item is pressed in a detached
3987 tool bar or the overflow drop down menu.
3988 We just call xg_tool_bar_callback.
3989 W is the menu item widget that got pressed,
3990 CLIENT_DATA is an integer that is the index of the button in the
3991 tool bar. 0 is the first button. */
3993 static void
3994 xg_tool_bar_proxy_callback (GtkWidget *w, gpointer client_data)
3996 GtkWidget *wbutton = GTK_WIDGET (g_object_get_data (G_OBJECT (w),
3997 XG_TOOL_BAR_PROXY_BUTTON));
3998 xg_tool_bar_callback (wbutton, client_data);
4002 static gboolean
4003 xg_tool_bar_help_callback (GtkWidget *w,
4004 GdkEventCrossing *event,
4005 gpointer client_data);
4007 /* This callback is called when a help is to be shown for an item in
4008 the detached tool bar when the detached tool bar it is not expanded. */
4010 static gboolean
4011 xg_tool_bar_proxy_help_callback (GtkWidget *w,
4012 GdkEventCrossing *event,
4013 gpointer client_data)
4015 GtkWidget *wbutton = GTK_WIDGET (g_object_get_data (G_OBJECT (w),
4016 XG_TOOL_BAR_PROXY_BUTTON));
4018 return xg_tool_bar_help_callback (wbutton, event, client_data);
4021 static GtkWidget *
4022 xg_get_tool_bar_widgets (GtkWidget *vb, GtkWidget **wimage)
4024 GList *clist = gtk_container_get_children (GTK_CONTAINER (vb));
4025 GtkWidget *c1 = clist->data;
4026 GtkWidget *c2 = clist->next ? clist->next->data : NULL;
4028 *wimage = GTK_IS_IMAGE (c1) ? c1 : c2;
4029 g_list_free (clist);
4030 return GTK_IS_LABEL (c1) ? c1 : c2;
4034 /* This callback is called when a tool item should create a proxy item,
4035 such as for the overflow menu. Also called when the tool bar is detached.
4036 If we don't create a proxy menu item, the detached tool bar will be
4037 blank. */
4039 static gboolean
4040 xg_tool_bar_menu_proxy (GtkToolItem *toolitem, gpointer user_data)
4042 GtkButton *wbutton = GTK_BUTTON (XG_BIN_CHILD (XG_BIN_CHILD (toolitem)));
4043 GtkWidget *vb = XG_BIN_CHILD (wbutton);
4044 GtkWidget *c1;
4045 GtkLabel *wlbl = GTK_LABEL (xg_get_tool_bar_widgets (vb, &c1));
4046 GtkImage *wimage = GTK_IMAGE (c1);
4047 GtkWidget *wmenuitem = gtk_image_menu_item_new_with_label
4048 (wlbl ? gtk_label_get_text (wlbl) : "");
4049 GtkWidget *wmenuimage;
4052 if (gtk_button_get_use_stock (wbutton))
4053 wmenuimage = gtk_image_new_from_stock (gtk_button_get_label (wbutton),
4054 GTK_ICON_SIZE_MENU);
4055 else
4057 GtkSettings *settings = gtk_widget_get_settings (GTK_WIDGET (wbutton));
4058 GtkImageType store_type = gtk_image_get_storage_type (wimage);
4060 g_object_set (G_OBJECT (settings), "gtk-menu-images", TRUE, NULL);
4062 if (store_type == GTK_IMAGE_STOCK)
4064 gchar *stock_id;
4065 gtk_image_get_stock (wimage, &stock_id, NULL);
4066 wmenuimage = gtk_image_new_from_stock (stock_id, GTK_ICON_SIZE_MENU);
4068 else if (store_type == GTK_IMAGE_ICON_SET)
4070 GtkIconSet *icon_set;
4071 gtk_image_get_icon_set (wimage, &icon_set, NULL);
4072 wmenuimage = gtk_image_new_from_icon_set (icon_set,
4073 GTK_ICON_SIZE_MENU);
4075 else if (store_type == GTK_IMAGE_PIXBUF)
4077 gint width, height;
4079 if (settings &&
4080 gtk_icon_size_lookup_for_settings (settings, GTK_ICON_SIZE_MENU,
4081 &width, &height))
4083 GdkPixbuf *src_pixbuf, *dest_pixbuf;
4085 src_pixbuf = gtk_image_get_pixbuf (wimage);
4086 dest_pixbuf = gdk_pixbuf_scale_simple (src_pixbuf, width, height,
4087 GDK_INTERP_BILINEAR);
4089 wmenuimage = gtk_image_new_from_pixbuf (dest_pixbuf);
4091 else
4093 fprintf (stderr, "internal error: GTK_IMAGE_PIXBUF failed\n");
4094 emacs_abort ();
4097 else if (store_type == GTK_IMAGE_ICON_NAME)
4099 const gchar *icon_name;
4100 GtkIconSize icon_size;
4102 gtk_image_get_icon_name (wimage, &icon_name, &icon_size);
4103 wmenuimage = gtk_image_new_from_icon_name (icon_name,
4104 GTK_ICON_SIZE_MENU);
4106 else
4108 fprintf (stderr, "internal error: store_type is %d\n", store_type);
4109 emacs_abort ();
4112 if (wmenuimage)
4113 gtk_image_menu_item_set_image (GTK_IMAGE_MENU_ITEM (wmenuitem), wmenuimage);
4115 g_signal_connect (G_OBJECT (wmenuitem),
4116 "activate",
4117 G_CALLBACK (xg_tool_bar_proxy_callback),
4118 user_data);
4121 g_object_set_data (G_OBJECT (wmenuitem), XG_TOOL_BAR_PROXY_BUTTON,
4122 (gpointer) wbutton);
4123 gtk_tool_item_set_proxy_menu_item (toolitem, "Emacs toolbar item", wmenuitem);
4124 gtk_widget_set_sensitive (wmenuitem,
4125 gtk_widget_get_sensitive (GTK_WIDGET (wbutton)));
4127 /* Use enter/leave notify to show help. We use the events
4128 rather than the GtkButton specific signals "enter" and
4129 "leave", so we can have only one callback. The event
4130 will tell us what kind of event it is. */
4131 g_signal_connect (G_OBJECT (wmenuitem),
4132 "enter-notify-event",
4133 G_CALLBACK (xg_tool_bar_proxy_help_callback),
4134 user_data);
4135 g_signal_connect (G_OBJECT (wmenuitem),
4136 "leave-notify-event",
4137 G_CALLBACK (xg_tool_bar_proxy_help_callback),
4138 user_data);
4140 return TRUE;
4143 /* This callback is called when a tool bar is detached. We must set
4144 the height of the tool bar to zero when this happens so frame sizes
4145 are correctly calculated.
4146 WBOX is the handle box widget that enables detach/attach of the tool bar.
4147 W is the tool bar widget.
4148 CLIENT_DATA is a pointer to the frame the tool bar belongs to. */
4150 static void
4151 xg_tool_bar_detach_callback (GtkHandleBox *wbox,
4152 GtkWidget *w,
4153 gpointer client_data)
4155 struct frame *f = client_data;
4157 g_object_set (G_OBJECT (w), "show-arrow", !x_gtk_whole_detached_tool_bar,
4158 NULL);
4160 if (f)
4162 GtkRequisition req, req2;
4164 gtk_widget_get_preferred_size (GTK_WIDGET (wbox), NULL, &req);
4165 gtk_widget_get_preferred_size (w, NULL, &req2);
4166 req.width -= req2.width;
4167 req.height -= req2.height;
4168 if (FRAME_TOOLBAR_TOP_HEIGHT (f) != 0)
4169 FRAME_TOOLBAR_TOP_HEIGHT (f) = req.height;
4170 else if (FRAME_TOOLBAR_BOTTOM_HEIGHT (f) != 0)
4171 FRAME_TOOLBAR_BOTTOM_HEIGHT (f) = req.height;
4172 else if (FRAME_TOOLBAR_RIGHT_WIDTH (f) != 0)
4173 FRAME_TOOLBAR_RIGHT_WIDTH (f) = req.width;
4174 else if (FRAME_TOOLBAR_LEFT_WIDTH (f) != 0)
4175 FRAME_TOOLBAR_LEFT_WIDTH (f) = req.width;
4176 xg_height_or_width_changed (f);
4180 /* This callback is called when a tool bar is reattached. We must set
4181 the height of the tool bar when this happens so frame sizes
4182 are correctly calculated.
4183 WBOX is the handle box widget that enables detach/attach of the tool bar.
4184 W is the tool bar widget.
4185 CLIENT_DATA is a pointer to the frame the tool bar belongs to. */
4187 static void
4188 xg_tool_bar_attach_callback (GtkHandleBox *wbox,
4189 GtkWidget *w,
4190 gpointer client_data)
4192 struct frame *f = client_data;
4193 g_object_set (G_OBJECT (w), "show-arrow", TRUE, NULL);
4195 if (f)
4197 GtkRequisition req, req2;
4199 gtk_widget_get_preferred_size (GTK_WIDGET (wbox), NULL, &req);
4200 gtk_widget_get_preferred_size (w, NULL, &req2);
4201 req.width += req2.width;
4202 req.height += req2.height;
4203 if (FRAME_TOOLBAR_TOP_HEIGHT (f) != 0)
4204 FRAME_TOOLBAR_TOP_HEIGHT (f) = req.height;
4205 else if (FRAME_TOOLBAR_BOTTOM_HEIGHT (f) != 0)
4206 FRAME_TOOLBAR_BOTTOM_HEIGHT (f) = req.height;
4207 else if (FRAME_TOOLBAR_RIGHT_WIDTH (f) != 0)
4208 FRAME_TOOLBAR_RIGHT_WIDTH (f) = req.width;
4209 else if (FRAME_TOOLBAR_LEFT_WIDTH (f) != 0)
4210 FRAME_TOOLBAR_LEFT_WIDTH (f) = req.width;
4211 xg_height_or_width_changed (f);
4215 /* This callback is called when the mouse enters or leaves a tool bar item.
4216 It is used for displaying and hiding the help text.
4217 W is the tool bar item, a button.
4218 EVENT is either an enter event or leave event.
4219 CLIENT_DATA is an integer that is the index of the button in the
4220 tool bar. 0 is the first button.
4222 Returns FALSE to tell GTK to keep processing this event. */
4224 static gboolean
4225 xg_tool_bar_help_callback (GtkWidget *w,
4226 GdkEventCrossing *event,
4227 gpointer client_data)
4229 intptr_t idx = (intptr_t) client_data;
4230 struct frame *f = g_object_get_data (G_OBJECT (w), XG_FRAME_DATA);
4231 Lisp_Object help, frame;
4233 if (! f || ! f->n_tool_bar_items || NILP (f->tool_bar_items))
4234 return FALSE;
4236 if (event->type == GDK_ENTER_NOTIFY)
4238 idx *= TOOL_BAR_ITEM_NSLOTS;
4239 help = AREF (f->tool_bar_items, idx + TOOL_BAR_ITEM_HELP);
4241 if (NILP (help))
4242 help = AREF (f->tool_bar_items, idx + TOOL_BAR_ITEM_CAPTION);
4244 else
4245 help = Qnil;
4247 XSETFRAME (frame, f);
4248 kbd_buffer_store_help_event (frame, help);
4250 return FALSE;
4254 /* This callback is called when a tool bar item shall be redrawn.
4255 It modifies the expose event so that the GtkImage widget redraws the
4256 whole image. This to overcome a bug that makes GtkImage draw the image
4257 in the wrong place when it tries to redraw just a part of the image.
4258 W is the GtkImage to be redrawn.
4259 EVENT is the expose event for W.
4260 CLIENT_DATA is unused.
4262 Returns FALSE to tell GTK to keep processing this event. */
4264 #ifndef HAVE_GTK3
4265 static gboolean
4266 xg_tool_bar_item_expose_callback (GtkWidget *w,
4267 GdkEventExpose *event,
4268 gpointer client_data)
4270 gint width, height;
4272 gdk_drawable_get_size (event->window, &width, &height);
4273 event->area.x -= width > event->area.width ? width-event->area.width : 0;
4274 event->area.y -= height > event->area.height ? height-event->area.height : 0;
4276 event->area.x = max (0, event->area.x);
4277 event->area.y = max (0, event->area.y);
4279 event->area.width = max (width, event->area.width);
4280 event->area.height = max (height, event->area.height);
4282 return FALSE;
4284 #endif
4286 #ifdef HAVE_GTK_ORIENTABLE_SET_ORIENTATION
4287 #define toolbar_set_orientation(w, o) \
4288 gtk_orientable_set_orientation (GTK_ORIENTABLE (w), o)
4289 #else
4290 #define toolbar_set_orientation(w, o) \
4291 gtk_toolbar_set_orientation (GTK_TOOLBAR (w), o)
4292 #endif
4294 #ifdef HAVE_GTK_HANDLE_BOX_NEW
4295 #define TOOLBAR_TOP_WIDGET(x) ((x)->handlebox_widget)
4296 #else
4297 #define TOOLBAR_TOP_WIDGET(x) ((x)->toolbar_widget)
4298 #endif
4300 /* Attach a tool bar to frame F. */
4302 static void
4303 xg_pack_tool_bar (struct frame *f, Lisp_Object pos)
4305 struct x_output *x = f->output_data.x;
4306 bool into_hbox = EQ (pos, Qleft) || EQ (pos, Qright);
4307 GtkWidget *top_widget = TOOLBAR_TOP_WIDGET (x);
4309 toolbar_set_orientation (x->toolbar_widget,
4310 into_hbox
4311 ? GTK_ORIENTATION_VERTICAL
4312 : GTK_ORIENTATION_HORIZONTAL);
4313 #ifdef HAVE_GTK_HANDLE_BOX_NEW
4314 if (!x->handlebox_widget)
4316 top_widget = x->handlebox_widget = gtk_handle_box_new ();
4317 g_signal_connect (G_OBJECT (x->handlebox_widget), "child-detached",
4318 G_CALLBACK (xg_tool_bar_detach_callback), f);
4319 g_signal_connect (G_OBJECT (x->handlebox_widget), "child-attached",
4320 G_CALLBACK (xg_tool_bar_attach_callback), f);
4321 gtk_container_add (GTK_CONTAINER (x->handlebox_widget),
4322 x->toolbar_widget);
4324 #endif
4326 if (into_hbox)
4328 #ifdef HAVE_GTK_HANDLE_BOX_NEW
4329 gtk_handle_box_set_handle_position (GTK_HANDLE_BOX (x->handlebox_widget),
4330 GTK_POS_TOP);
4331 #endif
4332 gtk_box_pack_start (GTK_BOX (x->hbox_widget), top_widget,
4333 FALSE, FALSE, 0);
4335 if (EQ (pos, Qleft))
4336 gtk_box_reorder_child (GTK_BOX (x->hbox_widget),
4337 top_widget,
4339 x->toolbar_in_hbox = true;
4341 else
4343 bool vbox_pos = x->menubar_widget != 0;
4344 #ifdef HAVE_GTK_HANDLE_BOX_NEW
4345 gtk_handle_box_set_handle_position (GTK_HANDLE_BOX (x->handlebox_widget),
4346 GTK_POS_LEFT);
4347 #endif
4348 gtk_box_pack_start (GTK_BOX (x->vbox_widget), top_widget,
4349 FALSE, FALSE, 0);
4351 if (EQ (pos, Qtop))
4352 gtk_box_reorder_child (GTK_BOX (x->vbox_widget),
4353 top_widget,
4354 vbox_pos);
4355 x->toolbar_in_hbox = false;
4357 x->toolbar_is_packed = true;
4360 static bool xg_update_tool_bar_sizes (struct frame *f);
4362 static void
4363 tb_size_cb (GtkWidget *widget,
4364 GdkRectangle *allocation,
4365 gpointer user_data)
4367 /* When tool bar is created it has one preferred size. But when size is
4368 allocated between widgets, it may get another. So we must update
4369 size hints if tool bar size changes. Seen on Fedora 18 at least. */
4370 struct frame *f = user_data;
4371 if (xg_update_tool_bar_sizes (f))
4372 xg_height_or_width_changed (f);
4375 /* Create a tool bar for frame F. */
4377 static void
4378 xg_create_tool_bar (struct frame *f)
4380 struct x_output *x = f->output_data.x;
4381 #if GTK_CHECK_VERSION (3, 3, 6)
4382 GtkStyleContext *gsty;
4383 #endif
4384 struct xg_frame_tb_info *tbinfo
4385 = g_object_get_data (G_OBJECT (FRAME_GTK_OUTER_WIDGET (f)),
4386 TB_INFO_KEY);
4387 if (! tbinfo)
4389 tbinfo = xmalloc (sizeof (*tbinfo));
4390 tbinfo->last_tool_bar = Qnil;
4391 tbinfo->style = Qnil;
4392 tbinfo->hmargin = tbinfo->vmargin = 0;
4393 tbinfo->dir = GTK_TEXT_DIR_NONE;
4394 tbinfo->n_last_items = 0;
4395 g_object_set_data (G_OBJECT (FRAME_GTK_OUTER_WIDGET (f)),
4396 TB_INFO_KEY,
4397 tbinfo);
4400 x->toolbar_widget = gtk_toolbar_new ();
4402 gtk_widget_set_name (x->toolbar_widget, "emacs-toolbar");
4404 gtk_toolbar_set_style (GTK_TOOLBAR (x->toolbar_widget), GTK_TOOLBAR_ICONS);
4405 toolbar_set_orientation (x->toolbar_widget, GTK_ORIENTATION_HORIZONTAL);
4406 g_signal_connect (x->toolbar_widget, "size-allocate",
4407 G_CALLBACK (tb_size_cb), f);
4408 #if GTK_CHECK_VERSION (3, 3, 6)
4409 gsty = gtk_widget_get_style_context (x->toolbar_widget);
4410 gtk_style_context_add_class (gsty, "primary-toolbar");
4411 #endif
4415 #define PROP(IDX) AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
4417 /* Find the right-to-left image named by RTL in the tool bar images for F.
4418 Returns IMAGE if RTL is not found. */
4420 static Lisp_Object
4421 find_rtl_image (struct frame *f, Lisp_Object image, Lisp_Object rtl)
4423 int i;
4424 Lisp_Object file, rtl_name;
4425 struct gcpro gcpro1, gcpro2;
4426 GCPRO2 (file, rtl_name);
4428 rtl_name = Ffile_name_nondirectory (rtl);
4430 for (i = 0; i < f->n_tool_bar_items; ++i)
4432 Lisp_Object rtl_image = PROP (TOOL_BAR_ITEM_IMAGES);
4433 if (!NILP (file = file_for_image (rtl_image)))
4435 file = call1 (intern ("file-name-sans-extension"),
4436 Ffile_name_nondirectory (file));
4437 if (! NILP (Fequal (file, rtl_name)))
4439 image = rtl_image;
4440 break;
4445 return image;
4448 static GtkToolItem *
4449 xg_make_tool_item (struct frame *f,
4450 GtkWidget *wimage,
4451 GtkWidget **wbutton,
4452 const char *label,
4453 int i, bool horiz, bool text_image)
4455 GtkToolItem *ti = gtk_tool_item_new ();
4456 GtkWidget *vb = gtk_box_new (horiz
4457 ? GTK_ORIENTATION_HORIZONTAL
4458 : GTK_ORIENTATION_VERTICAL,
4460 GtkWidget *wb = gtk_button_new ();
4461 /* The eventbox is here so we can have tooltips on disabled items. */
4462 GtkWidget *weventbox = gtk_event_box_new ();
4463 #if GTK_CHECK_VERSION (3, 3, 6)
4464 GtkCssProvider *css_prov = gtk_css_provider_new ();
4465 GtkStyleContext *gsty;
4467 gtk_css_provider_load_from_data (css_prov,
4468 "GtkEventBox {"
4469 " background-color: transparent;"
4470 "}",
4471 -1, NULL);
4473 gsty = gtk_widget_get_style_context (weventbox);
4474 gtk_style_context_add_provider (gsty,
4475 GTK_STYLE_PROVIDER (css_prov),
4476 GTK_STYLE_PROVIDER_PRIORITY_USER);
4477 g_object_unref (css_prov);
4478 #endif
4480 gtk_box_set_homogeneous (GTK_BOX (vb), FALSE);
4482 if (wimage && !text_image)
4483 gtk_box_pack_start (GTK_BOX (vb), wimage, TRUE, TRUE, 0);
4484 if (label)
4485 gtk_box_pack_start (GTK_BOX (vb), gtk_label_new (label), TRUE, TRUE, 0);
4486 if (wimage && text_image)
4487 gtk_box_pack_start (GTK_BOX (vb), wimage, TRUE, TRUE, 0);
4489 gtk_button_set_focus_on_click (GTK_BUTTON (wb), FALSE);
4490 gtk_button_set_relief (GTK_BUTTON (wb), GTK_RELIEF_NONE);
4491 gtk_container_add (GTK_CONTAINER (wb), vb);
4492 gtk_container_add (GTK_CONTAINER (weventbox), wb);
4493 gtk_container_add (GTK_CONTAINER (ti), weventbox);
4495 if (wimage || label)
4497 intptr_t ii = i;
4498 gpointer gi = (gpointer) ii;
4500 g_signal_connect (G_OBJECT (ti), "create-menu-proxy",
4501 G_CALLBACK (xg_tool_bar_menu_proxy),
4502 gi);
4504 g_signal_connect (G_OBJECT (wb), "clicked",
4505 G_CALLBACK (xg_tool_bar_callback),
4506 gi);
4508 g_object_set_data (G_OBJECT (weventbox), XG_FRAME_DATA, (gpointer)f);
4510 #ifndef HAVE_GTK3
4511 /* Catch expose events to overcome an annoying redraw bug, see
4512 comment for xg_tool_bar_item_expose_callback. */
4513 g_signal_connect (G_OBJECT (ti),
4514 "expose-event",
4515 G_CALLBACK (xg_tool_bar_item_expose_callback),
4517 #endif
4518 gtk_tool_item_set_homogeneous (ti, FALSE);
4520 /* Callback to save modifier mask (Shift/Control, etc). GTK makes
4521 no distinction based on modifiers in the activate callback,
4522 so we have to do it ourselves. */
4523 g_signal_connect (wb, "button-release-event",
4524 G_CALLBACK (xg_tool_bar_button_cb),
4525 NULL);
4527 g_object_set_data (G_OBJECT (wb), XG_FRAME_DATA, (gpointer)f);
4529 /* Use enter/leave notify to show help. We use the events
4530 rather than the GtkButton specific signals "enter" and
4531 "leave", so we can have only one callback. The event
4532 will tell us what kind of event it is. */
4533 g_signal_connect (G_OBJECT (weventbox),
4534 "enter-notify-event",
4535 G_CALLBACK (xg_tool_bar_help_callback),
4536 gi);
4537 g_signal_connect (G_OBJECT (weventbox),
4538 "leave-notify-event",
4539 G_CALLBACK (xg_tool_bar_help_callback),
4540 gi);
4543 if (wbutton) *wbutton = wb;
4545 return ti;
4548 static bool
4549 is_box_type (GtkWidget *vb, bool is_horizontal)
4551 #ifdef HAVE_GTK3
4552 bool ret = 0;
4553 if (GTK_IS_BOX (vb))
4555 GtkOrientation ori = gtk_orientable_get_orientation (GTK_ORIENTABLE (vb));
4556 ret = (ori == GTK_ORIENTATION_HORIZONTAL && is_horizontal)
4557 || (ori == GTK_ORIENTATION_VERTICAL && ! is_horizontal);
4559 return ret;
4560 #else
4561 return is_horizontal ? GTK_IS_VBOX (vb) : GTK_IS_HBOX (vb);
4562 #endif
4566 static bool
4567 xg_tool_item_stale_p (GtkWidget *wbutton, const char *stock_name,
4568 const char *icon_name, const struct image *img,
4569 const char *label, bool horiz)
4571 gpointer old;
4572 GtkWidget *wimage;
4573 GtkWidget *vb = XG_BIN_CHILD (wbutton);
4574 GtkWidget *wlbl = xg_get_tool_bar_widgets (vb, &wimage);
4576 /* Check if the tool icon matches. */
4577 if (stock_name && wimage)
4579 old = g_object_get_data (G_OBJECT (wimage),
4580 XG_TOOL_BAR_STOCK_NAME);
4581 if (!old || strcmp (old, stock_name))
4582 return 1;
4584 else if (icon_name && wimage)
4586 old = g_object_get_data (G_OBJECT (wimage),
4587 XG_TOOL_BAR_ICON_NAME);
4588 if (!old || strcmp (old, icon_name))
4589 return 1;
4591 else if (wimage)
4593 gpointer gold_img = g_object_get_data (G_OBJECT (wimage),
4594 XG_TOOL_BAR_IMAGE_DATA);
4595 Pixmap old_img = (Pixmap) gold_img;
4596 if (old_img != img->pixmap)
4597 return 1;
4600 /* Check button configuration and label. */
4601 if (is_box_type (vb, horiz)
4602 || (label ? (wlbl == NULL) : (wlbl != NULL)))
4603 return 1;
4605 /* Ensure label is correct. */
4606 if (label && wlbl)
4607 gtk_label_set_text (GTK_LABEL (wlbl), label);
4608 return 0;
4611 static bool
4612 xg_update_tool_bar_sizes (struct frame *f)
4614 struct x_output *x = f->output_data.x;
4615 GtkRequisition req;
4616 int nl = 0, nr = 0, nt = 0, nb = 0;
4617 GtkWidget *top_widget = TOOLBAR_TOP_WIDGET (x);
4619 gtk_widget_get_preferred_size (GTK_WIDGET (top_widget), NULL, &req);
4620 if (x->toolbar_in_hbox)
4622 int pos;
4623 gtk_container_child_get (GTK_CONTAINER (x->hbox_widget),
4624 top_widget,
4625 "position", &pos, NULL);
4626 if (pos == 0) nl = req.width;
4627 else nr = req.width;
4629 else
4631 int pos;
4632 gtk_container_child_get (GTK_CONTAINER (x->vbox_widget),
4633 top_widget,
4634 "position", &pos, NULL);
4635 if (pos == 0 || (pos == 1 && x->menubar_widget)) nt = req.height;
4636 else nb = req.height;
4639 if (nl != FRAME_TOOLBAR_LEFT_WIDTH (f)
4640 || nr != FRAME_TOOLBAR_RIGHT_WIDTH (f)
4641 || nt != FRAME_TOOLBAR_TOP_HEIGHT (f)
4642 || nb != FRAME_TOOLBAR_BOTTOM_HEIGHT (f))
4644 FRAME_TOOLBAR_RIGHT_WIDTH (f) = FRAME_TOOLBAR_LEFT_WIDTH (f)
4645 = FRAME_TOOLBAR_TOP_HEIGHT (f) = FRAME_TOOLBAR_BOTTOM_HEIGHT (f) = 0;
4646 FRAME_TOOLBAR_LEFT_WIDTH (f) = nl;
4647 FRAME_TOOLBAR_RIGHT_WIDTH (f) = nr;
4648 FRAME_TOOLBAR_TOP_HEIGHT (f) = nt;
4649 FRAME_TOOLBAR_BOTTOM_HEIGHT (f) = nb;
4650 return 1;
4653 return 0;
4657 /* Update the tool bar for frame F. Add new buttons and remove old. */
4659 void
4660 update_frame_tool_bar (struct frame *f)
4662 int i, j;
4663 struct x_output *x = f->output_data.x;
4664 int hmargin = 0, vmargin = 0;
4665 GtkToolbar *wtoolbar;
4666 GtkToolItem *ti;
4667 GtkTextDirection dir;
4668 Lisp_Object style;
4669 bool text_image, horiz;
4670 struct xg_frame_tb_info *tbinfo;
4672 if (! FRAME_GTK_WIDGET (f))
4673 return;
4675 block_input ();
4677 if (RANGED_INTEGERP (1, Vtool_bar_button_margin, INT_MAX))
4679 hmargin = XFASTINT (Vtool_bar_button_margin);
4680 vmargin = XFASTINT (Vtool_bar_button_margin);
4682 else if (CONSP (Vtool_bar_button_margin))
4684 if (RANGED_INTEGERP (1, XCAR (Vtool_bar_button_margin), INT_MAX))
4685 hmargin = XFASTINT (XCAR (Vtool_bar_button_margin));
4687 if (RANGED_INTEGERP (1, XCDR (Vtool_bar_button_margin), INT_MAX))
4688 vmargin = XFASTINT (XCDR (Vtool_bar_button_margin));
4691 /* The natural size (i.e. when GTK uses 0 as margin) looks best,
4692 so take DEFAULT_TOOL_BAR_BUTTON_MARGIN to mean "default for GTK",
4693 i.e. zero. This means that margins less than
4694 DEFAULT_TOOL_BAR_BUTTON_MARGIN has no effect. */
4695 hmargin = max (0, hmargin - DEFAULT_TOOL_BAR_BUTTON_MARGIN);
4696 vmargin = max (0, vmargin - DEFAULT_TOOL_BAR_BUTTON_MARGIN);
4698 if (! x->toolbar_widget)
4699 xg_create_tool_bar (f);
4701 wtoolbar = GTK_TOOLBAR (x->toolbar_widget);
4702 dir = gtk_widget_get_direction (GTK_WIDGET (wtoolbar));
4704 style = Ftool_bar_get_system_style ();
4706 /* Are we up to date? */
4707 tbinfo = g_object_get_data (G_OBJECT (FRAME_GTK_OUTER_WIDGET (f)),
4708 TB_INFO_KEY);
4710 if (! NILP (tbinfo->last_tool_bar) && ! NILP (f->tool_bar_items)
4711 && tbinfo->n_last_items == f->n_tool_bar_items
4712 && tbinfo->hmargin == hmargin && tbinfo->vmargin == vmargin
4713 && tbinfo->dir == dir
4714 && ! NILP (Fequal (tbinfo->style, style))
4715 && ! NILP (Fequal (tbinfo->last_tool_bar, f->tool_bar_items)))
4717 unblock_input ();
4718 return;
4721 tbinfo->last_tool_bar = f->tool_bar_items;
4722 tbinfo->n_last_items = f->n_tool_bar_items;
4723 tbinfo->style = style;
4724 tbinfo->hmargin = hmargin;
4725 tbinfo->vmargin = vmargin;
4726 tbinfo->dir = dir;
4728 text_image = EQ (style, Qtext_image_horiz);
4729 horiz = EQ (style, Qboth_horiz) || text_image;
4731 for (i = j = 0; i < f->n_tool_bar_items; ++i)
4733 bool enabled_p = !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P));
4734 bool selected_p = !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P));
4735 int idx;
4736 ptrdiff_t img_id;
4737 int icon_size = 0;
4738 struct image *img = NULL;
4739 Lisp_Object image;
4740 Lisp_Object stock = Qnil;
4741 GtkStockItem stock_item;
4742 char *stock_name = NULL;
4743 char *icon_name = NULL;
4744 Lisp_Object rtl;
4745 GtkWidget *wbutton = NULL;
4746 Lisp_Object specified_file;
4747 bool vert_only = ! NILP (PROP (TOOL_BAR_ITEM_VERT_ONLY));
4748 const char *label
4749 = (EQ (style, Qimage) || (vert_only && horiz)) ? NULL
4750 : STRINGP (PROP (TOOL_BAR_ITEM_LABEL))
4751 ? SSDATA (PROP (TOOL_BAR_ITEM_LABEL))
4752 : "";
4754 ti = gtk_toolbar_get_nth_item (GTK_TOOLBAR (wtoolbar), j);
4756 /* If this is a separator, use a gtk separator item. */
4757 if (EQ (PROP (TOOL_BAR_ITEM_TYPE), Qt))
4759 if (ti == NULL || !GTK_IS_SEPARATOR_TOOL_ITEM (ti))
4761 if (ti)
4762 gtk_container_remove (GTK_CONTAINER (wtoolbar),
4763 GTK_WIDGET (ti));
4764 ti = gtk_separator_tool_item_new ();
4765 gtk_toolbar_insert (GTK_TOOLBAR (wtoolbar), ti, j);
4767 j++;
4768 continue;
4771 /* Otherwise, the tool-bar item is an ordinary button. */
4773 if (ti && GTK_IS_SEPARATOR_TOOL_ITEM (ti))
4775 gtk_container_remove (GTK_CONTAINER (wtoolbar), GTK_WIDGET (ti));
4776 ti = NULL;
4779 if (ti) wbutton = XG_BIN_CHILD (XG_BIN_CHILD (ti));
4781 /* Ignore invalid image specifications. */
4782 image = PROP (TOOL_BAR_ITEM_IMAGES);
4783 if (!valid_image_p (image))
4785 if (ti)
4786 gtk_container_remove (GTK_CONTAINER (wtoolbar),
4787 GTK_WIDGET (ti));
4788 continue;
4791 specified_file = file_for_image (image);
4792 if (!NILP (specified_file) && !NILP (Ffboundp (Qx_gtk_map_stock)))
4793 stock = call1 (Qx_gtk_map_stock, specified_file);
4795 if (STRINGP (stock))
4797 stock_name = SSDATA (stock);
4798 if (stock_name[0] == 'n' && stock_name[1] == ':')
4800 GdkScreen *screen = gtk_widget_get_screen (GTK_WIDGET (wtoolbar));
4801 GtkIconTheme *icon_theme = gtk_icon_theme_get_for_screen (screen);
4803 icon_name = stock_name + 2;
4804 stock_name = NULL;
4805 stock = Qnil;
4807 if (! gtk_icon_theme_has_icon (icon_theme, icon_name))
4808 icon_name = NULL;
4809 else
4810 icon_size = gtk_toolbar_get_icon_size (wtoolbar);
4812 else if (gtk_stock_lookup (SSDATA (stock), &stock_item))
4813 icon_size = gtk_toolbar_get_icon_size (wtoolbar);
4814 else
4816 stock = Qnil;
4817 stock_name = NULL;
4821 if (stock_name == NULL && icon_name == NULL)
4823 /* No stock image, or stock item not known. Try regular
4824 image. If image is a vector, choose it according to the
4825 button state. */
4826 if (dir == GTK_TEXT_DIR_RTL
4827 && !NILP (rtl = PROP (TOOL_BAR_ITEM_RTL_IMAGE))
4828 && STRINGP (rtl))
4829 image = find_rtl_image (f, image, rtl);
4831 if (VECTORP (image))
4833 if (enabled_p)
4834 idx = (selected_p
4835 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
4836 : TOOL_BAR_IMAGE_ENABLED_DESELECTED);
4837 else
4838 idx = (selected_p
4839 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
4840 : TOOL_BAR_IMAGE_DISABLED_DESELECTED);
4842 eassert (ASIZE (image) >= idx);
4843 image = AREF (image, idx);
4845 else
4846 idx = -1;
4848 img_id = lookup_image (f, image);
4849 img = IMAGE_FROM_ID (f, img_id);
4850 prepare_image_for_display (f, img);
4852 if (img->load_failed_p || img->pixmap == None)
4854 if (ti)
4855 gtk_container_remove (GTK_CONTAINER (wtoolbar),
4856 GTK_WIDGET (ti));
4857 continue;
4861 /* If there is an existing widget, check if it's stale; if so,
4862 remove it and make a new tool item from scratch. */
4863 if (ti && xg_tool_item_stale_p (wbutton, stock_name, icon_name,
4864 img, label, horiz))
4866 gtk_container_remove (GTK_CONTAINER (wtoolbar),
4867 GTK_WIDGET (ti));
4868 ti = NULL;
4871 if (ti == NULL)
4873 GtkWidget *w;
4875 /* Save the image so we can see if an update is needed the
4876 next time we call xg_tool_item_match_p. */
4877 if (EQ (style, Qtext))
4878 w = NULL;
4879 else if (stock_name)
4881 w = gtk_image_new_from_stock (stock_name, icon_size);
4882 g_object_set_data_full (G_OBJECT (w), XG_TOOL_BAR_STOCK_NAME,
4883 (gpointer) xstrdup (stock_name),
4884 (GDestroyNotify) xfree);
4886 else if (icon_name)
4888 w = gtk_image_new_from_icon_name (icon_name, icon_size);
4889 g_object_set_data_full (G_OBJECT (w), XG_TOOL_BAR_ICON_NAME,
4890 (gpointer) xstrdup (icon_name),
4891 (GDestroyNotify) xfree);
4893 else
4895 w = xg_get_image_for_pixmap (f, img, x->widget, NULL);
4896 g_object_set_data (G_OBJECT (w), XG_TOOL_BAR_IMAGE_DATA,
4897 (gpointer)img->pixmap);
4900 if (w) gtk_misc_set_padding (GTK_MISC (w), hmargin, vmargin);
4901 ti = xg_make_tool_item (f, w, &wbutton, label, i, horiz, text_image);
4902 gtk_toolbar_insert (GTK_TOOLBAR (wtoolbar), ti, j);
4905 #undef PROP
4907 gtk_widget_set_sensitive (wbutton, enabled_p);
4908 j++;
4911 /* Remove buttons not longer needed. */
4914 ti = gtk_toolbar_get_nth_item (GTK_TOOLBAR (wtoolbar), j);
4915 if (ti)
4916 gtk_container_remove (GTK_CONTAINER (wtoolbar), GTK_WIDGET (ti));
4917 } while (ti != NULL);
4919 if (f->n_tool_bar_items != 0)
4921 if (! x->toolbar_is_packed)
4922 xg_pack_tool_bar (f, f->tool_bar_position);
4923 gtk_widget_show_all (TOOLBAR_TOP_WIDGET (x));
4924 if (xg_update_tool_bar_sizes (f))
4925 xg_height_or_width_changed (f);
4928 unblock_input ();
4931 /* Deallocate all resources for the tool bar on frame F.
4932 Remove the tool bar. */
4934 void
4935 free_frame_tool_bar (struct frame *f)
4937 struct x_output *x = f->output_data.x;
4939 if (x->toolbar_widget)
4941 struct xg_frame_tb_info *tbinfo;
4942 GtkWidget *top_widget = TOOLBAR_TOP_WIDGET (x);
4944 block_input ();
4945 /* We may have created the toolbar_widget in xg_create_tool_bar, but
4946 not the x->handlebox_widget which is created in xg_pack_tool_bar. */
4947 if (x->toolbar_is_packed)
4949 if (x->toolbar_in_hbox)
4950 gtk_container_remove (GTK_CONTAINER (x->hbox_widget),
4951 top_widget);
4952 else
4953 gtk_container_remove (GTK_CONTAINER (x->vbox_widget),
4954 top_widget);
4956 else
4957 gtk_widget_destroy (x->toolbar_widget);
4959 x->toolbar_widget = 0;
4960 TOOLBAR_TOP_WIDGET (x) = 0;
4961 x->toolbar_is_packed = false;
4962 FRAME_TOOLBAR_TOP_HEIGHT (f) = FRAME_TOOLBAR_BOTTOM_HEIGHT (f) = 0;
4963 FRAME_TOOLBAR_LEFT_WIDTH (f) = FRAME_TOOLBAR_RIGHT_WIDTH (f) = 0;
4965 tbinfo = g_object_get_data (G_OBJECT (FRAME_GTK_OUTER_WIDGET (f)),
4966 TB_INFO_KEY);
4967 if (tbinfo)
4969 xfree (tbinfo);
4970 g_object_set_data (G_OBJECT (FRAME_GTK_OUTER_WIDGET (f)),
4971 TB_INFO_KEY,
4972 NULL);
4975 xg_height_or_width_changed (f);
4977 unblock_input ();
4981 void
4982 xg_change_toolbar_position (struct frame *f, Lisp_Object pos)
4984 struct x_output *x = f->output_data.x;
4985 GtkWidget *top_widget = TOOLBAR_TOP_WIDGET (x);
4987 if (! x->toolbar_widget || ! top_widget)
4988 return;
4990 block_input ();
4991 g_object_ref (top_widget);
4992 if (x->toolbar_is_packed)
4994 if (x->toolbar_in_hbox)
4995 gtk_container_remove (GTK_CONTAINER (x->hbox_widget),
4996 top_widget);
4997 else
4998 gtk_container_remove (GTK_CONTAINER (x->vbox_widget),
4999 top_widget);
5002 xg_pack_tool_bar (f, pos);
5003 g_object_unref (top_widget);
5004 if (xg_update_tool_bar_sizes (f))
5005 xg_height_or_width_changed (f);
5007 unblock_input ();
5012 /***********************************************************************
5013 Initializing
5014 ***********************************************************************/
5015 void
5016 xg_initialize (void)
5018 GtkBindingSet *binding_set;
5019 GtkSettings *settings;
5021 #if HAVE_XFT
5022 /* Work around a bug with corrupted data if libXft gets unloaded. This way
5023 we keep it permanently linked in. */
5024 XftInit (0);
5025 #endif
5027 gdpy_def = NULL;
5028 xg_ignore_gtk_scrollbar = 0;
5029 #ifdef HAVE_GTK_TEAROFF_MENU_ITEM_NEW
5030 xg_detached_menus = 0;
5031 #endif
5032 xg_menu_cb_list.prev = xg_menu_cb_list.next =
5033 xg_menu_item_cb_list.prev = xg_menu_item_cb_list.next = 0;
5035 id_to_widget.max_size = id_to_widget.used = 0;
5036 id_to_widget.widgets = 0;
5038 settings = gtk_settings_get_for_screen (gdk_display_get_default_screen
5039 (gdk_display_get_default ()));
5040 /* Remove F10 as a menu accelerator, it does not mix well with Emacs key
5041 bindings. It doesn't seem to be any way to remove properties,
5042 so we set it to "" which in means "no key". */
5043 gtk_settings_set_string_property (settings,
5044 "gtk-menu-bar-accel",
5046 EMACS_CLASS);
5048 /* Make GTK text input widgets use Emacs style keybindings. This is
5049 Emacs after all. */
5050 gtk_settings_set_string_property (settings,
5051 "gtk-key-theme-name",
5052 "Emacs",
5053 EMACS_CLASS);
5055 /* Make dialogs close on C-g. Since file dialog inherits from
5056 dialog, this works for them also. */
5057 binding_set = gtk_binding_set_by_class (g_type_class_ref (GTK_TYPE_DIALOG));
5058 gtk_binding_entry_add_signal (binding_set, GDK_KEY_g, GDK_CONTROL_MASK,
5059 "close", 0);
5061 /* Make menus close on C-g. */
5062 binding_set = gtk_binding_set_by_class (g_type_class_ref
5063 (GTK_TYPE_MENU_SHELL));
5064 gtk_binding_entry_add_signal (binding_set, GDK_KEY_g, GDK_CONTROL_MASK,
5065 "cancel", 0);
5066 update_theme_scrollbar_width ();
5068 #ifdef HAVE_FREETYPE
5069 x_last_font_name = NULL;
5070 #endif
5073 #endif /* USE_GTK */