Avoid undefined behavior in color table hashing.
[emacs.git] / src / gtkutil.c
blob6db8858923d9d7bfa9147edcba52ef40b5ea1971
1 /* Functions for creating and updating GTK widgets.
3 Copyright (C) 2003-2014 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 "buffer.h"
34 #include "gtkutil.h"
35 #include "termhooks.h"
36 #include "keyboard.h"
37 #include "charset.h"
38 #include "coding.h"
39 #include "font.h"
41 #include <gdk/gdkkeysyms.h>
42 #include "xsettings.h"
44 #ifdef HAVE_XFT
45 #include <X11/Xft/Xft.h>
46 #endif
48 #ifdef HAVE_GTK3
49 #include <gtk/gtkx.h>
50 #include "emacsgtkfixed.h"
51 #endif
53 /** #define FRAME_TOTAL_PIXEL_HEIGHT(f) \ **/
54 /** (FRAME_PIXEL_HEIGHT (f) + FRAME_MENUBAR_HEIGHT (f) + FRAME_TOOLBAR_HEIGHT (f)) **/
56 /** #define FRAME_TOTAL_PIXEL_WIDTH(f) \ **/
57 /** (FRAME_PIXEL_WIDTH (f) + FRAME_TOOLBAR_WIDTH (f)) **/
59 #ifndef HAVE_GTK_WIDGET_SET_HAS_WINDOW
60 #define gtk_widget_set_has_window(w, b) \
61 (gtk_fixed_set_has_window (GTK_FIXED (w), b))
62 #endif
63 #ifndef HAVE_GTK_DIALOG_GET_ACTION_AREA
64 #define gtk_dialog_get_action_area(w) ((w)->action_area)
65 #define gtk_dialog_get_content_area(w) ((w)->vbox)
66 #endif
67 #ifndef HAVE_GTK_WIDGET_GET_SENSITIVE
68 #define gtk_widget_get_sensitive(w) (GTK_WIDGET_SENSITIVE (w))
69 #endif
70 #ifndef HAVE_GTK_ADJUSTMENT_GET_PAGE_SIZE
71 #define gtk_adjustment_set_page_size(w, s) ((w)->page_size = (s))
72 #define gtk_adjustment_set_page_increment(w, s) ((w)->page_increment = (s))
73 #define gtk_adjustment_get_step_increment(w) ((w)->step_increment)
74 #define gtk_adjustment_set_step_increment(w, s) ((w)->step_increment = (s))
75 #endif
76 #if GTK_CHECK_VERSION (2, 12, 0)
77 #define remove_submenu(w) gtk_menu_item_set_submenu ((w), NULL)
78 #else
79 #define remove_submenu(w) gtk_menu_item_remove_submenu ((w))
80 #endif
82 #ifdef HAVE_FREETYPE
83 #if GTK_CHECK_VERSION (3, 2, 0)
84 #define USE_NEW_GTK_FONT_CHOOSER 1
85 #else
86 #define USE_NEW_GTK_FONT_CHOOSER 0
87 #define gtk_font_chooser_dialog_new(x, y) \
88 gtk_font_selection_dialog_new (x)
89 #undef GTK_FONT_CHOOSER
90 #define GTK_FONT_CHOOSER(x) GTK_FONT_SELECTION_DIALOG (x)
91 #define gtk_font_chooser_set_font(x, y) \
92 gtk_font_selection_dialog_set_font_name (x, y)
93 #endif
94 #endif /* HAVE_FREETYPE */
96 #if GTK_CHECK_VERSION (3, 10, 0)
97 #define XG_TEXT_CANCEL "Cancel"
98 #define XG_TEXT_OK "OK"
99 #define XG_TEXT_OPEN "Open"
100 #else
101 #define XG_TEXT_CANCEL GTK_STOCK_CANCEL
102 #define XG_TEXT_OK GTK_STOCK_OK
103 #define XG_TEXT_OPEN GTK_STOCK_OPEN
104 #endif
106 #ifndef HAVE_GTK3
107 #ifdef USE_GTK_TOOLTIP
108 #define gdk_window_get_screen(w) gdk_drawable_get_screen (w)
109 #endif
110 #define gdk_window_get_geometry(w, a, b, c, d) \
111 gdk_window_get_geometry (w, a, b, c, d, 0)
112 #define gdk_x11_window_lookup_for_display(d, w) \
113 gdk_xid_table_lookup_for_display (d, w)
114 #define gtk_box_new(ori, spacing) \
115 ((ori) == GTK_ORIENTATION_HORIZONTAL \
116 ? gtk_hbox_new (FALSE, (spacing)) : gtk_vbox_new (FALSE, (spacing)))
117 #define gtk_scrollbar_new(ori, spacing) \
118 ((ori) == GTK_ORIENTATION_HORIZONTAL \
119 ? gtk_hscrollbar_new ((spacing)) : gtk_vscrollbar_new ((spacing)))
120 #ifndef GDK_KEY_g
121 #define GDK_KEY_g GDK_g
122 #endif
123 #endif /* HAVE_GTK3 */
125 #define XG_BIN_CHILD(x) gtk_bin_get_child (GTK_BIN (x))
127 static void update_theme_scrollbar_width (void);
128 static void update_theme_scrollbar_height (void);
130 #define TB_INFO_KEY "xg_frame_tb_info"
131 struct xg_frame_tb_info
133 Lisp_Object last_tool_bar;
134 Lisp_Object style;
135 int n_last_items;
136 int hmargin, vmargin;
137 GtkTextDirection dir;
141 /***********************************************************************
142 Display handling functions
143 ***********************************************************************/
145 /* Keep track of the default display, or NULL if there is none. Emacs
146 may close all its displays. */
148 static GdkDisplay *gdpy_def;
150 /* When the GTK widget W is to be created on a display for F that
151 is not the default display, set the display for W.
152 W can be a GtkMenu or a GtkWindow widget. */
154 static void
155 xg_set_screen (GtkWidget *w, struct frame *f)
157 if (FRAME_X_DISPLAY (f) != DEFAULT_GDK_DISPLAY ())
159 GdkDisplay *gdpy = gdk_x11_lookup_xdisplay (FRAME_X_DISPLAY (f));
160 GdkScreen *gscreen = gdk_display_get_default_screen (gdpy);
162 if (GTK_IS_MENU (w))
163 gtk_menu_set_screen (GTK_MENU (w), gscreen);
164 else
165 gtk_window_set_screen (GTK_WINDOW (w), gscreen);
170 /* Open a display named by DISPLAY_NAME. The display is returned in *DPY.
171 *DPY is set to NULL if the display can't be opened.
173 Returns non-zero if display could be opened, zero if display could not
174 be opened, and less than zero if the GTK version doesn't support
175 multiple displays. */
177 void
178 xg_display_open (char *display_name, Display **dpy)
180 GdkDisplay *gdpy;
182 gdpy = gdk_display_open (display_name);
183 if (!gdpy_def && gdpy)
185 gdpy_def = gdpy;
186 gdk_display_manager_set_default_display (gdk_display_manager_get (),
187 gdpy);
190 *dpy = gdpy ? GDK_DISPLAY_XDISPLAY (gdpy) : NULL;
194 /* Close display DPY. */
196 void
197 xg_display_close (Display *dpy)
199 GdkDisplay *gdpy = gdk_x11_lookup_xdisplay (dpy);
201 /* If this is the default display, try to change it before closing.
202 If there is no other display to use, gdpy_def is set to NULL, and
203 the next call to xg_display_open resets the default display. */
204 if (gdk_display_get_default () == gdpy)
206 struct x_display_info *dpyinfo;
207 GdkDisplay *gdpy_new = NULL;
209 /* Find another display. */
210 for (dpyinfo = x_display_list; dpyinfo; dpyinfo = dpyinfo->next)
211 if (dpyinfo->display != dpy)
213 gdpy_new = gdk_x11_lookup_xdisplay (dpyinfo->display);
214 gdk_display_manager_set_default_display (gdk_display_manager_get (),
215 gdpy_new);
216 break;
218 gdpy_def = gdpy_new;
221 #if GTK_CHECK_VERSION (2, 0, 0) && ! GTK_CHECK_VERSION (2, 10, 0)
222 /* GTK 2.2-2.8 has a bug that makes gdk_display_close crash (bug
223 http://bugzilla.gnome.org/show_bug.cgi?id=85715). This way we
224 can continue running, but there will be memory leaks. */
225 g_object_run_dispose (G_OBJECT (gdpy));
226 #else
227 /* This seems to be fixed in GTK 2.10. */
228 gdk_display_close (gdpy);
229 #endif
233 /***********************************************************************
234 Utility functions
235 ***********************************************************************/
237 /* Create and return the cursor to be used for popup menus and
238 scroll bars on display DPY. */
240 GdkCursor *
241 xg_create_default_cursor (Display *dpy)
243 GdkDisplay *gdpy = gdk_x11_lookup_xdisplay (dpy);
244 return gdk_cursor_new_for_display (gdpy, GDK_LEFT_PTR);
247 static GdkPixbuf *
248 xg_get_pixbuf_from_pixmap (struct frame *f, Pixmap pix)
250 int iunused;
251 GdkPixbuf *tmp_buf;
252 Window wunused;
253 unsigned int width, height, uunused;
254 XImage *xim;
256 XGetGeometry (FRAME_X_DISPLAY (f), pix, &wunused, &iunused, &iunused,
257 &width, &height, &uunused, &uunused);
259 xim = XGetImage (FRAME_X_DISPLAY (f), pix, 0, 0, width, height,
260 ~0, XYPixmap);
261 if (!xim) return 0;
263 tmp_buf = gdk_pixbuf_new_from_data ((guchar *) xim->data,
264 GDK_COLORSPACE_RGB,
265 FALSE,
266 xim->bitmap_unit,
267 width,
268 height,
269 xim->bytes_per_line,
270 NULL,
271 NULL);
272 XDestroyImage (xim);
273 return tmp_buf;
276 /* Apply GMASK to GPIX and return a GdkPixbuf with an alpha channel. */
278 static GdkPixbuf *
279 xg_get_pixbuf_from_pix_and_mask (struct frame *f,
280 Pixmap pix,
281 Pixmap mask)
283 int width, height;
284 GdkPixbuf *icon_buf, *tmp_buf;
286 tmp_buf = xg_get_pixbuf_from_pixmap (f, pix);
287 icon_buf = gdk_pixbuf_add_alpha (tmp_buf, FALSE, 0, 0, 0);
288 g_object_unref (G_OBJECT (tmp_buf));
290 width = gdk_pixbuf_get_width (icon_buf);
291 height = gdk_pixbuf_get_height (icon_buf);
293 if (mask)
295 GdkPixbuf *mask_buf = xg_get_pixbuf_from_pixmap (f, mask);
296 guchar *pixels = gdk_pixbuf_get_pixels (icon_buf);
297 guchar *mask_pixels = gdk_pixbuf_get_pixels (mask_buf);
298 int rowstride = gdk_pixbuf_get_rowstride (icon_buf);
299 int mask_rowstride = gdk_pixbuf_get_rowstride (mask_buf);
300 int y;
302 for (y = 0; y < height; ++y)
304 guchar *iconptr, *maskptr;
305 int x;
307 iconptr = pixels + y * rowstride;
308 maskptr = mask_pixels + y * mask_rowstride;
310 for (x = 0; x < width; ++x)
312 /* In a bitmap, RGB is either 255/255/255 or 0/0/0. Checking
313 just R is sufficient. */
314 if (maskptr[0] == 0)
315 iconptr[3] = 0; /* 0, 1, 2 is R, G, B. 3 is alpha. */
317 iconptr += rowstride/width;
318 maskptr += mask_rowstride/width;
322 g_object_unref (G_OBJECT (mask_buf));
325 return icon_buf;
328 static Lisp_Object
329 file_for_image (Lisp_Object image)
331 Lisp_Object specified_file = Qnil;
332 Lisp_Object tail;
334 for (tail = XCDR (image);
335 NILP (specified_file) && CONSP (tail) && CONSP (XCDR (tail));
336 tail = XCDR (XCDR (tail)))
337 if (EQ (XCAR (tail), QCfile))
338 specified_file = XCAR (XCDR (tail));
340 return specified_file;
343 /* For the image defined in IMG, make and return a GtkImage. For displays with
344 8 planes or less we must make a GdkPixbuf and apply the mask manually.
345 Otherwise the highlighting and dimming the tool bar code in GTK does
346 will look bad. For display with more than 8 planes we just use the
347 pixmap and mask directly. For monochrome displays, GTK doesn't seem
348 able to use external pixmaps, it looks bad whatever we do.
349 The image is defined on the display where frame F is.
350 WIDGET is used to find the GdkColormap to use for the GdkPixbuf.
351 If OLD_WIDGET is NULL, a new widget is constructed and returned.
352 If OLD_WIDGET is not NULL, that widget is modified. */
354 static GtkWidget *
355 xg_get_image_for_pixmap (struct frame *f,
356 struct image *img,
357 GtkWidget *widget,
358 GtkImage *old_widget)
360 GdkPixbuf *icon_buf;
362 /* If we have a file, let GTK do all the image handling.
363 This seems to be the only way to make insensitive and activated icons
364 look good in all cases. */
365 Lisp_Object specified_file = file_for_image (img->spec);
366 Lisp_Object file;
368 /* We already loaded the image once before calling this
369 function, so this only fails if the image file has been removed.
370 In that case, use the pixmap already loaded. */
372 if (STRINGP (specified_file)
373 && STRINGP (file = x_find_image_file (specified_file)))
375 if (! old_widget)
376 old_widget = GTK_IMAGE (gtk_image_new_from_file (SSDATA (file)));
377 else
378 gtk_image_set_from_file (old_widget, SSDATA (file));
380 return GTK_WIDGET (old_widget);
383 /* No file, do the image handling ourselves. This will look very bad
384 on a monochrome display, and sometimes bad on all displays with
385 certain themes. */
387 /* This is a workaround to make icons look good on pseudo color
388 displays. Apparently GTK expects the images to have an alpha
389 channel. If they don't, insensitive and activated icons will
390 look bad. This workaround does not work on monochrome displays,
391 and is strictly not needed on true color/static color displays (i.e.
392 16 bits and higher). But we do it anyway so we get a pixbuf that is
393 not associated with the img->pixmap. The img->pixmap may be removed
394 by clearing the image cache and then the tool bar redraw fails, since
395 Gtk+ assumes the pixmap is always there. */
396 icon_buf = xg_get_pixbuf_from_pix_and_mask (f, img->pixmap, img->mask);
398 if (icon_buf)
400 if (! old_widget)
401 old_widget = GTK_IMAGE (gtk_image_new_from_pixbuf (icon_buf));
402 else
403 gtk_image_set_from_pixbuf (old_widget, icon_buf);
405 g_object_unref (G_OBJECT (icon_buf));
408 return GTK_WIDGET (old_widget);
412 /* Set CURSOR on W and all widgets W contain. We must do like this
413 for scroll bars and menu because they create widgets internally,
414 and it is those widgets that are visible. */
416 static void
417 xg_set_cursor (GtkWidget *w, GdkCursor *cursor)
419 GdkWindow *window = gtk_widget_get_window (w);
420 GList *children = gdk_window_peek_children (window);
422 gdk_window_set_cursor (window, cursor);
424 /* The scroll bar widget has more than one GDK window (had to look at
425 the source to figure this out), and there is no way to set cursor
426 on widgets in GTK. So we must set the cursor for all GDK windows.
427 Ditto for menus. */
429 for ( ; children; children = g_list_next (children))
430 gdk_window_set_cursor (GDK_WINDOW (children->data), cursor);
433 /* Insert NODE into linked LIST. */
435 static void
436 xg_list_insert (xg_list_node *list, xg_list_node *node)
438 xg_list_node *list_start = list->next;
440 if (list_start) list_start->prev = node;
441 node->next = list_start;
442 node->prev = 0;
443 list->next = node;
446 /* Remove NODE from linked LIST. */
448 static void
449 xg_list_remove (xg_list_node *list, xg_list_node *node)
451 xg_list_node *list_start = list->next;
452 if (node == list_start)
454 list->next = node->next;
455 if (list->next) list->next->prev = 0;
457 else
459 node->prev->next = node->next;
460 if (node->next) node->next->prev = node->prev;
464 /* Allocate and return a utf8 version of STR. If STR is already
465 utf8 or NULL, just return a copy of STR.
466 A new string is allocated and the caller must free the result
467 with g_free. */
469 static char *
470 get_utf8_string (const char *str)
472 char *utf8_str;
474 if (!str) return NULL;
476 /* If not UTF-8, try current locale. */
477 if (!g_utf8_validate (str, -1, NULL))
478 utf8_str = g_locale_to_utf8 (str, -1, 0, 0, 0);
479 else
480 return g_strdup (str);
482 if (!utf8_str)
484 /* Probably some control characters in str. Escape them. */
485 ptrdiff_t len;
486 ptrdiff_t nr_bad = 0;
487 gsize bytes_read;
488 gsize bytes_written;
489 unsigned char *p = (unsigned char *)str;
490 char *cp, *up;
491 GError *err = NULL;
493 while (! (cp = g_locale_to_utf8 ((char *)p, -1, &bytes_read,
494 &bytes_written, &err))
495 && err->code == G_CONVERT_ERROR_ILLEGAL_SEQUENCE)
497 ++nr_bad;
498 p += bytes_written+1;
499 g_error_free (err);
500 err = NULL;
503 if (err)
505 g_error_free (err);
506 err = NULL;
508 if (cp) g_free (cp);
510 len = strlen (str);
511 if ((min (PTRDIFF_MAX, SIZE_MAX) - len - 1) / 4 < nr_bad)
512 memory_full (SIZE_MAX);
513 up = utf8_str = xmalloc (len + nr_bad * 4 + 1);
514 p = (unsigned char *)str;
516 while (! (cp = g_locale_to_utf8 ((char *)p, -1, &bytes_read,
517 &bytes_written, &err))
518 && err->code == G_CONVERT_ERROR_ILLEGAL_SEQUENCE)
520 memcpy (up, p, bytes_written);
521 up += bytes_written;
522 up += sprintf (up, "\\%03o", p[bytes_written]);
523 p += bytes_written + 1;
524 g_error_free (err);
525 err = NULL;
528 if (cp)
530 strcpy (up, cp);
531 g_free (cp);
533 if (err)
535 g_error_free (err);
536 err = NULL;
539 return utf8_str;
542 /* Check for special colors used in face spec for region face.
543 The colors are fetched from the Gtk+ theme.
544 Return true if color was found, false if not. */
546 bool
547 xg_check_special_colors (struct frame *f,
548 const char *color_name,
549 XColor *color)
551 bool success_p = 0;
552 bool get_bg = strcmp ("gtk_selection_bg_color", color_name) == 0;
553 bool get_fg = !get_bg && strcmp ("gtk_selection_fg_color", color_name) == 0;
555 if (! FRAME_GTK_WIDGET (f) || ! (get_bg || get_fg))
556 return success_p;
558 block_input ();
560 #ifdef HAVE_GTK3
561 GtkStyleContext *gsty
562 = gtk_widget_get_style_context (FRAME_GTK_OUTER_WIDGET (f));
563 GdkRGBA col;
564 char buf[sizeof "rgb://rrrr/gggg/bbbb"];
565 int state = GTK_STATE_FLAG_SELECTED|GTK_STATE_FLAG_FOCUSED;
566 if (get_fg)
567 gtk_style_context_get_color (gsty, state, &col);
568 else
569 gtk_style_context_get_background_color (gsty, state, &col);
571 sprintf (buf, "rgb:%04x/%04x/%04x",
572 (int)(col.red * 65535),
573 (int)(col.green * 65535),
574 (int)(col.blue * 65535));
575 success_p = (XParseColor (FRAME_X_DISPLAY (f), FRAME_X_COLORMAP (f),
576 buf, color)
577 != 0);
578 #else
579 GtkStyle *gsty = gtk_widget_get_style (FRAME_GTK_WIDGET (f));
580 GdkColor *grgb = get_bg
581 ? &gsty->bg[GTK_STATE_SELECTED]
582 : &gsty->fg[GTK_STATE_SELECTED];
584 color->red = grgb->red;
585 color->green = grgb->green;
586 color->blue = grgb->blue;
587 color->pixel = grgb->pixel;
588 success_p = 1;
589 #endif
592 unblock_input ();
593 return success_p;
598 /***********************************************************************
599 Tooltips
600 ***********************************************************************/
601 /* Gtk+ calls this callback when the parent of our tooltip dummy changes.
602 We use that to pop down the tooltip. This happens if Gtk+ for some
603 reason wants to change or hide the tooltip. */
605 #ifdef USE_GTK_TOOLTIP
607 static void
608 hierarchy_ch_cb (GtkWidget *widget,
609 GtkWidget *previous_toplevel,
610 gpointer user_data)
612 struct frame *f = user_data;
613 struct x_output *x = f->output_data.x;
614 GtkWidget *top = gtk_widget_get_toplevel (x->ttip_lbl);
616 if (! top || ! GTK_IS_WINDOW (top))
617 gtk_widget_hide (previous_toplevel);
620 /* Callback called when Gtk+ thinks a tooltip should be displayed.
621 We use it to get the tooltip window and the tooltip widget so
622 we can manipulate the ourselves.
624 Return FALSE ensures that the tooltip is not shown. */
626 static gboolean
627 qttip_cb (GtkWidget *widget,
628 gint xpos,
629 gint ypos,
630 gboolean keyboard_mode,
631 GtkTooltip *tooltip,
632 gpointer user_data)
634 struct frame *f = user_data;
635 struct x_output *x = f->output_data.x;
636 if (x->ttip_widget == NULL)
638 GtkWidget *p;
639 GList *list, *iter;
641 g_object_set (G_OBJECT (widget), "has-tooltip", FALSE, NULL);
642 x->ttip_widget = tooltip;
643 g_object_ref (G_OBJECT (tooltip));
644 x->ttip_lbl = gtk_label_new ("");
645 g_object_ref (G_OBJECT (x->ttip_lbl));
646 gtk_tooltip_set_custom (tooltip, x->ttip_lbl);
647 x->ttip_window = GTK_WINDOW (gtk_widget_get_toplevel (x->ttip_lbl));
649 /* Change stupid Gtk+ default line wrapping. */
650 p = gtk_widget_get_parent (x->ttip_lbl);
651 list = gtk_container_get_children (GTK_CONTAINER (p));
652 for (iter = list; iter; iter = g_list_next (iter))
654 GtkWidget *w = GTK_WIDGET (iter->data);
655 if (GTK_IS_LABEL (w))
656 gtk_label_set_line_wrap (GTK_LABEL (w), FALSE);
658 g_list_free (list);
660 /* ATK needs an empty title for some reason. */
661 gtk_window_set_title (x->ttip_window, "");
662 /* Realize so we can safely get screen later on. */
663 gtk_widget_realize (GTK_WIDGET (x->ttip_window));
664 gtk_widget_realize (x->ttip_lbl);
666 g_signal_connect (x->ttip_lbl, "hierarchy-changed",
667 G_CALLBACK (hierarchy_ch_cb), f);
669 return FALSE;
672 #endif /* USE_GTK_TOOLTIP */
674 /* Prepare a tooltip to be shown, i.e. calculate WIDTH and HEIGHT.
675 Return true if a system tooltip is available. */
677 bool
678 xg_prepare_tooltip (struct frame *f,
679 Lisp_Object string,
680 int *width,
681 int *height)
683 #ifndef USE_GTK_TOOLTIP
684 return 0;
685 #else
686 struct x_output *x = f->output_data.x;
687 GtkWidget *widget;
688 GdkWindow *gwin;
689 GdkScreen *screen;
690 GtkSettings *settings;
691 gboolean tt_enabled = TRUE;
692 GtkRequisition req;
693 Lisp_Object encoded_string;
695 if (!x->ttip_lbl) return 0;
697 block_input ();
698 encoded_string = ENCODE_UTF_8 (string);
699 widget = GTK_WIDGET (x->ttip_lbl);
700 gwin = gtk_widget_get_window (GTK_WIDGET (x->ttip_window));
701 screen = gdk_window_get_screen (gwin);
702 settings = gtk_settings_get_for_screen (screen);
703 g_object_get (settings, "gtk-enable-tooltips", &tt_enabled, NULL);
704 if (tt_enabled)
706 g_object_set (settings, "gtk-enable-tooltips", FALSE, NULL);
707 /* Record that we disabled it so it can be enabled again. */
708 g_object_set_data (G_OBJECT (x->ttip_window), "restore-tt",
709 (gpointer)f);
712 /* Prevent Gtk+ from hiding tooltip on mouse move and such. */
713 g_object_set_data (G_OBJECT
714 (gtk_widget_get_display (GTK_WIDGET (x->ttip_window))),
715 "gdk-display-current-tooltip", NULL);
717 /* Put our dummy widget in so we can get callbacks for unrealize and
718 hierarchy-changed. */
719 gtk_tooltip_set_custom (x->ttip_widget, widget);
720 gtk_tooltip_set_text (x->ttip_widget, SSDATA (encoded_string));
721 gtk_widget_get_preferred_size (GTK_WIDGET (x->ttip_window), NULL, &req);
722 if (width) *width = req.width;
723 if (height) *height = req.height;
725 unblock_input ();
727 return 1;
728 #endif /* USE_GTK_TOOLTIP */
731 /* Show the tooltip at ROOT_X and ROOT_Y.
732 xg_prepare_tooltip must have been called before this function. */
734 void
735 xg_show_tooltip (struct frame *f, int root_x, int root_y)
737 #ifdef USE_GTK_TOOLTIP
738 struct x_output *x = f->output_data.x;
739 if (x->ttip_window)
741 block_input ();
742 gtk_window_move (x->ttip_window, root_x, root_y);
743 gtk_widget_show_all (GTK_WIDGET (x->ttip_window));
744 unblock_input ();
746 #endif
749 /* Hide tooltip if shown. Do nothing if not shown.
750 Return true if tip was hidden, false if not (i.e. not using
751 system tooltips). */
753 bool
754 xg_hide_tooltip (struct frame *f)
756 bool ret = 0;
757 #ifdef USE_GTK_TOOLTIP
758 if (f->output_data.x->ttip_window)
760 GtkWindow *win = f->output_data.x->ttip_window;
761 block_input ();
762 gtk_widget_hide (GTK_WIDGET (win));
764 if (g_object_get_data (G_OBJECT (win), "restore-tt"))
766 GdkWindow *gwin = gtk_widget_get_window (GTK_WIDGET (win));
767 GdkScreen *screen = gdk_window_get_screen (gwin);
768 GtkSettings *settings = gtk_settings_get_for_screen (screen);
769 g_object_set (settings, "gtk-enable-tooltips", TRUE, NULL);
771 unblock_input ();
773 ret = 1;
775 #endif
776 return ret;
780 /***********************************************************************
781 General functions for creating widgets, resizing, events, e.t.c.
782 ***********************************************************************/
784 static void
785 my_log_handler (const gchar *log_domain, GLogLevelFlags log_level,
786 const gchar *msg, gpointer user_data)
788 if (!strstr (msg, "visible children"))
789 fprintf (stderr, "XX %s-WARNING **: %s\n", log_domain, msg);
792 /* Make a geometry string and pass that to GTK. It seems this is the
793 only way to get geometry position right if the user explicitly
794 asked for a position when starting Emacs.
795 F is the frame we shall set geometry for. */
797 static void
798 xg_set_geometry (struct frame *f)
800 if (f->size_hint_flags & (USPosition | PPosition))
802 int left = f->left_pos;
803 int xneg = f->size_hint_flags & XNegative;
804 int top = f->top_pos;
805 int yneg = f->size_hint_flags & YNegative;
806 char geom_str[sizeof "=x--" + 4 * INT_STRLEN_BOUND (int)];
807 guint id;
809 if (xneg)
810 left = -left;
811 if (yneg)
812 top = -top;
814 sprintf (geom_str, "=%dx%d%c%d%c%d",
815 FRAME_PIXEL_WIDTH (f),
816 FRAME_PIXEL_HEIGHT (f),
817 (xneg ? '-' : '+'), left,
818 (yneg ? '-' : '+'), top);
820 /* Silence warning about visible children. */
821 id = g_log_set_handler ("Gtk", G_LOG_LEVEL_WARNING | G_LOG_FLAG_FATAL
822 | G_LOG_FLAG_RECURSION, my_log_handler, NULL);
824 if (!gtk_window_parse_geometry (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)),
825 geom_str))
826 fprintf (stderr, "Failed to parse: '%s'\n", geom_str);
828 g_log_remove_handler ("Gtk", id);
832 /* Clear under internal border if any. As we use a mix of Gtk+ and X calls
833 and use a GtkFixed widget, this doesn't happen automatically. */
835 void
836 xg_clear_under_internal_border (struct frame *f)
838 if (FRAME_INTERNAL_BORDER_WIDTH (f) > 0)
840 GtkWidget *wfixed = f->output_data.x->edit_widget;
842 gtk_widget_queue_draw (wfixed);
843 gdk_window_process_all_updates ();
845 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), 0, 0,
846 FRAME_PIXEL_WIDTH (f), FRAME_INTERNAL_BORDER_WIDTH (f));
848 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), 0, 0,
849 FRAME_INTERNAL_BORDER_WIDTH (f), FRAME_PIXEL_HEIGHT (f));
851 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), 0,
852 FRAME_PIXEL_HEIGHT (f) - FRAME_INTERNAL_BORDER_WIDTH (f),
853 FRAME_PIXEL_WIDTH (f), FRAME_INTERNAL_BORDER_WIDTH (f));
855 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
856 FRAME_PIXEL_WIDTH (f) - FRAME_INTERNAL_BORDER_WIDTH (f),
857 0, FRAME_INTERNAL_BORDER_WIDTH (f), FRAME_PIXEL_HEIGHT (f));
861 /* Function to handle resize of our frame. As we have a Gtk+ tool bar
862 and a Gtk+ menu bar, we get resize events for the edit part of the
863 frame only. We let Gtk+ deal with the Gtk+ parts.
864 F is the frame to resize.
865 PIXELWIDTH, PIXELHEIGHT is the new size in pixels. */
867 void
868 xg_frame_resized (struct frame *f, int pixelwidth, int pixelheight)
870 int width, height;
872 if (pixelwidth == -1 && pixelheight == -1)
874 if (FRAME_GTK_WIDGET (f) && gtk_widget_get_mapped (FRAME_GTK_WIDGET (f)))
875 gdk_window_get_geometry (gtk_widget_get_window (FRAME_GTK_WIDGET (f)),
876 0, 0,
877 &pixelwidth, &pixelheight);
878 else return;
882 width = FRAME_PIXEL_TO_TEXT_WIDTH (f, pixelwidth);
883 height = FRAME_PIXEL_TO_TEXT_HEIGHT (f, pixelheight);
885 if (width != FRAME_TEXT_WIDTH (f)
886 || height != FRAME_TEXT_HEIGHT (f)
887 || pixelwidth != FRAME_PIXEL_WIDTH (f)
888 || pixelheight != FRAME_PIXEL_HEIGHT (f))
890 FRAME_PIXEL_WIDTH (f) = pixelwidth;
891 FRAME_PIXEL_HEIGHT (f) = pixelheight;
893 xg_clear_under_internal_border (f);
894 change_frame_size (f, width, height, 0, 1, 0, 1);
895 SET_FRAME_GARBAGED (f);
896 cancel_mouse_face (f);
898 do_pending_window_change (0);
902 /* Resize the outer window of frame F after changing the height.
903 COLUMNS/ROWS is the size the edit area shall have after the resize. */
905 void
906 xg_frame_set_char_size (struct frame *f, int width, int height)
908 int pixelwidth = FRAME_TEXT_TO_PIXEL_WIDTH (f, width);
909 int pixelheight = FRAME_TEXT_TO_PIXEL_HEIGHT (f, height);
911 if (FRAME_PIXEL_HEIGHT (f) == 0)
912 return;
914 /* Do this before resize, as we don't know yet if we will be resized. */
915 xg_clear_under_internal_border (f);
917 /* Must resize our top level widget. Font size may have changed,
918 but not rows/cols. */
919 gtk_window_resize (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)),
920 pixelwidth + FRAME_TOOLBAR_WIDTH (f),
921 pixelheight + FRAME_TOOLBAR_HEIGHT (f)
922 + FRAME_MENUBAR_HEIGHT (f));
923 x_wm_set_size_hint (f, 0, 0);
925 SET_FRAME_GARBAGED (f);
926 cancel_mouse_face (f);
928 /* We can not call change_frame_size for a mapped frame,
929 we can not set pixel width/height either. The window manager may
930 override our resize request, XMonad does this all the time.
931 The best we can do is try to sync, so lisp code sees the updated
932 size as fast as possible.
933 For unmapped windows, we can set rows/cols. When
934 the frame is mapped again we will (hopefully) get the correct size. */
935 if (FRAME_VISIBLE_P (f))
937 /* Must call this to flush out events */
938 (void)gtk_events_pending ();
939 gdk_flush ();
940 x_wait_for_event (f, ConfigureNotify);
942 else
943 adjust_frame_size (f, -1, -1, 5, 0, Qnil);
946 /* Handle height/width changes (i.e. add/remove/move menu/toolbar).
947 The policy is to keep the number of editable lines. */
949 #if 0
950 static void
951 xg_height_or_width_changed (struct frame *f)
953 gtk_window_resize (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)),
954 FRAME_TOTAL_PIXEL_WIDTH (f),
955 FRAME_TOTAL_PIXEL_HEIGHT (f));
956 f->output_data.x->hint_flags = 0;
957 x_wm_set_size_hint (f, 0, 0);
959 #endif
961 /* Convert an X Window WSESC on display DPY to its corresponding GtkWidget.
962 Must be done like this, because GtkWidget:s can have "hidden"
963 X Window that aren't accessible.
965 Return 0 if no widget match WDESC. */
967 GtkWidget *
968 xg_win_to_widget (Display *dpy, Window wdesc)
970 gpointer gdkwin;
971 GtkWidget *gwdesc = 0;
973 block_input ();
975 gdkwin = gdk_x11_window_lookup_for_display (gdk_x11_lookup_xdisplay (dpy),
976 wdesc);
977 if (gdkwin)
979 GdkEvent event;
980 event.any.window = gdkwin;
981 event.any.type = GDK_NOTHING;
982 gwdesc = gtk_get_event_widget (&event);
985 unblock_input ();
986 return gwdesc;
989 /* Set the background of widget W to PIXEL. */
991 static void
992 xg_set_widget_bg (struct frame *f, GtkWidget *w, unsigned long pixel)
994 #ifdef HAVE_GTK3
995 GdkRGBA bg;
996 XColor xbg;
997 xbg.pixel = pixel;
998 if (XQueryColor (FRAME_X_DISPLAY (f), FRAME_X_COLORMAP (f), &xbg))
1000 bg.red = (double)xbg.red/65535.0;
1001 bg.green = (double)xbg.green/65535.0;
1002 bg.blue = (double)xbg.blue/65535.0;
1003 bg.alpha = 1.0;
1004 gtk_widget_override_background_color (w, GTK_STATE_FLAG_NORMAL, &bg);
1006 #else
1007 GdkColor bg;
1008 GdkColormap *map = gtk_widget_get_colormap (w);
1009 gdk_colormap_query_color (map, pixel, &bg);
1010 gtk_widget_modify_bg (FRAME_GTK_WIDGET (f), GTK_STATE_NORMAL, &bg);
1011 #endif
1014 /* Callback called when the gtk theme changes.
1015 We notify lisp code so it can fix faces used for region for example. */
1017 static void
1018 style_changed_cb (GObject *go,
1019 GParamSpec *spec,
1020 gpointer user_data)
1022 struct input_event event;
1023 GdkDisplay *gdpy = user_data;
1024 const char *display_name = gdk_display_get_name (gdpy);
1025 Display *dpy = GDK_DISPLAY_XDISPLAY (gdpy);
1027 EVENT_INIT (event);
1028 event.kind = CONFIG_CHANGED_EVENT;
1029 event.frame_or_window = build_string (display_name);
1030 /* Theme doesn't change often, so intern is called seldom. */
1031 event.arg = intern ("theme-name");
1032 kbd_buffer_store_event (&event);
1034 update_theme_scrollbar_width ();
1035 update_theme_scrollbar_height ();
1037 /* If scroll bar width changed, we need set the new size on all frames
1038 on this display. */
1039 if (dpy)
1041 Lisp_Object rest, frame;
1042 FOR_EACH_FRAME (rest, frame)
1044 struct frame *f = XFRAME (frame);
1045 if (FRAME_LIVE_P (f)
1046 && FRAME_X_P (f)
1047 && FRAME_X_DISPLAY (f) == dpy)
1049 x_set_scroll_bar_default_width (f);
1050 x_set_scroll_bar_default_height (f);
1051 xg_frame_set_char_size (f, FRAME_TEXT_WIDTH (f), FRAME_TEXT_HEIGHT (f));
1057 /* Called when a delete-event occurs on WIDGET. */
1059 static gboolean
1060 delete_cb (GtkWidget *widget,
1061 GdkEvent *event,
1062 gpointer user_data)
1064 #ifdef HAVE_GTK3
1065 /* The event doesn't arrive in the normal event loop. Send event
1066 here. */
1067 struct frame *f = user_data;
1068 struct input_event ie;
1070 EVENT_INIT (ie);
1071 ie.kind = DELETE_WINDOW_EVENT;
1072 XSETFRAME (ie.frame_or_window, f);
1073 kbd_buffer_store_event (&ie);
1074 #endif
1076 return TRUE;
1079 /* Create and set up the GTK widgets for frame F.
1080 Return true if creation succeeded. */
1082 bool
1083 xg_create_frame_widgets (struct frame *f)
1085 GtkWidget *wtop;
1086 GtkWidget *wvbox, *whbox;
1087 GtkWidget *wfixed;
1088 #ifndef HAVE_GTK3
1089 GtkRcStyle *style;
1090 #endif
1091 char *title = 0;
1093 block_input ();
1095 if (FRAME_X_EMBEDDED_P (f))
1097 GdkDisplay *gdpy = gdk_x11_lookup_xdisplay (FRAME_X_DISPLAY (f));
1098 wtop = gtk_plug_new_for_display (gdpy, f->output_data.x->parent_desc);
1100 else
1101 wtop = gtk_window_new (GTK_WINDOW_TOPLEVEL);
1103 /* gtk_window_set_has_resize_grip is a Gtk+ 3.0 function but Ubuntu
1104 has backported it to Gtk+ 2.0 and they add the resize grip for
1105 Gtk+ 2.0 applications also. But it has a bug that makes Emacs loop
1106 forever, so disable the grip. */
1107 #if (! GTK_CHECK_VERSION (3, 0, 0) \
1108 && defined HAVE_GTK_WINDOW_SET_HAS_RESIZE_GRIP)
1109 gtk_window_set_has_resize_grip (GTK_WINDOW (wtop), FALSE);
1110 #endif
1112 xg_set_screen (wtop, f);
1114 wvbox = gtk_box_new (GTK_ORIENTATION_VERTICAL, 0);
1115 whbox = gtk_box_new (GTK_ORIENTATION_HORIZONTAL, 0);
1116 gtk_box_set_homogeneous (GTK_BOX (wvbox), FALSE);
1117 gtk_box_set_homogeneous (GTK_BOX (whbox), FALSE);
1119 #ifdef HAVE_GTK3
1120 wfixed = emacs_fixed_new (f);
1121 #else
1122 wfixed = gtk_fixed_new ();
1123 #endif
1125 if (! wtop || ! wvbox || ! whbox || ! wfixed)
1127 if (wtop) gtk_widget_destroy (wtop);
1128 if (wvbox) gtk_widget_destroy (wvbox);
1129 if (whbox) gtk_widget_destroy (whbox);
1130 if (wfixed) gtk_widget_destroy (wfixed);
1132 unblock_input ();
1133 return 0;
1136 /* Use same names as the Xt port does. I.e. Emacs.pane.emacs by default */
1137 gtk_widget_set_name (wtop, EMACS_CLASS);
1138 gtk_widget_set_name (wvbox, "pane");
1139 gtk_widget_set_name (wfixed, SSDATA (Vx_resource_name));
1141 /* If this frame has a title or name, set it in the title bar. */
1142 if (! NILP (f->title))
1143 title = SSDATA (ENCODE_UTF_8 (f->title));
1144 else if (! NILP (f->name))
1145 title = SSDATA (ENCODE_UTF_8 (f->name));
1147 if (title) gtk_window_set_title (GTK_WINDOW (wtop), title);
1149 FRAME_GTK_OUTER_WIDGET (f) = wtop;
1150 FRAME_GTK_WIDGET (f) = wfixed;
1151 f->output_data.x->vbox_widget = wvbox;
1152 f->output_data.x->hbox_widget = whbox;
1154 gtk_widget_set_has_window (wfixed, TRUE);
1156 gtk_container_add (GTK_CONTAINER (wtop), wvbox);
1157 gtk_box_pack_start (GTK_BOX (wvbox), whbox, TRUE, TRUE, 0);
1158 gtk_box_pack_start (GTK_BOX (whbox), wfixed, TRUE, TRUE, 0);
1160 if (FRAME_EXTERNAL_TOOL_BAR (f))
1161 update_frame_tool_bar (f);
1163 /* We don't want this widget double buffered, because we draw on it
1164 with regular X drawing primitives, so from a GTK/GDK point of
1165 view, the widget is totally blank. When an expose comes, this
1166 will make the widget blank, and then Emacs redraws it. This flickers
1167 a lot, so we turn off double buffering. */
1168 gtk_widget_set_double_buffered (wfixed, FALSE);
1170 gtk_window_set_wmclass (GTK_WINDOW (wtop),
1171 SSDATA (Vx_resource_name),
1172 SSDATA (Vx_resource_class));
1174 /* Add callback to do nothing on WM_DELETE_WINDOW. The default in
1175 GTK is to destroy the widget. We want Emacs to do that instead. */
1176 g_signal_connect (G_OBJECT (wtop), "delete-event",
1177 G_CALLBACK (delete_cb), f);
1179 /* Convert our geometry parameters into a geometry string
1180 and specify it.
1181 GTK will itself handle calculating the real position this way. */
1182 xg_set_geometry (f);
1183 f->win_gravity
1184 = gtk_window_get_gravity (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)));
1186 gtk_widget_add_events (wfixed,
1187 GDK_POINTER_MOTION_MASK
1188 | GDK_EXPOSURE_MASK
1189 | GDK_BUTTON_PRESS_MASK
1190 | GDK_BUTTON_RELEASE_MASK
1191 | GDK_KEY_PRESS_MASK
1192 | GDK_ENTER_NOTIFY_MASK
1193 | GDK_LEAVE_NOTIFY_MASK
1194 | GDK_FOCUS_CHANGE_MASK
1195 | GDK_STRUCTURE_MASK
1196 | GDK_VISIBILITY_NOTIFY_MASK);
1198 /* Must realize the windows so the X window gets created. It is used
1199 by callers of this function. */
1200 gtk_widget_realize (wfixed);
1201 FRAME_X_WINDOW (f) = GTK_WIDGET_TO_X_WIN (wfixed);
1203 /* Since GTK clears its window by filling with the background color,
1204 we must keep X and GTK background in sync. */
1205 xg_set_widget_bg (f, wfixed, FRAME_BACKGROUND_PIXEL (f));
1207 #ifndef HAVE_GTK3
1208 /* Also, do not let any background pixmap to be set, this looks very
1209 bad as Emacs overwrites the background pixmap with its own idea
1210 of background color. */
1211 style = gtk_widget_get_modifier_style (wfixed);
1213 /* Must use g_strdup because gtk_widget_modify_style does g_free. */
1214 style->bg_pixmap_name[GTK_STATE_NORMAL] = g_strdup ("<none>");
1215 gtk_widget_modify_style (wfixed, style);
1216 #else
1217 gtk_widget_set_can_focus (wfixed, TRUE);
1218 gtk_window_set_resizable (GTK_WINDOW (wtop), TRUE);
1219 #endif
1221 #ifdef USE_GTK_TOOLTIP
1222 /* Steal a tool tip window we can move ourselves. */
1223 f->output_data.x->ttip_widget = 0;
1224 f->output_data.x->ttip_lbl = 0;
1225 f->output_data.x->ttip_window = 0;
1226 gtk_widget_set_tooltip_text (wtop, "Dummy text");
1227 g_signal_connect (wtop, "query-tooltip", G_CALLBACK (qttip_cb), f);
1228 #endif
1231 GdkScreen *screen = gtk_widget_get_screen (wtop);
1232 GtkSettings *gs = gtk_settings_get_for_screen (screen);
1233 /* Only connect this signal once per screen. */
1234 if (! g_signal_handler_find (G_OBJECT (gs),
1235 G_SIGNAL_MATCH_FUNC,
1236 0, 0, 0,
1237 G_CALLBACK (style_changed_cb),
1240 g_signal_connect (G_OBJECT (gs), "notify::gtk-theme-name",
1241 G_CALLBACK (style_changed_cb),
1242 gdk_screen_get_display (screen));
1246 unblock_input ();
1248 return 1;
1251 void
1252 xg_free_frame_widgets (struct frame *f)
1254 if (FRAME_GTK_OUTER_WIDGET (f))
1256 #ifdef USE_GTK_TOOLTIP
1257 struct x_output *x = f->output_data.x;
1258 #endif
1259 struct xg_frame_tb_info *tbinfo
1260 = g_object_get_data (G_OBJECT (FRAME_GTK_OUTER_WIDGET (f)),
1261 TB_INFO_KEY);
1262 if (tbinfo)
1263 xfree (tbinfo);
1265 gtk_widget_destroy (FRAME_GTK_OUTER_WIDGET (f));
1266 FRAME_X_WINDOW (f) = 0; /* Set to avoid XDestroyWindow in xterm.c */
1267 FRAME_GTK_OUTER_WIDGET (f) = 0;
1268 #ifdef USE_GTK_TOOLTIP
1269 if (x->ttip_lbl)
1270 gtk_widget_destroy (x->ttip_lbl);
1271 if (x->ttip_widget)
1272 g_object_unref (G_OBJECT (x->ttip_widget));
1273 #endif
1277 /* Set the normal size hints for the window manager, for frame F.
1278 FLAGS is the flags word to use--or 0 meaning preserve the flags
1279 that the window now has.
1280 If USER_POSITION, set the User Position
1281 flag (this is useful when FLAGS is 0). */
1283 void
1284 x_wm_set_size_hint (struct frame *f, long int flags, bool user_position)
1286 /* Must use GTK routines here, otherwise GTK resets the size hints
1287 to its own defaults. */
1288 GdkGeometry size_hints;
1289 gint hint_flags = 0;
1290 int base_width, base_height;
1291 int min_rows = 0, min_cols = 0;
1292 int win_gravity = f->win_gravity;
1293 Lisp_Object fs_state, frame;
1295 /* Don't set size hints during initialization; that apparently leads
1296 to a race condition. See the thread at
1297 http://lists.gnu.org/archive/html/emacs-devel/2008-10/msg00033.html */
1298 if (NILP (Vafter_init_time) || !FRAME_GTK_OUTER_WIDGET (f))
1299 return;
1301 XSETFRAME (frame, f);
1302 fs_state = Fframe_parameter (frame, Qfullscreen);
1303 if (EQ (fs_state, Qmaximized) || EQ (fs_state, Qfullboth))
1305 /* Don't set hints when maximized or fullscreen. Apparently KWin and
1306 Gtk3 don't get along and the frame shrinks (!).
1308 return;
1311 if (flags)
1313 memset (&size_hints, 0, sizeof (size_hints));
1314 f->output_data.x->size_hints = size_hints;
1315 f->output_data.x->hint_flags = hint_flags;
1317 else
1318 flags = f->size_hint_flags;
1320 size_hints = f->output_data.x->size_hints;
1321 hint_flags = f->output_data.x->hint_flags;
1323 hint_flags |= GDK_HINT_RESIZE_INC | GDK_HINT_MIN_SIZE;
1324 size_hints.width_inc = frame_resize_pixelwise ? 1 : FRAME_COLUMN_WIDTH (f);
1325 size_hints.height_inc = frame_resize_pixelwise ? 1 : FRAME_LINE_HEIGHT (f);
1327 hint_flags |= GDK_HINT_BASE_SIZE;
1328 /* Use one row/col here so base_height/width does not become zero.
1329 Gtk+ and/or Unity on Ubuntu 12.04 can't handle it. */
1330 base_width = FRAME_TEXT_COLS_TO_PIXEL_WIDTH (f, 1) + FRAME_TOOLBAR_WIDTH (f);
1331 base_height = FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, 1)
1332 + FRAME_MENUBAR_HEIGHT (f) + FRAME_TOOLBAR_HEIGHT (f);
1334 if (min_cols > 0) --min_cols; /* We used one col in base_width = ... 1); */
1335 if (min_rows > 0) --min_rows; /* We used one row in base_height = ... 1); */
1337 size_hints.base_width = base_width;
1338 size_hints.base_height = base_height;
1339 size_hints.min_width = base_width + min_cols * FRAME_COLUMN_WIDTH (f);
1340 size_hints.min_height = base_height + min_rows * FRAME_LINE_HEIGHT (f);
1342 /* These currently have a one to one mapping with the X values, but I
1343 don't think we should rely on that. */
1344 hint_flags |= GDK_HINT_WIN_GRAVITY;
1345 size_hints.win_gravity = 0;
1346 if (win_gravity == NorthWestGravity)
1347 size_hints.win_gravity = GDK_GRAVITY_NORTH_WEST;
1348 else if (win_gravity == NorthGravity)
1349 size_hints.win_gravity = GDK_GRAVITY_NORTH;
1350 else if (win_gravity == NorthEastGravity)
1351 size_hints.win_gravity = GDK_GRAVITY_NORTH_EAST;
1352 else if (win_gravity == WestGravity)
1353 size_hints.win_gravity = GDK_GRAVITY_WEST;
1354 else if (win_gravity == CenterGravity)
1355 size_hints.win_gravity = GDK_GRAVITY_CENTER;
1356 else if (win_gravity == EastGravity)
1357 size_hints.win_gravity = GDK_GRAVITY_EAST;
1358 else if (win_gravity == SouthWestGravity)
1359 size_hints.win_gravity = GDK_GRAVITY_SOUTH_WEST;
1360 else if (win_gravity == SouthGravity)
1361 size_hints.win_gravity = GDK_GRAVITY_SOUTH;
1362 else if (win_gravity == SouthEastGravity)
1363 size_hints.win_gravity = GDK_GRAVITY_SOUTH_EAST;
1364 else if (win_gravity == StaticGravity)
1365 size_hints.win_gravity = GDK_GRAVITY_STATIC;
1367 if (user_position)
1369 hint_flags &= ~GDK_HINT_POS;
1370 hint_flags |= GDK_HINT_USER_POS;
1373 if (hint_flags != f->output_data.x->hint_flags
1374 || memcmp (&size_hints,
1375 &f->output_data.x->size_hints,
1376 sizeof (size_hints)) != 0)
1378 block_input ();
1379 gtk_window_set_geometry_hints (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)),
1380 NULL, &size_hints, hint_flags);
1381 f->output_data.x->size_hints = size_hints;
1382 f->output_data.x->hint_flags = hint_flags;
1383 unblock_input ();
1387 /* Change background color of a frame.
1388 Since GTK uses the background color to clear the window, we must
1389 keep the GTK and X colors in sync.
1390 F is the frame to change,
1391 BG is the pixel value to change to. */
1393 void
1394 xg_set_background_color (struct frame *f, unsigned long bg)
1396 if (FRAME_GTK_WIDGET (f))
1398 block_input ();
1399 xg_set_widget_bg (f, FRAME_GTK_WIDGET (f), FRAME_BACKGROUND_PIXEL (f));
1400 unblock_input ();
1405 /* Set the frame icon to ICON_PIXMAP/MASK. This must be done with GTK
1406 functions so GTK does not overwrite the icon. */
1408 void
1409 xg_set_frame_icon (struct frame *f, Pixmap icon_pixmap, Pixmap icon_mask)
1411 GdkPixbuf *gp = xg_get_pixbuf_from_pix_and_mask (f,
1412 icon_pixmap,
1413 icon_mask);
1414 if (gp)
1415 gtk_window_set_icon (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)), gp);
1420 /***********************************************************************
1421 Dialog functions
1422 ***********************************************************************/
1423 /* Return the dialog title to use for a dialog of type KEY.
1424 This is the encoding used by lwlib. We use the same for GTK. */
1426 static const char *
1427 get_dialog_title (char key)
1429 const char *title = "";
1431 switch (key) {
1432 case 'E': case 'e':
1433 title = "Error";
1434 break;
1436 case 'I': case 'i':
1437 title = "Information";
1438 break;
1440 case 'L': case 'l':
1441 title = "Prompt";
1442 break;
1444 case 'P': case 'p':
1445 title = "Prompt";
1446 break;
1448 case 'Q': case 'q':
1449 title = "Question";
1450 break;
1453 return title;
1456 /* Callback for dialogs that get WM_DELETE_WINDOW. We pop down
1457 the dialog, but return TRUE so the event does not propagate further
1458 in GTK. This prevents GTK from destroying the dialog widget automatically
1459 and we can always destroy the widget manually, regardless of how
1460 it was popped down (button press or WM_DELETE_WINDOW).
1461 W is the dialog widget.
1462 EVENT is the GdkEvent that represents WM_DELETE_WINDOW (not used).
1463 user_data is NULL (not used).
1465 Returns TRUE to end propagation of event. */
1467 static gboolean
1468 dialog_delete_callback (GtkWidget *w, GdkEvent *event, gpointer user_data)
1470 gtk_widget_unmap (w);
1471 return TRUE;
1474 /* Create a popup dialog window. See also xg_create_widget below.
1475 WV is a widget_value describing the dialog.
1476 SELECT_CB is the callback to use when a button has been pressed.
1477 DEACTIVATE_CB is the callback to use when the dialog pops down.
1479 Returns the GTK dialog widget. */
1481 static GtkWidget *
1482 create_dialog (widget_value *wv,
1483 GCallback select_cb,
1484 GCallback deactivate_cb)
1486 const char *title = get_dialog_title (wv->name[0]);
1487 int total_buttons = wv->name[1] - '0';
1488 int right_buttons = wv->name[4] - '0';
1489 int left_buttons;
1490 int button_nr = 0;
1491 int button_spacing = 10;
1492 GtkWidget *wdialog = gtk_dialog_new ();
1493 GtkDialog *wd = GTK_DIALOG (wdialog);
1494 widget_value *item;
1495 GtkWidget *whbox_down;
1497 /* If the number of buttons is greater than 4, make two rows of buttons
1498 instead. This looks better. */
1499 bool make_two_rows = total_buttons > 4;
1501 #if GTK_CHECK_VERSION (3, 12, 0)
1502 GtkBuilder *gbld = gtk_builder_new ();
1503 GObject *go = gtk_buildable_get_internal_child (GTK_BUILDABLE (wd),
1504 gbld,
1505 "action_area");
1506 GtkBox *cur_box = GTK_BOX (go);
1507 g_object_unref (G_OBJECT (gbld));
1508 #else
1509 GtkBox *cur_box = GTK_BOX (gtk_dialog_get_action_area (wd));
1510 #endif
1512 if (right_buttons == 0) right_buttons = total_buttons/2;
1513 left_buttons = total_buttons - right_buttons;
1515 gtk_window_set_title (GTK_WINDOW (wdialog), title);
1516 gtk_widget_set_name (wdialog, "emacs-dialog");
1519 if (make_two_rows)
1521 GtkWidget *wvbox = gtk_box_new (GTK_ORIENTATION_VERTICAL, button_spacing);
1522 GtkWidget *whbox_up = gtk_box_new (GTK_ORIENTATION_HORIZONTAL, 0);
1523 gtk_box_set_homogeneous (GTK_BOX (wvbox), TRUE);
1524 gtk_box_set_homogeneous (GTK_BOX (whbox_up), FALSE);
1525 whbox_down = gtk_box_new (GTK_ORIENTATION_HORIZONTAL, 0);
1526 gtk_box_set_homogeneous (GTK_BOX (whbox_down), FALSE);
1528 gtk_box_pack_start (cur_box, wvbox, FALSE, FALSE, 0);
1529 gtk_box_pack_start (GTK_BOX (wvbox), whbox_up, FALSE, FALSE, 0);
1530 gtk_box_pack_start (GTK_BOX (wvbox), whbox_down, FALSE, FALSE, 0);
1532 cur_box = GTK_BOX (whbox_up);
1535 g_signal_connect (G_OBJECT (wdialog), "delete-event",
1536 G_CALLBACK (dialog_delete_callback), 0);
1538 if (deactivate_cb)
1540 g_signal_connect (G_OBJECT (wdialog), "close", deactivate_cb, 0);
1541 g_signal_connect (G_OBJECT (wdialog), "response", deactivate_cb, 0);
1544 for (item = wv->contents; item; item = item->next)
1546 char *utf8_label = get_utf8_string (item->value);
1547 GtkWidget *w;
1548 GtkRequisition req;
1550 if (item->name && strcmp (item->name, "message") == 0)
1552 GtkBox *wvbox = GTK_BOX (gtk_dialog_get_content_area (wd));
1553 /* This is the text part of the dialog. */
1554 w = gtk_label_new (utf8_label);
1555 gtk_box_pack_start (wvbox, gtk_label_new (""), FALSE, FALSE, 0);
1556 gtk_box_pack_start (wvbox, w, TRUE, TRUE, 0);
1557 #if GTK_CHECK_VERSION (3, 14, 0)
1558 gtk_widget_set_halign (w, GTK_ALIGN_START);
1559 gtk_widget_set_valign (w, GTK_ALIGN_CENTER);
1560 #else
1561 gtk_misc_set_alignment (GTK_MISC (w), 0.1, 0.5);
1562 #endif
1563 /* Try to make dialog look better. Must realize first so
1564 the widget can calculate the size it needs. */
1565 gtk_widget_realize (w);
1566 gtk_widget_get_preferred_size (w, NULL, &req);
1567 gtk_box_set_spacing (wvbox, req.height);
1568 if (item->value && strlen (item->value) > 0)
1569 button_spacing = 2*req.width/strlen (item->value);
1570 if (button_spacing < 10) button_spacing = 10;
1572 else
1574 /* This is one button to add to the dialog. */
1575 w = gtk_button_new_with_label (utf8_label);
1576 if (! item->enabled)
1577 gtk_widget_set_sensitive (w, FALSE);
1578 if (select_cb)
1579 g_signal_connect (G_OBJECT (w), "clicked",
1580 select_cb, item->call_data);
1582 gtk_box_pack_start (cur_box, w, TRUE, TRUE, button_spacing);
1583 if (++button_nr == left_buttons)
1585 if (make_two_rows)
1586 cur_box = GTK_BOX (whbox_down);
1590 if (utf8_label)
1591 g_free (utf8_label);
1594 return wdialog;
1597 struct xg_dialog_data
1599 GMainLoop *loop;
1600 int response;
1601 GtkWidget *w;
1602 guint timerid;
1605 /* Function that is called when the file or font dialogs pop down.
1606 W is the dialog widget, RESPONSE is the response code.
1607 USER_DATA is what we passed in to g_signal_connect. */
1609 static void
1610 xg_dialog_response_cb (GtkDialog *w,
1611 gint response,
1612 gpointer user_data)
1614 struct xg_dialog_data *dd = user_data;
1615 dd->response = response;
1616 g_main_loop_quit (dd->loop);
1620 /* Destroy the dialog. This makes it pop down. */
1622 static void
1623 pop_down_dialog (void *arg)
1625 struct xg_dialog_data *dd = arg;
1627 block_input ();
1628 if (dd->w) gtk_widget_destroy (dd->w);
1629 if (dd->timerid != 0) g_source_remove (dd->timerid);
1631 g_main_loop_quit (dd->loop);
1632 g_main_loop_unref (dd->loop);
1634 unblock_input ();
1637 /* If there are any emacs timers pending, add a timeout to main loop in DATA.
1638 We pass in DATA as gpointer* so we can use this as a callback. */
1640 static gboolean
1641 xg_maybe_add_timer (gpointer data)
1643 struct xg_dialog_data *dd = data;
1644 struct timespec next_time = timer_check ();
1646 dd->timerid = 0;
1648 if (timespec_valid_p (next_time))
1650 time_t s = next_time.tv_sec;
1651 int per_ms = TIMESPEC_RESOLUTION / 1000;
1652 int ms = (next_time.tv_nsec + per_ms - 1) / per_ms;
1653 if (s <= ((guint) -1 - ms) / 1000)
1654 dd->timerid = g_timeout_add (s * 1000 + ms, xg_maybe_add_timer, dd);
1656 return FALSE;
1660 /* Pops up a modal dialog W and waits for response.
1661 We don't use gtk_dialog_run because we want to process emacs timers.
1662 The dialog W is not destroyed when this function returns. */
1664 static int
1665 xg_dialog_run (struct frame *f, GtkWidget *w)
1667 ptrdiff_t count = SPECPDL_INDEX ();
1668 struct xg_dialog_data dd;
1670 xg_set_screen (w, f);
1671 gtk_window_set_transient_for (GTK_WINDOW (w),
1672 GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)));
1673 gtk_window_set_destroy_with_parent (GTK_WINDOW (w), TRUE);
1674 gtk_window_set_modal (GTK_WINDOW (w), TRUE);
1676 dd.loop = g_main_loop_new (NULL, FALSE);
1677 dd.response = GTK_RESPONSE_CANCEL;
1678 dd.w = w;
1679 dd.timerid = 0;
1681 g_signal_connect (G_OBJECT (w),
1682 "response",
1683 G_CALLBACK (xg_dialog_response_cb),
1684 &dd);
1685 /* Don't destroy the widget if closed by the window manager close button. */
1686 g_signal_connect (G_OBJECT (w), "delete-event", G_CALLBACK (gtk_true), NULL);
1687 gtk_widget_show (w);
1689 record_unwind_protect_ptr (pop_down_dialog, &dd);
1691 (void) xg_maybe_add_timer (&dd);
1692 g_main_loop_run (dd.loop);
1694 dd.w = 0;
1695 unbind_to (count, Qnil);
1697 return dd.response;
1701 /***********************************************************************
1702 File dialog functions
1703 ***********************************************************************/
1704 /* Return true if the old file selection dialog is being used. */
1706 bool
1707 xg_uses_old_file_dialog (void)
1709 #ifdef HAVE_GTK_FILE_SELECTION_NEW
1710 return x_gtk_use_old_file_dialog;
1711 #else
1712 return 0;
1713 #endif
1717 typedef char * (*xg_get_file_func) (GtkWidget *);
1719 /* Return the selected file for file chooser dialog W.
1720 The returned string must be free:d. */
1722 static char *
1723 xg_get_file_name_from_chooser (GtkWidget *w)
1725 return gtk_file_chooser_get_filename (GTK_FILE_CHOOSER (w));
1728 /* Callback called when the "Show hidden files" toggle is pressed.
1729 WIDGET is the toggle widget, DATA is the file chooser dialog. */
1731 static void
1732 xg_toggle_visibility_cb (GtkWidget *widget, gpointer data)
1734 GtkFileChooser *dialog = GTK_FILE_CHOOSER (data);
1735 gboolean visible;
1736 g_object_get (G_OBJECT (dialog), "show-hidden", &visible, NULL);
1737 g_object_set (G_OBJECT (dialog), "show-hidden", !visible, NULL);
1741 /* Callback called when a property changes in a file chooser.
1742 GOBJECT is the file chooser dialog, ARG1 describes the property.
1743 USER_DATA is the toggle widget in the file chooser dialog.
1744 We use this to update the "Show hidden files" toggle when the user
1745 changes that property by right clicking in the file list. */
1747 static void
1748 xg_toggle_notify_cb (GObject *gobject, GParamSpec *arg1, gpointer user_data)
1750 if (strcmp (arg1->name, "show-hidden") == 0)
1752 GtkWidget *wtoggle = GTK_WIDGET (user_data);
1753 gboolean visible, toggle_on;
1755 g_object_get (G_OBJECT (gobject), "show-hidden", &visible, NULL);
1756 toggle_on = gtk_toggle_button_get_active (GTK_TOGGLE_BUTTON (wtoggle));
1758 if (!!visible != !!toggle_on)
1760 g_signal_handlers_block_by_func (G_OBJECT (wtoggle),
1761 G_CALLBACK (xg_toggle_visibility_cb),
1762 gobject);
1763 gtk_toggle_button_set_active (GTK_TOGGLE_BUTTON (wtoggle), visible);
1764 g_signal_handlers_unblock_by_func
1765 (G_OBJECT (wtoggle),
1766 G_CALLBACK (xg_toggle_visibility_cb),
1767 gobject);
1769 x_gtk_show_hidden_files = visible;
1773 /* Read a file name from the user using a file chooser dialog.
1774 F is the current frame.
1775 PROMPT is a prompt to show to the user. May not be NULL.
1776 DEFAULT_FILENAME is a default selection to be displayed. May be NULL.
1777 If MUSTMATCH_P, the returned file name must be an existing
1778 file. (Actually, this only has cosmetic effects, the user can
1779 still enter a non-existing file.) *FUNC is set to a function that
1780 can be used to retrieve the selected file name from the returned widget.
1782 Returns the created widget. */
1784 static GtkWidget *
1785 xg_get_file_with_chooser (struct frame *f,
1786 char *prompt,
1787 char *default_filename,
1788 bool mustmatch_p, bool only_dir_p,
1789 xg_get_file_func *func)
1791 char msgbuf[1024];
1793 GtkWidget *filewin, *wtoggle, *wbox, *wmessage IF_LINT (= NULL);
1794 GtkWindow *gwin = GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f));
1795 GtkFileChooserAction action = (mustmatch_p ?
1796 GTK_FILE_CHOOSER_ACTION_OPEN :
1797 GTK_FILE_CHOOSER_ACTION_SAVE);
1799 if (only_dir_p)
1800 action = GTK_FILE_CHOOSER_ACTION_SELECT_FOLDER;
1802 filewin = gtk_file_chooser_dialog_new (prompt, gwin, action,
1803 XG_TEXT_CANCEL, GTK_RESPONSE_CANCEL,
1804 (mustmatch_p || only_dir_p ?
1805 XG_TEXT_OPEN : XG_TEXT_OK),
1806 GTK_RESPONSE_OK,
1807 NULL);
1808 gtk_file_chooser_set_local_only (GTK_FILE_CHOOSER (filewin), TRUE);
1810 wbox = gtk_box_new (GTK_ORIENTATION_VERTICAL, 0);
1811 gtk_box_set_homogeneous (GTK_BOX (wbox), FALSE);
1812 gtk_widget_show (wbox);
1813 wtoggle = gtk_check_button_new_with_label ("Show hidden files.");
1815 if (x_gtk_show_hidden_files)
1817 g_object_set (G_OBJECT (filewin), "show-hidden", TRUE, NULL);
1818 gtk_toggle_button_set_active (GTK_TOGGLE_BUTTON (wtoggle), TRUE);
1820 gtk_widget_show (wtoggle);
1821 g_signal_connect (G_OBJECT (wtoggle), "clicked",
1822 G_CALLBACK (xg_toggle_visibility_cb), filewin);
1823 g_signal_connect (G_OBJECT (filewin), "notify",
1824 G_CALLBACK (xg_toggle_notify_cb), wtoggle);
1826 if (x_gtk_file_dialog_help_text)
1828 msgbuf[0] = '\0';
1829 /* Gtk+ 2.10 has the file name text entry box integrated in the dialog.
1830 Show the C-l help text only for versions < 2.10. */
1831 if (gtk_check_version (2, 10, 0) && action != GTK_FILE_CHOOSER_ACTION_SAVE)
1832 strcat (msgbuf, "\nType C-l to display a file name text entry box.\n");
1833 strcat (msgbuf, "\nIf you don't like this file selector, use the "
1834 "corresponding\nkey binding or customize "
1835 "use-file-dialog to turn it off.");
1837 wmessage = gtk_label_new (msgbuf);
1838 gtk_widget_show (wmessage);
1841 gtk_box_pack_start (GTK_BOX (wbox), wtoggle, FALSE, FALSE, 0);
1842 if (x_gtk_file_dialog_help_text)
1843 gtk_box_pack_start (GTK_BOX (wbox), wmessage, FALSE, FALSE, 0);
1844 gtk_file_chooser_set_extra_widget (GTK_FILE_CHOOSER (filewin), wbox);
1846 if (default_filename)
1848 Lisp_Object file;
1849 struct gcpro gcpro1;
1850 char *utf8_filename;
1851 GCPRO1 (file);
1853 file = build_string (default_filename);
1855 /* File chooser does not understand ~/... in the file name. It must be
1856 an absolute name starting with /. */
1857 if (default_filename[0] != '/')
1858 file = Fexpand_file_name (file, Qnil);
1860 utf8_filename = SSDATA (ENCODE_UTF_8 (file));
1861 if (! NILP (Ffile_directory_p (file)))
1862 gtk_file_chooser_set_current_folder (GTK_FILE_CHOOSER (filewin),
1863 utf8_filename);
1864 else
1866 gtk_file_chooser_set_filename (GTK_FILE_CHOOSER (filewin),
1867 utf8_filename);
1868 if (action == GTK_FILE_CHOOSER_ACTION_SAVE)
1870 char *cp = strrchr (utf8_filename, '/');
1871 if (cp) ++cp;
1872 else cp = utf8_filename;
1873 gtk_file_chooser_set_current_name (GTK_FILE_CHOOSER (filewin), cp);
1877 UNGCPRO;
1880 *func = xg_get_file_name_from_chooser;
1881 return filewin;
1884 #ifdef HAVE_GTK_FILE_SELECTION_NEW
1886 /* Return the selected file for file selector dialog W.
1887 The returned string must be free:d. */
1889 static char *
1890 xg_get_file_name_from_selector (GtkWidget *w)
1892 GtkFileSelection *filesel = GTK_FILE_SELECTION (w);
1893 return xstrdup (gtk_file_selection_get_filename (filesel));
1896 /* Create a file selection dialog.
1897 F is the current frame.
1898 PROMPT is a prompt to show to the user. May not be NULL.
1899 DEFAULT_FILENAME is a default selection to be displayed. May be NULL.
1900 If MUSTMATCH_P, the returned file name must be an existing
1901 file. *FUNC is set to a function that can be used to retrieve the
1902 selected file name from the returned widget.
1904 Returns the created widget. */
1906 static GtkWidget *
1907 xg_get_file_with_selection (struct frame *f,
1908 char *prompt,
1909 char *default_filename,
1910 bool mustmatch_p, bool only_dir_p,
1911 xg_get_file_func *func)
1913 GtkWidget *filewin;
1914 GtkFileSelection *filesel;
1916 filewin = gtk_file_selection_new (prompt);
1917 filesel = GTK_FILE_SELECTION (filewin);
1919 if (default_filename)
1920 gtk_file_selection_set_filename (filesel, default_filename);
1922 if (mustmatch_p)
1924 /* The selection_entry part of filesel is not documented. */
1925 gtk_widget_set_sensitive (filesel->selection_entry, FALSE);
1926 gtk_file_selection_hide_fileop_buttons (filesel);
1929 *func = xg_get_file_name_from_selector;
1931 return filewin;
1933 #endif /* HAVE_GTK_FILE_SELECTION_NEW */
1935 /* Read a file name from the user using a file dialog, either the old
1936 file selection dialog, or the new file chooser dialog. Which to use
1937 depends on what the GTK version used has, and what the value of
1938 gtk-use-old-file-dialog.
1939 F is the current frame.
1940 PROMPT is a prompt to show to the user. May not be NULL.
1941 DEFAULT_FILENAME is a default selection to be displayed. May be NULL.
1942 If MUSTMATCH_P, the returned file name must be an existing
1943 file.
1945 Returns a file name or NULL if no file was selected.
1946 The returned string must be freed by the caller. */
1948 char *
1949 xg_get_file_name (struct frame *f,
1950 char *prompt,
1951 char *default_filename,
1952 bool mustmatch_p,
1953 bool only_dir_p)
1955 GtkWidget *w = 0;
1956 char *fn = 0;
1957 int filesel_done = 0;
1958 xg_get_file_func func;
1960 #ifdef HAVE_GTK_FILE_SELECTION_NEW
1962 if (xg_uses_old_file_dialog ())
1963 w = xg_get_file_with_selection (f, prompt, default_filename,
1964 mustmatch_p, only_dir_p, &func);
1965 else
1966 w = xg_get_file_with_chooser (f, prompt, default_filename,
1967 mustmatch_p, only_dir_p, &func);
1969 #else /* not HAVE_GTK_FILE_SELECTION_NEW */
1970 w = xg_get_file_with_chooser (f, prompt, default_filename,
1971 mustmatch_p, only_dir_p, &func);
1972 #endif /* not HAVE_GTK_FILE_SELECTION_NEW */
1974 gtk_widget_set_name (w, "emacs-filedialog");
1976 filesel_done = xg_dialog_run (f, w);
1977 if (filesel_done == GTK_RESPONSE_OK)
1978 fn = (*func) (w);
1980 gtk_widget_destroy (w);
1981 return fn;
1984 /***********************************************************************
1985 GTK font chooser
1986 ***********************************************************************/
1988 #ifdef HAVE_FREETYPE
1990 #if USE_NEW_GTK_FONT_CHOOSER
1992 #define XG_WEIGHT_TO_SYMBOL(w) \
1993 (w <= PANGO_WEIGHT_THIN ? Qextra_light \
1994 : w <= PANGO_WEIGHT_ULTRALIGHT ? Qlight \
1995 : w <= PANGO_WEIGHT_LIGHT ? Qsemi_light \
1996 : w < PANGO_WEIGHT_MEDIUM ? Qnormal \
1997 : w <= PANGO_WEIGHT_SEMIBOLD ? Qsemi_bold \
1998 : w <= PANGO_WEIGHT_BOLD ? Qbold \
1999 : w <= PANGO_WEIGHT_HEAVY ? Qextra_bold \
2000 : Qultra_bold)
2002 #define XG_STYLE_TO_SYMBOL(s) \
2003 (s == PANGO_STYLE_OBLIQUE ? Qoblique \
2004 : s == PANGO_STYLE_ITALIC ? Qitalic \
2005 : Qnormal)
2007 #endif /* USE_NEW_GTK_FONT_CHOOSER */
2010 static char *x_last_font_name;
2012 /* Pop up a GTK font selector and return the name of the font the user
2013 selects, as a C string. The returned font name follows GTK's own
2014 format:
2016 `FAMILY [VALUE1 VALUE2] SIZE'
2018 This can be parsed using font_parse_fcname in font.c.
2019 DEFAULT_NAME, if non-zero, is the default font name. */
2021 Lisp_Object
2022 xg_get_font (struct frame *f, const char *default_name)
2024 GtkWidget *w;
2025 int done = 0;
2026 Lisp_Object font = Qnil;
2028 w = gtk_font_chooser_dialog_new
2029 ("Pick a font", GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)));
2031 if (default_name)
2033 /* Convert fontconfig names to Gtk names, i.e. remove - before
2034 number */
2035 char *p = strrchr (default_name, '-');
2036 if (p)
2038 char *ep = p+1;
2039 while (c_isdigit (*ep))
2040 ++ep;
2041 if (*ep == '\0') *p = ' ';
2044 else if (x_last_font_name)
2045 default_name = x_last_font_name;
2047 if (default_name)
2048 gtk_font_chooser_set_font (GTK_FONT_CHOOSER (w), default_name);
2050 gtk_widget_set_name (w, "emacs-fontdialog");
2051 done = xg_dialog_run (f, w);
2052 if (done == GTK_RESPONSE_OK)
2054 #if USE_NEW_GTK_FONT_CHOOSER
2055 /* Use the GTK3 font chooser. */
2056 PangoFontDescription *desc
2057 = gtk_font_chooser_get_font_desc (GTK_FONT_CHOOSER (w));
2059 if (desc)
2061 Lisp_Object args[10];
2062 const char *name = pango_font_description_get_family (desc);
2063 gint size = pango_font_description_get_size (desc);
2064 PangoWeight weight = pango_font_description_get_weight (desc);
2065 PangoStyle style = pango_font_description_get_style (desc);
2067 args[0] = QCname;
2068 args[1] = build_string (name);
2070 args[2] = QCsize;
2071 args[3] = make_float (pango_units_to_double (size));
2073 args[4] = QCweight;
2074 args[5] = XG_WEIGHT_TO_SYMBOL (weight);
2076 args[6] = QCslant;
2077 args[7] = XG_STYLE_TO_SYMBOL (style);
2079 args[8] = QCtype;
2080 args[9] = Qxft;
2082 font = Ffont_spec (8, args);
2084 pango_font_description_free (desc);
2085 dupstring (&x_last_font_name, name);
2088 #else /* Use old font selector, which just returns the font name. */
2090 char *font_name
2091 = gtk_font_selection_dialog_get_font_name (GTK_FONT_CHOOSER (w));
2093 if (font_name)
2095 font = build_string (font_name);
2096 g_free (x_last_font_name);
2097 x_last_font_name = font_name;
2099 #endif /* USE_NEW_GTK_FONT_CHOOSER */
2102 gtk_widget_destroy (w);
2103 return font;
2105 #endif /* HAVE_FREETYPE */
2109 /***********************************************************************
2110 Menu functions.
2111 ***********************************************************************/
2113 /* The name of menu items that can be used for customization. Since GTK
2114 RC files are very crude and primitive, we have to set this on all
2115 menu item names so a user can easily customize menu items. */
2117 #define MENU_ITEM_NAME "emacs-menuitem"
2120 /* Linked list of all allocated struct xg_menu_cb_data. Used for marking
2121 during GC. The next member points to the items. */
2122 static xg_list_node xg_menu_cb_list;
2124 /* Linked list of all allocated struct xg_menu_item_cb_data. Used for marking
2125 during GC. The next member points to the items. */
2126 static xg_list_node xg_menu_item_cb_list;
2128 /* Allocate and initialize CL_DATA if NULL, otherwise increase ref_count.
2129 F is the frame CL_DATA will be initialized for.
2130 HIGHLIGHT_CB is the callback to call when entering/leaving menu items.
2132 The menu bar and all sub menus under the menu bar in a frame
2133 share the same structure, hence the reference count.
2135 Returns CL_DATA if CL_DATA is not NULL, or a pointer to a newly
2136 allocated xg_menu_cb_data if CL_DATA is NULL. */
2138 static xg_menu_cb_data *
2139 make_cl_data (xg_menu_cb_data *cl_data, struct frame *f, GCallback highlight_cb)
2141 if (! cl_data)
2143 cl_data = xmalloc (sizeof *cl_data);
2144 cl_data->f = f;
2145 cl_data->menu_bar_vector = f->menu_bar_vector;
2146 cl_data->menu_bar_items_used = f->menu_bar_items_used;
2147 cl_data->highlight_cb = highlight_cb;
2148 cl_data->ref_count = 0;
2150 xg_list_insert (&xg_menu_cb_list, &cl_data->ptrs);
2153 cl_data->ref_count++;
2155 return cl_data;
2158 /* Update CL_DATA with values from frame F and with HIGHLIGHT_CB.
2159 HIGHLIGHT_CB is the callback to call when entering/leaving menu items.
2161 When the menu bar is updated, menu items may have been added and/or
2162 removed, so menu_bar_vector and menu_bar_items_used change. We must
2163 then update CL_DATA since it is used to determine which menu
2164 item that is invoked in the menu.
2165 HIGHLIGHT_CB could change, there is no check that the same
2166 function is given when modifying a menu bar as was given when
2167 creating the menu bar. */
2169 static void
2170 update_cl_data (xg_menu_cb_data *cl_data,
2171 struct frame *f,
2172 GCallback highlight_cb)
2174 if (cl_data)
2176 cl_data->f = f;
2177 cl_data->menu_bar_vector = f->menu_bar_vector;
2178 cl_data->menu_bar_items_used = f->menu_bar_items_used;
2179 cl_data->highlight_cb = highlight_cb;
2183 /* Decrease reference count for CL_DATA.
2184 If reference count is zero, free CL_DATA. */
2186 static void
2187 unref_cl_data (xg_menu_cb_data *cl_data)
2189 if (cl_data && cl_data->ref_count > 0)
2191 cl_data->ref_count--;
2192 if (cl_data->ref_count == 0)
2194 xg_list_remove (&xg_menu_cb_list, &cl_data->ptrs);
2195 xfree (cl_data);
2200 /* Function that marks all lisp data during GC. */
2202 void
2203 xg_mark_data (void)
2205 xg_list_node *iter;
2206 Lisp_Object rest, frame;
2208 for (iter = xg_menu_cb_list.next; iter; iter = iter->next)
2209 mark_object (((xg_menu_cb_data *) iter)->menu_bar_vector);
2211 for (iter = xg_menu_item_cb_list.next; iter; iter = iter->next)
2213 xg_menu_item_cb_data *cb_data = (xg_menu_item_cb_data *) iter;
2215 if (! NILP (cb_data->help))
2216 mark_object (cb_data->help);
2219 FOR_EACH_FRAME (rest, frame)
2221 struct frame *f = XFRAME (frame);
2223 if (FRAME_X_P (f) && FRAME_GTK_OUTER_WIDGET (f))
2225 struct xg_frame_tb_info *tbinfo
2226 = g_object_get_data (G_OBJECT (FRAME_GTK_OUTER_WIDGET (f)),
2227 TB_INFO_KEY);
2228 if (tbinfo)
2230 mark_object (tbinfo->last_tool_bar);
2231 mark_object (tbinfo->style);
2238 /* Callback called when a menu item is destroyed. Used to free data.
2239 W is the widget that is being destroyed (not used).
2240 CLIENT_DATA points to the xg_menu_item_cb_data associated with the W. */
2242 static void
2243 menuitem_destroy_callback (GtkWidget *w, gpointer client_data)
2245 if (client_data)
2247 xg_menu_item_cb_data *data = client_data;
2248 xg_list_remove (&xg_menu_item_cb_list, &data->ptrs);
2249 xfree (data);
2253 /* Callback called when the pointer enters/leaves a menu item.
2254 W is the parent of the menu item.
2255 EVENT is either an enter event or leave event.
2256 CLIENT_DATA is not used.
2258 Returns FALSE to tell GTK to keep processing this event. */
2260 static gboolean
2261 menuitem_highlight_callback (GtkWidget *w,
2262 GdkEventCrossing *event,
2263 gpointer client_data)
2265 GdkEvent ev;
2266 GtkWidget *subwidget;
2267 xg_menu_item_cb_data *data;
2269 ev.crossing = *event;
2270 subwidget = gtk_get_event_widget (&ev);
2271 data = g_object_get_data (G_OBJECT (subwidget), XG_ITEM_DATA);
2272 if (data)
2274 if (! NILP (data->help) && data->cl_data->highlight_cb)
2276 gpointer call_data = event->type == GDK_LEAVE_NOTIFY ? 0 : data;
2277 GtkCallback func = (GtkCallback) data->cl_data->highlight_cb;
2278 (*func) (subwidget, call_data);
2282 return FALSE;
2285 /* Callback called when a menu is destroyed. Used to free data.
2286 W is the widget that is being destroyed (not used).
2287 CLIENT_DATA points to the xg_menu_cb_data associated with W. */
2289 static void
2290 menu_destroy_callback (GtkWidget *w, gpointer client_data)
2292 unref_cl_data (client_data);
2295 /* Make a GTK widget that contains both UTF8_LABEL and UTF8_KEY (both
2296 must be non-NULL) and can be inserted into a menu item.
2298 Returns the GtkHBox. */
2300 static GtkWidget *
2301 make_widget_for_menu_item (const char *utf8_label, const char *utf8_key)
2303 GtkWidget *wlbl;
2304 GtkWidget *wkey;
2305 GtkWidget *wbox;
2307 wbox = gtk_box_new (GTK_ORIENTATION_HORIZONTAL, 0);
2308 gtk_box_set_homogeneous (GTK_BOX (wbox), FALSE);
2309 wlbl = gtk_label_new (utf8_label);
2310 wkey = gtk_label_new (utf8_key);
2312 #if GTK_CHECK_VERSION (3, 14, 0)
2313 gtk_widget_set_halign (wlbl, GTK_ALIGN_START);
2314 gtk_widget_set_valign (wlbl, GTK_ALIGN_CENTER);
2315 gtk_widget_set_halign (wkey, GTK_ALIGN_START);
2316 gtk_widget_set_valign (wkey, GTK_ALIGN_CENTER);
2317 #else
2318 gtk_misc_set_alignment (GTK_MISC (wlbl), 0.0, 0.5);
2319 gtk_misc_set_alignment (GTK_MISC (wkey), 0.0, 0.5);
2320 #endif
2321 gtk_box_pack_start (GTK_BOX (wbox), wlbl, TRUE, TRUE, 0);
2322 gtk_box_pack_start (GTK_BOX (wbox), wkey, FALSE, FALSE, 0);
2324 gtk_widget_set_name (wlbl, MENU_ITEM_NAME);
2325 gtk_widget_set_name (wkey, MENU_ITEM_NAME);
2326 gtk_widget_set_name (wbox, MENU_ITEM_NAME);
2328 return wbox;
2331 /* Make and return a menu item widget with the key to the right.
2332 UTF8_LABEL is the text for the menu item (GTK uses UTF8 internally).
2333 UTF8_KEY is the text representing the key binding.
2334 ITEM is the widget_value describing the menu item.
2336 GROUP is an in/out parameter. If the menu item to be created is not
2337 part of any radio menu group, *GROUP contains NULL on entry and exit.
2338 If the menu item to be created is part of a radio menu group, on entry
2339 *GROUP contains the group to use, or NULL if this is the first item
2340 in the group. On exit, *GROUP contains the radio item group.
2342 Unfortunately, keys don't line up as nicely as in Motif,
2343 but the MacOS X version doesn't either, so I guess that is OK. */
2345 static GtkWidget *
2346 make_menu_item (const char *utf8_label,
2347 const char *utf8_key,
2348 widget_value *item,
2349 GSList **group)
2351 GtkWidget *w;
2352 GtkWidget *wtoadd = 0;
2354 /* It has been observed that some menu items have a NULL name field.
2355 This will lead to this function being called with a NULL utf8_label.
2356 GTK crashes on that so we set a blank label. Why there is a NULL
2357 name remains to be investigated. */
2358 if (! utf8_label) utf8_label = " ";
2360 if (utf8_key)
2361 wtoadd = make_widget_for_menu_item (utf8_label, utf8_key);
2363 if (item->button_type == BUTTON_TYPE_TOGGLE)
2365 *group = NULL;
2366 if (utf8_key) w = gtk_check_menu_item_new ();
2367 else w = gtk_check_menu_item_new_with_label (utf8_label);
2368 gtk_check_menu_item_set_active (GTK_CHECK_MENU_ITEM (w), item->selected);
2370 else if (item->button_type == BUTTON_TYPE_RADIO)
2372 if (utf8_key) w = gtk_radio_menu_item_new (*group);
2373 else w = gtk_radio_menu_item_new_with_label (*group, utf8_label);
2374 *group = gtk_radio_menu_item_get_group (GTK_RADIO_MENU_ITEM (w));
2375 if (item->selected)
2376 gtk_check_menu_item_set_active (GTK_CHECK_MENU_ITEM (w), TRUE);
2378 else
2380 *group = NULL;
2381 if (utf8_key) w = gtk_menu_item_new ();
2382 else w = gtk_menu_item_new_with_label (utf8_label);
2385 if (wtoadd) gtk_container_add (GTK_CONTAINER (w), wtoadd);
2386 if (! item->enabled) gtk_widget_set_sensitive (w, FALSE);
2388 return w;
2391 /* Create a menu item widget, and connect the callbacks.
2392 ITEM describes the menu item.
2393 F is the frame the created menu belongs to.
2394 SELECT_CB is the callback to use when a menu item is selected.
2395 HIGHLIGHT_CB is the callback to call when entering/leaving menu items.
2396 CL_DATA points to the callback data to be used for this menu.
2397 GROUP is an in/out parameter. If the menu item to be created is not
2398 part of any radio menu group, *GROUP contains NULL on entry and exit.
2399 If the menu item to be created is part of a radio menu group, on entry
2400 *GROUP contains the group to use, or NULL if this is the first item
2401 in the group. On exit, *GROUP contains the radio item group.
2403 Returns the created GtkWidget. */
2405 static GtkWidget *
2406 xg_create_one_menuitem (widget_value *item,
2407 struct frame *f,
2408 GCallback select_cb,
2409 GCallback highlight_cb,
2410 xg_menu_cb_data *cl_data,
2411 GSList **group)
2413 char *utf8_label;
2414 char *utf8_key;
2415 GtkWidget *w;
2416 xg_menu_item_cb_data *cb_data;
2418 utf8_label = get_utf8_string (item->name);
2419 utf8_key = get_utf8_string (item->key);
2421 w = make_menu_item (utf8_label, utf8_key, item, group);
2423 if (utf8_label) g_free (utf8_label);
2424 if (utf8_key) g_free (utf8_key);
2426 cb_data = xmalloc (sizeof *cb_data);
2428 xg_list_insert (&xg_menu_item_cb_list, &cb_data->ptrs);
2430 cb_data->select_id = 0;
2431 cb_data->help = item->help;
2432 cb_data->cl_data = cl_data;
2433 cb_data->call_data = item->call_data;
2435 g_signal_connect (G_OBJECT (w),
2436 "destroy",
2437 G_CALLBACK (menuitem_destroy_callback),
2438 cb_data);
2440 /* Put cb_data in widget, so we can get at it when modifying menubar */
2441 g_object_set_data (G_OBJECT (w), XG_ITEM_DATA, cb_data);
2443 /* final item, not a submenu */
2444 if (item->call_data && ! item->contents)
2446 if (select_cb)
2447 cb_data->select_id
2448 = g_signal_connect (G_OBJECT (w), "activate", select_cb, cb_data);
2451 return w;
2454 /* Create a full menu tree specified by DATA.
2455 F is the frame the created menu belongs to.
2456 SELECT_CB is the callback to use when a menu item is selected.
2457 DEACTIVATE_CB is the callback to use when a sub menu is not shown anymore.
2458 HIGHLIGHT_CB is the callback to call when entering/leaving menu items.
2459 If POP_UP_P, create a popup menu.
2460 If MENU_BAR_P, create a menu bar.
2461 TOPMENU is the topmost GtkWidget that others shall be placed under.
2462 It may be NULL, in that case we create the appropriate widget
2463 (menu bar or menu item depending on POP_UP_P and MENU_BAR_P)
2464 CL_DATA is the callback data we shall use for this menu, or NULL
2465 if we haven't set the first callback yet.
2466 NAME is the name to give to the top level menu if this function
2467 creates it. May be NULL to not set any name.
2469 Returns the top level GtkWidget. This is TOPLEVEL if TOPLEVEL is
2470 not NULL.
2472 This function calls itself to create submenus. */
2474 static GtkWidget *
2475 create_menus (widget_value *data,
2476 struct frame *f,
2477 GCallback select_cb,
2478 GCallback deactivate_cb,
2479 GCallback highlight_cb,
2480 bool pop_up_p,
2481 bool menu_bar_p,
2482 GtkWidget *topmenu,
2483 xg_menu_cb_data *cl_data,
2484 const char *name)
2486 widget_value *item;
2487 GtkWidget *wmenu = topmenu;
2488 GSList *group = NULL;
2490 if (! topmenu)
2492 if (! menu_bar_p)
2494 wmenu = gtk_menu_new ();
2495 xg_set_screen (wmenu, f);
2496 /* Connect this to the menu instead of items so we get enter/leave for
2497 disabled items also. TODO: Still does not get enter/leave for
2498 disabled items in detached menus. */
2499 g_signal_connect (G_OBJECT (wmenu),
2500 "enter-notify-event",
2501 G_CALLBACK (menuitem_highlight_callback),
2502 NULL);
2503 g_signal_connect (G_OBJECT (wmenu),
2504 "leave-notify-event",
2505 G_CALLBACK (menuitem_highlight_callback),
2506 NULL);
2508 else
2510 wmenu = gtk_menu_bar_new ();
2511 /* Set width of menu bar to a small value so it doesn't enlarge
2512 a small initial frame size. The width will be set to the
2513 width of the frame later on when it is added to a container.
2514 height -1: Natural height. */
2515 gtk_widget_set_size_request (wmenu, 1, -1);
2518 /* Put cl_data on the top menu for easier access. */
2519 cl_data = make_cl_data (cl_data, f, highlight_cb);
2520 g_object_set_data (G_OBJECT (wmenu), XG_FRAME_DATA, (gpointer)cl_data);
2521 g_signal_connect (G_OBJECT (wmenu), "destroy",
2522 G_CALLBACK (menu_destroy_callback), cl_data);
2524 if (name)
2525 gtk_widget_set_name (wmenu, name);
2527 if (deactivate_cb)
2528 g_signal_connect (G_OBJECT (wmenu),
2529 "selection-done", deactivate_cb, 0);
2532 for (item = data; item; item = item->next)
2534 GtkWidget *w;
2536 if (pop_up_p && !item->contents && !item->call_data
2537 && !menu_separator_name_p (item->name))
2539 char *utf8_label;
2540 /* A title for a popup. We do the same as GTK does when
2541 creating titles, but it does not look good. */
2542 group = NULL;
2543 utf8_label = get_utf8_string (item->name);
2545 w = gtk_menu_item_new_with_label (utf8_label);
2546 gtk_widget_set_sensitive (w, FALSE);
2547 if (utf8_label) g_free (utf8_label);
2549 else if (menu_separator_name_p (item->name))
2551 group = NULL;
2552 /* GTK only have one separator type. */
2553 w = gtk_separator_menu_item_new ();
2555 else
2557 w = xg_create_one_menuitem (item,
2559 item->contents ? 0 : select_cb,
2560 highlight_cb,
2561 cl_data,
2562 &group);
2564 /* Create a possibly empty submenu for menu bar items, since some
2565 themes don't highlight items correctly without it. */
2566 if (item->contents || menu_bar_p)
2568 GtkWidget *submenu = create_menus (item->contents,
2570 select_cb,
2571 deactivate_cb,
2572 highlight_cb,
2576 cl_data,
2578 gtk_menu_item_set_submenu (GTK_MENU_ITEM (w), submenu);
2582 gtk_menu_shell_append (GTK_MENU_SHELL (wmenu), w);
2583 gtk_widget_set_name (w, MENU_ITEM_NAME);
2586 return wmenu;
2589 /* Create a menubar, popup menu or dialog, depending on the TYPE argument.
2590 TYPE can be "menubar", "popup" for popup menu, or "dialog" for a dialog
2591 with some text and buttons.
2592 F is the frame the created item belongs to.
2593 NAME is the name to use for the top widget.
2594 VAL is a widget_value structure describing items to be created.
2595 SELECT_CB is the callback to use when a menu item is selected or
2596 a dialog button is pressed.
2597 DEACTIVATE_CB is the callback to use when an item is deactivated.
2598 For a menu, when a sub menu is not shown anymore, for a dialog it is
2599 called when the dialog is popped down.
2600 HIGHLIGHT_CB is the callback to call when entering/leaving menu items.
2602 Returns the widget created. */
2604 GtkWidget *
2605 xg_create_widget (const char *type, const char *name, struct frame *f,
2606 widget_value *val, GCallback select_cb,
2607 GCallback deactivate_cb, GCallback highlight_cb)
2609 GtkWidget *w = 0;
2610 bool menu_bar_p = strcmp (type, "menubar") == 0;
2611 bool pop_up_p = strcmp (type, "popup") == 0;
2613 if (strcmp (type, "dialog") == 0)
2615 w = create_dialog (val, select_cb, deactivate_cb);
2616 xg_set_screen (w, f);
2617 gtk_window_set_transient_for (GTK_WINDOW (w),
2618 GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)));
2619 gtk_window_set_destroy_with_parent (GTK_WINDOW (w), TRUE);
2620 gtk_widget_set_name (w, "emacs-dialog");
2621 gtk_window_set_modal (GTK_WINDOW (w), TRUE);
2623 else if (menu_bar_p || pop_up_p)
2625 w = create_menus (val->contents,
2627 select_cb,
2628 deactivate_cb,
2629 highlight_cb,
2630 pop_up_p,
2631 menu_bar_p,
2634 name);
2636 /* Set the cursor to an arrow for popup menus when they are mapped.
2637 This is done by default for menu bar menus. */
2638 if (pop_up_p)
2640 /* Must realize so the GdkWindow inside the widget is created. */
2641 gtk_widget_realize (w);
2642 xg_set_cursor (w, FRAME_DISPLAY_INFO (f)->xg_cursor);
2645 else
2647 fprintf (stderr, "bad type in xg_create_widget: %s, doing nothing\n",
2648 type);
2651 return w;
2654 /* Return the label for menu item WITEM. */
2656 static const char *
2657 xg_get_menu_item_label (GtkMenuItem *witem)
2659 GtkLabel *wlabel = GTK_LABEL (XG_BIN_CHILD (witem));
2660 return gtk_label_get_label (wlabel);
2663 /* Return true if the menu item WITEM has the text LABEL. */
2665 static bool
2666 xg_item_label_same_p (GtkMenuItem *witem, const char *label)
2668 bool is_same = 0;
2669 char *utf8_label = get_utf8_string (label);
2670 const char *old_label = witem ? xg_get_menu_item_label (witem) : 0;
2672 if (! old_label && ! utf8_label)
2673 is_same = 1;
2674 else if (old_label && utf8_label)
2675 is_same = strcmp (utf8_label, old_label) == 0;
2677 if (utf8_label) g_free (utf8_label);
2679 return is_same;
2682 /* Destroy widgets in LIST. */
2684 static void
2685 xg_destroy_widgets (GList *list)
2687 GList *iter;
2689 for (iter = list; iter; iter = g_list_next (iter))
2691 GtkWidget *w = GTK_WIDGET (iter->data);
2693 /* Destroying the widget will remove it from the container it is in. */
2694 gtk_widget_destroy (w);
2698 /* Update the top level names in MENUBAR (i.e. not submenus).
2699 F is the frame the menu bar belongs to.
2700 *LIST is a list with the current menu bar names (menu item widgets).
2701 ITER is the item within *LIST that shall be updated.
2702 POS is the numerical position, starting at 0, of ITER in *LIST.
2703 VAL describes what the menu bar shall look like after the update.
2704 SELECT_CB is the callback to use when a menu item is selected.
2705 HIGHLIGHT_CB is the callback to call when entering/leaving menu items.
2706 CL_DATA points to the callback data to be used for this menu bar.
2708 This function calls itself to walk through the menu bar names. */
2710 static void
2711 xg_update_menubar (GtkWidget *menubar,
2712 struct frame *f,
2713 GList **list,
2714 GList *iter,
2715 int pos,
2716 widget_value *val,
2717 GCallback select_cb,
2718 GCallback deactivate_cb,
2719 GCallback highlight_cb,
2720 xg_menu_cb_data *cl_data)
2722 if (! iter && ! val)
2723 return;
2724 else if (iter && ! val)
2726 /* Item(s) have been removed. Remove all remaining items. */
2727 xg_destroy_widgets (iter);
2729 /* Add a blank entry so the menubar doesn't collapse to nothing. */
2730 gtk_menu_shell_insert (GTK_MENU_SHELL (menubar),
2731 gtk_menu_item_new_with_label (""),
2733 /* All updated. */
2734 val = 0;
2735 iter = 0;
2737 else if (! iter && val)
2739 /* Item(s) added. Add all new items in one call. */
2740 create_menus (val, f, select_cb, deactivate_cb, highlight_cb,
2741 0, 1, menubar, cl_data, 0);
2743 /* All updated. */
2744 val = 0;
2745 iter = 0;
2747 /* Below this neither iter or val is NULL */
2748 else if (xg_item_label_same_p (GTK_MENU_ITEM (iter->data), val->name))
2750 /* This item is still the same, check next item. */
2751 val = val->next;
2752 iter = g_list_next (iter);
2753 ++pos;
2755 else /* This item is changed. */
2757 GtkMenuItem *witem = GTK_MENU_ITEM (iter->data);
2758 GtkMenuItem *witem2 = 0;
2759 bool val_in_menubar = 0;
2760 bool iter_in_new_menubar = 0;
2761 GList *iter2;
2762 widget_value *cur;
2764 /* See if the changed entry (val) is present later in the menu bar */
2765 for (iter2 = iter;
2766 iter2 && ! val_in_menubar;
2767 iter2 = g_list_next (iter2))
2769 witem2 = GTK_MENU_ITEM (iter2->data);
2770 val_in_menubar = xg_item_label_same_p (witem2, val->name);
2773 /* See if the current entry (iter) is present later in the
2774 specification for the new menu bar. */
2775 for (cur = val; cur && ! iter_in_new_menubar; cur = cur->next)
2776 iter_in_new_menubar = xg_item_label_same_p (witem, cur->name);
2778 if (val_in_menubar && ! iter_in_new_menubar)
2780 int nr = pos;
2782 /* This corresponds to:
2783 Current: A B C
2784 New: A C
2785 Remove B. */
2787 g_object_ref (G_OBJECT (witem));
2788 gtk_container_remove (GTK_CONTAINER (menubar), GTK_WIDGET (witem));
2789 gtk_widget_destroy (GTK_WIDGET (witem));
2791 /* Must get new list since the old changed. */
2792 g_list_free (*list);
2793 *list = iter = gtk_container_get_children (GTK_CONTAINER (menubar));
2794 while (nr-- > 0) iter = g_list_next (iter);
2796 else if (! val_in_menubar && ! iter_in_new_menubar)
2798 /* This corresponds to:
2799 Current: A B C
2800 New: A X C
2801 Rename B to X. This might seem to be a strange thing to do,
2802 since if there is a menu under B it will be totally wrong for X.
2803 But consider editing a C file. Then there is a C-mode menu
2804 (corresponds to B above).
2805 If then doing C-x C-f the minibuf menu (X above) replaces the
2806 C-mode menu. When returning from the minibuffer, we get
2807 back the C-mode menu. Thus we do:
2808 Rename B to X (C-mode to minibuf menu)
2809 Rename X to B (minibuf to C-mode menu).
2810 If the X menu hasn't been invoked, the menu under B
2811 is up to date when leaving the minibuffer. */
2812 GtkLabel *wlabel = GTK_LABEL (XG_BIN_CHILD (witem));
2813 char *utf8_label = get_utf8_string (val->name);
2815 /* GTK menu items don't notice when their labels have been
2816 changed from underneath them, so we have to explicitly
2817 use g_object_notify to tell listeners (e.g., a GMenuModel
2818 bridge that might be loaded) that the item's label has
2819 changed. */
2820 gtk_label_set_text (wlabel, utf8_label);
2821 #if GTK_CHECK_VERSION (2, 16, 0)
2822 g_object_notify (G_OBJECT (witem), "label");
2823 #endif
2824 if (utf8_label) g_free (utf8_label);
2825 iter = g_list_next (iter);
2826 val = val->next;
2827 ++pos;
2829 else if (! val_in_menubar && iter_in_new_menubar)
2831 /* This corresponds to:
2832 Current: A B C
2833 New: A X B C
2834 Insert X. */
2836 int nr = pos;
2837 GSList *group = 0;
2838 GtkWidget *w = xg_create_one_menuitem (val,
2840 select_cb,
2841 highlight_cb,
2842 cl_data,
2843 &group);
2845 /* Create a possibly empty submenu for menu bar items, since some
2846 themes don't highlight items correctly without it. */
2847 GtkWidget *submenu = create_menus (NULL, f,
2848 select_cb, deactivate_cb,
2849 highlight_cb,
2850 0, 0, 0, cl_data, 0);
2852 gtk_widget_set_name (w, MENU_ITEM_NAME);
2853 gtk_menu_shell_insert (GTK_MENU_SHELL (menubar), w, pos);
2854 gtk_menu_item_set_submenu (GTK_MENU_ITEM (w), submenu);
2856 g_list_free (*list);
2857 *list = iter = gtk_container_get_children (GTK_CONTAINER (menubar));
2858 while (nr-- > 0) iter = g_list_next (iter);
2859 iter = g_list_next (iter);
2860 val = val->next;
2861 ++pos;
2863 else /* if (val_in_menubar && iter_in_new_menubar) */
2865 int nr = pos;
2866 /* This corresponds to:
2867 Current: A B C
2868 New: A C B
2869 Move C before B */
2871 g_object_ref (G_OBJECT (witem2));
2872 gtk_container_remove (GTK_CONTAINER (menubar), GTK_WIDGET (witem2));
2873 gtk_menu_shell_insert (GTK_MENU_SHELL (menubar),
2874 GTK_WIDGET (witem2), pos);
2875 g_object_unref (G_OBJECT (witem2));
2877 g_list_free (*list);
2878 *list = iter = gtk_container_get_children (GTK_CONTAINER (menubar));
2879 while (nr-- > 0) iter = g_list_next (iter);
2880 if (iter) iter = g_list_next (iter);
2881 val = val->next;
2882 ++pos;
2886 /* Update the rest of the menu bar. */
2887 xg_update_menubar (menubar, f, list, iter, pos, val,
2888 select_cb, deactivate_cb, highlight_cb, cl_data);
2891 /* Update the menu item W so it corresponds to VAL.
2892 SELECT_CB is the callback to use when a menu item is selected.
2893 HIGHLIGHT_CB is the callback to call when entering/leaving menu items.
2894 CL_DATA is the data to set in the widget for menu invocation. */
2896 static void
2897 xg_update_menu_item (widget_value *val,
2898 GtkWidget *w,
2899 GCallback select_cb,
2900 GCallback highlight_cb,
2901 xg_menu_cb_data *cl_data)
2903 GtkWidget *wchild;
2904 GtkLabel *wlbl = 0;
2905 GtkLabel *wkey = 0;
2906 char *utf8_label;
2907 char *utf8_key;
2908 const char *old_label = 0;
2909 const char *old_key = 0;
2910 xg_menu_item_cb_data *cb_data;
2911 bool label_changed = false;
2913 wchild = XG_BIN_CHILD (w);
2914 utf8_label = get_utf8_string (val->name);
2915 utf8_key = get_utf8_string (val->key);
2917 /* See if W is a menu item with a key. See make_menu_item above. */
2918 if (GTK_IS_BOX (wchild))
2920 GList *list = gtk_container_get_children (GTK_CONTAINER (wchild));
2922 wlbl = GTK_LABEL (list->data);
2923 wkey = GTK_LABEL (list->next->data);
2924 g_list_free (list);
2926 if (! utf8_key)
2928 /* Remove the key and keep just the label. */
2929 g_object_ref (G_OBJECT (wlbl));
2930 gtk_container_remove (GTK_CONTAINER (w), wchild);
2931 gtk_container_add (GTK_CONTAINER (w), GTK_WIDGET (wlbl));
2932 g_object_unref (G_OBJECT (wlbl));
2933 wkey = 0;
2937 else /* Just a label. */
2939 wlbl = GTK_LABEL (wchild);
2941 /* Check if there is now a key. */
2942 if (utf8_key)
2944 GtkWidget *wtoadd = make_widget_for_menu_item (utf8_label, utf8_key);
2945 GList *list = gtk_container_get_children (GTK_CONTAINER (wtoadd));
2947 wlbl = GTK_LABEL (list->data);
2948 wkey = GTK_LABEL (list->next->data);
2949 g_list_free (list);
2951 gtk_container_remove (GTK_CONTAINER (w), wchild);
2952 gtk_container_add (GTK_CONTAINER (w), wtoadd);
2956 if (wkey) old_key = gtk_label_get_label (wkey);
2957 if (wlbl) old_label = gtk_label_get_label (wlbl);
2959 if (wkey && utf8_key && (! old_key || strcmp (utf8_key, old_key) != 0))
2961 label_changed = true;
2962 gtk_label_set_text (wkey, utf8_key);
2965 if (! old_label || strcmp (utf8_label, old_label) != 0)
2967 label_changed = true;
2968 gtk_label_set_text (wlbl, utf8_label);
2971 if (utf8_key) g_free (utf8_key);
2972 if (utf8_label) g_free (utf8_label);
2974 if (! val->enabled && gtk_widget_get_sensitive (w))
2975 gtk_widget_set_sensitive (w, FALSE);
2976 else if (val->enabled && ! gtk_widget_get_sensitive (w))
2977 gtk_widget_set_sensitive (w, TRUE);
2979 cb_data = g_object_get_data (G_OBJECT (w), XG_ITEM_DATA);
2980 if (cb_data)
2982 cb_data->call_data = val->call_data;
2983 cb_data->help = val->help;
2984 cb_data->cl_data = cl_data;
2986 /* We assume the callback functions don't change. */
2987 if (val->call_data && ! val->contents)
2989 /* This item shall have a select callback. */
2990 if (! cb_data->select_id)
2991 cb_data->select_id
2992 = g_signal_connect (G_OBJECT (w), "activate",
2993 select_cb, cb_data);
2995 else if (cb_data->select_id)
2997 g_signal_handler_disconnect (w, cb_data->select_id);
2998 cb_data->select_id = 0;
3002 #if GTK_CHECK_VERSION (2, 16, 0)
3003 if (label_changed) /* See comment in xg_update_menubar. */
3004 g_object_notify (G_OBJECT (w), "label");
3005 #endif
3008 /* Update the toggle menu item W so it corresponds to VAL. */
3010 static void
3011 xg_update_toggle_item (widget_value *val, GtkWidget *w)
3013 gtk_check_menu_item_set_active (GTK_CHECK_MENU_ITEM (w), val->selected);
3016 /* Update the radio menu item W so it corresponds to VAL. */
3018 static void
3019 xg_update_radio_item (widget_value *val, GtkWidget *w)
3021 gtk_check_menu_item_set_active (GTK_CHECK_MENU_ITEM (w), val->selected);
3024 /* Update the sub menu SUBMENU and all its children so it corresponds to VAL.
3025 SUBMENU may be NULL, in that case a new menu is created.
3026 F is the frame the menu bar belongs to.
3027 VAL describes the contents of the menu bar.
3028 SELECT_CB is the callback to use when a menu item is selected.
3029 DEACTIVATE_CB is the callback to use when a sub menu is not shown anymore.
3030 HIGHLIGHT_CB is the callback to call when entering/leaving menu items.
3031 CL_DATA is the call back data to use for any newly created items.
3033 Returns the updated submenu widget, that is SUBMENU unless SUBMENU
3034 was NULL. */
3036 static GtkWidget *
3037 xg_update_submenu (GtkWidget *submenu,
3038 struct frame *f,
3039 widget_value *val,
3040 GCallback select_cb,
3041 GCallback deactivate_cb,
3042 GCallback highlight_cb,
3043 xg_menu_cb_data *cl_data)
3045 GtkWidget *newsub = submenu;
3046 GList *list = 0;
3047 GList *iter;
3048 widget_value *cur;
3049 GList *first_radio = 0;
3051 if (submenu)
3052 list = gtk_container_get_children (GTK_CONTAINER (submenu));
3054 for (cur = val, iter = list;
3055 cur && iter;
3056 iter = g_list_next (iter), cur = cur->next)
3058 GtkWidget *w = GTK_WIDGET (iter->data);
3060 /* Remember first radio button in a group. If we get a mismatch in
3061 a radio group we must rebuild the whole group so that the connections
3062 in GTK becomes correct. */
3063 if (cur->button_type == BUTTON_TYPE_RADIO && ! first_radio)
3064 first_radio = iter;
3065 else if (cur->button_type != BUTTON_TYPE_RADIO
3066 && ! GTK_IS_RADIO_MENU_ITEM (w))
3067 first_radio = 0;
3069 if (GTK_IS_SEPARATOR_MENU_ITEM (w))
3071 if (! menu_separator_name_p (cur->name))
3072 break;
3074 else if (GTK_IS_CHECK_MENU_ITEM (w))
3076 if (cur->button_type != BUTTON_TYPE_TOGGLE)
3077 break;
3078 xg_update_toggle_item (cur, w);
3079 xg_update_menu_item (cur, w, select_cb, highlight_cb, cl_data);
3081 else if (GTK_IS_RADIO_MENU_ITEM (w))
3083 if (cur->button_type != BUTTON_TYPE_RADIO)
3084 break;
3085 xg_update_radio_item (cur, w);
3086 xg_update_menu_item (cur, w, select_cb, highlight_cb, cl_data);
3088 else if (GTK_IS_MENU_ITEM (w))
3090 GtkMenuItem *witem = GTK_MENU_ITEM (w);
3091 GtkWidget *sub;
3093 if (cur->button_type != BUTTON_TYPE_NONE ||
3094 menu_separator_name_p (cur->name))
3095 break;
3097 xg_update_menu_item (cur, w, select_cb, highlight_cb, cl_data);
3099 sub = gtk_menu_item_get_submenu (witem);
3100 if (sub && ! cur->contents)
3102 /* Not a submenu anymore. */
3103 g_object_ref (G_OBJECT (sub));
3104 remove_submenu (witem);
3105 gtk_widget_destroy (sub);
3107 else if (cur->contents)
3109 GtkWidget *nsub;
3111 nsub = xg_update_submenu (sub, f, cur->contents,
3112 select_cb, deactivate_cb,
3113 highlight_cb, cl_data);
3115 /* If this item just became a submenu, we must set it. */
3116 if (nsub != sub)
3117 gtk_menu_item_set_submenu (witem, nsub);
3120 else
3122 /* Structural difference. Remove everything from here and down
3123 in SUBMENU. */
3124 break;
3128 /* Remove widgets from first structural change. */
3129 if (iter)
3131 /* If we are adding new menu items below, we must remove from
3132 first radio button so that radio groups become correct. */
3133 if (cur && first_radio) xg_destroy_widgets (first_radio);
3134 else xg_destroy_widgets (iter);
3137 if (cur)
3139 /* More items added. Create them. */
3140 newsub = create_menus (cur,
3142 select_cb,
3143 deactivate_cb,
3144 highlight_cb,
3147 submenu,
3148 cl_data,
3152 if (list) g_list_free (list);
3154 return newsub;
3157 /* Update the MENUBAR.
3158 F is the frame the menu bar belongs to.
3159 VAL describes the contents of the menu bar.
3160 If DEEP_P, rebuild all but the top level menu names in
3161 the MENUBAR. If DEEP_P is zero, just rebuild the names in the menubar.
3162 SELECT_CB is the callback to use when a menu item is selected.
3163 DEACTIVATE_CB is the callback to use when a sub menu is not shown anymore.
3164 HIGHLIGHT_CB is the callback to call when entering/leaving menu items. */
3166 void
3167 xg_modify_menubar_widgets (GtkWidget *menubar, struct frame *f,
3168 widget_value *val, bool deep_p,
3169 GCallback select_cb, GCallback deactivate_cb,
3170 GCallback highlight_cb)
3172 xg_menu_cb_data *cl_data;
3173 GList *list = gtk_container_get_children (GTK_CONTAINER (menubar));
3175 if (! list) return;
3177 cl_data = g_object_get_data (G_OBJECT (menubar), XG_FRAME_DATA);
3179 xg_update_menubar (menubar, f, &list, list, 0, val->contents,
3180 select_cb, deactivate_cb, highlight_cb, cl_data);
3182 if (deep_p)
3184 widget_value *cur;
3186 /* Update all sub menus.
3187 We must keep the submenus (GTK menu item widgets) since the
3188 X Window in the XEvent that activates the menu are those widgets. */
3190 /* Update cl_data, menu_item things in F may have changed. */
3191 update_cl_data (cl_data, f, highlight_cb);
3193 for (cur = val->contents; cur; cur = cur->next)
3195 GList *iter;
3196 GtkWidget *sub = 0;
3197 GtkWidget *newsub;
3198 GtkMenuItem *witem = 0;
3200 /* Find sub menu that corresponds to val and update it. */
3201 for (iter = list ; iter; iter = g_list_next (iter))
3203 witem = GTK_MENU_ITEM (iter->data);
3204 if (xg_item_label_same_p (witem, cur->name))
3206 sub = gtk_menu_item_get_submenu (witem);
3207 break;
3211 newsub = xg_update_submenu (sub,
3213 cur->contents,
3214 select_cb,
3215 deactivate_cb,
3216 highlight_cb,
3217 cl_data);
3218 /* sub may still be NULL. If we just updated non deep and added
3219 a new menu bar item, it has no sub menu yet. So we set the
3220 newly created sub menu under witem. */
3221 if (newsub != sub && witem != 0)
3223 xg_set_screen (newsub, f);
3224 gtk_menu_item_set_submenu (witem, newsub);
3229 g_list_free (list);
3230 gtk_widget_show_all (menubar);
3233 /* Callback called when the menu bar W is mapped.
3234 Used to find the height of the menu bar if we didn't get it
3235 after showing the widget. */
3237 static void
3238 menubar_map_cb (GtkWidget *w, gpointer user_data)
3240 GtkRequisition req;
3241 struct frame *f = user_data;
3242 gtk_widget_get_preferred_size (w, NULL, &req);
3243 if (FRAME_MENUBAR_HEIGHT (f) != req.height)
3245 FRAME_MENUBAR_HEIGHT (f) = req.height;
3246 adjust_frame_size (f, -1, -1, 2, 0, Qmenu_bar_lines);
3250 /* Recompute all the widgets of frame F, when the menu bar has been
3251 changed. */
3253 void
3254 xg_update_frame_menubar (struct frame *f)
3256 struct x_output *x = f->output_data.x;
3257 GtkRequisition req;
3259 if (!x->menubar_widget || gtk_widget_get_mapped (x->menubar_widget))
3260 return;
3262 if (x->menubar_widget && gtk_widget_get_parent (x->menubar_widget))
3263 return; /* Already done this, happens for frames created invisible. */
3265 block_input ();
3267 gtk_box_pack_start (GTK_BOX (x->vbox_widget), x->menubar_widget,
3268 FALSE, FALSE, 0);
3269 gtk_box_reorder_child (GTK_BOX (x->vbox_widget), x->menubar_widget, 0);
3271 g_signal_connect (x->menubar_widget, "map", G_CALLBACK (menubar_map_cb), f);
3272 gtk_widget_show_all (x->menubar_widget);
3273 gtk_widget_get_preferred_size (x->menubar_widget, NULL, &req);
3275 if (FRAME_MENUBAR_HEIGHT (f) != req.height)
3277 FRAME_MENUBAR_HEIGHT (f) = req.height;
3278 adjust_frame_size (f, -1, -1, 2, 0, Qmenu_bar_lines);
3280 unblock_input ();
3283 /* Get rid of the menu bar of frame F, and free its storage.
3284 This is used when deleting a frame, and when turning off the menu bar. */
3286 void
3287 free_frame_menubar (struct frame *f)
3289 struct x_output *x = f->output_data.x;
3291 if (x->menubar_widget)
3293 block_input ();
3295 gtk_container_remove (GTK_CONTAINER (x->vbox_widget), x->menubar_widget);
3296 /* The menubar and its children shall be deleted when removed from
3297 the container. */
3298 x->menubar_widget = 0;
3299 FRAME_MENUBAR_HEIGHT (f) = 0;
3300 adjust_frame_size (f, -1, -1, 2, 0, Qmenu_bar_lines);
3301 unblock_input ();
3305 bool
3306 xg_event_is_for_menubar (struct frame *f, const XEvent *event)
3308 struct x_output *x = f->output_data.x;
3309 GList *iter;
3310 GdkRectangle rec;
3311 GList *list;
3312 GdkDisplay *gdpy;
3313 GdkWindow *gw;
3314 GdkEvent gevent;
3315 GtkWidget *gwdesc;
3317 if (! x->menubar_widget) return 0;
3319 if (! (event->xbutton.x >= 0
3320 && event->xbutton.x < FRAME_PIXEL_WIDTH (f)
3321 && event->xbutton.y >= 0
3322 && event->xbutton.y < FRAME_MENUBAR_HEIGHT (f)
3323 && event->xbutton.same_screen))
3324 return 0;
3326 gdpy = gdk_x11_lookup_xdisplay (FRAME_X_DISPLAY (f));
3327 gw = gdk_x11_window_lookup_for_display (gdpy, event->xbutton.window);
3328 if (! gw) return 0;
3329 gevent.any.window = gw;
3330 gevent.any.type = GDK_NOTHING;
3331 gwdesc = gtk_get_event_widget (&gevent);
3332 if (! gwdesc) return 0;
3333 if (! GTK_IS_MENU_BAR (gwdesc)
3334 && ! GTK_IS_MENU_ITEM (gwdesc)
3335 && ! gtk_widget_is_ancestor (x->menubar_widget, gwdesc))
3336 return 0;
3338 list = gtk_container_get_children (GTK_CONTAINER (x->menubar_widget));
3339 if (! list) return 0;
3340 rec.x = event->xbutton.x;
3341 rec.y = event->xbutton.y;
3342 rec.width = 1;
3343 rec.height = 1;
3345 for (iter = list ; iter; iter = g_list_next (iter))
3347 GtkWidget *w = GTK_WIDGET (iter->data);
3348 if (gtk_widget_get_mapped (w) && gtk_widget_intersect (w, &rec, NULL))
3349 break;
3351 g_list_free (list);
3352 return iter != 0;
3357 /***********************************************************************
3358 Scroll bar functions
3359 ***********************************************************************/
3362 /* Setting scroll bar values invokes the callback. Use this variable
3363 to indicate that callback should do nothing. */
3365 bool xg_ignore_gtk_scrollbar;
3367 /* Width and height of scroll bars for the current theme. */
3368 static int scroll_bar_width_for_theme;
3369 static int scroll_bar_height_for_theme;
3371 /* Xlib's `Window' fits in 32 bits. But we want to store pointers, and they
3372 may be larger than 32 bits. Keep a mapping from integer index to widget
3373 pointers to get around the 32 bit limitation. */
3375 static struct
3377 GtkWidget **widgets;
3378 ptrdiff_t max_size;
3379 ptrdiff_t used;
3380 } id_to_widget;
3382 /* Grow this much every time we need to allocate more */
3384 #define ID_TO_WIDGET_INCR 32
3386 /* Store the widget pointer W in id_to_widget and return the integer index. */
3388 static ptrdiff_t
3389 xg_store_widget_in_map (GtkWidget *w)
3391 ptrdiff_t i;
3393 if (id_to_widget.max_size == id_to_widget.used)
3395 ptrdiff_t new_size;
3396 if (TYPE_MAXIMUM (Window) - ID_TO_WIDGET_INCR < id_to_widget.max_size)
3397 memory_full (SIZE_MAX);
3399 new_size = id_to_widget.max_size + ID_TO_WIDGET_INCR;
3400 id_to_widget.widgets = xnrealloc (id_to_widget.widgets,
3401 new_size, sizeof (GtkWidget *));
3403 for (i = id_to_widget.max_size; i < new_size; ++i)
3404 id_to_widget.widgets[i] = 0;
3405 id_to_widget.max_size = new_size;
3408 /* Just loop over the array and find a free place. After all,
3409 how many scroll bars are we creating? Should be a small number.
3410 The check above guarantees we will find a free place. */
3411 for (i = 0; i < id_to_widget.max_size; ++i)
3413 if (! id_to_widget.widgets[i])
3415 id_to_widget.widgets[i] = w;
3416 ++id_to_widget.used;
3418 return i;
3422 /* Should never end up here */
3423 emacs_abort ();
3426 /* Remove pointer at IDX from id_to_widget.
3427 Called when scroll bar is destroyed. */
3429 static void
3430 xg_remove_widget_from_map (ptrdiff_t idx)
3432 if (idx < id_to_widget.max_size && id_to_widget.widgets[idx] != 0)
3434 id_to_widget.widgets[idx] = 0;
3435 --id_to_widget.used;
3439 /* Get the widget pointer at IDX from id_to_widget. */
3441 static GtkWidget *
3442 xg_get_widget_from_map (ptrdiff_t idx)
3444 if (idx < id_to_widget.max_size && id_to_widget.widgets[idx] != 0)
3445 return id_to_widget.widgets[idx];
3447 return 0;
3450 static void
3451 update_theme_scrollbar_width (void)
3453 #ifdef HAVE_GTK3
3454 GtkAdjustment *vadj;
3455 #else
3456 GtkObject *vadj;
3457 #endif
3458 GtkWidget *wscroll;
3459 int w = 0, b = 0;
3461 vadj = gtk_adjustment_new (XG_SB_MIN, XG_SB_MIN, XG_SB_MAX, 0.1, 0.1, 0.1);
3462 wscroll = gtk_scrollbar_new (GTK_ORIENTATION_VERTICAL, GTK_ADJUSTMENT (vadj));
3463 g_object_ref_sink (G_OBJECT (wscroll));
3464 gtk_widget_style_get (wscroll, "slider-width", &w, "trough-border", &b, NULL);
3465 gtk_widget_destroy (wscroll);
3466 g_object_unref (G_OBJECT (wscroll));
3467 w += 2*b;
3468 if (w < 16) w = 16;
3469 scroll_bar_width_for_theme = w;
3472 static void
3473 update_theme_scrollbar_height (void)
3475 #ifdef HAVE_GTK3
3476 GtkAdjustment *hadj;
3477 #else
3478 GtkObject *hadj;
3479 #endif
3480 GtkWidget *wscroll;
3481 int w = 0, b = 0;
3483 hadj = gtk_adjustment_new (YG_SB_MIN, YG_SB_MIN, YG_SB_MAX, 0.1, 0.1, 0.1);
3484 wscroll = gtk_scrollbar_new (GTK_ORIENTATION_HORIZONTAL, GTK_ADJUSTMENT (hadj));
3485 g_object_ref_sink (G_OBJECT (wscroll));
3486 gtk_widget_style_get (wscroll, "slider-width", &w, "trough-border", &b, NULL);
3487 gtk_widget_destroy (wscroll);
3488 g_object_unref (G_OBJECT (wscroll));
3489 w += 2*b;
3490 if (w < 12) w = 12;
3491 scroll_bar_height_for_theme = w;
3495 xg_get_default_scrollbar_width (void)
3497 return scroll_bar_width_for_theme;
3501 xg_get_default_scrollbar_height (void)
3503 /* Apparently there's no default height for themes. */
3504 return scroll_bar_width_for_theme;
3507 /* Return the scrollbar id for X Window WID on display DPY.
3508 Return -1 if WID not in id_to_widget. */
3510 ptrdiff_t
3511 xg_get_scroll_id_for_window (Display *dpy, Window wid)
3513 ptrdiff_t idx;
3514 GtkWidget *w;
3516 w = xg_win_to_widget (dpy, wid);
3518 if (w)
3520 for (idx = 0; idx < id_to_widget.max_size; ++idx)
3521 if (id_to_widget.widgets[idx] == w)
3522 return idx;
3525 return -1;
3528 /* Callback invoked when scroll bar WIDGET is destroyed.
3529 DATA is the index into id_to_widget for WIDGET.
3530 We free pointer to last scroll bar values here and remove the index. */
3532 static void
3533 xg_gtk_scroll_destroy (GtkWidget *widget, gpointer data)
3535 intptr_t id = (intptr_t) data;
3536 xg_remove_widget_from_map (id);
3539 /* Create a scroll bar widget for frame F. Store the scroll bar
3540 in BAR.
3541 SCROLL_CALLBACK is the callback to invoke when the value of the
3542 bar changes.
3543 END_CALLBACK is the callback to invoke when scrolling ends.
3544 SCROLL_BAR_NAME is the name we use for the scroll bar. Can be used
3545 to set resources for the widget. */
3547 void
3548 xg_create_scroll_bar (struct frame *f,
3549 struct scroll_bar *bar,
3550 GCallback scroll_callback,
3551 GCallback end_callback,
3552 const char *scroll_bar_name)
3554 GtkWidget *wscroll;
3555 GtkWidget *webox;
3556 intptr_t scroll_id;
3557 #ifdef HAVE_GTK3
3558 GtkAdjustment *vadj;
3559 #else
3560 GtkObject *vadj;
3561 #endif
3563 /* Page, step increment values are not so important here, they
3564 will be corrected in x_set_toolkit_scroll_bar_thumb. */
3565 vadj = gtk_adjustment_new (XG_SB_MIN, XG_SB_MIN, XG_SB_MAX,
3566 0.1, 0.1, 0.1);
3568 wscroll = gtk_scrollbar_new (GTK_ORIENTATION_VERTICAL, GTK_ADJUSTMENT (vadj));
3569 webox = gtk_event_box_new ();
3570 gtk_widget_set_name (wscroll, scroll_bar_name);
3571 #ifndef HAVE_GTK3
3572 gtk_range_set_update_policy (GTK_RANGE (wscroll), GTK_UPDATE_CONTINUOUS);
3573 #endif
3574 g_object_set_data (G_OBJECT (wscroll), XG_FRAME_DATA, (gpointer)f);
3576 scroll_id = xg_store_widget_in_map (wscroll);
3578 g_signal_connect (G_OBJECT (wscroll),
3579 "destroy",
3580 G_CALLBACK (xg_gtk_scroll_destroy),
3581 (gpointer) scroll_id);
3582 g_signal_connect (G_OBJECT (wscroll),
3583 "change-value",
3584 scroll_callback,
3585 (gpointer) bar);
3586 g_signal_connect (G_OBJECT (wscroll),
3587 "button-release-event",
3588 end_callback,
3589 (gpointer) bar);
3591 /* The scroll bar widget does not draw on a window of its own. Instead
3592 it draws on the parent window, in this case the edit widget. So
3593 whenever the edit widget is cleared, the scroll bar needs to redraw
3594 also, which causes flicker. Put an event box between the edit widget
3595 and the scroll bar, so the scroll bar instead draws itself on the
3596 event box window. */
3597 gtk_fixed_put (GTK_FIXED (f->output_data.x->edit_widget), webox, -1, -1);
3598 gtk_container_add (GTK_CONTAINER (webox), wscroll);
3601 /* Set the cursor to an arrow. */
3602 xg_set_cursor (webox, FRAME_DISPLAY_INFO (f)->xg_cursor);
3604 bar->x_window = scroll_id;
3605 bar->horizontal = 0;
3608 /* Create a horizontal scroll bar widget for frame F. Store the scroll
3609 bar in BAR. SCROLL_CALLBACK is the callback to invoke when the value
3610 of the bar changes. END_CALLBACK is the callback to invoke when
3611 scrolling ends. SCROLL_BAR_NAME is the name we use for the scroll
3612 bar. Can be used to set resources for the widget. */
3614 void
3615 xg_create_horizontal_scroll_bar (struct frame *f,
3616 struct scroll_bar *bar,
3617 GCallback scroll_callback,
3618 GCallback end_callback,
3619 const char *scroll_bar_name)
3621 GtkWidget *wscroll;
3622 GtkWidget *webox;
3623 intptr_t scroll_id;
3624 #ifdef HAVE_GTK3
3625 GtkAdjustment *hadj;
3626 #else
3627 GtkObject *hadj;
3628 #endif
3630 /* Page, step increment values are not so important here, they
3631 will be corrected in x_set_toolkit_scroll_bar_thumb. */
3632 hadj = gtk_adjustment_new (YG_SB_MIN, YG_SB_MIN, YG_SB_MAX,
3633 0.1, 0.1, 0.1);
3635 wscroll = gtk_scrollbar_new (GTK_ORIENTATION_HORIZONTAL, GTK_ADJUSTMENT (hadj));
3636 webox = gtk_event_box_new ();
3637 gtk_widget_set_name (wscroll, scroll_bar_name);
3638 #ifndef HAVE_GTK3
3639 gtk_range_set_update_policy (GTK_RANGE (wscroll), GTK_UPDATE_CONTINUOUS);
3640 #endif
3641 g_object_set_data (G_OBJECT (wscroll), XG_FRAME_DATA, (gpointer)f);
3643 scroll_id = xg_store_widget_in_map (wscroll);
3645 g_signal_connect (G_OBJECT (wscroll),
3646 "destroy",
3647 G_CALLBACK (xg_gtk_scroll_destroy),
3648 (gpointer) scroll_id);
3649 g_signal_connect (G_OBJECT (wscroll),
3650 "change-value",
3651 scroll_callback,
3652 (gpointer) bar);
3653 g_signal_connect (G_OBJECT (wscroll),
3654 "button-release-event",
3655 end_callback,
3656 (gpointer) bar);
3658 /* The scroll bar widget does not draw on a window of its own. Instead
3659 it draws on the parent window, in this case the edit widget. So
3660 whenever the edit widget is cleared, the scroll bar needs to redraw
3661 also, which causes flicker. Put an event box between the edit widget
3662 and the scroll bar, so the scroll bar instead draws itself on the
3663 event box window. */
3664 gtk_fixed_put (GTK_FIXED (f->output_data.x->edit_widget), webox, -1, -1);
3665 gtk_container_add (GTK_CONTAINER (webox), wscroll);
3668 /* Set the cursor to an arrow. */
3669 xg_set_cursor (webox, FRAME_DISPLAY_INFO (f)->xg_cursor);
3671 bar->x_window = scroll_id;
3672 bar->horizontal = 1;
3675 /* Remove the scroll bar represented by SCROLLBAR_ID from the frame F. */
3677 void
3678 xg_remove_scroll_bar (struct frame *f, ptrdiff_t scrollbar_id)
3680 GtkWidget *w = xg_get_widget_from_map (scrollbar_id);
3681 if (w)
3683 GtkWidget *wparent = gtk_widget_get_parent (w);
3684 gtk_widget_destroy (w);
3685 gtk_widget_destroy (wparent);
3686 SET_FRAME_GARBAGED (f);
3690 /* Update the position of the vertical scroll bar represented by SCROLLBAR_ID
3691 in frame F.
3692 TOP/LEFT are the new pixel positions where the bar shall appear.
3693 WIDTH, HEIGHT is the size in pixels the bar shall have. */
3695 void
3696 xg_update_scrollbar_pos (struct frame *f,
3697 ptrdiff_t scrollbar_id,
3698 int top,
3699 int left,
3700 int width,
3701 int height)
3704 GtkWidget *wscroll = xg_get_widget_from_map (scrollbar_id);
3706 if (wscroll)
3708 GtkWidget *wfixed = f->output_data.x->edit_widget;
3709 GtkWidget *wparent = gtk_widget_get_parent (wscroll);
3710 gint msl;
3712 /* Clear out old position. */
3713 int oldx = -1, oldy = -1, oldw, oldh;
3714 if (gtk_widget_get_parent (wparent) == wfixed)
3716 gtk_container_child_get (GTK_CONTAINER (wfixed), wparent,
3717 "x", &oldx, "y", &oldy, NULL);
3718 gtk_widget_get_size_request (wscroll, &oldw, &oldh);
3721 /* Move and resize to new values. */
3722 gtk_fixed_move (GTK_FIXED (wfixed), wparent, left, top);
3723 gtk_widget_style_get (wscroll, "min-slider-length", &msl, NULL);
3724 if (msl > height)
3726 /* No room. Hide scroll bar as some themes output a warning if
3727 the height is less than the min size. */
3728 gtk_widget_hide (wparent);
3729 gtk_widget_hide (wscroll);
3731 else
3733 gtk_widget_show_all (wparent);
3734 gtk_widget_set_size_request (wscroll, width, height);
3736 gtk_widget_queue_draw (wfixed);
3737 gdk_window_process_all_updates ();
3738 if (oldx != -1 && oldw > 0 && oldh > 0)
3739 /* Clear under old scroll bar position. This must be done after
3740 the gtk_widget_queue_draw and gdk_window_process_all_updates
3741 above. */
3742 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3743 oldx, oldy, oldw, oldh);
3745 /* GTK does not redraw until the main loop is entered again, but
3746 if there are no X events pending we will not enter it. So we sync
3747 here to get some events. */
3749 x_sync (f);
3750 SET_FRAME_GARBAGED (f);
3751 cancel_mouse_face (f);
3756 /* Update the position of the horizontal scroll bar represented by SCROLLBAR_ID
3757 in frame F.
3758 TOP/LEFT are the new pixel positions where the bar shall appear.
3759 WIDTH, HEIGHT is the size in pixels the bar shall have. */
3761 void
3762 xg_update_horizontal_scrollbar_pos (struct frame *f,
3763 ptrdiff_t scrollbar_id,
3764 int top,
3765 int left,
3766 int width,
3767 int height)
3770 GtkWidget *wscroll = xg_get_widget_from_map (scrollbar_id);
3772 if (wscroll)
3774 GtkWidget *wfixed = f->output_data.x->edit_widget;
3775 GtkWidget *wparent = gtk_widget_get_parent (wscroll);
3776 gint msl;
3778 /* Clear out old position. */
3779 int oldx = -1, oldy = -1, oldw, oldh;
3780 if (gtk_widget_get_parent (wparent) == wfixed)
3782 gtk_container_child_get (GTK_CONTAINER (wfixed), wparent,
3783 "x", &oldx, "y", &oldy, NULL);
3784 gtk_widget_get_size_request (wscroll, &oldw, &oldh);
3787 /* Move and resize to new values. */
3788 gtk_fixed_move (GTK_FIXED (wfixed), wparent, left, top);
3789 gtk_widget_style_get (wscroll, "min-slider-length", &msl, NULL);
3790 if (msl > width)
3792 /* No room. Hide scroll bar as some themes output a warning if
3793 the width is less than the min size. */
3794 gtk_widget_hide (wparent);
3795 gtk_widget_hide (wscroll);
3797 else
3799 gtk_widget_show_all (wparent);
3800 gtk_widget_set_size_request (wscroll, width, height);
3802 gtk_widget_queue_draw (wfixed);
3803 gdk_window_process_all_updates ();
3804 if (oldx != -1 && oldw > 0 && oldh > 0)
3805 /* Clear under old scroll bar position. This must be done after
3806 the gtk_widget_queue_draw and gdk_window_process_all_updates
3807 above. */
3808 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3809 oldx, oldy, oldw, oldh);
3811 /* GTK does not redraw until the main loop is entered again, but
3812 if there are no X events pending we will not enter it. So we sync
3813 here to get some events. */
3815 x_sync (f);
3816 SET_FRAME_GARBAGED (f);
3817 cancel_mouse_face (f);
3822 /* Get the current value of the range, truncated to an integer. */
3824 static int
3825 int_gtk_range_get_value (GtkRange *range)
3827 return gtk_range_get_value (range);
3831 /* Set the thumb size and position of scroll bar BAR. We are currently
3832 displaying PORTION out of a whole WHOLE, and our position POSITION. */
3834 void
3835 xg_set_toolkit_scroll_bar_thumb (struct scroll_bar *bar,
3836 int portion,
3837 int position,
3838 int whole)
3840 GtkWidget *wscroll = xg_get_widget_from_map (bar->x_window);
3842 struct frame *f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
3844 if (wscroll && bar->dragging == -1)
3846 GtkAdjustment *adj;
3847 gdouble shown;
3848 gdouble top;
3849 int size, value;
3850 int old_size;
3851 int new_step;
3852 bool changed = 0;
3854 adj = gtk_range_get_adjustment (GTK_RANGE (wscroll));
3856 if (scroll_bar_adjust_thumb_portion_p)
3858 /* We do the same as for MOTIF in xterm.c, use 30 chars per
3859 line rather than the real portion value. This makes the
3860 thumb less likely to resize and that looks better. */
3861 portion = WINDOW_TOTAL_LINES (XWINDOW (bar->window)) * 30;
3863 /* When the thumb is at the bottom, position == whole.
3864 So we need to increase `whole' to make space for the thumb. */
3865 whole += portion;
3868 if (whole <= 0)
3869 top = 0, shown = 1;
3870 else
3872 top = (gdouble) position / whole;
3873 shown = (gdouble) portion / whole;
3876 size = clip_to_bounds (1, shown * XG_SB_RANGE, XG_SB_RANGE);
3877 value = clip_to_bounds (XG_SB_MIN, top * XG_SB_RANGE, XG_SB_MAX - size);
3879 /* Assume all lines are of equal size. */
3880 new_step = size / max (1, FRAME_LINES (f));
3882 old_size = gtk_adjustment_get_page_size (adj);
3883 if (old_size != size)
3885 int old_step = gtk_adjustment_get_step_increment (adj);
3886 if (old_step != new_step)
3888 gtk_adjustment_set_page_size (adj, size);
3889 gtk_adjustment_set_step_increment (adj, new_step);
3890 /* Assume a page increment is about 95% of the page size */
3891 gtk_adjustment_set_page_increment (adj, size - size / 20);
3892 changed = 1;
3896 if (changed || int_gtk_range_get_value (GTK_RANGE (wscroll)) != value)
3898 block_input ();
3900 /* gtk_range_set_value invokes the callback. Set
3901 ignore_gtk_scrollbar to make the callback do nothing */
3902 xg_ignore_gtk_scrollbar = 1;
3904 if (int_gtk_range_get_value (GTK_RANGE (wscroll)) != value)
3905 gtk_range_set_value (GTK_RANGE (wscroll), (gdouble)value);
3906 else if (changed)
3907 gtk_adjustment_changed (adj);
3909 xg_ignore_gtk_scrollbar = 0;
3911 unblock_input ();
3916 /* Set the thumb size and position of horizontal scroll bar BAR. We are
3917 currently displaying PORTION out of a whole WHOLE, and our position
3918 POSITION. */
3919 void
3920 xg_set_toolkit_horizontal_scroll_bar_thumb (struct scroll_bar *bar,
3921 int portion,
3922 int position,
3923 int whole)
3925 GtkWidget *wscroll = xg_get_widget_from_map (bar->x_window);
3927 if (wscroll && bar->dragging == -1)
3929 GtkAdjustment *adj;
3930 int lower = 0;
3931 int upper = max (whole - 1, 0);
3932 int pagesize = min (upper, max (portion, 0));
3933 int value = max (0, min (position, upper - pagesize));
3934 /* These should be set to something more <portion, whole>
3935 related. */
3936 int page_increment = 4;
3937 int step_increment = 1;
3939 block_input ();
3940 adj = gtk_range_get_adjustment (GTK_RANGE (wscroll));
3941 #if GTK_CHECK_VERSION (2, 3, 16)
3942 gtk_adjustment_configure (adj, (gdouble) value, (gdouble) lower,
3943 (gdouble) upper, (gdouble) step_increment,
3944 (gdouble) page_increment, (gdouble) pagesize);
3945 #else
3946 gtk_adjustment_set_lower (adj, (gdouble) lower);
3947 gtk_adjustment_set_upper (adj, (gdouble) upper);
3948 gtk_adjustment_set_page_size (adj, (gdouble) pagesize);
3949 gtk_adjustment_set_value (adj, (gdouble) value);
3950 gtk_adjustment_set_page_increment (adj, (gdouble) page_increment);
3951 gtk_adjustment_set_step_increment (adj, (gdouble) step_increment);
3952 #endif
3953 gtk_adjustment_changed (adj);
3954 unblock_input ();
3958 /* Return true if EVENT is for a scroll bar in frame F.
3959 When the same X window is used for several Gtk+ widgets, we cannot
3960 say for sure based on the X window alone if an event is for the
3961 frame. This function does additional checks. */
3963 bool
3964 xg_event_is_for_scrollbar (struct frame *f, const XEvent *event)
3966 bool retval = 0;
3968 if (f && event->type == ButtonPress && event->xbutton.button < 4)
3970 /* Check if press occurred outside the edit widget. */
3971 GdkDisplay *gdpy = gdk_x11_lookup_xdisplay (FRAME_X_DISPLAY (f));
3972 GdkWindow *gwin;
3973 #ifdef HAVE_GTK3
3974 GdkDevice *gdev = gdk_device_manager_get_client_pointer
3975 (gdk_display_get_device_manager (gdpy));
3976 gwin = gdk_device_get_window_at_position (gdev, NULL, NULL);
3977 #else
3978 gwin = gdk_display_get_window_at_pointer (gdpy, NULL, NULL);
3979 #endif
3980 retval = gwin != gtk_widget_get_window (f->output_data.x->edit_widget);
3982 else if (f
3983 && ((event->type == ButtonRelease && event->xbutton.button < 4)
3984 || event->type == MotionNotify))
3986 /* If we are releasing or moving the scroll bar, it has the grab. */
3987 GtkWidget *w = gtk_grab_get_current ();
3988 retval = w != 0 && GTK_IS_SCROLLBAR (w);
3991 return retval;
3996 /***********************************************************************
3997 Tool bar functions
3998 ***********************************************************************/
3999 /* The key for the data we put in the GtkImage widgets. The data is
4000 the image used by Emacs. We use this to see if we need to update
4001 the GtkImage with a new image. */
4002 #define XG_TOOL_BAR_IMAGE_DATA "emacs-tool-bar-image"
4004 /* The key for storing the latest modifiers so the activate callback can
4005 get them. */
4006 #define XG_TOOL_BAR_LAST_MODIFIER "emacs-tool-bar-modifier"
4008 /* The key for the data we put in the GtkImage widgets. The data is
4009 the stock name used by Emacs. We use this to see if we need to update
4010 the GtkImage with a new image. */
4011 #define XG_TOOL_BAR_STOCK_NAME "emacs-tool-bar-stock-name"
4013 /* As above, but this is used for named theme widgets, as opposed to
4014 stock items. */
4015 #define XG_TOOL_BAR_ICON_NAME "emacs-tool-bar-icon-name"
4017 /* Callback function invoked when a tool bar item is pressed.
4018 W is the button widget in the tool bar that got pressed,
4019 CLIENT_DATA is an integer that is the index of the button in the
4020 tool bar. 0 is the first button. */
4022 static gboolean
4023 xg_tool_bar_button_cb (GtkWidget *widget,
4024 GdkEventButton *event,
4025 gpointer user_data)
4027 intptr_t state = event->state;
4028 gpointer ptr = (gpointer) state;
4029 g_object_set_data (G_OBJECT (widget), XG_TOOL_BAR_LAST_MODIFIER, ptr);
4030 return FALSE;
4034 /* Callback function invoked when a tool bar item is pressed.
4035 W is the button widget in the tool bar that got pressed,
4036 CLIENT_DATA is an integer that is the index of the button in the
4037 tool bar. 0 is the first button. */
4039 static void
4040 xg_tool_bar_callback (GtkWidget *w, gpointer client_data)
4042 intptr_t idx = (intptr_t) client_data;
4043 gpointer gmod = g_object_get_data (G_OBJECT (w), XG_TOOL_BAR_LAST_MODIFIER);
4044 intptr_t mod = (intptr_t) gmod;
4046 struct frame *f = g_object_get_data (G_OBJECT (w), XG_FRAME_DATA);
4047 Lisp_Object key, frame;
4048 struct input_event event;
4049 EVENT_INIT (event);
4051 if (! f || ! f->n_tool_bar_items || NILP (f->tool_bar_items))
4052 return;
4054 idx *= TOOL_BAR_ITEM_NSLOTS;
4056 key = AREF (f->tool_bar_items, idx + TOOL_BAR_ITEM_KEY);
4057 XSETFRAME (frame, f);
4059 /* We generate two events here. The first one is to set the prefix
4060 to `(tool_bar)', see keyboard.c. */
4061 event.kind = TOOL_BAR_EVENT;
4062 event.frame_or_window = frame;
4063 event.arg = frame;
4064 kbd_buffer_store_event (&event);
4066 event.kind = TOOL_BAR_EVENT;
4067 event.frame_or_window = frame;
4068 event.arg = key;
4069 /* Convert between the modifier bits GDK uses and the modifier bits
4070 Emacs uses. This assumes GDK and X masks are the same, which they are when
4071 this is written. */
4072 event.modifiers = x_x_to_emacs_modifiers (FRAME_DISPLAY_INFO (f), mod);
4073 kbd_buffer_store_event (&event);
4075 /* Return focus to the frame after we have clicked on a detached
4076 tool bar button. */
4077 x_focus_frame (f);
4080 static GtkWidget *
4081 xg_get_tool_bar_widgets (GtkWidget *vb, GtkWidget **wimage)
4083 GList *clist = gtk_container_get_children (GTK_CONTAINER (vb));
4084 GtkWidget *c1 = clist->data;
4085 GtkWidget *c2 = clist->next ? clist->next->data : NULL;
4087 *wimage = GTK_IS_IMAGE (c1) ? c1 : c2;
4088 g_list_free (clist);
4089 return GTK_IS_LABEL (c1) ? c1 : c2;
4093 /* This callback is called when the mouse enters or leaves a tool bar item.
4094 It is used for displaying and hiding the help text.
4095 W is the tool bar item, a button.
4096 EVENT is either an enter event or leave event.
4097 CLIENT_DATA is an integer that is the index of the button in the
4098 tool bar. 0 is the first button.
4100 Returns FALSE to tell GTK to keep processing this event. */
4102 static gboolean
4103 xg_tool_bar_help_callback (GtkWidget *w,
4104 GdkEventCrossing *event,
4105 gpointer client_data)
4107 intptr_t idx = (intptr_t) client_data;
4108 struct frame *f = g_object_get_data (G_OBJECT (w), XG_FRAME_DATA);
4109 Lisp_Object help, frame;
4111 if (! f || ! f->n_tool_bar_items || NILP (f->tool_bar_items))
4112 return FALSE;
4114 if (event->type == GDK_ENTER_NOTIFY)
4116 idx *= TOOL_BAR_ITEM_NSLOTS;
4117 help = AREF (f->tool_bar_items, idx + TOOL_BAR_ITEM_HELP);
4119 if (NILP (help))
4120 help = AREF (f->tool_bar_items, idx + TOOL_BAR_ITEM_CAPTION);
4122 else
4123 help = Qnil;
4125 XSETFRAME (frame, f);
4126 kbd_buffer_store_help_event (frame, help);
4128 return FALSE;
4132 /* This callback is called when a tool bar item shall be redrawn.
4133 It modifies the expose event so that the GtkImage widget redraws the
4134 whole image. This to overcome a bug that makes GtkImage draw the image
4135 in the wrong place when it tries to redraw just a part of the image.
4136 W is the GtkImage to be redrawn.
4137 EVENT is the expose event for W.
4138 CLIENT_DATA is unused.
4140 Returns FALSE to tell GTK to keep processing this event. */
4142 #ifndef HAVE_GTK3
4143 static gboolean
4144 xg_tool_bar_item_expose_callback (GtkWidget *w,
4145 GdkEventExpose *event,
4146 gpointer client_data)
4148 gint width, height;
4150 gdk_drawable_get_size (event->window, &width, &height);
4151 event->area.x -= width > event->area.width ? width-event->area.width : 0;
4152 event->area.y -= height > event->area.height ? height-event->area.height : 0;
4154 event->area.x = max (0, event->area.x);
4155 event->area.y = max (0, event->area.y);
4157 event->area.width = max (width, event->area.width);
4158 event->area.height = max (height, event->area.height);
4160 return FALSE;
4162 #endif
4164 #ifdef HAVE_GTK_ORIENTABLE_SET_ORIENTATION
4165 #define toolbar_set_orientation(w, o) \
4166 gtk_orientable_set_orientation (GTK_ORIENTABLE (w), o)
4167 #else
4168 #define toolbar_set_orientation(w, o) \
4169 gtk_toolbar_set_orientation (GTK_TOOLBAR (w), o)
4170 #endif
4172 /* Attach a tool bar to frame F. */
4174 static void
4175 xg_pack_tool_bar (struct frame *f, Lisp_Object pos)
4177 struct x_output *x = f->output_data.x;
4178 bool into_hbox = EQ (pos, Qleft) || EQ (pos, Qright);
4179 GtkWidget *top_widget = x->toolbar_widget;
4181 toolbar_set_orientation (x->toolbar_widget,
4182 into_hbox
4183 ? GTK_ORIENTATION_VERTICAL
4184 : GTK_ORIENTATION_HORIZONTAL);
4186 if (into_hbox)
4188 gtk_box_pack_start (GTK_BOX (x->hbox_widget), top_widget,
4189 FALSE, FALSE, 0);
4191 if (EQ (pos, Qleft))
4192 gtk_box_reorder_child (GTK_BOX (x->hbox_widget),
4193 top_widget,
4195 x->toolbar_in_hbox = true;
4197 else
4199 bool vbox_pos = x->menubar_widget != 0;
4200 gtk_box_pack_start (GTK_BOX (x->vbox_widget), top_widget,
4201 FALSE, FALSE, 0);
4203 if (EQ (pos, Qtop))
4204 gtk_box_reorder_child (GTK_BOX (x->vbox_widget),
4205 top_widget,
4206 vbox_pos);
4207 x->toolbar_in_hbox = false;
4209 x->toolbar_is_packed = true;
4212 static bool xg_update_tool_bar_sizes (struct frame *f);
4214 static void
4215 tb_size_cb (GtkWidget *widget,
4216 GdkRectangle *allocation,
4217 gpointer user_data)
4219 /* When tool bar is created it has one preferred size. But when size is
4220 allocated between widgets, it may get another. So we must update
4221 size hints if tool bar size changes. Seen on Fedora 18 at least. */
4222 struct frame *f = user_data;
4223 if (xg_update_tool_bar_sizes (f))
4224 adjust_frame_size (f, -1, -1, 2, 0, Qtool_bar_lines);
4227 /* Create a tool bar for frame F. */
4229 static void
4230 xg_create_tool_bar (struct frame *f)
4232 struct x_output *x = f->output_data.x;
4233 #if GTK_CHECK_VERSION (3, 3, 6)
4234 GtkStyleContext *gsty;
4235 #endif
4236 struct xg_frame_tb_info *tbinfo
4237 = g_object_get_data (G_OBJECT (FRAME_GTK_OUTER_WIDGET (f)),
4238 TB_INFO_KEY);
4239 if (! tbinfo)
4241 tbinfo = xmalloc (sizeof (*tbinfo));
4242 tbinfo->last_tool_bar = Qnil;
4243 tbinfo->style = Qnil;
4244 tbinfo->hmargin = tbinfo->vmargin = 0;
4245 tbinfo->dir = GTK_TEXT_DIR_NONE;
4246 tbinfo->n_last_items = 0;
4247 g_object_set_data (G_OBJECT (FRAME_GTK_OUTER_WIDGET (f)),
4248 TB_INFO_KEY,
4249 tbinfo);
4252 x->toolbar_widget = gtk_toolbar_new ();
4254 gtk_widget_set_name (x->toolbar_widget, "emacs-toolbar");
4256 gtk_toolbar_set_style (GTK_TOOLBAR (x->toolbar_widget), GTK_TOOLBAR_ICONS);
4257 toolbar_set_orientation (x->toolbar_widget, GTK_ORIENTATION_HORIZONTAL);
4258 g_signal_connect (x->toolbar_widget, "size-allocate",
4259 G_CALLBACK (tb_size_cb), f);
4260 #if GTK_CHECK_VERSION (3, 3, 6)
4261 gsty = gtk_widget_get_style_context (x->toolbar_widget);
4262 gtk_style_context_add_class (gsty, "primary-toolbar");
4263 #endif
4267 #define PROP(IDX) AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
4269 /* Find the right-to-left image named by RTL in the tool bar images for F.
4270 Returns IMAGE if RTL is not found. */
4272 static Lisp_Object
4273 find_rtl_image (struct frame *f, Lisp_Object image, Lisp_Object rtl)
4275 int i;
4276 Lisp_Object file, rtl_name;
4277 struct gcpro gcpro1, gcpro2;
4278 GCPRO2 (file, rtl_name);
4280 rtl_name = Ffile_name_nondirectory (rtl);
4282 for (i = 0; i < f->n_tool_bar_items; ++i)
4284 Lisp_Object rtl_image = PROP (TOOL_BAR_ITEM_IMAGES);
4285 if (!NILP (file = file_for_image (rtl_image)))
4287 file = call1 (intern ("file-name-sans-extension"),
4288 Ffile_name_nondirectory (file));
4289 if (! NILP (Fequal (file, rtl_name)))
4291 image = rtl_image;
4292 break;
4297 return image;
4300 static GtkToolItem *
4301 xg_make_tool_item (struct frame *f,
4302 GtkWidget *wimage,
4303 GtkWidget **wbutton,
4304 const char *label,
4305 int i, bool horiz, bool text_image)
4307 GtkToolItem *ti = gtk_tool_item_new ();
4308 GtkWidget *vb = gtk_box_new (horiz
4309 ? GTK_ORIENTATION_HORIZONTAL
4310 : GTK_ORIENTATION_VERTICAL,
4312 GtkWidget *wb = gtk_button_new ();
4313 /* The eventbox is here so we can have tooltips on disabled items. */
4314 GtkWidget *weventbox = gtk_event_box_new ();
4315 #if GTK_CHECK_VERSION (3, 3, 6)
4316 GtkCssProvider *css_prov = gtk_css_provider_new ();
4317 GtkStyleContext *gsty;
4319 gtk_css_provider_load_from_data (css_prov,
4320 "GtkEventBox {"
4321 " background-color: transparent;"
4322 "}",
4323 -1, NULL);
4325 gsty = gtk_widget_get_style_context (weventbox);
4326 gtk_style_context_add_provider (gsty,
4327 GTK_STYLE_PROVIDER (css_prov),
4328 GTK_STYLE_PROVIDER_PRIORITY_USER);
4329 g_object_unref (css_prov);
4330 #endif
4332 gtk_box_set_homogeneous (GTK_BOX (vb), FALSE);
4334 if (wimage && !text_image)
4335 gtk_box_pack_start (GTK_BOX (vb), wimage, TRUE, TRUE, 0);
4336 if (label)
4337 gtk_box_pack_start (GTK_BOX (vb), gtk_label_new (label), TRUE, TRUE, 0);
4338 if (wimage && text_image)
4339 gtk_box_pack_start (GTK_BOX (vb), wimage, TRUE, TRUE, 0);
4341 gtk_button_set_focus_on_click (GTK_BUTTON (wb), FALSE);
4342 gtk_button_set_relief (GTK_BUTTON (wb), GTK_RELIEF_NONE);
4343 gtk_container_add (GTK_CONTAINER (wb), vb);
4344 gtk_container_add (GTK_CONTAINER (weventbox), wb);
4345 gtk_container_add (GTK_CONTAINER (ti), weventbox);
4347 if (wimage || label)
4349 intptr_t ii = i;
4350 gpointer gi = (gpointer) ii;
4352 g_signal_connect (G_OBJECT (wb), "clicked",
4353 G_CALLBACK (xg_tool_bar_callback),
4354 gi);
4356 g_object_set_data (G_OBJECT (weventbox), XG_FRAME_DATA, (gpointer)f);
4358 #ifndef HAVE_GTK3
4359 /* Catch expose events to overcome an annoying redraw bug, see
4360 comment for xg_tool_bar_item_expose_callback. */
4361 g_signal_connect (G_OBJECT (ti),
4362 "expose-event",
4363 G_CALLBACK (xg_tool_bar_item_expose_callback),
4365 #endif
4366 gtk_tool_item_set_homogeneous (ti, FALSE);
4368 /* Callback to save modifier mask (Shift/Control, etc). GTK makes
4369 no distinction based on modifiers in the activate callback,
4370 so we have to do it ourselves. */
4371 g_signal_connect (wb, "button-release-event",
4372 G_CALLBACK (xg_tool_bar_button_cb),
4373 NULL);
4375 g_object_set_data (G_OBJECT (wb), XG_FRAME_DATA, (gpointer)f);
4377 /* Use enter/leave notify to show help. We use the events
4378 rather than the GtkButton specific signals "enter" and
4379 "leave", so we can have only one callback. The event
4380 will tell us what kind of event it is. */
4381 g_signal_connect (G_OBJECT (weventbox),
4382 "enter-notify-event",
4383 G_CALLBACK (xg_tool_bar_help_callback),
4384 gi);
4385 g_signal_connect (G_OBJECT (weventbox),
4386 "leave-notify-event",
4387 G_CALLBACK (xg_tool_bar_help_callback),
4388 gi);
4391 if (wbutton) *wbutton = wb;
4393 return ti;
4396 static bool
4397 is_box_type (GtkWidget *vb, bool is_horizontal)
4399 #ifdef HAVE_GTK3
4400 bool ret = 0;
4401 if (GTK_IS_BOX (vb))
4403 GtkOrientation ori = gtk_orientable_get_orientation (GTK_ORIENTABLE (vb));
4404 ret = (ori == GTK_ORIENTATION_HORIZONTAL && is_horizontal)
4405 || (ori == GTK_ORIENTATION_VERTICAL && ! is_horizontal);
4407 return ret;
4408 #else
4409 return is_horizontal ? GTK_IS_VBOX (vb) : GTK_IS_HBOX (vb);
4410 #endif
4414 static bool
4415 xg_tool_item_stale_p (GtkWidget *wbutton, const char *stock_name,
4416 const char *icon_name, const struct image *img,
4417 const char *label, bool horiz)
4419 gpointer old;
4420 GtkWidget *wimage;
4421 GtkWidget *vb = XG_BIN_CHILD (wbutton);
4422 GtkWidget *wlbl = xg_get_tool_bar_widgets (vb, &wimage);
4424 /* Check if the tool icon matches. */
4425 if (stock_name && wimage)
4427 old = g_object_get_data (G_OBJECT (wimage),
4428 XG_TOOL_BAR_STOCK_NAME);
4429 if (!old || strcmp (old, stock_name))
4430 return 1;
4432 else if (icon_name && wimage)
4434 old = g_object_get_data (G_OBJECT (wimage),
4435 XG_TOOL_BAR_ICON_NAME);
4436 if (!old || strcmp (old, icon_name))
4437 return 1;
4439 else if (wimage)
4441 gpointer gold_img = g_object_get_data (G_OBJECT (wimage),
4442 XG_TOOL_BAR_IMAGE_DATA);
4443 Pixmap old_img = (Pixmap) gold_img;
4444 if (old_img != img->pixmap)
4445 return 1;
4448 /* Check button configuration and label. */
4449 if (is_box_type (vb, horiz)
4450 || (label ? (wlbl == NULL) : (wlbl != NULL)))
4451 return 1;
4453 /* Ensure label is correct. */
4454 if (label && wlbl)
4455 gtk_label_set_text (GTK_LABEL (wlbl), label);
4456 return 0;
4459 static bool
4460 xg_update_tool_bar_sizes (struct frame *f)
4462 struct x_output *x = f->output_data.x;
4463 GtkRequisition req;
4464 int nl = 0, nr = 0, nt = 0, nb = 0;
4465 GtkWidget *top_widget = x->toolbar_widget;
4467 gtk_widget_get_preferred_size (GTK_WIDGET (top_widget), NULL, &req);
4468 if (x->toolbar_in_hbox)
4470 int pos;
4471 gtk_container_child_get (GTK_CONTAINER (x->hbox_widget),
4472 top_widget,
4473 "position", &pos, NULL);
4474 if (pos == 0) nl = req.width;
4475 else nr = req.width;
4477 else
4479 int pos;
4480 gtk_container_child_get (GTK_CONTAINER (x->vbox_widget),
4481 top_widget,
4482 "position", &pos, NULL);
4483 if (pos == 0 || (pos == 1 && x->menubar_widget)) nt = req.height;
4484 else nb = req.height;
4487 if (nl != FRAME_TOOLBAR_LEFT_WIDTH (f)
4488 || nr != FRAME_TOOLBAR_RIGHT_WIDTH (f)
4489 || nt != FRAME_TOOLBAR_TOP_HEIGHT (f)
4490 || nb != FRAME_TOOLBAR_BOTTOM_HEIGHT (f))
4492 FRAME_TOOLBAR_RIGHT_WIDTH (f) = FRAME_TOOLBAR_LEFT_WIDTH (f)
4493 = FRAME_TOOLBAR_TOP_HEIGHT (f) = FRAME_TOOLBAR_BOTTOM_HEIGHT (f) = 0;
4494 FRAME_TOOLBAR_LEFT_WIDTH (f) = nl;
4495 FRAME_TOOLBAR_RIGHT_WIDTH (f) = nr;
4496 FRAME_TOOLBAR_TOP_HEIGHT (f) = nt;
4497 FRAME_TOOLBAR_BOTTOM_HEIGHT (f) = nb;
4498 return 1;
4501 return 0;
4504 static char *
4505 find_icon_from_name (char *name,
4506 GtkIconTheme *icon_theme,
4507 char **icon_name)
4509 #if ! GTK_CHECK_VERSION (3, 10, 0)
4510 GtkStockItem stock_item;
4511 #endif
4513 if (name[0] == 'n' && name[1] == ':')
4515 *icon_name = name + 2;
4516 name = NULL;
4518 if (! gtk_icon_theme_has_icon (icon_theme, *icon_name))
4519 *icon_name = NULL;
4522 #if ! GTK_CHECK_VERSION (3, 10, 0)
4523 else if (gtk_stock_lookup (name, &stock_item))
4524 *icon_name = NULL;
4525 #endif
4526 else if (gtk_icon_theme_has_icon (icon_theme, name))
4528 *icon_name = name;
4529 name = NULL;
4531 else
4533 name = NULL;
4534 *icon_name = NULL;
4537 return name;
4541 /* Update the tool bar for frame F. Add new buttons and remove old. */
4543 void
4544 update_frame_tool_bar (struct frame *f)
4546 int i, j;
4547 struct x_output *x = f->output_data.x;
4548 int hmargin = 0, vmargin = 0;
4549 GtkToolbar *wtoolbar;
4550 GtkToolItem *ti;
4551 GtkTextDirection dir;
4552 Lisp_Object style;
4553 bool text_image, horiz;
4554 struct xg_frame_tb_info *tbinfo;
4555 GdkScreen *screen;
4556 GtkIconTheme *icon_theme;
4559 if (! FRAME_GTK_WIDGET (f))
4560 return;
4562 block_input ();
4564 if (RANGED_INTEGERP (1, Vtool_bar_button_margin, INT_MAX))
4566 hmargin = XFASTINT (Vtool_bar_button_margin);
4567 vmargin = XFASTINT (Vtool_bar_button_margin);
4569 else if (CONSP (Vtool_bar_button_margin))
4571 if (RANGED_INTEGERP (1, XCAR (Vtool_bar_button_margin), INT_MAX))
4572 hmargin = XFASTINT (XCAR (Vtool_bar_button_margin));
4574 if (RANGED_INTEGERP (1, XCDR (Vtool_bar_button_margin), INT_MAX))
4575 vmargin = XFASTINT (XCDR (Vtool_bar_button_margin));
4578 /* The natural size (i.e. when GTK uses 0 as margin) looks best,
4579 so take DEFAULT_TOOL_BAR_BUTTON_MARGIN to mean "default for GTK",
4580 i.e. zero. This means that margins less than
4581 DEFAULT_TOOL_BAR_BUTTON_MARGIN has no effect. */
4582 hmargin = max (0, hmargin - DEFAULT_TOOL_BAR_BUTTON_MARGIN);
4583 vmargin = max (0, vmargin - DEFAULT_TOOL_BAR_BUTTON_MARGIN);
4585 if (! x->toolbar_widget)
4586 xg_create_tool_bar (f);
4588 wtoolbar = GTK_TOOLBAR (x->toolbar_widget);
4589 dir = gtk_widget_get_direction (GTK_WIDGET (wtoolbar));
4591 style = Ftool_bar_get_system_style ();
4592 screen = gtk_widget_get_screen (GTK_WIDGET (wtoolbar));
4593 icon_theme = gtk_icon_theme_get_for_screen (screen);
4595 /* Are we up to date? */
4596 tbinfo = g_object_get_data (G_OBJECT (FRAME_GTK_OUTER_WIDGET (f)),
4597 TB_INFO_KEY);
4599 if (! NILP (tbinfo->last_tool_bar) && ! NILP (f->tool_bar_items)
4600 && tbinfo->n_last_items == f->n_tool_bar_items
4601 && tbinfo->hmargin == hmargin && tbinfo->vmargin == vmargin
4602 && tbinfo->dir == dir
4603 && ! NILP (Fequal (tbinfo->style, style))
4604 && ! NILP (Fequal (tbinfo->last_tool_bar, f->tool_bar_items)))
4606 unblock_input ();
4607 return;
4610 tbinfo->last_tool_bar = f->tool_bar_items;
4611 tbinfo->n_last_items = f->n_tool_bar_items;
4612 tbinfo->style = style;
4613 tbinfo->hmargin = hmargin;
4614 tbinfo->vmargin = vmargin;
4615 tbinfo->dir = dir;
4617 text_image = EQ (style, Qtext_image_horiz);
4618 horiz = EQ (style, Qboth_horiz) || text_image;
4620 for (i = j = 0; i < f->n_tool_bar_items; ++i)
4622 bool enabled_p = !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P));
4623 bool selected_p = !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P));
4624 int idx;
4625 ptrdiff_t img_id;
4626 int icon_size = 0;
4627 struct image *img = NULL;
4628 Lisp_Object image;
4629 Lisp_Object stock = Qnil;
4630 char *stock_name = NULL;
4631 char *icon_name = NULL;
4632 Lisp_Object rtl;
4633 GtkWidget *wbutton = NULL;
4634 Lisp_Object specified_file;
4635 bool vert_only = ! NILP (PROP (TOOL_BAR_ITEM_VERT_ONLY));
4636 const char *label
4637 = (EQ (style, Qimage) || (vert_only && horiz)) ? NULL
4638 : STRINGP (PROP (TOOL_BAR_ITEM_LABEL))
4639 ? SSDATA (PROP (TOOL_BAR_ITEM_LABEL))
4640 : "";
4642 ti = gtk_toolbar_get_nth_item (GTK_TOOLBAR (wtoolbar), j);
4644 /* If this is a separator, use a gtk separator item. */
4645 if (EQ (PROP (TOOL_BAR_ITEM_TYPE), Qt))
4647 if (ti == NULL || !GTK_IS_SEPARATOR_TOOL_ITEM (ti))
4649 if (ti)
4650 gtk_container_remove (GTK_CONTAINER (wtoolbar),
4651 GTK_WIDGET (ti));
4652 ti = gtk_separator_tool_item_new ();
4653 gtk_toolbar_insert (GTK_TOOLBAR (wtoolbar), ti, j);
4655 j++;
4656 continue;
4659 /* Otherwise, the tool-bar item is an ordinary button. */
4661 if (ti && GTK_IS_SEPARATOR_TOOL_ITEM (ti))
4663 gtk_container_remove (GTK_CONTAINER (wtoolbar), GTK_WIDGET (ti));
4664 ti = NULL;
4667 if (ti) wbutton = XG_BIN_CHILD (XG_BIN_CHILD (ti));
4669 /* Ignore invalid image specifications. */
4670 image = PROP (TOOL_BAR_ITEM_IMAGES);
4671 if (!valid_image_p (image))
4673 if (ti)
4674 gtk_container_remove (GTK_CONTAINER (wtoolbar),
4675 GTK_WIDGET (ti));
4676 continue;
4679 specified_file = file_for_image (image);
4680 if (!NILP (specified_file) && !NILP (Ffboundp (Qx_gtk_map_stock)))
4681 stock = call1 (Qx_gtk_map_stock, specified_file);
4683 if (CONSP (stock))
4685 Lisp_Object tem;
4686 for (tem = stock; CONSP (tem); tem = XCDR (tem))
4687 if (! NILP (tem) && STRINGP (XCAR (tem)))
4689 stock_name = find_icon_from_name (SSDATA (XCAR (tem)),
4690 icon_theme,
4691 &icon_name);
4692 if (stock_name || icon_name) break;
4695 else if (STRINGP (stock))
4697 stock_name = find_icon_from_name (SSDATA (stock),
4698 icon_theme,
4699 &icon_name);
4702 if (stock_name || icon_name)
4703 icon_size = gtk_toolbar_get_icon_size (wtoolbar);
4705 if (stock_name == NULL && icon_name == NULL)
4707 /* No stock image, or stock item not known. Try regular
4708 image. If image is a vector, choose it according to the
4709 button state. */
4710 if (dir == GTK_TEXT_DIR_RTL
4711 && !NILP (rtl = PROP (TOOL_BAR_ITEM_RTL_IMAGE))
4712 && STRINGP (rtl))
4713 image = find_rtl_image (f, image, rtl);
4715 if (VECTORP (image))
4717 if (enabled_p)
4718 idx = (selected_p
4719 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
4720 : TOOL_BAR_IMAGE_ENABLED_DESELECTED);
4721 else
4722 idx = (selected_p
4723 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
4724 : TOOL_BAR_IMAGE_DISABLED_DESELECTED);
4726 eassert (ASIZE (image) >= idx);
4727 image = AREF (image, idx);
4729 else
4730 idx = -1;
4732 img_id = lookup_image (f, image);
4733 img = IMAGE_FROM_ID (f, img_id);
4734 prepare_image_for_display (f, img);
4736 if (img->load_failed_p || img->pixmap == None)
4738 if (ti)
4739 gtk_container_remove (GTK_CONTAINER (wtoolbar),
4740 GTK_WIDGET (ti));
4741 continue;
4745 /* If there is an existing widget, check if it's stale; if so,
4746 remove it and make a new tool item from scratch. */
4747 if (ti && xg_tool_item_stale_p (wbutton, stock_name, icon_name,
4748 img, label, horiz))
4750 gtk_container_remove (GTK_CONTAINER (wtoolbar),
4751 GTK_WIDGET (ti));
4752 ti = NULL;
4755 if (ti == NULL)
4757 GtkWidget *w;
4759 /* Save the image so we can see if an update is needed the
4760 next time we call xg_tool_item_match_p. */
4761 if (EQ (style, Qtext))
4762 w = NULL;
4763 else if (stock_name)
4766 #if GTK_CHECK_VERSION (3, 10, 0)
4767 w = gtk_image_new_from_icon_name (stock_name, icon_size);
4768 #else
4769 w = gtk_image_new_from_stock (stock_name, icon_size);
4770 #endif
4771 g_object_set_data_full (G_OBJECT (w), XG_TOOL_BAR_STOCK_NAME,
4772 (gpointer) xstrdup (stock_name),
4773 (GDestroyNotify) xfree);
4775 else if (icon_name)
4777 w = gtk_image_new_from_icon_name (icon_name, icon_size);
4778 g_object_set_data_full (G_OBJECT (w), XG_TOOL_BAR_ICON_NAME,
4779 (gpointer) xstrdup (icon_name),
4780 (GDestroyNotify) xfree);
4782 else
4784 w = xg_get_image_for_pixmap (f, img, x->widget, NULL);
4785 g_object_set_data (G_OBJECT (w), XG_TOOL_BAR_IMAGE_DATA,
4786 (gpointer)img->pixmap);
4789 #if GTK_CHECK_VERSION (3, 14, 0)
4790 if (w)
4792 gtk_widget_set_margin_start (w, hmargin);
4793 gtk_widget_set_margin_end (w, hmargin);
4794 gtk_widget_set_margin_top (w, vmargin);
4795 gtk_widget_set_margin_bottom (w, vmargin);
4797 #else
4798 if (w) gtk_misc_set_padding (GTK_MISC (w), hmargin, vmargin);
4799 #endif
4800 ti = xg_make_tool_item (f, w, &wbutton, label, i, horiz, text_image);
4801 gtk_toolbar_insert (GTK_TOOLBAR (wtoolbar), ti, j);
4804 #undef PROP
4806 gtk_widget_set_sensitive (wbutton, enabled_p);
4807 j++;
4810 /* Remove buttons not longer needed. */
4813 ti = gtk_toolbar_get_nth_item (GTK_TOOLBAR (wtoolbar), j);
4814 if (ti)
4815 gtk_container_remove (GTK_CONTAINER (wtoolbar), GTK_WIDGET (ti));
4816 } while (ti != NULL);
4818 if (f->n_tool_bar_items != 0)
4820 if (! x->toolbar_is_packed)
4821 xg_pack_tool_bar (f, FRAME_TOOL_BAR_POSITION (f));
4822 gtk_widget_show_all (x->toolbar_widget);
4823 if (xg_update_tool_bar_sizes (f))
4824 adjust_frame_size (f, -1, -1, 2, 0, Qtool_bar_lines);
4827 unblock_input ();
4830 /* Deallocate all resources for the tool bar on frame F.
4831 Remove the tool bar. */
4833 void
4834 free_frame_tool_bar (struct frame *f)
4836 struct x_output *x = f->output_data.x;
4838 if (x->toolbar_widget)
4840 struct xg_frame_tb_info *tbinfo;
4841 GtkWidget *top_widget = x->toolbar_widget;
4843 block_input ();
4844 if (x->toolbar_is_packed)
4846 if (x->toolbar_in_hbox)
4847 gtk_container_remove (GTK_CONTAINER (x->hbox_widget),
4848 top_widget);
4849 else
4850 gtk_container_remove (GTK_CONTAINER (x->vbox_widget),
4851 top_widget);
4853 else
4854 gtk_widget_destroy (x->toolbar_widget);
4856 x->toolbar_widget = 0;
4857 x->toolbar_widget = 0;
4858 x->toolbar_is_packed = false;
4859 FRAME_TOOLBAR_TOP_HEIGHT (f) = FRAME_TOOLBAR_BOTTOM_HEIGHT (f) = 0;
4860 FRAME_TOOLBAR_LEFT_WIDTH (f) = FRAME_TOOLBAR_RIGHT_WIDTH (f) = 0;
4862 tbinfo = g_object_get_data (G_OBJECT (FRAME_GTK_OUTER_WIDGET (f)),
4863 TB_INFO_KEY);
4864 if (tbinfo)
4866 xfree (tbinfo);
4867 g_object_set_data (G_OBJECT (FRAME_GTK_OUTER_WIDGET (f)),
4868 TB_INFO_KEY,
4869 NULL);
4872 adjust_frame_size (f, -1, -1, 2, 0, Qtool_bar_lines);
4874 unblock_input ();
4878 void
4879 xg_change_toolbar_position (struct frame *f, Lisp_Object pos)
4881 struct x_output *x = f->output_data.x;
4882 GtkWidget *top_widget = x->toolbar_widget;
4884 if (! x->toolbar_widget || ! top_widget)
4885 return;
4887 block_input ();
4888 g_object_ref (top_widget);
4889 if (x->toolbar_is_packed)
4891 if (x->toolbar_in_hbox)
4892 gtk_container_remove (GTK_CONTAINER (x->hbox_widget),
4893 top_widget);
4894 else
4895 gtk_container_remove (GTK_CONTAINER (x->vbox_widget),
4896 top_widget);
4899 xg_pack_tool_bar (f, pos);
4900 g_object_unref (top_widget);
4901 if (xg_update_tool_bar_sizes (f))
4902 adjust_frame_size (f, -1, -1, 2, 0, Qtool_bar_lines);
4904 unblock_input ();
4909 /***********************************************************************
4910 Initializing
4911 ***********************************************************************/
4912 void
4913 xg_initialize (void)
4915 GtkBindingSet *binding_set;
4916 GtkSettings *settings;
4918 #if HAVE_XFT
4919 /* Work around a bug with corrupted data if libXft gets unloaded. This way
4920 we keep it permanently linked in. */
4921 XftInit (0);
4922 #endif
4924 gdpy_def = NULL;
4925 xg_ignore_gtk_scrollbar = 0;
4926 xg_menu_cb_list.prev = xg_menu_cb_list.next =
4927 xg_menu_item_cb_list.prev = xg_menu_item_cb_list.next = 0;
4929 id_to_widget.max_size = id_to_widget.used = 0;
4930 id_to_widget.widgets = 0;
4932 settings = gtk_settings_get_for_screen (gdk_display_get_default_screen
4933 (gdk_display_get_default ()));
4934 /* Remove F10 as a menu accelerator, it does not mix well with Emacs key
4935 bindings. It doesn't seem to be any way to remove properties,
4936 so we set it to "" which in means "no key". */
4937 gtk_settings_set_string_property (settings,
4938 "gtk-menu-bar-accel",
4940 EMACS_CLASS);
4942 /* Make GTK text input widgets use Emacs style keybindings. This is
4943 Emacs after all. */
4944 gtk_settings_set_string_property (settings,
4945 "gtk-key-theme-name",
4946 "Emacs",
4947 EMACS_CLASS);
4949 /* Make dialogs close on C-g. Since file dialog inherits from
4950 dialog, this works for them also. */
4951 binding_set = gtk_binding_set_by_class (g_type_class_ref (GTK_TYPE_DIALOG));
4952 gtk_binding_entry_add_signal (binding_set, GDK_KEY_g, GDK_CONTROL_MASK,
4953 "close", 0);
4955 /* Make menus close on C-g. */
4956 binding_set = gtk_binding_set_by_class (g_type_class_ref
4957 (GTK_TYPE_MENU_SHELL));
4958 gtk_binding_entry_add_signal (binding_set, GDK_KEY_g, GDK_CONTROL_MASK,
4959 "cancel", 0);
4960 update_theme_scrollbar_width ();
4961 update_theme_scrollbar_height ();
4963 #ifdef HAVE_FREETYPE
4964 x_last_font_name = NULL;
4965 #endif
4968 #endif /* USE_GTK */