Quieten cc-mode compilation
[emacs.git] / src / gtkutil.c
blobb51d3388aca2b3eb3f077611e39f2529e1d757b9
1 /* Functions for creating and updating GTK widgets.
3 Copyright (C) 2003-2015 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
20 #include <config.h>
22 #ifdef USE_GTK
23 #include <float.h>
24 #include <stdio.h>
26 #include <c-ctype.h>
28 #include "lisp.h"
29 #include "xterm.h"
30 #include "blockinput.h"
31 #include "syssignal.h"
32 #include "window.h"
33 #include "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 #ifndef HAVE_GTK_WIDGET_SET_HAS_WINDOW
54 #define gtk_widget_set_has_window(w, b) \
55 (gtk_fixed_set_has_window (GTK_FIXED (w), b))
56 #endif
57 #ifndef HAVE_GTK_DIALOG_GET_ACTION_AREA
58 #define gtk_dialog_get_action_area(w) ((w)->action_area)
59 #define gtk_dialog_get_content_area(w) ((w)->vbox)
60 #endif
61 #ifndef HAVE_GTK_WIDGET_GET_SENSITIVE
62 #define gtk_widget_get_sensitive(w) (GTK_WIDGET_SENSITIVE (w))
63 #endif
64 #ifndef HAVE_GTK_ADJUSTMENT_GET_PAGE_SIZE
65 #define gtk_adjustment_set_page_size(w, s) ((w)->page_size = (s))
66 #define gtk_adjustment_set_page_increment(w, s) ((w)->page_increment = (s))
67 #define gtk_adjustment_get_step_increment(w) ((w)->step_increment)
68 #define gtk_adjustment_set_step_increment(w, s) ((w)->step_increment = (s))
69 #endif
70 #if GTK_CHECK_VERSION (2, 12, 0)
71 #define remove_submenu(w) gtk_menu_item_set_submenu ((w), NULL)
72 #else
73 #define remove_submenu(w) gtk_menu_item_remove_submenu ((w))
74 #endif
76 #if ! GTK_CHECK_VERSION (2, 14, 0)
77 #define gtk_adjustment_configure(adj, xvalue, xlower, \
78 xupper, xstep_increment, \
79 xpage_increment, xpagesize) \
80 do { \
81 adj->lower = xlower; \
82 adj->upper = xupper; \
83 adj->page_size = xpagesize; \
84 gtk_adjustment_set_value (adj, xvalue); \
85 adj->page_increment = xpage_increment; \
86 adj->step_increment = xstep_increment; \
87 } while (0)
88 #endif /* < Gtk+ 2.14 */
90 #ifdef HAVE_FREETYPE
91 #if GTK_CHECK_VERSION (3, 2, 0)
92 #define USE_NEW_GTK_FONT_CHOOSER 1
93 #else
94 #define USE_NEW_GTK_FONT_CHOOSER 0
95 #define gtk_font_chooser_dialog_new(x, y) \
96 gtk_font_selection_dialog_new (x)
97 #undef GTK_FONT_CHOOSER
98 #define GTK_FONT_CHOOSER(x) GTK_FONT_SELECTION_DIALOG (x)
99 #define gtk_font_chooser_set_font(x, y) \
100 gtk_font_selection_dialog_set_font_name (x, y)
101 #endif
102 #endif /* HAVE_FREETYPE */
104 #if GTK_CHECK_VERSION (3, 10, 0)
105 #define XG_TEXT_CANCEL "Cancel"
106 #define XG_TEXT_OK "OK"
107 #define XG_TEXT_OPEN "Open"
108 #else
109 #define XG_TEXT_CANCEL GTK_STOCK_CANCEL
110 #define XG_TEXT_OK GTK_STOCK_OK
111 #define XG_TEXT_OPEN GTK_STOCK_OPEN
112 #endif
114 #ifndef HAVE_GTK3
115 #ifdef USE_GTK_TOOLTIP
116 #define gdk_window_get_screen(w) gdk_drawable_get_screen (w)
117 #endif
118 #define gdk_window_get_geometry(w, a, b, c, d) \
119 gdk_window_get_geometry (w, a, b, c, d, 0)
120 #define gdk_x11_window_lookup_for_display(d, w) \
121 gdk_xid_table_lookup_for_display (d, w)
122 #define gtk_box_new(ori, spacing) \
123 ((ori) == GTK_ORIENTATION_HORIZONTAL \
124 ? gtk_hbox_new (FALSE, (spacing)) : gtk_vbox_new (FALSE, (spacing)))
125 #define gtk_scrollbar_new(ori, spacing) \
126 ((ori) == GTK_ORIENTATION_HORIZONTAL \
127 ? gtk_hscrollbar_new ((spacing)) : gtk_vscrollbar_new ((spacing)))
128 #ifndef GDK_KEY_g
129 #define GDK_KEY_g GDK_g
130 #endif
131 #endif /* HAVE_GTK3 */
133 #define XG_BIN_CHILD(x) gtk_bin_get_child (GTK_BIN (x))
135 static void update_theme_scrollbar_width (void);
136 static void update_theme_scrollbar_height (void);
138 #define TB_INFO_KEY "xg_frame_tb_info"
139 struct xg_frame_tb_info
141 Lisp_Object last_tool_bar;
142 Lisp_Object style;
143 int n_last_items;
144 int hmargin, vmargin;
145 GtkTextDirection dir;
149 /***********************************************************************
150 Display handling functions
151 ***********************************************************************/
153 /* Keep track of the default display, or NULL if there is none. Emacs
154 may close all its displays. */
156 static GdkDisplay *gdpy_def;
158 /* When the GTK widget W is to be created on a display for F that
159 is not the default display, set the display for W.
160 W can be a GtkMenu or a GtkWindow widget. */
162 static void
163 xg_set_screen (GtkWidget *w, struct frame *f)
165 if (FRAME_X_DISPLAY (f) != DEFAULT_GDK_DISPLAY ())
167 GdkDisplay *gdpy = gdk_x11_lookup_xdisplay (FRAME_X_DISPLAY (f));
168 GdkScreen *gscreen = gdk_display_get_default_screen (gdpy);
170 if (GTK_IS_MENU (w))
171 gtk_menu_set_screen (GTK_MENU (w), gscreen);
172 else
173 gtk_window_set_screen (GTK_WINDOW (w), gscreen);
178 /* Open a display named by DISPLAY_NAME. The display is returned in *DPY.
179 *DPY is set to NULL if the display can't be opened.
181 Returns non-zero if display could be opened, zero if display could not
182 be opened, and less than zero if the GTK version doesn't support
183 multiple displays. */
185 void
186 xg_display_open (char *display_name, Display **dpy)
188 GdkDisplay *gdpy;
190 unrequest_sigio (); // See comment in x_display_ok, xterm.c.
191 gdpy = gdk_display_open (display_name);
192 request_sigio ();
193 if (!gdpy_def && gdpy)
195 gdpy_def = gdpy;
196 gdk_display_manager_set_default_display (gdk_display_manager_get (),
197 gdpy);
200 *dpy = gdpy ? GDK_DISPLAY_XDISPLAY (gdpy) : NULL;
204 /* Close display DPY. */
206 void
207 xg_display_close (Display *dpy)
209 GdkDisplay *gdpy = gdk_x11_lookup_xdisplay (dpy);
211 /* If this is the default display, try to change it before closing.
212 If there is no other display to use, gdpy_def is set to NULL, and
213 the next call to xg_display_open resets the default display. */
214 if (gdk_display_get_default () == gdpy)
216 struct x_display_info *dpyinfo;
217 GdkDisplay *gdpy_new = NULL;
219 /* Find another display. */
220 for (dpyinfo = x_display_list; dpyinfo; dpyinfo = dpyinfo->next)
221 if (dpyinfo->display != dpy)
223 gdpy_new = gdk_x11_lookup_xdisplay (dpyinfo->display);
224 gdk_display_manager_set_default_display (gdk_display_manager_get (),
225 gdpy_new);
226 break;
228 gdpy_def = gdpy_new;
231 #if GTK_CHECK_VERSION (2, 0, 0) && ! GTK_CHECK_VERSION (2, 10, 0)
232 /* GTK 2.2-2.8 has a bug that makes gdk_display_close crash (bug
233 http://bugzilla.gnome.org/show_bug.cgi?id=85715). This way we
234 can continue running, but there will be memory leaks. */
235 g_object_run_dispose (G_OBJECT (gdpy));
236 #else
237 /* This seems to be fixed in GTK 2.10. */
238 gdk_display_close (gdpy);
239 #endif
243 /***********************************************************************
244 Utility functions
245 ***********************************************************************/
247 /* Create and return the cursor to be used for popup menus and
248 scroll bars on display DPY. */
250 GdkCursor *
251 xg_create_default_cursor (Display *dpy)
253 GdkDisplay *gdpy = gdk_x11_lookup_xdisplay (dpy);
254 return gdk_cursor_new_for_display (gdpy, GDK_LEFT_PTR);
257 static GdkPixbuf *
258 xg_get_pixbuf_from_pixmap (struct frame *f, Pixmap pix)
260 int iunused;
261 GdkPixbuf *tmp_buf;
262 Window wunused;
263 unsigned int width, height, uunused;
264 XImage *xim;
266 XGetGeometry (FRAME_X_DISPLAY (f), pix, &wunused, &iunused, &iunused,
267 &width, &height, &uunused, &uunused);
269 xim = XGetImage (FRAME_X_DISPLAY (f), pix, 0, 0, width, height,
270 ~0, XYPixmap);
271 if (!xim) return 0;
273 tmp_buf = gdk_pixbuf_new_from_data ((guchar *) xim->data,
274 GDK_COLORSPACE_RGB,
275 FALSE,
276 xim->bitmap_unit,
277 width,
278 height,
279 xim->bytes_per_line,
280 NULL,
281 NULL);
282 XDestroyImage (xim);
283 return tmp_buf;
286 /* Apply GMASK to GPIX and return a GdkPixbuf with an alpha channel. */
288 static GdkPixbuf *
289 xg_get_pixbuf_from_pix_and_mask (struct frame *f,
290 Pixmap pix,
291 Pixmap mask)
293 int width, height;
294 GdkPixbuf *icon_buf, *tmp_buf;
296 tmp_buf = xg_get_pixbuf_from_pixmap (f, pix);
297 icon_buf = gdk_pixbuf_add_alpha (tmp_buf, FALSE, 0, 0, 0);
298 g_object_unref (G_OBJECT (tmp_buf));
300 width = gdk_pixbuf_get_width (icon_buf);
301 height = gdk_pixbuf_get_height (icon_buf);
303 if (mask)
305 GdkPixbuf *mask_buf = xg_get_pixbuf_from_pixmap (f, mask);
306 guchar *pixels = gdk_pixbuf_get_pixels (icon_buf);
307 guchar *mask_pixels = gdk_pixbuf_get_pixels (mask_buf);
308 int rowstride = gdk_pixbuf_get_rowstride (icon_buf);
309 int mask_rowstride = gdk_pixbuf_get_rowstride (mask_buf);
310 int y;
312 for (y = 0; y < height; ++y)
314 guchar *iconptr, *maskptr;
315 int x;
317 iconptr = pixels + y * rowstride;
318 maskptr = mask_pixels + y * mask_rowstride;
320 for (x = 0; x < width; ++x)
322 /* In a bitmap, RGB is either 255/255/255 or 0/0/0. Checking
323 just R is sufficient. */
324 if (maskptr[0] == 0)
325 iconptr[3] = 0; /* 0, 1, 2 is R, G, B. 3 is alpha. */
327 iconptr += rowstride/width;
328 maskptr += mask_rowstride/width;
332 g_object_unref (G_OBJECT (mask_buf));
335 return icon_buf;
338 static Lisp_Object
339 file_for_image (Lisp_Object image)
341 Lisp_Object specified_file = Qnil;
342 Lisp_Object tail;
344 for (tail = XCDR (image);
345 NILP (specified_file) && CONSP (tail) && CONSP (XCDR (tail));
346 tail = XCDR (XCDR (tail)))
347 if (EQ (XCAR (tail), QCfile))
348 specified_file = XCAR (XCDR (tail));
350 return specified_file;
353 /* For the image defined in IMG, make and return a GtkImage. For displays with
354 8 planes or less we must make a GdkPixbuf and apply the mask manually.
355 Otherwise the highlighting and dimming the tool bar code in GTK does
356 will look bad. For display with more than 8 planes we just use the
357 pixmap and mask directly. For monochrome displays, GTK doesn't seem
358 able to use external pixmaps, it looks bad whatever we do.
359 The image is defined on the display where frame F is.
360 WIDGET is used to find the GdkColormap to use for the GdkPixbuf.
361 If OLD_WIDGET is NULL, a new widget is constructed and returned.
362 If OLD_WIDGET is not NULL, that widget is modified. */
364 static GtkWidget *
365 xg_get_image_for_pixmap (struct frame *f,
366 struct image *img,
367 GtkWidget *widget,
368 GtkImage *old_widget)
370 GdkPixbuf *icon_buf;
372 /* If we have a file, let GTK do all the image handling.
373 This seems to be the only way to make insensitive and activated icons
374 look good in all cases. */
375 Lisp_Object specified_file = file_for_image (img->spec);
376 Lisp_Object file;
378 /* We already loaded the image once before calling this
379 function, so this only fails if the image file has been removed.
380 In that case, use the pixmap already loaded. */
382 if (STRINGP (specified_file)
383 && STRINGP (file = x_find_image_file (specified_file)))
385 if (! old_widget)
386 old_widget = GTK_IMAGE (gtk_image_new_from_file (SSDATA (file)));
387 else
388 gtk_image_set_from_file (old_widget, SSDATA (file));
390 return GTK_WIDGET (old_widget);
393 /* No file, do the image handling ourselves. This will look very bad
394 on a monochrome display, and sometimes bad on all displays with
395 certain themes. */
397 /* This is a workaround to make icons look good on pseudo color
398 displays. Apparently GTK expects the images to have an alpha
399 channel. If they don't, insensitive and activated icons will
400 look bad. This workaround does not work on monochrome displays,
401 and is strictly not needed on true color/static color displays (i.e.
402 16 bits and higher). But we do it anyway so we get a pixbuf that is
403 not associated with the img->pixmap. The img->pixmap may be removed
404 by clearing the image cache and then the tool bar redraw fails, since
405 Gtk+ assumes the pixmap is always there. */
406 icon_buf = xg_get_pixbuf_from_pix_and_mask (f, img->pixmap, img->mask);
408 if (icon_buf)
410 if (! old_widget)
411 old_widget = GTK_IMAGE (gtk_image_new_from_pixbuf (icon_buf));
412 else
413 gtk_image_set_from_pixbuf (old_widget, icon_buf);
415 g_object_unref (G_OBJECT (icon_buf));
418 return GTK_WIDGET (old_widget);
422 /* Set CURSOR on W and all widgets W contain. We must do like this
423 for scroll bars and menu because they create widgets internally,
424 and it is those widgets that are visible. */
426 static void
427 xg_set_cursor (GtkWidget *w, GdkCursor *cursor)
429 GdkWindow *window = gtk_widget_get_window (w);
430 GList *children = gdk_window_peek_children (window);
432 gdk_window_set_cursor (window, cursor);
434 /* The scroll bar widget has more than one GDK window (had to look at
435 the source to figure this out), and there is no way to set cursor
436 on widgets in GTK. So we must set the cursor for all GDK windows.
437 Ditto for menus. */
439 for ( ; children; children = g_list_next (children))
440 gdk_window_set_cursor (GDK_WINDOW (children->data), cursor);
443 /* Insert NODE into linked LIST. */
445 static void
446 xg_list_insert (xg_list_node *list, xg_list_node *node)
448 xg_list_node *list_start = list->next;
450 if (list_start) list_start->prev = node;
451 node->next = list_start;
452 node->prev = 0;
453 list->next = node;
456 /* Remove NODE from linked LIST. */
458 static void
459 xg_list_remove (xg_list_node *list, xg_list_node *node)
461 xg_list_node *list_start = list->next;
462 if (node == list_start)
464 list->next = node->next;
465 if (list->next) list->next->prev = 0;
467 else
469 node->prev->next = node->next;
470 if (node->next) node->next->prev = node->prev;
474 /* Allocate and return a utf8 version of STR. If STR is already
475 utf8 or NULL, just return a copy of STR.
476 A new string is allocated and the caller must free the result
477 with g_free. */
479 static char *
480 get_utf8_string (const char *str)
482 char *utf8_str;
484 if (!str) return NULL;
486 /* If not UTF-8, try current locale. */
487 if (!g_utf8_validate (str, -1, NULL))
488 utf8_str = g_locale_to_utf8 (str, -1, 0, 0, 0);
489 else
490 return g_strdup (str);
492 if (!utf8_str)
494 /* Probably some control characters in str. Escape them. */
495 ptrdiff_t len;
496 ptrdiff_t nr_bad = 0;
497 gsize bytes_read;
498 gsize bytes_written;
499 unsigned char *p = (unsigned char *)str;
500 char *cp, *up;
501 GError *err = NULL;
503 while (! (cp = g_locale_to_utf8 ((char *)p, -1, &bytes_read,
504 &bytes_written, &err))
505 && err->code == G_CONVERT_ERROR_ILLEGAL_SEQUENCE)
507 ++nr_bad;
508 p += bytes_written+1;
509 g_error_free (err);
510 err = NULL;
513 if (err)
515 g_error_free (err);
516 err = NULL;
518 if (cp) g_free (cp);
520 len = strlen (str);
521 if ((min (PTRDIFF_MAX, SIZE_MAX) - len - 1) / 4 < nr_bad)
522 memory_full (SIZE_MAX);
523 up = utf8_str = xmalloc (len + nr_bad * 4 + 1);
524 p = (unsigned char *)str;
526 while (! (cp = g_locale_to_utf8 ((char *)p, -1, &bytes_read,
527 &bytes_written, &err))
528 && err->code == G_CONVERT_ERROR_ILLEGAL_SEQUENCE)
530 memcpy (up, p, bytes_written);
531 up += bytes_written;
532 up += sprintf (up, "\\%03o", p[bytes_written]);
533 p += bytes_written + 1;
534 g_error_free (err);
535 err = NULL;
538 if (cp)
540 strcpy (up, cp);
541 g_free (cp);
543 if (err)
545 g_error_free (err);
546 err = NULL;
549 return utf8_str;
552 /* Check for special colors used in face spec for region face.
553 The colors are fetched from the Gtk+ theme.
554 Return true if color was found, false if not. */
556 bool
557 xg_check_special_colors (struct frame *f,
558 const char *color_name,
559 XColor *color)
561 bool success_p = 0;
562 bool get_bg = strcmp ("gtk_selection_bg_color", color_name) == 0;
563 bool get_fg = !get_bg && strcmp ("gtk_selection_fg_color", color_name) == 0;
565 if (! FRAME_GTK_WIDGET (f) || ! (get_bg || get_fg))
566 return success_p;
568 block_input ();
570 #ifdef HAVE_GTK3
571 GtkStyleContext *gsty
572 = gtk_widget_get_style_context (FRAME_GTK_OUTER_WIDGET (f));
573 GdkRGBA col;
574 char buf[sizeof "rgb://rrrr/gggg/bbbb"];
575 int state = GTK_STATE_FLAG_SELECTED|GTK_STATE_FLAG_FOCUSED;
576 if (get_fg)
577 gtk_style_context_get_color (gsty, state, &col);
578 else
579 gtk_style_context_get_background_color (gsty, state, &col);
581 sprintf (buf, "rgb:%04x/%04x/%04x",
582 (unsigned) (col.red * 65535),
583 (unsigned) (col.green * 65535),
584 (unsigned) (col.blue * 65535));
585 success_p = (XParseColor (FRAME_X_DISPLAY (f), FRAME_X_COLORMAP (f),
586 buf, color)
587 != 0);
588 #else
589 GtkStyle *gsty = gtk_widget_get_style (FRAME_GTK_WIDGET (f));
590 GdkColor *grgb = get_bg
591 ? &gsty->bg[GTK_STATE_SELECTED]
592 : &gsty->fg[GTK_STATE_SELECTED];
594 color->red = grgb->red;
595 color->green = grgb->green;
596 color->blue = grgb->blue;
597 color->pixel = grgb->pixel;
598 success_p = 1;
599 #endif
602 unblock_input ();
603 return success_p;
608 /***********************************************************************
609 Tooltips
610 ***********************************************************************/
611 /* Gtk+ calls this callback when the parent of our tooltip dummy changes.
612 We use that to pop down the tooltip. This happens if Gtk+ for some
613 reason wants to change or hide the tooltip. */
615 #ifdef USE_GTK_TOOLTIP
617 static void
618 hierarchy_ch_cb (GtkWidget *widget,
619 GtkWidget *previous_toplevel,
620 gpointer user_data)
622 struct frame *f = user_data;
623 struct x_output *x = f->output_data.x;
624 GtkWidget *top = gtk_widget_get_toplevel (x->ttip_lbl);
626 if (! top || ! GTK_IS_WINDOW (top))
627 gtk_widget_hide (previous_toplevel);
630 /* Callback called when Gtk+ thinks a tooltip should be displayed.
631 We use it to get the tooltip window and the tooltip widget so
632 we can manipulate the ourselves.
634 Return FALSE ensures that the tooltip is not shown. */
636 static gboolean
637 qttip_cb (GtkWidget *widget,
638 gint xpos,
639 gint ypos,
640 gboolean keyboard_mode,
641 GtkTooltip *tooltip,
642 gpointer user_data)
644 struct frame *f = user_data;
645 struct x_output *x = f->output_data.x;
646 if (x->ttip_widget == NULL)
648 GtkWidget *p;
649 GList *list, *iter;
651 g_object_set (G_OBJECT (widget), "has-tooltip", FALSE, NULL);
652 x->ttip_widget = tooltip;
653 g_object_ref (G_OBJECT (tooltip));
654 x->ttip_lbl = gtk_label_new ("");
655 g_object_ref (G_OBJECT (x->ttip_lbl));
656 gtk_tooltip_set_custom (tooltip, x->ttip_lbl);
657 x->ttip_window = GTK_WINDOW (gtk_widget_get_toplevel (x->ttip_lbl));
659 /* Change stupid Gtk+ default line wrapping. */
660 p = gtk_widget_get_parent (x->ttip_lbl);
661 list = gtk_container_get_children (GTK_CONTAINER (p));
662 for (iter = list; iter; iter = g_list_next (iter))
664 GtkWidget *w = GTK_WIDGET (iter->data);
665 if (GTK_IS_LABEL (w))
666 gtk_label_set_line_wrap (GTK_LABEL (w), FALSE);
668 g_list_free (list);
670 /* ATK needs an empty title for some reason. */
671 gtk_window_set_title (x->ttip_window, "");
672 /* Realize so we can safely get screen later on. */
673 gtk_widget_realize (GTK_WIDGET (x->ttip_window));
674 gtk_widget_realize (x->ttip_lbl);
676 g_signal_connect (x->ttip_lbl, "hierarchy-changed",
677 G_CALLBACK (hierarchy_ch_cb), f);
679 return FALSE;
682 #endif /* USE_GTK_TOOLTIP */
684 /* Prepare a tooltip to be shown, i.e. calculate WIDTH and HEIGHT.
685 Return true if a system tooltip is available. */
687 bool
688 xg_prepare_tooltip (struct frame *f,
689 Lisp_Object string,
690 int *width,
691 int *height)
693 #ifndef USE_GTK_TOOLTIP
694 return 0;
695 #else
696 struct x_output *x = f->output_data.x;
697 GtkWidget *widget;
698 GdkWindow *gwin;
699 GdkScreen *screen;
700 GtkSettings *settings;
701 gboolean tt_enabled = TRUE;
702 GtkRequisition req;
703 Lisp_Object encoded_string;
705 if (!x->ttip_lbl) return 0;
707 block_input ();
708 encoded_string = ENCODE_UTF_8 (string);
709 widget = GTK_WIDGET (x->ttip_lbl);
710 gwin = gtk_widget_get_window (GTK_WIDGET (x->ttip_window));
711 screen = gdk_window_get_screen (gwin);
712 settings = gtk_settings_get_for_screen (screen);
713 g_object_get (settings, "gtk-enable-tooltips", &tt_enabled, NULL);
714 if (tt_enabled)
716 g_object_set (settings, "gtk-enable-tooltips", FALSE, NULL);
717 /* Record that we disabled it so it can be enabled again. */
718 g_object_set_data (G_OBJECT (x->ttip_window), "restore-tt",
719 (gpointer)f);
722 /* Prevent Gtk+ from hiding tooltip on mouse move and such. */
723 g_object_set_data (G_OBJECT
724 (gtk_widget_get_display (GTK_WIDGET (x->ttip_window))),
725 "gdk-display-current-tooltip", NULL);
727 /* Put our dummy widget in so we can get callbacks for unrealize and
728 hierarchy-changed. */
729 gtk_tooltip_set_custom (x->ttip_widget, widget);
730 gtk_tooltip_set_text (x->ttip_widget, SSDATA (encoded_string));
731 gtk_widget_get_preferred_size (GTK_WIDGET (x->ttip_window), NULL, &req);
732 if (width) *width = req.width;
733 if (height) *height = req.height;
735 unblock_input ();
737 return 1;
738 #endif /* USE_GTK_TOOLTIP */
741 /* Show the tooltip at ROOT_X and ROOT_Y.
742 xg_prepare_tooltip must have been called before this function. */
744 void
745 xg_show_tooltip (struct frame *f, int root_x, int root_y)
747 #ifdef USE_GTK_TOOLTIP
748 struct x_output *x = f->output_data.x;
749 if (x->ttip_window)
751 block_input ();
752 gtk_window_move (x->ttip_window, root_x, root_y);
753 gtk_widget_show_all (GTK_WIDGET (x->ttip_window));
754 unblock_input ();
756 #endif
759 /* Hide tooltip if shown. Do nothing if not shown.
760 Return true if tip was hidden, false if not (i.e. not using
761 system tooltips). */
763 bool
764 xg_hide_tooltip (struct frame *f)
766 bool ret = 0;
767 #ifdef USE_GTK_TOOLTIP
768 if (f->output_data.x->ttip_window)
770 GtkWindow *win = f->output_data.x->ttip_window;
771 block_input ();
772 gtk_widget_hide (GTK_WIDGET (win));
774 if (g_object_get_data (G_OBJECT (win), "restore-tt"))
776 GdkWindow *gwin = gtk_widget_get_window (GTK_WIDGET (win));
777 GdkScreen *screen = gdk_window_get_screen (gwin);
778 GtkSettings *settings = gtk_settings_get_for_screen (screen);
779 g_object_set (settings, "gtk-enable-tooltips", TRUE, NULL);
781 unblock_input ();
783 ret = 1;
785 #endif
786 return ret;
790 /***********************************************************************
791 General functions for creating widgets, resizing, events, e.t.c.
792 ***********************************************************************/
794 static void
795 my_log_handler (const gchar *log_domain, GLogLevelFlags log_level,
796 const gchar *msg, gpointer user_data)
798 if (!strstr (msg, "visible children"))
799 fprintf (stderr, "XX %s-WARNING **: %s\n", log_domain, msg);
802 /* Make a geometry string and pass that to GTK. It seems this is the
803 only way to get geometry position right if the user explicitly
804 asked for a position when starting Emacs.
805 F is the frame we shall set geometry for. */
807 static void
808 xg_set_geometry (struct frame *f)
810 if (f->size_hint_flags & (USPosition | PPosition))
812 int left = f->left_pos;
813 int xneg = f->size_hint_flags & XNegative;
814 int top = f->top_pos;
815 int yneg = f->size_hint_flags & YNegative;
816 char geom_str[sizeof "=x--" + 4 * INT_STRLEN_BOUND (int)];
817 guint id;
819 if (xneg)
820 left = -left;
821 if (yneg)
822 top = -top;
824 sprintf (geom_str, "=%dx%d%c%d%c%d",
825 FRAME_PIXEL_WIDTH (f),
826 FRAME_PIXEL_HEIGHT (f),
827 (xneg ? '-' : '+'), left,
828 (yneg ? '-' : '+'), top);
830 /* Silence warning about visible children. */
831 id = g_log_set_handler ("Gtk", G_LOG_LEVEL_WARNING | G_LOG_FLAG_FATAL
832 | G_LOG_FLAG_RECURSION, my_log_handler, NULL);
834 if (!gtk_window_parse_geometry (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)),
835 geom_str))
836 fprintf (stderr, "Failed to parse: '%s'\n", geom_str);
838 g_log_remove_handler ("Gtk", id);
842 /* Clear under internal border if any. As we use a mix of Gtk+ and X calls
843 and use a GtkFixed widget, this doesn't happen automatically. */
845 void
846 xg_clear_under_internal_border (struct frame *f)
848 if (FRAME_INTERNAL_BORDER_WIDTH (f) > 0)
850 GtkWidget *wfixed = f->output_data.x->edit_widget;
852 gtk_widget_queue_draw (wfixed);
853 gdk_window_process_all_updates ();
855 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), 0, 0,
856 FRAME_PIXEL_WIDTH (f), FRAME_INTERNAL_BORDER_WIDTH (f));
858 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), 0, 0,
859 FRAME_INTERNAL_BORDER_WIDTH (f), FRAME_PIXEL_HEIGHT (f));
861 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), 0,
862 FRAME_PIXEL_HEIGHT (f) - FRAME_INTERNAL_BORDER_WIDTH (f),
863 FRAME_PIXEL_WIDTH (f), FRAME_INTERNAL_BORDER_WIDTH (f));
865 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
866 FRAME_PIXEL_WIDTH (f) - FRAME_INTERNAL_BORDER_WIDTH (f),
867 0, FRAME_INTERNAL_BORDER_WIDTH (f), FRAME_PIXEL_HEIGHT (f));
871 /* Function to handle resize of our frame. As we have a Gtk+ tool bar
872 and a Gtk+ menu bar, we get resize events for the edit part of the
873 frame only. We let Gtk+ deal with the Gtk+ parts.
874 F is the frame to resize.
875 PIXELWIDTH, PIXELHEIGHT is the new size in pixels. */
877 void
878 xg_frame_resized (struct frame *f, int pixelwidth, int pixelheight)
880 int width, height;
882 if (pixelwidth == -1 && pixelheight == -1)
884 if (FRAME_GTK_WIDGET (f) && gtk_widget_get_mapped (FRAME_GTK_WIDGET (f)))
885 gdk_window_get_geometry (gtk_widget_get_window (FRAME_GTK_WIDGET (f)),
886 0, 0, &pixelwidth, &pixelheight);
887 else
888 return;
891 width = FRAME_PIXEL_TO_TEXT_WIDTH (f, pixelwidth);
892 height = FRAME_PIXEL_TO_TEXT_HEIGHT (f, pixelheight);
894 frame_size_history_add
895 (f, Qxg_frame_resized, width, height, Qnil);
897 if (width != FRAME_TEXT_WIDTH (f)
898 || height != FRAME_TEXT_HEIGHT (f)
899 || pixelwidth != FRAME_PIXEL_WIDTH (f)
900 || pixelheight != FRAME_PIXEL_HEIGHT (f))
902 xg_clear_under_internal_border (f);
903 change_frame_size (f, width, height, 0, 1, 0, 1);
904 SET_FRAME_GARBAGED (f);
905 cancel_mouse_face (f);
907 do_pending_window_change (0);
911 /* Resize the outer window of frame F after changing the height.
912 COLUMNS/ROWS is the size the edit area shall have after the resize. */
914 void
915 xg_frame_set_char_size (struct frame *f, int width, int height)
917 int pixelwidth = FRAME_TEXT_TO_PIXEL_WIDTH (f, width);
918 int pixelheight = FRAME_TEXT_TO_PIXEL_HEIGHT (f, height);
919 Lisp_Object fullscreen = get_frame_param (f, Qfullscreen);
920 gint gwidth, gheight;
922 if (FRAME_PIXEL_HEIGHT (f) == 0)
923 return;
925 gtk_window_get_size (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)),
926 &gwidth, &gheight);
928 /* Do this before resize, as we don't know yet if we will be resized. */
929 xg_clear_under_internal_border (f);
931 /* Resize the top level widget so rows and columns remain constant.
933 When the frame is fullheight and we only want to change the width
934 or it is fullwidth and we only want to change the height we should
935 be able to preserve the fullscreen property. However, due to the
936 fact that we have to send a resize request anyway, the window
937 manager will abolish it. At least the respective size should
938 remain unchanged but giving the frame back its normal size will
939 be broken ... */
940 if (EQ (fullscreen, Qfullwidth) && width == FRAME_TEXT_WIDTH (f))
942 frame_size_history_add
943 (f, Qxg_frame_set_char_size_1, width, height,
944 list2 (make_number (gheight),
945 make_number (pixelheight + FRAME_TOOLBAR_HEIGHT (f)
946 + FRAME_MENUBAR_HEIGHT (f))));
948 gtk_window_resize (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)),
949 gwidth,
950 pixelheight + FRAME_TOOLBAR_HEIGHT (f)
951 + FRAME_MENUBAR_HEIGHT (f));
953 else if (EQ (fullscreen, Qfullheight) && height == FRAME_TEXT_HEIGHT (f))
955 frame_size_history_add
956 (f, Qxg_frame_set_char_size_2, width, height,
957 list2 (make_number (gwidth),
958 make_number (pixelwidth + FRAME_TOOLBAR_WIDTH (f))));
960 gtk_window_resize (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)),
961 pixelwidth + FRAME_TOOLBAR_WIDTH (f),
962 gheight);
965 else
967 frame_size_history_add
968 (f, Qxg_frame_set_char_size_3, width, height,
969 list2 (make_number (pixelwidth + FRAME_TOOLBAR_WIDTH (f)),
970 make_number (pixelheight + FRAME_TOOLBAR_HEIGHT (f)
971 + FRAME_MENUBAR_HEIGHT (f))));
973 gtk_window_resize (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)),
974 pixelwidth + FRAME_TOOLBAR_WIDTH (f),
975 pixelheight + FRAME_TOOLBAR_HEIGHT (f)
976 + FRAME_MENUBAR_HEIGHT (f));
977 fullscreen = Qnil;
980 SET_FRAME_GARBAGED (f);
981 cancel_mouse_face (f);
983 x_wm_set_size_hint (f, 0, 0);
984 /* We can not call change_frame_size for a mapped frame,
985 we can not set pixel width/height either. The window manager may
986 override our resize request, XMonad does this all the time.
987 The best we can do is try to sync, so lisp code sees the updated
988 size as fast as possible.
989 For unmapped windows, we can set rows/cols. When
990 the frame is mapped again we will (hopefully) get the correct size. */
991 if (FRAME_VISIBLE_P (f))
993 /* Must call this to flush out events */
994 (void)gtk_events_pending ();
995 gdk_flush ();
996 x_wait_for_event (f, ConfigureNotify);
998 if (!NILP (fullscreen))
999 /* Try to restore fullscreen state. */
1001 store_frame_param (f, Qfullscreen, fullscreen);
1002 x_set_fullscreen (f, fullscreen, fullscreen);
1005 else
1006 adjust_frame_size (f, width, height, 5, 0, Qxg_frame_set_char_size);
1010 /* Handle height/width changes (i.e. add/remove/move menu/toolbar).
1011 The policy is to keep the number of editable lines. */
1013 #if 0
1014 static void
1015 xg_height_or_width_changed (struct frame *f)
1017 gtk_window_resize (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)),
1018 FRAME_TOTAL_PIXEL_WIDTH (f),
1019 FRAME_TOTAL_PIXEL_HEIGHT (f));
1020 f->output_data.x->hint_flags = 0;
1021 x_wm_set_size_hint (f, 0, 0);
1023 #endif
1025 /* Convert an X Window WSESC on display DPY to its corresponding GtkWidget.
1026 Must be done like this, because GtkWidget:s can have "hidden"
1027 X Window that aren't accessible.
1029 Return 0 if no widget match WDESC. */
1031 GtkWidget *
1032 xg_win_to_widget (Display *dpy, Window wdesc)
1034 gpointer gdkwin;
1035 GtkWidget *gwdesc = 0;
1037 block_input ();
1039 gdkwin = gdk_x11_window_lookup_for_display (gdk_x11_lookup_xdisplay (dpy),
1040 wdesc);
1041 if (gdkwin)
1043 GdkEvent event;
1044 event.any.window = gdkwin;
1045 event.any.type = GDK_NOTHING;
1046 gwdesc = gtk_get_event_widget (&event);
1049 unblock_input ();
1050 return gwdesc;
1053 /* Set the background of widget W to PIXEL. */
1055 static void
1056 xg_set_widget_bg (struct frame *f, GtkWidget *w, unsigned long pixel)
1058 #ifdef HAVE_GTK3
1059 GdkRGBA bg;
1060 XColor xbg;
1061 xbg.pixel = pixel;
1062 if (XQueryColor (FRAME_X_DISPLAY (f), FRAME_X_COLORMAP (f), &xbg))
1064 bg.red = (double)xbg.red/65535.0;
1065 bg.green = (double)xbg.green/65535.0;
1066 bg.blue = (double)xbg.blue/65535.0;
1067 bg.alpha = 1.0;
1068 gtk_widget_override_background_color (w, GTK_STATE_FLAG_NORMAL, &bg);
1070 #else
1071 GdkColor bg;
1072 GdkColormap *map = gtk_widget_get_colormap (w);
1073 gdk_colormap_query_color (map, pixel, &bg);
1074 gtk_widget_modify_bg (FRAME_GTK_WIDGET (f), GTK_STATE_NORMAL, &bg);
1075 #endif
1078 /* Callback called when the gtk theme changes.
1079 We notify lisp code so it can fix faces used for region for example. */
1081 static void
1082 style_changed_cb (GObject *go,
1083 GParamSpec *spec,
1084 gpointer user_data)
1086 struct input_event event;
1087 GdkDisplay *gdpy = user_data;
1088 const char *display_name = gdk_display_get_name (gdpy);
1089 Display *dpy = GDK_DISPLAY_XDISPLAY (gdpy);
1091 EVENT_INIT (event);
1092 event.kind = CONFIG_CHANGED_EVENT;
1093 event.frame_or_window = build_string (display_name);
1094 /* Theme doesn't change often, so intern is called seldom. */
1095 event.arg = intern ("theme-name");
1096 kbd_buffer_store_event (&event);
1098 update_theme_scrollbar_width ();
1099 update_theme_scrollbar_height ();
1101 /* If scroll bar width changed, we need set the new size on all frames
1102 on this display. */
1103 if (dpy)
1105 Lisp_Object rest, frame;
1106 FOR_EACH_FRAME (rest, frame)
1108 struct frame *f = XFRAME (frame);
1109 if (FRAME_LIVE_P (f)
1110 && FRAME_X_P (f)
1111 && FRAME_X_DISPLAY (f) == dpy)
1113 x_set_scroll_bar_default_width (f);
1114 x_set_scroll_bar_default_height (f);
1115 xg_frame_set_char_size (f, FRAME_TEXT_WIDTH (f), FRAME_TEXT_HEIGHT (f));
1121 /* Called when a delete-event occurs on WIDGET. */
1123 static gboolean
1124 delete_cb (GtkWidget *widget,
1125 GdkEvent *event,
1126 gpointer user_data)
1128 #ifdef HAVE_GTK3
1129 /* The event doesn't arrive in the normal event loop. Send event
1130 here. */
1131 struct frame *f = user_data;
1132 struct input_event ie;
1134 EVENT_INIT (ie);
1135 ie.kind = DELETE_WINDOW_EVENT;
1136 XSETFRAME (ie.frame_or_window, f);
1137 kbd_buffer_store_event (&ie);
1138 #endif
1140 return TRUE;
1143 /* Create and set up the GTK widgets for frame F.
1144 Return true if creation succeeded. */
1146 bool
1147 xg_create_frame_widgets (struct frame *f)
1149 GtkWidget *wtop;
1150 GtkWidget *wvbox, *whbox;
1151 GtkWidget *wfixed;
1152 #ifndef HAVE_GTK3
1153 GtkRcStyle *style;
1154 #endif
1155 char *title = 0;
1157 block_input ();
1159 if (FRAME_X_EMBEDDED_P (f))
1161 GdkDisplay *gdpy = gdk_x11_lookup_xdisplay (FRAME_X_DISPLAY (f));
1162 wtop = gtk_plug_new_for_display (gdpy, f->output_data.x->parent_desc);
1164 else
1165 wtop = gtk_window_new (GTK_WINDOW_TOPLEVEL);
1167 /* gtk_window_set_has_resize_grip is a Gtk+ 3.0 function but Ubuntu
1168 has backported it to Gtk+ 2.0 and they add the resize grip for
1169 Gtk+ 2.0 applications also. But it has a bug that makes Emacs loop
1170 forever, so disable the grip. */
1171 #if (! GTK_CHECK_VERSION (3, 0, 0) \
1172 && defined HAVE_GTK_WINDOW_SET_HAS_RESIZE_GRIP)
1173 gtk_window_set_has_resize_grip (GTK_WINDOW (wtop), FALSE);
1174 #endif
1176 xg_set_screen (wtop, f);
1178 wvbox = gtk_box_new (GTK_ORIENTATION_VERTICAL, 0);
1179 whbox = gtk_box_new (GTK_ORIENTATION_HORIZONTAL, 0);
1180 gtk_box_set_homogeneous (GTK_BOX (wvbox), FALSE);
1181 gtk_box_set_homogeneous (GTK_BOX (whbox), FALSE);
1183 #ifdef HAVE_GTK3
1184 wfixed = emacs_fixed_new (f);
1185 #else
1186 wfixed = gtk_fixed_new ();
1187 #endif
1189 if (! wtop || ! wvbox || ! whbox || ! wfixed)
1191 if (wtop) gtk_widget_destroy (wtop);
1192 if (wvbox) gtk_widget_destroy (wvbox);
1193 if (whbox) gtk_widget_destroy (whbox);
1194 if (wfixed) gtk_widget_destroy (wfixed);
1196 unblock_input ();
1197 return 0;
1200 /* Use same names as the Xt port does. I.e. Emacs.pane.emacs by default */
1201 gtk_widget_set_name (wtop, EMACS_CLASS);
1202 gtk_widget_set_name (wvbox, "pane");
1203 gtk_widget_set_name (wfixed, SSDATA (Vx_resource_name));
1205 /* If this frame has a title or name, set it in the title bar. */
1206 if (! NILP (f->title))
1207 title = SSDATA (ENCODE_UTF_8 (f->title));
1208 else if (! NILP (f->name))
1209 title = SSDATA (ENCODE_UTF_8 (f->name));
1211 if (title) gtk_window_set_title (GTK_WINDOW (wtop), title);
1213 FRAME_GTK_OUTER_WIDGET (f) = wtop;
1214 FRAME_GTK_WIDGET (f) = wfixed;
1215 f->output_data.x->vbox_widget = wvbox;
1216 f->output_data.x->hbox_widget = whbox;
1218 gtk_widget_set_has_window (wfixed, TRUE);
1220 gtk_container_add (GTK_CONTAINER (wtop), wvbox);
1221 gtk_box_pack_start (GTK_BOX (wvbox), whbox, TRUE, TRUE, 0);
1222 gtk_box_pack_start (GTK_BOX (whbox), wfixed, TRUE, TRUE, 0);
1224 if (FRAME_EXTERNAL_TOOL_BAR (f))
1225 update_frame_tool_bar (f);
1227 /* We don't want this widget double buffered, because we draw on it
1228 with regular X drawing primitives, so from a GTK/GDK point of
1229 view, the widget is totally blank. When an expose comes, this
1230 will make the widget blank, and then Emacs redraws it. This flickers
1231 a lot, so we turn off double buffering. */
1232 gtk_widget_set_double_buffered (wfixed, FALSE);
1234 gtk_window_set_wmclass (GTK_WINDOW (wtop),
1235 SSDATA (Vx_resource_name),
1236 SSDATA (Vx_resource_class));
1238 /* Add callback to do nothing on WM_DELETE_WINDOW. The default in
1239 GTK is to destroy the widget. We want Emacs to do that instead. */
1240 g_signal_connect (G_OBJECT (wtop), "delete-event",
1241 G_CALLBACK (delete_cb), f);
1243 /* Convert our geometry parameters into a geometry string
1244 and specify it.
1245 GTK will itself handle calculating the real position this way. */
1246 xg_set_geometry (f);
1247 f->win_gravity
1248 = gtk_window_get_gravity (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)));
1250 gtk_widget_add_events (wfixed,
1251 GDK_POINTER_MOTION_MASK
1252 | GDK_EXPOSURE_MASK
1253 | GDK_BUTTON_PRESS_MASK
1254 | GDK_BUTTON_RELEASE_MASK
1255 | GDK_KEY_PRESS_MASK
1256 | GDK_ENTER_NOTIFY_MASK
1257 | GDK_LEAVE_NOTIFY_MASK
1258 | GDK_FOCUS_CHANGE_MASK
1259 | GDK_STRUCTURE_MASK
1260 | GDK_VISIBILITY_NOTIFY_MASK);
1262 /* Must realize the windows so the X window gets created. It is used
1263 by callers of this function. */
1264 gtk_widget_realize (wfixed);
1265 FRAME_X_WINDOW (f) = GTK_WIDGET_TO_X_WIN (wfixed);
1267 /* Since GTK clears its window by filling with the background color,
1268 we must keep X and GTK background in sync. */
1269 xg_set_widget_bg (f, wfixed, FRAME_BACKGROUND_PIXEL (f));
1271 #ifndef HAVE_GTK3
1272 /* Also, do not let any background pixmap to be set, this looks very
1273 bad as Emacs overwrites the background pixmap with its own idea
1274 of background color. */
1275 style = gtk_widget_get_modifier_style (wfixed);
1277 /* Must use g_strdup because gtk_widget_modify_style does g_free. */
1278 style->bg_pixmap_name[GTK_STATE_NORMAL] = g_strdup ("<none>");
1279 gtk_widget_modify_style (wfixed, style);
1280 #else
1281 gtk_widget_set_can_focus (wfixed, TRUE);
1282 gtk_window_set_resizable (GTK_WINDOW (wtop), TRUE);
1283 #endif
1285 #ifdef USE_GTK_TOOLTIP
1286 /* Steal a tool tip window we can move ourselves. */
1287 f->output_data.x->ttip_widget = 0;
1288 f->output_data.x->ttip_lbl = 0;
1289 f->output_data.x->ttip_window = 0;
1290 gtk_widget_set_tooltip_text (wtop, "Dummy text");
1291 g_signal_connect (wtop, "query-tooltip", G_CALLBACK (qttip_cb), f);
1292 #endif
1295 GdkScreen *screen = gtk_widget_get_screen (wtop);
1296 GtkSettings *gs = gtk_settings_get_for_screen (screen);
1297 /* Only connect this signal once per screen. */
1298 if (! g_signal_handler_find (G_OBJECT (gs),
1299 G_SIGNAL_MATCH_FUNC,
1300 0, 0, 0,
1301 G_CALLBACK (style_changed_cb),
1304 g_signal_connect (G_OBJECT (gs), "notify::gtk-theme-name",
1305 G_CALLBACK (style_changed_cb),
1306 gdk_screen_get_display (screen));
1310 unblock_input ();
1312 return 1;
1315 void
1316 xg_free_frame_widgets (struct frame *f)
1318 if (FRAME_GTK_OUTER_WIDGET (f))
1320 #ifdef USE_GTK_TOOLTIP
1321 struct x_output *x = f->output_data.x;
1322 #endif
1323 struct xg_frame_tb_info *tbinfo
1324 = g_object_get_data (G_OBJECT (FRAME_GTK_OUTER_WIDGET (f)),
1325 TB_INFO_KEY);
1326 if (tbinfo)
1327 xfree (tbinfo);
1329 gtk_widget_destroy (FRAME_GTK_OUTER_WIDGET (f));
1330 FRAME_X_WINDOW (f) = 0; /* Set to avoid XDestroyWindow in xterm.c */
1331 FRAME_GTK_OUTER_WIDGET (f) = 0;
1332 #ifdef USE_GTK_TOOLTIP
1333 if (x->ttip_lbl)
1334 gtk_widget_destroy (x->ttip_lbl);
1335 if (x->ttip_widget)
1336 g_object_unref (G_OBJECT (x->ttip_widget));
1337 #endif
1341 /* Set the normal size hints for the window manager, for frame F.
1342 FLAGS is the flags word to use--or 0 meaning preserve the flags
1343 that the window now has.
1344 If USER_POSITION, set the User Position
1345 flag (this is useful when FLAGS is 0). */
1347 void
1348 x_wm_set_size_hint (struct frame *f, long int flags, bool user_position)
1350 /* Must use GTK routines here, otherwise GTK resets the size hints
1351 to its own defaults. */
1352 GdkGeometry size_hints;
1353 gint hint_flags = 0;
1354 int base_width, base_height;
1355 int min_rows = 0, min_cols = 0;
1356 int win_gravity = f->win_gravity;
1357 Lisp_Object fs_state, frame;
1359 /* Don't set size hints during initialization; that apparently leads
1360 to a race condition. See the thread at
1361 http://lists.gnu.org/archive/html/emacs-devel/2008-10/msg00033.html */
1362 if (NILP (Vafter_init_time) || !FRAME_GTK_OUTER_WIDGET (f))
1363 return;
1365 XSETFRAME (frame, f);
1366 fs_state = Fframe_parameter (frame, Qfullscreen);
1367 if (EQ (fs_state, Qmaximized) || EQ (fs_state, Qfullboth))
1369 /* Don't set hints when maximized or fullscreen. Apparently KWin and
1370 Gtk3 don't get along and the frame shrinks (!).
1372 return;
1375 if (flags)
1377 memset (&size_hints, 0, sizeof (size_hints));
1378 f->output_data.x->size_hints = size_hints;
1379 f->output_data.x->hint_flags = hint_flags;
1381 else
1382 flags = f->size_hint_flags;
1384 size_hints = f->output_data.x->size_hints;
1385 hint_flags = f->output_data.x->hint_flags;
1387 hint_flags |= GDK_HINT_RESIZE_INC | GDK_HINT_MIN_SIZE;
1388 size_hints.width_inc = frame_resize_pixelwise ? 1 : FRAME_COLUMN_WIDTH (f);
1389 size_hints.height_inc = frame_resize_pixelwise ? 1 : FRAME_LINE_HEIGHT (f);
1391 hint_flags |= GDK_HINT_BASE_SIZE;
1392 /* Use one row/col here so base_height/width does not become zero.
1393 Gtk+ and/or Unity on Ubuntu 12.04 can't handle it. */
1394 base_width = FRAME_TEXT_COLS_TO_PIXEL_WIDTH (f, 1) + FRAME_TOOLBAR_WIDTH (f);
1395 base_height = FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, 1)
1396 + FRAME_MENUBAR_HEIGHT (f) + FRAME_TOOLBAR_HEIGHT (f);
1398 if (min_cols > 0) --min_cols; /* We used one col in base_width = ... 1); */
1399 if (min_rows > 0) --min_rows; /* We used one row in base_height = ... 1); */
1401 size_hints.base_width = base_width;
1402 size_hints.base_height = base_height;
1403 size_hints.min_width = base_width + min_cols * FRAME_COLUMN_WIDTH (f);
1404 size_hints.min_height = base_height + min_rows * FRAME_LINE_HEIGHT (f);
1406 /* These currently have a one to one mapping with the X values, but I
1407 don't think we should rely on that. */
1408 hint_flags |= GDK_HINT_WIN_GRAVITY;
1409 size_hints.win_gravity = 0;
1410 if (win_gravity == NorthWestGravity)
1411 size_hints.win_gravity = GDK_GRAVITY_NORTH_WEST;
1412 else if (win_gravity == NorthGravity)
1413 size_hints.win_gravity = GDK_GRAVITY_NORTH;
1414 else if (win_gravity == NorthEastGravity)
1415 size_hints.win_gravity = GDK_GRAVITY_NORTH_EAST;
1416 else if (win_gravity == WestGravity)
1417 size_hints.win_gravity = GDK_GRAVITY_WEST;
1418 else if (win_gravity == CenterGravity)
1419 size_hints.win_gravity = GDK_GRAVITY_CENTER;
1420 else if (win_gravity == EastGravity)
1421 size_hints.win_gravity = GDK_GRAVITY_EAST;
1422 else if (win_gravity == SouthWestGravity)
1423 size_hints.win_gravity = GDK_GRAVITY_SOUTH_WEST;
1424 else if (win_gravity == SouthGravity)
1425 size_hints.win_gravity = GDK_GRAVITY_SOUTH;
1426 else if (win_gravity == SouthEastGravity)
1427 size_hints.win_gravity = GDK_GRAVITY_SOUTH_EAST;
1428 else if (win_gravity == StaticGravity)
1429 size_hints.win_gravity = GDK_GRAVITY_STATIC;
1431 if (user_position)
1433 hint_flags &= ~GDK_HINT_POS;
1434 hint_flags |= GDK_HINT_USER_POS;
1437 if (hint_flags != f->output_data.x->hint_flags
1438 || memcmp (&size_hints,
1439 &f->output_data.x->size_hints,
1440 sizeof (size_hints)) != 0)
1442 block_input ();
1443 gtk_window_set_geometry_hints (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)),
1444 NULL, &size_hints, hint_flags);
1445 f->output_data.x->size_hints = size_hints;
1446 f->output_data.x->hint_flags = hint_flags;
1447 unblock_input ();
1451 /* Change background color of a frame.
1452 Since GTK uses the background color to clear the window, we must
1453 keep the GTK and X colors in sync.
1454 F is the frame to change,
1455 BG is the pixel value to change to. */
1457 void
1458 xg_set_background_color (struct frame *f, unsigned long bg)
1460 if (FRAME_GTK_WIDGET (f))
1462 block_input ();
1463 xg_set_widget_bg (f, FRAME_GTK_WIDGET (f), FRAME_BACKGROUND_PIXEL (f));
1464 unblock_input ();
1469 /* Set the frame icon to ICON_PIXMAP/MASK. This must be done with GTK
1470 functions so GTK does not overwrite the icon. */
1472 void
1473 xg_set_frame_icon (struct frame *f, Pixmap icon_pixmap, Pixmap icon_mask)
1475 GdkPixbuf *gp = xg_get_pixbuf_from_pix_and_mask (f,
1476 icon_pixmap,
1477 icon_mask);
1478 if (gp)
1479 gtk_window_set_icon (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)), gp);
1484 /***********************************************************************
1485 Dialog functions
1486 ***********************************************************************/
1487 /* Return the dialog title to use for a dialog of type KEY.
1488 This is the encoding used by lwlib. We use the same for GTK. */
1490 static const char *
1491 get_dialog_title (char key)
1493 const char *title = "";
1495 switch (key) {
1496 case 'E': case 'e':
1497 title = "Error";
1498 break;
1500 case 'I': case 'i':
1501 title = "Information";
1502 break;
1504 case 'L': case 'l':
1505 title = "Prompt";
1506 break;
1508 case 'P': case 'p':
1509 title = "Prompt";
1510 break;
1512 case 'Q': case 'q':
1513 title = "Question";
1514 break;
1517 return title;
1520 /* Callback for dialogs that get WM_DELETE_WINDOW. We pop down
1521 the dialog, but return TRUE so the event does not propagate further
1522 in GTK. This prevents GTK from destroying the dialog widget automatically
1523 and we can always destroy the widget manually, regardless of how
1524 it was popped down (button press or WM_DELETE_WINDOW).
1525 W is the dialog widget.
1526 EVENT is the GdkEvent that represents WM_DELETE_WINDOW (not used).
1527 user_data is NULL (not used).
1529 Returns TRUE to end propagation of event. */
1531 static gboolean
1532 dialog_delete_callback (GtkWidget *w, GdkEvent *event, gpointer user_data)
1534 gtk_widget_unmap (w);
1535 return TRUE;
1538 /* Create a popup dialog window. See also xg_create_widget below.
1539 WV is a widget_value describing the dialog.
1540 SELECT_CB is the callback to use when a button has been pressed.
1541 DEACTIVATE_CB is the callback to use when the dialog pops down.
1543 Returns the GTK dialog widget. */
1545 static GtkWidget *
1546 create_dialog (widget_value *wv,
1547 GCallback select_cb,
1548 GCallback deactivate_cb)
1550 const char *title = get_dialog_title (wv->name[0]);
1551 int total_buttons = wv->name[1] - '0';
1552 int right_buttons = wv->name[4] - '0';
1553 int left_buttons;
1554 int button_nr = 0;
1555 int button_spacing = 10;
1556 GtkWidget *wdialog = gtk_dialog_new ();
1557 GtkDialog *wd = GTK_DIALOG (wdialog);
1558 widget_value *item;
1559 GtkWidget *whbox_down;
1561 /* If the number of buttons is greater than 4, make two rows of buttons
1562 instead. This looks better. */
1563 bool make_two_rows = total_buttons > 4;
1565 #if GTK_CHECK_VERSION (3, 12, 0)
1566 GtkBuilder *gbld = gtk_builder_new ();
1567 GObject *go = gtk_buildable_get_internal_child (GTK_BUILDABLE (wd),
1568 gbld,
1569 "action_area");
1570 GtkBox *cur_box = GTK_BOX (go);
1571 g_object_unref (G_OBJECT (gbld));
1572 #else
1573 GtkBox *cur_box = GTK_BOX (gtk_dialog_get_action_area (wd));
1574 #endif
1576 if (right_buttons == 0) right_buttons = total_buttons/2;
1577 left_buttons = total_buttons - right_buttons;
1579 gtk_window_set_title (GTK_WINDOW (wdialog), title);
1580 gtk_widget_set_name (wdialog, "emacs-dialog");
1583 if (make_two_rows)
1585 GtkWidget *wvbox = gtk_box_new (GTK_ORIENTATION_VERTICAL, button_spacing);
1586 GtkWidget *whbox_up = gtk_box_new (GTK_ORIENTATION_HORIZONTAL, 0);
1587 gtk_box_set_homogeneous (GTK_BOX (wvbox), TRUE);
1588 gtk_box_set_homogeneous (GTK_BOX (whbox_up), FALSE);
1589 whbox_down = gtk_box_new (GTK_ORIENTATION_HORIZONTAL, 0);
1590 gtk_box_set_homogeneous (GTK_BOX (whbox_down), FALSE);
1592 gtk_box_pack_start (cur_box, wvbox, FALSE, FALSE, 0);
1593 gtk_box_pack_start (GTK_BOX (wvbox), whbox_up, FALSE, FALSE, 0);
1594 gtk_box_pack_start (GTK_BOX (wvbox), whbox_down, FALSE, FALSE, 0);
1596 cur_box = GTK_BOX (whbox_up);
1599 g_signal_connect (G_OBJECT (wdialog), "delete-event",
1600 G_CALLBACK (dialog_delete_callback), 0);
1602 if (deactivate_cb)
1604 g_signal_connect (G_OBJECT (wdialog), "close", deactivate_cb, 0);
1605 g_signal_connect (G_OBJECT (wdialog), "response", deactivate_cb, 0);
1608 for (item = wv->contents; item; item = item->next)
1610 char *utf8_label = get_utf8_string (item->value);
1611 GtkWidget *w;
1612 GtkRequisition req;
1614 if (item->name && strcmp (item->name, "message") == 0)
1616 GtkBox *wvbox = GTK_BOX (gtk_dialog_get_content_area (wd));
1617 /* This is the text part of the dialog. */
1618 w = gtk_label_new (utf8_label);
1619 gtk_box_pack_start (wvbox, gtk_label_new (""), FALSE, FALSE, 0);
1620 gtk_box_pack_start (wvbox, w, TRUE, TRUE, 0);
1621 #if GTK_CHECK_VERSION (3, 14, 0)
1622 gtk_widget_set_halign (w, GTK_ALIGN_START);
1623 gtk_widget_set_valign (w, GTK_ALIGN_CENTER);
1624 #else
1625 gtk_misc_set_alignment (GTK_MISC (w), 0.1, 0.5);
1626 #endif
1627 /* Try to make dialog look better. Must realize first so
1628 the widget can calculate the size it needs. */
1629 gtk_widget_realize (w);
1630 gtk_widget_get_preferred_size (w, NULL, &req);
1631 gtk_box_set_spacing (wvbox, req.height);
1632 if (item->value && strlen (item->value) > 0)
1633 button_spacing = 2*req.width/strlen (item->value);
1634 if (button_spacing < 10) button_spacing = 10;
1636 else
1638 /* This is one button to add to the dialog. */
1639 w = gtk_button_new_with_label (utf8_label);
1640 if (! item->enabled)
1641 gtk_widget_set_sensitive (w, FALSE);
1642 if (select_cb)
1643 g_signal_connect (G_OBJECT (w), "clicked",
1644 select_cb, item->call_data);
1646 gtk_box_pack_start (cur_box, w, TRUE, TRUE, button_spacing);
1647 if (++button_nr == left_buttons)
1649 if (make_two_rows)
1650 cur_box = GTK_BOX (whbox_down);
1654 if (utf8_label)
1655 g_free (utf8_label);
1658 return wdialog;
1661 struct xg_dialog_data
1663 GMainLoop *loop;
1664 int response;
1665 GtkWidget *w;
1666 guint timerid;
1669 /* Function that is called when the file or font dialogs pop down.
1670 W is the dialog widget, RESPONSE is the response code.
1671 USER_DATA is what we passed in to g_signal_connect. */
1673 static void
1674 xg_dialog_response_cb (GtkDialog *w,
1675 gint response,
1676 gpointer user_data)
1678 struct xg_dialog_data *dd = user_data;
1679 dd->response = response;
1680 g_main_loop_quit (dd->loop);
1684 /* Destroy the dialog. This makes it pop down. */
1686 static void
1687 pop_down_dialog (void *arg)
1689 struct xg_dialog_data *dd = arg;
1691 block_input ();
1692 if (dd->w) gtk_widget_destroy (dd->w);
1693 if (dd->timerid != 0) g_source_remove (dd->timerid);
1695 g_main_loop_quit (dd->loop);
1696 g_main_loop_unref (dd->loop);
1698 unblock_input ();
1701 /* If there are any emacs timers pending, add a timeout to main loop in DATA.
1702 We pass in DATA as gpointer* so we can use this as a callback. */
1704 static gboolean
1705 xg_maybe_add_timer (gpointer data)
1707 struct xg_dialog_data *dd = data;
1708 struct timespec next_time = timer_check ();
1710 dd->timerid = 0;
1712 if (timespec_valid_p (next_time))
1714 time_t s = next_time.tv_sec;
1715 int per_ms = TIMESPEC_RESOLUTION / 1000;
1716 int ms = (next_time.tv_nsec + per_ms - 1) / per_ms;
1717 if (s <= ((guint) -1 - ms) / 1000)
1718 dd->timerid = g_timeout_add (s * 1000 + ms, xg_maybe_add_timer, dd);
1720 return FALSE;
1724 /* Pops up a modal dialog W and waits for response.
1725 We don't use gtk_dialog_run because we want to process emacs timers.
1726 The dialog W is not destroyed when this function returns. */
1728 static int
1729 xg_dialog_run (struct frame *f, GtkWidget *w)
1731 ptrdiff_t count = SPECPDL_INDEX ();
1732 struct xg_dialog_data dd;
1734 xg_set_screen (w, f);
1735 gtk_window_set_transient_for (GTK_WINDOW (w),
1736 GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)));
1737 gtk_window_set_destroy_with_parent (GTK_WINDOW (w), TRUE);
1738 gtk_window_set_modal (GTK_WINDOW (w), TRUE);
1740 dd.loop = g_main_loop_new (NULL, FALSE);
1741 dd.response = GTK_RESPONSE_CANCEL;
1742 dd.w = w;
1743 dd.timerid = 0;
1745 g_signal_connect (G_OBJECT (w),
1746 "response",
1747 G_CALLBACK (xg_dialog_response_cb),
1748 &dd);
1749 /* Don't destroy the widget if closed by the window manager close button. */
1750 g_signal_connect (G_OBJECT (w), "delete-event", G_CALLBACK (gtk_true), NULL);
1751 gtk_widget_show (w);
1753 record_unwind_protect_ptr (pop_down_dialog, &dd);
1755 (void) xg_maybe_add_timer (&dd);
1756 g_main_loop_run (dd.loop);
1758 dd.w = 0;
1759 unbind_to (count, Qnil);
1761 return dd.response;
1765 /***********************************************************************
1766 File dialog functions
1767 ***********************************************************************/
1768 /* Return true if the old file selection dialog is being used. */
1770 bool
1771 xg_uses_old_file_dialog (void)
1773 #ifdef HAVE_GTK_FILE_SELECTION_NEW
1774 return x_gtk_use_old_file_dialog;
1775 #else
1776 return 0;
1777 #endif
1781 typedef char * (*xg_get_file_func) (GtkWidget *);
1783 /* Return the selected file for file chooser dialog W.
1784 The returned string must be free:d. */
1786 static char *
1787 xg_get_file_name_from_chooser (GtkWidget *w)
1789 return gtk_file_chooser_get_filename (GTK_FILE_CHOOSER (w));
1792 /* Callback called when the "Show hidden files" toggle is pressed.
1793 WIDGET is the toggle widget, DATA is the file chooser dialog. */
1795 static void
1796 xg_toggle_visibility_cb (GtkWidget *widget, gpointer data)
1798 GtkFileChooser *dialog = GTK_FILE_CHOOSER (data);
1799 gboolean visible;
1800 g_object_get (G_OBJECT (dialog), "show-hidden", &visible, NULL);
1801 g_object_set (G_OBJECT (dialog), "show-hidden", !visible, NULL);
1805 /* Callback called when a property changes in a file chooser.
1806 GOBJECT is the file chooser dialog, ARG1 describes the property.
1807 USER_DATA is the toggle widget in the file chooser dialog.
1808 We use this to update the "Show hidden files" toggle when the user
1809 changes that property by right clicking in the file list. */
1811 static void
1812 xg_toggle_notify_cb (GObject *gobject, GParamSpec *arg1, gpointer user_data)
1814 if (strcmp (arg1->name, "show-hidden") == 0)
1816 GtkWidget *wtoggle = GTK_WIDGET (user_data);
1817 gboolean visible, toggle_on;
1819 g_object_get (G_OBJECT (gobject), "show-hidden", &visible, NULL);
1820 toggle_on = gtk_toggle_button_get_active (GTK_TOGGLE_BUTTON (wtoggle));
1822 if (!!visible != !!toggle_on)
1824 g_signal_handlers_block_by_func (G_OBJECT (wtoggle),
1825 G_CALLBACK (xg_toggle_visibility_cb),
1826 gobject);
1827 gtk_toggle_button_set_active (GTK_TOGGLE_BUTTON (wtoggle), visible);
1828 g_signal_handlers_unblock_by_func
1829 (G_OBJECT (wtoggle),
1830 G_CALLBACK (xg_toggle_visibility_cb),
1831 gobject);
1833 x_gtk_show_hidden_files = visible;
1837 /* Read a file name from the user using a file chooser dialog.
1838 F is the current frame.
1839 PROMPT is a prompt to show to the user. May not be NULL.
1840 DEFAULT_FILENAME is a default selection to be displayed. May be NULL.
1841 If MUSTMATCH_P, the returned file name must be an existing
1842 file. (Actually, this only has cosmetic effects, the user can
1843 still enter a non-existing file.) *FUNC is set to a function that
1844 can be used to retrieve the selected file name from the returned widget.
1846 Returns the created widget. */
1848 static GtkWidget *
1849 xg_get_file_with_chooser (struct frame *f,
1850 char *prompt,
1851 char *default_filename,
1852 bool mustmatch_p, bool only_dir_p,
1853 xg_get_file_func *func)
1855 char msgbuf[1024];
1857 GtkWidget *filewin, *wtoggle, *wbox, *wmessage IF_LINT (= NULL);
1858 GtkWindow *gwin = GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f));
1859 GtkFileChooserAction action = (mustmatch_p ?
1860 GTK_FILE_CHOOSER_ACTION_OPEN :
1861 GTK_FILE_CHOOSER_ACTION_SAVE);
1863 if (only_dir_p)
1864 action = GTK_FILE_CHOOSER_ACTION_SELECT_FOLDER;
1866 filewin = gtk_file_chooser_dialog_new (prompt, gwin, action,
1867 XG_TEXT_CANCEL, GTK_RESPONSE_CANCEL,
1868 (mustmatch_p || only_dir_p ?
1869 XG_TEXT_OPEN : XG_TEXT_OK),
1870 GTK_RESPONSE_OK,
1871 NULL);
1872 gtk_file_chooser_set_local_only (GTK_FILE_CHOOSER (filewin), TRUE);
1874 wbox = gtk_box_new (GTK_ORIENTATION_VERTICAL, 0);
1875 gtk_box_set_homogeneous (GTK_BOX (wbox), FALSE);
1876 gtk_widget_show (wbox);
1877 wtoggle = gtk_check_button_new_with_label ("Show hidden files.");
1879 if (x_gtk_show_hidden_files)
1881 g_object_set (G_OBJECT (filewin), "show-hidden", TRUE, NULL);
1882 gtk_toggle_button_set_active (GTK_TOGGLE_BUTTON (wtoggle), TRUE);
1884 gtk_widget_show (wtoggle);
1885 g_signal_connect (G_OBJECT (wtoggle), "clicked",
1886 G_CALLBACK (xg_toggle_visibility_cb), filewin);
1887 g_signal_connect (G_OBJECT (filewin), "notify",
1888 G_CALLBACK (xg_toggle_notify_cb), wtoggle);
1890 if (x_gtk_file_dialog_help_text)
1892 char *z = msgbuf;
1893 /* Gtk+ 2.10 has the file name text entry box integrated in the dialog.
1894 Show the C-l help text only for versions < 2.10. */
1895 if (gtk_check_version (2, 10, 0) && action != GTK_FILE_CHOOSER_ACTION_SAVE)
1896 z = stpcpy (z, "\nType C-l to display a file name text entry box.\n");
1897 strcpy (z, "\nIf you don't like this file selector, use the "
1898 "corresponding\nkey binding or customize "
1899 "use-file-dialog to turn it off.");
1901 wmessage = gtk_label_new (msgbuf);
1902 gtk_widget_show (wmessage);
1905 gtk_box_pack_start (GTK_BOX (wbox), wtoggle, FALSE, FALSE, 0);
1906 if (x_gtk_file_dialog_help_text)
1907 gtk_box_pack_start (GTK_BOX (wbox), wmessage, FALSE, FALSE, 0);
1908 gtk_file_chooser_set_extra_widget (GTK_FILE_CHOOSER (filewin), wbox);
1910 if (default_filename)
1912 Lisp_Object file;
1913 struct gcpro gcpro1;
1914 char *utf8_filename;
1915 GCPRO1 (file);
1917 file = build_string (default_filename);
1919 /* File chooser does not understand ~/... in the file name. It must be
1920 an absolute name starting with /. */
1921 if (default_filename[0] != '/')
1922 file = Fexpand_file_name (file, Qnil);
1924 utf8_filename = SSDATA (ENCODE_UTF_8 (file));
1925 if (! NILP (Ffile_directory_p (file)))
1926 gtk_file_chooser_set_current_folder (GTK_FILE_CHOOSER (filewin),
1927 utf8_filename);
1928 else
1930 gtk_file_chooser_set_filename (GTK_FILE_CHOOSER (filewin),
1931 utf8_filename);
1932 if (action == GTK_FILE_CHOOSER_ACTION_SAVE)
1934 char *cp = strrchr (utf8_filename, '/');
1935 if (cp) ++cp;
1936 else cp = utf8_filename;
1937 gtk_file_chooser_set_current_name (GTK_FILE_CHOOSER (filewin), cp);
1941 UNGCPRO;
1944 *func = xg_get_file_name_from_chooser;
1945 return filewin;
1948 #ifdef HAVE_GTK_FILE_SELECTION_NEW
1950 /* Return the selected file for file selector dialog W.
1951 The returned string must be free:d. */
1953 static char *
1954 xg_get_file_name_from_selector (GtkWidget *w)
1956 GtkFileSelection *filesel = GTK_FILE_SELECTION (w);
1957 return xstrdup (gtk_file_selection_get_filename (filesel));
1960 /* Create a file selection dialog.
1961 F is the current frame.
1962 PROMPT is a prompt to show to the user. May not be NULL.
1963 DEFAULT_FILENAME is a default selection to be displayed. May be NULL.
1964 If MUSTMATCH_P, the returned file name must be an existing
1965 file. *FUNC is set to a function that can be used to retrieve the
1966 selected file name from the returned widget.
1968 Returns the created widget. */
1970 static GtkWidget *
1971 xg_get_file_with_selection (struct frame *f,
1972 char *prompt,
1973 char *default_filename,
1974 bool mustmatch_p, bool only_dir_p,
1975 xg_get_file_func *func)
1977 GtkWidget *filewin;
1978 GtkFileSelection *filesel;
1980 filewin = gtk_file_selection_new (prompt);
1981 filesel = GTK_FILE_SELECTION (filewin);
1983 if (default_filename)
1984 gtk_file_selection_set_filename (filesel, default_filename);
1986 if (mustmatch_p)
1988 /* The selection_entry part of filesel is not documented. */
1989 gtk_widget_set_sensitive (filesel->selection_entry, FALSE);
1990 gtk_file_selection_hide_fileop_buttons (filesel);
1993 *func = xg_get_file_name_from_selector;
1995 return filewin;
1997 #endif /* HAVE_GTK_FILE_SELECTION_NEW */
1999 /* Read a file name from the user using a file dialog, either the old
2000 file selection dialog, or the new file chooser dialog. Which to use
2001 depends on what the GTK version used has, and what the value of
2002 gtk-use-old-file-dialog.
2003 F is the current frame.
2004 PROMPT is a prompt to show to the user. May not be NULL.
2005 DEFAULT_FILENAME is a default selection to be displayed. May be NULL.
2006 If MUSTMATCH_P, the returned file name must be an existing
2007 file.
2009 Returns a file name or NULL if no file was selected.
2010 The returned string must be freed by the caller. */
2012 char *
2013 xg_get_file_name (struct frame *f,
2014 char *prompt,
2015 char *default_filename,
2016 bool mustmatch_p,
2017 bool only_dir_p)
2019 GtkWidget *w = 0;
2020 char *fn = 0;
2021 int filesel_done = 0;
2022 xg_get_file_func func;
2024 #ifdef HAVE_GTK_FILE_SELECTION_NEW
2026 if (xg_uses_old_file_dialog ())
2027 w = xg_get_file_with_selection (f, prompt, default_filename,
2028 mustmatch_p, only_dir_p, &func);
2029 else
2030 w = xg_get_file_with_chooser (f, prompt, default_filename,
2031 mustmatch_p, only_dir_p, &func);
2033 #else /* not HAVE_GTK_FILE_SELECTION_NEW */
2034 w = xg_get_file_with_chooser (f, prompt, default_filename,
2035 mustmatch_p, only_dir_p, &func);
2036 #endif /* not HAVE_GTK_FILE_SELECTION_NEW */
2038 gtk_widget_set_name (w, "emacs-filedialog");
2040 filesel_done = xg_dialog_run (f, w);
2041 if (filesel_done == GTK_RESPONSE_OK)
2042 fn = (*func) (w);
2044 gtk_widget_destroy (w);
2045 return fn;
2048 /***********************************************************************
2049 GTK font chooser
2050 ***********************************************************************/
2052 #ifdef HAVE_FREETYPE
2054 #if USE_NEW_GTK_FONT_CHOOSER
2056 #define XG_WEIGHT_TO_SYMBOL(w) \
2057 (w <= PANGO_WEIGHT_THIN ? Qextra_light \
2058 : w <= PANGO_WEIGHT_ULTRALIGHT ? Qlight \
2059 : w <= PANGO_WEIGHT_LIGHT ? Qsemi_light \
2060 : w < PANGO_WEIGHT_MEDIUM ? Qnormal \
2061 : w <= PANGO_WEIGHT_SEMIBOLD ? Qsemi_bold \
2062 : w <= PANGO_WEIGHT_BOLD ? Qbold \
2063 : w <= PANGO_WEIGHT_HEAVY ? Qextra_bold \
2064 : Qultra_bold)
2066 #define XG_STYLE_TO_SYMBOL(s) \
2067 (s == PANGO_STYLE_OBLIQUE ? Qoblique \
2068 : s == PANGO_STYLE_ITALIC ? Qitalic \
2069 : Qnormal)
2071 #endif /* USE_NEW_GTK_FONT_CHOOSER */
2074 static char *x_last_font_name;
2076 /* Pop up a GTK font selector and return the name of the font the user
2077 selects, as a C string. The returned font name follows GTK's own
2078 format:
2080 `FAMILY [VALUE1 VALUE2] SIZE'
2082 This can be parsed using font_parse_fcname in font.c.
2083 DEFAULT_NAME, if non-zero, is the default font name. */
2085 Lisp_Object
2086 xg_get_font (struct frame *f, const char *default_name)
2088 GtkWidget *w;
2089 int done = 0;
2090 Lisp_Object font = Qnil;
2092 w = gtk_font_chooser_dialog_new
2093 ("Pick a font", GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)));
2095 if (default_name)
2097 /* Convert fontconfig names to Gtk names, i.e. remove - before
2098 number */
2099 char *p = strrchr (default_name, '-');
2100 if (p)
2102 char *ep = p+1;
2103 while (c_isdigit (*ep))
2104 ++ep;
2105 if (*ep == '\0') *p = ' ';
2108 else if (x_last_font_name)
2109 default_name = x_last_font_name;
2111 if (default_name)
2112 gtk_font_chooser_set_font (GTK_FONT_CHOOSER (w), default_name);
2114 gtk_widget_set_name (w, "emacs-fontdialog");
2115 done = xg_dialog_run (f, w);
2116 if (done == GTK_RESPONSE_OK)
2118 #if USE_NEW_GTK_FONT_CHOOSER
2119 /* Use the GTK3 font chooser. */
2120 PangoFontDescription *desc
2121 = gtk_font_chooser_get_font_desc (GTK_FONT_CHOOSER (w));
2123 if (desc)
2125 const char *name = pango_font_description_get_family (desc);
2126 gint size = pango_font_description_get_size (desc);
2127 PangoWeight weight = pango_font_description_get_weight (desc);
2128 PangoStyle style = pango_font_description_get_style (desc);
2130 font = CALLN (Ffont_spec,
2131 QCname, build_string (name),
2132 QCsize, make_float (pango_units_to_double (size)),
2133 QCweight, XG_WEIGHT_TO_SYMBOL (weight),
2134 QCslant, XG_STYLE_TO_SYMBOL (style),
2135 QCtype, Qxft);
2137 pango_font_description_free (desc);
2138 dupstring (&x_last_font_name, name);
2141 #else /* Use old font selector, which just returns the font name. */
2143 char *font_name
2144 = gtk_font_selection_dialog_get_font_name (GTK_FONT_CHOOSER (w));
2146 if (font_name)
2148 font = build_string (font_name);
2149 g_free (x_last_font_name);
2150 x_last_font_name = font_name;
2152 #endif /* USE_NEW_GTK_FONT_CHOOSER */
2155 gtk_widget_destroy (w);
2156 return font;
2158 #endif /* HAVE_FREETYPE */
2162 /***********************************************************************
2163 Menu functions.
2164 ***********************************************************************/
2166 /* The name of menu items that can be used for customization. Since GTK
2167 RC files are very crude and primitive, we have to set this on all
2168 menu item names so a user can easily customize menu items. */
2170 #define MENU_ITEM_NAME "emacs-menuitem"
2173 /* Linked list of all allocated struct xg_menu_cb_data. Used for marking
2174 during GC. The next member points to the items. */
2175 static xg_list_node xg_menu_cb_list;
2177 /* Linked list of all allocated struct xg_menu_item_cb_data. Used for marking
2178 during GC. The next member points to the items. */
2179 static xg_list_node xg_menu_item_cb_list;
2181 /* Allocate and initialize CL_DATA if NULL, otherwise increase ref_count.
2182 F is the frame CL_DATA will be initialized for.
2183 HIGHLIGHT_CB is the callback to call when entering/leaving menu items.
2185 The menu bar and all sub menus under the menu bar in a frame
2186 share the same structure, hence the reference count.
2188 Returns CL_DATA if CL_DATA is not NULL, or a pointer to a newly
2189 allocated xg_menu_cb_data if CL_DATA is NULL. */
2191 static xg_menu_cb_data *
2192 make_cl_data (xg_menu_cb_data *cl_data, struct frame *f, GCallback highlight_cb)
2194 if (! cl_data)
2196 cl_data = xmalloc (sizeof *cl_data);
2197 cl_data->f = f;
2198 cl_data->menu_bar_vector = f->menu_bar_vector;
2199 cl_data->menu_bar_items_used = f->menu_bar_items_used;
2200 cl_data->highlight_cb = highlight_cb;
2201 cl_data->ref_count = 0;
2203 xg_list_insert (&xg_menu_cb_list, &cl_data->ptrs);
2206 cl_data->ref_count++;
2208 return cl_data;
2211 /* Update CL_DATA with values from frame F and with HIGHLIGHT_CB.
2212 HIGHLIGHT_CB is the callback to call when entering/leaving menu items.
2214 When the menu bar is updated, menu items may have been added and/or
2215 removed, so menu_bar_vector and menu_bar_items_used change. We must
2216 then update CL_DATA since it is used to determine which menu
2217 item that is invoked in the menu.
2218 HIGHLIGHT_CB could change, there is no check that the same
2219 function is given when modifying a menu bar as was given when
2220 creating the menu bar. */
2222 static void
2223 update_cl_data (xg_menu_cb_data *cl_data,
2224 struct frame *f,
2225 GCallback highlight_cb)
2227 if (cl_data)
2229 cl_data->f = f;
2230 cl_data->menu_bar_vector = f->menu_bar_vector;
2231 cl_data->menu_bar_items_used = f->menu_bar_items_used;
2232 cl_data->highlight_cb = highlight_cb;
2236 /* Decrease reference count for CL_DATA.
2237 If reference count is zero, free CL_DATA. */
2239 static void
2240 unref_cl_data (xg_menu_cb_data *cl_data)
2242 if (cl_data && cl_data->ref_count > 0)
2244 cl_data->ref_count--;
2245 if (cl_data->ref_count == 0)
2247 xg_list_remove (&xg_menu_cb_list, &cl_data->ptrs);
2248 xfree (cl_data);
2253 /* Function that marks all lisp data during GC. */
2255 void
2256 xg_mark_data (void)
2258 xg_list_node *iter;
2259 Lisp_Object rest, frame;
2261 for (iter = xg_menu_cb_list.next; iter; iter = iter->next)
2262 mark_object (((xg_menu_cb_data *) iter)->menu_bar_vector);
2264 for (iter = xg_menu_item_cb_list.next; iter; iter = iter->next)
2266 xg_menu_item_cb_data *cb_data = (xg_menu_item_cb_data *) iter;
2268 if (! NILP (cb_data->help))
2269 mark_object (cb_data->help);
2272 FOR_EACH_FRAME (rest, frame)
2274 struct frame *f = XFRAME (frame);
2276 if (FRAME_X_P (f) && FRAME_GTK_OUTER_WIDGET (f))
2278 struct xg_frame_tb_info *tbinfo
2279 = g_object_get_data (G_OBJECT (FRAME_GTK_OUTER_WIDGET (f)),
2280 TB_INFO_KEY);
2281 if (tbinfo)
2283 mark_object (tbinfo->last_tool_bar);
2284 mark_object (tbinfo->style);
2291 /* Callback called when a menu item is destroyed. Used to free data.
2292 W is the widget that is being destroyed (not used).
2293 CLIENT_DATA points to the xg_menu_item_cb_data associated with the W. */
2295 static void
2296 menuitem_destroy_callback (GtkWidget *w, gpointer client_data)
2298 if (client_data)
2300 xg_menu_item_cb_data *data = client_data;
2301 xg_list_remove (&xg_menu_item_cb_list, &data->ptrs);
2302 xfree (data);
2306 /* Callback called when the pointer enters/leaves a menu item.
2307 W is the parent of the menu item.
2308 EVENT is either an enter event or leave event.
2309 CLIENT_DATA is not used.
2311 Returns FALSE to tell GTK to keep processing this event. */
2313 static gboolean
2314 menuitem_highlight_callback (GtkWidget *w,
2315 GdkEventCrossing *event,
2316 gpointer client_data)
2318 GdkEvent ev;
2319 GtkWidget *subwidget;
2320 xg_menu_item_cb_data *data;
2322 ev.crossing = *event;
2323 subwidget = gtk_get_event_widget (&ev);
2324 data = g_object_get_data (G_OBJECT (subwidget), XG_ITEM_DATA);
2325 if (data)
2327 if (! NILP (data->help) && data->cl_data->highlight_cb)
2329 gpointer call_data = event->type == GDK_LEAVE_NOTIFY ? 0 : data;
2330 GtkCallback func = (GtkCallback) data->cl_data->highlight_cb;
2331 (*func) (subwidget, call_data);
2335 return FALSE;
2338 /* Callback called when a menu is destroyed. Used to free data.
2339 W is the widget that is being destroyed (not used).
2340 CLIENT_DATA points to the xg_menu_cb_data associated with W. */
2342 static void
2343 menu_destroy_callback (GtkWidget *w, gpointer client_data)
2345 unref_cl_data (client_data);
2348 /* Make a GTK widget that contains both UTF8_LABEL and UTF8_KEY (both
2349 must be non-NULL) and can be inserted into a menu item.
2351 Returns the GtkHBox. */
2353 static GtkWidget *
2354 make_widget_for_menu_item (const char *utf8_label, const char *utf8_key)
2356 GtkWidget *wlbl;
2357 GtkWidget *wkey;
2358 GtkWidget *wbox;
2360 wbox = gtk_box_new (GTK_ORIENTATION_HORIZONTAL, 0);
2361 gtk_box_set_homogeneous (GTK_BOX (wbox), FALSE);
2362 wlbl = gtk_label_new (utf8_label);
2363 wkey = gtk_label_new (utf8_key);
2365 #if GTK_CHECK_VERSION (3, 14, 0)
2366 gtk_widget_set_halign (wlbl, GTK_ALIGN_START);
2367 gtk_widget_set_valign (wlbl, GTK_ALIGN_CENTER);
2368 gtk_widget_set_halign (wkey, GTK_ALIGN_START);
2369 gtk_widget_set_valign (wkey, GTK_ALIGN_CENTER);
2370 #else
2371 gtk_misc_set_alignment (GTK_MISC (wlbl), 0.0, 0.5);
2372 gtk_misc_set_alignment (GTK_MISC (wkey), 0.0, 0.5);
2373 #endif
2374 gtk_box_pack_start (GTK_BOX (wbox), wlbl, TRUE, TRUE, 0);
2375 gtk_box_pack_start (GTK_BOX (wbox), wkey, FALSE, FALSE, 0);
2377 gtk_widget_set_name (wlbl, MENU_ITEM_NAME);
2378 gtk_widget_set_name (wkey, MENU_ITEM_NAME);
2379 gtk_widget_set_name (wbox, MENU_ITEM_NAME);
2381 return wbox;
2384 /* Make and return a menu item widget with the key to the right.
2385 UTF8_LABEL is the text for the menu item (GTK uses UTF8 internally).
2386 UTF8_KEY is the text representing the key binding.
2387 ITEM is the widget_value describing the menu item.
2389 GROUP is an in/out parameter. If the menu item to be created is not
2390 part of any radio menu group, *GROUP contains NULL on entry and exit.
2391 If the menu item to be created is part of a radio menu group, on entry
2392 *GROUP contains the group to use, or NULL if this is the first item
2393 in the group. On exit, *GROUP contains the radio item group.
2395 Unfortunately, keys don't line up as nicely as in Motif,
2396 but the MacOS X version doesn't either, so I guess that is OK. */
2398 static GtkWidget *
2399 make_menu_item (const char *utf8_label,
2400 const char *utf8_key,
2401 widget_value *item,
2402 GSList **group)
2404 GtkWidget *w;
2405 GtkWidget *wtoadd = 0;
2407 /* It has been observed that some menu items have a NULL name field.
2408 This will lead to this function being called with a NULL utf8_label.
2409 GTK crashes on that so we set a blank label. Why there is a NULL
2410 name remains to be investigated. */
2411 if (! utf8_label) utf8_label = " ";
2413 if (utf8_key)
2414 wtoadd = make_widget_for_menu_item (utf8_label, utf8_key);
2416 if (item->button_type == BUTTON_TYPE_TOGGLE)
2418 *group = NULL;
2419 if (utf8_key) w = gtk_check_menu_item_new ();
2420 else w = gtk_check_menu_item_new_with_label (utf8_label);
2421 gtk_check_menu_item_set_active (GTK_CHECK_MENU_ITEM (w), item->selected);
2423 else if (item->button_type == BUTTON_TYPE_RADIO)
2425 if (utf8_key) w = gtk_radio_menu_item_new (*group);
2426 else w = gtk_radio_menu_item_new_with_label (*group, utf8_label);
2427 *group = gtk_radio_menu_item_get_group (GTK_RADIO_MENU_ITEM (w));
2428 if (item->selected)
2429 gtk_check_menu_item_set_active (GTK_CHECK_MENU_ITEM (w), TRUE);
2431 else
2433 *group = NULL;
2434 if (utf8_key) w = gtk_menu_item_new ();
2435 else w = gtk_menu_item_new_with_label (utf8_label);
2438 if (wtoadd) gtk_container_add (GTK_CONTAINER (w), wtoadd);
2439 if (! item->enabled) gtk_widget_set_sensitive (w, FALSE);
2441 return w;
2444 /* Create a menu item widget, and connect the callbacks.
2445 ITEM describes the menu item.
2446 F is the frame the created menu belongs to.
2447 SELECT_CB is the callback to use when a menu item is selected.
2448 HIGHLIGHT_CB is the callback to call when entering/leaving menu items.
2449 CL_DATA points to the callback data to be used for this menu.
2450 GROUP is an in/out parameter. If the menu item to be created is not
2451 part of any radio menu group, *GROUP contains NULL on entry and exit.
2452 If the menu item to be created is part of a radio menu group, on entry
2453 *GROUP contains the group to use, or NULL if this is the first item
2454 in the group. On exit, *GROUP contains the radio item group.
2456 Returns the created GtkWidget. */
2458 static GtkWidget *
2459 xg_create_one_menuitem (widget_value *item,
2460 struct frame *f,
2461 GCallback select_cb,
2462 GCallback highlight_cb,
2463 xg_menu_cb_data *cl_data,
2464 GSList **group)
2466 char *utf8_label;
2467 char *utf8_key;
2468 GtkWidget *w;
2469 xg_menu_item_cb_data *cb_data;
2471 utf8_label = get_utf8_string (item->name);
2472 utf8_key = get_utf8_string (item->key);
2474 w = make_menu_item (utf8_label, utf8_key, item, group);
2476 if (utf8_label) g_free (utf8_label);
2477 if (utf8_key) g_free (utf8_key);
2479 cb_data = xmalloc (sizeof *cb_data);
2481 xg_list_insert (&xg_menu_item_cb_list, &cb_data->ptrs);
2483 cb_data->select_id = 0;
2484 cb_data->help = item->help;
2485 cb_data->cl_data = cl_data;
2486 cb_data->call_data = item->call_data;
2488 g_signal_connect (G_OBJECT (w),
2489 "destroy",
2490 G_CALLBACK (menuitem_destroy_callback),
2491 cb_data);
2493 /* Put cb_data in widget, so we can get at it when modifying menubar */
2494 g_object_set_data (G_OBJECT (w), XG_ITEM_DATA, cb_data);
2496 /* final item, not a submenu */
2497 if (item->call_data && ! item->contents)
2499 if (select_cb)
2500 cb_data->select_id
2501 = g_signal_connect (G_OBJECT (w), "activate", select_cb, cb_data);
2504 return w;
2507 /* Create a full menu tree specified by DATA.
2508 F is the frame the created menu belongs to.
2509 SELECT_CB is the callback to use when a menu item is selected.
2510 DEACTIVATE_CB is the callback to use when a sub menu is not shown anymore.
2511 HIGHLIGHT_CB is the callback to call when entering/leaving menu items.
2512 If POP_UP_P, create a popup menu.
2513 If MENU_BAR_P, create a menu bar.
2514 TOPMENU is the topmost GtkWidget that others shall be placed under.
2515 It may be NULL, in that case we create the appropriate widget
2516 (menu bar or menu item depending on POP_UP_P and MENU_BAR_P)
2517 CL_DATA is the callback data we shall use for this menu, or NULL
2518 if we haven't set the first callback yet.
2519 NAME is the name to give to the top level menu if this function
2520 creates it. May be NULL to not set any name.
2522 Returns the top level GtkWidget. This is TOPLEVEL if TOPLEVEL is
2523 not NULL.
2525 This function calls itself to create submenus. */
2527 static GtkWidget *
2528 create_menus (widget_value *data,
2529 struct frame *f,
2530 GCallback select_cb,
2531 GCallback deactivate_cb,
2532 GCallback highlight_cb,
2533 bool pop_up_p,
2534 bool menu_bar_p,
2535 GtkWidget *topmenu,
2536 xg_menu_cb_data *cl_data,
2537 const char *name)
2539 widget_value *item;
2540 GtkWidget *wmenu = topmenu;
2541 GSList *group = NULL;
2543 if (! topmenu)
2545 if (! menu_bar_p)
2547 wmenu = gtk_menu_new ();
2548 xg_set_screen (wmenu, f);
2549 /* Connect this to the menu instead of items so we get enter/leave for
2550 disabled items also. TODO: Still does not get enter/leave for
2551 disabled items in detached menus. */
2552 g_signal_connect (G_OBJECT (wmenu),
2553 "enter-notify-event",
2554 G_CALLBACK (menuitem_highlight_callback),
2555 NULL);
2556 g_signal_connect (G_OBJECT (wmenu),
2557 "leave-notify-event",
2558 G_CALLBACK (menuitem_highlight_callback),
2559 NULL);
2561 else
2563 wmenu = gtk_menu_bar_new ();
2564 /* Set width of menu bar to a small value so it doesn't enlarge
2565 a small initial frame size. The width will be set to the
2566 width of the frame later on when it is added to a container.
2567 height -1: Natural height. */
2568 gtk_widget_set_size_request (wmenu, 1, -1);
2571 /* Put cl_data on the top menu for easier access. */
2572 cl_data = make_cl_data (cl_data, f, highlight_cb);
2573 g_object_set_data (G_OBJECT (wmenu), XG_FRAME_DATA, (gpointer)cl_data);
2574 g_signal_connect (G_OBJECT (wmenu), "destroy",
2575 G_CALLBACK (menu_destroy_callback), cl_data);
2577 if (name)
2578 gtk_widget_set_name (wmenu, name);
2580 if (deactivate_cb)
2581 g_signal_connect (G_OBJECT (wmenu),
2582 "selection-done", deactivate_cb, 0);
2585 for (item = data; item; item = item->next)
2587 GtkWidget *w;
2589 if (pop_up_p && !item->contents && !item->call_data
2590 && !menu_separator_name_p (item->name))
2592 char *utf8_label;
2593 /* A title for a popup. We do the same as GTK does when
2594 creating titles, but it does not look good. */
2595 group = NULL;
2596 utf8_label = get_utf8_string (item->name);
2598 w = gtk_menu_item_new_with_label (utf8_label);
2599 gtk_widget_set_sensitive (w, FALSE);
2600 if (utf8_label) g_free (utf8_label);
2602 else if (menu_separator_name_p (item->name))
2604 group = NULL;
2605 /* GTK only have one separator type. */
2606 w = gtk_separator_menu_item_new ();
2608 else
2610 w = xg_create_one_menuitem (item,
2612 item->contents ? 0 : select_cb,
2613 highlight_cb,
2614 cl_data,
2615 &group);
2617 /* Create a possibly empty submenu for menu bar items, since some
2618 themes don't highlight items correctly without it. */
2619 if (item->contents || menu_bar_p)
2621 GtkWidget *submenu = create_menus (item->contents,
2623 select_cb,
2624 deactivate_cb,
2625 highlight_cb,
2629 cl_data,
2631 gtk_menu_item_set_submenu (GTK_MENU_ITEM (w), submenu);
2635 gtk_menu_shell_append (GTK_MENU_SHELL (wmenu), w);
2636 gtk_widget_set_name (w, MENU_ITEM_NAME);
2639 return wmenu;
2642 /* Create a menubar, popup menu or dialog, depending on the TYPE argument.
2643 TYPE can be "menubar", "popup" for popup menu, or "dialog" for a dialog
2644 with some text and buttons.
2645 F is the frame the created item belongs to.
2646 NAME is the name to use for the top widget.
2647 VAL is a widget_value structure describing items to be created.
2648 SELECT_CB is the callback to use when a menu item is selected or
2649 a dialog button is pressed.
2650 DEACTIVATE_CB is the callback to use when an item is deactivated.
2651 For a menu, when a sub menu is not shown anymore, for a dialog it is
2652 called when the dialog is popped down.
2653 HIGHLIGHT_CB is the callback to call when entering/leaving menu items.
2655 Returns the widget created. */
2657 GtkWidget *
2658 xg_create_widget (const char *type, const char *name, struct frame *f,
2659 widget_value *val, GCallback select_cb,
2660 GCallback deactivate_cb, GCallback highlight_cb)
2662 GtkWidget *w = 0;
2663 bool menu_bar_p = strcmp (type, "menubar") == 0;
2664 bool pop_up_p = strcmp (type, "popup") == 0;
2666 if (strcmp (type, "dialog") == 0)
2668 w = create_dialog (val, select_cb, deactivate_cb);
2669 xg_set_screen (w, f);
2670 gtk_window_set_transient_for (GTK_WINDOW (w),
2671 GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)));
2672 gtk_window_set_destroy_with_parent (GTK_WINDOW (w), TRUE);
2673 gtk_widget_set_name (w, "emacs-dialog");
2674 gtk_window_set_modal (GTK_WINDOW (w), TRUE);
2676 else if (menu_bar_p || pop_up_p)
2678 w = create_menus (val->contents,
2680 select_cb,
2681 deactivate_cb,
2682 highlight_cb,
2683 pop_up_p,
2684 menu_bar_p,
2687 name);
2689 /* Set the cursor to an arrow for popup menus when they are mapped.
2690 This is done by default for menu bar menus. */
2691 if (pop_up_p)
2693 /* Must realize so the GdkWindow inside the widget is created. */
2694 gtk_widget_realize (w);
2695 xg_set_cursor (w, FRAME_DISPLAY_INFO (f)->xg_cursor);
2698 else
2700 fprintf (stderr, "bad type in xg_create_widget: %s, doing nothing\n",
2701 type);
2704 return w;
2707 /* Return the label for menu item WITEM. */
2709 static const char *
2710 xg_get_menu_item_label (GtkMenuItem *witem)
2712 GtkLabel *wlabel = GTK_LABEL (XG_BIN_CHILD (witem));
2713 return gtk_label_get_label (wlabel);
2716 /* Return true if the menu item WITEM has the text LABEL. */
2718 static bool
2719 xg_item_label_same_p (GtkMenuItem *witem, const char *label)
2721 bool is_same = 0;
2722 char *utf8_label = get_utf8_string (label);
2723 const char *old_label = witem ? xg_get_menu_item_label (witem) : 0;
2725 if (! old_label && ! utf8_label)
2726 is_same = 1;
2727 else if (old_label && utf8_label)
2728 is_same = strcmp (utf8_label, old_label) == 0;
2730 if (utf8_label) g_free (utf8_label);
2732 return is_same;
2735 /* Destroy widgets in LIST. */
2737 static void
2738 xg_destroy_widgets (GList *list)
2740 GList *iter;
2742 for (iter = list; iter; iter = g_list_next (iter))
2744 GtkWidget *w = GTK_WIDGET (iter->data);
2746 /* Destroying the widget will remove it from the container it is in. */
2747 gtk_widget_destroy (w);
2751 /* Update the top level names in MENUBAR (i.e. not submenus).
2752 F is the frame the menu bar belongs to.
2753 *LIST is a list with the current menu bar names (menu item widgets).
2754 ITER is the item within *LIST that shall be updated.
2755 POS is the numerical position, starting at 0, of ITER in *LIST.
2756 VAL describes what the menu bar shall look like after the update.
2757 SELECT_CB is the callback to use when a menu item is selected.
2758 HIGHLIGHT_CB is the callback to call when entering/leaving menu items.
2759 CL_DATA points to the callback data to be used for this menu bar.
2761 This function calls itself to walk through the menu bar names. */
2763 static void
2764 xg_update_menubar (GtkWidget *menubar,
2765 struct frame *f,
2766 GList **list,
2767 GList *iter,
2768 int pos,
2769 widget_value *val,
2770 GCallback select_cb,
2771 GCallback deactivate_cb,
2772 GCallback highlight_cb,
2773 xg_menu_cb_data *cl_data)
2775 if (! iter && ! val)
2776 return;
2777 else if (iter && ! val)
2779 /* Item(s) have been removed. Remove all remaining items. */
2780 xg_destroy_widgets (iter);
2782 /* Add a blank entry so the menubar doesn't collapse to nothing. */
2783 gtk_menu_shell_insert (GTK_MENU_SHELL (menubar),
2784 gtk_menu_item_new_with_label (""),
2786 /* All updated. */
2787 val = 0;
2788 iter = 0;
2790 else if (! iter && val)
2792 /* Item(s) added. Add all new items in one call. */
2793 create_menus (val, f, select_cb, deactivate_cb, highlight_cb,
2794 0, 1, menubar, cl_data, 0);
2796 /* All updated. */
2797 val = 0;
2798 iter = 0;
2800 /* Below this neither iter or val is NULL */
2801 else if (xg_item_label_same_p (GTK_MENU_ITEM (iter->data), val->name))
2803 /* This item is still the same, check next item. */
2804 val = val->next;
2805 iter = g_list_next (iter);
2806 ++pos;
2808 else /* This item is changed. */
2810 GtkMenuItem *witem = GTK_MENU_ITEM (iter->data);
2811 GtkMenuItem *witem2 = 0;
2812 bool val_in_menubar = 0;
2813 bool iter_in_new_menubar = 0;
2814 GList *iter2;
2815 widget_value *cur;
2817 /* See if the changed entry (val) is present later in the menu bar */
2818 for (iter2 = iter;
2819 iter2 && ! val_in_menubar;
2820 iter2 = g_list_next (iter2))
2822 witem2 = GTK_MENU_ITEM (iter2->data);
2823 val_in_menubar = xg_item_label_same_p (witem2, val->name);
2826 /* See if the current entry (iter) is present later in the
2827 specification for the new menu bar. */
2828 for (cur = val; cur && ! iter_in_new_menubar; cur = cur->next)
2829 iter_in_new_menubar = xg_item_label_same_p (witem, cur->name);
2831 if (val_in_menubar && ! iter_in_new_menubar)
2833 int nr = pos;
2835 /* This corresponds to:
2836 Current: A B C
2837 New: A C
2838 Remove B. */
2840 g_object_ref (G_OBJECT (witem));
2841 gtk_container_remove (GTK_CONTAINER (menubar), GTK_WIDGET (witem));
2842 gtk_widget_destroy (GTK_WIDGET (witem));
2844 /* Must get new list since the old changed. */
2845 g_list_free (*list);
2846 *list = iter = gtk_container_get_children (GTK_CONTAINER (menubar));
2847 while (nr-- > 0) iter = g_list_next (iter);
2849 else if (! val_in_menubar && ! iter_in_new_menubar)
2851 /* This corresponds to:
2852 Current: A B C
2853 New: A X C
2854 Rename B to X. This might seem to be a strange thing to do,
2855 since if there is a menu under B it will be totally wrong for X.
2856 But consider editing a C file. Then there is a C-mode menu
2857 (corresponds to B above).
2858 If then doing C-x C-f the minibuf menu (X above) replaces the
2859 C-mode menu. When returning from the minibuffer, we get
2860 back the C-mode menu. Thus we do:
2861 Rename B to X (C-mode to minibuf menu)
2862 Rename X to B (minibuf to C-mode menu).
2863 If the X menu hasn't been invoked, the menu under B
2864 is up to date when leaving the minibuffer. */
2865 GtkLabel *wlabel = GTK_LABEL (XG_BIN_CHILD (witem));
2866 char *utf8_label = get_utf8_string (val->name);
2868 /* GTK menu items don't notice when their labels have been
2869 changed from underneath them, so we have to explicitly
2870 use g_object_notify to tell listeners (e.g., a GMenuModel
2871 bridge that might be loaded) that the item's label has
2872 changed. */
2873 gtk_label_set_text (wlabel, utf8_label);
2874 #if GTK_CHECK_VERSION (2, 16, 0)
2875 g_object_notify (G_OBJECT (witem), "label");
2876 #endif
2877 if (utf8_label) g_free (utf8_label);
2878 iter = g_list_next (iter);
2879 val = val->next;
2880 ++pos;
2882 else if (! val_in_menubar && iter_in_new_menubar)
2884 /* This corresponds to:
2885 Current: A B C
2886 New: A X B C
2887 Insert X. */
2889 int nr = pos;
2890 GSList *group = 0;
2891 GtkWidget *w = xg_create_one_menuitem (val,
2893 select_cb,
2894 highlight_cb,
2895 cl_data,
2896 &group);
2898 /* Create a possibly empty submenu for menu bar items, since some
2899 themes don't highlight items correctly without it. */
2900 GtkWidget *submenu = create_menus (NULL, f,
2901 select_cb, deactivate_cb,
2902 highlight_cb,
2903 0, 0, 0, cl_data, 0);
2905 gtk_widget_set_name (w, MENU_ITEM_NAME);
2906 gtk_menu_shell_insert (GTK_MENU_SHELL (menubar), w, pos);
2907 gtk_menu_item_set_submenu (GTK_MENU_ITEM (w), submenu);
2909 g_list_free (*list);
2910 *list = iter = gtk_container_get_children (GTK_CONTAINER (menubar));
2911 while (nr-- > 0) iter = g_list_next (iter);
2912 iter = g_list_next (iter);
2913 val = val->next;
2914 ++pos;
2916 else /* if (val_in_menubar && iter_in_new_menubar) */
2918 int nr = pos;
2919 /* This corresponds to:
2920 Current: A B C
2921 New: A C B
2922 Move C before B */
2924 g_object_ref (G_OBJECT (witem2));
2925 gtk_container_remove (GTK_CONTAINER (menubar), GTK_WIDGET (witem2));
2926 gtk_menu_shell_insert (GTK_MENU_SHELL (menubar),
2927 GTK_WIDGET (witem2), pos);
2928 g_object_unref (G_OBJECT (witem2));
2930 g_list_free (*list);
2931 *list = iter = gtk_container_get_children (GTK_CONTAINER (menubar));
2932 while (nr-- > 0) iter = g_list_next (iter);
2933 if (iter) iter = g_list_next (iter);
2934 val = val->next;
2935 ++pos;
2939 /* Update the rest of the menu bar. */
2940 xg_update_menubar (menubar, f, list, iter, pos, val,
2941 select_cb, deactivate_cb, highlight_cb, cl_data);
2944 /* Update the menu item W so it corresponds to VAL.
2945 SELECT_CB is the callback to use when a menu item is selected.
2946 HIGHLIGHT_CB is the callback to call when entering/leaving menu items.
2947 CL_DATA is the data to set in the widget for menu invocation. */
2949 static void
2950 xg_update_menu_item (widget_value *val,
2951 GtkWidget *w,
2952 GCallback select_cb,
2953 GCallback highlight_cb,
2954 xg_menu_cb_data *cl_data)
2956 GtkWidget *wchild;
2957 GtkLabel *wlbl = 0;
2958 GtkLabel *wkey = 0;
2959 char *utf8_label;
2960 char *utf8_key;
2961 const char *old_label = 0;
2962 const char *old_key = 0;
2963 xg_menu_item_cb_data *cb_data;
2964 bool label_changed = false;
2966 wchild = XG_BIN_CHILD (w);
2967 utf8_label = get_utf8_string (val->name);
2968 utf8_key = get_utf8_string (val->key);
2970 /* See if W is a menu item with a key. See make_menu_item above. */
2971 if (GTK_IS_BOX (wchild))
2973 GList *list = gtk_container_get_children (GTK_CONTAINER (wchild));
2975 wlbl = GTK_LABEL (list->data);
2976 wkey = GTK_LABEL (list->next->data);
2977 g_list_free (list);
2979 if (! utf8_key)
2981 /* Remove the key and keep just the label. */
2982 g_object_ref (G_OBJECT (wlbl));
2983 gtk_container_remove (GTK_CONTAINER (w), wchild);
2984 gtk_container_add (GTK_CONTAINER (w), GTK_WIDGET (wlbl));
2985 g_object_unref (G_OBJECT (wlbl));
2986 wkey = 0;
2990 else /* Just a label. */
2992 wlbl = GTK_LABEL (wchild);
2994 /* Check if there is now a key. */
2995 if (utf8_key)
2997 GtkWidget *wtoadd = make_widget_for_menu_item (utf8_label, utf8_key);
2998 GList *list = gtk_container_get_children (GTK_CONTAINER (wtoadd));
3000 wlbl = GTK_LABEL (list->data);
3001 wkey = GTK_LABEL (list->next->data);
3002 g_list_free (list);
3004 gtk_container_remove (GTK_CONTAINER (w), wchild);
3005 gtk_container_add (GTK_CONTAINER (w), wtoadd);
3009 if (wkey) old_key = gtk_label_get_label (wkey);
3010 if (wlbl) old_label = gtk_label_get_label (wlbl);
3012 if (wkey && utf8_key && (! old_key || strcmp (utf8_key, old_key) != 0))
3014 label_changed = true;
3015 gtk_label_set_text (wkey, utf8_key);
3018 if (! old_label || strcmp (utf8_label, old_label) != 0)
3020 label_changed = true;
3021 gtk_label_set_text (wlbl, utf8_label);
3024 if (utf8_key) g_free (utf8_key);
3025 if (utf8_label) g_free (utf8_label);
3027 if (! val->enabled && gtk_widget_get_sensitive (w))
3028 gtk_widget_set_sensitive (w, FALSE);
3029 else if (val->enabled && ! gtk_widget_get_sensitive (w))
3030 gtk_widget_set_sensitive (w, TRUE);
3032 cb_data = g_object_get_data (G_OBJECT (w), XG_ITEM_DATA);
3033 if (cb_data)
3035 cb_data->call_data = val->call_data;
3036 cb_data->help = val->help;
3037 cb_data->cl_data = cl_data;
3039 /* We assume the callback functions don't change. */
3040 if (val->call_data && ! val->contents)
3042 /* This item shall have a select callback. */
3043 if (! cb_data->select_id)
3044 cb_data->select_id
3045 = g_signal_connect (G_OBJECT (w), "activate",
3046 select_cb, cb_data);
3048 else if (cb_data->select_id)
3050 g_signal_handler_disconnect (w, cb_data->select_id);
3051 cb_data->select_id = 0;
3055 #if GTK_CHECK_VERSION (2, 16, 0)
3056 if (label_changed) /* See comment in xg_update_menubar. */
3057 g_object_notify (G_OBJECT (w), "label");
3058 #endif
3061 /* Update the toggle menu item W so it corresponds to VAL. */
3063 static void
3064 xg_update_toggle_item (widget_value *val, GtkWidget *w)
3066 gtk_check_menu_item_set_active (GTK_CHECK_MENU_ITEM (w), val->selected);
3069 /* Update the radio menu item W so it corresponds to VAL. */
3071 static void
3072 xg_update_radio_item (widget_value *val, GtkWidget *w)
3074 gtk_check_menu_item_set_active (GTK_CHECK_MENU_ITEM (w), val->selected);
3077 /* Update the sub menu SUBMENU and all its children so it corresponds to VAL.
3078 SUBMENU may be NULL, in that case a new menu is created.
3079 F is the frame the menu bar belongs to.
3080 VAL describes the contents of the menu bar.
3081 SELECT_CB is the callback to use when a menu item is selected.
3082 DEACTIVATE_CB is the callback to use when a sub menu is not shown anymore.
3083 HIGHLIGHT_CB is the callback to call when entering/leaving menu items.
3084 CL_DATA is the call back data to use for any newly created items.
3086 Returns the updated submenu widget, that is SUBMENU unless SUBMENU
3087 was NULL. */
3089 static GtkWidget *
3090 xg_update_submenu (GtkWidget *submenu,
3091 struct frame *f,
3092 widget_value *val,
3093 GCallback select_cb,
3094 GCallback deactivate_cb,
3095 GCallback highlight_cb,
3096 xg_menu_cb_data *cl_data)
3098 GtkWidget *newsub = submenu;
3099 GList *list = 0;
3100 GList *iter;
3101 widget_value *cur;
3102 GList *first_radio = 0;
3104 if (submenu)
3105 list = gtk_container_get_children (GTK_CONTAINER (submenu));
3107 for (cur = val, iter = list;
3108 cur && iter;
3109 iter = g_list_next (iter), cur = cur->next)
3111 GtkWidget *w = GTK_WIDGET (iter->data);
3113 /* Remember first radio button in a group. If we get a mismatch in
3114 a radio group we must rebuild the whole group so that the connections
3115 in GTK becomes correct. */
3116 if (cur->button_type == BUTTON_TYPE_RADIO && ! first_radio)
3117 first_radio = iter;
3118 else if (cur->button_type != BUTTON_TYPE_RADIO
3119 && ! GTK_IS_RADIO_MENU_ITEM (w))
3120 first_radio = 0;
3122 if (GTK_IS_SEPARATOR_MENU_ITEM (w))
3124 if (! menu_separator_name_p (cur->name))
3125 break;
3127 else if (GTK_IS_CHECK_MENU_ITEM (w))
3129 if (cur->button_type != BUTTON_TYPE_TOGGLE)
3130 break;
3131 xg_update_toggle_item (cur, w);
3132 xg_update_menu_item (cur, w, select_cb, highlight_cb, cl_data);
3134 else if (GTK_IS_RADIO_MENU_ITEM (w))
3136 if (cur->button_type != BUTTON_TYPE_RADIO)
3137 break;
3138 xg_update_radio_item (cur, w);
3139 xg_update_menu_item (cur, w, select_cb, highlight_cb, cl_data);
3141 else if (GTK_IS_MENU_ITEM (w))
3143 GtkMenuItem *witem = GTK_MENU_ITEM (w);
3144 GtkWidget *sub;
3146 if (cur->button_type != BUTTON_TYPE_NONE ||
3147 menu_separator_name_p (cur->name))
3148 break;
3150 xg_update_menu_item (cur, w, select_cb, highlight_cb, cl_data);
3152 sub = gtk_menu_item_get_submenu (witem);
3153 if (sub && ! cur->contents)
3155 /* Not a submenu anymore. */
3156 g_object_ref (G_OBJECT (sub));
3157 remove_submenu (witem);
3158 gtk_widget_destroy (sub);
3160 else if (cur->contents)
3162 GtkWidget *nsub;
3164 nsub = xg_update_submenu (sub, f, cur->contents,
3165 select_cb, deactivate_cb,
3166 highlight_cb, cl_data);
3168 /* If this item just became a submenu, we must set it. */
3169 if (nsub != sub)
3170 gtk_menu_item_set_submenu (witem, nsub);
3173 else
3175 /* Structural difference. Remove everything from here and down
3176 in SUBMENU. */
3177 break;
3181 /* Remove widgets from first structural change. */
3182 if (iter)
3184 /* If we are adding new menu items below, we must remove from
3185 first radio button so that radio groups become correct. */
3186 if (cur && first_radio) xg_destroy_widgets (first_radio);
3187 else xg_destroy_widgets (iter);
3190 if (cur)
3192 /* More items added. Create them. */
3193 newsub = create_menus (cur,
3195 select_cb,
3196 deactivate_cb,
3197 highlight_cb,
3200 submenu,
3201 cl_data,
3205 if (list) g_list_free (list);
3207 return newsub;
3210 /* Update the MENUBAR.
3211 F is the frame the menu bar belongs to.
3212 VAL describes the contents of the menu bar.
3213 If DEEP_P, rebuild all but the top level menu names in
3214 the MENUBAR. If DEEP_P is zero, just rebuild the names in the menubar.
3215 SELECT_CB is the callback to use when a menu item is selected.
3216 DEACTIVATE_CB is the callback to use when a sub menu is not shown anymore.
3217 HIGHLIGHT_CB is the callback to call when entering/leaving menu items. */
3219 void
3220 xg_modify_menubar_widgets (GtkWidget *menubar, struct frame *f,
3221 widget_value *val, bool deep_p,
3222 GCallback select_cb, GCallback deactivate_cb,
3223 GCallback highlight_cb)
3225 xg_menu_cb_data *cl_data;
3226 GList *list = gtk_container_get_children (GTK_CONTAINER (menubar));
3228 if (! list) return;
3230 cl_data = g_object_get_data (G_OBJECT (menubar), XG_FRAME_DATA);
3232 xg_update_menubar (menubar, f, &list, list, 0, val->contents,
3233 select_cb, deactivate_cb, highlight_cb, cl_data);
3235 if (deep_p)
3237 widget_value *cur;
3239 /* Update all sub menus.
3240 We must keep the submenus (GTK menu item widgets) since the
3241 X Window in the XEvent that activates the menu are those widgets. */
3243 /* Update cl_data, menu_item things in F may have changed. */
3244 update_cl_data (cl_data, f, highlight_cb);
3246 for (cur = val->contents; cur; cur = cur->next)
3248 GList *iter;
3249 GtkWidget *sub = 0;
3250 GtkWidget *newsub;
3251 GtkMenuItem *witem = 0;
3253 /* Find sub menu that corresponds to val and update it. */
3254 for (iter = list ; iter; iter = g_list_next (iter))
3256 witem = GTK_MENU_ITEM (iter->data);
3257 if (xg_item_label_same_p (witem, cur->name))
3259 sub = gtk_menu_item_get_submenu (witem);
3260 break;
3264 newsub = xg_update_submenu (sub,
3266 cur->contents,
3267 select_cb,
3268 deactivate_cb,
3269 highlight_cb,
3270 cl_data);
3271 /* sub may still be NULL. If we just updated non deep and added
3272 a new menu bar item, it has no sub menu yet. So we set the
3273 newly created sub menu under witem. */
3274 if (newsub != sub && witem != 0)
3276 xg_set_screen (newsub, f);
3277 gtk_menu_item_set_submenu (witem, newsub);
3282 g_list_free (list);
3283 gtk_widget_show_all (menubar);
3286 /* Callback called when the menu bar W is mapped.
3287 Used to find the height of the menu bar if we didn't get it
3288 after showing the widget. */
3290 static void
3291 menubar_map_cb (GtkWidget *w, gpointer user_data)
3293 GtkRequisition req;
3294 struct frame *f = user_data;
3295 gtk_widget_get_preferred_size (w, NULL, &req);
3296 if (FRAME_MENUBAR_HEIGHT (f) != req.height)
3298 FRAME_MENUBAR_HEIGHT (f) = req.height;
3299 adjust_frame_size (f, -1, -1, 2, 0, Qmenu_bar_lines);
3303 /* Recompute all the widgets of frame F, when the menu bar has been
3304 changed. */
3306 void
3307 xg_update_frame_menubar (struct frame *f)
3309 struct x_output *x = f->output_data.x;
3310 GtkRequisition req;
3312 if (!x->menubar_widget || gtk_widget_get_mapped (x->menubar_widget))
3313 return;
3315 if (x->menubar_widget && gtk_widget_get_parent (x->menubar_widget))
3316 return; /* Already done this, happens for frames created invisible. */
3318 block_input ();
3320 gtk_box_pack_start (GTK_BOX (x->vbox_widget), x->menubar_widget,
3321 FALSE, FALSE, 0);
3322 gtk_box_reorder_child (GTK_BOX (x->vbox_widget), x->menubar_widget, 0);
3324 g_signal_connect (x->menubar_widget, "map", G_CALLBACK (menubar_map_cb), f);
3325 gtk_widget_show_all (x->menubar_widget);
3326 gtk_widget_get_preferred_size (x->menubar_widget, NULL, &req);
3328 if (FRAME_MENUBAR_HEIGHT (f) != req.height)
3330 FRAME_MENUBAR_HEIGHT (f) = req.height;
3331 adjust_frame_size (f, -1, -1, 2, 0, Qmenu_bar_lines);
3333 unblock_input ();
3336 /* Get rid of the menu bar of frame F, and free its storage.
3337 This is used when deleting a frame, and when turning off the menu bar. */
3339 void
3340 free_frame_menubar (struct frame *f)
3342 struct x_output *x = f->output_data.x;
3344 if (x->menubar_widget)
3346 block_input ();
3348 gtk_container_remove (GTK_CONTAINER (x->vbox_widget), x->menubar_widget);
3349 /* The menubar and its children shall be deleted when removed from
3350 the container. */
3351 x->menubar_widget = 0;
3352 FRAME_MENUBAR_HEIGHT (f) = 0;
3353 adjust_frame_size (f, -1, -1, 2, 0, Qmenu_bar_lines);
3354 unblock_input ();
3358 bool
3359 xg_event_is_for_menubar (struct frame *f, const XEvent *event)
3361 struct x_output *x = f->output_data.x;
3362 GList *iter;
3363 GdkRectangle rec;
3364 GList *list;
3365 GdkDisplay *gdpy;
3366 GdkWindow *gw;
3367 GdkEvent gevent;
3368 GtkWidget *gwdesc;
3370 if (! x->menubar_widget) return 0;
3372 if (! (event->xbutton.x >= 0
3373 && event->xbutton.x < FRAME_PIXEL_WIDTH (f)
3374 && event->xbutton.y >= 0
3375 && event->xbutton.y < FRAME_MENUBAR_HEIGHT (f)
3376 && event->xbutton.same_screen))
3377 return 0;
3379 gdpy = gdk_x11_lookup_xdisplay (FRAME_X_DISPLAY (f));
3380 gw = gdk_x11_window_lookup_for_display (gdpy, event->xbutton.window);
3381 if (! gw) return 0;
3382 gevent.any.window = gw;
3383 gevent.any.type = GDK_NOTHING;
3384 gwdesc = gtk_get_event_widget (&gevent);
3385 if (! gwdesc) return 0;
3386 if (! GTK_IS_MENU_BAR (gwdesc)
3387 && ! GTK_IS_MENU_ITEM (gwdesc)
3388 && ! gtk_widget_is_ancestor (x->menubar_widget, gwdesc))
3389 return 0;
3391 list = gtk_container_get_children (GTK_CONTAINER (x->menubar_widget));
3392 if (! list) return 0;
3393 rec.x = event->xbutton.x;
3394 rec.y = event->xbutton.y;
3395 rec.width = 1;
3396 rec.height = 1;
3398 for (iter = list ; iter; iter = g_list_next (iter))
3400 GtkWidget *w = GTK_WIDGET (iter->data);
3401 if (gtk_widget_get_mapped (w) && gtk_widget_intersect (w, &rec, NULL))
3402 break;
3404 g_list_free (list);
3405 return iter != 0;
3410 /***********************************************************************
3411 Scroll bar functions
3412 ***********************************************************************/
3415 /* Setting scroll bar values invokes the callback. Use this variable
3416 to indicate that callback should do nothing. */
3418 bool xg_ignore_gtk_scrollbar;
3420 /* Width and height of scroll bars for the current theme. */
3421 static int scroll_bar_width_for_theme;
3422 static int scroll_bar_height_for_theme;
3424 /* Xlib's `Window' fits in 32 bits. But we want to store pointers, and they
3425 may be larger than 32 bits. Keep a mapping from integer index to widget
3426 pointers to get around the 32 bit limitation. */
3428 static struct
3430 GtkWidget **widgets;
3431 ptrdiff_t max_size;
3432 ptrdiff_t used;
3433 } id_to_widget;
3435 /* Grow this much every time we need to allocate more */
3437 #define ID_TO_WIDGET_INCR 32
3439 /* Store the widget pointer W in id_to_widget and return the integer index. */
3441 static ptrdiff_t
3442 xg_store_widget_in_map (GtkWidget *w)
3444 ptrdiff_t i;
3446 if (id_to_widget.max_size == id_to_widget.used)
3448 ptrdiff_t new_size;
3449 if (TYPE_MAXIMUM (Window) - ID_TO_WIDGET_INCR < id_to_widget.max_size)
3450 memory_full (SIZE_MAX);
3452 new_size = id_to_widget.max_size + ID_TO_WIDGET_INCR;
3453 id_to_widget.widgets = xnrealloc (id_to_widget.widgets,
3454 new_size, sizeof (GtkWidget *));
3456 for (i = id_to_widget.max_size; i < new_size; ++i)
3457 id_to_widget.widgets[i] = 0;
3458 id_to_widget.max_size = new_size;
3461 /* Just loop over the array and find a free place. After all,
3462 how many scroll bars are we creating? Should be a small number.
3463 The check above guarantees we will find a free place. */
3464 for (i = 0; i < id_to_widget.max_size; ++i)
3466 if (! id_to_widget.widgets[i])
3468 id_to_widget.widgets[i] = w;
3469 ++id_to_widget.used;
3471 return i;
3475 /* Should never end up here */
3476 emacs_abort ();
3479 /* Remove pointer at IDX from id_to_widget.
3480 Called when scroll bar is destroyed. */
3482 static void
3483 xg_remove_widget_from_map (ptrdiff_t idx)
3485 if (idx < id_to_widget.max_size && id_to_widget.widgets[idx] != 0)
3487 id_to_widget.widgets[idx] = 0;
3488 --id_to_widget.used;
3492 /* Get the widget pointer at IDX from id_to_widget. */
3494 static GtkWidget *
3495 xg_get_widget_from_map (ptrdiff_t idx)
3497 if (idx < id_to_widget.max_size && id_to_widget.widgets[idx] != 0)
3498 return id_to_widget.widgets[idx];
3500 return 0;
3503 static void
3504 update_theme_scrollbar_width (void)
3506 #ifdef HAVE_GTK3
3507 GtkAdjustment *vadj;
3508 #else
3509 GtkObject *vadj;
3510 #endif
3511 GtkWidget *wscroll;
3512 int w = 0, b = 0;
3514 vadj = gtk_adjustment_new (XG_SB_MIN, XG_SB_MIN, XG_SB_MAX, 0.1, 0.1, 0.1);
3515 wscroll = gtk_scrollbar_new (GTK_ORIENTATION_VERTICAL, GTK_ADJUSTMENT (vadj));
3516 g_object_ref_sink (G_OBJECT (wscroll));
3517 gtk_widget_style_get (wscroll, "slider-width", &w, "trough-border", &b, NULL);
3518 gtk_widget_destroy (wscroll);
3519 g_object_unref (G_OBJECT (wscroll));
3520 w += 2*b;
3521 #ifndef HAVE_GTK3
3522 if (w < 16) w = 16;
3523 #endif
3524 scroll_bar_width_for_theme = w;
3527 static void
3528 update_theme_scrollbar_height (void)
3530 #ifdef HAVE_GTK3
3531 GtkAdjustment *hadj;
3532 #else
3533 GtkObject *hadj;
3534 #endif
3535 GtkWidget *wscroll;
3536 int w = 0, b = 0;
3538 hadj = gtk_adjustment_new (YG_SB_MIN, YG_SB_MIN, YG_SB_MAX, 0.1, 0.1, 0.1);
3539 wscroll = gtk_scrollbar_new (GTK_ORIENTATION_HORIZONTAL, GTK_ADJUSTMENT (hadj));
3540 g_object_ref_sink (G_OBJECT (wscroll));
3541 gtk_widget_style_get (wscroll, "slider-width", &w, "trough-border", &b, NULL);
3542 gtk_widget_destroy (wscroll);
3543 g_object_unref (G_OBJECT (wscroll));
3544 w += 2*b;
3545 if (w < 12) w = 12;
3546 scroll_bar_height_for_theme = w;
3550 xg_get_default_scrollbar_width (void)
3552 return scroll_bar_width_for_theme;
3556 xg_get_default_scrollbar_height (void)
3558 /* Apparently there's no default height for themes. */
3559 return scroll_bar_width_for_theme;
3562 /* Return the scrollbar id for X Window WID on display DPY.
3563 Return -1 if WID not in id_to_widget. */
3565 ptrdiff_t
3566 xg_get_scroll_id_for_window (Display *dpy, Window wid)
3568 ptrdiff_t idx;
3569 GtkWidget *w;
3571 w = xg_win_to_widget (dpy, wid);
3573 if (w)
3575 for (idx = 0; idx < id_to_widget.max_size; ++idx)
3576 if (id_to_widget.widgets[idx] == w)
3577 return idx;
3580 return -1;
3583 /* Callback invoked when scroll bar WIDGET is destroyed.
3584 DATA is the index into id_to_widget for WIDGET.
3585 We free pointer to last scroll bar values here and remove the index. */
3587 static void
3588 xg_gtk_scroll_destroy (GtkWidget *widget, gpointer data)
3590 intptr_t id = (intptr_t) data;
3591 xg_remove_widget_from_map (id);
3594 /* Create a scroll bar widget for frame F. Store the scroll bar
3595 in BAR.
3596 SCROLL_CALLBACK is the callback to invoke when the value of the
3597 bar changes.
3598 END_CALLBACK is the callback to invoke when scrolling ends.
3599 SCROLL_BAR_NAME is the name we use for the scroll bar. Can be used
3600 to set resources for the widget. */
3602 void
3603 xg_create_scroll_bar (struct frame *f,
3604 struct scroll_bar *bar,
3605 GCallback scroll_callback,
3606 GCallback end_callback,
3607 const char *scroll_bar_name)
3609 GtkWidget *wscroll;
3610 GtkWidget *webox;
3611 intptr_t scroll_id;
3612 #ifdef HAVE_GTK3
3613 GtkAdjustment *vadj;
3614 #else
3615 GtkObject *vadj;
3616 #endif
3618 /* Page, step increment values are not so important here, they
3619 will be corrected in x_set_toolkit_scroll_bar_thumb. */
3620 vadj = gtk_adjustment_new (XG_SB_MIN, XG_SB_MIN, XG_SB_MAX,
3621 0.1, 0.1, 0.1);
3623 wscroll = gtk_scrollbar_new (GTK_ORIENTATION_VERTICAL, GTK_ADJUSTMENT (vadj));
3624 webox = gtk_event_box_new ();
3625 gtk_widget_set_name (wscroll, scroll_bar_name);
3626 #ifndef HAVE_GTK3
3627 gtk_range_set_update_policy (GTK_RANGE (wscroll), GTK_UPDATE_CONTINUOUS);
3628 #endif
3629 g_object_set_data (G_OBJECT (wscroll), XG_FRAME_DATA, (gpointer)f);
3631 scroll_id = xg_store_widget_in_map (wscroll);
3633 g_signal_connect (G_OBJECT (wscroll),
3634 "destroy",
3635 G_CALLBACK (xg_gtk_scroll_destroy),
3636 (gpointer) scroll_id);
3637 g_signal_connect (G_OBJECT (wscroll),
3638 "change-value",
3639 scroll_callback,
3640 (gpointer) bar);
3641 g_signal_connect (G_OBJECT (wscroll),
3642 "button-release-event",
3643 end_callback,
3644 (gpointer) bar);
3646 /* The scroll bar widget does not draw on a window of its own. Instead
3647 it draws on the parent window, in this case the edit widget. So
3648 whenever the edit widget is cleared, the scroll bar needs to redraw
3649 also, which causes flicker. Put an event box between the edit widget
3650 and the scroll bar, so the scroll bar instead draws itself on the
3651 event box window. */
3652 gtk_fixed_put (GTK_FIXED (f->output_data.x->edit_widget), webox, -1, -1);
3653 gtk_container_add (GTK_CONTAINER (webox), wscroll);
3656 /* Set the cursor to an arrow. */
3657 xg_set_cursor (webox, FRAME_DISPLAY_INFO (f)->xg_cursor);
3659 bar->x_window = scroll_id;
3660 bar->horizontal = 0;
3663 /* Create a horizontal scroll bar widget for frame F. Store the scroll
3664 bar in BAR. SCROLL_CALLBACK is the callback to invoke when the value
3665 of the bar changes. END_CALLBACK is the callback to invoke when
3666 scrolling ends. SCROLL_BAR_NAME is the name we use for the scroll
3667 bar. Can be used to set resources for the widget. */
3669 void
3670 xg_create_horizontal_scroll_bar (struct frame *f,
3671 struct scroll_bar *bar,
3672 GCallback scroll_callback,
3673 GCallback end_callback,
3674 const char *scroll_bar_name)
3676 GtkWidget *wscroll;
3677 GtkWidget *webox;
3678 intptr_t scroll_id;
3679 #ifdef HAVE_GTK3
3680 GtkAdjustment *hadj;
3681 #else
3682 GtkObject *hadj;
3683 #endif
3685 /* Page, step increment values are not so important here, they
3686 will be corrected in x_set_toolkit_scroll_bar_thumb. */
3687 hadj = gtk_adjustment_new (YG_SB_MIN, YG_SB_MIN, YG_SB_MAX,
3688 0.1, 0.1, 0.1);
3690 wscroll = gtk_scrollbar_new (GTK_ORIENTATION_HORIZONTAL, GTK_ADJUSTMENT (hadj));
3691 webox = gtk_event_box_new ();
3692 gtk_widget_set_name (wscroll, scroll_bar_name);
3693 #ifndef HAVE_GTK3
3694 gtk_range_set_update_policy (GTK_RANGE (wscroll), GTK_UPDATE_CONTINUOUS);
3695 #endif
3696 g_object_set_data (G_OBJECT (wscroll), XG_FRAME_DATA, (gpointer)f);
3698 scroll_id = xg_store_widget_in_map (wscroll);
3700 g_signal_connect (G_OBJECT (wscroll),
3701 "destroy",
3702 G_CALLBACK (xg_gtk_scroll_destroy),
3703 (gpointer) scroll_id);
3704 g_signal_connect (G_OBJECT (wscroll),
3705 "change-value",
3706 scroll_callback,
3707 (gpointer) bar);
3708 g_signal_connect (G_OBJECT (wscroll),
3709 "button-release-event",
3710 end_callback,
3711 (gpointer) bar);
3713 /* The scroll bar widget does not draw on a window of its own. Instead
3714 it draws on the parent window, in this case the edit widget. So
3715 whenever the edit widget is cleared, the scroll bar needs to redraw
3716 also, which causes flicker. Put an event box between the edit widget
3717 and the scroll bar, so the scroll bar instead draws itself on the
3718 event box window. */
3719 gtk_fixed_put (GTK_FIXED (f->output_data.x->edit_widget), webox, -1, -1);
3720 gtk_container_add (GTK_CONTAINER (webox), wscroll);
3723 /* Set the cursor to an arrow. */
3724 xg_set_cursor (webox, FRAME_DISPLAY_INFO (f)->xg_cursor);
3726 bar->x_window = scroll_id;
3727 bar->horizontal = 1;
3730 /* Remove the scroll bar represented by SCROLLBAR_ID from the frame F. */
3732 void
3733 xg_remove_scroll_bar (struct frame *f, ptrdiff_t scrollbar_id)
3735 GtkWidget *w = xg_get_widget_from_map (scrollbar_id);
3736 if (w)
3738 GtkWidget *wparent = gtk_widget_get_parent (w);
3739 gtk_widget_destroy (w);
3740 gtk_widget_destroy (wparent);
3741 SET_FRAME_GARBAGED (f);
3745 /* Update the position of the vertical scroll bar represented by SCROLLBAR_ID
3746 in frame F.
3747 TOP/LEFT are the new pixel positions where the bar shall appear.
3748 WIDTH, HEIGHT is the size in pixels the bar shall have. */
3750 void
3751 xg_update_scrollbar_pos (struct frame *f,
3752 ptrdiff_t scrollbar_id,
3753 int top,
3754 int left,
3755 int width,
3756 int height)
3759 GtkWidget *wscroll = xg_get_widget_from_map (scrollbar_id);
3761 if (wscroll)
3763 GtkWidget *wfixed = f->output_data.x->edit_widget;
3764 GtkWidget *wparent = gtk_widget_get_parent (wscroll);
3765 gint msl;
3767 /* Clear out old position. */
3768 int oldx = -1, oldy = -1, oldw, oldh;
3769 if (gtk_widget_get_parent (wparent) == wfixed)
3771 gtk_container_child_get (GTK_CONTAINER (wfixed), wparent,
3772 "x", &oldx, "y", &oldy, NULL);
3773 gtk_widget_get_size_request (wscroll, &oldw, &oldh);
3776 /* Move and resize to new values. */
3777 gtk_fixed_move (GTK_FIXED (wfixed), wparent, left, top);
3778 gtk_widget_style_get (wscroll, "min-slider-length", &msl, NULL);
3779 if (msl > height)
3781 /* No room. Hide scroll bar as some themes output a warning if
3782 the height is less than the min size. */
3783 gtk_widget_hide (wparent);
3784 gtk_widget_hide (wscroll);
3786 else
3788 gtk_widget_show_all (wparent);
3789 gtk_widget_set_size_request (wscroll, width, height);
3791 gtk_widget_queue_draw (wfixed);
3792 gdk_window_process_all_updates ();
3793 if (oldx != -1 && oldw > 0 && oldh > 0)
3794 /* Clear under old scroll bar position. This must be done after
3795 the gtk_widget_queue_draw and gdk_window_process_all_updates
3796 above. */
3797 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3798 oldx, oldy, oldw, oldh);
3800 /* GTK does not redraw until the main loop is entered again, but
3801 if there are no X events pending we will not enter it. So we sync
3802 here to get some events. */
3804 x_sync (f);
3805 SET_FRAME_GARBAGED (f);
3806 cancel_mouse_face (f);
3811 /* Update the position of the horizontal scroll bar represented by SCROLLBAR_ID
3812 in frame F.
3813 TOP/LEFT are the new pixel positions where the bar shall appear.
3814 WIDTH, HEIGHT is the size in pixels the bar shall have. */
3816 void
3817 xg_update_horizontal_scrollbar_pos (struct frame *f,
3818 ptrdiff_t scrollbar_id,
3819 int top,
3820 int left,
3821 int width,
3822 int height)
3825 GtkWidget *wscroll = xg_get_widget_from_map (scrollbar_id);
3827 if (wscroll)
3829 GtkWidget *wfixed = f->output_data.x->edit_widget;
3830 GtkWidget *wparent = gtk_widget_get_parent (wscroll);
3831 gint msl;
3833 /* Clear out old position. */
3834 int oldx = -1, oldy = -1, oldw, oldh;
3835 if (gtk_widget_get_parent (wparent) == wfixed)
3837 gtk_container_child_get (GTK_CONTAINER (wfixed), wparent,
3838 "x", &oldx, "y", &oldy, NULL);
3839 gtk_widget_get_size_request (wscroll, &oldw, &oldh);
3842 /* Move and resize to new values. */
3843 gtk_fixed_move (GTK_FIXED (wfixed), wparent, left, top);
3844 gtk_widget_style_get (wscroll, "min-slider-length", &msl, NULL);
3845 if (msl > width)
3847 /* No room. Hide scroll bar as some themes output a warning if
3848 the width is less than the min size. */
3849 gtk_widget_hide (wparent);
3850 gtk_widget_hide (wscroll);
3852 else
3854 gtk_widget_show_all (wparent);
3855 gtk_widget_set_size_request (wscroll, width, height);
3857 gtk_widget_queue_draw (wfixed);
3858 gdk_window_process_all_updates ();
3859 if (oldx != -1 && oldw > 0 && oldh > 0)
3860 /* Clear under old scroll bar position. This must be done after
3861 the gtk_widget_queue_draw and gdk_window_process_all_updates
3862 above. */
3863 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3864 oldx, oldy, oldw, oldh);
3866 /* GTK does not redraw until the main loop is entered again, but
3867 if there are no X events pending we will not enter it. So we sync
3868 here to get some events. */
3870 x_sync (f);
3871 SET_FRAME_GARBAGED (f);
3872 cancel_mouse_face (f);
3877 /* Get the current value of the range, truncated to an integer. */
3879 static int
3880 int_gtk_range_get_value (GtkRange *range)
3882 return gtk_range_get_value (range);
3886 /* Set the thumb size and position of scroll bar BAR. We are currently
3887 displaying PORTION out of a whole WHOLE, and our position POSITION. */
3889 void
3890 xg_set_toolkit_scroll_bar_thumb (struct scroll_bar *bar,
3891 int portion,
3892 int position,
3893 int whole)
3895 GtkWidget *wscroll = xg_get_widget_from_map (bar->x_window);
3897 struct frame *f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
3899 if (wscroll && bar->dragging == -1)
3901 GtkAdjustment *adj;
3902 gdouble shown;
3903 gdouble top;
3904 int size, value;
3905 int old_size;
3906 int new_step;
3907 bool changed = 0;
3909 adj = gtk_range_get_adjustment (GTK_RANGE (wscroll));
3911 if (scroll_bar_adjust_thumb_portion_p)
3913 /* We do the same as for MOTIF in xterm.c, use 30 chars per
3914 line rather than the real portion value. This makes the
3915 thumb less likely to resize and that looks better. */
3916 portion = WINDOW_TOTAL_LINES (XWINDOW (bar->window)) * 30;
3918 /* When the thumb is at the bottom, position == whole.
3919 So we need to increase `whole' to make space for the thumb. */
3920 whole += portion;
3923 if (whole <= 0)
3924 top = 0, shown = 1;
3925 else
3927 top = (gdouble) position / whole;
3928 shown = (gdouble) portion / whole;
3931 size = clip_to_bounds (1, shown * XG_SB_RANGE, XG_SB_RANGE);
3932 value = clip_to_bounds (XG_SB_MIN, top * XG_SB_RANGE, XG_SB_MAX - size);
3934 /* Assume all lines are of equal size. */
3935 new_step = size / max (1, FRAME_LINES (f));
3937 old_size = gtk_adjustment_get_page_size (adj);
3938 if (old_size != size)
3940 int old_step = gtk_adjustment_get_step_increment (adj);
3941 if (old_step != new_step)
3943 gtk_adjustment_set_page_size (adj, size);
3944 gtk_adjustment_set_step_increment (adj, new_step);
3945 /* Assume a page increment is about 95% of the page size */
3946 gtk_adjustment_set_page_increment (adj, size - size / 20);
3947 changed = 1;
3951 if (changed || int_gtk_range_get_value (GTK_RANGE (wscroll)) != value)
3953 block_input ();
3955 /* gtk_range_set_value invokes the callback. Set
3956 ignore_gtk_scrollbar to make the callback do nothing */
3957 xg_ignore_gtk_scrollbar = 1;
3959 if (int_gtk_range_get_value (GTK_RANGE (wscroll)) != value)
3960 gtk_range_set_value (GTK_RANGE (wscroll), (gdouble)value);
3961 else if (changed)
3962 gtk_adjustment_changed (adj);
3964 xg_ignore_gtk_scrollbar = 0;
3966 unblock_input ();
3971 /* Set the thumb size and position of horizontal scroll bar BAR. We are
3972 currently displaying PORTION out of a whole WHOLE, and our position
3973 POSITION. */
3974 void
3975 xg_set_toolkit_horizontal_scroll_bar_thumb (struct scroll_bar *bar,
3976 int portion,
3977 int position,
3978 int whole)
3980 GtkWidget *wscroll = xg_get_widget_from_map (bar->x_window);
3982 if (wscroll && bar->dragging == -1)
3984 GtkAdjustment *adj;
3985 int lower = 0;
3986 int upper = max (whole - 1, 0);
3987 int pagesize = min (upper, max (portion, 0));
3988 int value = max (0, min (position, upper - pagesize));
3989 /* These should be set to something more <portion, whole>
3990 related. */
3991 int page_increment = 4;
3992 int step_increment = 1;
3994 block_input ();
3995 adj = gtk_range_get_adjustment (GTK_RANGE (wscroll));
3996 gtk_adjustment_configure (adj, (gdouble) value, (gdouble) lower,
3997 (gdouble) upper, (gdouble) step_increment,
3998 (gdouble) page_increment, (gdouble) pagesize);
3999 gtk_adjustment_changed (adj);
4000 unblock_input ();
4004 /* Return true if EVENT is for a scroll bar in frame F.
4005 When the same X window is used for several Gtk+ widgets, we cannot
4006 say for sure based on the X window alone if an event is for the
4007 frame. This function does additional checks. */
4009 bool
4010 xg_event_is_for_scrollbar (struct frame *f, const XEvent *event)
4012 bool retval = 0;
4014 if (f && event->type == ButtonPress && event->xbutton.button < 4)
4016 /* Check if press occurred outside the edit widget. */
4017 GdkDisplay *gdpy = gdk_x11_lookup_xdisplay (FRAME_X_DISPLAY (f));
4018 GdkWindow *gwin;
4019 #ifdef HAVE_GTK3
4020 GdkDevice *gdev = gdk_device_manager_get_client_pointer
4021 (gdk_display_get_device_manager (gdpy));
4022 gwin = gdk_device_get_window_at_position (gdev, NULL, NULL);
4023 #else
4024 gwin = gdk_display_get_window_at_pointer (gdpy, NULL, NULL);
4025 #endif
4026 retval = gwin != gtk_widget_get_window (f->output_data.x->edit_widget);
4028 else if (f
4029 && ((event->type == ButtonRelease && event->xbutton.button < 4)
4030 || event->type == MotionNotify))
4032 /* If we are releasing or moving the scroll bar, it has the grab. */
4033 GtkWidget *w = gtk_grab_get_current ();
4034 retval = w != 0 && GTK_IS_SCROLLBAR (w);
4037 return retval;
4042 /***********************************************************************
4043 Tool bar functions
4044 ***********************************************************************/
4045 /* The key for the data we put in the GtkImage widgets. The data is
4046 the image used by Emacs. We use this to see if we need to update
4047 the GtkImage with a new image. */
4048 #define XG_TOOL_BAR_IMAGE_DATA "emacs-tool-bar-image"
4050 /* The key for storing the latest modifiers so the activate callback can
4051 get them. */
4052 #define XG_TOOL_BAR_LAST_MODIFIER "emacs-tool-bar-modifier"
4054 /* The key for the data we put in the GtkImage widgets. The data is
4055 the stock name used by Emacs. We use this to see if we need to update
4056 the GtkImage with a new image. */
4057 #define XG_TOOL_BAR_STOCK_NAME "emacs-tool-bar-stock-name"
4059 /* As above, but this is used for named theme widgets, as opposed to
4060 stock items. */
4061 #define XG_TOOL_BAR_ICON_NAME "emacs-tool-bar-icon-name"
4063 /* Callback function invoked when a tool bar item is pressed.
4064 W is the button widget in the tool bar that got pressed,
4065 CLIENT_DATA is an integer that is the index of the button in the
4066 tool bar. 0 is the first button. */
4068 static gboolean
4069 xg_tool_bar_button_cb (GtkWidget *widget,
4070 GdkEventButton *event,
4071 gpointer user_data)
4073 intptr_t state = event->state;
4074 gpointer ptr = (gpointer) state;
4075 g_object_set_data (G_OBJECT (widget), XG_TOOL_BAR_LAST_MODIFIER, ptr);
4076 return FALSE;
4080 /* Callback function invoked when a tool bar item is pressed.
4081 W is the button widget in the tool bar that got pressed,
4082 CLIENT_DATA is an integer that is the index of the button in the
4083 tool bar. 0 is the first button. */
4085 static void
4086 xg_tool_bar_callback (GtkWidget *w, gpointer client_data)
4088 intptr_t idx = (intptr_t) client_data;
4089 gpointer gmod = g_object_get_data (G_OBJECT (w), XG_TOOL_BAR_LAST_MODIFIER);
4090 intptr_t mod = (intptr_t) gmod;
4092 struct frame *f = g_object_get_data (G_OBJECT (w), XG_FRAME_DATA);
4093 Lisp_Object key, frame;
4094 struct input_event event;
4095 EVENT_INIT (event);
4097 if (! f || ! f->n_tool_bar_items || NILP (f->tool_bar_items))
4098 return;
4100 idx *= TOOL_BAR_ITEM_NSLOTS;
4102 key = AREF (f->tool_bar_items, idx + TOOL_BAR_ITEM_KEY);
4103 XSETFRAME (frame, f);
4105 /* We generate two events here. The first one is to set the prefix
4106 to `(tool_bar)', see keyboard.c. */
4107 event.kind = TOOL_BAR_EVENT;
4108 event.frame_or_window = frame;
4109 event.arg = frame;
4110 kbd_buffer_store_event (&event);
4112 event.kind = TOOL_BAR_EVENT;
4113 event.frame_or_window = frame;
4114 event.arg = key;
4115 /* Convert between the modifier bits GDK uses and the modifier bits
4116 Emacs uses. This assumes GDK and X masks are the same, which they are when
4117 this is written. */
4118 event.modifiers = x_x_to_emacs_modifiers (FRAME_DISPLAY_INFO (f), mod);
4119 kbd_buffer_store_event (&event);
4121 /* Return focus to the frame after we have clicked on a detached
4122 tool bar button. */
4123 x_focus_frame (f);
4126 static GtkWidget *
4127 xg_get_tool_bar_widgets (GtkWidget *vb, GtkWidget **wimage)
4129 GList *clist = gtk_container_get_children (GTK_CONTAINER (vb));
4130 GtkWidget *c1 = clist->data;
4131 GtkWidget *c2 = clist->next ? clist->next->data : NULL;
4133 *wimage = GTK_IS_IMAGE (c1) ? c1 : c2;
4134 g_list_free (clist);
4135 return GTK_IS_LABEL (c1) ? c1 : c2;
4139 /* This callback is called when the mouse enters or leaves a tool bar item.
4140 It is used for displaying and hiding the help text.
4141 W is the tool bar item, a button.
4142 EVENT is either an enter event or leave event.
4143 CLIENT_DATA is an integer that is the index of the button in the
4144 tool bar. 0 is the first button.
4146 Returns FALSE to tell GTK to keep processing this event. */
4148 static gboolean
4149 xg_tool_bar_help_callback (GtkWidget *w,
4150 GdkEventCrossing *event,
4151 gpointer client_data)
4153 intptr_t idx = (intptr_t) client_data;
4154 struct frame *f = g_object_get_data (G_OBJECT (w), XG_FRAME_DATA);
4155 Lisp_Object help, frame;
4157 if (! f || ! f->n_tool_bar_items || NILP (f->tool_bar_items))
4158 return FALSE;
4160 if (event->type == GDK_ENTER_NOTIFY)
4162 idx *= TOOL_BAR_ITEM_NSLOTS;
4163 help = AREF (f->tool_bar_items, idx + TOOL_BAR_ITEM_HELP);
4165 if (NILP (help))
4166 help = AREF (f->tool_bar_items, idx + TOOL_BAR_ITEM_CAPTION);
4168 else
4169 help = Qnil;
4171 XSETFRAME (frame, f);
4172 kbd_buffer_store_help_event (frame, help);
4174 return FALSE;
4178 /* This callback is called when a tool bar item shall be redrawn.
4179 It modifies the expose event so that the GtkImage widget redraws the
4180 whole image. This to overcome a bug that makes GtkImage draw the image
4181 in the wrong place when it tries to redraw just a part of the image.
4182 W is the GtkImage to be redrawn.
4183 EVENT is the expose event for W.
4184 CLIENT_DATA is unused.
4186 Returns FALSE to tell GTK to keep processing this event. */
4188 #ifndef HAVE_GTK3
4189 static gboolean
4190 xg_tool_bar_item_expose_callback (GtkWidget *w,
4191 GdkEventExpose *event,
4192 gpointer client_data)
4194 gint width, height;
4196 gdk_drawable_get_size (event->window, &width, &height);
4197 event->area.x -= width > event->area.width ? width-event->area.width : 0;
4198 event->area.y -= height > event->area.height ? height-event->area.height : 0;
4200 event->area.x = max (0, event->area.x);
4201 event->area.y = max (0, event->area.y);
4203 event->area.width = max (width, event->area.width);
4204 event->area.height = max (height, event->area.height);
4206 return FALSE;
4208 #endif
4210 #ifdef HAVE_GTK_ORIENTABLE_SET_ORIENTATION
4211 #define toolbar_set_orientation(w, o) \
4212 gtk_orientable_set_orientation (GTK_ORIENTABLE (w), o)
4213 #else
4214 #define toolbar_set_orientation(w, o) \
4215 gtk_toolbar_set_orientation (GTK_TOOLBAR (w), o)
4216 #endif
4218 /* Attach a tool bar to frame F. */
4220 static void
4221 xg_pack_tool_bar (struct frame *f, Lisp_Object pos)
4223 struct x_output *x = f->output_data.x;
4224 bool into_hbox = EQ (pos, Qleft) || EQ (pos, Qright);
4225 GtkWidget *top_widget = x->toolbar_widget;
4227 toolbar_set_orientation (x->toolbar_widget,
4228 into_hbox
4229 ? GTK_ORIENTATION_VERTICAL
4230 : GTK_ORIENTATION_HORIZONTAL);
4232 if (into_hbox)
4234 gtk_box_pack_start (GTK_BOX (x->hbox_widget), top_widget,
4235 FALSE, FALSE, 0);
4237 if (EQ (pos, Qleft))
4238 gtk_box_reorder_child (GTK_BOX (x->hbox_widget),
4239 top_widget,
4241 x->toolbar_in_hbox = true;
4243 else
4245 bool vbox_pos = x->menubar_widget != 0;
4246 gtk_box_pack_start (GTK_BOX (x->vbox_widget), top_widget,
4247 FALSE, FALSE, 0);
4249 if (EQ (pos, Qtop))
4250 gtk_box_reorder_child (GTK_BOX (x->vbox_widget),
4251 top_widget,
4252 vbox_pos);
4253 x->toolbar_in_hbox = false;
4255 x->toolbar_is_packed = true;
4258 static bool xg_update_tool_bar_sizes (struct frame *f);
4260 static void
4261 tb_size_cb (GtkWidget *widget,
4262 GdkRectangle *allocation,
4263 gpointer user_data)
4265 /* When tool bar is created it has one preferred size. But when size is
4266 allocated between widgets, it may get another. So we must update
4267 size hints if tool bar size changes. Seen on Fedora 18 at least. */
4268 struct frame *f = user_data;
4270 if (xg_update_tool_bar_sizes (f))
4272 frame_size_history_add (f, Qtb_size_cb, 0, 0, Qnil);
4273 adjust_frame_size (f, -1, -1, 5, 0, Qtool_bar_lines);
4277 /* Create a tool bar for frame F. */
4279 static void
4280 xg_create_tool_bar (struct frame *f)
4282 struct x_output *x = f->output_data.x;
4283 #if GTK_CHECK_VERSION (3, 3, 6)
4284 GtkStyleContext *gsty;
4285 #endif
4286 struct xg_frame_tb_info *tbinfo
4287 = g_object_get_data (G_OBJECT (FRAME_GTK_OUTER_WIDGET (f)),
4288 TB_INFO_KEY);
4289 if (! tbinfo)
4291 tbinfo = xmalloc (sizeof (*tbinfo));
4292 tbinfo->last_tool_bar = Qnil;
4293 tbinfo->style = Qnil;
4294 tbinfo->hmargin = tbinfo->vmargin = 0;
4295 tbinfo->dir = GTK_TEXT_DIR_NONE;
4296 tbinfo->n_last_items = 0;
4297 g_object_set_data (G_OBJECT (FRAME_GTK_OUTER_WIDGET (f)),
4298 TB_INFO_KEY,
4299 tbinfo);
4302 x->toolbar_widget = gtk_toolbar_new ();
4304 gtk_widget_set_name (x->toolbar_widget, "emacs-toolbar");
4306 gtk_toolbar_set_style (GTK_TOOLBAR (x->toolbar_widget), GTK_TOOLBAR_ICONS);
4307 toolbar_set_orientation (x->toolbar_widget, GTK_ORIENTATION_HORIZONTAL);
4308 g_signal_connect (x->toolbar_widget, "size-allocate",
4309 G_CALLBACK (tb_size_cb), f);
4310 #if GTK_CHECK_VERSION (3, 3, 6)
4311 gsty = gtk_widget_get_style_context (x->toolbar_widget);
4312 gtk_style_context_add_class (gsty, "primary-toolbar");
4313 #endif
4317 #define PROP(IDX) AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
4319 /* Find the right-to-left image named by RTL in the tool bar images for F.
4320 Returns IMAGE if RTL is not found. */
4322 static Lisp_Object
4323 find_rtl_image (struct frame *f, Lisp_Object image, Lisp_Object rtl)
4325 int i;
4326 Lisp_Object file, rtl_name;
4327 struct gcpro gcpro1, gcpro2;
4328 GCPRO2 (file, rtl_name);
4330 rtl_name = Ffile_name_nondirectory (rtl);
4332 for (i = 0; i < f->n_tool_bar_items; ++i)
4334 Lisp_Object rtl_image = PROP (TOOL_BAR_ITEM_IMAGES);
4335 if (!NILP (file = file_for_image (rtl_image)))
4337 file = call1 (intern ("file-name-sans-extension"),
4338 Ffile_name_nondirectory (file));
4339 if (! NILP (Fequal (file, rtl_name)))
4341 image = rtl_image;
4342 break;
4347 return image;
4350 static GtkToolItem *
4351 xg_make_tool_item (struct frame *f,
4352 GtkWidget *wimage,
4353 GtkWidget **wbutton,
4354 const char *label,
4355 int i, bool horiz, bool text_image)
4357 GtkToolItem *ti = gtk_tool_item_new ();
4358 GtkWidget *vb = gtk_box_new (horiz
4359 ? GTK_ORIENTATION_HORIZONTAL
4360 : GTK_ORIENTATION_VERTICAL,
4362 GtkWidget *wb = gtk_button_new ();
4363 /* The eventbox is here so we can have tooltips on disabled items. */
4364 GtkWidget *weventbox = gtk_event_box_new ();
4365 #if GTK_CHECK_VERSION (3, 3, 6)
4366 GtkCssProvider *css_prov = gtk_css_provider_new ();
4367 GtkStyleContext *gsty;
4369 gtk_css_provider_load_from_data (css_prov,
4370 "GtkEventBox {"
4371 " background-color: transparent;"
4372 "}",
4373 -1, NULL);
4375 gsty = gtk_widget_get_style_context (weventbox);
4376 gtk_style_context_add_provider (gsty,
4377 GTK_STYLE_PROVIDER (css_prov),
4378 GTK_STYLE_PROVIDER_PRIORITY_USER);
4379 g_object_unref (css_prov);
4380 #endif
4382 gtk_box_set_homogeneous (GTK_BOX (vb), FALSE);
4384 if (wimage && !text_image)
4385 gtk_box_pack_start (GTK_BOX (vb), wimage, TRUE, TRUE, 0);
4386 if (label)
4387 gtk_box_pack_start (GTK_BOX (vb), gtk_label_new (label), TRUE, TRUE, 0);
4388 if (wimage && text_image)
4389 gtk_box_pack_start (GTK_BOX (vb), wimage, TRUE, TRUE, 0);
4391 gtk_button_set_focus_on_click (GTK_BUTTON (wb), FALSE);
4392 gtk_button_set_relief (GTK_BUTTON (wb), GTK_RELIEF_NONE);
4393 gtk_container_add (GTK_CONTAINER (wb), vb);
4394 gtk_container_add (GTK_CONTAINER (weventbox), wb);
4395 gtk_container_add (GTK_CONTAINER (ti), weventbox);
4397 if (wimage || label)
4399 intptr_t ii = i;
4400 gpointer gi = (gpointer) ii;
4402 g_signal_connect (G_OBJECT (wb), "clicked",
4403 G_CALLBACK (xg_tool_bar_callback),
4404 gi);
4406 g_object_set_data (G_OBJECT (weventbox), XG_FRAME_DATA, (gpointer)f);
4408 #ifndef HAVE_GTK3
4409 /* Catch expose events to overcome an annoying redraw bug, see
4410 comment for xg_tool_bar_item_expose_callback. */
4411 g_signal_connect (G_OBJECT (ti),
4412 "expose-event",
4413 G_CALLBACK (xg_tool_bar_item_expose_callback),
4415 #endif
4416 gtk_tool_item_set_homogeneous (ti, FALSE);
4418 /* Callback to save modifier mask (Shift/Control, etc). GTK makes
4419 no distinction based on modifiers in the activate callback,
4420 so we have to do it ourselves. */
4421 g_signal_connect (wb, "button-release-event",
4422 G_CALLBACK (xg_tool_bar_button_cb),
4423 NULL);
4425 g_object_set_data (G_OBJECT (wb), XG_FRAME_DATA, (gpointer)f);
4427 /* Use enter/leave notify to show help. We use the events
4428 rather than the GtkButton specific signals "enter" and
4429 "leave", so we can have only one callback. The event
4430 will tell us what kind of event it is. */
4431 g_signal_connect (G_OBJECT (weventbox),
4432 "enter-notify-event",
4433 G_CALLBACK (xg_tool_bar_help_callback),
4434 gi);
4435 g_signal_connect (G_OBJECT (weventbox),
4436 "leave-notify-event",
4437 G_CALLBACK (xg_tool_bar_help_callback),
4438 gi);
4441 if (wbutton) *wbutton = wb;
4443 return ti;
4446 static bool
4447 is_box_type (GtkWidget *vb, bool is_horizontal)
4449 #ifdef HAVE_GTK3
4450 bool ret = 0;
4451 if (GTK_IS_BOX (vb))
4453 GtkOrientation ori = gtk_orientable_get_orientation (GTK_ORIENTABLE (vb));
4454 ret = (ori == GTK_ORIENTATION_HORIZONTAL && is_horizontal)
4455 || (ori == GTK_ORIENTATION_VERTICAL && ! is_horizontal);
4457 return ret;
4458 #else
4459 return is_horizontal ? GTK_IS_VBOX (vb) : GTK_IS_HBOX (vb);
4460 #endif
4464 static bool
4465 xg_tool_item_stale_p (GtkWidget *wbutton, const char *stock_name,
4466 const char *icon_name, const struct image *img,
4467 const char *label, bool horiz)
4469 gpointer old;
4470 GtkWidget *wimage;
4471 GtkWidget *vb = XG_BIN_CHILD (wbutton);
4472 GtkWidget *wlbl = xg_get_tool_bar_widgets (vb, &wimage);
4474 /* Check if the tool icon matches. */
4475 if (stock_name && wimage)
4477 old = g_object_get_data (G_OBJECT (wimage),
4478 XG_TOOL_BAR_STOCK_NAME);
4479 if (!old || strcmp (old, stock_name))
4480 return 1;
4482 else if (icon_name && wimage)
4484 old = g_object_get_data (G_OBJECT (wimage),
4485 XG_TOOL_BAR_ICON_NAME);
4486 if (!old || strcmp (old, icon_name))
4487 return 1;
4489 else if (wimage)
4491 gpointer gold_img = g_object_get_data (G_OBJECT (wimage),
4492 XG_TOOL_BAR_IMAGE_DATA);
4493 Pixmap old_img = (Pixmap) gold_img;
4494 if (old_img != img->pixmap)
4495 return 1;
4498 /* Check button configuration and label. */
4499 if (is_box_type (vb, horiz)
4500 || (label ? (wlbl == NULL) : (wlbl != NULL)))
4501 return 1;
4503 /* Ensure label is correct. */
4504 if (label && wlbl)
4505 gtk_label_set_text (GTK_LABEL (wlbl), label);
4506 return 0;
4509 static bool
4510 xg_update_tool_bar_sizes (struct frame *f)
4512 struct x_output *x = f->output_data.x;
4513 GtkRequisition req;
4514 int nl = 0, nr = 0, nt = 0, nb = 0;
4515 GtkWidget *top_widget = x->toolbar_widget;
4517 gtk_widget_get_preferred_size (GTK_WIDGET (top_widget), NULL, &req);
4518 if (x->toolbar_in_hbox)
4520 int pos;
4521 gtk_container_child_get (GTK_CONTAINER (x->hbox_widget),
4522 top_widget,
4523 "position", &pos, NULL);
4524 if (pos == 0) nl = req.width;
4525 else nr = req.width;
4527 else
4529 int pos;
4530 gtk_container_child_get (GTK_CONTAINER (x->vbox_widget),
4531 top_widget,
4532 "position", &pos, NULL);
4533 if (pos == 0 || (pos == 1 && x->menubar_widget)) nt = req.height;
4534 else nb = req.height;
4537 if (nl != FRAME_TOOLBAR_LEFT_WIDTH (f)
4538 || nr != FRAME_TOOLBAR_RIGHT_WIDTH (f)
4539 || nt != FRAME_TOOLBAR_TOP_HEIGHT (f)
4540 || nb != FRAME_TOOLBAR_BOTTOM_HEIGHT (f))
4542 FRAME_TOOLBAR_RIGHT_WIDTH (f) = FRAME_TOOLBAR_LEFT_WIDTH (f)
4543 = FRAME_TOOLBAR_TOP_HEIGHT (f) = FRAME_TOOLBAR_BOTTOM_HEIGHT (f) = 0;
4544 FRAME_TOOLBAR_LEFT_WIDTH (f) = nl;
4545 FRAME_TOOLBAR_RIGHT_WIDTH (f) = nr;
4546 FRAME_TOOLBAR_TOP_HEIGHT (f) = nt;
4547 FRAME_TOOLBAR_BOTTOM_HEIGHT (f) = nb;
4549 return true;
4551 else
4552 return false;
4555 static char *
4556 find_icon_from_name (char *name,
4557 GtkIconTheme *icon_theme,
4558 char **icon_name)
4560 #if ! GTK_CHECK_VERSION (3, 10, 0)
4561 GtkStockItem stock_item;
4562 #endif
4564 if (name[0] == 'n' && name[1] == ':')
4566 *icon_name = name + 2;
4567 name = NULL;
4569 if (! gtk_icon_theme_has_icon (icon_theme, *icon_name))
4570 *icon_name = NULL;
4573 #if ! GTK_CHECK_VERSION (3, 10, 0)
4574 else if (gtk_stock_lookup (name, &stock_item))
4575 *icon_name = NULL;
4576 #endif
4577 else if (gtk_icon_theme_has_icon (icon_theme, name))
4579 *icon_name = name;
4580 name = NULL;
4582 else
4584 name = NULL;
4585 *icon_name = NULL;
4588 return name;
4592 /* Update the tool bar for frame F. Add new buttons and remove old. */
4594 void
4595 update_frame_tool_bar (struct frame *f)
4597 int i, j;
4598 struct x_output *x = f->output_data.x;
4599 int hmargin = 0, vmargin = 0;
4600 GtkToolbar *wtoolbar;
4601 GtkToolItem *ti;
4602 GtkTextDirection dir;
4603 Lisp_Object style;
4604 bool text_image, horiz;
4605 struct xg_frame_tb_info *tbinfo;
4606 GdkScreen *screen;
4607 GtkIconTheme *icon_theme;
4610 if (! FRAME_GTK_WIDGET (f))
4611 return;
4613 block_input ();
4615 if (RANGED_INTEGERP (1, Vtool_bar_button_margin, INT_MAX))
4617 hmargin = XFASTINT (Vtool_bar_button_margin);
4618 vmargin = XFASTINT (Vtool_bar_button_margin);
4620 else if (CONSP (Vtool_bar_button_margin))
4622 if (RANGED_INTEGERP (1, XCAR (Vtool_bar_button_margin), INT_MAX))
4623 hmargin = XFASTINT (XCAR (Vtool_bar_button_margin));
4625 if (RANGED_INTEGERP (1, XCDR (Vtool_bar_button_margin), INT_MAX))
4626 vmargin = XFASTINT (XCDR (Vtool_bar_button_margin));
4629 /* The natural size (i.e. when GTK uses 0 as margin) looks best,
4630 so take DEFAULT_TOOL_BAR_BUTTON_MARGIN to mean "default for GTK",
4631 i.e. zero. This means that margins less than
4632 DEFAULT_TOOL_BAR_BUTTON_MARGIN has no effect. */
4633 hmargin = max (0, hmargin - DEFAULT_TOOL_BAR_BUTTON_MARGIN);
4634 vmargin = max (0, vmargin - DEFAULT_TOOL_BAR_BUTTON_MARGIN);
4636 if (! x->toolbar_widget)
4637 xg_create_tool_bar (f);
4639 wtoolbar = GTK_TOOLBAR (x->toolbar_widget);
4640 dir = gtk_widget_get_direction (GTK_WIDGET (wtoolbar));
4642 style = Ftool_bar_get_system_style ();
4643 screen = gtk_widget_get_screen (GTK_WIDGET (wtoolbar));
4644 icon_theme = gtk_icon_theme_get_for_screen (screen);
4646 /* Are we up to date? */
4647 tbinfo = g_object_get_data (G_OBJECT (FRAME_GTK_OUTER_WIDGET (f)),
4648 TB_INFO_KEY);
4650 if (! NILP (tbinfo->last_tool_bar) && ! NILP (f->tool_bar_items)
4651 && tbinfo->n_last_items == f->n_tool_bar_items
4652 && tbinfo->hmargin == hmargin && tbinfo->vmargin == vmargin
4653 && tbinfo->dir == dir
4654 && ! NILP (Fequal (tbinfo->style, style))
4655 && ! NILP (Fequal (tbinfo->last_tool_bar, f->tool_bar_items)))
4657 unblock_input ();
4658 return;
4661 tbinfo->last_tool_bar = f->tool_bar_items;
4662 tbinfo->n_last_items = f->n_tool_bar_items;
4663 tbinfo->style = style;
4664 tbinfo->hmargin = hmargin;
4665 tbinfo->vmargin = vmargin;
4666 tbinfo->dir = dir;
4668 text_image = EQ (style, Qtext_image_horiz);
4669 horiz = EQ (style, Qboth_horiz) || text_image;
4671 for (i = j = 0; i < f->n_tool_bar_items; ++i)
4673 bool enabled_p = !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P));
4674 bool selected_p = !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P));
4675 int idx;
4676 ptrdiff_t img_id;
4677 int icon_size = 0;
4678 struct image *img = NULL;
4679 Lisp_Object image;
4680 Lisp_Object stock = Qnil;
4681 char *stock_name = NULL;
4682 char *icon_name = NULL;
4683 Lisp_Object rtl;
4684 GtkWidget *wbutton = NULL;
4685 Lisp_Object specified_file;
4686 bool vert_only = ! NILP (PROP (TOOL_BAR_ITEM_VERT_ONLY));
4687 const char *label
4688 = (EQ (style, Qimage) || (vert_only && horiz)) ? NULL
4689 : STRINGP (PROP (TOOL_BAR_ITEM_LABEL))
4690 ? SSDATA (PROP (TOOL_BAR_ITEM_LABEL))
4691 : "";
4693 ti = gtk_toolbar_get_nth_item (GTK_TOOLBAR (wtoolbar), j);
4695 /* If this is a separator, use a gtk separator item. */
4696 if (EQ (PROP (TOOL_BAR_ITEM_TYPE), Qt))
4698 if (ti == NULL || !GTK_IS_SEPARATOR_TOOL_ITEM (ti))
4700 if (ti)
4701 gtk_container_remove (GTK_CONTAINER (wtoolbar),
4702 GTK_WIDGET (ti));
4703 ti = gtk_separator_tool_item_new ();
4704 gtk_toolbar_insert (GTK_TOOLBAR (wtoolbar), ti, j);
4706 j++;
4707 continue;
4710 /* Otherwise, the tool-bar item is an ordinary button. */
4712 if (ti && GTK_IS_SEPARATOR_TOOL_ITEM (ti))
4714 gtk_container_remove (GTK_CONTAINER (wtoolbar), GTK_WIDGET (ti));
4715 ti = NULL;
4718 if (ti) wbutton = XG_BIN_CHILD (XG_BIN_CHILD (ti));
4720 /* Ignore invalid image specifications. */
4721 image = PROP (TOOL_BAR_ITEM_IMAGES);
4722 if (!valid_image_p (image))
4724 if (ti)
4725 gtk_container_remove (GTK_CONTAINER (wtoolbar),
4726 GTK_WIDGET (ti));
4727 continue;
4730 specified_file = file_for_image (image);
4731 if (!NILP (specified_file) && !NILP (Ffboundp (Qx_gtk_map_stock)))
4732 stock = call1 (Qx_gtk_map_stock, specified_file);
4734 if (CONSP (stock))
4736 Lisp_Object tem;
4737 for (tem = stock; CONSP (tem); tem = XCDR (tem))
4738 if (! NILP (tem) && STRINGP (XCAR (tem)))
4740 stock_name = find_icon_from_name (SSDATA (XCAR (tem)),
4741 icon_theme,
4742 &icon_name);
4743 if (stock_name || icon_name) break;
4746 else if (STRINGP (stock))
4748 stock_name = find_icon_from_name (SSDATA (stock),
4749 icon_theme,
4750 &icon_name);
4753 if (stock_name || icon_name)
4754 icon_size = gtk_toolbar_get_icon_size (wtoolbar);
4756 if (stock_name == NULL && icon_name == NULL)
4758 /* No stock image, or stock item not known. Try regular
4759 image. If image is a vector, choose it according to the
4760 button state. */
4761 if (dir == GTK_TEXT_DIR_RTL
4762 && !NILP (rtl = PROP (TOOL_BAR_ITEM_RTL_IMAGE))
4763 && STRINGP (rtl))
4764 image = find_rtl_image (f, image, rtl);
4766 if (VECTORP (image))
4768 if (enabled_p)
4769 idx = (selected_p
4770 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
4771 : TOOL_BAR_IMAGE_ENABLED_DESELECTED);
4772 else
4773 idx = (selected_p
4774 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
4775 : TOOL_BAR_IMAGE_DISABLED_DESELECTED);
4777 eassert (ASIZE (image) >= idx);
4778 image = AREF (image, idx);
4780 else
4781 idx = -1;
4783 img_id = lookup_image (f, image);
4784 img = IMAGE_FROM_ID (f, img_id);
4785 prepare_image_for_display (f, img);
4787 if (img->load_failed_p || img->pixmap == None)
4789 if (ti)
4790 gtk_container_remove (GTK_CONTAINER (wtoolbar),
4791 GTK_WIDGET (ti));
4792 continue;
4796 /* If there is an existing widget, check if it's stale; if so,
4797 remove it and make a new tool item from scratch. */
4798 if (ti && xg_tool_item_stale_p (wbutton, stock_name, icon_name,
4799 img, label, horiz))
4801 gtk_container_remove (GTK_CONTAINER (wtoolbar),
4802 GTK_WIDGET (ti));
4803 ti = NULL;
4806 if (ti == NULL)
4808 GtkWidget *w;
4810 /* Save the image so we can see if an update is needed the
4811 next time we call xg_tool_item_match_p. */
4812 if (EQ (style, Qtext))
4813 w = NULL;
4814 else if (stock_name)
4817 #if GTK_CHECK_VERSION (3, 10, 0)
4818 w = gtk_image_new_from_icon_name (stock_name, icon_size);
4819 #else
4820 w = gtk_image_new_from_stock (stock_name, icon_size);
4821 #endif
4822 g_object_set_data_full (G_OBJECT (w), XG_TOOL_BAR_STOCK_NAME,
4823 (gpointer) xstrdup (stock_name),
4824 (GDestroyNotify) xfree);
4826 else if (icon_name)
4828 w = gtk_image_new_from_icon_name (icon_name, icon_size);
4829 g_object_set_data_full (G_OBJECT (w), XG_TOOL_BAR_ICON_NAME,
4830 (gpointer) xstrdup (icon_name),
4831 (GDestroyNotify) xfree);
4833 else
4835 w = xg_get_image_for_pixmap (f, img, x->widget, NULL);
4836 g_object_set_data (G_OBJECT (w), XG_TOOL_BAR_IMAGE_DATA,
4837 (gpointer)img->pixmap);
4840 #if GTK_CHECK_VERSION (3, 14, 0)
4841 if (w)
4843 gtk_widget_set_margin_start (w, hmargin);
4844 gtk_widget_set_margin_end (w, hmargin);
4845 gtk_widget_set_margin_top (w, vmargin);
4846 gtk_widget_set_margin_bottom (w, vmargin);
4848 #else
4849 if (w) gtk_misc_set_padding (GTK_MISC (w), hmargin, vmargin);
4850 #endif
4851 ti = xg_make_tool_item (f, w, &wbutton, label, i, horiz, text_image);
4852 gtk_toolbar_insert (GTK_TOOLBAR (wtoolbar), ti, j);
4855 #undef PROP
4857 gtk_widget_set_sensitive (wbutton, enabled_p);
4858 j++;
4861 /* Remove buttons not longer needed. */
4864 ti = gtk_toolbar_get_nth_item (GTK_TOOLBAR (wtoolbar), j);
4865 if (ti)
4866 gtk_container_remove (GTK_CONTAINER (wtoolbar), GTK_WIDGET (ti));
4867 } while (ti != NULL);
4869 if (f->n_tool_bar_items != 0)
4871 if (! x->toolbar_is_packed)
4872 xg_pack_tool_bar (f, FRAME_TOOL_BAR_POSITION (f));
4873 gtk_widget_show_all (x->toolbar_widget);
4874 if (xg_update_tool_bar_sizes (f))
4876 frame_size_history_add (f, Qupdate_frame_tool_bar, 0, 0, Qnil);
4877 adjust_frame_size (f, -1, -1, 2, 0, Qtool_bar_lines);
4881 unblock_input ();
4884 /* Deallocate all resources for the tool bar on frame F.
4885 Remove the tool bar. */
4887 void
4888 free_frame_tool_bar (struct frame *f)
4890 struct x_output *x = f->output_data.x;
4892 if (x->toolbar_widget)
4894 struct xg_frame_tb_info *tbinfo;
4895 GtkWidget *top_widget = x->toolbar_widget;
4897 block_input ();
4898 if (x->toolbar_is_packed)
4900 if (x->toolbar_in_hbox)
4901 gtk_container_remove (GTK_CONTAINER (x->hbox_widget),
4902 top_widget);
4903 else
4904 gtk_container_remove (GTK_CONTAINER (x->vbox_widget),
4905 top_widget);
4907 else
4908 gtk_widget_destroy (x->toolbar_widget);
4910 x->toolbar_widget = 0;
4911 x->toolbar_widget = 0;
4912 x->toolbar_is_packed = false;
4913 FRAME_TOOLBAR_TOP_HEIGHT (f) = FRAME_TOOLBAR_BOTTOM_HEIGHT (f) = 0;
4914 FRAME_TOOLBAR_LEFT_WIDTH (f) = FRAME_TOOLBAR_RIGHT_WIDTH (f) = 0;
4916 tbinfo = g_object_get_data (G_OBJECT (FRAME_GTK_OUTER_WIDGET (f)),
4917 TB_INFO_KEY);
4918 if (tbinfo)
4920 xfree (tbinfo);
4921 g_object_set_data (G_OBJECT (FRAME_GTK_OUTER_WIDGET (f)),
4922 TB_INFO_KEY,
4923 NULL);
4926 frame_size_history_add (f, Qfree_frame_tool_bar, 0, 0, Qnil);
4927 adjust_frame_size (f, -1, -1, 2, 0, Qtool_bar_lines);
4929 unblock_input ();
4933 void
4934 xg_change_toolbar_position (struct frame *f, Lisp_Object pos)
4936 struct x_output *x = f->output_data.x;
4937 GtkWidget *top_widget = x->toolbar_widget;
4939 if (! x->toolbar_widget || ! top_widget)
4940 return;
4942 block_input ();
4943 g_object_ref (top_widget);
4944 if (x->toolbar_is_packed)
4946 if (x->toolbar_in_hbox)
4947 gtk_container_remove (GTK_CONTAINER (x->hbox_widget),
4948 top_widget);
4949 else
4950 gtk_container_remove (GTK_CONTAINER (x->vbox_widget),
4951 top_widget);
4954 xg_pack_tool_bar (f, pos);
4955 g_object_unref (top_widget);
4957 if (xg_update_tool_bar_sizes (f))
4959 frame_size_history_add (f, Qxg_change_toolbar_position, 0, 0, Qnil);
4960 adjust_frame_size (f, -1, -1, 2, 0, Qtool_bar_lines);
4964 unblock_input ();
4969 /***********************************************************************
4970 Initializing
4971 ***********************************************************************/
4972 void
4973 xg_initialize (void)
4975 GtkBindingSet *binding_set;
4976 GtkSettings *settings;
4978 #if HAVE_XFT
4979 /* Work around a bug with corrupted data if libXft gets unloaded. This way
4980 we keep it permanently linked in. */
4981 XftInit (0);
4982 #endif
4984 gdpy_def = NULL;
4985 xg_ignore_gtk_scrollbar = 0;
4986 xg_menu_cb_list.prev = xg_menu_cb_list.next =
4987 xg_menu_item_cb_list.prev = xg_menu_item_cb_list.next = 0;
4989 id_to_widget.max_size = id_to_widget.used = 0;
4990 id_to_widget.widgets = 0;
4992 settings = gtk_settings_get_for_screen (gdk_display_get_default_screen
4993 (gdk_display_get_default ()));
4994 /* Remove F10 as a menu accelerator, it does not mix well with Emacs key
4995 bindings. It doesn't seem to be any way to remove properties,
4996 so we set it to "" which in means "no key". */
4997 gtk_settings_set_string_property (settings,
4998 "gtk-menu-bar-accel",
5000 EMACS_CLASS);
5002 /* Make GTK text input widgets use Emacs style keybindings. This is
5003 Emacs after all. */
5004 gtk_settings_set_string_property (settings,
5005 "gtk-key-theme-name",
5006 "Emacs",
5007 EMACS_CLASS);
5009 /* Make dialogs close on C-g. Since file dialog inherits from
5010 dialog, this works for them also. */
5011 binding_set = gtk_binding_set_by_class (g_type_class_ref (GTK_TYPE_DIALOG));
5012 gtk_binding_entry_add_signal (binding_set, GDK_KEY_g, GDK_CONTROL_MASK,
5013 "close", 0);
5015 /* Make menus close on C-g. */
5016 binding_set = gtk_binding_set_by_class (g_type_class_ref
5017 (GTK_TYPE_MENU_SHELL));
5018 gtk_binding_entry_add_signal (binding_set, GDK_KEY_g, GDK_CONTROL_MASK,
5019 "cancel", 0);
5020 update_theme_scrollbar_width ();
5021 update_theme_scrollbar_height ();
5023 #ifdef HAVE_FREETYPE
5024 x_last_font_name = NULL;
5025 #endif
5028 #endif /* USE_GTK */